sch_legacy_plugin.h

Go to the documentation of this file.

#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
 * Copyright (C) 2016-2021 KiCad Developers, see change_log.txt for contributors.
 *
 * @author Wayne Stambaugh <[email protected]>
 *
 * 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/>.
 */

#include <memory>
#include <sch_io_mgr.h>
#include <stack>
#include <general.h> // for EESCHEMA_VERSION definition


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_SYMBOL;
class SCH_FIELD;
class PROPERTIES;
class SELECTION;
class SCH_LEGACY_PLUGIN_CACHE;
class LIB_SYMBOL;
class SYMBOL_LIB;
class BUS_ALIAS;


class SCH_LEGACY_PLUGIN : public SCH_PLUGIN
{
public:

 SCH_LEGACY_PLUGIN();
 virtual ~SCH_LEGACY_PLUGIN();

 const wxString GetName() const override
 {
 return wxT( "Eeschema-Legacy" );
 }

 const wxString GetFileExtension() const override
 {
 return wxT( "sch" );
 }

 const wxString GetLibraryFileExtension() const override
 {
 return wxT( "lib" );
 }

 void SetProgressReporter( PROGRESS_REPORTER* aReporter ) override
 {
 m_progressReporter = aReporter;
 }

 static const char* PropBuffering;

 static const char* PropNoDocFile;

 int GetModifyHash() const override;

 SCH_SHEET* Load( const wxString& aFileName, SCHEMATIC* aSchematic,
 SCH_SHEET* aAppendToMe = nullptr,
 const PROPERTIES* aProperties = nullptr ) override;

 void LoadContent( LINE_READER& aReader, SCH_SCREEN* aScreen,
 int version = EESCHEMA_VERSION );

 void Save( const wxString& aFileName, SCH_SHEET* aScreen, SCHEMATIC* aSchematic,
 const PROPERTIES* aProperties = nullptr ) override;

 void Format( SCH_SHEET* aSheet );

 void Format( SELECTION* aSelection, OUTPUTFORMATTER* aFormatter );

 void EnumerateSymbolLib( wxArrayString& aSymbolNameList,
 const wxString& aLibraryPath,
 const PROPERTIES* aProperties = nullptr ) override;
 void EnumerateSymbolLib( std::vector<LIB_SYMBOL*>& aSymbolList,
 const wxString& aLibraryPath,
 const PROPERTIES* aProperties = nullptr ) override;
 LIB_SYMBOL* LoadSymbol( const wxString& aLibraryPath, const wxString& aAliasName,
 const PROPERTIES* aProperties = nullptr ) override;
 void SaveSymbol( const wxString& aLibraryPath, const LIB_SYMBOL* aSymbol,
 const PROPERTIES* aProperties = nullptr ) override;
 void DeleteSymbol( const wxString& aLibraryPath, const wxString& aSymbolName,
 const PROPERTIES* aProperties = nullptr ) override;
 void CreateSymbolLib( const wxString& aLibraryPath,
 const PROPERTIES* aProperties = nullptr ) override;
 bool DeleteSymbolLib( const wxString& aLibraryPath,
 const PROPERTIES* aProperties = nullptr ) override;
 void SaveLibrary( const wxString& aLibraryPath,
 const PROPERTIES* aProperties = nullptr ) override;

 bool CheckHeader( const wxString& aFileName ) override;
 bool IsSymbolLibWritable( const wxString& aLibraryPath ) override;

 const wxString& GetError() const override { return m_error; }

 static LIB_SYMBOL* ParsePart( LINE_READER& aReader, int majorVersion = 0,
 int minorVersion = 0 );
 static void FormatPart( LIB_SYMBOL* aSymbol, OUTPUTFORMATTER& aFormatter );

private:
 void checkpoint();
 void loadHierarchy( SCH_SHEET* aSheet );
 void loadHeader( LINE_READER& aReader, SCH_SCREEN* aScreen );
 void loadPageSettings( LINE_READER& aReader, SCH_SCREEN* aScreen );
 void loadFile( const wxString& aFileName, SCH_SCREEN* aScreen );
 SCH_SHEET* loadSheet( LINE_READER& aReader );
 SCH_BITMAP* loadBitmap( LINE_READER& aReader );
 SCH_JUNCTION* loadJunction( LINE_READER& aReader );
 SCH_NO_CONNECT* loadNoConnect( LINE_READER& aReader );
 SCH_LINE* loadWire( LINE_READER& aReader );
 SCH_BUS_ENTRY_BASE* loadBusEntry( LINE_READER& aReader );
 SCH_TEXT* loadText( LINE_READER& aReader );
 SCH_SYMBOL* loadSymbol( LINE_READER& aReader );
 std::shared_ptr<BUS_ALIAS> loadBusAlias( LINE_READER& aReader, SCH_SCREEN* aScreen );

 void saveSymbol( SCH_SYMBOL* aSymbol );
 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 );
 void saveBusAlias( std::shared_ptr<BUS_ALIAS> aAlias );

 void cacheLib( const wxString& aLibraryFileName, const PROPERTIES* aProperties );
 bool writeDocFile( const PROPERTIES* aProperties );
 bool isBuffering( const PROPERTIES* aProperties );

protected:
 int m_version; 

 wxString m_error; 
 PROGRESS_REPORTER* m_progressReporter; 
 LINE_READER* m_lineReader; 
 unsigned m_lastProgressLine;
 unsigned m_lineCount; 

 wxString m_path; 
 std::stack<wxString> m_currentPath; 
 SCH_SHEET* m_rootSheet; 
 OUTPUTFORMATTER* m_out; 
 SCH_LEGACY_PLUGIN_CACHE* m_cache;
 SCHEMATIC* m_schematic;

 void init( SCHEMATIC* aSchematic, const PROPERTIES* aProperties = nullptr );
};

#endif // _SCH_LEGACY_PLUGIN_H_