[Gnash-commit] gnash/doc/C/actionscript as_value.xml main.xml ...

[Rob Savoye]

CVSROOT:        /sources/gnash
Module name:    gnash
Changes by:     Rob Savoye <rsavoye>    08/03/01 15:11:30

Removed files:
        doc/C/actionscript: as_value.xml main.xml new_as_class.xml 

Log message:
        Moved to reference manual.

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/actionscript/as_value.xml?cvsroot=gnash&r1=1.3&r2=0
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/actionscript/main.xml?cvsroot=gnash&r1=1.2&r2=0
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/actionscript/new_as_class.xml?cvsroot=gnash&r1=1.5&r2=0

Patches:
Index: as_value.xml
===================================================================
RCS file: as_value.xml
diff -N as_value.xml
--- as_value.xml        18 Apr 2007 17:39:15 -0000      1.3
+++ /dev/null   1 Jan 1970 00:00:00 -0000
@@ -1,75 +0,0 @@
-    <sect1 id="as_value">
-      <title>The <emphasis>as_value</emphasis> Object Type</title>
-      <para>
-        The <emphasis>as_value</emphasis> class is used throughout
-        the interpreter to create generic objects to hold data.
-      </para>
-
-      <sect2 id="data_types">
-        <title>Data Types</title>
-        <para>
-          The following data types are supported:
-          <emphasis>NULLTYPE</emphasis>,
-          <emphasis>BOOLEAN</emphasis>, <emphasis>STRING</emphasis>,
-          <emphasis>NUMBER</emphasis>, <emphasis>OBJECT</emphasis>,
-          <emphasis>AS_FUNCTION</emphasis>, and 
-          <emphasis>MOVIECLIP</emphasis> (sprite).  
-          The type <emphasis>C_FUNCTION</emphasis> is being deprecated.
-        </para>
-      </sect2>
-
-      <sect2 id="is_methods">
-        <title>Determining the Type</title>
-        <para>
-          Several methods allow you to determine if a value stored in
-          <emphasis>as_value</emphasis> is of a specific type.  These
-          follow the form of <emphasis>is_TYPE</emphasis>, for example
-          <emphasis>is_as_function()</emphasis> and 
-          <emphasis>is_number()</emphasis>.  In general, the type names
-          match the <link linkend="data_types">data types</link> listed
-          above, with the exception of the type <emphasis>MOVIECLIP</emphasis>
-          which has a method <emphasis>is_sprite()</emphasis>.
-        </para>
-      </sect2>
-
-      <sect2 id="to_methods">
-        <title>Fetching the Value</title>
-        <para>
-          Another set of methods will return a representation of
-          the value as a particular type.  They follow the
-          <emphasis>to_TYPE</emphasis> naming convention.  Examples
-          are <emphasis>to_number()</emphasis> and
-          <emphasis>to_bool()</emphasis>.  The type names are as 
-          <link linkend="data_types">listed</link> earlier, except for
-          <emphasis>MOVIECLIP</emphasis>, which uses 
-          <emphasis>to_sprite()</emphasis>.
-        </para>
-      </sect2>
-
-      <sect2 id="set_methods">
-        <title>Setting the Value and Type</title>
-        <para>
-          Finally, there is the <emphasis>set_TYPE</emphasis> series
-          of methods.  They change the type to the type specified in
-          the method name, and set the value to the one given as an
-          argument.  It is also possible to accomplish the same thing
-          with the <emphasis>=</emphasis> operator.  Again, type names
-          match those <link linkend="data_types">named earlier</link>,
-          except in the case of <emphasis>MOVIECLASS</emphasis>.  Its
-          method is called <emphasis>set_sprite()</emphasis>.
-        </para>
-      </sect2>
-
-      <sect2 id="further_as_value_reading">
-        <title>Further Reading</title>
-        <para>
-          Please refer to <emphasis>as_value.h</emphasis> or the
-          Doxygen documentation (see 'Processing The Documentation'
-          in the &appname; manual for instructions on generating
-          documents with Doxygen) for more information
-          about which methods are available for the
-          <emphasis>as_value</emphasis> object.
-        </para>
-      </sect2>
-
-    </sect1>

