aboutsummaryrefslogtreecommitdiff
path: root/src/vrepFfi.h
blob: 0dbab1e2c4846b9230e2f0d3d9ff3788c7077cf9 (plain)
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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
/* vrepFfi.h -- exposing functions to V-REP
 * Copyright (C) 2013  Galois, Inc.
 *
 * This library is free software: you can redistribute it and/or modify it under
 * the terms of the GNU General Public License as published by the Free Software
 * Foundation, either version 3 of the License, or (at your option) any later
 * version.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License along with
 * this library.  If not, see <http://www.gnu.org/licenses/>.
 *
 * To contact Galois, complete the Web form at <http://corp.galois.com/contact/>
 * or write to Galois, Inc., 421 Southwest 6th Avenue, Suite 300, Portland,
 * Oregon, 97204-1622. */

#ifndef PPAML_VREP_AUTOMOBILE_PLUGIN_VREPFFI_H_
#define PPAML_VREP_AUTOMOBILE_PLUGIN_VREPFFI_H_

#ifdef HAVE_CONFIG_H
#   include <config.h>
#endif

#include <cstddef>
#include <cstring>

#include <forward_list>
#include <string>
#include <vector>

#include <v_repLib.h>

#include "vrep.h"

namespace vrep {

    namespace {

        // C-Lua type equivalences //

        template<typename T, int idVal>
        struct LuaTypeWrapper {
            static const int id = idVal;
            static inline T isNextArg(const SLuaCallBack *);
        };

        template<typename T>
        struct LuaType;

        template<>
        struct LuaType<std::nullptr_t>
            : public LuaTypeWrapper<std::nullptr_t, sim_lua_arg_nil> {
        };

        template<>
        struct LuaType<bool> : public LuaTypeWrapper<bool, sim_lua_arg_bool> {
            typedef simBool LuaT;
        };

        template<>
        struct LuaType<int> : public LuaTypeWrapper<int, sim_lua_arg_int> {
            typedef simInt LuaT;
        };

        template<>
        struct LuaType<float>
            : public LuaTypeWrapper<float, sim_lua_arg_float> {
            typedef simFloat LuaT;
        };

        template<>
        struct LuaType<std::string>
            : public LuaTypeWrapper<std::string, sim_lua_arg_string> {
            typedef simChar LuaT;
       };

        template<typename U>
        struct LuaType<std::vector<U>>
            : public LuaTypeWrapper<std::vector<U>,
                                    sim_lua_arg_table | LuaType<U>::id> {
            typedef typename LuaType<U>::LuaT LuaT;
        };


        // Converting a variadic template type to a Lua type list //

        std::forward_list<int> toLuaTypes();

        template<typename Car>
        std::forward_list<int> toLuaTypes();

        template<typename Car, typename Cadr, typename ...Cddr>
        std::forward_list<int> toLuaTypes();
    }


    // Exposing C++ functions to Lua //

    template<typename ...Args>
    void exposeFunction(const std::string name, const std::string callTips,
                        simVoid (*const f)(SLuaCallBack *));


    // Extracting Lua arguments from the callback structure //

    /* A class layered on 'SLuaCallBack' for handling calls from Lua into C++.
     * Watch out--interacting with this class at all outside of a C++ function
     * exposed to Lua will almost certainly cause undefined behavior! */
    class LuaCall {
    public:
        LuaCall(SLuaCallBack *);

        template<typename T>
        T expectAtom();

        template<typename T>
        std::vector<T> expectTable();

    private:
        void ensureNextArgType(const int expected);

        template<typename T>
        T unsafeGetAtom();

        template<typename T>
        std::vector<T> unsafeGetTable();

        SLuaCallBack *const simCall;
        size_t argIdx;
        simBool *cursorBool;
        simInt *cursorInt;
        simFloat *cursorFloat;
        simChar *cursorChar;
    };
    template<> inline bool LuaCall::unsafeGetAtom();
    template<> inline int LuaCall::unsafeGetAtom();
    template<> inline float LuaCall::unsafeGetAtom();
    template<> std::string LuaCall::unsafeGetAtom();


    // Error handling //

    // An error signaling a failed marshal from Lua to C++.
    class MarshalingError : public Error {
    public:
        explicit inline MarshalingError(const std::string &whatArg);
        explicit inline MarshalingError(const char *whatArg);
    };

}

#include "vrepFfi-inl.h"

#endif