src/script/common/helper.h

   1 /*
   2 Minetest
   3 Copyright (C) 2018 nerzhul, Loic Blot <loic.blot@unix-experience.fr>
   4
   5 This program is free software; you can redistribute it and/or modify
   6 it under the terms of the GNU Lesser General Public License as published by
   7 the Free Software Foundation; either version 2.1 of the License, or
   8 (at your option) any later version.
   9
  10 This program 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
  13 GNU Lesser General Public License for more details.
  14
  15 You should have received a copy of the GNU Lesser General Public License along
  16 with this program; if not, write to the Free Software Foundation, Inc.,
  17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 */
  19
  20 #pragma once
  21
  22 extern "C" {
  23 #include <lua.h>
  24 #include <lauxlib.h>
  25 }
  26
  27 class LuaHelper
  28 {
  29 protected:
  30         static bool isNaN(lua_State *L, int idx);
  31
  32         /**
  33          * Read a value using a template type T from Lua State L and index
  34          *
  35          *
  36          * @tparam T type to read from Lua
  37          * @param L Lua state
  38          * @param index Lua Index to read
  39          * @return read value from Lua
  40          */
  41         template <typename T> static T readParam(lua_State *L, int index);
  42
  43         /**
  44          * Read a value using a template type T from Lua State L and index
  45          *
  46          * @tparam T type to read from Lua
  47          * @param L Lua state
  48          * @param index Lua Index to read
  49          * @param default_value default value to apply if nil
  50          * @return read value from Lua or default value if nil
  51          */
  52         template <typename T>
  53         static inline T readParam(lua_State *L, int index, const T &default_value)
  54         {
  55                 return lua_isnoneornil(L, index) ? default_value : readParam<T>(L, index);
  56         }
  57 };