Index: main.xml
===================================================================
RCS file: main.xml
diff -N main.xml
--- main.xml    19 Mar 2007 14:50:33 -0000      1.2
+++ /dev/null   1 Jan 1970 00:00:00 -0000
@@ -1,29 +0,0 @@
-    <sect1 id="introduction">
-      <title>Introduction</title>
-
-      <para>
-        In this document, the term 'ActionScript class' refers to the
-        C++ class which is instantiated by Gnash when some ActionScript
-        code instantiates a corresponding class.  The C++ class
-        stores instance data and implements the methods which are 
-        called on the object in the ActionScript code.
-      </para>
-
-      <sect2 id="overview">
-        <title>Object Creation Overview</title>
-          <para>
-            When Gnash starts, the <emphasis>class_init()</emphasis> method 
-            for each ActionScript class (listed in Global.cpp) is called.
-            This method constructs a prototype, which is implemented as an
-            <emphasis>as_object</emphasis>.  In addition, the method
-            registers the constructor to be used for future object creation,
-            and attaches methods and properties to the prototype.
-          </para>
-
-          <para>
-            When a new object is needed, instance data is added to
-            the methods and properties inherited from the prototype.
-          </para>
-      </sect2>
-    </sect1>
-

Index: new_as_class.xml
===================================================================
RCS file: new_as_class.xml
diff -N new_as_class.xml
--- new_as_class.xml    20 Mar 2007 15:51:49 -0000      1.5
+++ /dev/null   1 Jan 1970 00:00:00 -0000
@@ -1,219 +0,0 @@
-    <sect1 id="newclass">
-      <title>Adding New ActionScript Class</title>
-
-      <para>
-        Adding a new ActionScript class is relatively simple, but the
-        process is complicated by the fact that the interface has evolved
-        over time and the current code base represents several different
-        formats.  This document describes the current interface.  The
-        Boolean class should be considered the authoritative example of
-        a modern ActionScript class.
-      </para>
-
-      <para>
-        ActionScript classes contain a header file and a C++
-        implementation.  The name is usually the name of the
-        class as it is called in the ActionScript specifications;
-        for instance <emphasis>Boolean.cpp</emphasis> for the Boolean class.
-      </para>
-
-      <para> 
-        In the CVS source tree, there is a utility file named
-        &gen_asclass; which can be used to
-        create the header file and a C++ source file stub for
-        an ActionScript class.  
-      </para>
-
-      <sect2 id="prototype">
-        <title>Prototype</title>
-
-       <para>
-          In ActionScript, a prototype is a base object which contains
-          all the methods that an instantiated object will contain.
-          In short, it contains every part of the class except for
-          the portions dealing with the storage of instance data.
-       </para>
-       <para>
-          In Gnash, the prototype of an ActionScript object is 
-          implemented as an <emphasis>as_object</emphasis>.
-          At startup, the methods and properties of the ActionScript class
-          are attached to the <emphasis>as_object</emphasis>.  The
-          following example demonstrates how methods can be attached:
-         <programlisting>
-            static void
-            attachBooleanInterface(as_object&amp; o) 
-            {
-                o.init_member("toString", new 
builtin_function(boolean_tostring));
-                o.init_member("valueOf", new 
builtin_function(boolean_valueof));
-            }
-         </programlisting>
-          This code was generated using &gen_asclass;.
-          Typically, you will need to customize the attach method to include
-          any new methods you add to the class.
-       </para>
-       <para>
-          Static properties can also be added to the ActionScript prototype
-          (<link linkend="properties">dynamic properties</link> 
-          are addressed later).  They are attached in a similar way:
-          <programlisting>
-           o.init_member("myProperty", as_value("HelloWorld"));
-         </programlisting>
-       </para>
-       <para>
-          Properties which have been added in this manner can be
-          directly accessed in ActionScript code without a function
-          call, as this piece of ActionScript code compiled by Ming's
-          <emphasis>makeswf</emphasis> compiler demonstrates:
-           <programlisting>
-             // Get the value of the myProperty property
-             if (node.myProperty == "HelloWorld") {
-                 trace("MATCHED");
-             }
-           </programlisting>
-       </para>
-      </sect2>
-
-      <sect2 id="declaration">
-       <title>Declaration</title>
-
-       <para>
-          A new class should derive from <emphasis>as_object</emphasis>,
-          which is the base class of every ActionScript object in Gnash.
-          The class declaration will also be generated when you use
-          &gen_asclass;.
-       </para>
-      </sect2>
-      
-      <sect2 id="instantiation">
-       <title>Instantiation</title>
-
-       <para>
-          The class should contain an init method; this is included
-          in the stub when &gen_asclass; is
-          used.
-       </para>
-       <para>
-          The init method should be called in the constructor in
-          <emphasis>Global.cpp</emphasis>, where all other ActionScript
-          classes are similarly referenced.
-       </para>
-      </sect2>
-
-      <sect2 id="methods">
-       <title>Methods</title>
-
-        <para>
-          Every method you implement and 
-          <link linkend="prototype">attach</link> will receive an
-          &fn_call; data structure as an argument when it is called.
-        </para>
-
-        <sect3 id="arguments">
-          <title>Accessing Arguments</title>
-          <para>
-            The arguments stored in &fn_call;
-            should be accessed using <emphasis>arg()</emphasis>.  For
-            instance, the first element can be popped with
-            <emphasis>fn.arg(0)</emphasis>.
-         </para>
-          <para>
-            The element popped off the stack is an 
-            <link linkend="as_value"><emphasis>as_value</emphasis>
-            object</link>.
-          </para>
-        </sect3>
-
-        <sect3 id="return">
-          <title>Returning a Value to ActionScript</title>
-          <para>
-            The return value should be an
-            <link linkend="as_value"><emphasis>as_value</emphasis> 
-            object</link>.  For example:
-            <programlisting>
-              return as_value('Goodbye, cruel world.');
-            </programlisting>
-          </para>
-        </sect3>
-
-        <sect3 id="additional_fn_call">
-          <title>Additional &fn_call; Members</title>
-          <para>
-            There are two other useful members of the &fn_call;
-            structure, namely <emphasis>this_ptr</emphasis> and
-            <emphasis>nargs</emphasis>.  The former points to the
-            class which is invoking this method, while the latter
-            is a count of the number of 
-            <link linkend="arguments">arguments in the stack</link>.
-         </para>
-         <para>
-            You may also see instances of the <emphasis>env</emphasis>
-            pointer being used.   This is being deprecated.  Instances
-            which could be replaced with
-            <link linkend="arguments"><emphasis>arg()</emphasis></link>
-            are already deprecated; other uses will be deprecated
-            in the near future.
-         </para>
-          <para>
-            Beyond the <emphasis><link 
-            linkend="arguments">arg()</link></emphasis> method, there
-            is one method of note.  <emphasis>dump_args()</emphasis>
-            can be used in debugging to output the entire argument
-            stack.
-         </para>
-        </sect3>
-      </sect2>
-
-      <sect2 id="properties">
-       <title>Dynamic Properties</title>
-        <para>
-          This section describes accessors to dynamic properties.
-          Read-only properties are described
-          in the <link linkend="prototype">prototype</link> section.
-        </para>
-        <para>
-          Dynamic properties are not created by the &gen_asclass; 
-          script.  Accessors should be written as
-          a single get/set method.  Previously this was done by
-          overriding <emphasis>get_member()</emphasis> and
-          <emphasis>set_member()</emphasis>, but this practice
-          is deprecated.  
-        </para>
-        <para> 
-          The accessor is written so that it sets the property
-          if it is called with an argument, and puts the property in
-          the <link linkend="methods">&fn_call;</link>
-          <link linkend="return">result pointer</link>.  For instance:
-          <programlisting>
-            void
-            MyClass::myProperty_getset(const fn_call&amp; fn)
-            {
-
-                boost::intrusive_ptr&lt;MyClass&gt; ptr = 
ensureType&lt;MyClass&gt;(fn.this_ptr);
-
-                // setter
-                if ( fn.nargs > 0 )
-                {
-                    bool h = fn.arg(0).to_bool();
-                    ptr->MyMethod(h);
-                    return;
-                }
-
-                // getter
-                bool h = ptr->MyMethod();
-                fn.result->set_bool(h);
-            }
-          </programlisting>
-        </para>
-        <para> 
-          It has not yet been decided whether properties should be set
-          in the <link linkend="prototype">exported interface</link> 
-          or attached to instances of the class.  A property is attached
-          in the following manner:
-          <programlisting>
-            boost::intrusive_ptr&lt;builtin_function&gt; gettersetter;
-            gettersetter = new 
builtin_function(&amp;MyClass::myProperty_getset, NULL);
-            o.init_property("myProperty", *gettersetter, *gettersetter);
-          </programlisting>
-        </para>
-      </sect2>
-    </sect1>