KiCad PCB EDA Suite
Go to the documentation of this file.
5 * This program source code file is part of KiCad, a free EDA CAD application.
6 *
7 * Copyright (C) 2020 CERN
8 * Copyright (C) 2021-2023 KiCad Developers, see AUTHORS.txt for contributors.
9 *
10 * @author Wayne Stambaugh <[email protected]>
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
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 <>.
24 */
26#include <memory>
27#include <sch_io_mgr.h>
28#include <sch_file_versions.h>
29#include <sch_sheet_path.h>
30#include <stack>
33class KIWAY;
34class LINE_READER;
35class SCH_SCREEN;
36class SCH_SHEET;
38class SCH_BITMAP;
41class SCH_LINE;
42class SCH_SHAPE;
44class SCH_TEXT;
45class SCH_TEXTBOX;
46class SCH_SYMBOL;
47class SCH_FIELD;
49class STRING_UTF8_MAP;
52class LIB_SYMBOL;
53class SYMBOL_LIB;
54class BUS_ALIAS;
67 virtual ~SCH_SEXPR_PLUGIN();
69 const wxString GetName() const override
70 {
71 return wxT( "Eeschema s-expression" );
72 }
74 const wxString GetFileExtension() const override
75 {
76 return wxT( "kicad_sch" );
77 }
79 const wxString GetLibraryFileExtension() const override
80 {
81 return wxT( "kicad_sym" );
82 }
84 void SetProgressReporter( PROGRESS_REPORTER* aReporter ) override
85 {
86 m_progressReporter = aReporter;
87 }
94 static const char* PropBuffering;
96 int GetModifyHash() const override;
98 SCH_SHEET* Load( const wxString& aFileName, SCHEMATIC* aSchematic,
99 SCH_SHEET* aAppendToMe = nullptr,
100 const STRING_UTF8_MAP* aProperties = nullptr ) override;
102 void LoadContent( LINE_READER& aReader, SCH_SHEET* aSheet,
105 void Save( const wxString& aFileName, SCH_SHEET* aSheet, SCHEMATIC* aSchematic,
106 const STRING_UTF8_MAP* aProperties = nullptr ) override;
108 void Format( SCH_SHEET* aSheet );
110 void Format( EE_SELECTION* aSelection, SCH_SHEET_PATH* aSelectionPath,
111 SCHEMATIC& aSchematic, OUTPUTFORMATTER* aFormatter, bool aForClipboard );
113 void EnumerateSymbolLib( wxArrayString& aSymbolNameList,
114 const wxString& aLibraryPath,
115 const STRING_UTF8_MAP* aProperties = nullptr ) override;
116 void EnumerateSymbolLib( std::vector<LIB_SYMBOL*>& aSymbolList,
117 const wxString& aLibraryPath,
118 const STRING_UTF8_MAP* aProperties = nullptr ) override;
119 LIB_SYMBOL* LoadSymbol( const wxString& aLibraryPath, const wxString& aAliasName,
120 const STRING_UTF8_MAP* aProperties = nullptr ) override;
121 void SaveSymbol( const wxString& aLibraryPath, const LIB_SYMBOL* aSymbol,
122 const STRING_UTF8_MAP* aProperties = nullptr ) override;
123 void DeleteSymbol( const wxString& aLibraryPath, const wxString& aSymbolName,
124 const STRING_UTF8_MAP* aProperties = nullptr ) override;
125 void CreateSymbolLib( const wxString& aLibraryPath,
126 const STRING_UTF8_MAP* aProperties = nullptr ) override;
127 bool DeleteSymbolLib( const wxString& aLibraryPath,
128 const STRING_UTF8_MAP* aProperties = nullptr ) override;
129 void SaveLibrary( const wxString& aLibraryPath,
130 const STRING_UTF8_MAP* aProperties = nullptr ) override;
132 bool CheckHeader( const wxString& aFileName ) override;
133 bool IsSymbolLibWritable( const wxString& aLibraryPath ) override;
135 void GetAvailableSymbolFields( std::vector<wxString>& aNames ) override;
136 void GetDefaultSymbolFields( std::vector<wxString>& aNames ) override;
138 const wxString& GetError() const override { return m_error; }
140 static LIB_SYMBOL* ParseLibSymbol( LINE_READER& aReader,
142 static void FormatLibSymbol( LIB_SYMBOL* aPart, OUTPUTFORMATTER& aFormatter );
145 void loadHierarchy( const SCH_SHEET_PATH& aParentSheetPath, SCH_SHEET* aSheet );
146 void loadFile( const wxString& aFileName, SCH_SHEET* aSheet );
148 void saveSymbol( SCH_SYMBOL* aSymbol, const SCHEMATIC& aSchematic, int aNestLevel,
149 bool aForClipboard );
150 void saveField( SCH_FIELD* aField, int aNestLevel );
151 void saveBitmap( SCH_BITMAP* aBitmap, int aNestLevel );
152 void saveSheet( SCH_SHEET* aSheet, int aNestLevel );
153 void saveJunction( SCH_JUNCTION* aJunction, int aNestLevel );
154 void saveNoConnect( SCH_NO_CONNECT* aNoConnect, int aNestLevel );
155 void saveBusEntry( SCH_BUS_ENTRY_BASE* aBusEntry, int aNestLevel );
156 void saveLine( SCH_LINE* aLine, int aNestLevel );
157 void saveShape( SCH_SHAPE* aShape, int aNestLevel );
158 void saveText( SCH_TEXT* aText, int aNestLevel );
159 void saveTextBox( SCH_TEXTBOX* aText, int aNestLevel );
160 void saveBusAlias( std::shared_ptr<BUS_ALIAS> aAlias, int aNestLevel );
161 void saveInstances( const std::vector<SCH_SHEET_INSTANCE>& aSheets, int aNestLevel );
163 void cacheLib( const wxString& aLibraryFileName, const STRING_UTF8_MAP* aProperties );
164 bool isBuffering( const STRING_UTF8_MAP* aProperties );
170 wxString m_error;
174 wxString m_path;
175 std::stack<wxString> m_currentPath;
183 void init( SCHEMATIC* aSchematic, const STRING_UTF8_MAP* aProperties = nullptr );
186#endif // _SCH_SEXPR_PLUGIN_H_
A minimalistic software bus for communications between various DLLs/DSOs (DSOs) within the same KiCad...
Definition: kiway.h:279
Define a library symbol object.
Definition: lib_symbol.h:99
An abstract class from which implementation specific LINE_READERs may be derived to read single lines...
Definition: richio.h:81
An interface used to output 8 bit text in a convenient way.
Definition: richio.h:310
A progress reporter interface for use in multi-threaded environments.
Holds all the data relating to one schematic.
Definition: schematic.h:61
Object to handle a bitmap image that can be inserted in a schematic.
Definition: sch_bitmap.h:41
Base class for a bus or wire entry.
Definition: sch_bus_entry.h:38
Instances are attached to a symbol or sheet and provide a place for the symbol's value,...
Definition: sch_field.h:51
Segment description base class to describe items which have 2 end points (track, wire,...
Definition: sch_line.h:40
Base class that schematic file and library loading and saving plugins should derive from.
Definition: sch_io_mgr.h:155
A cache assistant for the KiCad s-expression symbol libraries.
A SCH_PLUGIN derivation for loading schematic files using the new s-expression file format.
wxString m_error
For throwing exceptions or errors on partial loads.
void saveBusAlias(std::shared_ptr< BUS_ALIAS > aAlias, int aNestLevel)
void GetDefaultSymbolFields(std::vector< wxString > &aNames) override
Retrieves a list of (custom) field names that should be shown by default for this library in the symb...
const wxString GetLibraryFileExtension() const override
Return the library file extension for the SCH_PLUGIN object.
SCH_SHEET_PATH m_currentSheetPath
void cacheLib(const wxString &aLibraryFileName, const STRING_UTF8_MAP *aProperties)
wxString m_path
Root project path for loading child sheets.
void saveField(SCH_FIELD *aField, int aNestLevel)
void saveTextBox(SCH_TEXTBOX *aText, int aNestLevel)
const wxString GetFileExtension() const override
Return the file extension for the SCH_PLUGIN.
SCHEMATIC * m_schematic
The formatter for saving SCH_SCREEN objects.
void Format(SCH_SHEET *aSheet)
void SaveSymbol(const wxString &aLibraryPath, const LIB_SYMBOL *aSymbol, const STRING_UTF8_MAP *aProperties=nullptr) override
Write aSymbol to an existing library located at aLibraryPath.
static void FormatLibSymbol(LIB_SYMBOL *aPart, OUTPUTFORMATTER &aFormatter)
void SaveLibrary(const wxString &aLibraryPath, const STRING_UTF8_MAP *aProperties=nullptr) override
void GetAvailableSymbolFields(std::vector< wxString > &aNames) override
Retrieves a list of (custom) field names that are present on symbols in this library.
bool DeleteSymbolLib(const wxString &aLibraryPath, const STRING_UTF8_MAP *aProperties=nullptr) override
Delete an existing symbol library and returns true if successful, or if library does not exist return...
const wxString GetName() const override
Return a brief hard coded name for this SCH_PLUGIN.
std::stack< wxString > m_currentPath
Stack to maintain nested sheet paths.
void loadFile(const wxString &aFileName, SCH_SHEET *aSheet)
void saveLine(SCH_LINE *aLine, int aNestLevel)
void saveInstances(const std::vector< SCH_SHEET_INSTANCE > &aSheets, int aNestLevel)
const wxString & GetError() const override
Return an error string to the caller.
bool m_appending
Schematic load append status.
SCH_SHEET * m_rootSheet
The root sheet of the schematic being loaded.
void DeleteSymbol(const wxString &aLibraryPath, const wxString &aSymbolName, const STRING_UTF8_MAP *aProperties=nullptr) override
Delete the entire LIB_SYMBOL associated with aAliasName from the library aLibraryPath.
void SetProgressReporter(PROGRESS_REPORTER *aReporter) override
Set an optional progress reporter.
void saveText(SCH_TEXT *aText, int aNestLevel)
static LIB_SYMBOL * ParseLibSymbol(LINE_READER &aReader, int aVersion=SEXPR_SCHEMATIC_FILE_VERSION)
void EnumerateSymbolLib(wxArrayString &aSymbolNameList, const wxString &aLibraryPath, const STRING_UTF8_MAP *aProperties=nullptr) override
Populate a list of LIB_SYMBOL alias names contained within the library aLibraryPath.
void saveSymbol(SCH_SYMBOL *aSymbol, const SCHEMATIC &aSchematic, int aNestLevel, bool aForClipboard)
void saveSheet(SCH_SHEET *aSheet, int aNestLevel)
SCH_SHEET * Load(const wxString &aFileName, SCHEMATIC *aSchematic, SCH_SHEET *aAppendToMe=nullptr, const STRING_UTF8_MAP *aProperties=nullptr) override
Load information from some input file format that this SCH_PLUGIN implementation knows about,...
void CreateSymbolLib(const wxString &aLibraryPath, const STRING_UTF8_MAP *aProperties=nullptr) override
Create a new empty symbol library at aLibraryPath.
void LoadContent(LINE_READER &aReader, SCH_SHEET *aSheet, int aVersion=SEXPR_SCHEMATIC_FILE_VERSION)
bool IsSymbolLibWritable(const wxString &aLibraryPath) override
Return true if the library at aLibraryPath is writable.
void loadHierarchy(const SCH_SHEET_PATH &aParentSheetPath, SCH_SHEET *aSheet)
bool isBuffering(const STRING_UTF8_MAP *aProperties)
PROGRESS_REPORTER * m_progressReporter
void init(SCHEMATIC *aSchematic, const STRING_UTF8_MAP *aProperties=nullptr)
initialize PLUGIN like a constructor would.
static const char * PropBuffering
The property used internally by the plugin to enable cache buffering which prevents the library file ...
void saveShape(SCH_SHAPE *aShape, int aNestLevel)
LIB_SYMBOL * LoadSymbol(const wxString &aLibraryPath, const wxString &aAliasName, const STRING_UTF8_MAP *aProperties=nullptr) override
Load a LIB_SYMBOL object having aPartName from the aLibraryPath containing a library format that this...
void saveBitmap(SCH_BITMAP *aBitmap, int aNestLevel)
bool CheckHeader(const wxString &aFileName) override
Return true if the first line in aFileName begins with the expected header.
void saveBusEntry(SCH_BUS_ENTRY_BASE *aBusEntry, int aNestLevel)
void Save(const wxString &aFileName, SCH_SHEET *aSheet, SCHEMATIC *aSchematic, const STRING_UTF8_MAP *aProperties=nullptr) override
Write aSchematic to a storage file in a format that this SCH_PLUGIN implementation knows about,...
int m_version
Version of file being loaded.
int GetModifyHash() const override
Return the modification hash from the library cache.
void saveNoConnect(SCH_NO_CONNECT *aNoConnect, int aNestLevel)
void saveJunction(SCH_JUNCTION *aJunction, int aNestLevel)
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition: sch_sheet.h:57
Schematic symbol object.
Definition: sch_symbol.h:81
A name/value tuple with unique names and optional values.
Object used to load, save, search, and otherwise manipulate symbol library files.
Schematic file version.
Definition of the SCH_SHEET_PATH and SCH_SHEET_LIST classes for Eeschema.
A simple container for sheet instance information.
A simple container for schematic symbol instance information.