gnash::Function2 Class Reference

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

#include <Function2.h>

Inheritance diagram for gnash::Function2:

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 boost::uint8_t	registers () const
	Return the number of registers to allocate for this function.
void	setRegisterCount (boost::uint8_t ct)
void	setFlags (boost::uint16_t flags)
virtual as_value	call (const fn_call &fn)
	Dispatch.
Public Member Functions inherited from gnash::Function
	Function (const action_buffer &ab, as_environment &env, size_t start, const ScopeStack &with_stack)
	Create an ActionScript function as defined in an action_buffer starting at offset 'start'.
virtual	~Function ()
const ScopeStack &	getScopeStack () const
const action_buffer &	getActionBuffer () const
size_t	getStartPC () const
size_t	getLength () const
void	add_arg (boost::uint8_t reg, const ObjectURI &name)
	Add an expected argument for the function.
void	setLength (size_t len)
	Set the length in bytes of the function code.
virtual void	markReachableResources () const
	Mark reachable resources. Override from as_object.

Additional Inherited Members
Static Public Attributes inherited from gnash::as_object
static const int	DefaultFlags
	The most common flags for built-in properties.
Protected Member Functions inherited from gnash::UserFunction
	UserFunction (Global_as &gl)
virtual	~UserFunction ()=0
	This is an abstract base class!
Protected Attributes inherited from gnash::Function
std::vector< Argument >	_args
as_environment &	_env
	@ might need some kind of ref count here, but beware cycles
const ConstantPool *	_pool
	The ConstantPool in effect at time of function definition.

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

enum gnash::Function2::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

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

virtual gnash::Function2::~Function2 ( )

inlinevirtual

Member Function Documentation

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

virtual

Dispatch.

This is only needed for SWF5 (temp switch of target) We do always and base 'target' value on SWF version. TODO: simplify code by maybe using a custom as_environment instead, so to get an "original" target being the one set now (rather then the really original one) TODO: test scope when calling functions defined in another timeline (target, in particular).

Reimplemented from gnash::Function.

References gnash::Function::_args, gnash::Function::_env, gnash::Function::_pool, gnash::fn_call::arg(), gnash::FrameGuard::callFrame(), gnash::VM::calling(), gnash::Global_as::createArray(), gnash::VM::currentCall(), gnash::declareLocal(), gnash::CallFrame::function(), gnash::as_environment::get_original_target(), gnash::as_object::get_super(), gnash::getArguments(), gnash::DisplayObject::getAsRoot(), gnash::VM::getGlobal(), gnash::getGlobal(), gnash::getObject(), gnash::getSWFVersion(), gnash::getVM(), gnash::key::i, gnash::key::n, gnash::fn_call::nargs, gnash::key::p, gnash::DisplayObject::parent(), PRELOAD_ARGUMENTS, PRELOAD_GLOBAL, PRELOAD_PARENT, PRELOAD_ROOT, PRELOAD_SUPER, PRELOAD_THIS, gnash::NSV::PROP_ARGUMENTS, gnash::NSV::PROP_SUPER, gnash::NSV::PROP_THIS, gnash::key::r, gnash::setLocal(), gnash::CallFrame::setLocalRegister(), gnash::fn_call::super, SUPPRESS_ARGUMENTS, SUPPRESS_SUPER, SUPPRESS_THIS, gnash::as_environment::target(), gnash::fn_call::this_ptr, and gnash::as_object::vm().

virtual boost::uint8_t gnash::Function2::registers ( ) const

inlinevirtual

Return the number of registers to allocate for this function.

Reimplemented from gnash::Function.

void gnash::Function2::setFlags ( boost::uint16_t  flags )

inline

void gnash::Function2::setRegisterCount ( boost::uint8_t  ct )

inline

---

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

• Function2.h
• Function2.cpp