annotate C++/LuaeVariant.h @ 231:2f1d820e6e33

Merge with OptionParser
author David Demelier <markand@malikania.fr>
date Sun, 22 Jun 2014 16:19:31 +0200
parents e01ee0c72c43
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
225
e01ee0c72c43 Luae: begin refactoring of Luae
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 /*
e01ee0c72c43 Luae: begin refactoring of Luae
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 * LuaeVariant.h -- Lua variant helper
e01ee0c72c43 Luae: begin refactoring of Luae
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 *
e01ee0c72c43 Luae: begin refactoring of Luae
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 * Copyright (c) 2013, 2014 David Demelier <markand@malikania.fr>
e01ee0c72c43 Luae: begin refactoring of Luae
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 *
e01ee0c72c43 Luae: begin refactoring of Luae
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 * Permission to use, copy, modify, and/or distribute this software for any
e01ee0c72c43 Luae: begin refactoring of Luae
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 * purpose with or without fee is hereby granted, provided that the above
e01ee0c72c43 Luae: begin refactoring of Luae
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 * copyright notice and this permission notice appear in all copies.
e01ee0c72c43 Luae: begin refactoring of Luae
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 *
e01ee0c72c43 Luae: begin refactoring of Luae
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
e01ee0c72c43 Luae: begin refactoring of Luae
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
e01ee0c72c43 Luae: begin refactoring of Luae
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
e01ee0c72c43 Luae: begin refactoring of Luae
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
e01ee0c72c43 Luae: begin refactoring of Luae
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
e01ee0c72c43 Luae: begin refactoring of Luae
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
e01ee0c72c43 Luae: begin refactoring of Luae
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
e01ee0c72c43 Luae: begin refactoring of Luae
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 */
e01ee0c72c43 Luae: begin refactoring of Luae
David Demelier <markand@malikania.fr>
parents:
diff changeset
18
e01ee0c72c43 Luae: begin refactoring of Luae
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 #ifndef _LUAE_VARIANT_H_
e01ee0c72c43 Luae: begin refactoring of Luae
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 #define _LUAE_VARIANT_H_
e01ee0c72c43 Luae: begin refactoring of Luae
David Demelier <markand@malikania.fr>
parents:
diff changeset
21
e01ee0c72c43 Luae: begin refactoring of Luae
David Demelier <markand@malikania.fr>
parents:
diff changeset
22 #include <lua.hpp>
e01ee0c72c43 Luae: begin refactoring of Luae
David Demelier <markand@malikania.fr>
parents:
diff changeset
23
e01ee0c72c43 Luae: begin refactoring of Luae
David Demelier <markand@malikania.fr>
parents:
diff changeset
24 /**
e01ee0c72c43 Luae: begin refactoring of Luae
David Demelier <markand@malikania.fr>
parents:
diff changeset
25 * @class LuaeVariant
e01ee0c72c43 Luae: begin refactoring of Luae
David Demelier <markand@malikania.fr>
parents:
diff changeset
26 * @brief A fake variant for Lua values
e01ee0c72c43 Luae: begin refactoring of Luae
David Demelier <markand@malikania.fr>
parents:
diff changeset
27 *
e01ee0c72c43 Luae: begin refactoring of Luae
David Demelier <markand@malikania.fr>
parents:
diff changeset
28 * This class is primarly used for copying Lua values without checking
e01ee0c72c43 Luae: begin refactoring of Luae
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 * the types, useful to pass data.
e01ee0c72c43 Luae: begin refactoring of Luae
David Demelier <markand@malikania.fr>
parents:
diff changeset
30 */
e01ee0c72c43 Luae: begin refactoring of Luae
David Demelier <markand@malikania.fr>
parents:
diff changeset
31 class LuaeVariant {
e01ee0c72c43 Luae: begin refactoring of Luae
David Demelier <markand@malikania.fr>
parents:
diff changeset
32 private:
e01ee0c72c43 Luae: begin refactoring of Luae
David Demelier <markand@malikania.fr>
parents:
diff changeset
33 union {
e01ee0c72c43 Luae: begin refactoring of Luae
David Demelier <markand@malikania.fr>
parents:
diff changeset
34 lua_Number number;
e01ee0c72c43 Luae: begin refactoring of Luae
David Demelier <markand@malikania.fr>
parents:
diff changeset
35 bool boolean;
e01ee0c72c43 Luae: begin refactoring of Luae
David Demelier <markand@malikania.fr>
parents:
diff changeset
36 };
e01ee0c72c43 Luae: begin refactoring of Luae
David Demelier <markand@malikania.fr>
parents:
diff changeset
37
e01ee0c72c43 Luae: begin refactoring of Luae
David Demelier <markand@malikania.fr>
parents:
diff changeset
38 int type;
e01ee0c72c43 Luae: begin refactoring of Luae
David Demelier <markand@malikania.fr>
parents:
diff changeset
39 std::string str;
e01ee0c72c43 Luae: begin refactoring of Luae
David Demelier <markand@malikania.fr>
parents:
diff changeset
40 std::vector<std::pair<LuaeVariant, LuaeVariant>> table;
e01ee0c72c43 Luae: begin refactoring of Luae
David Demelier <markand@malikania.fr>
parents:
diff changeset
41
e01ee0c72c43 Luae: begin refactoring of Luae
David Demelier <markand@malikania.fr>
parents:
diff changeset
42 public:
e01ee0c72c43 Luae: begin refactoring of Luae
David Demelier <markand@malikania.fr>
parents:
diff changeset
43 /**
e01ee0c72c43 Luae: begin refactoring of Luae
David Demelier <markand@malikania.fr>
parents:
diff changeset
44 * Dump a value at the specific index.
e01ee0c72c43 Luae: begin refactoring of Luae
David Demelier <markand@malikania.fr>
parents:
diff changeset
45 *
e01ee0c72c43 Luae: begin refactoring of Luae
David Demelier <markand@malikania.fr>
parents:
diff changeset
46 * @param L the Lua state
e01ee0c72c43 Luae: begin refactoring of Luae
David Demelier <markand@malikania.fr>
parents:
diff changeset
47 * @param index the value
e01ee0c72c43 Luae: begin refactoring of Luae
David Demelier <markand@malikania.fr>
parents:
diff changeset
48 * @return a tree of values
e01ee0c72c43 Luae: begin refactoring of Luae
David Demelier <markand@malikania.fr>
parents:
diff changeset
49 */
e01ee0c72c43 Luae: begin refactoring of Luae
David Demelier <markand@malikania.fr>
parents:
diff changeset
50 static LuaeVariant copy(lua_State *L, int index);
e01ee0c72c43 Luae: begin refactoring of Luae
David Demelier <markand@malikania.fr>
parents:
diff changeset
51
e01ee0c72c43 Luae: begin refactoring of Luae
David Demelier <markand@malikania.fr>
parents:
diff changeset
52 /**
e01ee0c72c43 Luae: begin refactoring of Luae
David Demelier <markand@malikania.fr>
parents:
diff changeset
53 * Push a value to a state.
e01ee0c72c43 Luae: begin refactoring of Luae
David Demelier <markand@malikania.fr>
parents:
diff changeset
54 *
e01ee0c72c43 Luae: begin refactoring of Luae
David Demelier <markand@malikania.fr>
parents:
diff changeset
55 * @param L the Lua state
e01ee0c72c43 Luae: begin refactoring of Luae
David Demelier <markand@malikania.fr>
parents:
diff changeset
56 * @param value the value to push
e01ee0c72c43 Luae: begin refactoring of Luae
David Demelier <markand@malikania.fr>
parents:
diff changeset
57 */
e01ee0c72c43 Luae: begin refactoring of Luae
David Demelier <markand@malikania.fr>
parents:
diff changeset
58 static void push(lua_State *L, const LuaeVariant &value);
e01ee0c72c43 Luae: begin refactoring of Luae
David Demelier <markand@malikania.fr>
parents:
diff changeset
59
e01ee0c72c43 Luae: begin refactoring of Luae
David Demelier <markand@malikania.fr>
parents:
diff changeset
60 /**
e01ee0c72c43 Luae: begin refactoring of Luae
David Demelier <markand@malikania.fr>
parents:
diff changeset
61 * Default constructor (type nil)
e01ee0c72c43 Luae: begin refactoring of Luae
David Demelier <markand@malikania.fr>
parents:
diff changeset
62 */
e01ee0c72c43 Luae: begin refactoring of Luae
David Demelier <markand@malikania.fr>
parents:
diff changeset
63 LuaeVariant();
e01ee0c72c43 Luae: begin refactoring of Luae
David Demelier <markand@malikania.fr>
parents:
diff changeset
64 };
e01ee0c72c43 Luae: begin refactoring of Luae
David Demelier <markand@malikania.fr>
parents:
diff changeset
65
e01ee0c72c43 Luae: begin refactoring of Luae
David Demelier <markand@malikania.fr>
parents:
diff changeset
66 #endif // !_LUAE_VARIANT_H_