Classes | Public Types | Public Member Functions | Protected Attributes

gnash::Function Class Reference

A simple SWF-defined Function. More...

#include <Function.h>

Inheritance diagram for gnash::Function:
Inheritance graph
[legend]
Collaboration diagram for gnash::Function:
Collaboration graph
[legend]

List of all members.

Classes

struct  Argument

Public Types

typedef std::vector< as_object * > ScopeStack

Public Member Functions

 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 ScopeStackgetScopeStack () const
const action_buffergetActionBuffer () const
size_t getStartPC () const
size_t getLength () const
virtual boost::uint8_t registers () const
 Get the number of registers required for function execution.
void add_arg (boost::uint8_t reg, string_table::key name)
 Add an expected argument for the function.
void setLength (size_t len)
 Set the length in bytes of the function code.
virtual as_value call (const fn_call &fn)
 Dispatch.
virtual void markReachableResources () const
 Mark reachable resources. Override from as_object.

Protected Attributes

std::vector< Argument_args
as_environment_env
 @ might need some kind of ref count here, but beware cycles

Detailed Description

A simple SWF-defined Function.

This represents a callable Function defined in a SWF. The basic version creates a scope in which and 'arguments' array, 'this', 'super', and the expected argument names are defined. For a more advanced function, see Function2.


Member Typedef Documentation

typedef std::vector<as_object*> gnash::Function::ScopeStack

Constructor & Destructor Documentation

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'.

References start.

virtual gnash::Function::~Function (  )  [inline, virtual]

Member Function Documentation

void gnash::Function::add_arg ( boost::uint8_t  reg,
string_table::key  name 
) [inline]

Add an expected argument for the function.

For ordinary Functions the register is disregarded. This is only relevant for Function2s. All argument names are declared as variables in the function scope, whether the argument is passed or not.

Parameters:
reg The register for the argument.
name The name of the argument.

References _args.

as_value gnash::Function::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).

Implements gnash::as_function.

Reimplemented in gnash::Function2.

References gnash::as_environment::set_original_target(), and gnash::as_environment::set_target().

const action_buffer& gnash::Function::getActionBuffer (  )  const [inline]
size_t gnash::Function::getLength (  )  const [inline]
const ScopeStack& gnash::Function::getScopeStack (  )  const [inline]
size_t gnash::Function::getStartPC (  )  const [inline]
void gnash::Function::markReachableResources (  )  const [virtual]

Mark reachable resources. Override from as_object.

Reachable resources from this object are its scope stack and the prototype.

Reimplemented from gnash::as_object.

virtual boost::uint8_t gnash::Function::registers (  )  const [inline, virtual]

Get the number of registers required for function execution.

For ordinary Functions this is always 0.

Implements gnash::UserFunction.

Reimplemented in gnash::Function2.

void gnash::Function::setLength ( size_t  len  ) 

Set the length in bytes of the function code.


Member Data Documentation

std::vector<Argument> gnash::Function::_args [protected]

Referenced by add_arg(), and gnash::Function2::call().

@ might need some kind of ref count here, but beware cycles

Referenced by gnash::Function2::call().


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