1 /******************************************************************************\
2 * Types.hpp                                                                    *
3 * The place for assorted types.                                                *
4 *                                                                              *
5 *                                                                              *
6 * Copyright (C) 2005-2013 by Leandro Motta Barros.                             *
7 *                                                                              *
8 * Permission is hereby granted, free of charge, to any person obtaining a copy *
9 * of this software and associated documentation files (the "Software"), to     *
10 * deal in the Software without restriction, including without limitation the   *
11 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or  *
12 * sell copies of the Software, and to permit persons to whom the Software is   *
13 * furnished to do so, subject to the following conditions:                     *
14 *                                                                              *
15 * The above copyright notice and this permission notice shall be included in   *
16 * all copies or substantial portions of the Software.                          *
17 *                                                                              *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR   *
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,     *
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE *
21 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER       *
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING      *
23 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS *
24 * IN THE SOFTWARE.                                                             *
25 \******************************************************************************/
26 
27 #ifndef _DILUCULUM_TYPES_HPP_
28 #define _DILUCULUM_TYPES_HPP_
29 
30 #include <map>
31 #include <vector>
32 
33 
34 namespace Diluculum
35 {
36    class LuaValue;
37 
38    /** A list of <tt>LuaValue</tt>s. Used, for example, to represent the return
39     *  value of a Lua function call. In this case, the first return value is
40     *  stored at the 0th \c vector position, the second return value at the 1st
41     *  \c vector position and so on.
42     */
43    typedef std::vector<LuaValue> LuaValueList;
44 
45    /** Type mapping from <tt>LuaValue</tt>s to <tt>LuaValue</tt>s. Think of it
46     *  as a C++ approximation of a Lua table.
47     */
48    typedef std::map<LuaValue, LuaValue> LuaValueMap;
49 
50 } // namespace Diluculum
51 
52 #endif // _DILUCULUM_TYPES_HPP_
53