kicad-source/pcbnew/scripting/pcbnew_footprint_wizards.cpp

/**
 * @file  pcbnew_footprint_wizards.cpp
 * @brief Class PCBNEW_PYTHON_FOOTPRINT_WIZARDS
 */

#include "pcbnew_footprint_wizards.h"
#include <stdio.h>

PYTHON_FOOTPRINT_WIZARD::PYTHON_FOOTPRINT_WIZARD(PyObject *aWizard)
{
    this->m_PyWizard= aWizard;
    Py_XINCREF(aWizard);    
}

PYTHON_FOOTPRINT_WIZARD::~PYTHON_FOOTPRINT_WIZARD()
{
    Py_XDECREF(this->m_PyWizard);
}

PyObject* PYTHON_FOOTPRINT_WIZARD::CallMethod(const char* aMethod, PyObject *aArglist)
{
     PyObject *pFunc;
    
    /* pFunc is a new reference to the desired method */
    pFunc = PyObject_GetAttrString(this->m_PyWizard, aMethod);
    
    if (pFunc && PyCallable_Check(pFunc)) 
    {
        PyObject *result;
        
        result = PyObject_CallObject(pFunc, aArglist);
        
        if (PyErr_Occurred())
        {
            PyObject *t, *v, *b;
            PyErr_Fetch(&t, &v, &b);
            printf ("calling %s()\n",aMethod);
            printf ("Exception: %s\n",PyString_AsString(PyObject_Str(v)));
            printf ("         : %s\n",PyString_AsString(PyObject_Str(b)));
        }
        
        if (result)
        {
                Py_XDECREF(pFunc);
                return result;
        }
        
    }
    else
    {
        printf("method not found, or not callable: %s\n",aMethod);
    }
    
    if (pFunc) Py_XDECREF(pFunc);
    
    return NULL;
}

wxString PYTHON_FOOTPRINT_WIZARD::CallRetStrMethod(const char* aMethod, PyObject *aArglist)
{
    wxString ret;
    
    ret.Clear();
    PyObject *result = CallMethod(aMethod,aArglist);
    if (result)
    {
         const char *str_res = PyString_AsString(result);
         ret  = wxString::FromUTF8(str_res);
         Py_DECREF(result);    
    }
    return ret;
}

wxArrayString PYTHON_FOOTPRINT_WIZARD::CallRetArrayStrMethod
                        (const char *aMethod, PyObject *aArglist)
{
    PyObject *result, *element;
    wxArrayString ret;
    wxString str_item;
    
    result = CallMethod(aMethod,aArglist);
    
    if (result)
    {
         if (!PyList_Check(result))
         {
             Py_DECREF(result);
             ret.Add(wxT("PYTHON_FOOTPRINT_WIZARD::CallRetArrayStrMethod, "
                        "result is not a list"),1);
             return ret;
         }
         int list_size = PyList_Size(result);
         
         for (int n=0;n<list_size;n++)
         {
            element = PyList_GetItem(result,n);

            const char *str_res = PyString_AsString(element);
            str_item  = wxString::FromUTF8(str_res);
            ret.Add(str_item,1);
         }
         
         Py_DECREF(result);    
    }
    
    
    
    return ret;
   
}

wxString PYTHON_FOOTPRINT_WIZARD::GetName()
{
    return CallRetStrMethod("GetName");
}

wxString PYTHON_FOOTPRINT_WIZARD::GetImage()
{
    return CallRetStrMethod("GetImage");
}

wxString PYTHON_FOOTPRINT_WIZARD::GetDescription()
{
    return CallRetStrMethod("GetDescription");
}

int PYTHON_FOOTPRINT_WIZARD::GetNumParameterPages()
{
    int ret;
    PyObject *result;
    
    /* Time to call the callback */
    result = CallMethod("GetNumParameterPages",NULL);
   
    if (result)
    {
         if (!PyInt_Check(result)) return -1;
         ret = PyInt_AsLong(result); 
         Py_DECREF(result);    
    }
    return ret;
}

wxString PYTHON_FOOTPRINT_WIZARD::GetParameterPageName(int aPage)
{
    wxString ret;
    PyObject *arglist;
    PyObject *result;
    
    /* Time to call the callback */
    arglist = Py_BuildValue("(i)", aPage);
    result = CallMethod("GetParameterPageName",arglist);
    Py_DECREF(arglist);
    
    if (result)
    {
         const char *str_res = PyString_AsString(result);
         ret  = wxString::FromUTF8(str_res);
         Py_DECREF(result);    
    }
    return ret;
}

