KiCad PCB EDA Suite
sch_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) 2016 CERN
5  * Copyright (C) 2016 KiCad Developers, see change_log.txt for contributors.
6  *
7  * @author Wayne Stambaugh <stambaughw@gmail.com>
8  *
9  * This program is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU General Public License
11  * as published by the Free Software Foundation; either version 2
12  * of the License, or (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License along
20  * with this program. If not, see <http://www.gnu.org/licenses/>.
21  */
22 
23 #include <wx/filename.h>
24 #include <wx/uri.h>
25 
26 #include <sch_io_mgr.h>
27 #include <sch_legacy_plugin.h>
28 
30 
31 #define FMT_UNIMPLEMENTED _( "Plugin '%s' does not implement the '%s' function." )
32 #define FMT_NOTFOUND _( "Plugin type '%s' is not found." )
33 
34 
35 
36 // Some day plugins might be in separate DLL/DSOs, simply because of numbers of them
37 // and code size. Until then, use the simplest method:
38 
39 // This implementation is one of two which could be done.
40 // The other one would cater to DLL/DSO's. But since it would be nearly
41 // impossible to link a KICAD type DLL/DSO right now without pulling in all
42 // ::Draw() functions, I forgo that option temporarily.
43 
44 // Some day it may be possible to have some built in AND some DLL/DSO
45 // plugins coexisting.
46 
47 
49 {
50  // This implementation is subject to change, any magic is allowed here.
51  // The public SCH_IO_MGR API is the only pertinent public information.
52 
53  switch( aFileType )
54  {
55  case SCH_LEGACY:
56  return new SCH_LEGACY_PLUGIN();
57  case SCH_KICAD:
58  return NULL;
59  }
60 
61  return NULL;
62 }
63 
64 
66 {
67  // This function is a place holder for a future point in time where
68  // the plugin is a DLL/DSO. It could do reference counting, and then
69  // unload the DLL/DSO when count goes to zero.
70 
71  delete aPlugin;
72 }
73 
74 
75 const wxString SCH_IO_MGR::ShowType( SCH_FILE_T aType )
76 {
77  // keep this function in sync with EnumFromStr() relative to the
78  // text spellings. If you change the spellings, you will obsolete
79  // library tables, so don't do change, only additions are ok.
80 
81  switch( aType )
82  {
83  default:
84  return wxString::Format( _( "Unknown SCH_FILE_T value: %d" ), aType );
85 
86  case SCH_LEGACY:
87  return wxString( wxT( "Legacy" ) );
88  }
89 }
90 
91 
93 {
94  // keep this function in sync with ShowType() relative to the
95  // text spellings. If you change the spellings, you will obsolete
96  // library tables, so don't do change, only additions are ok.
97 
98  if( aType == wxT( "Legacy" ) )
99  return SCH_LEGACY;
100 
101  // wxASSERT( blow up here )
102 
103  return SCH_FILE_T( -1 );
104 }
105 
106 
107 const wxString SCH_IO_MGR::GetFileExtension( SCH_FILE_T aFileType )
108 {
109  wxString ext = wxEmptyString;
110  SCH_PLUGIN* plugin = FindPlugin( aFileType );
111 
112  if( plugin != NULL )
113  {
114  ext = plugin->GetFileExtension();
115  ReleasePlugin( plugin );
116  }
117 
118  return ext;
119 }
120 
121 
123 {
124  SCH_FILE_T ret = SCH_LEGACY; // default guess, unless detected otherwise.
125  wxFileName fn( aLibPath );
126 
127  if( fn.GetExt() == SchematicFileWildcard )
128  {
129  ret = SCH_LEGACY;
130  }
131 
132  return ret;
133 }
134 
135 
136 SCH_SHEET* SCH_IO_MGR::Load( SCH_FILE_T aFileType, const wxString& aFileName, KIWAY* aKiway,
137  SCH_SHEET* aAppendToMe, const PROPERTIES* aProperties )
138 {
139  // release the SCH_PLUGIN even if an exception is thrown.
140  SCH_PLUGIN::SCH_PLUGIN_RELEASER pi( FindPlugin( aFileType ) );
141 
142  if( (SCH_PLUGIN*) pi ) // test pi->plugin
143  {
144  return pi->Load( aFileName, aKiway, aAppendToMe, aProperties ); // virtual
145  }
146 
147  THROW_IO_ERROR( wxString::Format( FMT_NOTFOUND, ShowType( aFileType ).GetData() ) );
148 }
149 
150 
151 void SCH_IO_MGR::Save( SCH_FILE_T aFileType, const wxString& aFileName,
152  SCH_SCREEN* aSchematic, KIWAY* aKiway, const PROPERTIES* aProperties )
153 {
154  // release the SCH_PLUGIN even if an exception is thrown.
155  SCH_PLUGIN::SCH_PLUGIN_RELEASER pi( FindPlugin( aFileType ) );
156 
157  if( (SCH_PLUGIN*) pi ) // test pi->plugin
158  {
159  pi->Save( aFileName, aSchematic, aKiway, aProperties ); // virtual
160  return;
161  }
162 
163  THROW_IO_ERROR( wxString::Format( FMT_NOTFOUND, ShowType( aFileType ).GetData() ) );
164 }
static SCH_FILE_T GuessPluginTypeFromLibPath(const wxString &aLibPath)
Return a plugin type given a footprint library's libPath.
Definition: sch_io_mgr.cpp:122
static SCH_PLUGIN * FindPlugin(SCH_FILE_T aFileType)
Return a SCH_PLUGIN which the caller can use to import, export, save, or load design documents...
Definition: sch_io_mgr.cpp:48
static const wxString ShowType(SCH_FILE_T aFileType)
Return a brief name for a plugin, given aFileType enum.
Definition: sch_io_mgr.cpp:75
virtual SCH_SHEET * Load(const wxString &aFileName, KIWAY *aKiway, SCH_SHEET *aAppendToMe=NULL, const PROPERTIES *aProperties=NULL)
Load information from some input file format that this SCH_PLUGIN implementation knows about...
Definition: sch_plugin.cpp:58
static void Save(SCH_FILE_T aFileType, const wxString &aFileName, SCH_SCREEN *aSchematic, KIWAY *aKiway, const PROPERTIES *aProperties=NULL)
Write either a full aSchematic to a storage file in a format that this implementation knows about...
Definition: sch_io_mgr.cpp:151
Class PROPERTIES is a name/value tuple with unique names and optional values.
Definition: properties.h:34
#define FMT_NOTFOUND
Definition: sch_io_mgr.cpp:32
Base class that schematic file and library loading and saving plugins should derive from...
Definition: sch_io_mgr.h:184
Legacy Eeschema file formats prior to s-expression.
Definition: sch_io_mgr.h:54
static const wxString GetFileExtension(SCH_FILE_T aFileType)
Return the file extension for aFileType.
Definition: sch_io_mgr.cpp:107
The common library.
Class KIWAY is a minimalistic software bus for communications between various DLLs/DSOs (DSOs) within...
Definition: kiway.h:257
const wxString SchematicFileWildcard
The s-expression version of the schematic file formats.
Definition: sch_io_mgr.h:55
Class SCH_LEGACY_PLUGIN.
Class SCH_SHEET is the sheet symbol placed in a schematic, and is the entry point for a sub schematic...
Definition: sch_sheet.h:216
static SCH_SHEET * Load(SCH_FILE_T aFileType, const wxString &aFileName, KIWAY *aKiway, SCH_SHEET *aAppendToMe=NULL, const PROPERTIES *aProperties=NULL)
Load the requested SCH_PLUGIN and if found, calls the SCH_PLUGIN->Load(..) function on it using the a...
Definition: sch_io_mgr.cpp:136
Helper object to release a SCH_PLUGIN in the context of a potential thrown exception through its dest...
Definition: sch_io_mgr.h:501
virtual void Save(const wxString &aFileName, SCH_SCREEN *aSchematic, KIWAY *aKiway, const PROPERTIES *aProperties=NULL)
Write aSchematic to a storage file in a format that this SCH_PLUGIN implementation knows about...
Definition: sch_plugin.cpp:66
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205
static SCH_FILE_T EnumFromStr(const wxString &aFileType)
Return the SCH_FILE_T from the corresponding plugin type name: "kicad", "legacy", etc...
Definition: sch_io_mgr.cpp:92
virtual const wxString GetFileExtension() const =0
Returns the file extension for the SCH_PLUGIN.
#define THROW_IO_ERROR(msg)
Definition: ki_exception.h:38
static void ReleasePlugin(SCH_PLUGIN *aPlugin)
Release a SCH_PLUGIN back to the system, and may cause it to be unloaded from memory.
Definition: sch_io_mgr.cpp:65
SCH_FILE_T
A set of file types that the SCH_IO_MGR knows about, and for which there has been a plugin written...
Definition: sch_io_mgr.h:52