KiCad PCB EDA Suite
symbol_lib_table.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) 2016 Wayne Stambaugh <[email protected]>
5 * Copyright (C) 2016-2021 KiCad Developers, see change_log.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 _SYMBOL_LIB_TABLE_H_
26#define _SYMBOL_LIB_TABLE_H_
27
28#include <lib_table_base.h>
29#include <sch_io_mgr.h>
30#include <lib_id.h>
31
32//class LIB_SYMBOL;
34class DIALOG_SYMBOL_LIB_TABLE;
35
36
42{
43public:
44 typedef SCH_IO_MGR::SCH_FILE_T LIB_T;
45
46 SYMBOL_LIB_TABLE_ROW( const wxString& aNick, const wxString& aURI, const wxString& aType,
47 const wxString& aOptions = wxEmptyString,
48 const wxString& aDescr = wxEmptyString ) :
49 LIB_TABLE_ROW( aNick, aURI, aOptions, aDescr )
50 {
51 SetType( aType );
52 SetEnabled( true );
53 }
54
56 type( SCH_IO_MGR::SCH_KICAD )
57 {
58 SetEnabled( true );
59 }
60
61 bool operator==( const SYMBOL_LIB_TABLE_ROW& aRow ) const;
62
63 bool operator!=( const SYMBOL_LIB_TABLE_ROW& aRow ) const { return !( *this == aRow ); }
64
68 const wxString GetType() const override { return SCH_IO_MGR::ShowType( type ); }
69
73 void SetType( const wxString& aType ) override;
74
81 bool Refresh();
82
83 bool SupportsSubLibraries() const { return plugin ? plugin->SupportsSubLibraries() : false; }
84
85 void GetSubLibraryNames( std::vector<wxString>& aNames ) const;
86
90 void GetAvailableSymbolFields( std::vector<wxString>& aNames ) const
91 {
92 if( plugin )
94 }
95
99 void GetDefaultSymbolFields( std::vector<wxString>& aNames ) const
100 {
101 if( plugin )
103 }
104
105protected:
107 LIB_TABLE_ROW( aRow ),
108 type( aRow.type )
109 {
110 SetEnabled( aRow.GetIsEnabled() );
111 }
112
113private:
114 friend class SYMBOL_LIB_TABLE;
115
116 virtual LIB_TABLE_ROW* do_clone() const override
117 {
118 return new SYMBOL_LIB_TABLE_ROW( *this );
119 }
120
121 void setPlugin( SCH_PLUGIN* aPlugin )
122 {
123 plugin.set( aPlugin );
124 }
125
128};
129
130
132{
133public:
134 KICAD_T Type() override { return SYMBOL_LIB_TABLE_T; }
135
136 static const char* PropPowerSymsOnly;
137 static const char* PropNonPowerSymsOnly;
138
139 virtual void Parse( LIB_TABLE_LEXER* aLexer ) override;
140
141 virtual void Format( OUTPUTFORMATTER* aOutput, int aIndentLevel ) const override;
142
151 SYMBOL_LIB_TABLE( SYMBOL_LIB_TABLE* aFallBackTable = nullptr );
152
164 SYMBOL_LIB_TABLE_ROW* FindRow( const wxString& aNickName, bool aCheckIfEnabled = false );
165
166 int GetModifyHash();
167
168 //-----<PLUGIN API SUBSET, REBASED ON aNickname>---------------------------
169
178 void EnumerateSymbolLib( const wxString& aNickname, wxArrayString& aAliasNames,
179 bool aPowerSymbolsOnly = false );
180
181 void LoadSymbolLib( std::vector<LIB_SYMBOL*>& aAliasList, const wxString& aNickname,
182 bool aPowerSymbolsOnly = false );
183
194 LIB_SYMBOL* LoadSymbol( const wxString& aNickname, const wxString& aName );
195
196 LIB_SYMBOL* LoadSymbol( const LIB_ID& aLibId )
197 {
198 return LoadSymbol( aLibId.GetLibNickname(), aLibId.GetLibItemName() );
199 }
200
205 {
208 };
209
226 SAVE_T SaveSymbol( const wxString& aNickname, const LIB_SYMBOL* aSymbol,
227 bool aOverwrite = true );
228
236 void DeleteSymbol( const wxString& aNickname, const wxString& aSymbolName );
237
247 bool IsSymbolLibWritable( const wxString& aNickname );
248
255 bool IsSymbolLibLoaded( const wxString& aNickname );
256
257 void DeleteSymbolLib( const wxString& aNickname );
258
259 void CreateSymbolLib( const wxString& aNickname );
260
261 //-----</PLUGIN API SUBSET, REBASED ON aNickname>---------------------------
262
273
285 static bool LoadGlobalTable( SYMBOL_LIB_TABLE& aTable );
286
293 static wxString GetGlobalTableFileName();
294
303 static const wxString GlobalPathEnvVariableName();
304
306
307 static const wxString& GetSymbolLibTableFileName();
308
309private:
312
313 static int m_modifyHash;
314};
315
316
317#endif // _SYMBOL_LIB_TABLE_H_
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:49
const UTF8 & GetLibItemName() const
Definition: lib_id.h:101
const UTF8 & GetLibNickname() const
Return the logical library name portion of a LIB_ID.
Definition: lib_id.h:87
Define a library symbol object.
Definition: lib_symbol.h:98
Hold a record identifying a library accessed by the appropriate plug in object in the LIB_TABLE.
void SetEnabled(bool aEnabled=true)
Change the enabled status of this library.
bool GetIsEnabled() const
Manage LIB_TABLE_ROW records (rows), and can be searched based on library nickname.
An interface used to output 8 bit text in a convenient way.
Definition: richio.h:310
Dialog to show and edit symbol library tables.
A factory which returns an instance of a SCH_PLUGIN.
Definition: sch_io_mgr.h:49
static const wxString ShowType(SCH_FILE_T aFileType)
Return a brief name for a plugin, given aFileType enum.
Definition: sch_io_mgr.cpp:81
Helper object to release a SCH_PLUGIN in the context of a potential thrown exception through its dest...
Definition: sch_io_mgr.h:535
void set(SCH_PLUGIN *aPlugin)
Definition: sch_io_mgr.h:562
Base class that schematic file and library loading and saving plugins should derive from.
Definition: sch_io_mgr.h:155
virtual void GetAvailableSymbolFields(std::vector< wxString > &aNames)
Retrieves a list of (custom) field names that are present on symbols in this library.
Definition: sch_io_mgr.h:474
virtual bool SupportsSubLibraries() const
Definition: sch_io_mgr.h:449
virtual void GetDefaultSymbolFields(std::vector< wxString > &aNames)
Retrieves a list of (custom) field names that should be shown by default for this library in the symb...
Definition: sch_io_mgr.h:488
Build a wxGridTableBase by wrapping an SYMBOL_LIB_TABLE object.
Hold a record identifying a symbol library accessed by the appropriate symbol library SCH_PLUGIN obje...
bool operator==(const SYMBOL_LIB_TABLE_ROW &aRow) const
void SetType(const wxString &aType) override
Change the schematic plugin type represented by this row.
bool operator!=(const SYMBOL_LIB_TABLE_ROW &aRow) const
void GetAvailableSymbolFields(std::vector< wxString > &aNames) const
void GetSubLibraryNames(std::vector< wxString > &aNames) const
SYMBOL_LIB_TABLE_ROW(const wxString &aNick, const wxString &aURI, const wxString &aType, const wxString &aOptions=wxEmptyString, const wxString &aDescr=wxEmptyString)
SYMBOL_LIB_TABLE_ROW(const SYMBOL_LIB_TABLE_ROW &aRow)
void setPlugin(SCH_PLUGIN *aPlugin)
void GetDefaultSymbolFields(std::vector< wxString > &aNames) const
bool Refresh()
Attempt to reload the library.
SCH_PLUGIN::SCH_PLUGIN_RELEASER plugin
virtual LIB_TABLE_ROW * do_clone() const override
bool SupportsSubLibraries() const
SCH_IO_MGR::SCH_FILE_T LIB_T
const wxString GetType() const override
Return the type of symbol library table represented by this row.
void LoadSymbolLib(std::vector< LIB_SYMBOL * > &aAliasList, const wxString &aNickname, bool aPowerSymbolsOnly=false)
void DeleteSymbol(const wxString &aNickname, const wxString &aSymbolName)
Deletes the aSymbolName from the library given by aNickname.
static SYMBOL_LIB_TABLE & GetGlobalLibTable()
virtual void Parse(LIB_TABLE_LEXER *aLexer) override
Parse the #LIB_TABLE_LEXER s-expression library table format into the appropriate LIB_TABLE_ROW objec...
static const wxString & GetSymbolLibTableFileName()
SYMBOL_LIB_TABLE(SYMBOL_LIB_TABLE *aFallBackTable=nullptr)
Build a symbol library table by pre-pending this table fragment in front of aFallBackTable.
static const char * PropPowerSymsOnly
bool IsSymbolLibWritable(const wxString &aNickname)
Return true if the library given by aNickname is writable.
bool IsSymbolLibLoaded(const wxString &aNickname)
Return true if the library given by aNickname was successfully loaded.
virtual void Format(OUTPUTFORMATTER *aOutput, int aIndentLevel) const override
Generate the table in s-expression format to aOutput with an indentation level of aIndentLevel.
void DeleteSymbolLib(const wxString &aNickname)
void CreateSymbolLib(const wxString &aNickname)
static wxString GetGlobalTableFileName()
Fetch the global symbol library table file name.
void EnumerateSymbolLib(const wxString &aNickname, wxArrayString &aAliasNames, bool aPowerSymbolsOnly=false)
Return a list of symbol alias names contained within the library given by aNickname.
static bool LoadGlobalTable(SYMBOL_LIB_TABLE &aTable)
Load the global symbol library table into aTable.
static const wxString GlobalPathEnvVariableName()
Return the name of the environment variable used to hold the directory of locally installed "KiCad sp...
LIB_SYMBOL * LoadSymbol(const wxString &aNickname, const wxString &aName)
Load a LIB_SYMBOL having aName from the library given by aNickname.
LIB_SYMBOL * LoadSymbolWithOptionalNickname(const LIB_ID &aId)
Load a LIB_SYMBOL having aFootprintId with possibly an empty library nickname.
static const char * PropNonPowerSymsOnly
SAVE_T SaveSymbol(const wxString &aNickname, const LIB_SYMBOL *aSymbol, bool aOverwrite=true)
Write aSymbol to an existing library given by aNickname.
KICAD_T Type() override
SAVE_T
The set of return values from SaveSymbol() below.
SYMBOL_LIB_TABLE_ROW * FindRow(const wxString &aNickName, bool aCheckIfEnabled=false)
Return an SYMBOL_LIB_TABLE_ROW if aNickName is found in this table or in any chained fallBack table f...
static int m_modifyHash
helper for GetModifyHash()
LIB_SYMBOL * LoadSymbol(const LIB_ID &aLibId)
KICAD_T
The set of class identification values stored in EDA_ITEM::m_structType.
Definition: typeinfo.h:78
@ SYMBOL_LIB_TABLE_T
Definition: typeinfo.h:234