simgear/nasal/cppbind/cppbind_test.cxx

   1 #include <simgear/math/SGMath.hxx>
   2
   3 #include "Ghost.hxx"
   4 #include "NasalHash.hxx"
   5 #include "NasalString.hxx"
   6 #include <simgear/structure/map.hxx>
   7
   8 #include <boost/shared_ptr.hpp>
   9 #include <boost/weak_ptr.hpp>
  10
  11 #include <cstring>
  12 #include <iostream>
  13
  14 #define VERIFY(a) \
  15   if( !(a) ) \
  16   { \
  17     std::cerr << "failed: line " << __LINE__ << ": " << #a << std::endl; \
  18     return 1; \
  19   }
  20
  21 enum MyEnum
  22 {
  23   ENUM_FIRST,
  24   ENUM_ANOTHER,
  25   ENUM_LAST
  26 };
  27 struct Base
  28 {
  29   naRef member(const nasal::CallContext&) { return naNil(); }
  30   virtual ~Base(){};
  31
  32   std::string getString() const { return ""; }
  33   void setString(const std::string&) {}
  34   void constVoidFunc() const {}
  35   size_t test1Arg(const std::string& str) const { return str.length(); }
  36   bool test2Args(const std::string& s, bool c) { return c && s.empty(); }
  37
  38   std::string var;
  39   const std::string& getVar() const { return var; }
  40   void setVar(const std::string v) { var = v; }
  41
  42   unsigned long getThis() const { return (unsigned long)this; }
  43   bool genericSet(const std::string& key, const std::string& val)
  44   {
  45     return key == "test";
  46   }
  47 };
  48
  49 void baseVoidFunc(Base& b) {}
  50 void baseConstVoidFunc(const Base& b) {}
  51 size_t baseFunc2Args(Base& b, int x, const std::string& s) { return x + s.size(); }
  52 std::string testPtr(Base& b) { return b.getString(); }
  53 void baseFuncCallContext(const Base&, const nasal::CallContext&) {}
  54
  55 struct Derived:
  56   public Base
  57 {
  58   int _x;
  59   int getX() const { return _x; }
  60   void setX(int x) { _x = x; }
  61 };
  62 struct DoubleDerived:
  63   public Derived
  64 {
  65
  66 };
  67
  68 typedef boost::shared_ptr<Base> BasePtr;
  69 typedef std::vector<BasePtr> BaseVec;
  70
  71 struct DoubleDerived2:
  72   public Derived
  73 {
  74   const BasePtr& getBase() const{return _base;}
  75   BasePtr _base;
  76   BaseVec doSomeBaseWork(const BaseVec& v) { return v; }
  77 };
  78
  79 class SGReferenceBasedClass:
  80   public SGReferenced
  81 {
  82
  83 };
  84
  85 typedef boost::shared_ptr<Derived> DerivedPtr;
  86 typedef boost::shared_ptr<DoubleDerived> DoubleDerivedPtr;
  87 typedef boost::shared_ptr<DoubleDerived2> DoubleDerived2Ptr;
  88 typedef SGSharedPtr<SGReferenceBasedClass> SGRefBasedPtr;
  89
  90 typedef boost::weak_ptr<Derived> DerivedWeakPtr;
  91
  92 naRef derivedFreeMember(Derived&, const nasal::CallContext&) { return naNil(); }
  93 naRef f_derivedGetX(naContext c, const Derived& d)
  94 {
  95   return nasal::to_nasal(c, d.getX());
  96 }
  97 naRef f_freeFunction(nasal::CallContext c) { return c.requireArg<naRef>(0); }
  98
  99 int main(int argc, char* argv[])
 100 {
 101   naContext c = naNewContext();
 102   naRef r;
 103
 104   using namespace nasal;
 105
 106   r = to_nasal(c, ENUM_ANOTHER);
 107   VERIFY( from_nasal<int>(c, r) == ENUM_ANOTHER );
 108
 109   r = to_nasal(c, "Test");
 110   VERIFY( strncmp("Test", naStr_data(r), naStr_len(r)) == 0 );
 111   VERIFY( from_nasal<std::string>(c, r) == "Test" );
 112
 113   r = to_nasal(c, std::string("Test"));
 114   VERIFY( strncmp("Test", naStr_data(r), naStr_len(r)) == 0 );
 115   VERIFY( from_nasal<std::string>(c, r) == "Test" );
 116
 117   r = to_nasal(c, 42);
 118   VERIFY( naNumValue(r).num == 42 );
 119   VERIFY( from_nasal<int>(c, r) == 42 );
 120
 121   r = to_nasal(c, 4.2f);
 122   VERIFY( naNumValue(r).num == 4.2f );
 123   VERIFY( from_nasal<float>(c, r) == 4.2f );
 124
 125   float test_data[3] = {0, 4, 2};
 126   r = to_nasal(c, test_data);
 127
 128   SGVec2f vec(0,2);
 129   r = to_nasal(c, vec);
 130   VERIFY( from_nasal<SGVec2f>(c, r) == vec );
 131
 132   std::vector<int> std_vec;
 133   r = to_nasal(c, std_vec);
 134
 135   r = to_nasal(c, "string");
 136   try
 137   {
 138     from_nasal<int>(c, r);
 139
 140     std::cerr << "failed: Expected bad_nasal_cast to be thrown" << std::endl;
 141     return 1;
 142   }
 143   catch(nasal::bad_nasal_cast&)
 144   {}
 145
 146   Hash hash(c);
 147   hash.set("vec", r);
 148   hash.set("vec2", vec);
 149   hash.set("name", "my-name");
 150   hash.set("string", std::string("blub"));
 151   hash.set("func", &f_freeFunction);
 152
 153   r = to_nasal(c, hash);
 154   VERIFY( naIsHash(r) );
 155
 156   VERIFY( hash.get<std::string>("name") == "my-name" );
 157   VERIFY( naIsString(hash.get("name")) );
 158
 159   Hash mod = hash.createHash("mod");
 160   mod.set("parent", hash);
 161
 162
 163   // 'func' is a C++ function registered to Nasal and now converted back to C++
 164   boost::function<int (int)> f = hash.get<int (int)>("func");
 165   VERIFY( f );
 166   VERIFY( f(3) == 3 );
 167
 168   boost::function<std::string (int)> fs = hash.get<std::string (int)>("func");
 169   VERIFY( fs );
 170   VERIFY( fs(14) == "14" );
 171
 172   typedef boost::function<void (int)> FuncVoidInt;
 173   FuncVoidInt fvi = hash.get<FuncVoidInt>("func");
 174   VERIFY( fvi );
 175   fvi(123);
 176
 177   typedef boost::function<std::string (const std::string&, int, float)> FuncMultiArg;
 178   FuncMultiArg fma = hash.get<FuncMultiArg>("func");
 179   VERIFY( fma );
 180   VERIFY( fma("test", 3, .5) == "test" );
 181
 182   typedef boost::function<naRef (naRef)> naRefMemFunc;
 183   naRefMemFunc fmem = hash.get<naRefMemFunc>("func");
 184   VERIFY( fmem );
 185   naRef ret = fmem(hash.get_naRef()),
 186         hash_ref = hash.get_naRef();
 187   VERIFY( naIsIdentical(ret, hash_ref) );
 188
 189   // Check if nasal::Me gets passed as self/me and remaining arguments are
 190   // passed on to function
 191   typedef boost::function<int (Me, int)> MeIntFunc;
 192   MeIntFunc fmeint = hash.get<MeIntFunc>("func");
 193   VERIFY( fmeint(naNil(), 5) == 5 );
 194
 195   //----------------------------------------------------------------------------
 196   // Test exposing classes to Nasal
 197   //----------------------------------------------------------------------------
 198
 199   Ghost<BasePtr>::init("BasePtr")
 200     .method("member", &Base::member)
 201     .method("strlen", &Base::test1Arg)
 202     .member("str", &Base::getString, &Base::setString)
 203     .method("str_m", &Base::getString)
 204     .method("void", &Base::constVoidFunc)
 205     .member("var_r", &Base::getVar)
 206     .member("var_w", &Base::setVar)
 207     .member("var", &Base::getVar, &Base::setVar)
 208     .method("void", &baseVoidFunc)
 209     .method("void_c", &baseConstVoidFunc)
 210     .method("int2args", &baseFunc2Args)
 211     .method("bool2args", &Base::test2Args)
 212     .method("str_ptr", &testPtr)
 213     .method("this", &Base::getThis)
 214     ._set(&Base::genericSet);
 215   Ghost<DerivedPtr>::init("DerivedPtr")
 216     .bases<BasePtr>()
 217     .member("x", &Derived::getX, &Derived::setX)
 218     .member("x_alternate", &f_derivedGetX)
 219     .method("free_fn", &derivedFreeMember)
 220     .method("free_member", &derivedFreeMember)
 221     .method("baseDoIt", &baseFuncCallContext);
 222   Ghost<DoubleDerivedPtr>::init("DoubleDerivedPtr")
 223     .bases<DerivedPtr>();
 224   Ghost<DoubleDerived2Ptr>::init("DoubleDerived2Ptr")
 225     .bases< Ghost<DerivedPtr> >()
 226     .member("base", &DoubleDerived2::getBase)
 227     .method("doIt", &DoubleDerived2::doSomeBaseWork);
 228
 229   Ghost<DerivedWeakPtr>::init("DerivedWeakPtr");
 230   Ghost<SGRefBasedPtr>::init("SGRefBasedPtr");
 231
 232   VERIFY( Ghost<BasePtr>::isInit() );
 233   nasal::to_nasal(c, DoubleDerived2Ptr());
 234
 235   BasePtr d( new Derived );
 236   naRef derived = to_nasal(c, d);
 237   VERIFY( naIsGhost(derived) );
 238   VERIFY( std::string("DerivedPtr") == naGhost_type(derived)->name );
 239
 240   // Get member function from ghost...
 241   naRef thisGetter = naNil();
 242   VERIFY( naMember_get(c, derived, to_nasal(c, "this"), &thisGetter) );
 243   VERIFY( naIsFunc(thisGetter) );
 244
 245   // ...and check if it really gets passed the correct instance
 246   typedef boost::function<unsigned long (Me)> MemFunc;
 247   MemFunc fGetThis = from_nasal<MemFunc>(c, thisGetter);
 248   VERIFY( fGetThis );
 249   VERIFY( fGetThis(derived) == (unsigned long)d.get() );
 250
 251   BasePtr d2( new DoubleDerived );
 252   derived = to_nasal(c, d2);
 253   VERIFY( naIsGhost(derived) );
 254   VERIFY( std::string("DoubleDerivedPtr") ==  naGhost_type(derived)->name );
 255
 256   BasePtr d3( new DoubleDerived2 );
 257   derived = to_nasal(c, d3);
 258   VERIFY( naIsGhost(derived) );
 259   VERIFY( std::string("DoubleDerived2Ptr") ==  naGhost_type(derived)->name );
 260
 261   SGRefBasedPtr ref_based( new SGReferenceBasedClass );
 262   naRef na_ref_based = to_nasal(c, ref_based.get());
 263   VERIFY( naIsGhost(na_ref_based) );
 264   VERIFY(    from_nasal<SGReferenceBasedClass*>(c, na_ref_based)
 265           == ref_based.get() );
 266   VERIFY( from_nasal<SGRefBasedPtr>(c, na_ref_based) == ref_based );
 267
 268   VERIFY( Ghost<BasePtr>::isBaseOf(derived) );
 269   VERIFY( Ghost<DerivedPtr>::isBaseOf(derived) );
 270   VERIFY( Ghost<DoubleDerived2Ptr>::isBaseOf(derived) );
 271
 272   VERIFY( from_nasal<BasePtr>(c, derived) == d3 );
 273   VERIFY( from_nasal<BasePtr>(c, derived) != d2 );
 274   VERIFY(    from_nasal<DerivedPtr>(c, derived)
 275           == boost::dynamic_pointer_cast<Derived>(d3) );
 276   VERIFY(    from_nasal<DoubleDerived2Ptr>(c, derived)
 277           == boost::dynamic_pointer_cast<DoubleDerived2>(d3) );
 278   VERIFY( !from_nasal<DoubleDerivedPtr>(c, derived) );
 279
 280   std::map<std::string, BasePtr> instances;
 281   VERIFY( naIsHash(to_nasal(c, instances)) );
 282
 283   std::map<std::string, DerivedPtr> instances_d;
 284   VERIFY( naIsHash(to_nasal(c, instances_d)) );
 285
 286   std::map<std::string, int> int_map;
 287   VERIFY( naIsHash(to_nasal(c, int_map)) );
 288
 289   std::map<std::string, std::vector<int> > int_vector_map;
 290   VERIFY( naIsHash(to_nasal(c, int_vector_map)) );
 291
 292   simgear::StringMap dict =
 293     simgear::StringMap("hello", "value")
 294                       ("key2", "value2");
 295   naRef na_dict = to_nasal(c, dict);
 296   VERIFY( naIsHash(na_dict) );
 297   VERIFY( Hash(na_dict, c).get<std::string>("key2") == "value2" );
 298
 299   // Check converting to Ghost if using Nasal hashes with actual ghost inside
 300   // the hashes parents vector
 301   std::vector<naRef> parents;
 302   parents.push_back(hash.get_naRef());
 303   parents.push_back(derived);
 304
 305   Hash obj(c);
 306   obj.set("parents", parents);
 307   VERIFY( from_nasal<BasePtr>(c, obj.get_naRef()) == d3 );
 308
 309   // Check recursive parents (aka parent-of-parent)
 310   std::vector<naRef> parents2;
 311   parents2.push_back(obj.get_naRef());
 312   Hash derived_obj(c);
 313   derived_obj.set("parents", parents2);
 314   VERIFY( from_nasal<BasePtr>(c, derived_obj.get_naRef()) == d3 );
 315
 316   std::vector<naRef> nasal_objects;
 317   nasal_objects.push_back( Ghost<BasePtr>::create(c, d) );
 318   nasal_objects.push_back( Ghost<BasePtr>::create(c, d2) );
 319   nasal_objects.push_back( Ghost<BasePtr>::create(c, d3) );
 320   naRef obj_vec = to_nasal(c, nasal_objects);
 321
 322   std::vector<BasePtr> objects = from_nasal<std::vector<BasePtr> >(c, obj_vec);
 323   VERIFY( objects[0] == d );
 324   VERIFY( objects[1] == d2 );
 325   VERIFY( objects[2] == d3 );
 326
 327   // Calling fallback setter for unset values
 328   const char* src_code = "me.test = 3;";
 329   int errLine = -1;
 330   naRef code = naParseCode( c, to_nasal(c, "source.nas"), 0,
 331                             (char*)src_code, strlen(src_code),
 332                             &errLine );
 333   ret = naCallMethod(code, derived, 0, 0, naNil());
 334
 335   VERIFY( !naGetError(c) ) // TODO real error check (this seems to always
 336                            //      return 0...
 337   VERIFY( from_nasal<int>(c, ret) == 3 )
 338
 339   //----------------------------------------------------------------------------
 340   // Test nasal::CallContext
 341   //----------------------------------------------------------------------------
 342
 343
 344   int int_vec[] = {1,2,3};
 345   std::map<std::string, std::string> map;
 346   naRef args[] = {
 347     to_nasal(c, std::string("test-arg")),
 348     to_nasal(c, 4),
 349     to_nasal(c, int_vec),
 350     to_nasal(c, map)
 351   };
 352   CallContext cc(c, sizeof(args)/sizeof(args[0]), args);
 353   VERIFY( cc.requireArg<std::string>(0) == "test-arg" );
 354   VERIFY( cc.getArg<std::string>(0) == "test-arg" );
 355   VERIFY( cc.getArg<std::string>(10) == "" );
 356   VERIFY( cc.isString(0) );
 357   VERIFY( !cc.isNumeric(0) );
 358   VERIFY( !cc.isVector(0) );
 359   VERIFY( !cc.isHash(0) );
 360   VERIFY( !cc.isGhost(0) );
 361   VERIFY( cc.isNumeric(1) );
 362   VERIFY( cc.isVector(2) );
 363   VERIFY( cc.isHash(3) );
 364
 365   naRef args_vec = nasal::to_nasal(c, args);
 366   VERIFY( naIsVector(args_vec) );
 367
 368   //----------------------------------------------------------------------------
 369   // Test nasal::String
 370   //----------------------------------------------------------------------------
 371
 372   String string( to_nasal(c, "Test") );
 373   VERIFY( from_nasal<std::string>(c, string.get_naRef()) == "Test" );
 374   VERIFY( string.c_str() == std::string("Test") );
 375   VERIFY( string.starts_with(string) );
 376   VERIFY( string.starts_with(String(c, "T")) );
 377   VERIFY( string.starts_with(String(c, "Te")) );
 378   VERIFY( string.starts_with(String(c, "Tes")) );
 379   VERIFY( string.starts_with(String(c, "Test")) );
 380   VERIFY( !string.starts_with(String(c, "Test1")) );
 381   VERIFY( !string.starts_with(String(c, "bb")) );
 382   VERIFY( !string.starts_with(String(c, "bbasdasdafasd")) );
 383   VERIFY( string.ends_with(String(c, "t")) );
 384   VERIFY( string.ends_with(String(c, "st")) );
 385   VERIFY( string.ends_with(String(c, "est")) );
 386   VERIFY( string.ends_with(String(c, "Test")) );
 387   VERIFY( !string.ends_with(String(c, "1Test")) );
 388   VERIFY( !string.ends_with(String(c, "abc")) );
 389   VERIFY( !string.ends_with(String(c, "estasdasd")) );
 390   VERIFY( string.find('e') == 1 );
 391   VERIFY( string.find('9') == String::npos );
 392   VERIFY( string.find_first_of(String(c, "st")) == 2 );
 393   VERIFY( string.find_first_of(String(c, "st"), 3) == 3 );
 394   VERIFY( string.find_first_of(String(c, "xyz")) == String::npos );
 395   VERIFY( string.find_first_not_of(String(c, "Tst")) == 1 );
 396   VERIFY( string.find_first_not_of(String(c, "Tse"), 2) == 3 );
 397   VERIFY( string.find_first_not_of(String(c, "abc")) == 0 );
 398   VERIFY( string.find_first_not_of(String(c, "abc"), 20) == String::npos );
 399
 400   naFreeContext(c);
 401
 402   return 0;
 403 }