src/Scripting/NasalCanvas.cxx

   1 // NasalCanvas.cxx -- expose Canvas classes to Nasal
   2 //
   3 // Written by James Turner, started 2012.
   4 //
   5 // Copyright (C) 2012 James Turner
   6 //
   7 // This program is free software; you can redistribute it and/or
   8 // modify it under the terms of the GNU General Public License as
   9 // published by the Free Software Foundation; either version 2 of the
  10 // License, or (at your option) any later version.
  11 //
  12 // This program is distributed in the hope that it will be useful, but
  13 // WITHOUT ANY WARRANTY; without even the implied warranty of
  14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15 // General Public License for more details.
  16 //
  17 // You should have received a copy of the GNU General Public License
  18 // along with this program; if not, write to the Free Software
  19 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  20
  21 #ifdef HAVE_CONFIG_H
  22 #  include "config.h"
  23 #endif
  24
  25 #include "NasalCanvas.hxx"
  26 #include <Canvas/canvas_mgr.hxx>
  27 #include <Main/globals.hxx>
  28 #include <Scripting/NasalSys.hxx>
  29
  30 #include <osgGA/GUIEventAdapter>
  31
  32 #include <simgear/sg_inlines.h>
  33
  34 #include <simgear/canvas/Canvas.hxx>
  35 #include <simgear/canvas/elements/CanvasElement.hxx>
  36 #include <simgear/canvas/MouseEvent.hxx>
  37
  38 #include <simgear/nasal/cppbind/from_nasal.hxx>
  39 #include <simgear/nasal/cppbind/to_nasal.hxx>
  40 #include <simgear/nasal/cppbind/NasalHash.hxx>
  41 #include <simgear/nasal/cppbind/Ghost.hxx>
  42
  43 extern naRef propNodeGhostCreate(naContext c, SGPropertyNode* n);
  44
  45 namespace sc = simgear::canvas;
  46
  47 template<class Element>
  48 naRef elementGetNode(naContext c, Element& element)
  49 {
  50   return propNodeGhostCreate(c, element.getProps());
  51 }
  52
  53 typedef nasal::Ghost<sc::EventPtr> NasalEvent;
  54 typedef nasal::Ghost<sc::MouseEventPtr> NasalMouseEvent;
  55 typedef nasal::Ghost<sc::CanvasPtr> NasalCanvas;
  56 typedef nasal::Ghost<sc::ElementPtr> NasalElement;
  57 typedef nasal::Ghost<sc::GroupPtr> NasalGroup;
  58
  59 SGPropertyNode& requireArg(naContext c, int argc, naRef* args, int index = 0)
  60 {
  61   if( argc <= index )
  62     naRuntimeError(c, "missing argument #%d", index);
  63
  64   SGPropertyNode* props = ghostToPropNode(args[index]);
  65   if( !props )
  66     naRuntimeError(c, "arg #%d: not a SGPropertyNode ghost");
  67
  68   return *props;
  69 }
  70
  71 CanvasMgr& requireCanvasMgr(naContext c)
  72 {
  73   CanvasMgr* canvas_mgr =
  74     static_cast<CanvasMgr*>(globals->get_subsystem("Canvas"));
  75   if( !canvas_mgr )
  76     naRuntimeError(c, "Failed to get Canvas subsystem");
  77
  78   return *canvas_mgr;
  79 }
  80
  81 /**
  82  * Create new Canvas and get ghost for it.
  83  */
  84 static naRef f_createCanvas(naContext c, naRef me, int argc, naRef* args)
  85 {
  86   return NasalCanvas::create(c, requireCanvasMgr(c).createCanvas());
  87 }
  88
  89 /**
  90  * Get ghost for existing Canvas.
  91  */
  92 static naRef f_getCanvas(naContext c, naRef me, int argc, naRef* args)
  93 {
  94   SGPropertyNode& props = requireArg(c, argc, args);
  95   CanvasMgr& canvas_mgr = requireCanvasMgr(c);
  96
  97   sc::CanvasPtr canvas;
  98   if( canvas_mgr.getPropertyRoot() == props.getParent() )
  99   {
 100     // get a canvas specified by its root node
 101     canvas = canvas_mgr.getCanvas( props.getIndex() );
 102     if( !canvas || canvas->getProps() != &props )
 103       return naNil();
 104   }
 105   else
 106   {
 107     // get a canvas by name
 108     if( props.hasValue("name") )
 109       canvas = canvas_mgr.getCanvas( props.getStringValue("name") );
 110     else if( props.hasValue("index") )
 111       canvas = canvas_mgr.getCanvas( props.getIntValue("index") );
 112   }
 113
 114   return NasalCanvas::create(c, canvas);
 115 }
 116
 117 naRef f_canvasCreateGroup(sc::Canvas& canvas, const nasal::CallContext& ctx)
 118 {
 119   return NasalGroup::create
 120   (
 121     ctx.c,
 122     canvas.createGroup( ctx.getArg<std::string>(0) )
 123   );
 124 }
 125
 126 naRef f_groupCreateChild(sc::Group& group, const nasal::CallContext& ctx)
 127 {
 128   return NasalElement::create
 129   (
 130     ctx.c,
 131     group.createChild( ctx.requireArg<std::string>(0),
 132                        ctx.getArg<std::string>(1) )
 133   );
 134 }
 135
 136 naRef initNasalCanvas(naRef globals, naContext c, naRef gcSave)
 137 {
 138   NasalEvent::init("canvas.Event");
 139   NasalMouseEvent::init("canvas.MouseEvent")
 140     .bases<NasalEvent>();
 141   NasalCanvas::init("Canvas")
 142     .member("_node_ghost", &elementGetNode<sc::Canvas>)
 143     .member("size_x", &sc::Canvas::getSizeX)
 144     .member("size_y", &sc::Canvas::getSizeY)
 145     .method_func<&f_canvasCreateGroup>("createGroup");
 146   NasalElement::init("canvas.Element")
 147     .member("_node_ghost", &elementGetNode<sc::Element>)
 148     .method<&sc::Element::addEventListener>("addEventListener");
 149   NasalGroup::init("canvas.Group")
 150     .bases<NasalElement>()
 151     .method_func<&f_groupCreateChild>("createChild");
 152
 153   nasal::Hash globals_module(globals, c),
 154               canvas_module = globals_module.createHash("canvas");
 155
 156   canvas_module.set("_newCanvasGhost", f_createCanvas);
 157   canvas_module.set("_getCanvasGhost", f_getCanvas);
 158
 159   return naNil();
 160 }