libcore/ClassHierarchy.h

   1 //
   2 //   Copyright (C) 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
   3 //
   4 // This program is free software; you can redistribute it and/or modify
   5 // it under the terms of the GNU General Public License as published by
   6 // the Free Software Foundation; either version 3 of the License, or
   7 // (at your option) any later version.
   8 //
   9 // This program is distributed in the hope that it will be useful,
  10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 // GNU General Public License for more details.
  13 //
  14 // You should have received a copy of the GNU General Public License
  15 // along with this program; if not, write to the Free Software
  16 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  17 //
  18
  19 #ifndef GNASH_CLASS_HIERARCHY_H
  20 #define GNASH_CLASS_HIERARCHY_H
  21
  22 #ifdef HAVE_CONFIG_H
  23 #include "gnashconfig.h"
  24 #endif
  25
  26 #include <string>
  27 #include <vector>
  28 #include <iosfwd>
  29
  30 #include "ObjectURI.h"
  31
  32 namespace gnash {
  33     class Extension;
  34     class as_object;
  35 }
  36
  37 namespace gnash {
  38
  39 /// Register all of the ActionScript classes, with their dependencies.
  40 class ClassHierarchy
  41 {
  42 public:
  43         struct ExtensionClass
  44         {
  45                 /// The filename for the library relative to the plugins directory.
  46                 std::string file_name;
  47
  48                 /// Initialization function name
  49                 ///
  50                 /// The name of the function which will yield the prototype
  51                 /// object. It should be a function with signature:
  52                 /// void init_name(as_object &obj);
  53                 /// which sets its prototype as the member 'name' in the
  54                 /// object. See extensions/mysql/mysql_db.cpp function
  55                 /// mysql_class_init
  56                 std::string init_name;
  57
  58         const ObjectURI uri;
  59
  60                 /// The version at which this should be added.
  61                 int version;
  62         };
  63
  64         struct NativeClass
  65         {
  66
  67         /// The type of function to use for initialization
  68                 typedef void (*InitFunc)(as_object& obj, const ObjectURI& uri);
  69
  70         NativeClass(InitFunc init, const ObjectURI& u, int ver)
  71             :
  72             initializer(init),
  73             uri(u),
  74             version(ver)
  75         {}
  76
  77                 /// The initialization function
  78                 ///
  79                 /// See ExtensionClass.init_name for the necessary function.
  80                 InitFunc initializer;
  81
  82                 /// The name of the class.
  83                 const ObjectURI uri;
  84
  85                 /// The version at which this should be visible.
  86                 int version;
  87         };
  88
  89     /// \brief
  90         /// Construct the declaration object. Later set the global and
  91         /// extension objects using setGlobal and setExtension
  92         ClassHierarchy(as_object* global, Extension* e)
  93         :
  94                 mGlobal(global),
  95         mExtension(e)
  96         {}
  97
  98         /// \brief
  99         /// Delete our private namespaces.
 100         ~ClassHierarchy();
 101
 102     typedef std::vector<NativeClass> NativeClasses;
 103
 104         /// Declare an ActionScript class, with information on how to load it.
 105         ///
 106         /// @param c
 107         /// The ExtensionClass structure which defines the class.
 108         ///
 109         /// @return true, unless the class with c.name already existed.
 110         bool declareClass(ExtensionClass& c);
 111
 112         /// Declare an ActionScript class and how to instantiate it from the core.
 113         ///
 114         /// @param c
 115         /// The NativeClass structure which defines the class.
 116         ///
 117         /// @return true, unless the class with c.name already existed.
 118         bool declareClass(const NativeClass& c);
 119
 120         /// Declare a list of native classes.
 121         void declareAll(const NativeClasses& classes);
 122
 123         /// Mark objects for garbage collector.
 124         void markReachableResources() const {}
 125
 126 private:
 127         as_object* mGlobal;
 128         Extension* mExtension;
 129 };
 130
 131 }
 132 #endif
 133