swfdecasvalue.xml

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

<listitem><simpara> a <link linkend="SwfdecAsValue"><type>SwfdecAsValue</type></link> used by context
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a double value. It can be NaN or +-Infinity. It will not be -0.0.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-as-value-to-integer" role="function"/>swfdec_as_value_to_integer ()</title>
<indexterm><primary>swfdec_as_value_to_integer</primary></indexterm><programlisting><link linkend="int">int</link>                 swfdec_as_value_to_integer          (<link linkend="SwfdecAsContext">SwfdecAsContext</link> *context,
                                                         const <link linkend="SwfdecAsValue">SwfdecAsValue</link> *value);</programlisting>
<para>
Converts the given value to an integer. This is done similar to the 
conversion used by <link linkend="swfdec-as-value-to-number"><function>swfdec_as_value_to_number()</function></link>.</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>value</parameter>&nbsp;:</term>
<listitem><simpara> value to convert
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> An Integer that can be represented in 32 bits.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="SWFDEC-AS-VALUE-SET-INT:CAPS" role="macro"/>SWFDEC_AS_VALUE_SET_INT()</title>
<indexterm><primary>SWFDEC_AS_VALUE_SET_INT</primary></indexterm><programlisting>#define SWFDEC_AS_VALUE_SET_INT(val,d) SWFDEC_AS_VALUE_SET_NUMBER(val,d)
</programlisting>
<para>
Sets <parameter>val</parameter> to the given value. Currently this macro is equivalent to
<link linkend="SWFDEC-AS-VALUE-SET-NUMBER:CAPS"><function>SWFDEC_AS_VALUE_SET_NUMBER()</function></link>, but this may change in future versions of
Swfdec.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>val</parameter>&nbsp;:</term>
<listitem><simpara> value to set
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>d</parameter>&nbsp;:</term>
<listitem><simpara> integer value to set
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="SWFDEC-AS-VALUE-SET-NUMBER:CAPS" role="macro"/>SWFDEC_AS_VALUE_SET_NUMBER()</title>
<indexterm><primary>SWFDEC_AS_VALUE_SET_NUMBER</primary></indexterm><programlisting>#define             SWFDEC_AS_VALUE_SET_NUMBER(val,d)</programlisting>
<para>
Sets <parameter>val</parameter> to the given value. If you are sure the value is a valid
integer value, use <link linkend="SWFDEC-AS-VALUE-SET-INT:CAPS"><function>SWFDEC_AS_VALUE_SET_INT()</function></link> instead.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>val</parameter>&nbsp;:</term>
<listitem><simpara> value to set
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>d</parameter>&nbsp;:</term>
<listitem><simpara> double value to set
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="SWFDEC-AS-VALUE-GET-STRING:CAPS" role="macro"/>SWFDEC_AS_VALUE_GET_STRING()</title>
<indexterm><primary>SWFDEC_AS_VALUE_GET_STRING</primary></indexterm><programlisting>#define SWFDEC_AS_VALUE_GET_STRING(val) ((val)-&gt;value.string)
</programlisting>
<para>
Gets the string associated with <parameter>val</parameter>. If you are not sure that the value is
a string value, consider using <link linkend="swfdec-as-value-to-string"><function>swfdec_as_value_to_string()</function></link> instead.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>val</parameter>&nbsp;:</term>
<listitem><simpara> value to get, the value must reference a string
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-as-value-to-string" role="function"/>swfdec_as_value_to_string ()</title>
<indexterm><primary>swfdec_as_value_to_string</primary></indexterm><programlisting>const <link linkend="char">char</link>*         swfdec_as_value_to_string           (<link linkend="SwfdecAsContext">SwfdecAsContext</link> *context,
                                                         const <link linkend="SwfdecAsValue">SwfdecAsValue</link> *value);</programlisting>
<para>
Converts <parameter>value</parameter> to a string according to the rules of Flash. This might 
cause calling back into the script engine if the <parameter>value</parameter> is an object. In
that case, the object's valueOf function is called. 
<warning>Never use this function for debugging purposes.</warning></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>value</parameter>&nbsp;:</term>
<listitem><simpara> value to be expressed as string
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a garbage-collected string representing <parameter>value</parameter>. The value will 
         never be <link linkend="NULL:CAPS"><literal>NULL</literal></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="SWFDEC-AS-VALUE-SET-STRING:CAPS" role="macro"/>SWFDEC_AS_VALUE_SET_STRING()</title>
