]> git.mxchange.org Git - flightgear.git/blobdiff - src/Scripting/NasalCanvas.cxx
Canvas: store data inside canvas and elements.
[flightgear.git] / src / Scripting / NasalCanvas.cxx
index f349dadb5bf502070c597cfeda85678415dd6618..2e0b0c034ebc79a2c59cacbfff0a3ddda292f70e 100644 (file)
@@ -24,6 +24,7 @@
 
 #include "NasalCanvas.hxx"
 #include <Canvas/canvas_mgr.hxx>
+#include <Canvas/gui_mgr.hxx>
 #include <Main/globals.hxx>
 #include <Scripting/NasalSys.hxx>
 
 #include <simgear/sg_inlines.h>
 
 #include <simgear/canvas/Canvas.hxx>
+#include <simgear/canvas/CanvasWindow.hxx>
 #include <simgear/canvas/elements/CanvasElement.hxx>
 #include <simgear/canvas/elements/CanvasText.hxx>
-#include <simgear/canvas/MouseEvent.hxx>
+#include <simgear/canvas/events/CustomEvent.hxx>
+#include <simgear/canvas/events/MouseEvent.hxx>
 
 #include <simgear/nasal/cppbind/from_nasal.hxx>
 #include <simgear/nasal/cppbind/to_nasal.hxx>
@@ -46,17 +49,36 @@ extern naRef propNodeGhostCreate(naContext c, SGPropertyNode* n);
 namespace sc = simgear::canvas;
 
 template<class Element>
-naRef elementGetNode(naContext c, Element& element)
+naRef elementGetNode(Element& element, naContext c)
 {
   return propNodeGhostCreate(c, element.getProps());
 }
 
 typedef nasal::Ghost<sc::EventPtr> NasalEvent;
+typedef nasal::Ghost<sc::CustomEventPtr> NasalCustomEvent;
 typedef nasal::Ghost<sc::MouseEventPtr> NasalMouseEvent;
+
+struct CustomEventDetailWrapper;
+typedef SGSharedPtr<CustomEventDetailWrapper> CustomEventDetailPtr;
+typedef nasal::Ghost<CustomEventDetailPtr> NasalCustomEventDetail;
+
+typedef nasal::Ghost<simgear::PropertyBasedElementPtr> NasalPropertyBasedElement;
 typedef nasal::Ghost<sc::CanvasPtr> NasalCanvas;
 typedef nasal::Ghost<sc::ElementPtr> NasalElement;
 typedef nasal::Ghost<sc::GroupPtr> NasalGroup;
 typedef nasal::Ghost<sc::TextPtr> NasalText;
+typedef nasal::Ghost<sc::WindowWeakPtr> NasalWindow;
+
+naRef to_nasal_helper(naContext c, const osg::BoundingBox& bb)
+{
+  std::vector<float> bb_vec(4);
+  bb_vec[0] = bb._min.x();
+  bb_vec[1] = bb._min.y();
+  bb_vec[2] = bb._max.x();
+  bb_vec[3] = bb._max.y();
+
+  return nasal::to_nasal(c, bb_vec);
+}
 
 SGPropertyNode* from_nasal_helper(naContext c, naRef ref, SGPropertyNode**)
 {
@@ -67,6 +89,11 @@ SGPropertyNode* from_nasal_helper(naContext c, naRef ref, SGPropertyNode**)
   return props;
 }
 
+sc::CanvasWeakPtr from_nasal_helper(naContext c, naRef ref, sc::CanvasWeakPtr const*)
+{
+  return nasal::from_nasal<sc::CanvasPtr>(c, ref);
+}
+
 CanvasMgr& requireCanvasMgr(naContext c)
 {
   CanvasMgr* canvas_mgr =
@@ -77,12 +104,34 @@ CanvasMgr& requireCanvasMgr(naContext c)
   return *canvas_mgr;
 }
 
+GUIMgr& requireGUIMgr(naContext c)
+{
+  GUIMgr* mgr =
+    static_cast<GUIMgr*>(globals->get_subsystem("CanvasGUI"));
+  if( !mgr )
+    naRuntimeError(c, "Failed to get CanvasGUI subsystem");
+
+  return *mgr;
+}
+
 /**
  * Create new Canvas and get ghost for it.
  */
