/* * This program source code file is part of KiCad, a free EDA CAD application. * * Copyright (C) 2012 NBEE Embedded Systems, Miguel Angel Ajo * Copyright (C) 1992-2023 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 %include %include %include %include %include %include %include %include %include "ki_exception.i" // affects all that follow it /* http://www.swig.org/Doc3.0/CPlusPlus11.html 7.3.3 Hash tables The new hash tables in the STL are unordered_set, unordered_multiset, unordered_map, unordered_multimap. These are not available in SWIG, but in principle should be easily implemented by adapting the current STL containers. %include */ // 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 ); %warnfilter(401) EDA_ITEM; %warnfilter(509) UTF8; /* swig tries to wrap SetBack/SetNext on derived classes, but this method is private for most children, 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; %rename(getBOX2I) operator BOX2I; %ignore operator <<; %ignore operator=; %ignore to_json; %ignore from_json; // headers/imports that must be included in the _wrapper.cpp at top %{ #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include %} // all the wx wrappers for wxString, wxPoint, wxRect, wxChar .. %include wx.i // SWIG is incompatible with std::unique_ptr %ignore GetNewConfig; // wrapper of BASE_SEQ (see typedef std::vector BASE_SEQ;) %template(base_seqVect) std::vector; // TODO: wrapper of BASE_SET (see std::bitset BASE_SET;) #define KICOMMON_API #define GAL_API // header files that must be wrapped %include %include macros_swig.h %include kiid.h %include core/typeinfo.h %include eda_item.h %include base_units.h %include eda_units.h %include common.h %include richio.h %include title_block.h %include gal/color4d.h %include marker_base.h %include eda_text.h %include build_version.h %include layer_ids.h %include settings/settings_manager.h %include pcbnew_utils_3d.h // Cast time_t to known type for Python typedef long time_t; // std template mappings %template(intVector) std::vector; %template(str_utf8_Map) std::map< std::string,UTF8 >; // KiCad plugin handling %include "kicadplugins.i" // Contains VECTOR2I %include math.i %template(VECTOR_VECTOR2I) std::vector; // Shapes/geometry %include shape.i // 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; %rename(utf8_to_string) operator const std::string& () const; #include %include %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() %} }