added obsolescence note

[wxWidgets.git] / wxPython / src / my_typemaps.i

/////////////////////////////////////////////////////////////////////////////
// Name:        my_typemaps.i
// Purpose:     Special typemaps specifically for wxPython.
//
// Author:      Robin Dunn
//
// Created:     7/3/97
// RCS-ID:      $Id$
// Copyright:   (c) 1998 by Total Control Software
// Licence:     wxWindows license
/////////////////////////////////////////////////////////////////////////////


//---------------------------------------------------------------------------
// Tell SWIG to wrap all the wrappers with our thread protection

%exception {
    PyThreadState* __tstate = wxPyBeginAllowThreads();
    $action
    wxPyEndAllowThreads(__tstate);
    if (PyErr_Occurred()) SWIG_fail;
}


//----------------------------------------------------------------------
// Typemaps to convert a list of items to an int (size) and an array

%typemap(in) (int choices, wxString* choices_array ) {
    $1 = PyList_Size($input);
    $2 = wxString_LIST_helper($input);
    if ($2 == NULL) SWIG_fail;
}
%typemap(freearg) (int choices, wxString* choices_array ) {
    if ($2) delete [] $2;
}




//---------------------------------------------------------------------------
// wxString typemaps


%typemap(in) wxString& (bool temp=False) {
    $1 = wxString_in_helper($input);
    if ($1 == NULL) SWIG_fail;
    temp = True;
}
%typemap(freearg) wxString& {
    if (temp$argnum)
        delete $1;
}



%typemap(out) wxString {
%#if wxUSE_UNICODE
    $result = PyUnicode_FromWideChar($1.c_str(), $1.Len());
%#else
    $result = PyString_FromStringAndSize($1.c_str(), $1.Len());
%#endif
}

%typemap(out) wxString* {
%#if wxUSE_UNICODE
    $result = PyUnicode_FromWideChar($1->c_str(), $1->Len());
%#else
    $result = PyString_FromStringAndSize($1->c_str(), $1->Len());
%#endif
}

%typemap(varout) wxString {
%#if wxUSE_UNICODE
    $result = PyUnicode_FromWideChar($1.c_str(), $1.Len());
%#else
    $result = PyString_FromStringAndSize($1.c_str(), $1.Len());
%#endif
}


%typemap(in) wxString {
    wxString* sptr = wxString_in_helper($input);
    if (sptr == NULL) SWIG_fail;
    $1 = *sptr;
    delete sptr;
}
    
   

// //---------------------------------------------------------------------------


// %typemap(python, in) wxMemoryBuffer& {
//     if (!PyString_Check($source)) {
//         PyErr_SetString(PyExc_TypeError, "String buffer expected");
//         return NULL;
//     }
//     char* str = PyString_AS_STRING($source);
//     int   len = PyString_GET_SIZE($source);
//     $target = new wxMemoryBuffer(len);
//     memcpy($target->GetData(), str, len);
// }

// %typemap(python, freearg) wxMemoryBuffer& {
//     if ($target)
//         delete $source;
// }

// %typemap(python, out) wxMemoryBuffer {
//     $target = PyString_FromStringAndSize((char*)$source->GetData(), $source->GetDataLen());
// }

// %typemap(python, ret) wxMemoryBuffer {
//     delete $source;
// }


//---------------------------------------------------------------------------
// Typemaps to convert Python sequence objects (tuples, etc.) to
// wxSize, wxPoint, wxRealPoint, and wxRect.


%typemap(in) wxSize& (wxSize temp) {
    $1 = &temp;
    if ( ! wxSize_helper($input, &$1)) SWIG_fail;
}
%typemap(typecheck, precedence=SWIG_TYPECHECK_POINTER) wxSize& {
    $1 = wxPySimple_typecheck($input, wxT("wxSize"), 2);
}


%typemap(in) wxPoint& (wxPoint temp) {
    $1 = &temp;
    if ( ! wxPoint_helper($input, &$1)) SWIG_fail;
}
%typemap(typecheck, precedence=SWIG_TYPECHECK_POINTER) wxPoint& {
    $1 = wxPySimple_typecheck($input, wxT("wxPoint"), 2);
}


%typemap(in) wxRealPoint& (wxRealPoint temp) {
    $1 = &temp;
    if ( ! wxRealPoint_helper($input, &$1)) SWIG_fail;
}
%typemap(typecheck, precedence=SWIG_TYPECHECK_POINTER) wxRealPoint& {
    $1 = wxPySimple_typecheck($input, wxT("wxRealPoint"), 2);
}


