kicad/common/swig/wx_python_helpers.cpp

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2012 Miguel Angel Ajo <miguelangel@nbee.es>
 * Copyright (C) 1992-2012 KiCad Developers, see AUTHORS.txt for contributors.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, you may find one here:
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 * or you may search the http://www.gnu.org website for the version 2 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
 */

/**
 * @file wx_python_helpers.cpp
 * @brief Python wrapping helpers for wx structures/objects
 */

#include <Python.h>
#include <wx/intl.h>
#include <wx/string.h>
#include <wx/arrstr.h>


#define WX_DEFAULTENCODING_SIZE 64

static char wxPythonEncoding[WX_DEFAULTENCODING_SIZE] = "ascii";


PyObject* wxArrayString2PyList( const wxArrayString& lst )
{
    PyObject* list = PyList_New( 0 );

    for( size_t i = 0; i < lst.GetCount(); i++ )
    {
#if wxUSE_UNICODE
        PyObject* pyStr = PyUnicode_FromWideChar( lst[i].c_str(),
                                                  lst[i].Len()
                                                  );
#else
        PyObject* pyStr = PyString_FromStringAndSize( lst[i].c_str(),
                                                      lst[i].Len()
                                                      );
#endif
        PyList_Append( list, pyStr );
        Py_DECREF( pyStr );
    }

    return list;
}


wxString* newWxStringFromPy( PyObject* src )
{
    bool        must_unref_str = false;

    wxString*   result  = NULL;
    PyObject*   obj     = src;

#if wxUSE_UNICODE
    bool        must_unref_obj = false;
    // Unicode string to python unicode string
    PyObject*   uni_str = src;

    // if not an str or unicode, try to str(src)
#if PY_MAJOR_VERSION >= 3
    if( !PyBytes_Check( src ) && !PyUnicode_Check( src ) )
#else
    if( !PyString_Check( src ) && !PyUnicode_Check( src ) )
#endif
    {
        obj = PyObject_Str( src );

#if PY_MAJOR_VERSION >= 3
        uni_str = obj; // in case of Python 3 our string is already correctly encoded
#endif

        must_unref_obj = true;

        if( PyErr_Occurred() )
            return NULL;
    }

#if PY_MAJOR_VERSION >= 3
    if( PyBytes_Check( obj ) )
#else
    if( PyString_Check( obj ) )
#endif
    {
        uni_str = PyUnicode_FromEncodedObject( obj, wxPythonEncoding, "strict" );
        must_unref_str = true;

        if( PyErr_Occurred() )
            return NULL;
    }

    result = new wxString();
#if PY_MAJOR_VERSION >= 3
    size_t len = PyUnicode_GET_LENGTH( uni_str );
#else
    size_t len = PyUnicode_GET_SIZE( uni_str );
#endif

    if( len )
    {
#if PY_MAJOR_VERSION >= 3
        PyUnicode_AsWideChar( uni_str,
                              wxStringBuffer( *result, len ), len );
#else
        PyUnicode_AsWideChar( (PyUnicodeObject*) uni_str,
                              wxStringBuffer( *result, len ), len );
#endif
    }

    if( must_unref_str )
    {
        Py_DECREF( uni_str );
    }

    if( must_unref_obj )
    {
        Py_DECREF( obj );
    }

#else
    // normal string (or object) to normal python string
    PyObject* str = src;

    if( PyUnicode_Check( src ) )    // if it's unicode convert to normal string
    {
        str = PyUnicode_AsEncodedString( src, wxPythonEncoding, "strict" );

        if( PyErr_Occurred() )
            return NULL;
    }
#if PY_MAJOR_VERSION >= 3
    else if( !PyUnicode_Check( src ) )
#else
    else if( !PyString_Check( src ) )    // if it's not a string, str(obj)
#endif
    {
        str = PyObject_Str( src );
        must_unref_str = true;

        if( PyErr_Occurred() )
            return NULL;
    }

    // get the string pointer and size
    char*       str_ptr;
    Py_ssize_t  str_size;
    PyString_AsStringAndSize( str, &str_ptr, &str_size );

    // build the wxString from our pointer / size
    result = new wxString( str_ptr, str_size );

    if( must_unref_str )
    {
        Py_DECREF( str );
    }

#endif

    return result;
}


wxString Py2wxString( PyObject* src )
{
    wxString    result;
    wxString*   resPtr = newWxStringFromPy( src );

    // In case of exception clear it and return an empty string
    if( resPtr==NULL )
    {
        PyErr_Clear();
        return wxEmptyString;
    }

    result = *resPtr;

    delete resPtr;

    return result;
}


PyObject* wx2PyString( const wxString& src )
{
    PyObject* str;

#if wxUSE_UNICODE
    str = PyUnicode_FromWideChar( src.c_str(), src.Len() );
#else
    str = PyString_FromStringAndSize( src.c_str(), src.Len() );
#endif
    return str;
}


void wxSetDefaultPyEncoding( const char* encoding )
{
    strncpy( wxPythonEncoding, encoding, WX_DEFAULTENCODING_SIZE );
    wxPythonEncoding[ WX_DEFAULTENCODING_SIZE - 1 ] = '\0';
}


const char* wxGetDefaultPyEncoding()
{
    return wxPythonEncoding;
}