sch_io.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2016 CERN
 * Copyright (C) 2016-2024 KiCad Developers, see AUTHORS.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 3
 * 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/>.
 */
 
#ifndef SCH_IO_H_
#define SCH_IO_H_
 
#include <io/io_base.h>
#include <sch_io/sch_io_mgr.h>
#include <import_export.h>
#include <map>
#include <enum_vector.h>
#include <reporter.h>
#include <i18n_utility.h>
#include <wx/arrstr.h>
 
class SCH_IO : public IO_BASE
{
public:
 
 //-----<PUBLIC SCH_IO API>-------------------------------------------------
 
 virtual const IO_BASE::IO_FILE_DESC GetSchematicFileDesc() const;
 
 virtual bool CanReadSchematicFile( const wxString& aFileName ) const;
 
 virtual int GetModifyHash() const = 0;
 
 virtual void SaveLibrary( const wxString& aFileName,
 const STRING_UTF8_MAP* aProperties = nullptr );
 
 virtual SCH_SHEET* LoadSchematicFile( const wxString& aFileName, SCHEMATIC* aSchematic,
 SCH_SHEET* aAppendToMe = nullptr,
 const STRING_UTF8_MAP* aProperties = nullptr );
 
 virtual void SaveSchematicFile( const wxString& aFileName, SCH_SHEET* aSheet,
 SCHEMATIC* aSchematic,
 const STRING_UTF8_MAP* aProperties = nullptr );
 
 virtual void EnumerateSymbolLib( wxArrayString& aSymbolNameList, const wxString& aLibraryPath,
 const STRING_UTF8_MAP* aProperties = nullptr );
 
 virtual void EnumerateSymbolLib( std::vector<LIB_SYMBOL*>& aSymbolList,
 const wxString& aLibraryPath,
 const STRING_UTF8_MAP* aProperties = nullptr );
 
 virtual LIB_SYMBOL* LoadSymbol( const wxString& aLibraryPath, const wxString& aPartName,
 const STRING_UTF8_MAP* aProperties = nullptr );
 
 virtual void SaveSymbol( const wxString& aLibraryPath, const LIB_SYMBOL* aSymbol,
 const STRING_UTF8_MAP* aProperties = nullptr );
 
 virtual void DeleteSymbol( const wxString& aLibraryPath, const wxString& aSymbolName,
 const STRING_UTF8_MAP* aProperties = nullptr );
 
 virtual void GetLibraryOptions( STRING_UTF8_MAP* aListToAppendTo ) const override;
 
 virtual bool SupportsSubLibraries() const { return false; }
 
 virtual void GetSubLibraryNames( std::vector<wxString>& aNames ) {}
 
 virtual void GetAvailableSymbolFields( std::vector<wxString>& aNames ) {}
 
 virtual void GetDefaultSymbolFields( std::vector<wxString>& aNames )
 {
 return GetAvailableSymbolFields( aNames );
 }
 
 virtual const wxString& GetError() const;
 
 virtual void SetLibTable( SYMBOL_LIB_TABLE* aTable ) {}
 
 //-----</PUBLIC SCH_IO API>------------------------------------------------
 
 
 /* The compiler writes the "zero argument" constructor for a SCH_IO
 automatically if you do not provide one. If you decide you need to
 provide a zero argument constructor of your own design, that is allowed.
 It must be public, and it is what the SCH_IO_MGR uses. Parameters may be
 passed into a SCH_IO via the PROPERTIES variable for any of the public
 API functions which take one.
 */
 virtual ~SCH_IO() { }
 
protected:
 
 SCH_IO( const wxString& aName ) : IO_BASE( aName )
 {}
};
 
 
#endif // SCH_IO_H_