Examples/test-suite/cpp11_raw_string_literals.i

/* This module tests whether SWIG correctly parses:
   -    ordinary strings (char)
   - L  wide strings (wchar_t)
   - u8 unicode8 strings (char / char8_t since C++20)
   - u  unicode16 strings (char16_t)
   - U  unicode32 strings (char32_t)

   This module also tests whether SWIG correctly parses custom string delimiters.
*/
%module cpp11_raw_string_literals
%warnfilter(SWIGWARN_TYPEMAP_CHARLEAK) bb;
%warnfilter(SWIGWARN_TYPEMAP_CHARLEAK) ee;
%warnfilter(SWIGWARN_TYPEMAP_CHARLEAK) gg;
%warnfilter(SWIGWARN_TYPEMAP_CHARLEAK) xx;
%warnfilter(SWIGWARN_TYPEMAP_SWIGTYPELEAK) cc;
%warnfilter(SWIGWARN_TYPEMAP_SWIGTYPELEAK) dd;
%warnfilter(SWIGWARN_TYPEMAP_SWIGTYPELEAK) hh;
%warnfilter(SWIGWARN_TYPEMAP_SWIGTYPELEAK) ii;

#if defined(SWIGTCL) || defined(SWIGCSHARP) || defined(SWIGOCTAVE) || defined(SWIGRUBY) || defined(SWIGPYTHON) || defined(SWIGJAVA)
%include <std_wstring.i>
#endif

#if defined(SWIGLUA)
// Lua uses a parameter called L in every wrapper function
%ignore L;
#endif

%inline %{
#include <iostream>
#include <string>

using namespace std;

int L  = 100;
int u8 = 100;
int u  = 100;
struct UStruct {
  static const int U  = 100;
};

int R   = 100;
int LR  = 100;
int u8R = 100;
int uR  = 100;
struct URStruct {
  static const int UR  = 100;
};

// New string literals
wstring         aa =  L"Wide string";
// u8"" is const char8_t[N] in C++20; const char[N] from C++11 until then.
const char     *bb = reinterpret_cast<const char*>(u8"UTF-8 string");
const char16_t *cc =  u"UTF-16 string";
const char32_t *dd =  U"UTF-32 string";
// New char literals
char16_t char16_t_char = u'a';
char32_t char32_t_char = U'b';
%}

%constant const wchar_t *ll = L"Wide string constant";

/* Raw string literals */
%inline %{
const char      *xx =        ")I'm an \"ascii\" \\ string.";
const char      *ee =   R"XXX()I'm an "ascii" \ string.)XXX";
wstring          ff =  LR"XXX(I'm a "raw wide" \ string.)XXX";
const char      *gg = reinterpret_cast<const char*>(u8R"XXX(I'm a "raw UTF-8" \ string.)XXX");
const char16_t  *hh =  uR"XXX(I'm a "raw UTF-16" \ string.)XXX";
const char32_t  *ii =  UR"XXX(I'm a "raw UTF-32" \ string.)XXX";
%}

// A wide raw string literal has the type and value of a wide string literal
%constant const wchar_t *nn = LR"XXX(I'm a "raw wide" \ string constant.)XXX";
%feature("compactdefaultargs") raw_wide_default_length;

%inline %{
#include <cwchar>
static constexpr auto ww = LR"XXX(I'm a "raw wide" \ auto.)XXX";
size_t raw_wide_default_length(const wchar_t *s = LR"XXX(abcd)XXX") { return wcslen(s); }
%}

// Constants
#if defined(SWIGJAVA)
%javaconst(1);
#elif SWIGCSHARP
%csconst(1);
#elif SWIGD
%dmanifestconst;
#endif

%inline %{
#define   jj          ")I'm an \"ascii\" \\ string constant."
#define   kk     R"XXX()I'm an "ascii" \ string constant.)XXX";
%}

%constant mm =   R"XXX()I'm an "ascii" \ string constant with multiple

lines.)XXX";

// docstring feature
%feature("docstring") RawStringDoc::WW "Single line documentation comment"
%feature("docstring") RawStringDoc::XX %{
Multi-line
documentation
comment
%}
%feature("docstring") RawStringDoc::YY R"RRR(Single line "raw string" documentation comment)RRR"
%feature("docstring") RawStringDoc::ZZ R"FOO(Documentation comment

as a "raw string"
on multiple lines including a \ backslash)FOO"

%inline %{
struct RawStringDoc {
  void WW() {}
  void XX() {}
  void YY() {}
  void ZZ() {}
};
%}