KiCad PCB EDA Suite
Loading...
Searching...
No Matches
pcb_io_mgr.cpp
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) 2011-2012 SoftPLC Corporation, Dick Hollenbeck <[email protected]>
5 * Copyright The 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#include <wx/filename.h>
26#include <wx/uri.h>
27
28#include <config.h>
29#include <kiway_player.h>
31#include <pcb_io/pcb_io_mgr.h>
32
48#include <reporter.h>
49
50
51
52#define FMT_UNIMPLEMENTED _( "Plugin '%s' does not implement the '%s' function." )
53#define FMT_NOTFOUND _( "Plugin type '%s' is not found." )
54
55
56// Some day plugins might be in separate DLL/DSOs, simply because of numbers of them
57// and code size. Until then, use the simplest method:
58
59// This implementation is one of two which could be done.
60// The other one would cater to DLL/DSO's. But since it would be nearly
61// impossible to link a KICAD type DLL/DSO right now without pulling in all
62// ::Draw() functions, I forgo that option temporarily.
63
64// Some day it may be possible to have some built in AND some DLL/DSO
65// plugins coexisting.
66
67
69{
70 // This implementation is subject to change, any magic is allowed here.
71 // The public IO_MGR API is the only pertinent public information.
72
73 return PLUGIN_REGISTRY::Instance()->Create( aFileType );
74}
75
76
77const wxString PCB_IO_MGR::ShowType( PCB_FILE_T aType )
78{
79 const auto& plugins = PLUGIN_REGISTRY::Instance()->AllPlugins();
80
81 for( const auto& plugin : plugins )
82 {
83 if ( plugin.m_type == aType )
84 {
85 return plugin.m_name;
86 }
87 }
88
89 return wxString::Format( _( "UNKNOWN (%d)" ), aType );
90}
91
92
94{
95 const auto& plugins = PLUGIN_REGISTRY::Instance()->AllPlugins();
96
97 for( const auto& plugin : plugins )
98 {
99 if ( plugin.m_name == aType )
100 {
101 return plugin.m_type;
102 }
103 }
104
105 return PCB_FILE_T( -1 );
106}
107
108
109// The KIWAY_PLAYER::OpenProjectFiles() API knows nothing about plugins, so
110// determine how to load the BOARD here
112{
113 const auto& plugins = PCB_IO_MGR::PLUGIN_REGISTRY::Instance()->AllPlugins();
114
115 for( const auto& plugin : plugins )
116 {
117 bool isKiCad = plugin.m_type == PCB_IO_MGR::KICAD_SEXP || plugin.m_type == PCB_IO_MGR::LEGACY;
118
119 if( ( aCtl & KICTL_KICAD_ONLY ) && !isKiCad )
120 continue;
121
122 if( ( aCtl & KICTL_NONKICAD_ONLY ) && isKiCad )
123 continue;
124
125 IO_RELEASER<PCB_IO> pi( plugin.m_createFunc() );
126
127 if( pi->CanReadBoard( aFileName ) )
128 return plugin.m_type;
129 }
130
132}
133
134
136{
137 const auto& plugins = PCB_IO_MGR::PLUGIN_REGISTRY::Instance()->AllPlugins();
138
139 for( const auto& plugin : plugins )
140 {
141 bool isKiCad = plugin.m_type == PCB_IO_MGR::KICAD_SEXP || plugin.m_type == PCB_IO_MGR::LEGACY;
142
143 if( ( aCtl & KICTL_KICAD_ONLY ) && !isKiCad )
144 continue;
145
146 if( ( aCtl & KICTL_NONKICAD_ONLY ) && isKiCad )
147 continue;
148
149 IO_RELEASER<PCB_IO> pi( plugin.m_createFunc() );
150
151 if( pi->CanReadLibrary( aLibPath ) )
152 return plugin.m_type;
153 }
154
156}
157
158
159BOARD* PCB_IO_MGR::Load( PCB_FILE_T aFileType, const wxString& aFileName, BOARD* aAppendToMe,
160 const std::map<std::string, UTF8>* aProperties, PROJECT* aProject,
161 PROGRESS_REPORTER* aProgressReporter )
162{
163 IO_RELEASER<PCB_IO> pi( PluginFind( aFileType ) );
164
165 if( pi ) // test pi->plugin
166 {
167 pi->SetProgressReporter( aProgressReporter );
168 return pi->LoadBoard( aFileName, aAppendToMe, aProperties, aProject );
169 }
170
171 THROW_IO_ERROR( wxString::Format( FMT_NOTFOUND, ShowType( aFileType ).GetData() ) );
172}
173
174
175void PCB_IO_MGR::Save( PCB_FILE_T aFileType, const wxString& aFileName, BOARD* aBoard,
176 const std::map<std::string, UTF8>* aProperties )
177{
178 IO_RELEASER<PCB_IO> pi( PluginFind( aFileType ) );
179
180 if( pi )
181 {
182 pi->SaveBoard( aFileName, aBoard, aProperties ); // virtual
183 return;
184 }
185
186 THROW_IO_ERROR( wxString::Format( FMT_NOTFOUND, ShowType( aFileType ).GetData() ) );
187}
188
189
190bool PCB_IO_MGR::ConvertLibrary( std::map<std::string, UTF8>* aOldFileProps, const wxString& aOldFilePath,
191 const wxString& aNewFilePath, REPORTER* aReporter )
192{
194
195 if( oldFileType == PCB_IO_MGR::FILE_TYPE_NONE )
196 return false;
197
198 IO_RELEASER<PCB_IO> oldFilePI( PCB_IO_MGR::PluginFind( oldFileType ) );
200 wxArrayString fpNames;
201 wxFileName newFileName( aNewFilePath );
202
203 if( newFileName.HasExt() )
204 {
205 wxString extraDir = newFileName.GetFullName();
206 newFileName.ClearExt();
207 newFileName.SetName( "" );
208 newFileName.AppendDir( extraDir );
209 }
210
211 if( !newFileName.DirExists() && !wxFileName::Mkdir( aNewFilePath, wxS_DIR_DEFAULT ) )
212 return false;
213
214 try
215 {
216 bool bestEfforts = false; // throw on first error
217 oldFilePI->FootprintEnumerate( fpNames, aOldFilePath, bestEfforts, aOldFileProps );
218 std::map<std::string, UTF8> props { { "skip_cache_validation", "" } };
219
220 for ( const wxString& fpName : fpNames )
221 {
222 std::unique_ptr<const FOOTPRINT> fp( oldFilePI->GetEnumeratedFootprint( aOldFilePath, fpName,
223 aOldFileProps ) );
224
225 try
226 {
227 kicadPI->FootprintSave( aNewFilePath, fp.get(), &props );
228 }
229 catch( ... )
230 {
231 // Footprints that cannot be saved are just skipped. This is not see
232 // as a fatal error.
233 // this can be just a illegal filename used for the footprint
234 if( aReporter )
235 aReporter->Report( wxString::Format( "Footprint \"%s\" can't be saved. Skipped",
236 fpName ),
237 SEVERITY::RPT_SEVERITY_WARNING );
238 }
239 }
240 }
241 catch( IO_ERROR& io_err )
242 {
243 if( aReporter )
244 aReporter->Report( wxString::Format( "Library '%s' Convert err: \"%s\"",
245 aOldFilePath, io_err.What() ),
246 SEVERITY::RPT_SEVERITY_ERROR );
247 return false;
248 }
249 catch( ... )
250 {
251 return false;
252 }
253
254 return true;
255}
256
257
258// These text strings are "truth" for identifying the plugins. If you change the spellings,
259// you will obsolete library tables, so don't do it. Additions are OK.
260
261// clang-format off
264 wxT( "KiCad" ),
265 []() -> PCB_IO* { return new PCB_IO_KICAD_SEXPR; } );
266
269 wxT( "Legacy" ),
270 []() -> PCB_IO* { return new PCB_IO_KICAD_LEGACY; } );
271
272// Keep non-KiCad plugins in alphabetical order
273
276 wxT( "Altium Circuit Maker" ),
277 []() -> PCB_IO* { return new PCB_IO_ALTIUM_CIRCUIT_MAKER; } );
278
281 wxT( "Altium Circuit Studio" ),
282 []() -> PCB_IO* { return new PCB_IO_ALTIUM_CIRCUIT_STUDIO; } );
283
286 wxT( "Altium Designer" ),
287 []() -> PCB_IO* { return new PCB_IO_ALTIUM_DESIGNER; } );
288
291 wxT( "CADSTAR PCB Archive" ),
292 []() -> PCB_IO* { return new PCB_IO_CADSTAR_ARCHIVE; } );
293
296 wxT( "Eagle" ),
297 []() -> PCB_IO* { return new PCB_IO_EAGLE; } );
298
301 wxT( "EasyEDA / JLCEDA Std" ),
302 []() -> PCB_IO* { return new PCB_IO_EASYEDA; });
303
306 wxT( "EasyEDA / JLCEDA Pro" ),
307 []() -> PCB_IO* { return new PCB_IO_EASYEDAPRO; });
308
311 wxT( "Fabmaster" ),
312 []() -> PCB_IO* { return new PCB_IO_FABMASTER; } );
313
316 wxT( "GEDA/Pcb" ),
317 []() -> PCB_IO* { return new PCB_IO_GEDA; } );
318
321 wxT( "P-Cad" ),
322 []() -> PCB_IO* { return new PCB_IO_PCAD; } );
323
326 wxT( "Solidworks PCB" ),
327 []() -> PCB_IO* { return new PCB_IO_SOLIDWORKS; } );
328
331 wxT( "IPC-2581" ),
332 []() -> PCB_IO* { return new PCB_IO_IPC2581; } );
333
336 wxT( "ODB++" ),
337 []() -> PCB_IO* { return new PCB_IO_ODBPP; } );
338// clang-format on
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:317
Hold an error message and may be used when throwing exceptions containing meaningful error messages.
Definition: ki_exception.h:77
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:30
Works with Eagle 6.x XML board files and footprints to implement the Pcbnew #PLUGIN API or a portion ...
Definition: pcb_io_eagle.h:133
A #PLUGIN derivation for saving and loading Geda PCB files.
Definition: pcb_io_geda.h:48
A #PLUGIN derivation which could possibly be put into a DLL/DSO.
A #PLUGIN derivation for saving and loading Pcbnew s-expression formatted files.
PCB_IO * Create(PCB_FILE_T aFileType) const
Definition: pcb_io_mgr.h:115
const std::vector< ENTRY > & AllPlugins() const
Definition: pcb_io_mgr.h:128
static PLUGIN_REGISTRY * Instance()
Definition: pcb_io_mgr.h:94
static PCB_IO * PluginFind(PCB_FILE_T aFileType)
Return a #PLUGIN which the caller can use to import, export, save, or load design documents.
Definition: pcb_io_mgr.cpp:68
static BOARD * Load(PCB_FILE_T aFileType, const wxString &aFileName, BOARD *aAppendToMe=nullptr, const std::map< std::string, UTF8 > *aProperties=nullptr, PROJECT *aProject=nullptr, PROGRESS_REPORTER *aProgressReporter=nullptr)
Find the requested #PLUGIN and if found, calls the #PLUGIN::LoadBoard() function on it using the argu...
Definition: pcb_io_mgr.cpp:159
static PCB_FILE_T EnumFromStr(const wxString &aFileType)
Return the PCB_FILE_T from the corresponding plugin type name: "kicad", "legacy", etc.
Definition: pcb_io_mgr.cpp:93
PCB_FILE_T
The set of file types that the PCB_IO_MGR knows about, and for which there has been a plugin written,...
Definition: pcb_io_mgr.h:56
@ FILE_TYPE_NONE
Definition: pcb_io_mgr.h:77
@ KICAD_SEXP
S-expression Pcbnew file format.
Definition: pcb_io_mgr.h:58
@ GEDA_PCB
Geda PCB file formats.
Definition: pcb_io_mgr.h:68
@ ALTIUM_DESIGNER
Definition: pcb_io_mgr.h:62
@ LEGACY
Legacy Pcbnew file formats prior to s-expression.
Definition: pcb_io_mgr.h:59
@ SOLIDWORKS_PCB
Definition: pcb_io_mgr.h:70
@ ALTIUM_CIRCUIT_MAKER
Definition: pcb_io_mgr.h:60
@ ALTIUM_CIRCUIT_STUDIO
Definition: pcb_io_mgr.h:61
@ CADSTAR_PCB_ARCHIVE
Definition: pcb_io_mgr.h:63
static bool ConvertLibrary(std::map< std::string, UTF8 > *aOldFileProps, const wxString &aOldFilePath, const wxString &aNewFilePath, REPORTER *aReporter)
Convert a schematic symbol library to the latest KiCad format.
Definition: pcb_io_mgr.cpp:190
static PCB_FILE_T FindPluginTypeFromBoardPath(const wxString &aFileName, int aCtl=0)
Return a plugin type given a path for a board file.
Definition: pcb_io_mgr.cpp:111
static void Save(PCB_FILE_T aFileType, const wxString &aFileName, BOARD *aBoard, const std::map< std::string, UTF8 > *aProperties=nullptr)
Write either a full aBoard to a storage file in a format that this implementation knows about,...
Definition: pcb_io_mgr.cpp:175
static PCB_FILE_T GuessPluginTypeFromLibPath(const wxString &aLibPath, int aCtl=0)
Return a plugin type given a footprint library's libPath.
Definition: pcb_io_mgr.cpp:135
static const wxString ShowType(PCB_FILE_T aFileType)
Return a brief name for a plugin given aFileType enum.
Definition: pcb_io_mgr.cpp:77
A base class that BOARD loading and saving plugins should derive from.
Definition: pcb_io.h:71
A progress reporter interface for use in multi-threaded environments.
Container for project specific data.
Definition: project.h:65
A pure virtual class used to derive REPORTER objects from.
Definition: reporter.h:73
virtual REPORTER & Report(const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED)
Report a string with a given severity.
Definition: reporter.h:102
#define _(s)
std::unique_ptr< T > IO_RELEASER
Helper to hold and release an IO_BASE object when exceptions are thrown.
Definition: io_mgr.h:33
#define THROW_IO_ERROR(msg)
Definition: ki_exception.h:39
#define KICTL_KICAD_ONLY
chosen file is from KiCad according to user
Definition: kiway_player.h:75
#define KICTL_NONKICAD_ONLY
chosen file is non-KiCad according to user
Definition: kiway_player.h:74
static PCB_IO_MGR::REGISTER_PLUGIN registerODBPPPlugin(PCB_IO_MGR::ODBPP, wxT("ODB++"), []() -> PCB_IO *{ return new PCB_IO_ODBPP;})
static PCB_IO_MGR::REGISTER_PLUGIN registerSolidworksPCBPlugin(PCB_IO_MGR::SOLIDWORKS_PCB, wxT("Solidworks PCB"), []() -> PCB_IO *{ return new PCB_IO_SOLIDWORKS;})
static PCB_IO_MGR::REGISTER_PLUGIN registerEasyEDAProPlugin(PCB_IO_MGR::EASYEDAPRO, wxT("EasyEDA / JLCEDA Pro"), []() -> PCB_IO *{ return new PCB_IO_EASYEDAPRO;})
static PCB_IO_MGR::REGISTER_PLUGIN registerEasyEDAPlugin(PCB_IO_MGR::EASYEDA, wxT("EasyEDA / JLCEDA Std"), []() -> PCB_IO *{ return new PCB_IO_EASYEDA;})
static PCB_IO_MGR::REGISTER_PLUGIN registerGPCBPlugin(PCB_IO_MGR::GEDA_PCB, wxT("GEDA/Pcb"), []() -> PCB_IO *{ return new PCB_IO_GEDA;})
static PCB_IO_MGR::REGISTER_PLUGIN registerKicadPlugin(PCB_IO_MGR::KICAD_SEXP, wxT("KiCad"), []() -> PCB_IO *{ return new PCB_IO_KICAD_SEXPR;})
static PCB_IO_MGR::REGISTER_PLUGIN registerIPC2581Plugin(PCB_IO_MGR::IPC2581, wxT("IPC-2581"), []() -> PCB_IO *{ return new PCB_IO_IPC2581;})
static PCB_IO_MGR::REGISTER_PLUGIN registerPcadPlugin(PCB_IO_MGR::PCAD, wxT("P-Cad"), []() -> PCB_IO *{ return new PCB_IO_PCAD;})
static PCB_IO_MGR::REGISTER_PLUGIN registerEaglePlugin(PCB_IO_MGR::EAGLE, wxT("Eagle"), []() -> PCB_IO *{ return new PCB_IO_EAGLE;})
static PCB_IO_MGR::REGISTER_PLUGIN registerAltiumCircuitStudioPlugin(PCB_IO_MGR::ALTIUM_CIRCUIT_STUDIO, wxT("Altium Circuit Studio"), []() -> PCB_IO *{ return new PCB_IO_ALTIUM_CIRCUIT_STUDIO;})
static PCB_IO_MGR::REGISTER_PLUGIN registerAltiumDesignerPlugin(PCB_IO_MGR::ALTIUM_DESIGNER, wxT("Altium Designer"), []() -> PCB_IO *{ return new PCB_IO_ALTIUM_DESIGNER;})
static PCB_IO_MGR::REGISTER_PLUGIN registerCadstarArchivePlugin(PCB_IO_MGR::CADSTAR_PCB_ARCHIVE, wxT("CADSTAR PCB Archive"), []() -> PCB_IO *{ return new PCB_IO_CADSTAR_ARCHIVE;})
static PCB_IO_MGR::REGISTER_PLUGIN registerLegacyPlugin(PCB_IO_MGR::LEGACY, wxT("Legacy"), []() -> PCB_IO *{ return new PCB_IO_KICAD_LEGACY;})
static PCB_IO_MGR::REGISTER_PLUGIN registerFabmasterPlugin(PCB_IO_MGR::FABMASTER, wxT("Fabmaster"), []() -> PCB_IO *{ return new PCB_IO_FABMASTER;})
static PCB_IO_MGR::REGISTER_PLUGIN registerAltiumCircuitMakerPlugin(PCB_IO_MGR::ALTIUM_CIRCUIT_MAKER, wxT("Altium Circuit Maker"), []() -> PCB_IO *{ return new PCB_IO_ALTIUM_CIRCUIT_MAKER;})
#define FMT_NOTFOUND
Definition: sch_io_mgr.cpp:45
Register a plugin.
Definition: pcb_io_mgr.h:147
Definition of file extensions used in Kicad.