KiCad PCB EDA Suite
sch_legacy_plugin.h
Go to the documentation of this file.
1 #ifndef _SCH_LEGACY_PLUGIN_H_
2 #define _SCH_LEGACY_PLUGIN_H_
3 
4 /*
5  * This program source code file is part of KiCad, a free EDA CAD application.
6  *
7  * Copyright (C) 2016 CERN
8  * Copyright (C) 2016-2019 KiCad Developers, see change_log.txt for contributors.
9  *
10  * @author Wayne Stambaugh <stambaughw@gmail.com>
11  *
12  * This program is free software; you can redistribute it and/or
13  * modify it under the terms of the GNU General Public License
14  * as published by the Free Software Foundation; either version 2
15  * of the License, or (at your option) any later version.
16  *
17  * This program is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20  * GNU General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License along
23  * with this program. If not, see <http://www.gnu.org/licenses/>.
24  */
25 
26 #include <memory>
27 #include <sch_io_mgr.h>
28 #include <stack>
29 
30 
31 class KIWAY;
32 class LINE_READER;
33 class SCH_SCREEN;
34 class SCH_SHEET;
35 class SCH_BITMAP;
36 class SCH_JUNCTION;
37 class SCH_NO_CONNECT;
38 class SCH_LINE;
39 class SCH_BUS_ENTRY_BASE;
40 class SCH_TEXT;
41 class SCH_COMPONENT;
42 class SCH_FIELD;
43 class PROPERTIES;
45 class LIB_PART;
46 class PART_LIB;
47 class LIB_ALIAS;
48 class BUS_ALIAS;
49 
50 
63 {
64 public:
65 
67  virtual ~SCH_LEGACY_PLUGIN();
68 
69  const wxString GetName() const override
70  {
71  return wxT( "Eeschema-Legacy" );
72  }
73 
74  const wxString GetFileExtension() const override
75  {
76  return wxT( "sch" );
77  }
78 
86  static const char* PropBuffering;
87 
94  static const char* PropNoDocFile;
95 
96  int GetModifyHash() const override;
97 
98  SCH_SHEET* Load( const wxString& aFileName, KIWAY* aKiway,
99  SCH_SHEET* aAppendToMe = NULL, const PROPERTIES* aProperties = NULL ) override;
100 
101  void Save( const wxString& aFileName, SCH_SCREEN* aScreen, KIWAY* aKiway,
102  const PROPERTIES* aProperties = NULL ) override;
103 
104  void Format( SCH_SCREEN* aScreen );
105 
106  size_t GetSymbolLibCount( const wxString& aLibraryPath,
107  const PROPERTIES* aProperties = NULL ) override;
108  void EnumerateSymbolLib( wxArrayString& aAliasNameList,
109  const wxString& aLibraryPath,
110  const PROPERTIES* aProperties = NULL ) override;
111  void EnumerateSymbolLib( std::vector<LIB_ALIAS*>& aAliasList,
112  const wxString& aLibraryPath,
113  const PROPERTIES* aProperties = NULL ) override;
114  LIB_ALIAS* LoadSymbol( const wxString& aLibraryPath, const wxString& aAliasName,
115  const PROPERTIES* aProperties = NULL ) override;
116  void SaveSymbol( const wxString& aLibraryPath, const LIB_PART* aSymbol,
117  const PROPERTIES* aProperties = NULL ) override;
118  void DeleteAlias( const wxString& aLibraryPath, const wxString& aAliasName,
119  const PROPERTIES* aProperties = NULL ) override;
120  void DeleteSymbol( const wxString& aLibraryPath, const wxString& aAliasName,
121  const PROPERTIES* aProperties = NULL ) override;
122  void CreateSymbolLib( const wxString& aLibraryPath,
123  const PROPERTIES* aProperties = NULL ) override;
124  bool DeleteSymbolLib( const wxString& aLibraryPath,
125  const PROPERTIES* aProperties = NULL ) override;
126  void SaveLibrary( const wxString& aLibraryPath, const PROPERTIES* aProperties = NULL ) override;
127 
128  bool CheckHeader( const wxString& aFileName ) override;
129  bool IsSymbolLibWritable( const wxString& aLibraryPath ) override;
130 
131  const wxString& GetError() const override { return m_error; }
132 
133  static LIB_PART * ParsePart( LINE_READER& reader, int aMajorVersion = 0,
134  int aMinorVersion = 0 );
135  static void FormatPart( LIB_PART* part, OUTPUTFORMATTER& formatter );
136 
137 private:
138  void loadHierarchy( SCH_SHEET* aSheet );
139  void loadHeader( FILE_LINE_READER& aReader, SCH_SCREEN* aScreen );
140  void loadPageSettings( FILE_LINE_READER& aReader, SCH_SCREEN* aScreen );
141  void loadFile( const wxString& aFileName, SCH_SCREEN* aScreen );
142  SCH_SHEET* loadSheet( FILE_LINE_READER& aReader );
146  SCH_LINE* loadWire( FILE_LINE_READER& aReader );
148  SCH_TEXT* loadText( FILE_LINE_READER& aReader );
150  std::shared_ptr< BUS_ALIAS > loadBusAlias( FILE_LINE_READER& aReader, SCH_SCREEN* aScreen );
151 
152  void saveComponent( SCH_COMPONENT* aComponent );
153  void saveField( SCH_FIELD* aField );
154  void saveBitmap( SCH_BITMAP* aBitmap );
155  void saveSheet( SCH_SHEET* aSheet );
156  void saveJunction( SCH_JUNCTION* aJunction );
157  void saveNoConnect( SCH_NO_CONNECT* aNoConnect );
158  void saveBusEntry( SCH_BUS_ENTRY_BASE* aBusEntry );
159  void saveLine( SCH_LINE* aLine );
160  void saveText( SCH_TEXT* aText );
161  void saveBusAlias( std::shared_ptr< BUS_ALIAS > aAlias );
162 
163  void cacheLib( const wxString& aLibraryFileName );
164  bool writeDocFile( const PROPERTIES* aProperties );
165  bool isBuffering( const PROPERTIES* aProperties );
166 
167 protected:
168  int m_version;
169 
171  wxString m_error;
172 
173  wxString m_path;
174  std::stack<wxString> m_currentPath;
180 
182  void init( KIWAY* aKiway, const PROPERTIES* aProperties = NULL );
183 };
184 
185 #endif // _SCH_LEGACY_PLUGIN_H_
FILE_OUTPUTFORMATTER * m_out
The output formatter for saving SCH_SCREEN objects.
Class SCH_FIELD instances are attached to a component and provide a place for the component's value,...
Definition: sch_field.h:56
SCH_BITMAP * loadBitmap(FILE_LINE_READER &aReader)
Class LINE_READER is an abstract class from which implementation specific LINE_READERs may be derived...
Definition: richio.h:81
Part library alias object definition.
wxString m_error
For throwing exceptions or errors on partial schematic loads.
void saveLine(SCH_LINE *aLine)
SCH_LEGACY_PLUGIN_CACHE * m_cache
void SaveLibrary(const wxString &aLibraryPath, const PROPERTIES *aProperties=NULL) override
size_t GetSymbolLibCount(const wxString &aLibraryPath, const PROPERTIES *aProperties=NULL) override
SCH_SHEET * m_rootSheet
The root sheet of the schematic being loaded..
void Format(SCH_SCREEN *aScreen)
void saveText(SCH_TEXT *aText)
Class OUTPUTFORMATTER is an important interface (abstract class) used to output 8 bit text in a conve...
Definition: richio.h:327
void SaveSymbol(const wxString &aLibraryPath, const LIB_PART *aSymbol, const PROPERTIES *aProperties=NULL) override
Write aSymbol to an existing library located at aLibraryPath.
void DeleteSymbol(const wxString &aLibraryPath, const wxString &aAliasName, const PROPERTIES *aProperties=NULL) override
Delete the entire LIB_PART associated with aAliasName from the library aLibraryPath.
void Save(const wxString &aFileName, SCH_SCREEN *aScreen, KIWAY *aKiway, const PROPERTIES *aProperties=NULL) override
Write aSchematic to a storage file in a format that this SCH_PLUGIN implementation knows about,...
void saveNoConnect(SCH_NO_CONNECT *aNoConnect)
Class PROPERTIES is a name/value tuple with unique names and optional values.
Definition: properties.h:34
std::shared_ptr< BUS_ALIAS > loadBusAlias(FILE_LINE_READER &aReader, SCH_SCREEN *aScreen)
void saveSheet(SCH_SHEET *aSheet)
const wxString GetName() const override
Returns a brief hard coded name for this SCH_PLUGIN.
const wxString & GetError() const override
Return an error string to the caller.
void loadPageSettings(FILE_LINE_READER &aReader, SCH_SCREEN *aScreen)
A cache assistant for the part library portion of the SCH_PLUGIN API, and only for the SCH_LEGACY_PLU...
void saveField(SCH_FIELD *aField)
static LIB_PART * ParsePart(LINE_READER &reader, int aMajorVersion=0, int aMinorVersion=0)
Base class for a bus or wire entry.
Definition: sch_bus_entry.h:41
const wxString GetFileExtension() const override
Returns the file extension for the SCH_PLUGIN.
void saveJunction(SCH_JUNCTION *aJunction)
int m_version
Version of file being loaded.
void CreateSymbolLib(const wxString &aLibraryPath, const PROPERTIES *aProperties=NULL) override
Create a new empty symbol library at aLibraryPath.
void loadFile(const wxString &aFileName, SCH_SCREEN *aScreen)
wxString m_path
Root project path for loading child sheets.
SCH_SHEET * loadSheet(FILE_LINE_READER &aReader)
Class FILE_LINE_READER is a LINE_READER that reads from an open file.
Definition: richio.h:180
Base class that schematic file and library loading and saving plugins should derive from.
Definition: sch_io_mgr.h:188
bool isBuffering(const PROPERTIES *aProperties)
void loadHierarchy(SCH_SHEET *aSheet)
static void FormatPart(LIB_PART *part, OUTPUTFORMATTER &formatter)
SCH_TEXT * loadText(FILE_LINE_READER &aReader)
bool DeleteSymbolLib(const wxString &aLibraryPath, const PROPERTIES *aProperties=NULL) override
Delete an existing symbol library and returns true if successful, or if library does not exist return...
Define a library symbol object.
Class KIWAY is a minimalistic software bus for communications between various DLLs/DSOs (DSOs) within...
Definition: kiway.h:258
void init(KIWAY *aKiway, const PROPERTIES *aProperties=NULL)
initialize PLUGIN like a constructor would.
void saveBitmap(SCH_BITMAP *aBitmap)
static const char * PropNoDocFile
const char* PropBuffering
SCH_JUNCTION * loadJunction(FILE_LINE_READER &aReader)
Object to handle a bitmap image that can be inserted in a schematic.
Definition: sch_bitmap.h:42
void saveComponent(SCH_COMPONENT *aComponent)
A SCH_PLUGIN derivation for loading schematic files created before the new s-expression file format.
bool CheckHeader(const wxString &aFileName) override
Return true if the first line in aFileName begins with the expected header.
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition: sch_sheet.h:208
void saveBusAlias(std::shared_ptr< BUS_ALIAS > aAlias)
Segment description base class to describe items which have 2 end points (track, wire,...
Definition: sch_line.h:41
void loadHeader(FILE_LINE_READER &aReader, SCH_SCREEN *aScreen)
void EnumerateSymbolLib(wxArrayString &aAliasNameList, const wxString &aLibraryPath, const PROPERTIES *aProperties=NULL) override
Populate a list of LIB_PART alias names contained within the library aLibraryPath.
SCH_BUS_ENTRY_BASE * loadBusEntry(FILE_LINE_READER &aReader)
Class SCH_COMPONENT describes a real schematic component.
Definition: sch_component.h:72
static const char * PropBuffering
const char* PropBuffering
void cacheLib(const wxString &aLibraryFileName)
Class FILE_OUTPUTFORMATTER may be used for text file output.
Definition: richio.h:492
SCH_COMPONENT * loadComponent(FILE_LINE_READER &aReader)
void DeleteAlias(const wxString &aLibraryPath, const wxString &aAliasName, const PROPERTIES *aProperties=NULL) override
Delete aAliasName from the library at aLibraryPath.
int GetModifyHash() const override
Return the modification hash from the library cache.
SCH_LINE * loadWire(FILE_LINE_READER &aReader)
LIB_ALIAS * LoadSymbol(const wxString &aLibraryPath, const wxString &aAliasName, const PROPERTIES *aProperties=NULL) override
Load a LIB_ALIAS object having aAliasName from the aLibraryPath containing a library format that this...
SCH_NO_CONNECT * loadNoConnect(FILE_LINE_READER &aReader)
KIWAY * m_kiway
Required for path to legacy component libraries.
bool IsSymbolLibWritable(const wxString &aLibraryPath) override
Return true if the library at aLibraryPath is writable.
Object used to load, save, search, and otherwise manipulate symbol library files.
void saveBusEntry(SCH_BUS_ENTRY_BASE *aBusEntry)
bool writeDocFile(const PROPERTIES *aProperties)
SCH_SHEET * Load(const wxString &aFileName, KIWAY *aKiway, SCH_SHEET *aAppendToMe=NULL, const PROPERTIES *aProperties=NULL) override
Load information from some input file format that this SCH_PLUGIN implementation knows about,...
const PROPERTIES * m_props
Passed via Save() or Load(), no ownership, may be NULL.
std::stack< wxString > m_currentPath
Stack to maintain nested sheet paths.