-static naRef f_createCanvas(naContext c, naRef me, int argc, naRef* args)
+static naRef f_createCanvas(const nasal::CallContext& ctx)
 {
-  return NasalCanvas::create(c, requireCanvasMgr(c).createCanvas());
+  return NasalCanvas::create(ctx.c, requireCanvasMgr(ctx.c).createCanvas());
+}
+
+/**
+ * Create new Window and get ghost for it.
+ */
+static naRef f_createWindow(const nasal::CallContext& ctx)
+{
+  return NasalWindow::create
+  (
+    ctx.c,
+    requireGUIMgr(ctx.c).createWindow( ctx.getArg<std::string>(0) )
+  );
 }
 
 /**
@@ -123,17 +172,12 @@ naRef f_canvasCreateGroup(sc::Canvas& canvas, const nasal::CallContext& ctx)
   );
 }
 
-naRef f_elementGetTransformedBounds(sc::Element& el, const nasal::CallContext& ctx)
+/**
+ * Get group containing all gui windows
+ */
+naRef f_getDesktop(naContext c, naRef me, int argc, naRef* args)
 {
-  osg::BoundingBox bb = el.getTransformedBounds( osg::Matrix::identity() );
-
-  std::vector<float> bb_vec(4);
-  bb_vec[0] = bb._min.x();
-  bb_vec[1] = bb._min.y();
-  bb_vec[2] = bb._max.x();
-  bb_vec[3] = bb._max.y();
-
-  return nasal::to_nasal(ctx.c, bb_vec);
+  return NasalGroup::create(c, requireGUIMgr(c).getDesktop());
 }
 
 naRef f_groupCreateChild(sc::Group& group, const nasal::CallContext& ctx)
@@ -164,68 +208,250 @@ naRef f_groupGetElementById(sc::Group& group, const nasal::CallContext& ctx)
   );
 }
 
