KiCad PCB EDA Suite
Loading...
Searching...
No Matches
sch_io_easyedapro.h
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright (C) 2023 Alex Shvartzkop <[email protected]>
5 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
6 *
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version 2
10 * of the License, or (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program. If not, see <https://www.gnu.org/licenses/>.
19 */
20
21#ifndef SCH_IO_EASYEDAPRO_H_
22#define SCH_IO_EASYEDAPRO_H_
23
24#include <sch_io/sch_io.h>
25#include <sch_io/sch_io_mgr.h>
26#include <reporter.h>
28
29
30class SCH_SHEET;
31class SCH_SCREEN;
32
33
35{
36public:
39
41 {
42 return IO_BASE::IO_FILE_DESC( _HKI( "EasyEDA (JLCEDA) Pro files" ), { "epro", "zip" } );
43 }
44
46 {
47 return IO_BASE::IO_FILE_DESC( _HKI( "EasyEDA (JLCEDA) Pro files" ), { "elibz", "epro", "zip" } );
48 }
49
50 bool CanReadSchematicFile( const wxString& aFileName ) const override;
51
52 int GetModifyHash() const override;
53
54 SCH_SHEET* LoadSchematicFile( const wxString& aFileName, SCHEMATIC* aSchematic,
55 SCH_SHEET* aAppendToMe = nullptr,
56 const std::map<std::string, UTF8>* aProperties = nullptr ) override;
57
58 std::vector<LIB_SYMBOL*> GetImportedCachedLibrarySymbols() override;
59
60 void EnumerateSymbolLib( wxArrayString& aSymbolNameList, const wxString& aLibraryPath,
61 const std::map<std::string, UTF8>* aProperties = nullptr ) override;
62
63 void EnumerateSymbolLib( std::vector<LIB_SYMBOL*>& aSymbolList, const wxString& aLibraryPath,
64 const std::map<std::string, UTF8>* aProperties = nullptr ) override;
65
66 void LoadAllDataFromProject( const wxString& aLibraryPath );
67
68 LIB_SYMBOL* LoadSymbol( const wxString& aLibraryPath, const wxString& aAliasName,
69 const std::map<std::string, UTF8>* aProperties = nullptr ) override;
70
71 bool IsLibraryWritable( const wxString& aLibraryPath ) override { return false; }
72
73private:
74 struct PRJ_DATA; // Opaque data structure
76
78 std::vector<std::unique_ptr<LIB_SYMBOL>> m_importedLibSymbols;
79};
80
81
82#endif // SCH_IO_EASYEDAPRO_H_
Define a library symbol object.
Definition lib_symbol.h:114
Plugin class for import plugins that support choosing a project.
Holds all the data relating to one schematic.
Definition schematic.h:90
const IO_BASE::IO_FILE_DESC GetSchematicFileDesc() const override
Returns schematic file description for the SCH_IO.
std::vector< LIB_SYMBOL * > GetImportedCachedLibrarySymbols() override
Return the canonical symbol definitions produced by the last LoadSchematicFile().
void LoadAllDataFromProject(const wxString &aLibraryPath)
LIB_SYMBOL * LoadSymbol(const wxString &aLibraryPath, const wxString &aAliasName, const std::map< std::string, UTF8 > *aProperties=nullptr) override
Load a LIB_SYMBOL object having aPartName from the aLibraryPath containing a library format that this...
int GetModifyHash() const override
Return the modification hash from the library cache.
std::vector< std::unique_ptr< LIB_SYMBOL > > m_importedLibSymbols
Definitions from the last LoadSchematicFile, cloned out to the import reconciler on request.
void EnumerateSymbolLib(wxArrayString &aSymbolNameList, const wxString &aLibraryPath, const std::map< std::string, UTF8 > *aProperties=nullptr) override
Populate a list of LIB_SYMBOL alias names contained within the library aLibraryPath.
bool CanReadSchematicFile(const wxString &aFileName) const override
Checks if this SCH_IO can read the specified schematic file.
bool IsLibraryWritable(const wxString &aLibraryPath) override
Return true if the library at aLibraryPath is writable.
const IO_BASE::IO_FILE_DESC GetLibraryDesc() const override
Get the descriptor for the library container that this IO plugin operates on.
SCH_SHEET * LoadSchematicFile(const wxString &aFileName, SCHEMATIC *aSchematic, SCH_SHEET *aAppendToMe=nullptr, const std::map< std::string, UTF8 > *aProperties=nullptr) override
Load information from some input file format that this SCH_IO implementation knows about,...
SCH_IO(const wxString &aName)
Definition sch_io.h:384
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition sch_sheet.h:44
#define _HKI(x)
Definition page_info.cpp:40
Container that describes file type info.
Definition io_base.h:43