libcore/NativeFunction.h

   1 //
   2 //   Copyright (C) 2005, 2006, 2007, 2008, 2009, 2010 Free Software
   3 //   Foundation, Inc
   4 //
   5 // This program is free software; you can redistribute it and/or modify
   6 // it under the terms of the GNU General Public License as published by
   7 // the Free Software Foundation; either version 3 of the License, or
   8 // (at your option) any later version.
   9 //
  10 // This program is distributed in the hope that it will be useful,
  11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 // GNU General Public License for more details.
  14 //
  15 // You should have received a copy of the GNU General Public License
  16 // along with this program; if not, write to the Free Software
  17 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  18
  19 #ifndef GNASH_NATIVE_FUNCTION_H
  20 #define GNASH_NATIVE_FUNCTION_H
  21
  22 #include "as_function.h" // for inheritance
  23
  24 #include <cassert>
  25
  26 namespace gnash {
  27     class fn_call;
  28 }
  29
  30 namespace gnash {
  31
  32 /// This class implements functions native to the player.
  33 //
  34 /// They are not implemented in ActionScript in the reference player, but
  35 /// rather have access to internal functions.
  36 //
  37 /// Native functions include methods for handling SharedObjects, NetConnections
  38 /// and MovieClips, but also constructors for types such as String, Number,
  39 /// Array, Boolean, and MovieClip.
  40 class NativeFunction : public as_function
  41 {
  42     typedef as_value (*ASFunction)(const fn_call& fn);
  43
  44 public:
  45
  46         /// Construct a builtin function/class with a default interface
  47         //
  48         /// The default interface will have a constructor member set as 'this'
  49         ///
  50         /// @param func
  51         ///     The C function to call when this as_function is invoked.
  52         ///     For classes, the function pointer is the constructor.
  53         ///
  54     NativeFunction(Global_as& gl, ASFunction func)
  55                 :
  56                 as_function(gl),
  57                 _func(func)
  58         {
  59         }
  60
  61         /// Invoke this function
  62         virtual as_value call(const fn_call& fn)
  63         {
  64                 assert(_func);
  65                 return _func(fn);
  66         }
  67
  68         bool isBuiltin()  { return true; }
  69
  70 private:
  71
  72         ASFunction _func;
  73 };
  74
  75 } // end of gnash namespace
  76
  77 #endif
  78