-naRef f_textGetNearestCursor(sc::Text& text, const nasal::CallContext& ctx)
+static void propElementSetData( simgear::PropertyBasedElement& el,
+                                const std::string& name,
+                                naContext c,
+                                naRef ref )
 {
-  return nasal::to_nasal
-  (
+  if( naIsNil(ref) )
+    return el.removeDataProp(name);
+
+  std::string val = nasal::from_nasal<std::string>(c, ref);
+
+  char* end = NULL;
+
+  long val_long = strtol(val.c_str(), &end, 10);
+  if( !*end )
+    return el.setDataProp(name, val_long);
+
+  double val_double = strtod(val.c_str(), &end);
+  if( !*end )
+    return el.setDataProp(name, val_double);
+
+  el.setDataProp(name, val);
+}
+
+/**
+ * Accessor for HTML5 data properties.
+ *
+ * # set single property:
+ * el.data("myKey", 5);
+ *
+ * # set multiple properties
+ * el.data({myProp1: 12, myProp2: "test"});
+ *
+ * # get value of properties
+ * el.data("myKey");   # 5
+ * el.data("myProp2"); # "test"
+ *
+ * # remove a single property
+ * el.data("myKey", nil);
+ *
+ * # remove multiple properties
+ * el.data({myProp1: nil, myProp2: nil});
+ *
+ * # set and remove multiple properties
+ * el.data({newProp: "some text...", removeProp: nil});
+ *
+ *
+ * @see http://api.jquery.com/data/
+ */
+static naRef f_propElementData( simgear::PropertyBasedElement& el,
+                                const nasal::CallContext& ctx )
+{
+  if( ctx.isHash(0) )
+  {
+    // Add/delete properties given as hash
+    nasal::Hash obj = ctx.requireArg<nasal::Hash>(0);
+    for(nasal::Hash::iterator it = obj.begin(); it != obj.end(); ++it)
+      propElementSetData(el, it->getKey(), ctx.c, it->getValue<naRef>());
+
+    return ctx.to_nasal(&el);
+  }
+
+  std::string name = ctx.getArg<std::string>(0);
+  if( !name.empty() )
+  {
+    if( ctx.argc == 1 )
+    {
+      // name + additional argument -> add/delete property
+      SGPropertyNode* node = el.getDataProp<SGPropertyNode*>(name);
+      if( !node )
+        return naNil();
+
+      return ctx.to_nasal( node->getStringValue() );
+    }
+    else
+    {
+      // only name -> get property
+      propElementSetData(el, name, ctx.c, ctx.requireArg<naRef>(1));
+      return ctx.to_nasal(&el);
+    }
+  }
+
+  return naNil();
+}
+
+template<int Mask>
+naRef f_eventGetModifier(sc::MouseEvent& event, naContext)
+{
+  return naNum((event.getModifiers() & Mask) != 0);
+}
+
+static naRef f_createCustomEvent(const nasal::CallContext& ctx)
+{
+  std::string const& type = ctx.requireArg<std::string>(0);
+  if( type.empty() )
+    return naNil();
+
+  simgear::StringMap detail;
+  if( ctx.isHash(1) )
+  {
+    nasal::Hash const& cfg = ctx.requireArg<nasal::Hash>(1);
+    naRef na_detail = cfg.get("detail");
+    if( naIsHash(na_detail) )
+      detail = ctx.from_nasal<simgear::StringMap>(na_detail);
+  }
+
+  return NasalCustomEvent::create(
     ctx.c,
-    text.getNearestCursor( ctx.requireArg<osg::Vec2>(0) )
+    sc::CustomEventPtr(new sc::CustomEvent(type, detail))
+  );
+}
+
+struct CustomEventDetailWrapper:
+  public SGReferenced
+{
+  sc::CustomEventPtr _event;
+
+  CustomEventDetailWrapper(const sc::CustomEventPtr& event):
+    _event(event)
+  {
+
+  }
+
+  bool _get( const std::string& key,
+             std::string& value_out ) const
+  {
+    if( !_event )
+      return false;
+
+    simgear::StringMap::const_iterator it = _event->detail.find(key);
+    if( it == _event->detail.end() )
+      return false;
+
+    value_out = it->second;
+    return true;
+  }
+
+  bool _set( const std::string& key,
+             const std::string& value )
+  {
+    if( !_event )
+      return false;
+
+    _event->detail[ key ] = value;
+    return true;
+  }
+};
+
+static naRef f_customEventGetDetail( sc::CustomEvent& event,
+                                     naContext c )
+{
+  return nasal::to_nasal(
+    c,
+    CustomEventDetailPtr(new CustomEventDetailWrapper(&event))
   );
 }
 
-naRef f_eventGetTarget(naContext c, sc::Event& event)
+naRef to_nasal_helper(naContext c, const sc::ElementWeakPtr& el)
 {
-  return NasalElement::create(c, event.getTarget().lock());
+  return NasalElement::create(c, el.lock());
 }
 
-// TODO allow directly exposing functions without parameters and return type
-naRef f_eventStopPropagation(sc::Event& event, const nasal::CallContext& ctx)
+naRef to_nasal_helper(naContext c, const sc::CanvasWeakPtr& canvas)
 {
-  if( ctx.argc != 0 )
-    naRuntimeError(ctx.c, "Event::stopPropagation no argument expected");
-  event.stopPropagation();
-  return naNil();
+  return NasalCanvas::create(c, canvas.lock());
 }
 
-naRef initNasalCanvas(naRef globals, naContext c, naRef gcSave)
+naRef initNasalCanvas(naRef globals, naContext c)
 {
+  using osgGA::GUIEventAdapter;
   NasalEvent::init("canvas.Event")
     .member("type", &sc::Event::getTypeString)
-    .member("target", &f_eventGetTarget)
-    .method_func<&f_eventStopPropagation>("stopPropagation");
+    .member("target", &sc::Event::getTarget)
+    .member("currentTarget", &sc::Event::getCurrentTarget)
+    .method("stopPropagation", &sc::Event::stopPropagation);
+
+  NasalCustomEvent::init("canvas.CustomEvent")
+    .bases<NasalEvent>()
+    .member("detail", &f_customEventGetDetail, &sc::CustomEvent::setDetail);
+  NasalCustomEventDetail::init("canvas.CustomEventDetail")
+    ._get(&CustomEventDetailWrapper::_get)
+    ._set(&CustomEventDetailWrapper::_set);
+
   NasalMouseEvent::init("canvas.MouseEvent")
     .bases<NasalEvent>()
     .member("screenX", &sc::MouseEvent::getScreenX)
     .member("screenY", &sc::MouseEvent::getScreenY)
     .member("clientX", &sc::MouseEvent::getClientX)
     .member("clientY", &sc::MouseEvent::getClientY)
+    .member("localX", &sc::MouseEvent::getLocalX)
+    .member("localY", &sc::MouseEvent::getLocalY)
     .member("deltaX", &sc::MouseEvent::getDeltaX)
     .member("deltaY", &sc::MouseEvent::getDeltaY)
+    .member("button", &sc::MouseEvent::getButton)
+    .member("buttons", &sc::MouseEvent::getButtonMask)
+    .member("modifiers", &sc::MouseEvent::getModifiers)
+    .member("ctrlKey", &f_eventGetModifier<GUIEventAdapter::MODKEY_CTRL>)
+    .member("shiftKey", &f_eventGetModifier<GUIEventAdapter::MODKEY_SHIFT>)
+    .member("altKey", &f_eventGetModifier<GUIEventAdapter::MODKEY_ALT>)
+    .member("metaKey", &f_eventGetModifier<GUIEventAdapter::MODKEY_META>)
     .member("click_count", &sc::MouseEvent::getCurrentClickCount);
+
+  NasalPropertyBasedElement::init("PropertyBasedElement")
+    .method("data", &f_propElementData);
   NasalCanvas::init("Canvas")
+    .bases<NasalPropertyBasedElement>()
     .member("_node_ghost", &elementGetNode<sc::Canvas>)
     .member("size_x", &sc::Canvas::getSizeX)
     .member("size_y", &sc::Canvas::getSizeY)
-    .method_func<&f_canvasCreateGroup>("_createGroup")
-    .method<&sc::Canvas::addEventListener>("addEventListener");
+    .method("_createGroup", &f_canvasCreateGroup)
+    .method("_getGroup", &sc::Canvas::getGroup)
+    .method("addEventListener", &sc::Canvas::addEventListener)
+    .method("dispatchEvent", &sc::Canvas::dispatchEvent);
   NasalElement::init("canvas.Element")
+    .bases<NasalPropertyBasedElement>()
     .member("_node_ghost", &elementGetNode<sc::Element>)
-    .method<&sc::Element::addEventListener>("addEventListener")
-    .method_func<&f_elementGetTransformedBounds>("getTransformedBounds");
+    .method("_getParent", &sc::Element::getParent)
+    .method("_getCanvas", &sc::Element::getCanvas)
+    .method("addEventListener", &sc::Element::addEventListener)
+    .method("dispatchEvent", &sc::Element::dispatchEvent)
+    .method("getBoundingBox", &sc::Element::getBoundingBox)
+    .method("getTightBoundingBox", &sc::Element::getTightBoundingBox);
   NasalGroup::init("canvas.Group")
     .bases<NasalElement>()
-    .method_func<&f_groupCreateChild>("_createChild")
-    .method_func<&f_groupGetChild>("_getChild")
-    .method_func<&f_groupGetElementById>("_getElementById");
+    .method("_createChild", &f_groupCreateChild)
+    .method("_getChild", &f_groupGetChild)
+    .method("_getElementById", &f_groupGetElementById);
   NasalText::init("canvas.Text")
     .bases<NasalElement>()
-    .method_func<&f_textGetNearestCursor>("getNearestCursor");
+    .method("getNearestCursor", &sc::Text::getNearestCursor);
 
+  NasalWindow::init("canvas.Window")
+    .bases<NasalElement>()
+    .member("_node_ghost", &elementGetNode<sc::Window>)
+    .method("_getCanvasDecoration", &sc::Window::getCanvasDecoration);
+    
   nasal::Hash globals_module(globals, c),
               canvas_module = globals_module.createHash("canvas");
 
   canvas_module.set("_newCanvasGhost", f_createCanvas);
+  canvas_module.set("_newWindowGhost", f_createWindow);
   canvas_module.set("_getCanvasGhost", f_getCanvas);
+  canvas_module.set("_getDesktopGhost", f_getDesktop);
 
+  canvas_module.createHash("CustomEvent")
+               .set("new", &f_createCustomEvent);
   return naNil();
 }