haskal
/
kicad
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
kicad/eeschema/sch_legacy_plugin.h

186 lines
7.4 KiB
C
Raw Normal View History

Eeschema: initial schematic I/O plugin. * Factor out PROPERTIES object from the PCB plugin code and move it into common so it can be used by both the Pcbnew and Eeschema plugins. * Add schematic I/O plugin manager for loading and saving schematic and component library files. * Add initial attempt at a parser for current schematic file format. This parser will be infinitely more strict than the current parser which is very forgiving in what it parses. * Make minor changes to the base bitmap class to support the new parser. * Add find root sheet support to sheet object to allow fetching the root sheet from any sheet in the stack.
2016-07-06 09:22:56 +00:00
#ifndef _SCH_LEGACY_PLUGIN_H_
#define _SCH_LEGACY_PLUGIN_H_
/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2016 CERN
Fix coding policy violations of previous patch.
2019-03-15 13:09:42 +00:00
* Copyright (C) 2016-2019 KiCad Developers, see change_log.txt for contributors.
Eeschema: initial schematic I/O plugin. * Factor out PROPERTIES object from the PCB plugin code and move it into common so it can be used by both the Pcbnew and Eeschema plugins. * Add schematic I/O plugin manager for loading and saving schematic and component library files. * Add initial attempt at a parser for current schematic file format. This parser will be infinitely more strict than the current parser which is very forgiving in what it parses. * Make minor changes to the base bitmap class to support the new parser. * Add find root sheet support to sheet object to allow fetching the root sheet from any sheet in the stack.
2016-07-06 09:22:56 +00:00
*
* @author Wayne Stambaugh <stambaughw@gmail.com>
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program. If not, see <http://www.gnu.org/licenses/>.
*/
New connectivity algorithm and bus upgrades Bus upgrades: core new connectivity code Bus upgrades: eeschema integration and modifications Bus upgrades: eeschema dialogs Bus upgrades: netlist export Bus upgrades: file format changes
2019-03-11 21:32:05 +00:00
#include <memory>
Eeschema: initial schematic I/O plugin. * Factor out PROPERTIES object from the PCB plugin code and move it into common so it can be used by both the Pcbnew and Eeschema plugins. * Add schematic I/O plugin manager for loading and saving schematic and component library files. * Add initial attempt at a parser for current schematic file format. This parser will be infinitely more strict than the current parser which is very forgiving in what it parses. * Make minor changes to the base bitmap class to support the new parser. * Add find root sheet support to sheet object to allow fetching the root sheet from any sheet in the stack.
2016-07-06 09:22:56 +00:00
#include <sch_io_mgr.h>
SCH_LEGACY_PLUGIN::loadHierarchy() uses a stack to maintain sheet paths Path keeping stack copes well with paths pointing outside the project directory (e.g. "../path"). The so far used wxFileName::GetDirCount() and wxFileName::RemoveLastDir() remove too many directories, as ".." is also counted as a directory. Fixes: lp:1769746 * https://bugs.launchpad.net/kicad/+bug/1769746
2018-05-09 09:15:00 +00:00
#include <stack>
Eeschema: initial schematic I/O plugin. * Factor out PROPERTIES object from the PCB plugin code and move it into common so it can be used by both the Pcbnew and Eeschema plugins. * Add schematic I/O plugin manager for loading and saving schematic and component library files. * Add initial attempt at a parser for current schematic file format. This parser will be infinitely more strict than the current parser which is very forgiving in what it parses. * Make minor changes to the base bitmap class to support the new parser. * Add find root sheet support to sheet object to allow fetching the root sheet from any sheet in the stack.
2016-07-06 09:22:56 +00:00
class KIWAY;
class LINE_READER;
class SCH_SCREEN;
class SCH_SHEET;
class SCH_BITMAP;
class SCH_JUNCTION;
class SCH_NO_CONNECT;
class SCH_LINE;
class SCH_BUS_ENTRY_BASE;
class SCH_TEXT;
class SCH_COMPONENT;
Eeschema: add saving schematic files to schematic plugin. * Add SCH_PLUGIN::Save() for current file format and code for saving all SCH_XXX objects. * Add function to SCH_FIELD to get the position of the field in the component not the position added to the component position which is what GetPosition() does. This was required because saving the component field expects position of the field sans the position of the component. * Remove public members from BITMAP_BASE object and fix all associated code. * Fix the never ending coding policy violations found making these changes.
2016-07-11 19:48:46 +00:00
class SCH_FIELD;
Eeschema: initial schematic I/O plugin. * Factor out PROPERTIES object from the PCB plugin code and move it into common so it can be used by both the Pcbnew and Eeschema plugins. * Add schematic I/O plugin manager for loading and saving schematic and component library files. * Add initial attempt at a parser for current schematic file format. This parser will be infinitely more strict than the current parser which is very forgiving in what it parses. * Make minor changes to the base bitmap class to support the new parser. * Add find root sheet support to sheet object to allow fetching the root sheet from any sheet in the stack.
2016-07-06 09:22:56 +00:00
class PROPERTIES;
Eeschema: implement schematic I/O plugin symbol library parser. * Write SCH_LEGACY_PLUGIN_CACHE object for handling the legacy symbol library file format. * Write legacy symbol library file parser. * Write code to transfer cache to PART_LIB object so existing library save code can be used for round trip testing. This is temporary until Eeschema is updated to use the plugin for library management rather than PART_LIB. * Add LIB_XXXX object helper functions where there was no way to set the member variables of an object. * Give the cache object friend status to some object where there are incredibly byzantine ways of setting text in LIB_XXXX objects.
2016-08-18 23:23:10 +00:00
class SCH_LEGACY_PLUGIN_CACHE;
class LIB_PART;
class PART_LIB;
Eeschema: add code to plugin manager to load a symbol from a library.
2016-09-03 18:28:17 +00:00
class LIB_ALIAS;
New connectivity algorithm and bus upgrades Bus upgrades: core new connectivity code Bus upgrades: eeschema integration and modifications Bus upgrades: eeschema dialogs Bus upgrades: netlist export Bus upgrades: file format changes
2019-03-11 21:32:05 +00:00
class BUS_ALIAS;
Eeschema: initial schematic I/O plugin. * Factor out PROPERTIES object from the PCB plugin code and move it into common so it can be used by both the Pcbnew and Eeschema plugins. * Add schematic I/O plugin manager for loading and saving schematic and component library files. * Add initial attempt at a parser for current schematic file format. This parser will be infinitely more strict than the current parser which is very forgiving in what it parses. * Make minor changes to the base bitmap class to support the new parser. * Add find root sheet support to sheet object to allow fetching the root sheet from any sheet in the stack.
2016-07-06 09:22:56 +00:00
/**
Convert symbol library viewer over to symbol library table. Remove all instances of PART_LIBS and replace them with SYMBOL_LIB_TABLE except for the CMP_TREE_MODEL_ADAPTER which requires updating as well. Return the selected symbol using the LIB_NICKNAME:SYMBOL_NAME format when viewer is launched as modal. Add code to SYMBOL_LIB_TABLE object to allow enumerating symbol library power symbols only. Add a non-const version of LIB_TABLE::findRow(). Remove redundant information from Doxygen comments.
2017-09-02 18:12:50 +00:00
* A #SCH_PLUGIN derivation for loading schematic files created before the new s-expression
* file format.
Eeschema: initial schematic I/O plugin. * Factor out PROPERTIES object from the PCB plugin code and move it into common so it can be used by both the Pcbnew and Eeschema plugins. * Add schematic I/O plugin manager for loading and saving schematic and component library files. * Add initial attempt at a parser for current schematic file format. This parser will be infinitely more strict than the current parser which is very forgiving in what it parses. * Make minor changes to the base bitmap class to support the new parser. * Add find root sheet support to sheet object to allow fetching the root sheet from any sheet in the stack.
2016-07-06 09:22:56 +00:00
*
* The legacy parser and formatter attempt to be compatible with the legacy file format.
* The original parser was very forgiving in that it would parse only part of a keyword.
* So "$C", "$Co", and "$Com" could be used for "$Comp" and the old parser would allow
* this. This parser is not that forgiving and sticks to the legacy file format document.
*
* As with all SCH_PLUGINs there is no UI dependencies i.e. windowing calls allowed.
*/
class SCH_LEGACY_PLUGIN : public SCH_PLUGIN
{
public:
Eeschema: implement schematic I/O plugin symbol library parser. * Write SCH_LEGACY_PLUGIN_CACHE object for handling the legacy symbol library file format. * Write legacy symbol library file parser. * Write code to transfer cache to PART_LIB object so existing library save code can be used for round trip testing. This is temporary until Eeschema is updated to use the plugin for library management rather than PART_LIB. * Add LIB_XXXX object helper functions where there was no way to set the member variables of an object. * Give the cache object friend status to some object where there are incredibly byzantine ways of setting text in LIB_XXXX objects.
2016-08-18 23:23:10 +00:00
SCH_LEGACY_PLUGIN();
Prevent schematic I/O plugin from setting the library cache to null. Don't call init() when performing library functions as it was always setting the m_cache variable to null which cause the library to be reloaded every time a library command was performed as well as a memory leak. Delete cache object when the plugin is destroyed.
2017-01-28 04:30:13 +00:00
virtual ~SCH_LEGACY_PLUGIN();
Eeschema: implement schematic I/O plugin symbol library parser. * Write SCH_LEGACY_PLUGIN_CACHE object for handling the legacy symbol library file format. * Write legacy symbol library file parser. * Write code to transfer cache to PART_LIB object so existing library save code can be used for round trip testing. This is temporary until Eeschema is updated to use the plugin for library management rather than PART_LIB. * Add LIB_XXXX object helper functions where there was no way to set the member variables of an object. * Give the cache object friend status to some object where there are incredibly byzantine ways of setting text in LIB_XXXX objects.
2016-08-18 23:23:10 +00:00
Add more "override" markers.
2016-09-25 17:06:49 +00:00
const wxString GetName() const override
Eeschema: initial schematic I/O plugin. * Factor out PROPERTIES object from the PCB plugin code and move it into common so it can be used by both the Pcbnew and Eeschema plugins. * Add schematic I/O plugin manager for loading and saving schematic and component library files. * Add initial attempt at a parser for current schematic file format. This parser will be infinitely more strict than the current parser which is very forgiving in what it parses. * Make minor changes to the base bitmap class to support the new parser. * Add find root sheet support to sheet object to allow fetching the root sheet from any sheet in the stack.
2016-07-06 09:22:56 +00:00
{
return wxT( "Eeschema-Legacy" );
}
Add more "override" markers.
2016-09-25 17:06:49 +00:00
const wxString GetFileExtension() const override
Eeschema: initial schematic I/O plugin. * Factor out PROPERTIES object from the PCB plugin code and move it into common so it can be used by both the Pcbnew and Eeschema plugins. * Add schematic I/O plugin manager for loading and saving schematic and component library files. * Add initial attempt at a parser for current schematic file format. This parser will be infinitely more strict than the current parser which is very forgiving in what it parses. * Make minor changes to the base bitmap class to support the new parser. * Add find root sheet support to sheet object to allow fetching the root sheet from any sheet in the stack.
2016-07-06 09:22:56 +00:00
{
return wxT( "sch" );
}
Make the schematic I/O plugin the only option. Add SCH_PLUGIN object to PART_LIB object. Convert all PART_LIB I/O to use SCH_PLUGIN. Remove library caching from PART_LIB and use caching provided by SCH_PLUGIN. Add support to use PROPERTIES for buffering and document file write control instead of adding code the SCH_PLUGIN object in the SCH_LEGACY_PLUGIN that will not be required when the new file formats are implemented. Add buffering to SCH_LEGACY_PLUGIN to prevent cache from writing file on every change to library. This is to prevent the cache library from being written every time a new symbol is added. Add option to not save library document file when saving library. This is primarily used by the cache library write code. Move symbol library write code out of LIB_PART and into SCH_LEGACY_PLUGIN. Add exception handling where LIB_PART caught the exception and returned an error status. Remove KICAD_SCH_IO_MANAGER build option as it is no longer optional.
2017-01-27 15:56:36 +00:00
/**
* const char* PropBuffering
*
* is a property used internally by the plugin to enable cache buffering which prevents
* the library file from being written every time the cache is changed. This is useful
* when writing the schematic cache library file or saving a library to a new file name.
*/
static const char* PropBuffering;
/**
* const char* PropBuffering
*
* is a property used internally by the plugin to disable writing the library
* documentation (.dcm) file when saving the library cache.
*/
static const char* PropNoDocFile;
Eeschema: more schematic I/O plugin prep work. Add code to schematic I/O plugin for updating library modification hashes. Remove unused RemoveLibrary() method from PART_LIBS object. Purge wxT() macros from modified files.
2016-10-24 23:18:50 +00:00
int GetModifyHash() const override;
Eeschema: initial schematic I/O plugin. * Factor out PROPERTIES object from the PCB plugin code and move it into common so it can be used by both the Pcbnew and Eeschema plugins. * Add schematic I/O plugin manager for loading and saving schematic and component library files. * Add initial attempt at a parser for current schematic file format. This parser will be infinitely more strict than the current parser which is very forgiving in what it parses. * Make minor changes to the base bitmap class to support the new parser. * Add find root sheet support to sheet object to allow fetching the root sheet from any sheet in the stack.
2016-07-06 09:22:56 +00:00
SCH_SHEET* Load( const wxString& aFileName, KIWAY* aKiway,
Add more "override" markers.
2016-09-25 17:06:49 +00:00
SCH_SHEET* aAppendToMe = NULL, const PROPERTIES* aProperties = NULL ) override;
Eeschema: initial schematic I/O plugin. * Factor out PROPERTIES object from the PCB plugin code and move it into common so it can be used by both the Pcbnew and Eeschema plugins. * Add schematic I/O plugin manager for loading and saving schematic and component library files. * Add initial attempt at a parser for current schematic file format. This parser will be infinitely more strict than the current parser which is very forgiving in what it parses. * Make minor changes to the base bitmap class to support the new parser. * Add find root sheet support to sheet object to allow fetching the root sheet from any sheet in the stack.
2016-07-06 09:22:56 +00:00
Eeschema: add saving schematic files to schematic plugin. * Add SCH_PLUGIN::Save() for current file format and code for saving all SCH_XXX objects. * Add function to SCH_FIELD to get the position of the field in the component not the position added to the component position which is what GetPosition() does. This was required because saving the component field expects position of the field sans the position of the component. * Remove public members from BITMAP_BASE object and fix all associated code. * Fix the never ending coding policy violations found making these changes.
2016-07-11 19:48:46 +00:00
void Save( const wxString& aFileName, SCH_SCREEN* aScreen, KIWAY* aKiway,
Add more "override" markers.
2016-09-25 17:06:49 +00:00
const PROPERTIES* aProperties = NULL ) override;
Eeschema: add saving schematic files to schematic plugin. * Add SCH_PLUGIN::Save() for current file format and code for saving all SCH_XXX objects. * Add function to SCH_FIELD to get the position of the field in the component not the position added to the component position which is what GetPosition() does. This was required because saving the component field expects position of the field sans the position of the component. * Remove public members from BITMAP_BASE object and fix all associated code. * Fix the never ending coding policy violations found making these changes.
2016-07-11 19:48:46 +00:00
void Format( SCH_SCREEN* aScreen );
Eeschema: initial schematic I/O plugin. * Factor out PROPERTIES object from the PCB plugin code and move it into common so it can be used by both the Pcbnew and Eeschema plugins. * Add schematic I/O plugin manager for loading and saving schematic and component library files. * Add initial attempt at a parser for current schematic file format. This parser will be infinitely more strict than the current parser which is very forgiving in what it parses. * Make minor changes to the base bitmap class to support the new parser. * Add find root sheet support to sheet object to allow fetching the root sheet from any sheet in the stack.
2016-07-06 09:22:56 +00:00
Make the schematic I/O plugin the only option. Add SCH_PLUGIN object to PART_LIB object. Convert all PART_LIB I/O to use SCH_PLUGIN. Remove library caching from PART_LIB and use caching provided by SCH_PLUGIN. Add support to use PROPERTIES for buffering and document file write control instead of adding code the SCH_PLUGIN object in the SCH_LEGACY_PLUGIN that will not be required when the new file formats are implemented. Add buffering to SCH_LEGACY_PLUGIN to prevent cache from writing file on every change to library. This is to prevent the cache library from being written every time a new symbol is added. Add option to not save library document file when saving library. This is primarily used by the cache library write code. Move symbol library write code out of LIB_PART and into SCH_LEGACY_PLUGIN. Add exception handling where LIB_PART caught the exception and returned an error status. Remove KICAD_SCH_IO_MANAGER build option as it is no longer optional.
2017-01-27 15:56:36 +00:00
size_t GetSymbolLibCount( const wxString& aLibraryPath,
const PROPERTIES* aProperties = NULL ) override;
Eeschema: implement schematic I/O plugin symbol library parser. * Write SCH_LEGACY_PLUGIN_CACHE object for handling the legacy symbol library file format. * Write legacy symbol library file parser. * Write code to transfer cache to PART_LIB object so existing library save code can be used for round trip testing. This is temporary until Eeschema is updated to use the plugin for library management rather than PART_LIB. * Add LIB_XXXX object helper functions where there was no way to set the member variables of an object. * Give the cache object friend status to some object where there are incredibly byzantine ways of setting text in LIB_XXXX objects.
2016-08-18 23:23:10 +00:00
void EnumerateSymbolLib( wxArrayString& aAliasNameList,
const wxString& aLibraryPath,
Add more "override" markers.
2016-09-25 17:06:49 +00:00
const PROPERTIES* aProperties = NULL ) override;
Optimize SCH_PLUGIN enumeration for populating the component chooser
2017-02-24 16:09:27 +00:00
void EnumerateSymbolLib( std::vector<LIB_ALIAS*>& aAliasList,
const wxString& aLibraryPath,
const PROPERTIES* aProperties = NULL ) override;
Eeschema: add code to plugin manager to load a symbol from a library.
2016-09-03 18:28:17 +00:00
LIB_ALIAS* LoadSymbol( const wxString& aLibraryPath, const wxString& aAliasName,
Add more "override" markers.
2016-09-25 17:06:49 +00:00
const PROPERTIES* aProperties = NULL ) override;
Eeschema: add save code to legacy symbol library plugin. Make LIB_PART copy constructor take a const LIB_PART reference. Add SaveSymbol to legacy symbol library plugin. Add removeAlias to legacy symbol library cache. Add AddSymbol to legacy symbol library cache.
2016-09-17 17:31:58 +00:00
void SaveSymbol( const wxString& aLibraryPath, const LIB_PART* aSymbol,
Add more "override" markers.
2016-09-25 17:06:49 +00:00
const PROPERTIES* aProperties = NULL ) override;
Eeschema: add delete alias from library to I/O manager. Modify base I/O manager class to delete alias from a symbol library. Add delete alias from legacy symbol library plugin.
2016-09-23 17:28:38 +00:00
void DeleteAlias( const wxString& aLibraryPath, const wxString& aAliasName,
Add more "override" markers.
2016-09-25 17:06:49 +00:00
const PROPERTIES* aProperties = NULL ) override;
Eeschema: add delete symbol method to schematic I/O plugin.
2016-09-29 22:31:43 +00:00
void DeleteSymbol( const wxString& aLibraryPath, const wxString& aAliasName,
const PROPERTIES* aProperties = NULL ) override;
Eeschema: add create symbol library to legacy schematic I/O plugin.
2016-10-05 23:28:56 +00:00
void CreateSymbolLib( const wxString& aLibraryPath,
const PROPERTIES* aProperties = NULL ) override;
Eeschema: add delete symbol library code to schematic legacy plugin.
2016-10-09 12:29:44 +00:00
bool DeleteSymbolLib( const wxString& aLibraryPath,
const PROPERTIES* aProperties = NULL ) override;
Make the schematic I/O plugin the only option. Add SCH_PLUGIN object to PART_LIB object. Convert all PART_LIB I/O to use SCH_PLUGIN. Remove library caching from PART_LIB and use caching provided by SCH_PLUGIN. Add support to use PROPERTIES for buffering and document file write control instead of adding code the SCH_PLUGIN object in the SCH_LEGACY_PLUGIN that will not be required when the new file formats are implemented. Add buffering to SCH_LEGACY_PLUGIN to prevent cache from writing file on every change to library. This is to prevent the cache library from being written every time a new symbol is added. Add option to not save library document file when saving library. This is primarily used by the cache library write code. Move symbol library write code out of LIB_PART and into SCH_LEGACY_PLUGIN. Add exception handling where LIB_PART caught the exception and returned an error status. Remove KICAD_SCH_IO_MANAGER build option as it is no longer optional.
2017-01-27 15:56:36 +00:00
void SaveLibrary( const wxString& aLibraryPath, const PROPERTIES* aProperties = NULL ) override;
Eeschema: initial schematic I/O plugin. * Factor out PROPERTIES object from the PCB plugin code and move it into common so it can be used by both the Pcbnew and Eeschema plugins. * Add schematic I/O plugin manager for loading and saving schematic and component library files. * Add initial attempt at a parser for current schematic file format. This parser will be infinitely more strict than the current parser which is very forgiving in what it parses. * Make minor changes to the base bitmap class to support the new parser. * Add find root sheet support to sheet object to allow fetching the root sheet from any sheet in the stack.
2016-07-06 09:22:56 +00:00
eeschema: Iterate through plugins when determining file format.
2017-06-26 11:13:43 +00:00
bool CheckHeader( const wxString& aFileName ) override;
Convert symbol library editor over to use symbol library table. Simplify some of the library editing code. There have been a few minor changes in the behavior of the editor. If the current symbol is deleted from the library, the next symbol in the library is not loaded. The deleted symbol is cleared and the current symbol is empty. Change component to symbol to align with the preferred terminology discussed on the developer's mailing list. Add separate update UI event for save library as to enable the menu entry whenever a library is selected. Change the select symbol list dialog to a single column using the LIB_ID format LIB_NICKNAME:LIB_ITEM_NAME so that the selection can be parsed by LIB_ID. Add method to expand URI to LIB_TABLE_BASE. Override wxApp::OnExceptionInMainLoop() in debug builds to make debugging easier when an unhandled exception occurs in a wxUpdateUIEvent handler. Change SCH_SCREENS::HasNoFullyDefinedLibIds() to return false when the schematic has no symbols to prevent the remapping dialog from being run. Use SCH_COMPONENT part reference when creating netlist rather than looking up the library symbol.
2017-10-06 18:07:43 +00:00
bool IsSymbolLibWritable( const wxString& aLibraryPath ) override;
Eeschema: Add CheckHeader function to SCH_PLUGIN and cycle through plugins when loading files.
2017-06-21 12:41:00 +00:00
Eeschema: allow for partial schematic loading. With the implementation of the legacy schematic plugin, any I/O error when parsing the schematics would prevent the entire schematic from being loaded. This change restores (somewhat) the previous behavior where as long as the root schematic is loaded properly, then all of the remaining sub-sheet will attempt to load. Add GetError() method the SCH_PLUGIN object to allow for partial schematic loading. Check the error message contents when no exception was caught to warn the user of any accumulated errors. Fixes lp:1690644 https://bugs.launchpad.net/kicad/+bug/1690644
2017-12-07 00:10:45 +00:00
const wxString& GetError() const override { return m_error; }
Fix coding policy violations of previous patch.
2019-03-15 13:09:42 +00:00
static LIB_PART * ParsePart( LINE_READER& reader, int aMajorVersion = 0,
int aMinorVersion = 0 );
static void FormatPart( LIB_PART* part, OUTPUTFORMATTER& formatter );
Eeschema: allow for partial schematic loading. With the implementation of the legacy schematic plugin, any I/O error when parsing the schematics would prevent the entire schematic from being loaded. This change restores (somewhat) the previous behavior where as long as the root schematic is loaded properly, then all of the remaining sub-sheet will attempt to load. Add GetError() method the SCH_PLUGIN object to allow for partial schematic loading. Check the error message contents when no exception was caught to warn the user of any accumulated errors. Fixes lp:1690644 https://bugs.launchpad.net/kicad/+bug/1690644
2017-12-07 00:10:45 +00:00
Eeschema: initial schematic I/O plugin. * Factor out PROPERTIES object from the PCB plugin code and move it into common so it can be used by both the Pcbnew and Eeschema plugins. * Add schematic I/O plugin manager for loading and saving schematic and component library files. * Add initial attempt at a parser for current schematic file format. This parser will be infinitely more strict than the current parser which is very forgiving in what it parses. * Make minor changes to the base bitmap class to support the new parser. * Add find root sheet support to sheet object to allow fetching the root sheet from any sheet in the stack.
2016-07-06 09:22:56 +00:00
private:
void loadHierarchy( SCH_SHEET* aSheet );
void loadHeader( FILE_LINE_READER& aReader, SCH_SCREEN* aScreen );
void loadPageSettings( FILE_LINE_READER& aReader, SCH_SCREEN* aScreen );
void loadFile( const wxString& aFileName, SCH_SCREEN* aScreen );
SCH_SHEET* loadSheet( FILE_LINE_READER& aReader );
SCH_BITMAP* loadBitmap( FILE_LINE_READER& aReader );
SCH_JUNCTION* loadJunction( FILE_LINE_READER& aReader );
SCH_NO_CONNECT* loadNoConnect( FILE_LINE_READER& aReader );
SCH_LINE* loadWire( FILE_LINE_READER& aReader );
SCH_BUS_ENTRY_BASE* loadBusEntry( FILE_LINE_READER& aReader );
SCH_TEXT* loadText( FILE_LINE_READER& aReader );
SCH_COMPONENT* loadComponent( FILE_LINE_READER& aReader );
New connectivity algorithm and bus upgrades Bus upgrades: core new connectivity code Bus upgrades: eeschema integration and modifications Bus upgrades: eeschema dialogs Bus upgrades: netlist export Bus upgrades: file format changes
2019-03-11 21:32:05 +00:00
std::shared_ptr< BUS_ALIAS > loadBusAlias( FILE_LINE_READER& aReader, SCH_SCREEN* aScreen );
Eeschema: initial schematic I/O plugin. * Factor out PROPERTIES object from the PCB plugin code and move it into common so it can be used by both the Pcbnew and Eeschema plugins. * Add schematic I/O plugin manager for loading and saving schematic and component library files. * Add initial attempt at a parser for current schematic file format. This parser will be infinitely more strict than the current parser which is very forgiving in what it parses. * Make minor changes to the base bitmap class to support the new parser. * Add find root sheet support to sheet object to allow fetching the root sheet from any sheet in the stack.
2016-07-06 09:22:56 +00:00
Eeschema: add saving schematic files to schematic plugin. * Add SCH_PLUGIN::Save() for current file format and code for saving all SCH_XXX objects. * Add function to SCH_FIELD to get the position of the field in the component not the position added to the component position which is what GetPosition() does. This was required because saving the component field expects position of the field sans the position of the component. * Remove public members from BITMAP_BASE object and fix all associated code. * Fix the never ending coding policy violations found making these changes.
2016-07-11 19:48:46 +00:00
void saveComponent( SCH_COMPONENT* aComponent );
void saveField( SCH_FIELD* aField );
void saveBitmap( SCH_BITMAP* aBitmap );
void saveSheet( SCH_SHEET* aSheet );
void saveJunction( SCH_JUNCTION* aJunction );
void saveNoConnect( SCH_NO_CONNECT* aNoConnect );
void saveBusEntry( SCH_BUS_ENTRY_BASE* aBusEntry );
void saveLine( SCH_LINE* aLine );
void saveText( SCH_TEXT* aText );
New connectivity algorithm and bus upgrades Bus upgrades: core new connectivity code Bus upgrades: eeschema integration and modifications Bus upgrades: eeschema dialogs Bus upgrades: netlist export Bus upgrades: file format changes
2019-03-11 21:32:05 +00:00
void saveBusAlias( std::shared_ptr< BUS_ALIAS > aAlias );
Eeschema: initial schematic I/O plugin. * Factor out PROPERTIES object from the PCB plugin code and move it into common so it can be used by both the Pcbnew and Eeschema plugins. * Add schematic I/O plugin manager for loading and saving schematic and component library files. * Add initial attempt at a parser for current schematic file format. This parser will be infinitely more strict than the current parser which is very forgiving in what it parses. * Make minor changes to the base bitmap class to support the new parser. * Add find root sheet support to sheet object to allow fetching the root sheet from any sheet in the stack.
2016-07-06 09:22:56 +00:00
Eeschema: implement schematic I/O plugin symbol library parser. * Write SCH_LEGACY_PLUGIN_CACHE object for handling the legacy symbol library file format. * Write legacy symbol library file parser. * Write code to transfer cache to PART_LIB object so existing library save code can be used for round trip testing. This is temporary until Eeschema is updated to use the plugin for library management rather than PART_LIB. * Add LIB_XXXX object helper functions where there was no way to set the member variables of an object. * Give the cache object friend status to some object where there are incredibly byzantine ways of setting text in LIB_XXXX objects.
2016-08-18 23:23:10 +00:00
void cacheLib( const wxString& aLibraryFileName );
Make the schematic I/O plugin the only option. Add SCH_PLUGIN object to PART_LIB object. Convert all PART_LIB I/O to use SCH_PLUGIN. Remove library caching from PART_LIB and use caching provided by SCH_PLUGIN. Add support to use PROPERTIES for buffering and document file write control instead of adding code the SCH_PLUGIN object in the SCH_LEGACY_PLUGIN that will not be required when the new file formats are implemented. Add buffering to SCH_LEGACY_PLUGIN to prevent cache from writing file on every change to library. This is to prevent the cache library from being written every time a new symbol is added. Add option to not save library document file when saving library. This is primarily used by the cache library write code. Move symbol library write code out of LIB_PART and into SCH_LEGACY_PLUGIN. Add exception handling where LIB_PART caught the exception and returned an error status. Remove KICAD_SCH_IO_MANAGER build option as it is no longer optional.
2017-01-27 15:56:36 +00:00
bool writeDocFile( const PROPERTIES* aProperties );
bool isBuffering( const PROPERTIES* aProperties );
Eeschema: implement schematic I/O plugin symbol library parser. * Write SCH_LEGACY_PLUGIN_CACHE object for handling the legacy symbol library file format. * Write legacy symbol library file parser. * Write code to transfer cache to PART_LIB object so existing library save code can be used for round trip testing. This is temporary until Eeschema is updated to use the plugin for library management rather than PART_LIB. * Add LIB_XXXX object helper functions where there was no way to set the member variables of an object. * Give the cache object friend status to some object where there are incredibly byzantine ways of setting text in LIB_XXXX objects.
2016-08-18 23:23:10 +00:00
Eeschema: add saving schematic files to schematic plugin. * Add SCH_PLUGIN::Save() for current file format and code for saving all SCH_XXX objects. * Add function to SCH_FIELD to get the position of the field in the component not the position added to the component position which is what GetPosition() does. This was required because saving the component field expects position of the field sans the position of the component. * Remove public members from BITMAP_BASE object and fix all associated code. * Fix the never ending coding policy violations found making these changes.
2016-07-11 19:48:46 +00:00
protected:
Eeschema: initial schematic I/O plugin. * Factor out PROPERTIES object from the PCB plugin code and move it into common so it can be used by both the Pcbnew and Eeschema plugins. * Add schematic I/O plugin manager for loading and saving schematic and component library files. * Add initial attempt at a parser for current schematic file format. This parser will be infinitely more strict than the current parser which is very forgiving in what it parses. * Make minor changes to the base bitmap class to support the new parser. * Add find root sheet support to sheet object to allow fetching the root sheet from any sheet in the stack.
2016-07-06 09:22:56 +00:00
int m_version; ///< Version of file being loaded.
Eeschema: allow for partial schematic loading. With the implementation of the legacy schematic plugin, any I/O error when parsing the schematics would prevent the entire schematic from being loaded. This change restores (somewhat) the previous behavior where as long as the root schematic is loaded properly, then all of the remaining sub-sheet will attempt to load. Add GetError() method the SCH_PLUGIN object to allow for partial schematic loading. Check the error message contents when no exception was caught to warn the user of any accumulated errors. Fixes lp:1690644 https://bugs.launchpad.net/kicad/+bug/1690644
2017-12-07 00:10:45 +00:00
/** For throwing exceptions or errors on partial schematic loads. */
wxString m_error;
Eeschema: initial schematic I/O plugin. * Factor out PROPERTIES object from the PCB plugin code and move it into common so it can be used by both the Pcbnew and Eeschema plugins. * Add schematic I/O plugin manager for loading and saving schematic and component library files. * Add initial attempt at a parser for current schematic file format. This parser will be infinitely more strict than the current parser which is very forgiving in what it parses. * Make minor changes to the base bitmap class to support the new parser. * Add find root sheet support to sheet object to allow fetching the root sheet from any sheet in the stack.
2016-07-06 09:22:56 +00:00
wxString m_path; ///< Root project path for loading child sheets.
SCH_LEGACY_PLUGIN::loadHierarchy() uses a stack to maintain sheet paths Path keeping stack copes well with paths pointing outside the project directory (e.g. "../path"). The so far used wxFileName::GetDirCount() and wxFileName::RemoveLastDir() remove too many directories, as ".." is also counted as a directory. Fixes: lp:1769746 * https://bugs.launchpad.net/kicad/+bug/1769746
2018-05-09 09:15:00 +00:00
std::stack<wxString> m_currentPath; ///< Stack to maintain nested sheet paths
Eeschema: initial schematic I/O plugin. * Factor out PROPERTIES object from the PCB plugin code and move it into common so it can be used by both the Pcbnew and Eeschema plugins. * Add schematic I/O plugin manager for loading and saving schematic and component library files. * Add initial attempt at a parser for current schematic file format. This parser will be infinitely more strict than the current parser which is very forgiving in what it parses. * Make minor changes to the base bitmap class to support the new parser. * Add find root sheet support to sheet object to allow fetching the root sheet from any sheet in the stack.
2016-07-06 09:22:56 +00:00
const PROPERTIES* m_props; ///< Passed via Save() or Load(), no ownership, may be NULL.
KIWAY* m_kiway; ///< Required for path to legacy component libraries.
SCH_SHEET* m_rootSheet; ///< The root sheet of the schematic being loaded..
Eeschema: add saving schematic files to schematic plugin. * Add SCH_PLUGIN::Save() for current file format and code for saving all SCH_XXX objects. * Add function to SCH_FIELD to get the position of the field in the component not the position added to the component position which is what GetPosition() does. This was required because saving the component field expects position of the field sans the position of the component. * Remove public members from BITMAP_BASE object and fix all associated code. * Fix the never ending coding policy violations found making these changes.
2016-07-11 19:48:46 +00:00
FILE_OUTPUTFORMATTER* m_out; ///< The output formatter for saving SCH_SCREEN objects.
Eeschema: implement schematic I/O plugin symbol library parser. * Write SCH_LEGACY_PLUGIN_CACHE object for handling the legacy symbol library file format. * Write legacy symbol library file parser. * Write code to transfer cache to PART_LIB object so existing library save code can be used for round trip testing. This is temporary until Eeschema is updated to use the plugin for library management rather than PART_LIB. * Add LIB_XXXX object helper functions where there was no way to set the member variables of an object. * Give the cache object friend status to some object where there are incredibly byzantine ways of setting text in LIB_XXXX objects.
2016-08-18 23:23:10 +00:00
SCH_LEGACY_PLUGIN_CACHE* m_cache;
Eeschema: initial schematic I/O plugin. * Factor out PROPERTIES object from the PCB plugin code and move it into common so it can be used by both the Pcbnew and Eeschema plugins. * Add schematic I/O plugin manager for loading and saving schematic and component library files. * Add initial attempt at a parser for current schematic file format. This parser will be infinitely more strict than the current parser which is very forgiving in what it parses. * Make minor changes to the base bitmap class to support the new parser. * Add find root sheet support to sheet object to allow fetching the root sheet from any sheet in the stack.
2016-07-06 09:22:56 +00:00
/// initialize PLUGIN like a constructor would.
void init( KIWAY* aKiway, const PROPERTIES* aProperties = NULL );
};
#endif // _SCH_LEGACY_PLUGIN_H_