File: raw.rst

package info (click to toggle)
luabind 0.9.1%2Bdfsg-5
  • links: PTS
  • area: main
  • in suites: wheezy
  • size: 1,460 kB
  • sloc: cpp: 13,761; makefile: 120; sh: 24; ansic: 11
file content (59 lines) | stat: -rwxr-xr-x 1,113 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
raw
---

.. note::

    ``raw()`` has been deprecated. ``lua_State*`` parameters are
    automatically handled by luabind.

Motivation
~~~~~~~~~~

This converter policy will pass through the ``lua_State*`` unmodified.
This can be useful for example when binding functions that need to 
return a ``luabind::object``. The parameter will be removed from the
function signature, decreasing the function arity by one.

Defined in
~~~~~~~~~~

.. parsed-literal::

    #include <luabind/raw_policy.hpp>

Synopsis
~~~~~~~~

.. parsed-literal::

    raw(index)

Parameters
~~~~~~~~~~

============= ===============================================================
Parameter     Purpose
============= ===============================================================
``index``     The index of the lua_State* parameter.
============= ===============================================================

Example
~~~~~~~

.. parsed-literal::

    void greet(lua_State* L)
    {
        lua_pushstring(L, "hello");
    }

    ...

    module(L)
    [
        def("greet", &greet, **raw(_1)**)
    ];

    > print(greet())
    hello