Gnash  0.8.11dev
Public Types | Public Member Functions | List of all members
gnash::Function2 Class Reference

Function2 adds extra sauce to ordinary Functions. More...

#include <Function2.h>

Inheritance diagram for gnash::Function2:
gnash::Function gnash::UserFunction gnash::as_function gnash::as_object gnash::GcResource

Public Types

enum  DefineFunction2Flags {
  PRELOAD_THIS = 0x01, SUPPRESS_THIS = 0x02, PRELOAD_ARGUMENTS = 0x04, SUPPRESS_ARGUMENTS = 0x08,
  PRELOAD_SUPER = 0x10, SUPPRESS_SUPER = 0x20, PRELOAD_ROOT = 0x40, PRELOAD_PARENT = 0x80,
  PRELOAD_GLOBAL = 256
}
 
- Public Types inherited from gnash::Function
typedef std::vector< as_object * > ScopeStack
 

Public Member Functions

 Function2 (const action_buffer &ab, as_environment &env, size_t start, const ScopeStack &with_stack)
 
virtual ~Function2 ()
 
virtual std::uint8_t registers () const
 Return the number of registers to allocate for this function. More...
 
void setRegisterCount (std::uint8_t ct)
 
void setFlags (std::uint16_t flags)
 
virtual as_value call (const fn_call &fn)
 Dispatch. More...
 
- Public Member Functions inherited from gnash::Function
 Function (const action_buffer &ab, as_environment &env, size_t start, ScopeStack with_stack)
 Create an ActionScript function as defined in an action_buffer starting at offset 'start'. More...
 
virtual ~Function ()
 
const ScopeStackgetScopeStack () const
 
const action_buffergetActionBuffer () const
 
size_t getStartPC () const
 
size_t getLength () const
 
void add_arg (std::uint8_t reg, const ObjectURI &name)
 Add an expected argument for the function. More...
 
void setLength (size_t len)
 Set the length in bytes of the function code. More...
 
virtual void markReachableResources () const
 Mark reachable resources. Override from as_object. More...
 
- Public Member Functions inherited from gnash::as_function
virtual ~as_function ()
 Destructor. More...
 
virtual as_functionto_function ()
 Return this as_object as an as_function. More...
 
virtual std::string stringValue () const
 Return the string value of this as_object subclass. More...
 
as_objectconstruct (as_object &newobj, const as_environment &env, FunctionArgs< as_value > &args)
 Run this function as a constructor on an object. More...
 
virtual bool isBuiltin ()
 Return true if this is a built-in class. More...
 
- Public Member Functions inherited from gnash::as_object
DSOTEXPORT as_object (const Global_as &global)
 Construct an ActionScript object with no prototype associated. More...
 
virtual ~as_object ()
 The as_object dtor does nothing special. More...
 
PropertyfindProperty (const ObjectURI &uri, as_object **owner=nullptr)
 Find a property, scanning the inheritance chain. More...
 
VMvm () const
 Return a reference to this as_object's global object. More...
 
void dump_members ()
 Dump all properties using log_debug. More...
 
virtual bool set_member (const ObjectURI &uri, const as_value &val, bool ifFound=false)
 Set a member value. More...
 
void init_member (const std::string &name, const as_value &val, int flags=DefaultFlags)
 Initialize a member value by string. More...
 
void init_member (const ObjectURI &uri, const as_value &val, int flags=DefaultFlags)
 Initialize a member value by key. More...
 
void init_property (const std::string &key, as_function &getter, as_function &setter, int flags=DefaultFlags)
 Initialize a getter/setter property by name. More...
 
void init_property (const std::string &key, as_c_function_ptr getter, as_c_function_ptr setter, int flags=DefaultFlags)
 Initialize a getter/setter property by name. More...
 
void init_property (const ObjectURI &uri, as_function &getter, as_function &setter, int flags=DefaultFlags)
 Initialize a getter/setter property by key. More...
 
void init_property (const ObjectURI &uri, as_c_function_ptr getter, as_c_function_ptr setter, int flags=DefaultFlags)
 Initialize a getter/setter property by key. More...
 
bool init_destructive_property (const ObjectURI &uri, as_function &getter, int flags=PropFlags::dontEnum)
 Initialize a destructive getter property. More...
 
bool init_destructive_property (const ObjectURI &uri, as_c_function_ptr getter, int flags=PropFlags::dontEnum)
 Initialize a destructive getter property. More...
 
void init_readonly_property (const std::string &key, as_function &getter, int flags=DefaultFlags)
 Use this method for read-only properties. More...
 
void init_readonly_property (const std::string &key, as_c_function_ptr getter, int flags=DefaultFlags)
 Use this method for read-only properties. More...
 
bool watch (const ObjectURI &uri, as_function &trig, const as_value &cust)
 Add a watch trigger, overriding any other defined for same name. More...
 
bool unwatch (const ObjectURI &uri)
 Remove a watch trigger. More...
 
virtual bool get_member (const ObjectURI &uri, as_value *val)
 Get a property by name if it exists. More...
 
virtual as_objectget_super (const ObjectURI &fname)
 
