Lua api(九) lua_toboolean/lua_to*

前言#

通过上一章所说的lua_is*系列，我们已经可以判定数值的类型，但是这不是我们的最终目的，我们的最终目的是使用这些值，检测类型只是来判断的，而这些存在栈中的值究竟要怎样用，就要涉及到今天我所列举的这些api，也就是使用频率相当高的lua_to*系列。

内容#

---

lua_toboolean##

• 原型：int lua_toboolean (lua_State *L, int index)
• 解释：把指定的索引处的的 Lua 值转换为一个 C 中的 boolean 值（ 0 或是 1 ）。 和 Lua 中做的所有测试一样， lua_toboolean 会把任何 不同于 false 和 nil 的值当作 1 返回； 否则就返回 0 。 如果用一个无效索引去调用也会返回 0 。

---

lua_tocfunction##

• 原型：lua_CFunction lua_tocfunction (lua_State *L, int index);
• 解释：把给定索引处的 Lua 值转换为一个 C 函数。 这个值必须是一个 C 函数；如果不是就返回 NULL 。

---

lua_tointeger##

• 原型：lua_Integer lua_tointeger (lua_State *L, int idx);
• 解释： 把给定索引处的 Lua 值转换为 lua_Integer 这样一个有符号整数类型。 这个 Lua 值必须是一个数字或是一个可以转换为数字的字符串， 否则 lua_tointeger 返回 0 。

---

lua_tolstring##

• 原型：const char *lua_tolstring (lua_State *L, int index, size_t *len);
• 解释：把给定索引处的 Lua 值转换为一个 C 字符串。 如果 len 不为 NULL ， 它还把字符串长度设到 *len 中。 这个 Lua 值必须是一个字符串或是一个数字； 否则返回返回 NULL 。 如果值是一个数字，lua_tolstring 还会把堆栈中的那个值的实际类型转换为一个字符串。

---

lua_tonumber##

• 原型：lua_Number lua_tonumber (lua_State *L, int index);
• 解释：把给定索引处的 Lua 值转换为 lua_Number 这样一个 C 类型。 这个 Lua 值必须是一个数字或是一个可转换为数字的字符串， 否则，lua_tonumber 返回 0 。

---

lua_topointer##

• 原型：const void *lua_topointer (lua_State *L, int index);
• 解释： 把给定索引处的值转换为一般的 C 指针 (void*) 。 这个值可以是一个 userdata ，table ，thread 或是一个 function ； 否则，lua_topointer 返回 NULL 。 不同的对象有不同的指针。 不存在把指针再转回原有类型的方法。

---

lua_tostring##

• 原型：const char *lua_tostring (lua_State *L, int index);
• 解释：等价于 lua_tolstring ，而参数 len 设为 NULL 。

---

lua_tothread##

• 原型：lua_State *lua_tothread (lua_State *L, int index);
• 解释：把给定索引处的值转换为一个 Lua 线程（由 lua_State* 代表）。 这个值必须是一个线程；否则函数返回 NULL 。

---

lua_touserdata##

• 原型：void *lua_touserdata (lua_State *L, int index);
• 解释：如果给定索引处的值是一个完整的 userdata ，函数返回内存块的地址。 如果值是一个 light userdata ，那么就返回它表示的指针。 否则返回 NULL 。

---

Usage##

• 首先我们来新建一个文件命名为totransformtest.lua，然后在文件中编写如下代码：

-- 定义一个table
information = 
{
    name = "AlbertS",
    age = 20,
    sex = "man",
    married = false,
}

function func_testtype()
    print("lua -- > this is a lua function");
end

• 然后我们来编写c++的调用函数，代码如下：

    lua_State *L = lua_open();
    luaL_openlibs(L);

    luaL_dofile(L,"totransformtest.lua"); // 加载执行lua文件
    lua_getglobal(L, "func_testtype");      // 函数入栈
    if(lua_isfunction(L, -1))               // -->lua_isfunction用法
    {
        lua_pcall(L, 0, 0, 0);
    }

    lua_getglobal(L,"information");         // 将全局表压入栈

    lua_pushstring(L, "name");              // 将要取的变量名压入栈
    lua_rawget(L, -2);                      // 取information.name的值
    if(lua_isstring(L, -1))
    {
        size_t nNameLen;
        printf("c++ --> information.name = %s\n",
            lua_tolstring(L, -1, &nNameLen));// -->lua_tolstring用法
        printf("c++ --> information.name len = %d\n", nNameLen);
    }
    lua_pop(L, 1);

    lua_pushstring(L, "age");               // 将要取的变量名压入栈
    lua_rawget(L, -2);                      // 取information.age的值
    if(lua_isnumber(L, -1))
    {
        printf("c++ --> information.age = %d\n",
            lua_tointeger(L, -1));          // -->lua_tointeger用法
    }
    lua_pop(L, 1);

    lua_pushstring(L, "sex");               // 将要取的变量名压入栈
    lua_rawget(L, -2);                      // 取information.sex的值
    if(lua_isstring(L, -1))
    {
        printf("c++ --> information.sex = %s\n",
            lua_tostring(L, -1));           // -->lua_tostring用法
    }
    lua_pop(L, 1);

    lua_pushstring(L, "married");           // 将要取的变量名压入栈
    lua_rawget(L, -2);                      // 取information.married的值
    if(lua_isboolean(L, -1))
    {
        printf("c++ --> information.married = %s\n",
            lua_toboolean(L, -1) ? "true" : "false");// -->lua_toboolean
    }
    lua_pop(L, 1);

    lua_close(L);                       //关闭lua环境  

• 结果

总结#

• 由于lua_toboolean会把任何不同于 false 和 nil 的值当作 1 返回，所以你如果想只接收真正的 boolean 值，就需要使用lua_isboolean来测试值的类型。
• lua_tolstring 返回 Lua 状态机中字符串的以对齐指针。这个字符串总能保证最后一个字符为零 ('\0') ，而且它允许在字符串内包含多个这样的零。因为 Lua 中可能发生垃圾收集，所以不保证 lua_tolstring 返回的指针，在对应的值从堆栈中移除后依然有效。
• lua_tostring是利用lua_tolstring的一个宏而已。
• 可能你会疑惑为什么有lua_isfunction和lua_iscfunction函数，但却只有lua_tocfunction而没有lua_tofunction函数，其实仔细想想就知道只有转化成c function才有意义，假设是一个lua function在c代码里是没有用处的。