wxPython/src/my_typemaps.i

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        my_typemaps.i
   3 // Purpose:     Special typemaps specifically for wxPython.
   4 //
   5 // Author:      Robin Dunn
   6 //
   7 // Created:     7/3/97
   8 // RCS-ID:      $Id$
   9 // Copyright:   (c) 1998 by Total Control Software
  10 // Licence:     wxWindows license
  11 /////////////////////////////////////////////////////////////////////////////
  12
  13
  14 //----------------------------------------------------------------------
  15 // Typemaps to convert a list of items to an int (size) and an array
  16
  17 %define MAKE_INT_ARRAY_TYPEMAPS(NAME, ARR_NAME)
  18     %typemap(in) (int NAME, int* ARR_NAME) {
  19         $1 = PyList_Size($input);
  20         $2 =  int_LIST_helper($input);
  21         if ($2 == NULL) SWIG_fail;
  22     }
  23
  24     %typemap(freearg) (int NAME, int* ARR_NAME) {
  25         if ($2) delete [] $2;
  26     }
  27 %enddef
  28
  29 MAKE_INT_ARRAY_TYPEMAPS(widths, widths_field)
  30 MAKE_INT_ARRAY_TYPEMAPS(styles, styles_field)
  31
  32
  33
  34 // Same things for a wxString
  35 %typemap(in) (int choices, wxString* choices_array ) {
  36     $1 = PyList_Size($input);
  37     $2 = wxString_LIST_helper($input);
  38     if ($2 == NULL) SWIG_fail;
  39 }
  40 %typemap(freearg) (int choices, wxString* choices_array ) {
  41     if ($2) delete [] $2;
  42 }
  43
  44
  45
  46 //---------------------------------------------------------------------------
  47 // wxString typemaps
  48
  49
  50 %typemap(in) wxString& (bool temp=false) {
  51     $1 = wxString_in_helper($input);
  52     if ($1 == NULL) SWIG_fail;
  53     temp = true;
  54 }
  55 %typemap(freearg) wxString& {
  56     if (temp$argnum)
  57         delete $1;
  58 }
  59
  60 %typemap(out) wxString& {
  61 %#if wxUSE_UNICODE
  62     $result = PyUnicode_FromWideChar($1->c_str(), $1->Len());
  63 %#else
  64     $result = PyString_FromStringAndSize($1->c_str(), $1->Len());
  65 %#endif
  66 }
  67
  68
  69 %apply wxString& { wxString* }
  70
  71
  72
  73 %typemap(out) wxString {
  74 %#if wxUSE_UNICODE
  75     $result = PyUnicode_FromWideChar($1.c_str(), $1.Len());
  76 %#else
  77     $result = PyString_FromStringAndSize($1.c_str(), $1.Len());
  78 %#endif
  79 }
  80
  81 %typemap(varout) wxString {
  82 %#if wxUSE_UNICODE
  83     $result = PyUnicode_FromWideChar($1.c_str(), $1.Len());
  84 %#else
  85     $result = PyString_FromStringAndSize($1.c_str(), $1.Len());
  86 %#endif
  87 }
  88
  89
  90 %typemap(in) wxString {
  91     wxString* sptr = wxString_in_helper($input);
  92     if (sptr == NULL) SWIG_fail;
  93     $1 = *sptr;
  94     delete sptr;
  95 }
  96
  97 %typemap(typecheck, precedence=SWIG_TYPECHECK_POINTER) wxString& {
  98     $1 = PyString_Check($input) || PyUnicode_Check($input);
  99 }
 100
 101 //---------------------------------------------------------------------------
 102 // wxMemoryBuffer  (needed for wxSTC)
 103
 104 %typemap(in) wxMemoryBuffer& (bool temp=false) {
 105     if (!PyString_Check($input)) {
 106         PyErr_SetString(PyExc_TypeError, "String buffer expected");
 107         SWIG_fail;
 108     }
 109     char* str = PyString_AS_STRING($input);
 110     int   len = PyString_GET_SIZE($input);
 111     $1 = new wxMemoryBuffer(len);
 112     temp = true;
 113     memcpy($1->GetData(), str, len);
 114     $1->SetDataLen(len);
 115 }
 116
 117 %typemap(freearg) wxMemoryBuffer& {
 118     if (temp$argnum) delete $1;
 119 }
 120
 121 %typemap(out) wxMemoryBuffer {
 122     $result = PyString_FromStringAndSize((char*)$1.GetData(), $1.GetDataLen());
 123 }
 124
 125
 126
 127 %typemap(out) wxCharBuffer {
 128     $result = PyString_FromString((char*)$1.data());
 129 }
 130
 131
 132 //---------------------------------------------------------------------------
 133 // Typemaps to convert Python sequence objects (tuples, etc.) to
 134 // wxSize, wxPoint, wxRealPoint, and wxRect.
 135
 136
 137 %typemap(in) wxSize& (wxSize temp) {
 138     $1 = &temp;
 139     if ( ! wxSize_helper($input, &$1)) SWIG_fail;
 140 }
 141 %typemap(typecheck, precedence=SWIG_TYPECHECK_POINTER) wxSize& {
 142     $1 = wxPySimple_typecheck($input, wxT("wxSize"), 2);
 143 }
 144
 145
 146 %typemap(in) wxPoint& (wxPoint temp) {
 147     $1 = &temp;
 148     if ( ! wxPoint_helper($input, &$1)) SWIG_fail;
 149 }
 150 %typemap(typecheck, precedence=SWIG_TYPECHECK_POINTER) wxPoint& {
 151     $1 = wxPySimple_typecheck($input, wxT("wxPoint"), 2);
 152 }
 153
 154
 155 %typemap(in) wxRealPoint& (wxRealPoint temp) {
 156     $1 = &temp;
 157     if ( ! wxRealPoint_helper($input, &$1)) SWIG_fail;
 158 }
 159 %typemap(typecheck, precedence=SWIG_TYPECHECK_POINTER) wxRealPoint& {
 160     $1 = wxPySimple_typecheck($input, wxT("wxRealPoint"), 2);
 161 }
 162
 163
 164 %typemap(in) wxRect& (wxRect temp) {
 165     $1 = &temp;
 166     if ( ! wxRect_helper($input, &$1)) SWIG_fail;
 167 }
 168 %typemap(typecheck, precedence=SWIG_TYPECHECK_POINTER) wxRect& {
 169     $1 = wxPySimple_typecheck($input, wxT("wxRect"), 4);
 170 }
 171
 172
 173 %typemap(in) wxPoint2D& (wxPoint2D temp) {
 174     $1 = &temp;
 175     if ( ! wxPoint2D_helper($input, &$1)) SWIG_fail;
 176 }
 177 %typemap(typecheck, precedence=SWIG_TYPECHECK_POINTER) wxPoint2D& {
 178     $1 = wxPySimple_typecheck($input, wxT("wxPoint2D"), 2);
 179 }
 180
 181
 182 //---------------------------------------------------------------------------
 183 // Typemap to convert strings to wxColour.  Two string formats are accepted,
 184 // either a colour name, or a hex colour spec like "#RRGGBB"
 185
 186 %typemap(in) wxColour& (wxColour temp) {
 187     $1 = &temp;
 188     if ( ! wxColour_helper($input, &$1)) SWIG_fail;
 189 }
 190 %typemap(typecheck, precedence=SWIG_TYPECHECK_POINTER) wxColour& {
 191     $1 = wxColour_typecheck($input);
 192 }
 193
 194
 195
 196 //---------------------------------------------------------------------------
 197 // Typemap for wxArrayString from Python sequence objects
 198
 199 %typemap(in) wxArrayString& (bool temp=false) {
 200     if (! PySequence_Check($input)) {
 201         PyErr_SetString(PyExc_TypeError, "Sequence of strings expected.");
 202         SWIG_fail;
 203     }
 204     $1 = new wxArrayString;
 205     temp = true;
 206     int i, len=PySequence_Length($input);
 207     for (i=0; i<len; i++) {
 208         PyObject* item = PySequence_GetItem($input, i);
 209         wxString* s = wxString_in_helper(item);
 210         if (PyErr_Occurred())  SWIG_fail;
 211         $1->Add(*s);
 212         delete s;
 213         Py_DECREF(item);
 214     }
 215 }
 216
 217 %typemap(freearg) wxArrayString& {
 218     if (temp$argnum) delete $1;
 219 }
 220
 221 //---------------------------------------------------------------------------
 222 // Typemap for wxArrayInt from Python sequence objects
 223
 224 %typemap(in) wxArrayInt& (bool temp=false) {
 225     if (! PySequence_Check($input)) {
 226         PyErr_SetString(PyExc_TypeError, "Sequence of integers expected.");
 227         SWIG_fail;
 228     }
 229     $1 = new wxArrayInt;
 230     temp = true;
 231     int i, len=PySequence_Length($input);
 232     for (i=0; i<len; i++) {
 233         PyObject* item = PySequence_GetItem($input, i);
 234         PyObject* number  = PyNumber_Int(item);
 235         $1->Add(PyInt_AS_LONG(number));
 236         Py_DECREF(item);
 237         Py_DECREF(number);
 238     }
 239 }
 240
 241 %typemap(freearg) wxArrayInt& {
 242     if (temp$argnum) delete $1;
 243 }
 244
 245
 246 //---------------------------------------------------------------------------
 247 // Typemaps to convert an array of ints to a list for return values
 248 %typemap(out) wxArrayInt& {
 249     $result = PyList_New(0);
 250     size_t idx;
 251     for (idx = 0; idx < $1->GetCount(); idx += 1) {
 252         PyObject* val = PyInt_FromLong( $1->Item(idx) );
 253         PyList_Append($result, val);
 254         Py_DECREF(val);
 255     }
 256 }
 257
 258 %typemap(out) wxArrayInt {
 259     $result = PyList_New(0);
 260     size_t idx;
 261     for (idx = 0; idx < $1.GetCount(); idx += 1) {
 262         PyObject* val = PyInt_FromLong( $1.Item(idx) );
 263         PyList_Append($result, val);
 264         Py_DECREF(val);
 265     }
 266 }
 267
 268
 269
 270 // Typemaps to convert an array of strings to a list for return values
 271 %typemap(out) wxArrayString& {
 272     $result = wxArrayString2PyList_helper(*$1);
 273 }
 274
 275 %typemap(out) wxArrayString {
 276     $result = wxArrayString2PyList_helper($1);
 277 }
 278
 279
 280 //---------------------------------------------------------------------------
 281
 282 %typemap(out) bool {
 283     $result = $1 ? Py_True : Py_False; Py_INCREF($result);
 284 }
 285
 286
 287 //---------------------------------------------------------------------------
 288 // wxFileOffset, can be a 32-bit or a 64-bit integer
 289
 290 %typemap(in) wxFileOffset {
 291     if (sizeof(wxFileOffset) > sizeof(long))
 292         $1 = PyLong_AsLongLong($input);
 293     else
 294         $1 = PyInt_AsLong($input);
 295 }
 296
 297 %typemap(out) wxFileOffset {
 298     if (sizeof(wxFileOffset) > sizeof(long))
 299         $result = PyLong_FromLongLong($1);
 300     else
 301         $result = PyInt_FromLong($1);
 302 }
 303
 304
 305 //---------------------------------------------------------------------------
 306 // Typemap for when GDI objects are returned by reference.  This will cause a
 307 // copy to be made instead of returning a reference to the same instance.  The
 308 // GDI object's internal refcounting scheme will do a copy-on-write of the
 309 // internal data as needed.
 310
 311 // These too?
 312 //, wxRegion&, wxPalette&
 313
 314 %typemap(out) wxBrush&, wxPen&, wxFont&, wxBitmap&, wxIcon&, wxCursor& {
 315     $*1_ltype* resultptr = new $*1_ltype(*$1);
 316     $result = SWIG_NewPointerObj((void*)(resultptr), $1_descriptor, 1);
 317 }
 318
 319
 320 //---------------------------------------------------------------------------
 321 // Typemaps to convert return values that are base class pointers
 322 // to the real derived type, if possible.  See wxPyMake_wxObject in
 323 // helpers.cpp
 324
 325 // NOTE: For those classes that also call _setOORInfo these typemaps should be
 326 // disabled for the constructor.
 327
 328 %typemap(out) wxEvtHandler*             { $result = wxPyMake_wxObject($1, $owner); }
 329 %typemap(out) wxMenu*                   { $result = wxPyMake_wxObject($1, $owner); }
 330 %typemap(out) wxValidator*              { $result = wxPyMake_wxObject($1, $owner); }
 331
 332 %typemap(out) wxApp*                    { $result = wxPyMake_wxObject($1, $owner); }
 333 %typemap(out) wxPyApp*                  { $result = wxPyMake_wxObject($1, $owner); }
 334 %typemap(out) wxDC*                     { $result = wxPyMake_wxObject($1, $owner); }
 335 %typemap(out) wxFSFile*                 { $result = wxPyMake_wxObject($1, $owner); }
 336 %typemap(out) wxFileSystem*             { $result = wxPyMake_wxObject($1, $owner); }
 337 %typemap(out) wxImageList*              { $result = wxPyMake_wxObject($1, $owner); }
 338 %typemap(out) wxImage*                  { $result = wxPyMake_wxObject($1, $owner); }
 339 %typemap(out) wxListItem*               { $result = wxPyMake_wxObject($1, $owner); }
 340 %typemap(out) wxMenuItem*               { $result = wxPyMake_wxObject($1, $owner); }
 341 %typemap(out) wxMouseEvent*             { $result = wxPyMake_wxObject($1, $owner); }
 342 %typemap(out) wxObject*                 { $result = wxPyMake_wxObject($1, $owner); }
 343 %typemap(out) wxPyPrintout*             { $result = wxPyMake_wxObject($1, $owner); }
 344 %typemap(out) wxToolBarToolBase*        { $result = wxPyMake_wxObject($1, $owner); }
 345 %typemap(out) wxToolTip*                { $result = wxPyMake_wxObject($1, $owner); }
 346
 347
 348 %typemap(out) wxBitmapButton*           { $result = wxPyMake_wxObject($1, $owner); }
 349 %typemap(out) wxButton*                 { $result = wxPyMake_wxObject($1, $owner); }
 350 %typemap(out) wxControl*                { $result = wxPyMake_wxObject($1, $owner); }
 351 %typemap(out) wxFrame*                  { $result = wxPyMake_wxObject($1, $owner); }
 352 %typemap(out) wxGrid*                   { $result = wxPyMake_wxObject($1, $owner); }
 353 //%typemap(out) wxListCtrl*               { $result = wxPyMake_wxObject($1, $owner); }
 354 %typemap(out) wxMDIChildFrame*          { $result = wxPyMake_wxObject($1, $owner); }
 355 %typemap(out) wxMDIClientWindow*        { $result = wxPyMake_wxObject($1, $owner); }
 356 %typemap(out) wxMenuBar*                { $result = wxPyMake_wxObject($1, $owner); }
 357 %typemap(out) wxNotebook*               { $result = wxPyMake_wxObject($1, $owner); }
 358 %typemap(out) wxStaticBox*              { $result = wxPyMake_wxObject($1, $owner); }
 359 %typemap(out) wxStatusBar*              { $result = wxPyMake_wxObject($1, $owner); }
 360 %typemap(out) wxTextCtrl*               { $result = wxPyMake_wxObject($1, $owner); }
 361 %typemap(out) wxToolBar*                { $result = wxPyMake_wxObject($1, $owner); }
 362 %typemap(out) wxToolBarBase*            { $result = wxPyMake_wxObject($1, $owner); }
 363 //%typemap(out) wxTreeCtrl*               { $result = wxPyMake_wxObject($1, $owner); }
 364 %typemap(out) wxPyTreeCtrl*             { $result = wxPyMake_wxObject($1, $owner); }
 365 %typemap(out) wxWindow*                 { $result = wxPyMake_wxObject($1, $owner); }
 366 %typemap(out) wxPyHtmlWindow*           { $result = wxPyMake_wxObject($1, $owner); }
 367 %typemap(out) wxWizardPage*             { $result = wxPyMake_wxObject($1, $owner); }
 368 %typemap(out) wxPyWizardPage*           { $result = wxPyMake_wxObject($1, $owner); }
 369 %typemap(out) wxPanel*                  { $result = wxPyMake_wxObject($1, $owner); }
 370 %typemap(out) wxDialog*                 { $result = wxPyMake_wxObject($1, $owner); }
 371 %typemap(out) wxScrolledWindow*         { $result = wxPyMake_wxObject($1, $owner); }
 372
 373 %typemap(out) wxSizer*                  { $result = wxPyMake_wxObject($1, $owner); }
 374
 375
 376 //---------------------------------------------------------------------------
 377 //---------------------------------------------------------------------------
 378
 379
 380
 381
 382
 383