as_objectget_super ()
 
DSOTEXPORT std::pair< bool, bool > delProperty (const ObjectURI &uri)
 Delete a property of this object, unless protected from deletion. More...
 
PropertygetOwnProperty (const ObjectURI &uri)
 Get this object's own named property, if existing. More...
 
void set_member_flags (const ObjectURI &uri, int setTrue, int setFalse=0)
 Set member flags (probably used by ASSetPropFlags) More...
 
virtual bool isSuper () const
 Return true if this is a 'super' object. More...
 
void addInterface (as_object *ctor)
 Add an interface to the list of interfaces. More...
 
bool instanceOf (as_object *ctor)
 Check whether this object is an instance of the given constructor. More...
 
bool prototypeOf (as_object &instance)
 Check whether this object is in another object's inheritance chain. More...
 
void setPropFlags (const as_value &props, int set_false, int set_true)
 Set property flags. More...
 
void copyProperties (const as_object &o)
 Copy properties from the given object. More...
 
void clearProperties ()
 Drop all properties from this object. More...
 
template<typename T >
void visitProperties (PropertyVisitor &visitor) const
 Visit the properties of this object by key/as_value pairs. More...
 
void visitKeys (KeyVisitor &visitor) const
 Visit all visible property identifiers. More...
 
void add_property (const std::string &key, as_function &getter, as_function *setter)
 Add a getter/setter property if no member already has that name. More...
 
as_objectget_prototype () const
 Return this object's proto member. More...
 
void set_prototype (const as_value &proto)
 Set this object's proto member. More...
 
void setRelay (Relay *p)
 Set the as_object's Relay object. More...
 
Relayrelay () const
 Access the as_object's Relay object. More...
 
bool array () const
 Return true if this object should be treated as an array. More...
 
void setArray (bool array=true)
 Set whether this object should be treated as an array. More...
 
DisplayObjectdisplayObject () const
 Return the DisplayObject associated with this object. More...
 
void setDisplayObject (DisplayObject *d)
 Set the DisplayObject associated with this as_object. More...
 
- Public Member Functions inherited from gnash::GcResource
 GcResource (GC &gc)
 Create a Garbage-collected resource associated with a GC. More...
 
void setReachable () const
 Mark this resource as being reachable. More...
 
bool isReachable () const
 Return true if this object is marked as reachable. More...
 
void clearReachable () const
 Clear the reachable flag. More...
 

Additional Inherited Members

- Static Public Attributes inherited from gnash::as_object
static const int DefaultFlags
 The most common flags for built-in properties. More...
 
- Protected Member Functions inherited from gnash::UserFunction
 UserFunction (Global_as &gl)
 
virtual ~UserFunction ()=0
 This is an abstract base class! More...
 
- Protected Member Functions inherited from gnash::as_function
 as_function (Global_as &gl)
 Construct a function. More...
 
- Protected Member Functions inherited from gnash::as_object
 as_object (VM &vm)
 Construct an as_object associated with a VM. More...
 
- Protected Member Functions inherited from gnash::GcResource
virtual ~GcResource ()
 Delete this resource. More...
 
- Protected Attributes inherited from gnash::Function
std::vector< Argument_args
 
as_environment_env
 @ might need some kind of ref count here, but beware cycles More...
 
const ConstantPool_pool
 The ConstantPool in effect at time of function definition. More...
 

Detailed Description

Function2 adds extra sauce to ordinary Functions.

The Function2 was introduced in version 6 of the player. Differences from ordinary functions are:

  1. Up to 256 local registers.
  2. Ability to suppress super, this, arguments
  3. Ability to store super, this, arguments, _global, _root, and _parent in registers.

Member Enumeration Documentation

§ DefineFunction2Flags

Enumerator
PRELOAD_THIS 

Bind one register to "this".

SUPPRESS_THIS 

No "this" variable accessible by name.

PRELOAD_ARGUMENTS 

Bind one register to "arguments".

SUPPRESS_ARGUMENTS 

No "argument" variable accessible by name.

PRELOAD_SUPER 

Bind one register to "super".

SUPPRESS_SUPER 

No "super" variable accessible by name.

PRELOAD_ROOT 

Bind one register to "_root".

PRELOAD_PARENT 

Bind one register to "_parent".

PRELOAD_GLOBAL 

Bind one register to "_global".

Constructor & Destructor Documentation

§ Function2()

gnash::Function2::Function2 ( const action_buffer ab,
as_environment env,
size_t  start,
const ScopeStack with_stack 
)

§ ~Function2()

virtual gnash::Function2::~Function2 ( )
inlinevirtual

Member Function Documentation

§ call()

as_value gnash::Function2::call ( const fn_call fn)
virtual

§ registers()

virtual std::uint8_t gnash::Function2::registers ( ) const
inlinevirtual

Return the number of registers to allocate for this function.

Reimplemented from gnash::Function.

§ setFlags()

void gnash::Function2::setFlags ( std::uint16_t  flags)
inline

References call().

§ setRegisterCount()

void gnash::Function2::setRegisterCount ( std::uint8_t  ct)
inline

The documentation for this class was generated from the following files: