SwfdecAsContext

typedef struct _SwfdecAsContext SwfdecAsContext;

This is the main object ued to hold the state of a script engine. All members are private and should not be accessed.

Subclassing this structure to get scripting support in your own appliation is encouraged.

swfdec_as_context_startup ()

void                swfdec_as_context_startup           (SwfdecAsContext *context,
                                                         guint version);

Starts up the context. This function must be called before any Actionscript is called on context. The version is responsible for deciding which native functions and properties are available in the context.

swfdec_as_context_abort ()

void                swfdec_as_context_abort             (SwfdecAsContext *context,
                                                         const char *reason);

Aborts script execution in context. Call this functon if the script engine encountered a fatal error and cannot continue. A possible reason for this is an out-of-memory condition.

swfdec_as_context_get_string ()

const char*         swfdec_as_context_get_string        (SwfdecAsContext *context,
                                                         const char *string);

Gets the garbage-collected version of string. You need to call this function for every not garbage-collected string that you want to use in Swfdecs script interpreter.

swfdec_as_context_give_string ()

const char*         swfdec_as_context_give_string       (SwfdecAsContext *context,
                                                         char *string);

Takes ownership of string and returns a refcounted version of the same string. This function is the same as swfdec_as_context_get_string(), but takes ownership of string.

swfdec_as_context_use_mem ()

gboolean            swfdec_as_context_use_mem           (SwfdecAsContext *context,
                                                         gsize bytes);

Registers bytes additional bytes as in use by the context. This function keeps track of the memory that script code consumes. If too many memory is in use, this function may decide to stop the script engine with an out of memory error.

swfdec_as_context_gc ()

void                swfdec_as_context_gc                (SwfdecAsContext *context);

Calls the Swfdec Gargbage collector and reclaims any unused memory. You should call this function or swfdec_as_context_maybe_gc() regularly.

swfdec_as_context_maybe_gc ()

void                swfdec_as_context_maybe_gc          (SwfdecAsContext *context);

Calls the garbage collector if necessary. It's a good idea to call this function regularly instead of swfdec_as_context_gc() as it only does collect garage as needed. For example, SwfdecPlayer calls this function after every frame advancement.

swfdec_as_context_run ()

void                swfdec_as_context_run               (SwfdecAsContext *context);

Continues running the script engine. Executing code in this engine works in 2 steps: First, you push the frame to be executed onto the stack, then you call this function to execute it. So this function is the single entry point to script execution. This might be helpful when debugging your application.

swfdec_as_context_unuse_mem ()

void                swfdec_as_context_unuse_mem         (SwfdecAsContext *context,
                                                         gsize bytes);

Releases a number of bytes previously allocated using swfdec_as_context_use_mem(). See that function for details.

swfdec_as_context_eval ()

void                swfdec_as_context_eval              (SwfdecAsContext *context,
                                                         SwfdecAsObject *obj,
                                                         const char *str,
                                                         SwfdecAsValue *val);

This function works like the Actionscript eval function used on obj. It handles both slash-style and dot-style notation. If an error occured during evaluation, the return value will be the undefined value.

swfdec_as_context_eval_set ()

void                swfdec_as_context_eval_set          (SwfdecAsContext *context,
                                                         SwfdecAsObject *obj,
                                                         const char *str,
                                                         const SwfdecAsValue *val);

Sets the variable referenced by str to val. If str does not reference a valid property, nothing happens.

swfdec_as_context_get_time ()

void                swfdec_as_context_get_time          (SwfdecAsContext *context,
                                                         GTimeVal *tv);

This function queries the time to be used inside this context. By default, this is the same as g_get_current_time(), but it may be overwriten to allow things such as slower or faster playback.

swfdec_as_context_get_frame ()

SwfdecAsFrame*      swfdec_as_context_get_frame         (SwfdecAsContext *context);

This is a debugging function. It gets the topmost stack frame that is currently executing. If no function is executing, NULL is returned. You can easily get a backtrace with code like this:

for (frame = swfdec_as_context_get_frame (context); frame != NULL; 
    frame = swfdec_as_frame_get_next (frame)) {
  char *s = swfdec_as_object_get_debug (SWFDEC_AS_OBJECT (frame));
  g_print ("%s\n", s);
  g_free (s);
}

swfdec_as_context_is_constructing ()

gboolean            swfdec_as_context_is_constructing   (SwfdecAsContext *context);

Determines if the contexxt is currently constructing. This information is used by various constructors to do different things when they are constructing and when they are not. The Boolean, Number and String functions for example setup the newly constructed objects when constructing but only cast the provided argument when being called.