%typemap(in) wxRect& (wxRect temp) {
    $1 = &temp;
    if ( ! wxRect_helper($input, &$1)) SWIG_fail;
}
%typemap(typecheck, precedence=SWIG_TYPECHECK_POINTER) wxRect& {
    $1 = wxPySimple_typecheck($input, wxT("wxRect"), 4);
}


%typemap(in) wxPoint2D& (wxPoint2D temp) {
    $1 = &temp;
    if ( ! wxPoint2D_helper($input, &$1)) SWIG_fail;
}
%typemap(typecheck, precedence=SWIG_TYPECHECK_POINTER) wxPoint2D& {
    $1 = wxPySimple_typecheck($input, wxT("wxPoint2D"), 2);
}


//---------------------------------------------------------------------------
// Typemap to convert strings to wxColour.  Two string formats are accepted,
// either a colour name, or a hex colour spec like "#RRGGBB"

%typemap(in) wxColour& (wxColour temp) {
    $1 = &temp;
    if ( ! wxColour_helper($input, &$1)) SWIG_fail;
}
%typemap(typecheck, precedence=SWIG_TYPECHECK_POINTER) wxColour& {
    $1 = wxColour_typecheck($input);
}



//---------------------------------------------------------------------------
// Typemap for wxArrayString from Python sequence objects

%typemap(in) wxArrayString& {
    if (! PySequence_Check($input)) {
        PyErr_SetString(PyExc_TypeError, "Sequence of strings expected.");
        SWIG_fail;
    }
    $1 = new wxArrayString;
    int i, len=PySequence_Length($input);
    for (i=0; i<len; i++) {
        PyObject* item = PySequence_GetItem($input, i);
%#if wxUSE_UNICODE
        PyObject* str  = PyObject_Unicode(item);
%#else
        PyObject* str  = PyObject_Str(item);
%#endif
        $1->Add(Py2wxString(str));
        Py_DECREF(item);
        Py_DECREF(str);
    }
}

%typemap(freearg) wxArrayString& {
    if ($1) delete $1;
}

//---------------------------------------------------------------------------
// Typemap for wxArrayInt from Python sequence objects

%typemap(in) wxArrayInt& {
    if (! PySequence_Check($input)) {
        PyErr_SetString(PyExc_TypeError, "Sequence of integers expected.");
        SWIG_fail;
    }
    $1 = new wxArrayInt;
    int i, len=PySequence_Length($input);
    for (i=0; i<len; i++) {
        PyObject* item = PySequence_GetItem($input, i);
        PyObject* number  = PyNumber_Int(item);
        $1->Add(PyInt_AS_LONG(number));
        Py_DECREF(item);
        Py_DECREF(number);
    }
}

%typemap(freearg) wxArrayInt& {
    if ($1) delete $1;
}


//---------------------------------------------------------------------------
// Typemaps to convert an array of ints to a list for return values
%typemap(out) wxArrayInt& {
    $result = PyList_New(0);
    size_t idx;
    for (idx = 0; idx < $1->GetCount(); idx += 1) {
        PyObject* val = PyInt_FromLong( $1->Item(idx) );
        PyList_Append($result, val);
        Py_DECREF(val);
    }
}

%typemap(out) wxArrayInt {
    $result = PyList_New(0);
    size_t idx;
    for (idx = 0; idx < $1.GetCount(); idx += 1) {
        PyObject* val = PyInt_FromLong( $1.Item(idx) );
        PyList_Append($result, val);
        Py_DECREF(val);
    }
}



// Typemaps to convert an array of ints to a list for return values
%typemap(out) wxArrayString& {
    $result = wxArrayString2PyList_helper(*$1);
}

%typemap(out) wxArrayString {
    $result = wxArrayString2PyList_helper($1);
}


// //---------------------------------------------------------------------------
// // Map T_OUTPUTs for floats to return ints.


// %typemap(python,ignore) float          *T_OUTPUT_TOINT(float temp),
//                         double         *T_OUTPUT_TOINT(double temp)
// {
//   $target = &temp;
// }


// %typemap(python,argout) float          *T_OUTPUT_TOINT,
//                         double         *T_OUTPUT_TOINT
// {
//     PyObject *o;
//     o = PyInt_FromLong((long) (*$source));
//     $target = t_output_helper($target, o);
// }


// %typemap(python,ignore) bool *T_OUTPUT(int temp)
// {
//   $target = (bool*)&temp;
// }

// %typemap(python,argout) bool *T_OUTPUT
// {
//     PyObject *o;
//     o = PyInt_FromLong((long) (*$source));
//     $target = t_output_helper($target, o);
// }

// %typemap(python,ignore) bool  *OUTPUT = bool *T_OUTPUT;
// %typemap(python,argout) bool  *OUTPUT = bool *T_OUTPUT;



// %typemap(python,ignore) byte *T_OUTPUT(int temp)
// {
//   $target = (byte*)&temp;
// }

