KiCad PCB EDA Suite
Loading...
Searching...
No Matches
pcb_easyeda_plugin.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 (C) 2023 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, you may find one here:
19 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20 * or you may search the http://www.gnu.org website for the version 2 license,
21 * or you may write to the Free Software Foundation, Inc.,
22 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23 */
24
25#ifndef PCB_EASYEDA_PLUGIN_H_
26#define PCB_EASYEDA_PLUGIN_H_
27
28#include <io_mgr.h>
29#include <footprint.h>
30
31
32class EASYEDA_PLUGIN : public PLUGIN
33{
34public:
35 const wxString PluginName() const override
36 {
37 return wxS( "EasyEDA (JLCEDA) Standard" );
38 }
39
41 {
42 return PLUGIN_FILE_DESC( _HKI( "EasyEDA (JLCEDA) Std files" ), { "json", "zip" } );
43 }
44
46
48
49 bool CanReadBoard( const wxString& aFileName ) const override;
50
51 bool CanReadFootprint( const wxString& aFileName ) const override;
52
53 bool CanReadFootprintLib( const wxString& aFileName ) const override;
54
55 BOARD* LoadBoard( const wxString& aFileName, BOARD* aAppendToMe,
56 const STRING_UTF8_MAP* aProperties = nullptr, PROJECT* aProject = nullptr,
57 PROGRESS_REPORTER* aProgressReporter = nullptr ) override;
58
59 long long GetLibraryTimestamp( const wxString& aLibraryPath ) const override;
60
61 void FootprintEnumerate( wxArrayString& aFootprintNames, const wxString& aLibraryPath,
62 bool aBestEfforts,
63 const STRING_UTF8_MAP* aProperties = nullptr ) override;
64
65 std::vector<FOOTPRINT*> GetImportedCachedLibraryFootprints() override;
66
67 FOOTPRINT* FootprintLoad( const wxString& aLibraryPath, const wxString& aFootprintName,
68 bool aKeepUUID = false,
69 const STRING_UTF8_MAP* aProperties = nullptr ) override;
70
71 bool IsFootprintLibWritable( const wxString& aLibraryPath ) override { return false; }
72
75
76private:
79
80 std::map<wxString, std::unique_ptr<FOOTPRINT>> m_loadedFootprints;
81};
82
83
84#endif // PCB_EASYEDA_PLUGIN_H_
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:276
const wxString PluginName() const override
Return a brief hard coded name for this PLUGIN.
bool CanReadFootprintLib(const wxString &aFileName) const override
Checks if this PLUGIN can read footprint library from specified file or directory.
PLUGIN_FILE_DESC GetBoardFileDesc() const override
Returns board file description for the PLUGIN.
bool IsFootprintLibWritable(const wxString &aLibraryPath) override
Return true if the library at aLibraryPath is writable.
FOOTPRINT * FootprintLoad(const wxString &aLibraryPath, const wxString &aFootprintName, bool aKeepUUID=false, const STRING_UTF8_MAP *aProperties=nullptr) override
Load a footprint having aFootprintName from the aLibraryPath containing a library format that this PL...
const STRING_UTF8_MAP * m_props
PLUGIN_FILE_DESC GetFootprintFileDesc() const override
Returns footprint file description for the PLUGIN.
BOARD * LoadBoard(const wxString &aFileName, BOARD *aAppendToMe, const STRING_UTF8_MAP *aProperties=nullptr, PROJECT *aProject=nullptr, PROGRESS_REPORTER *aProgressReporter=nullptr) override
Load information from some input file format that this PLUGIN implementation knows about into either ...
long long GetLibraryTimestamp(const wxString &aLibraryPath) const override
Generate a timestamp representing all the files in the library (including the library directory).
std::map< wxString, std::unique_ptr< FOOTPRINT > > m_loadedFootprints
bool CanReadBoard(const wxString &aFileName) const override
Checks if this PLUGIN can read the specified board file.
void FootprintEnumerate(wxArrayString &aFootprintNames, const wxString &aLibraryPath, bool aBestEfforts, const STRING_UTF8_MAP *aProperties=nullptr) override
Return a list of footprint names contained within the library at aLibraryPath.
std::vector< FOOTPRINT * > GetImportedCachedLibraryFootprints() override
Return a container with the cached library footprints generated in the last call to Load.
PLUGIN_FILE_DESC GetFootprintLibDesc() const override
Returns footprint library description for the PLUGIN.
bool CanReadFootprint(const wxString &aFileName) const override
Checks if this PLUGIN can read a footprint from specified file or directory.
A base class that BOARD loading and saving plugins should derive from.
Definition: io_mgr.h:272
A progress reporter interface for use in multi-threaded environments.
Container for project specific data.
Definition: project.h:62
A name/value tuple with unique names and optional values.
#define _HKI(x)
Container that describes file type info.