Add documentation on placing tiles.
[Tsunagari.git] / src / scriptinst.h
blobb9e38eb2f09d6b1e64e8ee9e04291d8bcbbb9e2b
1 /*********************************
2 ** Tsunagari Tile Engine **
3 ** scriptinst.h **
4 ** Copyright 2011-2012 OmegaSDG **
5 *********************************/
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:
15 // The above copyright notice and this permission notice shall be included in
16 // all copies or substantial portions of the Software.
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 // **********
27 #ifndef SCRIPTINST_H
28 #define SCRIPTINST_H
30 #include <string>
32 #include <boost/python/object.hpp>
33 #include <boost/variant.hpp>
35 class ScriptInst
37 public:
38 ScriptInst();
39 ScriptInst(const std::string& strloc);
40 ScriptInst(boost::python::object pyfn);
42 // context = domain for errors msgs
43 bool validate(const std::string& context);
44 bool invoke();
46 private:
47 struct strref {
48 std::string filename;
49 std::string funcname;
50 PyCodeObject* funccall;
53 boost::variant<
54 void*,
55 strref,
56 boost::python::object
57 > data;
59 friend struct validate_visitor;
60 friend struct invoke_visitor;
61 friend struct topython_visitor;
62 friend struct scriptinst_to_python;
65 void exportScriptInst();
67 #endif