// %typemap(python,argout) byte *T_OUTPUT
// {
//     PyObject *o;
//     o = PyInt_FromLong((long) (*$source));
//     $target = t_output_helper($target, o);
// }

// %typemap(python,ignore) byte  *OUTPUT = byte *T_OUTPUT;
// %typemap(python,argout) byte  *OUTPUT = byte *T_OUTPUT;


// %typemap(python,ignore) wxCoord *OUTPUT = int *OUTPUT;
// %typemap(python,argout) wxCoord *OUTPUT = int *OUTPUT;


//---------------------------------------------------------------------------
// Typemaps to convert return values that are base class pointers
// to the real derived type, if possible.  See wxPyMake_wxObject in
// helpers.cpp

%typemap(out) wxEvtHandler*             { $result = wxPyMake_wxObject($1); }
%typemap(out) wxMenu*                   { $result = wxPyMake_wxObject($1); }
%typemap(out) wxValidator*              { $result = wxPyMake_wxObject($1); }

%typemap(out) wxApp*                    { $result = wxPyMake_wxObject($1); }
%typemap(out) wxPyApp*                  { $result = wxPyMake_wxObject($1); }
%typemap(out) wxDC*                     { $result = wxPyMake_wxObject($1); }
%typemap(out) wxFSFile*                 { $result = wxPyMake_wxObject($1); }
%typemap(out) wxFileSystem*             { $result = wxPyMake_wxObject($1); }
%typemap(out) wxGridTableBase*          { $result = wxPyMake_wxObject($1); }
%typemap(out) wxImageList*              { $result = wxPyMake_wxObject($1); }
%typemap(out) wxListItem*               { $result = wxPyMake_wxObject($1); }
%typemap(out) wxMenuItem*               { $result = wxPyMake_wxObject($1); }
%typemap(out) wxMouseEvent*             { $result = wxPyMake_wxObject($1); }
%typemap(out) wxObject*                 { $result = wxPyMake_wxObject($1); }
%typemap(out) wxPyPrintout*             { $result = wxPyMake_wxObject($1); }
%typemap(out) wxToolBarToolBase*        { $result = wxPyMake_wxObject($1); }
%typemap(out) wxToolTip*                { $result = wxPyMake_wxObject($1); }


%typemap(out) wxBitmapButton*           { $result = wxPyMake_wxObject($1); }
%typemap(out) wxButton*                 { $result = wxPyMake_wxObject($1); }
%typemap(out) wxControl*                { $result = wxPyMake_wxObject($1); }
%typemap(out) wxFrame*                  { $result = wxPyMake_wxObject($1); }
%typemap(out) wxGrid*                   { $result = wxPyMake_wxObject($1); }
%typemap(out) wxListCtrl*               { $result = wxPyMake_wxObject($1); }
%typemap(out) wxMDIChildFrame*          { $result = wxPyMake_wxObject($1); }
%typemap(out) wxMDIClientWindow*        { $result = wxPyMake_wxObject($1); }
%typemap(out) wxMenuBar*                { $result = wxPyMake_wxObject($1); }
%typemap(out) wxNotebook*               { $result = wxPyMake_wxObject($1); }
%typemap(out) wxStaticBox*              { $result = wxPyMake_wxObject($1); }
%typemap(out) wxStatusBar*              { $result = wxPyMake_wxObject($1); }
%typemap(out) wxTextCtrl*               { $result = wxPyMake_wxObject($1); }
%typemap(out) wxToolBar*                { $result = wxPyMake_wxObject($1); }
%typemap(out) wxToolBarBase*            { $result = wxPyMake_wxObject($1); }
%typemap(out) wxTreeCtrl*               { $result = wxPyMake_wxObject($1); }
%typemap(out) wxWindow*                 { $result = wxPyMake_wxObject($1); }
%typemap(out) wxHtmlWindow*             { $result = wxPyMake_wxObject($1); }
%typemap(out) wxPyHtmlWindow*           { $result = wxPyMake_wxObject($1); }
%typemap(out) wxWizardPage*             { $result = wxPyMake_wxObject($1); }

%typemap(out) wxSizer*                  { $result = wxPyMake_wxSizer($1); }


//%typemap(python, out) wxHtmlCell*               { $target = wxPyMake_wxObject($source); }
//%typemap(python, out) wxHtmlContainerCell*      { $target = wxPyMake_wxObject($source); }
//%typemap(python, out) wxHtmlParser*             { $target = wxPyMake_wxObject($source); }
//%typemap(python, out) wxHtmlWinParser*          { $target = wxPyMake_wxObject($source); }

//---------------------------------------------------------------------------
//---------------------------------------------------------------------------