KiCad PCB EDA Suite
sch_plugin.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-2017 KiCad Developers, see AUTHORS.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 <properties.h>
24 
25 #include <sch_io_mgr.h>
26 
27 #define FMT_UNIMPLEMENTED _( "Plugin \"%s\" does not implement the \"%s\" function." )
28 
36 static void not_implemented( const SCH_PLUGIN* aPlugin, const char* aCaller )
37 {
39  aPlugin->GetName().GetData(),
40  wxString::FromUTF8( aCaller ).GetData() ) );
41 }
42 
43 
44 void SCH_PLUGIN::SaveLibrary( const wxString& aFileName, const PROPERTIES* aProperties )
45 {
46  not_implemented( this, __FUNCTION__ );
47 }
48 
49 
50 SCH_SHEET* SCH_PLUGIN::Load( const wxString& aFileName, KIWAY* aKiway, SCH_SHEET* aAppendToMe,
51  const PROPERTIES* aProperties )
52 {
53  not_implemented( this, __FUNCTION__ );
54  return NULL;
55 }
56 
57 
58 void SCH_PLUGIN::Save( const wxString& aFileName, SCH_SCREEN* aSchematic, KIWAY* aKiway,
59  const PROPERTIES* aProperties )
60 {
61  // not pure virtual so that plugins only have to implement subset of the SCH_PLUGIN interface.
62  not_implemented( this, __FUNCTION__ );
63 }
64 
65 
66 void SCH_PLUGIN::EnumerateSymbolLib( wxArrayString& aAliasNameList,
67  const wxString& aLibraryPath,
68  const PROPERTIES* aProperties )
69 {
70  // not pure virtual so that plugins only have to implement subset of the SCH_PLUGIN interface.
71  not_implemented( this, __FUNCTION__ );
72 }
73 
74 
75 void SCH_PLUGIN::EnumerateSymbolLib( std::vector<LIB_PART*>& aSymbolList,
76  const wxString& aLibraryPath,
77  const PROPERTIES* aProperties )
78 {
79  // not pure virtual so that plugins only have to implement subset of the SCH_PLUGIN interface.
80  not_implemented( this, __FUNCTION__ );
81 }
82 
83 
84 LIB_PART* SCH_PLUGIN::LoadSymbol( const wxString& aLibraryPath, const wxString& aSymbolName,
85  const PROPERTIES* aProperties )
86 {
87  // not pure virtual so that plugins only have to implement subset of the SCH_PLUGIN interface.
88  not_implemented( this, __FUNCTION__ );
89  return NULL;
90 }
91 
92 
93 void SCH_PLUGIN::SaveSymbol( const wxString& aLibraryPath, const LIB_PART* aSymbol,
94  const PROPERTIES* aProperties )
95 {
96  // not pure virtual so that plugins only have to implement subset of the SCH_PLUGIN interface.
97  not_implemented( this, __FUNCTION__ );
98 }
99 
100 
101 void SCH_PLUGIN::DeleteSymbol( const wxString& aLibraryPath, const wxString& aSymbolName,
102  const PROPERTIES* aProperties )
103 {
104  // not pure virtual so that plugins only have to implement subset of the SCH_PLUGIN interface.
105  not_implemented( this, __FUNCTION__ );
106 }
107 
108 
109 void SCH_PLUGIN::CreateSymbolLib( const wxString& aLibraryPath, const PROPERTIES* aProperties )
110 {
111  // not pure virtual so that plugins only have to implement subset of the SCH_PLUGIN interface.
112  not_implemented( this, __FUNCTION__ );
113 }
114 
115 
116 bool SCH_PLUGIN::DeleteSymbolLib( const wxString& aLibraryPath, const PROPERTIES* aProperties )
117 {
118  // not pure virtual so that plugins only have to implement subset of the SCH_PLUGIN interface.
119  not_implemented( this, __FUNCTION__ );
120  return false;
121 }
122 
123 
124 bool SCH_PLUGIN::IsSymbolLibWritable( const wxString& aLibraryPath )
125 {
126  // not pure virtual so that plugins only have to implement subset of the SCH_PLUGIN interface.
127  not_implemented( this, __FUNCTION__ );
128  return false;
129 }
130 
131 
132 void SCH_PLUGIN::SymbolLibOptions( PROPERTIES* aListToAppendTo ) const
133 {
134  // disable all these in another couple of months, after everyone has seen them:
135 #if 1
136  (*aListToAppendTo)["debug_level"] = UTF8( _(
137  "Enable <b>debug</b> logging for Symbol*() functions in this SCH_PLUGIN."
138  ) );
139 
140  (*aListToAppendTo)["read_filter_regex"] = UTF8( _(
141  "Regular expression <b>symbol name</b> filter."
142  ) );
143 
144  (*aListToAppendTo)["enable_transaction_logging"] = UTF8( _(
145  "Enable transaction logging. The mere presence of this option turns on the "
146  "logging, no need to set a Value."
147  ) );
148 
149  (*aListToAppendTo)["username"] = UTF8( _(
150  "User name for <b>login</b> to some special library server."
151  ));
152 
153  (*aListToAppendTo)["password"] = UTF8( _(
154  "Password for <b>login</b> to some special library server."
155  ) );
156 #endif
157 
158 #if 1
159  // Suitable for a C++ to python SCH_PLUGIN::Footprint*() adapter, move it to the adapter
160  // if and when implemented.
161  (*aListToAppendTo)["python_symbol_plugin"] = UTF8( _(
162  "Enter the python symbol which implements the SCH_PLUGIN::Symbol*() functions."
163  ) );
164 #endif
165 }
166 
167 
168 bool SCH_PLUGIN::CheckHeader( const wxString& aFileName )
169 {
170  // not pure virtual so that plugins only have to implement subset of the SCH_PLUGIN interface.
171  not_implemented( this, __FUNCTION__ );
172  return false;
173 }
174 
175 
176 const wxString& SCH_PLUGIN::GetError() const
177 {
178  // not pure virtual so that plugins only have to implement subset of the SCH_PLUGIN interface.
179  not_implemented( this, __FUNCTION__ );
180  static wxString error;
181  return error;
182 }
UTF8 is an 8 bit string that is assuredly encoded in UTF8, and supplies special conversion support to...
Definition: utf8.h:73
virtual void CreateSymbolLib(const wxString &aLibraryPath, const PROPERTIES *aProperties=NULL)
Create a new empty symbol library at aLibraryPath.
Definition: sch_plugin.cpp:109
virtual bool DeleteSymbolLib(const wxString &aLibraryPath, const PROPERTIES *aProperties=NULL)
Delete an existing symbol library and returns true if successful, or if library does not exist return...
Definition: sch_plugin.cpp:116
static void not_implemented(const SCH_PLUGIN *aPlugin, const char *aCaller)
Function not_implemented throws an IO_ERROR and complains of an API function not being implemented.
Definition: sch_plugin.cpp:36
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:50
virtual void DeleteSymbol(const wxString &aLibraryPath, const wxString &aSymbolName, const PROPERTIES *aProperties=NULL)
Delete the entire LIB_PART associated with aAliasName from the library aLibraryPath.
Definition: sch_plugin.cpp:101
virtual const wxString GetName() const =0
Returns a brief hard coded name for this SCH_PLUGIN.
PROPERTIES is a name/value tuple with unique names and optional values.
Definition: properties.h:34
virtual bool CheckHeader(const wxString &aFileName)
Return true if the first line in aFileName begins with the expected header.
Definition: sch_plugin.cpp:168
#define FMT_UNIMPLEMENTED
Definition: sch_plugin.cpp:27
Base class that schematic file and library loading and saving plugins should derive from.
Definition: sch_io_mgr.h:187
#define NULL
virtual void EnumerateSymbolLib(wxArrayString &aSymbolNameList, const wxString &aLibraryPath, const PROPERTIES *aProperties=NULL)
Populate a list of LIB_PART alias names contained within the library aLibraryPath.
Definition: sch_plugin.cpp:66
virtual LIB_PART * LoadSymbol(const wxString &aLibraryPath, const wxString &aPartName, const PROPERTIES *aProperties=NULL)
Load a LIB_PART object having aPartName from the aLibraryPath containing a library format that this S...
Definition: sch_plugin.cpp:84
Define a library symbol object.
KIWAY is a minimalistic software bus for communications between various DLLs/DSOs (DSOs) within the s...
Definition: kiway.h:274
#define THROW_IO_ERROR(msg)
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition: sch_sheet.h:206
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:58
virtual void SaveLibrary(const wxString &aFileName, const PROPERTIES *aProperties=NULL)
Definition: sch_plugin.cpp:44
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
#define _(s)
Definition: 3d_actions.cpp:31
virtual const wxString & GetError() const
Return an error string to the caller.
Definition: sch_plugin.cpp:176
virtual bool IsSymbolLibWritable(const wxString &aLibraryPath)
Return true if the library at aLibraryPath is writable.
Definition: sch_plugin.cpp:124
virtual void SymbolLibOptions(PROPERTIES *aListToAppendTo) const
Append supported SCH_PLUGIN options to aListToAppenTo along with internationalized descriptions.
Definition: sch_plugin.cpp:132
virtual void SaveSymbol(const wxString &aLibraryPath, const LIB_PART *aSymbol, const PROPERTIES *aProperties=NULL)
Write aSymbol to an existing library located at aLibraryPath.
Definition: sch_plugin.cpp:93