summaryrefslogtreecommitdiff
path: root/scripting/kicad.i
diff options
context:
space:
mode:
Diffstat (limited to 'scripting/kicad.i')
-rw-r--r--scripting/kicad.i160
1 files changed, 160 insertions, 0 deletions
diff --git a/scripting/kicad.i b/scripting/kicad.i
new file mode 100644
index 0000000..073c112
--- /dev/null
+++ b/scripting/kicad.i
@@ -0,0 +1,160 @@
+/*
+ * This program source code file is part of KiCad, a free EDA CAD application.
+ *
+ * Copyright (C) 2012 NBEE Embedded Systems, 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 kicad.i
+ * @brief General wrappers for kicad / wx structures and classes
+ */
+
+%include <std_vector.i>
+%include <std_basic_string.i>
+%include <std_string.i>
+%include <std_map.i>
+
+/* ignore some constructors of EDA_ITEM that will make the build fail */
+
+%nodefaultctor EDA_ITEM;
+%ignore EDA_ITEM::EDA_ITEM( EDA_ITEM* parent, KICAD_T idType );
+%ignore EDA_ITEM::EDA_ITEM( KICAD_T idType );
+%ignore EDA_ITEM::EDA_ITEM( const EDA_ITEM& base );
+
+/* swig tries to wrap SetBack/SetNext on derived classes, but this method is
+ private for most childs, so if we don't ignore it won't compile */
+
+%ignore EDA_ITEM::SetBack;
+%ignore EDA_ITEM::SetNext;
+
+/* ignore other functions that cause trouble */
+
+%ignore InitKiCadAbout;
+%ignore GetCommandOptions;
+
+%rename(getWxRect) operator wxRect;
+%ignore operator <<;
+%ignore operator=;
+
+
+/* headers/imports that must be included in the _wrapper.cpp at top */
+
+%{
+ #include <cstddef>
+ #include <dlist.h>
+ #include <base_struct.h>
+ #include <class_eda_rect.h>
+ #include <common.h>
+ #include <wx_python_helpers.h>
+ #include <cstddef>
+ #include <vector>
+ #include <bitset>
+
+ #include <class_title_block.h>
+ #include <class_colors_design_settings.h>
+ #include <class_marker_base.h>
+ #include <eda_text.h>
+ #include <convert_from_iu.h>
+ #include <convert_to_biu.h>
+%}
+
+/* all the wx wrappers for wxString, wxPoint, wxRect, wxChar .. */
+%include <wx.i>
+
+/* exception handling */
+
+/* the IO_ERROR exception handler, not working yet... */
+/*
+%exception
+{
+ try {
+ $function
+ }
+ catch (IO_ERROR e) {
+ PyErr_SetString(PyExc_IOError,"IO error");
+ return NULL;
+ }
+}
+*/
+
+/* header files that must be wrapped */
+
+%include <dlist.h>
+%include <base_struct.h>
+%include <class_eda_rect.h>
+%include <common.h>
+%include <class_title_block.h>
+%include <class_colors_design_settings.h>
+%include <class_marker_base.h>
+%include <eda_text.h>
+%include <convert_from_iu.h>
+%include <convert_to_biu.h>
+%include <fpid.h>
+
+/* special iteration wrapper for DLIST objects */
+%include "dlist.i"
+
+/* std template mappings */
+%template(intVector) std::vector<int>;
+%template(str_utf8_Map) std::map< std::string,UTF8 >;
+
+// wrapper of BASE_SEQ (see typedef std::vector<LAYER_ID> BASE_SEQ;)
+%template(base_seqVect) std::vector<enum LAYER_ID>;
+
+// TODO: wrapper of BASE_SET (see std::bitset<LAYER_ID_COUNT> BASE_SET;)
+
+
+/* KiCad plugin handling */
+%include "kicadplugins.i"
+
+// map CPolyLine and classes used in CPolyLine:
+#include <../polygon/PolyLine.h>
+%include <../polygon/PolyLine.h>
+
+// ignore warning relative to operator = and operator ++:
+#pragma SWIG nowarn=362,383
+
+// Rename operators defined in utf8.h
+%rename(utf8_to_charptr) operator char* () const;
+%rename(utf8_to_wxstring) operator wxString () const;
+
+#include <utf8.h>
+%include <utf8.h>
+
+%extend UTF8
+{
+ const char* Cast_to_CChar() { return (self->c_str()); }
+
+ %pythoncode
+ %{
+
+ # Get the char buffer of the UTF8 string
+ def GetChars(self):
+ return self.Cast_to_CChar()
+
+ # Convert the UTF8 string to a python string
+ # Same as GetChars(), but more easy to use in print command
+ def __str__(self):
+ return self.GetChars()
+
+ %}
+}
+