KiCad PCB EDA Suite
pcbnew/kicad_plugin.h
Go to the documentation of this file.
1 /*
2  * This program source code file is part of KiCad, a free EDA CAD application.
3  *
4  * Copyright (C) 2012 CERN.
5  * Copyright (C) 1992-2017 KiCad Developers, see AUTHORS.txt for contributors.
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * as published by the Free Software Foundation; either version 2
10  * of the License, or (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, you may find one here:
19  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20  * or you may search the http://www.gnu.org website for the version 2 license,
21  * or you may write to the Free Software Foundation, Inc.,
22  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23  */
24 
25 #ifndef KICAD_PLUGIN_H_
26 #define KICAD_PLUGIN_H_
27 
28 #include <io_mgr.h>
29 #include <string>
31 
32 class BOARD;
33 class BOARD_ITEM;
34 class FP_CACHE;
35 class PCB_PARSER;
36 class NETINFO_MAPPING;
37 
38 
40 
41 //#define SEXPR_BOARD_FILE_VERSION 3 // first s-expression format, used legacy cu stack
42 //#define SEXPR_BOARD_FILE_VERSION 4 // reversed cu stack, changed Inner* to In* in reverse order
43 // // went to 32 Cu layers from 16.
44 //#define SEXPR_BOARD_FILE_VERSION 20160815 // differential pair settings per net class
45 #define SEXPR_BOARD_FILE_VERSION 20170123 // EDA_TEXT refactor, moved 'hide'
46 
47 #define CTL_STD_LAYER_NAMES (1 << 0)
48 #define CTL_OMIT_NETS (1 << 1)
49 #define CTL_OMIT_TSTAMPS (1 << 2)
50 #define CTL_OMIT_INITIAL_COMMENTS (1 << 3)
51 #define CTL_OMIT_PATH (1 << 4)
52 #define CTL_OMIT_AT (1 << 5)
53  // (always saved with potion 0,0 and rotation = 0 in library)
54 //#define CTL_OMIT_HIDE (1 << 6) // found and defined in eda_text.h
55 
56 
57 // common combinations of the above:
58 
60 #define CTL_FOR_CLIPBOARD (CTL_STD_LAYER_NAMES|CTL_OMIT_NETS)
61 
63 #define CTL_FOR_LIBRARY (CTL_STD_LAYER_NAMES|CTL_OMIT_NETS|CTL_OMIT_TSTAMPS|CTL_OMIT_PATH|CTL_OMIT_AT)
64 
67 #define CTL_FOR_BOARD (CTL_OMIT_INITIAL_COMMENTS)
68 
69 
70 class DIMENSION;
71 class EDGE_MODULE;
72 class DRAWSEGMENT;
73 class PCB_TARGET;
74 class D_PAD;
75 class TEXTE_MODULE;
76 class TRACK;
77 class ZONE_CONTAINER;
78 class TEXTE_PCB;
79 
80 
81 
88 class PCB_IO : public PLUGIN
89 {
90  friend class FP_CACHE;
91 
92 public:
93 
94  //-----<PLUGIN API>---------------------------------------------------------
95 
96  const wxString PluginName() const override
97  {
98  return wxT( "KiCad" );
99  }
100 
101  const wxString GetFileExtension() const override
102  {
103  // Would have used wildcards_and_files_ext.cpp's KiCadPcbFileExtension,
104  // but to be pure, a plugin should not assume that it will always be linked
105  // with the core of the pcbnew code. (Might someday be a DLL/DSO.) Besides,
106  // file extension policy should be controlled by the plugin.
107  return wxT( "kicad_pcb" );
108  }
109 
110  void Save( const wxString& aFileName, BOARD* aBoard,
111  const PROPERTIES* aProperties = NULL ) override;
112 
113  BOARD* Load( const wxString& aFileName, BOARD* aAppendToMe, const PROPERTIES* aProperties = NULL ) override;
114 
115  wxArrayString FootprintEnumerate( const wxString& aLibraryPath,
116  const PROPERTIES* aProperties = NULL ) override;
117 
118  MODULE* FootprintLoad( const wxString& aLibraryPath, const wxString& aFootprintName,
119  const PROPERTIES* aProperties = NULL ) override;
120 
121  void FootprintSave( const wxString& aLibraryPath, const MODULE* aFootprint,
122  const PROPERTIES* aProperties = NULL ) override;
123 
124  void FootprintDelete( const wxString& aLibraryPath, const wxString& aFootprintName, const PROPERTIES* aProperties = NULL ) override;
125 
126  void FootprintLibCreate( const wxString& aLibraryPath, const PROPERTIES* aProperties = NULL) override;
127 
128  bool FootprintLibDelete( const wxString& aLibraryPath, const PROPERTIES* aProperties = NULL ) override;
129 
130  bool IsFootprintLibWritable( const wxString& aLibraryPath ) override;
131 
132  //-----</PLUGIN API>--------------------------------------------------------
133 
134  PCB_IO( int aControlFlags = CTL_FOR_BOARD );
135 
136  ~PCB_IO();
137 
146  void Format( BOARD_ITEM* aItem, int aNestLevel = 0 ) const
147  throw( IO_ERROR );
148 
149  std::string GetStringOutput( bool doClear )
150  {
151  std::string ret = m_sf.GetString();
152  if( doClear )
153  m_sf.Clear();
154 
155  return ret;
156  }
157 
158  void SetOutputFormatter( OUTPUTFORMATTER* aFormatter ) { m_out = aFormatter; }
159 
160  BOARD_ITEM* Parse( const wxString& aClipboardSourceInput )
162 
163 protected:
164 
165  wxString m_error;
167 
168  const
171 
173  wxString m_filename;
174 
176 
179  int m_ctl;
182 
185  void cacheLib( const wxString& aLibraryPath, const wxString& aFootprintName = wxEmptyString );
186 
187  void init( const PROPERTIES* aProperties );
188 
189 private:
190  void format( BOARD* aBoard, int aNestLevel = 0 ) const
191  throw( IO_ERROR );
192 
193  void format( DIMENSION* aDimension, int aNestLevel = 0 ) const
194  throw( IO_ERROR );
195 
196  void format( EDGE_MODULE* aModuleDrawing, int aNestLevel = 0 ) const
197  throw( IO_ERROR );
198 
199  void format( DRAWSEGMENT* aSegment, int aNestLevel = 0 ) const
200  throw( IO_ERROR );
201 
202  void format( PCB_TARGET* aTarget, int aNestLevel = 0 ) const
203  throw( IO_ERROR );
204 
205  void format( MODULE* aModule, int aNestLevel = 0 ) const
206  throw( IO_ERROR );
207 
208  void format( D_PAD* aPad, int aNestLevel = 0 ) const
209  throw( IO_ERROR );
210 
211  void format( TEXTE_PCB* aText, int aNestLevel = 0 ) const
212  throw( IO_ERROR );
213 
214  void format( TEXTE_MODULE* aText, int aNestLevel = 0 ) const
215  throw( IO_ERROR );
216 
217  void format( TRACK* aTrack, int aNestLevel = 0 ) const
218  throw( IO_ERROR );
219 
220  void format( ZONE_CONTAINER* aZone, int aNestLevel = 0 ) const
221  throw( IO_ERROR );
222 
223  void formatLayer( const BOARD_ITEM* aItem ) const;
224 
225  void formatLayers( LSET aLayerMask, int aNestLevel = 0 ) const
226  throw( IO_ERROR );
227 };
228 
229 #endif // KICAD_PLUGIN_H_
Class ZONE_CONTAINER handles a list of polygons defining a copper zone.
Definition: class_zone.h:78
OUTPUTFORMATTER * m_out
output any Format()s to this, no ownership
Class LINE_READER is an abstract class from which implementation specific LINE_READERs may be derived...
Definition: richio.h:81
LINE_READER * m_reader
no ownership here.
BOARD_ITEM * Parse(const wxString &aClipboardSourceInput)
Class PCB_IO is a PLUGIN derivation for saving and loading Pcbnew s-expression formatted files...
BOARD * Load(const wxString &aFileName, BOARD *aAppendToMe, const PROPERTIES *aProperties=NULL) override
Function Load loads information from some input file format that this PLUGIN implementation knows abo...
Class BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class...
FP_CACHE * m_cache
Footprint library cache.
Class PCB_PARSER reads a Pcbnew s-expression formatted LINE_READER object and returns the appropriate...
Definition: pcb_parser.h:66
const PROPERTIES * m_props
passed via Save() or Load(), no ownership, may be NULL.
void init(const PROPERTIES *aProperties)
void formatLayer(const BOARD_ITEM *aItem) const
Class OUTPUTFORMATTER is an important interface (abstract class) used to output 8 bit text in a conve...
Definition: richio.h:327
bool IsFootprintLibWritable(const wxString &aLibraryPath) override
Function IsFootprintLibWritable returns true iff the library at aLibraryPath is writable.
wxString m_error
for throwing exceptions
Class PROPERTIES is a name/value tuple with unique names and optional values.
Definition: properties.h:34
const wxString GetFileExtension() const override
Function GetFileExtension returns the file extension for the PLUGIN.
void SetOutputFormatter(OUTPUTFORMATTER *aFormatter)
PCB_IO(int aControlFlags=CTL_FOR_BOARD)
void FootprintLibCreate(const wxString &aLibraryPath, const PROPERTIES *aProperties=NULL) override
Function FootprintLibCreate creates a new empty footprint library at aLibraryPath empty...
Class LSET is a set of LAYER_IDs.
void FootprintSave(const wxString &aLibraryPath, const MODULE *aFootprint, const PROPERTIES *aProperties=NULL) override
Function FootprintSave will write aModule to an existing library located at aLibraryPath.
std::string GetStringOutput(bool doClear)
MODULE * FootprintLoad(const wxString &aLibraryPath, const wxString &aFootprintName, const PROPERTIES *aProperties=NULL) override
Function FootprintLoad loads a footprint having aFootprintName from the aLibraryPath containing a lib...
int m_loading_format_version
which SEXPR_BOARD_FILE_VERSION should be Load()ed?
const std::string & GetString()
Definition: richio.h:475
PCB_PARSER * m_parser
void Format(BOARD_ITEM *aItem, int aNestLevel=0) const
Function Format outputs aItem to aFormatter in s-expression format.
NETINFO_MAPPING * m_mapping
mapping for net codes, so only not empty net codes are stored with consecutive integers as net codes ...
void FootprintDelete(const wxString &aLibraryPath, const wxString &aFootprintName, const PROPERTIES *aProperties=NULL) override
Function FootprintDelete deletes aFootprintName from the library at aLibraryPath. ...
#define CTL_FOR_BOARD
The zero arg constructor when PCB_IO is used for PLUGIN::Load() and PLUGIN::Save()ing a BOARD file un...
Struct PARSE_ERROR contains a filename or source description, a problem input line, a line number, a byte offset, and an error message which contains the the caller's report and his call site information: CPP source file, function, and line number.
Definition: ki_exception.h:94
STRING_FORMATTER m_sf
Board layer functions and definitions.
Class BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:166
wxArrayString FootprintEnumerate(const wxString &aLibraryPath, const PROPERTIES *aProperties=NULL) override
Function FootprintEnumerate returns a list of footprint names contained within the library at aLibrar...
Class PLUGIN is a base class that BOARD loading and saving plugins should derive from.
Definition: io_mgr.h:193
void format(BOARD *aBoard, int aNestLevel=0) const
BOARD * m_board
which BOARD, no ownership here
const wxString PluginName() const override
Function PluginName returns a brief hard coded name for this PLUGIN.
void formatLayers(LSET aLayerMask, int aNestLevel=0) const
Struct FUTURE_FORMAT_ERROR variant of PARSE_ERROR indicating that a syntax or related error was likel...
Definition: ki_exception.h:143
bool FootprintLibDelete(const wxString &aLibraryPath, const PROPERTIES *aProperties=NULL) override
Function FootprintLibDelete deletes an existing footprint library and returns true, or if library does not exist returns false, or throws an exception if library exists but is read only or cannot be deleted for some other reason.
Class STRING_FORMATTER implements OUTPUTFORMATTER to a memory buffer.
Definition: richio.h:445
Struct IO_ERROR is a class used to hold an error message and may be used when throwing exceptions con...
Definition: ki_exception.h:47
wxString m_filename
for saves only, name is in m_reader for loads
void cacheLib(const wxString &aLibraryPath, const wxString &aFootprintName=wxEmptyString)
we only cache one footprint library, this determines which one.
Class DIMENSION.
void Save(const wxString &aFileName, BOARD *aBoard, const PROPERTIES *aProperties=NULL) override
Function Save will write aBoard to a storage file in a format that this PLUGIN implementation knows a...
void Clear()
Function Clear clears the buffer and empties the internal string.
Definition: richio.h:464