swfdecasfunction.xml

Swfdec is a decoder/renderer for Macromedia Flash animations. The decoding and rendering engine is

<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="swfdec-SwfdecAsFunction">
<refmeta>
<refentrytitle role="top_of_page">SwfdecAsFunction</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>SWFDEC Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>SwfdecAsFunction</refname>
<refpurpose>script objects that can be executed</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>

<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>

<synopsis>



                    <link linkend="SwfdecAsFunction">SwfdecAsFunction</link>;
<link linkend="void">void</link>                (<link linkend="SwfdecAsNative">*SwfdecAsNative</link>)                   (<link linkend="SwfdecAsContext">SwfdecAsContext</link> *context,
                                                         <link linkend="SwfdecAsObject">SwfdecAsObject</link> *thisp,
                                                         <link linkend="guint">guint</link> argc,
                                                         <link linkend="SwfdecAsValue">SwfdecAsValue</link> *argv,
                                                         <link linkend="SwfdecAsValue">SwfdecAsValue</link> *retval);
                    <link linkend="SwfdecAsNativeFunction">SwfdecAsNativeFunction</link>;
<link linkend="void">void</link>                <link linkend="swfdec-as-function-call">swfdec_as_function_call</link>             (<link linkend="SwfdecAsFunction">SwfdecAsFunction</link> *function,
                                                         <link linkend="SwfdecAsObject">SwfdecAsObject</link> *thisp,
                                                         <link linkend="guint">guint</link> n_args,
                                                         const <link linkend="SwfdecAsValue">SwfdecAsValue</link> *args,
                                                         <link linkend="SwfdecAsValue">SwfdecAsValue</link> *return_value);
<link linkend="SwfdecAsFunction">SwfdecAsFunction</link>*   <link linkend="swfdec-as-native-function-new">swfdec_as_native_function_new</link>       (<link linkend="SwfdecAsContext">SwfdecAsContext</link> *context,
                                                         const <link linkend="char">char</link> *name,
                                                         <link linkend="SwfdecAsNative">SwfdecAsNative</link> native,
                                                         <link linkend="guint">guint</link> min_args,
                                                         <link linkend="SwfdecAsObject">SwfdecAsObject</link> *prototype);
<link linkend="void">void</link>                <link linkend="swfdec-as-native-function-set-construct-type">swfdec_as_native_function_set_construct_type</link>
                                                        (<link linkend="SwfdecAsNativeFunction">SwfdecAsNativeFunction</link> *function,
                                                         <link linkend="GType">GType</link> type);
<link linkend="void">void</link>                <link linkend="swfdec-as-native-function-set-object-type">swfdec_as_native_function_set_object_type</link>
                                                        (<link linkend="SwfdecAsNativeFunction">SwfdecAsNativeFunction</link> *function,
                                                         <link linkend="GType">GType</link> type);

</synopsis>
</refsynopsisdiv>









<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>
Functions is the basic object for executing code in the Swfdec script engine.
There is multiple different variants of functions, such as script-created 
ones and native functions.
</para>
<para>
If you want to create your own functions, you should create native functions.
The easiest way to do this is with <link linkend="swfdec-as-object-add-function"><function>swfdec_as_object_add_function()</function></link> or
<link linkend="swfdec-as-native-function-new"><function>swfdec_as_native_function_new()</function></link>.
</para>
<para>
In Actionscript, every function can be used as a constructor. If you want to
make a native function be used as a constructor for your own <link linkend="SwfdecAsObject"><type>SwfdecAsObject</type></link>
subclass, have a look at <link linkend="swfdec-as-native-function-set-construct-type"><function>swfdec_as_native_function_set_construct_type()</function></link>.</para>
<para>

</para>
</refsect1>

<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="SwfdecAsFunction" role="struct"/>SwfdecAsFunction</title>
<indexterm><primary>SwfdecAsFunction</primary></indexterm><programlisting>typedef struct {
} SwfdecAsFunction;
</programlisting>
<para>
This is the base executable object in Swfdec. It is an abstract object. If 
you want to create functions yourself, use <link linkend="SwfdecAsNativeFunction"><type>SwfdecAsNativeFunction</type></link>.</para>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="SwfdecAsNative" role="function"/>SwfdecAsNative ()</title>
<indexterm><primary>SwfdecAsNative</primary></indexterm><programlisting><link linkend="void">void</link>                (*SwfdecAsNative)                   (<link linkend="SwfdecAsContext">SwfdecAsContext</link> *context,
                                                         <link linkend="SwfdecAsObject">SwfdecAsObject</link> *thisp,
                                                         <link linkend="guint">guint</link> argc,
                                                         <link linkend="SwfdecAsValue">SwfdecAsValue</link> *argv,
                                                         <link linkend="SwfdecAsValue">SwfdecAsValue</link> *retval);</programlisting>
