blob: b95a8a4a2e5ad9372bb57a2243295240a37c2446 [file] [log] [blame]
/* -----------------------------------------------------------------------------
* 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)
std::string test_value(std::string x) {
return x;
can be used as
s="hello world"
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:
Similarly for getting the string
$1 = (char*)lua_tostring(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
%typemap(out) string
%{ lua_pushlstring(L,$,$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.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
void fn(std::string& str);
Is this an in/out/inout value?
Therefore you need the usual
%apply (std::string& INOUT) {std::string& str};
%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 {
string(const char*);
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*);
// no support for all the other features
// it's probably better to do it in lua