// NasalCanvas.cxx -- expose Canvas classes to Nasal // // Written by James Turner, started 2012. // // Copyright (C) 2012 James Turner // // This program is free software; you can redistribute it and/or // modify it under the terms of the GNU General Public License as // published by the Free Software Foundation; either version 2 of the // License, or (at your option) any later version. // // This program is distributed in the hope that it will be useful, but // WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU // General Public License for more details. // // You should have received a copy of the GNU General Public License // along with this program; if not, write to the Free Software // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. #ifdef HAVE_CONFIG_H # include "config.h" #endif #include "NasalCanvas.hxx" #include <Canvas/canvas_mgr.hxx> #include <Canvas/gui_mgr.hxx> #include <Main/globals.hxx> #include <Scripting/NasalSys.hxx> #include <osgGA/GUIEventAdapter> #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/layout/BoxLayout.hxx> #include <simgear/canvas/layout/NasalWidget.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> #include <simgear/nasal/cppbind/NasalHash.hxx> #include <simgear/nasal/cppbind/Ghost.hxx> extern naRef propNodeGhostCreate(naContext c, SGPropertyNode* n); namespace sc = simgear::canvas; template<class 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::LayoutItemRef> NasalLayoutItem; typedef nasal::Ghost<sc::LayoutRef> NasalLayout; 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**) { SGPropertyNode* props = ghostToPropNode(ref); if( !props ) naRuntimeError(c, "Not a SGPropertyNode ghost."); 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 = static_cast<CanvasMgr*>(globals->get_subsystem("Canvas")); if( !canvas_mgr ) naRuntimeError(c, "Failed to get Canvas subsystem"); 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(const nasal::CallContext& ctx) { 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) ) ); } /** * Get ghost for existing Canvas. */ static naRef f_getCanvas(naContext c, naRef me, int argc, naRef* args) { nasal::CallContext ctx(c, argc, args); SGPropertyNode& props = *ctx.requireArg<SGPropertyNode*>(0); CanvasMgr& canvas_mgr = requireCanvasMgr(c); sc::CanvasPtr canvas; if( canvas_mgr.getPropertyRoot() == props.getParent() ) { // get a canvas specified by its root node canvas = canvas_mgr.getCanvas( props.getIndex() ); if( !canvas || canvas->getProps() != &props ) return naNil(); } else { // get a canvas by name if( props.hasValue("name") ) canvas = canvas_mgr.getCanvas( props.getStringValue("name") ); else if( props.hasValue("index") ) canvas = canvas_mgr.getCanvas( props.getIntValue("index") ); } return NasalCanvas::create(c, canvas); } naRef f_canvasCreateGroup(sc::Canvas& canvas, const nasal::CallContext& ctx) { return NasalGroup::create ( ctx.c, canvas.createGroup( ctx.getArg<std::string>(0) ) ); } /** * Get group containing all gui windows */ naRef f_getDesktop(naContext c, naRef me, int argc, naRef* args) { return NasalGroup::create(c, requireGUIMgr(c).getDesktop()); } naRef f_groupCreateChild(sc::Group& group, const nasal::CallContext& ctx) { return NasalElement::create ( ctx.c, group.createChild( ctx.requireArg<std::string>(0), ctx.getArg<std::string>(1) ) ); } naRef f_groupGetChild(sc::Group& group, const nasal::CallContext& ctx) { return NasalElement::create ( ctx.c, group.getChild( ctx.requireArg<SGPropertyNode*>(0) ) ); } naRef f_groupGetElementById(sc::Group& group, const nasal::CallContext& ctx) { return NasalElement::create ( ctx.c, group.getElementById( ctx.requireArg<std::string>(0) ) ); } static void propElementSetData( simgear::PropertyBasedElement& el, const std::string& name, naContext c, naRef ref ) { 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, 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 to_nasal_helper(naContext c, const sc::ElementWeakPtr& el) { return NasalElement::create(c, el.lock()); } naRef to_nasal_helper(naContext c, const sc::CanvasWeakPtr& canvas) { return NasalCanvas::create(c, canvas.lock()); } template<class Type, class Base> static naRef f_newAsBase(const nasal::CallContext& ctx) { return ctx.to_nasal<Base*>(new Type()); } naRef initNasalCanvas(naRef globals, naContext c) { nasal::Hash globals_module(globals, c), canvas_module = globals_module.createHash("canvas"); //---------------------------------------------------------------------------- // Events using osgGA::GUIEventAdapter; NasalEvent::init("canvas.Event") .member("type", &sc::Event::getTypeString) .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); canvas_module.createHash("CustomEvent") .set("new", &f_createCustomEvent); 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); //---------------------------------------------------------------------------- // Canvas & elements 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("_createGroup", &f_canvasCreateGroup) .method("_getGroup", &sc::Canvas::getGroup) .method("addEventListener", &sc::Canvas::addEventListener) .method("dispatchEvent", &sc::Canvas::dispatchEvent); canvas_module.set("_newCanvasGhost", f_createCanvas); canvas_module.set("_getCanvasGhost", f_getCanvas); NasalElement::init("canvas.Element") .bases<NasalPropertyBasedElement>() .member("_node_ghost", &elementGetNode<sc::Element>) .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("_createChild", &f_groupCreateChild) .method("_getChild", &f_groupGetChild) .method("_getElementById", &f_groupGetElementById); NasalText::init("canvas.Text") .bases<NasalElement>() .method("getNearestCursor", &sc::Text::getNearestCursor); //---------------------------------------------------------------------------- // Layouting NasalLayoutItem::init("canvas.LayoutItem") .method("setCanvas", &sc::LayoutItem::setCanvas); sc::NasalWidget::setupGhost(canvas_module); NasalLayout::init("canvas.Layout") .bases<NasalLayoutItem>() .method("addItem", &sc::Layout::addItem); canvas_module.createHash("HBoxLayout") .set("new", &f_newAsBase<sc::HBoxLayout, sc::Layout>); //---------------------------------------------------------------------------- // Window NasalWindow::init("canvas.Window") .bases<NasalElement>() .member("_node_ghost", &elementGetNode<sc::Window>) .method("_getCanvasDecoration", &sc::Window::getCanvasDecoration) .method("setLayout", &sc::Window::setLayout); canvas_module.set("_newWindowGhost", f_createWindow); canvas_module.set("_getDesktopGhost", f_getDesktop); return naNil(); }