<indexterm><primary>SWFDEC_AS_VALUE_SET_STRING</primary></indexterm><programlisting>#define             SWFDEC_AS_VALUE_SET_STRING(val,s)</programlisting>
<para>
Sets <parameter>val</parameter> to the given string value.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>val</parameter>&nbsp;:</term>
<listitem><simpara> value to set
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>s</parameter>&nbsp;:</term>
<listitem><simpara> garbage-collected string to use
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="SWFDEC-AS-VALUE-SET-NULL:CAPS" role="macro"/>SWFDEC_AS_VALUE_SET_NULL()</title>
<indexterm><primary>SWFDEC_AS_VALUE_SET_NULL</primary></indexterm><programlisting>#define SWFDEC_AS_VALUE_SET_NULL(val) (val)-&gt;type = SWFDEC_AS_TYPE_NULL
</programlisting>
<para>
Sets <parameter>val</parameter> to the special null value.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>val</parameter>&nbsp;:</term>
<listitem><simpara> value to set
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="SWFDEC-AS-VALUE-GET-OBJECT:CAPS" role="macro"/>SWFDEC_AS_VALUE_GET_OBJECT()</title>
<indexterm><primary>SWFDEC_AS_VALUE_GET_OBJECT</primary></indexterm><programlisting>#define SWFDEC_AS_VALUE_GET_OBJECT(val) ((val)-&gt;value.object)
</programlisting>
<para>
Gets the object associated with <parameter>val</parameter>. If you are not sure that the value is
an object value, consider using <link linkend="swfdec-as-value-to-object"><function>swfdec_as_value_to_object()</function></link> instead.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>val</parameter>&nbsp;:</term>
<listitem><simpara> value to get, the value must reference an object
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-as-value-to-object" role="function"/>swfdec_as_value_to_object ()</title>
<indexterm><primary>swfdec_as_value_to_object</primary></indexterm><programlisting><link linkend="SwfdecAsObject">SwfdecAsObject</link>*     swfdec_as_value_to_object           (<link linkend="SwfdecAsContext">SwfdecAsContext</link> *context,
                                                         const <link linkend="SwfdecAsValue">SwfdecAsValue</link> *value);</programlisting>
<para>
Converts a given value to its representation as an object. The object 
representation for primitive types is a wrapper object of the corresponding 
class (Number for numbers, String for strings, Boolean for bools). If the 
value does not have an object representing it, such as undefined and null 
values, <link linkend="NULL:CAPS"><literal>NULL</literal></link> is returned.</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>value</parameter>&nbsp;:</term>
<listitem><simpara> value to convert
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> object representing <parameter>value</parameter> or <link linkend="NULL:CAPS"><literal>NULL</literal></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="SWFDEC-AS-VALUE-SET-OBJECT:CAPS" role="macro"/>SWFDEC_AS_VALUE_SET_OBJECT()</title>
<indexterm><primary>SWFDEC_AS_VALUE_SET_OBJECT</primary></indexterm><programlisting>#define             SWFDEC_AS_VALUE_SET_OBJECT(val,o)</programlisting>
<para>
Sets <parameter>val</parameter> to the given object. The object must have been added to the 
garbage collector via <link linkend="swfdec-as-object-add"><function>swfdec_as_object_add()</function></link> previously.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>val</parameter>&nbsp;:</term>
<listitem><simpara> value to set
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>o</parameter>&nbsp;:</term>
<listitem><simpara> garbage-collected <link linkend="SwfdecAsObject"><type>SwfdecAsObject</type></link> to use
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-as-value-to-primitive" role="function"/>swfdec_as_value_to_primitive ()</title>
<indexterm><primary>swfdec_as_value_to_primitive</primary></indexterm><programlisting><link linkend="void">void</link>                swfdec_as_value_to_primitive        (<link linkend="SwfdecAsValue">SwfdecAsValue</link> *value);</programlisting>
<para>
Tries to convert the given <parameter>value</parameter> inline to its primitive value. Primitive 
values are values that are not objects. If the value is an object, the 
object's valueOf function is called. If the result of that function is still 
an object, it is returned nonetheless.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>value</parameter>&nbsp;:</term>
<listitem><simpara> value to convert
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-as-value-to-debug" role="function"/>swfdec_as_value_to_debug ()</title>
<indexterm><primary>swfdec_as_value_to_debug</primary></indexterm><programlisting><link linkend="char">char</link>*               swfdec_as_value_to_debug            (const <link linkend="SwfdecAsValue">SwfdecAsValue</link> *value);</programlisting>
<para>
Converts the given <parameter>value</parameter> to a string in a safe way. It will not call into
the scripting engine. Its intended use is for output in debuggers.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>value</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="SwfdecAsValue"><type>SwfdecAsValue</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a newly allocated string. Free with <link linkend="g-free"><function>g_free()</function></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-as-double-to-string" role="function"/>swfdec_as_double_to_string ()</title>
<indexterm><primary>swfdec_as_double_to_string</primary></indexterm><programlisting>const <link linkend="char">char</link>*         swfdec_as_double_to_string          (<link linkend="SwfdecAsContext">SwfdecAsContext</link> *context,
                                                         <link linkend="double">double</link> d);</programlisting>
<para>
Converts <parameter>d</parameter> into a string using the same conversion algorithm as the 
official Flash player.</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>d</parameter>&nbsp;:</term>
<listitem><simpara> a double
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a garbage-collected string
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-as-str-concat" role="function"/>swfdec_as_str_concat ()</title>
<indexterm><primary>swfdec_as_str_concat</primary></indexterm><programlisting>const <link linkend="char">char</link>*         swfdec_as_str_concat                (<link linkend="SwfdecAsContext">SwfdecAsContext</link> *cx,
                                                         const <link linkend="char">char</link> *s1,
                                                         const <link linkend="char">char</link> *s2);</programlisting>
<para>
Convenience function to concatenate two garbage-collected strings. This
function is equivalent to <link linkend="g-strconcat"><function>g_strconcat()</function></link>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>cx</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="SwfdecAsContext"><type>SwfdecAsContext</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>s1</parameter>&nbsp;:</term>
<listitem><simpara> first string
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>s2</parameter>&nbsp;:</term>
<listitem><simpara> second string
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A new garbage-collected string
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>





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