/usr/include/gnash/asobj/PropertyList.h is in gnash-dev 0.8.11~git20160109-1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 | //
// Copyright (C) 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012
// Free Software Foundation, Inc
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
#ifndef GNASH_PROPERTYLIST_H
#define GNASH_PROPERTYLIST_H
#include <set>
#include <string> // for use within map
#include <cassert> // for inlines
#include <utility> // for std::pair
#include <cstdint>
#include <boost/multi_index_container.hpp>
#include <boost/multi_index/ordered_index.hpp>
#include <boost/multi_index/sequenced_index.hpp>
#include <boost/multi_index/key_extractors.hpp>
#include <boost/noncopyable.hpp>
#include <functional>
#include <algorithm>
#include "Property.h" // for templated functions
#include "dsodefs.h" // for DSOTEXPORT
// Forward declaration
namespace gnash {
class as_object;
class as_function;
struct ObjectURI;
class as_value;
}
namespace gnash {
/// An abstract property visitor
class PropertyVisitor {
public:
/// This function should return false if no further visits are needed.
virtual bool accept(const ObjectURI& uri, const as_value& val) = 0;
virtual ~PropertyVisitor() {}
};
/// An abstract key visitor
class KeyVisitor {
public:
/// This function should return false if no further visits are needed.
virtual void operator()(const ObjectURI& uri) = 0;
virtual ~KeyVisitor() {}
};
/// Set of properties associated with an ActionScript object.
//
/// The PropertyList container is the sole owner of the Property
/// elements in it contained and has full responsibility of their
/// construction and destruction.
//
/// A PropertyList holds a reference to the as_object whose properties it
/// contains. This reference will always be valid if the PropertyList
/// is a member of as_object.
//
/// It is theoretically possible for a PropertyList to be used with any
/// as_object, not just original as_object it was use with. Currently (as
/// there is no use for this scenario) it is not possible to change the
/// owner.
class PropertyList : boost::noncopyable
{
public:
typedef std::set<ObjectURI, ObjectURI::LessThan> PropertyTracker;
typedef Property value_type;
/// Identifier for the sequenced index
struct CreationOrder {};
/// The sequenced index in creation order.
typedef boost::multi_index::sequenced<
boost::multi_index::tag<CreationOrder> > SequencedIndex;
struct KeyExtractor
{
typedef const ObjectURI& result_type;
result_type operator()(const Property& p) const {
return p.uri();
}
};
/// Identifier for the case-sensitive index
struct Case {};
/// The case-sensitive index
typedef boost::multi_index::ordered_unique<
boost::multi_index::tag<Case>,
KeyExtractor,
ObjectURI::LessThan> CaseIndex;
/// Identifier for the case-insensitive index
struct NoCase {};
/// The case-insensitive index
typedef boost::multi_index::ordered_non_unique<
boost::multi_index::tag<NoCase>,
KeyExtractor,
ObjectURI::CaseLessThan> NoCaseIndex;
/// The container of the Properties.
typedef boost::multi_index_container<
value_type,
boost::multi_index::indexed_by<SequencedIndex, CaseIndex, NoCaseIndex>
> container;
typedef container::iterator iterator;
typedef container::const_iterator const_iterator;
/// Construct the PropertyList
//
/// @param obj The as_object to which this PropertyList belongs.
DSOTEXPORT PropertyList(as_object& obj);
/// Visit properties
//
/// The method will invoke the given visitor method
/// passing it two arguments: name of the property and
/// value of it.
//
/// @tparam V The type of the visitor.
/// @tparam U An object that may check property values. The object's
/// operator() should return false if the property is not
/// acceptable.
//
/// @param visitor The visitor function. It must implement the function:
/// bool accept(const ObjectURI&, const as_value&);
/// Scan is by enumeration order and stops when accept()
/// returns false.
template <class U, class V>
void visitValues(V& visitor, U cmp = U()) const {
for (const auto& prop : _props) {
if (!cmp(prop)) continue;
as_value val = prop.getValue(_owner);
if (!visitor.accept(prop.uri(), val)) return;
}
}
/// Enumerate all non-hidden properties to the given container.
//
/// Follows enumeration order. Note that this enumeration does not
/// access the values. Accessing the values can result in changes to
/// the object if the value is a getter-setter, and key enumeration must
/// avoid this.
///
/// @param donelist Don't enumerate properties in donelist.
/// Enumerated properties are added to donelist.
void visitKeys(KeyVisitor& v, PropertyTracker& donelist) const;
/// Set the value of a property, creating a new one if it doesn't exist.
//
/// If the named property is a getter/setter one it's setter
/// will be invoked using the given as_object as 'this' pointer.
/// If the property is not found a SimpleProperty will be created.
///
/// @param uri
/// Name of the property.
/// @param value
/// a const reference to the as_value to use for setting
/// or creating the property.
/// @param flagsIfMissing
/// Flags to associate to the property if a new one is created.
/// @return true if the value was successfully set, false
/// otherwise (found a read-only property, most likely).
DSOTEXPORT bool setValue(const ObjectURI& uri, const as_value& value,
const PropFlags& flagsIfMissing = 0);
/// Get a property if it exists.
//
/// @param uri Name of the property.
/// @return A Property or 0, if no such property exists.
/// All Property objects are owned by this PropertyList. Do
/// not delete them.
DSOTEXPORT Property* getProperty(const ObjectURI& uri) const;
/// Delete a Property, if existing and not protected from deletion.
//
///
/// @param uri Name of the property.
/// @return a pair of boolean values expressing whether the property
/// was found (first) and whether it was deleted (second).
/// Of course a pair(false, true) would be invalid (deleted
/// a non-found property!?). Valid returns are:
/// - (false, false) : property not found
/// - (true, false) : property protected from deletion
/// - (true, true) : property successfully deleted
DSOTEXPORT std::pair<bool,bool> delProperty(const ObjectURI& uri);
/// Add a getter/setter property, if not already existing
//
/// TODO: this function has far too many arguments.
//
/// @param uri Name of the property.
/// @param getter A function to invoke when this property value is
/// requested.
/// @param setter A function to invoke when setting this property's value.
/// @param cacheVal The value to use as a cache. If null uses any cache
/// from pre-existing property with same name.
/// @param flagsIfMissing Flags to associate to the property if a new one
/// is created.
/// @return true if the property was successfully added, false
/// otherwise.
bool addGetterSetter(const ObjectURI& uri, as_function& getter,
as_function* setter, const as_value& cacheVal,
const PropFlags& flagsIfMissing = 0);
/// Add a getter/setter property, if not already existing
//
/// @param uri Name of the property.
/// @param getter A function to invoke when this property value is
/// requested.
/// @param setter A function to invoke when setting this property's value.
/// @return true if the property was successfully added, false
/// otherwise.
bool addGetterSetter(const ObjectURI& uri, as_c_function_ptr getter,
as_c_function_ptr setter, const PropFlags& flagsIfMissing);
/// Add a destructive getter property, if not already existant.
//
/// @param uri Name of the property.
/// @param getter A function to invoke when this property value is
/// requested.
/// @param flagsIfMissing Flags to associate to the property if a new
/// one is created.
/// @return true if the property was successfully added.
bool addDestructiveGetter(const ObjectURI& uri, as_function& getter,
const PropFlags& flagsIfMissing = 0);
/// Add a destructive getter property, if not already existant.
///
/// @param uri Name of the property.
/// @param getter A function to invoke when this property value is
/// requested.
///
/// @param flagsIfMissing Flags to associate to the property if a new
// one is created.
/// @return true if the property was successfully added, false
/// otherwise.
bool addDestructiveGetter(const ObjectURI& uri, as_c_function_ptr getter,
const PropFlags& flagsIfMissing = 0);
/// Set the flags of a property.
//
/// @param uri Name of the property.
/// @param setTrue The set of flags to set
/// @param setFalse The set of flags to clear
DSOTEXPORT void setFlags(const ObjectURI& uri, int setTrue, int setFalse);
/// Set the flags of all properties.
//
/// @param setTrue The set of flags to set
/// @param setFalse The set of flags to clear
void setFlagsAll(int setTrue, int setFalse);
/// Remove all entries in the container
void clear();
/// Return number of properties in this list
size_t size() const {
return _props.size();
}
/// Dump all members (using log_debug)
//
/// This does not reflect the normal enumeration order. It is sorted
/// lexicographically by property.
void dump();
/// Mark all properties reachable
//
/// This can be called very frequently, so is inlined to allow the
/// compiler to optimize it.
void setReachable() const {
std::for_each(_props.begin(), _props.end(),
std::mem_fn(&Property::setReachable));
}
private:
container _props;
as_object& _owner;
};
} // namespace gnash
#endif // GNASH_PROPERTYLIST_H
|