wxArrayString PYTHON_FOOTPRINT_WIZARD::GetParameterNames(int aPage)
{
  
    PyObject *arglist;
    wxArrayString ret;
    
    arglist = Py_BuildValue("(i)", aPage);
    ret = CallRetArrayStrMethod("GetParameterNames",arglist);
    Py_DECREF(arglist);
 
    for (unsigned i=0;i<ret.GetCount();i++)
    {   
        wxString rest;
        wxString item = ret[i];
        if (item.StartsWith(wxT("*"),&rest))
        {
            ret[i]=rest;
        }
    }

    
    return ret;
}

wxArrayString PYTHON_FOOTPRINT_WIZARD::GetParameterTypes(int aPage)
{
  
    PyObject *arglist;
    wxArrayString ret;
    
    arglist = Py_BuildValue("(i)", aPage);
    ret = CallRetArrayStrMethod("GetParameterNames",arglist);
    Py_DECREF(arglist);
 
    for (unsigned i=0;i<ret.GetCount();i++)
    {   
        wxString rest;
        wxString item = ret[i];
        if (item.StartsWith(wxT("*"),&rest))
        {
            ret[i]=wxT("UNITS"); /* units */
        }
        else
        {
            ret[i]=wxT("IU"); /* internal units */
        }
    }

    
    return ret;
}



wxArrayString PYTHON_FOOTPRINT_WIZARD::GetParameterValues(int aPage)
{
    PyObject *arglist;
    wxArrayString ret;
    
    arglist = Py_BuildValue("(i)", aPage);
    ret = CallRetArrayStrMethod("GetParameterValues",arglist);
    Py_DECREF(arglist);
    
    return ret;
}

wxArrayString PYTHON_FOOTPRINT_WIZARD::GetParameterErrors(int aPage)
{
    PyObject *arglist;
    wxArrayString ret;
    
    arglist = Py_BuildValue("(i)", aPage);
    ret = CallRetArrayStrMethod("GetParameterErrors",arglist);
    Py_DECREF(arglist);
    
    return ret;
}

wxString PYTHON_FOOTPRINT_WIZARD::SetParameterValues(int aPage,wxArrayString& aValues)
{
    
    int len = aValues.size();
    PyObject *py_list;
    
    py_list = PyList_New(len);
    
    for (int i=0;i<len;i++)
    {
        wxString str = aValues[i];
        PyObject *py_str = PyString_FromString((const char*)str.mb_str());
        PyList_SetItem(py_list, i, py_str);
    }
    
    PyObject *arglist;
    
    arglist = Py_BuildValue("(i,O)", aPage,py_list);
    wxString res = CallRetStrMethod("SetParameterValues",arglist);
    Py_DECREF(arglist);
    
    
    
    return res;
}

/* this is a SWIG function declaration -from module.i*/
MODULE *PyModule_to_MODULE(PyObject *obj0);

MODULE *PYTHON_FOOTPRINT_WIZARD::GetModule()
{
    PyObject *result, *obj;
    result = CallMethod("GetModule",NULL);
    if (!result) return NULL;
    
   
    obj = PyObject_GetAttrString(result, "this");
       if (PyErr_Occurred())
        {
            /*
            PyObject *t, *v, *b;
            PyErr_Fetch(&t, &v, &b);
            printf ("calling GetModule()\n");
            printf ("Exception: %s\n",PyString_AsString(PyObject_Str(v)));
            printf ("         : %s\n",PyString_AsString(PyObject_Str(b)));
            */
            PyErr_Print();
        }
     
    
    return PyModule_to_MODULE(obj);
}


void PYTHON_FOOTPRINT_WIZARDS::register_wizard(PyObject* aPyWizard)
{
    PYTHON_FOOTPRINT_WIZARD *fw;
    
    fw = new PYTHON_FOOTPRINT_WIZARD(aPyWizard);
    
    printf("Registered python footprint wizard '%s'\n",
            (const char*)fw->GetName().mb_str()
            );
    
    // this get the wizard registered in the common
    // FOOTPRINT_WIZARDS class
    
    fw->register_wizard(); 
                           

#if 0 
    /* just to test if it works correctly */
    int pages = fw->GetNumParameterPages();
    printf("             %d pages\n",pages);
    
    for (int n=0; n<pages; n++)
    {
        printf("                      page %d->'%s'\n",n,
            (const char*)fw->GetParameterPageName(n).mb_str());
    }
#endif    
    
    
}