KiCad PCB EDA Suite
Loading...
Searching...
No Matches
pcb_io_mgr.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) 2011-2012 SoftPLC Corporation, Dick Hollenbeck <[email protected]>
5 * Copyright (C) 2016-2023 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 PCB_IO_MGR_H_
26#define PCB_IO_MGR_H_
27
28#include <cstdint>
29#include <config.h>
30#include <vector>
31#include <wx/arrstr.h>
32#include <i18n_utility.h>
33#include <io/io_base.h>
34#include <io/io_mgr.h>
35#include <pcb_io/pcb_io.h>
36
37class BOARD;
38class PCB_IO;
39class FOOTPRINT;
40class STRING_UTF8_MAP;
41class PROJECT;
43
47class PCB_IO_MGR : public IO_MGR
48{
49public:
50
56 {
72 // add your type here.
73
74 // etc.
75
77 };
78
84 {
85 public:
86 struct ENTRY
87 {
89 std::function<PCB_IO*(void)> m_createFunc;
90 wxString m_name;
91 };
92
94 {
95 static PLUGIN_REGISTRY *self = nullptr;
96
97 if( !self )
98 {
99 self = new PLUGIN_REGISTRY;
100 }
101 return self;
102 }
103
104 void Register( PCB_FILE_T aType, const wxString& aName,
105 std::function<PCB_IO*(void)> aCreateFunc )
106 {
107 ENTRY ent;
108 ent.m_type = aType;
109 ent.m_createFunc = aCreateFunc;
110 ent.m_name = aName;
111 m_plugins.push_back( ent );
112 }
113
114 PCB_IO* Create( PCB_FILE_T aFileType ) const
115 {
116 for( auto& ent : m_plugins )
117 {
118 if ( ent.m_type == aFileType )
119 {
120 return ent.m_createFunc();
121 }
122 }
123
124 return nullptr;
125 }
126
127 const std::vector<ENTRY>& AllPlugins() const
128 {
129 return m_plugins;
130 }
131
132 private:
133 std::vector<ENTRY> m_plugins;
134 };
135
146 {
147 REGISTER_PLUGIN( PCB_FILE_T aType, const wxString& aName,
148 std::function<PCB_IO*(void)> aCreateFunc )
149 {
150 PLUGIN_REGISTRY::Instance()->Register( aType, aName, aCreateFunc );
151 }
152 };
153
154
164 static PCB_IO* PluginFind( PCB_FILE_T aFileType );
165
169 static const wxString ShowType( PCB_FILE_T aFileType );
170
174 static PCB_FILE_T EnumFromStr( const wxString& aFileType );
175
179 static PCB_FILE_T FindPluginTypeFromBoardPath( const wxString& aFileName, int aCtl = 0 );
180
184 static PCB_FILE_T GuessPluginTypeFromLibPath( const wxString& aLibPath, int aCtl = 0 );
185
205 static BOARD* Load( PCB_FILE_T aFileType, const wxString& aFileName,
206 BOARD* aAppendToMe = nullptr, const STRING_UTF8_MAP* aProperties = nullptr,
207 PROJECT* aProject = nullptr,
208 PROGRESS_REPORTER* aProgressReporter = nullptr );
209
229 static void Save( PCB_FILE_T aFileType, const wxString& aFileName, BOARD* aBoard,
230 const STRING_UTF8_MAP* aProperties = nullptr );
231
235 static bool ConvertLibrary( STRING_UTF8_MAP* aOldFileProps, const wxString& aOldFilePath,
236 const wxString& aNewFilePath );
237};
238
239#endif // PCB_IO_MGR_H_
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:281
Definition: io_mgr.h:37
Hold a list of available plugins, created using a singleton REGISTER_PLUGIN object.
Definition: pcb_io_mgr.h:84
PCB_IO * Create(PCB_FILE_T aFileType) const
Definition: pcb_io_mgr.h:114
const std::vector< ENTRY > & AllPlugins() const
Definition: pcb_io_mgr.h:127
void Register(PCB_FILE_T aType, const wxString &aName, std::function< PCB_IO *(void)> aCreateFunc)
Definition: pcb_io_mgr.h:104
static PLUGIN_REGISTRY * Instance()
Definition: pcb_io_mgr.h:93
std::vector< ENTRY > m_plugins
Definition: pcb_io_mgr.h:133
A factory which returns an instance of a #PLUGIN.
Definition: pcb_io_mgr.h:48
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:65
static void Save(PCB_FILE_T aFileType, const wxString &aFileName, BOARD *aBoard, const STRING_UTF8_MAP *aProperties=nullptr)
Write either a full aBoard to a storage file in a format that this implementation knows about,...
Definition: pcb_io_mgr.cpp:172
static bool ConvertLibrary(STRING_UTF8_MAP *aOldFileProps, const wxString &aOldFilePath, const wxString &aNewFilePath)
Convert a schematic symbol library to the latest KiCad format.
Definition: pcb_io_mgr.cpp:187
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:90
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:76
@ 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
@ PCB_FILE_UNKNOWN
0 is not a legal menu id on Mac
Definition: pcb_io_mgr.h:57
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:108
static BOARD * Load(PCB_FILE_T aFileType, const wxString &aFileName, BOARD *aAppendToMe=nullptr, const STRING_UTF8_MAP *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:156
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:132
static const wxString ShowType(PCB_FILE_T aFileType)
Return a brief name for a plugin given aFileType enum.
Definition: pcb_io_mgr.cpp:74
A base class that BOARD loading and saving plugins should derive from.
Definition: pcb_io.h:72
A progress reporter interface for use in multi-threaded environments.
Container for project specific data.
Definition: project.h:62
A name/value tuple with unique names and optional values.
Some functions to handle hotkeys in KiCad.
std::function< PCB_IO *(void)> m_createFunc
Definition: pcb_io_mgr.h:89
Register a plugin.
Definition: pcb_io_mgr.h:146
REGISTER_PLUGIN(PCB_FILE_T aType, const wxString &aName, std::function< PCB_IO *(void)> aCreateFunc)
Definition: pcb_io_mgr.h:147