summaryrefslogtreecommitdiff
path: root/share/swig/3.0.12/lua/std_string.i
diff options
context:
space:
mode:
Diffstat (limited to 'share/swig/3.0.12/lua/std_string.i')
-rw-r--r--share/swig/3.0.12/lua/std_string.i127
1 files changed, 127 insertions, 0 deletions
diff --git a/share/swig/3.0.12/lua/std_string.i b/share/swig/3.0.12/lua/std_string.i
new file mode 100644
index 0000000..e9f326b
--- /dev/null
+++ b/share/swig/3.0.12/lua/std_string.i
@@ -0,0 +1,127 @@
+/* -----------------------------------------------------------------------------
+ * std_string.i
+ *
+ * std::string typemaps for LUA
+ * ----------------------------------------------------------------------------- */
+
+%{
+#include <string>
+%}
+
+/*
+Only std::string and const std::string& are typemapped
+they are converted to the Lua strings automatically
+
+std::string& and std::string* are not
+they must be explicitly managed (see below)
+
+eg.
+
+std::string test_value(std::string x) {
+ return x;
+}
+
+can be used as
+
+s="hello world"
+s2=test_value(s)
+assert(s==s2)
+*/
+
+namespace std {
+
+%naturalvar string;
+
+/*
+Bug report #1526022:
+Lua strings and std::string can contain embedded zero bytes
+Therefore a standard out typemap should not be:
+ lua_pushstring(L,$1.c_str());
+but
+ lua_pushlstring(L,$1.data(),$1.size());
+
+Similarly for getting the string
+ $1 = (char*)lua_tostring(L, $input);
+becomes
+ $1.assign(lua_tostring(L,$input),lua_rawlen(L,$input));
+
+Not using: lua_tolstring() as this is only found in Lua 5.1 & not 5.0.2
+*/
+
+%typemap(in,checkfn="lua_isstring") string
+%{$1.assign(lua_tostring(L,$input),lua_rawlen(L,$input));%}
+
+%typemap(out) string
+%{ lua_pushlstring(L,$1.data(),$1.size()); SWIG_arg++;%}
+
+%typemap(in,checkfn="lua_isstring") const string& ($*1_ltype temp)
+%{temp.assign(lua_tostring(L,$input),lua_rawlen(L,$input)); $1=&temp;%}
+
+%typemap(out) const string&
+%{ lua_pushlstring(L,$1->data(),$1->size()); SWIG_arg++;%}
+
+// for throwing of any kind of string, string ref's and string pointers
+// we convert all to lua strings
+%typemap(throws) string, string&, const string&
+%{ lua_pushlstring(L,$1.data(),$1.size()); SWIG_fail;%}
+
+%typemap(throws) string*, const string*
+%{ lua_pushlstring(L,$1->data(),$1->size()); SWIG_fail;%}
+
+%typecheck(SWIG_TYPECHECK_STRING) string, const string& {
+ $1 = lua_isstring(L,$input);
+}
+
+/*
+std::string& can be wrapped, but you must inform SWIG if it is in or out
+
+eg:
+void fn(std::string& str);
+Is this an in/out/inout value?
+
+Therefore you need the usual
+%apply (std::string& INOUT) {std::string& str};
+or
+%apply std::string& INOUT {std::string& str};
+typemaps to tell SWIG what to do.
+*/
+
+%typemap(in) string &INPUT=const string &;
+%typemap(in, numinputs=0) string &OUTPUT ($*1_ltype temp)
+%{ $1 = &temp; %}
+%typemap(argout) string &OUTPUT
+%{ lua_pushlstring(L,$1->data(),$1->size()); SWIG_arg++;%}
+%typemap(in) string &INOUT =const string &;
+%typemap(argout) string &INOUT = string &OUTPUT;
+
+/*
+A really cut down version of the string class
+
+This provides basic mapping of lua strings <-> std::string
+and little else
+(the std::string has a lot of unneeded functions anyway)
+
+note: no fn's taking the const string&
+as this is overloaded by the const char* version
+*/
+
+ class string {
+ public:
+ string();
+ string(const char*);
+ //string(const string&);
+ unsigned int size() const;
+ unsigned int length() const;
+ bool empty() const;
+ // no support for operator[]
+ const char* c_str()const;
+ const char* data()const;
+ // assign does not return a copy of this object
+ // (no point in a scripting language)
+ void assign(const char*);
+ //void assign(const string&);
+ // no support for all the other features
+ // it's probably better to do it in lua
+ };
+}
+