simgear/nasal/cppbind/from_nasal.hxx

   1 ///@file Conversion functions to convert Nasal types to C++ types
   2 //
   3 // Copyright (C) 2012  Thomas Geymayer <tomgey@gmail.com>
   4 //
   5 // This library is free software; you can redistribute it and/or
   6 // modify it under the terms of the GNU Library General Public
   7 // License as published by the Free Software Foundation; either
   8 // version 2 of the License, or (at your option) any later version.
   9 //
  10 // This library 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 GNU
  13 // Library General Public License for more details.
  14 //
  15 // You should have received a copy of the GNU Library General Public
  16 // License along with this library; if not, write to the Free Software
  17 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301, USA
  18
  19 #ifndef SG_FROM_NASAL_HXX_
  20 #define SG_FROM_NASAL_HXX_
  21
  22 #include "from_nasal_detail.hxx"
  23
  24 namespace nasal
  25 {
  26
  27   /**
  28    * Convert a Nasal type to any supported C++ type.
  29    *
  30    * @note  Every type which should be supported needs a function with the
  31    *        following signature declared:
  32    *
  33    *        Type from_nasal(naContext, naRef, Type*)
  34    */
  35   template<class T>
  36   T from_nasal(naContext c, naRef ref)
  37   {
  38     return from_nasal(c, ref, static_cast<T*>(0));
  39   }
  40
  41 } // namespace nasal
  42
  43 #endif /* SG_FROM_NASAL_HXX_ */