<para>
This is the prototype for all native functions.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>context</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="SwfdecAsContext"><type>SwfdecAsContext</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>thisp</parameter>&nbsp;:</term>
<listitem><simpara> the this object. <warning>Can be <link linkend="NULL:CAPS"><literal>NULL</literal></link>.</warning>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>argc</parameter>&nbsp;:</term>
<listitem><simpara> number of arguments passed to this function
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>argv</parameter>&nbsp;:</term>
<listitem><simpara> the <parameter>argc</parameter> arguments passed to this function
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>retval</parameter>&nbsp;:</term>
<listitem><simpara> set to the return value. Initialized to undefined by default
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="SwfdecAsNativeFunction" role="struct"/>SwfdecAsNativeFunction</title>
<indexterm><primary>SwfdecAsNativeFunction</primary></indexterm><programlisting>typedef struct {
} SwfdecAsNativeFunction;
</programlisting>
<para>
This is the object type for native functions.</para>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="swfdec-as-function-call" role="function"/>swfdec_as_function_call ()</title>
<indexterm><primary>swfdec_as_function_call</primary></indexterm><programlisting><link linkend="void">void</link>                swfdec_as_function_call             (<link linkend="SwfdecAsFunction">SwfdecAsFunction</link> *function,
                                                         <link linkend="SwfdecAsObject">SwfdecAsObject</link> *thisp,
                                                         <link linkend="guint">guint</link> n_args,
                                                         const <link linkend="SwfdecAsValue">SwfdecAsValue</link> *args,
                                                         <link linkend="SwfdecAsValue">SwfdecAsValue</link> *return_value);</programlisting>
<para>
Calls the given function. This means a <link linkend="SwfdecAsFrame"><type>SwfdecAsFrame</type></link> is created for the 
function and pushed on top of the execution stack. The function is however
not executed. Call <link linkend="swfdec-as-context-run"><function>swfdec_as_context_run()</function></link> to execute it.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>function</parameter>&nbsp;:</term>
<listitem><simpara> the <link linkend="SwfdecAsFunction"><type>SwfdecAsFunction</type></link> to call
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>thisp</parameter>&nbsp;:</term>
<listitem><simpara> this argument to use for the call or <link linkend="NULL:CAPS"><literal>NULL</literal></link> for none
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>n_args</parameter>&nbsp;:</term>
<listitem><simpara> number of arguments to pass to the function
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>args</parameter>&nbsp;:</term>
<listitem><simpara> the arguments to pass or <link linkend="NULL:CAPS"><literal>NULL</literal></link> to read the last <parameter>n_args</parameter> stack elements
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>return_value</parameter>&nbsp;:</term>
<listitem><simpara> pointer for return value or <link linkend="NULL:CAPS"><literal>NULL</literal></link> to push the return value to 
               the stack
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-as-native-function-new" role="function"/>swfdec_as_native_function_new ()</title>
<indexterm><primary>swfdec_as_native_function_new</primary></indexterm><programlisting><link linkend="SwfdecAsFunction">SwfdecAsFunction</link>*   swfdec_as_native_function_new       (<link linkend="SwfdecAsContext">SwfdecAsContext</link> *context,
                                                         const <link linkend="char">char</link> *name,
                                                         <link linkend="SwfdecAsNative">SwfdecAsNative</link> native,
                                                         <link linkend="guint">guint</link> min_args,
                                                         <link linkend="SwfdecAsObject">SwfdecAsObject</link> *prototype);</programlisting>
<para>
Creates a new native function, that will execute <parameter>native</parameter> when called. The
<parameter>min_args</parameter> parameter sets a requirement for the minimum number of arguments
to pass to <parameter>native</parameter>. If the function gets called with less arguments, it
will just redurn undefined. You might want to use 
<link linkend="swfdec-as-object-add-function"><function>swfdec_as_object_add_function()</function></link> instead of this function.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>context</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="SwfdecAsContext"><type>SwfdecAsContext</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>name</parameter>&nbsp;:</term>
<listitem><simpara> name of the function
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>native</parameter>&nbsp;:</term>
<listitem><simpara> function to call when executed
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>min_args</parameter>&nbsp;:</term>
<listitem><simpara> minimum number of arguments required
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>prototype</parameter>&nbsp;:</term>
<listitem><simpara> The object to be used as "prototype" property for the created 
            function or <link linkend="NULL:CAPS"><literal>NULL</literal></link> for none.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new <link linkend="SwfdecAsFunction"><type>SwfdecAsFunction</type></link> or <link linkend="NULL:CAPS"><literal>NULL</literal></link> on OOM
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-as-native-function-set-construct-type" role="function"/>swfdec_as_native_function_set_construct_type ()</title>
<indexterm><primary>swfdec_as_native_function_set_construct_type</primary></indexterm><programlisting><link linkend="void">void</link>                swfdec_as_native_function_set_construct_type
                                                        (<link linkend="SwfdecAsNativeFunction">SwfdecAsNativeFunction</link> *function,
                                                         <link linkend="GType">GType</link> type);</programlisting>
<para>
Sets the <parameter>type</parameter> to be used when using <parameter>function</parameter> as a constructor. If this is
not set, using <parameter>function</parameter> as a constructor will create a <link linkend="SwfdecAsObject"><type>SwfdecAsObject</type></link>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>function</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="SwfdecAsNativeFunction"><type>SwfdecAsNativeFunction</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>type</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="GType"><type>GType</type></link> used when constructing an object with <parameter>function</parameter>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-as-native-function-set-object-type" role="function"/>swfdec_as_native_function_set_object_type ()</title>
<indexterm><primary>swfdec_as_native_function_set_object_type</primary></indexterm><programlisting><link linkend="void">void</link>                swfdec_as_native_function_set_object_type
                                                        (<link linkend="SwfdecAsNativeFunction">SwfdecAsNativeFunction</link> *function,
                                                         <link linkend="GType">GType</link> type);</programlisting>
<para>
Sets the required type for the this object to <parameter>type</parameter>. If the this object 
isn't of the required type, the function will not be called and its
return value will be undefined.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>function</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="SwfdecAsNativeFunction"><type>SwfdecAsNativeFunction</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>type</parameter>&nbsp;:</term>
<listitem><simpara> required <link linkend="GType"><type>GType</type></link> for the this object
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>





<refsect1><refsect2 /><refsect2 /></refsect1>
</refentry>