KiCad PCB EDA Suite
LIB_TABLE_ROW Class Referenceabstract

Hold a record identifying a library accessed by the appropriate plug in object in the LIB_TABLE. More...

#include <lib_table_base.h>

Inheritance diagram for LIB_TABLE_ROW:
FP_LIB_TABLE_ROW SYMBOL_LIB_TABLE_ROW TEST_LIB_TABLE_ROW

Public Member Functions

 LIB_TABLE_ROW ()
 
virtual ~LIB_TABLE_ROW ()
 
 LIB_TABLE_ROW (const wxString &aNick, const wxString &aURI, const wxString &aOptions, const wxString &aDescr=wxEmptyString)
 
bool operator== (const LIB_TABLE_ROW &r) const
 
bool operator!= (const LIB_TABLE_ROW &r) const
 
const wxString & GetNickName () const
 
void SetNickName (const wxString &aNickName)
 Change the logical name of this library, useful for an editor. More...
 
bool GetIsLoaded () const
 
void SetLoaded (bool aLoaded)
 Mark the row as being a loaded library. More...
 
bool GetIsEnabled () const
 
void SetEnabled (bool aEnabled=true)
 Change the enabled status of this library. More...
 
virtual const wxString GetType () const =0
 Return the type of library represented by this row. More...
 
virtual void SetType (const wxString &aType)=0
 Change the type of library represented by this row that must be implemented in the derived object to provide the library table row type. More...
 
const wxString GetFullURI (bool aSubstituted=false) const
 Return the full location specifying URI for the LIB, either in original UI form or in environment variable expanded form. More...
 
void SetFullURI (const wxString &aFullURI)
 Change the full URI for the library. More...
 
const wxString & GetOptions () const
 Return the options string, which may hold a password or anything else needed to instantiate the underlying library plugin. More...
 
void SetOptions (const wxString &aOptions)
 Change the library options strings. More...
 
const wxString & GetDescr () const
 Return the description of the library referenced by this row. More...
 
void SetDescr (const wxString &aDescr)
 Change the description of the library referenced by this row. More...
 
const PROPERTIESGetProperties () const
 Return the constant PROPERTIES for this library (LIB_TABLE_ROW). More...
 
void Format (OUTPUTFORMATTER *out, int nestLevel) const
 Serialize this object as utf8 text to an OUTPUTFORMATTER, and tries to make it look good using multiple lines and indentation. More...
 
LIB_TABLE_ROWclone () const
 

Protected Member Functions

 LIB_TABLE_ROW (const LIB_TABLE_ROW &aRow)
 
void operator= (const LIB_TABLE_ROW &aRow)
 

Private Member Functions

virtual LIB_TABLE_ROWdo_clone () const =0
 
void setProperties (PROPERTIES *aProperties)
 

Private Attributes

wxString nickName
 
wxString uri_user
 what user entered from UI or loaded from disk More...
 
wxString options
 
wxString description
 
bool enabled = true
 Whether the LIB_TABLE_ROW is enabled. More...
 
bool m_loaded = false
 Whether the LIB_TABLE_ROW is loaded. More...
 
std::unique_ptr< PROPERTIESproperties
 

Detailed Description

Hold a record identifying a library accessed by the appropriate plug in object in the LIB_TABLE.

This is an abstract base class from which to derive library specific rows.

Definition at line 66 of file lib_table_base.h.

Constructor & Destructor Documentation

◆ LIB_TABLE_ROW() [1/3]

LIB_TABLE_ROW::LIB_TABLE_ROW ( )
inline

Definition at line 69 of file lib_table_base.h.

69  :
70  enabled( true ),
71  m_loaded( false )
72  {
73  }
bool enabled
Whether the LIB_TABLE_ROW is enabled.
bool m_loaded
Whether the LIB_TABLE_ROW is loaded.

◆ ~LIB_TABLE_ROW()

virtual LIB_TABLE_ROW::~LIB_TABLE_ROW ( )
inlinevirtual

Definition at line 75 of file lib_table_base.h.

76  {
77  }

◆ LIB_TABLE_ROW() [2/3]

LIB_TABLE_ROW::LIB_TABLE_ROW ( const wxString &  aNick,
const wxString &  aURI,
const wxString &  aOptions,
const wxString &  aDescr = wxEmptyString 
)
inline

Definition at line 79 of file lib_table_base.h.

80  :
81  nickName( aNick ),
82  description( aDescr ),
83  enabled( true ),
84  m_loaded( false )
85  {
86  properties.reset();
87  SetOptions( aOptions );
88  SetFullURI( aURI );
89  }
bool enabled
Whether the LIB_TABLE_ROW is enabled.
std::unique_ptr< PROPERTIES > properties
wxString description
void SetFullURI(const wxString &aFullURI)
Change the full URI for the library.
void SetOptions(const wxString &aOptions)
Change the library options strings.
wxString nickName
bool m_loaded
Whether the LIB_TABLE_ROW is loaded.

References properties, SetFullURI(), and SetOptions().

◆ LIB_TABLE_ROW() [3/3]

LIB_TABLE_ROW::LIB_TABLE_ROW ( const LIB_TABLE_ROW aRow)
inlineprotected

Definition at line 192 of file lib_table_base.h.

192  :
193  nickName( aRow.nickName ),
194  uri_user( aRow.uri_user ),
195 #if !FP_LATE_ENVVAR
196  uri_expanded( aRow.uri_expanded ),
197 #endif
198  options( aRow.options ),
199  description( aRow.description ),
200  enabled( aRow.enabled ),
201  m_loaded( aRow.m_loaded )
202  {
203  if( aRow.properties )
204  properties = std::make_unique<PROPERTIES>( *aRow.properties.get() );
205  else
206  properties.reset();
207  }
bool enabled
Whether the LIB_TABLE_ROW is enabled.
std::unique_ptr< PROPERTIES > properties
wxString description
wxString options
wxString nickName
wxString uri_user
what user entered from UI or loaded from disk
bool m_loaded
Whether the LIB_TABLE_ROW is loaded.

References properties.

Member Function Documentation

◆ clone()

LIB_TABLE_ROW* LIB_TABLE_ROW::clone ( ) const
inline

Definition at line 186 of file lib_table_base.h.

187  {
188  return do_clone();
189  }
virtual LIB_TABLE_ROW * do_clone() const =0

References do_clone().

Referenced by new_clone(), SYMBOL_GRID_TRICKS::paste_text(), and FP_GRID_TRICKS::paste_text().

◆ do_clone()

virtual LIB_TABLE_ROW* LIB_TABLE_ROW::do_clone ( ) const
privatepure virtual

Implemented in SYMBOL_LIB_TABLE_ROW, FP_LIB_TABLE_ROW, and TEST_LIB_TABLE_ROW.

Referenced by clone().

◆ Format()

void LIB_TABLE_ROW::Format ( OUTPUTFORMATTER out,
int  nestLevel 
) const

Serialize this object as utf8 text to an OUTPUTFORMATTER, and tries to make it look good using multiple lines and indentation.

Parameters
outis an OUTPUTFORMATTER
nestLevelis the indentation level to base all lines of the output. Actual indentation will be 2 spaces for each nestLevel.

Definition at line 80 of file lib_table_base.cpp.

81 {
82  // In Kicad, we save path and file names using the Unix notation (separator = '/')
83  // So ensure separator is always '/' is saved URI string
84  wxString uri = GetFullURI();
85  uri.Replace( '\\', '/' );
86 
87  wxString extraOptions;
88 
89  if( !GetIsEnabled() )
90  {
91  extraOptions += "(disabled)";
92  }
93 
94  out->Print( nestLevel, "(lib (name %s)(type %s)(uri %s)(options %s)(descr %s)%s)\n",
95  out->Quotew( GetNickName() ).c_str(),
96  out->Quotew( GetType() ).c_str(),
97  out->Quotew( uri ).c_str(),
98  out->Quotew( GetOptions() ).c_str(),
99  out->Quotew( GetDescr() ).c_str(),
100  extraOptions.ToStdString().c_str()
101  );
102 }
const wxString & GetOptions() const
Return the options string, which may hold a password or anything else needed to instantiate the under...
virtual const wxString GetType() const =0
Return the type of library represented by this row.
const wxString & GetDescr() const
Return the description of the library referenced by this row.
const wxString GetFullURI(bool aSubstituted=false) const
Return the full location specifying URI for the LIB, either in original UI form or in environment var...
const wxString & GetNickName() const
bool GetIsEnabled() const
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Format and write text to the output stream.
Definition: richio.cpp:426
std::string Quotew(const wxString &aWrapee) const
Definition: richio.cpp:494

References OUTPUTFORMATTER::Print(), and OUTPUTFORMATTER::Quotew().

◆ GetDescr()

const wxString& LIB_TABLE_ROW::GetDescr ( ) const
inline

Return the description of the library referenced by this row.

Definition at line 163 of file lib_table_base.h.

163 { return description; }
wxString description

References description.

Referenced by LIB_TABLE::GetDescription(), FP_TREE_SYNCHRONIZING_ADAPTER::GetValue(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetValue(), and SCH_EDIT_FRAME::LoadSheetFromFile().

◆ GetFullURI()

const wxString LIB_TABLE_ROW::GetFullURI ( bool  aSubstituted = false) const

Return the full location specifying URI for the LIB, either in original UI form or in environment variable expanded form.

Parameters
aSubstitutedTells if caller wanted the substituted form, else not.

Definition at line 64 of file lib_table_base.cpp.

65 {
66  if( aSubstituted )
67  {
68 #if !FP_LATE_ENVVAR // early expansion
69  return uri_expanded;
70 
71 #else // late expansion
72  return ExpandEnvVarSubstitutions( uri_user, nullptr );
73 #endif
74  }
75 
76  return uri_user;
77 }
const wxString ExpandEnvVarSubstitutions(const wxString &aString, PROJECT *aProject)
Replace any environment variable & text variable references with their values.
Definition: common.cpp:267
wxString uri_user
what user entered from UI or loaded from disk

References ExpandEnvVarSubstitutions().

Referenced by SYMBOL_LIB_TABLE::CreateSymbolLib(), FOOTPRINT_EDIT_FRAME::DeleteFootprintFromLibrary(), SYMBOL_LIB_TABLE::DeleteSymbol(), SYMBOL_LIB_TABLE::DeleteSymbolLib(), SYMBOL_VIEWER_FRAME::DisplayLibInfos(), SYMBOL_LIB_TABLE::EnumerateSymbolLib(), FP_LIB_TABLE::FootprintDelete(), FP_LIB_TABLE::FootprintEnumerate(), FP_LIB_TABLE::FootprintExists(), FP_LIB_TABLE::FootprintLibCreate(), FP_LIB_TABLE::FootprintLibDelete(), FP_LIB_TABLE::FootprintLoad(), FP_LIB_TABLE::FootprintSave(), FP_LIB_TABLE::GenerateTimestamp(), FP_LIB_TABLE::GetEnumeratedFootprint(), LIB_TABLE::GetFullURI(), FP_LIB_TABLE::IsFootprintLibWritable(), SYMBOL_LIB_TABLE::IsSymbolLibWritable(), SCH_EDIT_FRAME::LoadSheetFromFile(), SYMBOL_LIB_TABLE::LoadSymbol(), SYMBOL_LIB_TABLE::LoadSymbolLib(), FP_LIB_TABLE::PrefetchLib(), SCH::IFACE::SaveFileAs(), FOOTPRINT_EDIT_FRAME::SaveFootprint(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), SYMBOL_LIB_TABLE::SaveSymbol(), and FOOTPRINT_VIEWER_FRAME::UpdateTitle().

◆ GetIsEnabled()

bool LIB_TABLE_ROW::GetIsEnabled ( ) const
inline
Returns
the enabled status of this library row

Definition at line 118 of file lib_table_base.h.

118 { return enabled; }
bool enabled
Whether the LIB_TABLE_ROW is enabled.

References enabled.

Referenced by LIB_TABLE::findRow(), LIB_TABLE_GRID::GetValueAsBool(), SYMBOL_LIB_TABLE_ROW::SYMBOL_LIB_TABLE_ROW(), and PANEL_SYM_LIB_TABLE::verifyTables().

◆ GetIsLoaded()

bool LIB_TABLE_ROW::GetIsLoaded ( ) const
inline
Returns
true if the library was loaded without error

Definition at line 108 of file lib_table_base.h.

108 { return m_loaded; }
bool m_loaded
Whether the LIB_TABLE_ROW is loaded.

References m_loaded.

Referenced by SYMBOL_LIB_TABLE::IsSymbolLibLoaded().

◆ GetNickName()

◆ GetOptions()

const wxString& LIB_TABLE_ROW::GetOptions ( ) const
inline

Return the options string, which may hold a password or anything else needed to instantiate the underlying library plugin.

Definition at line 153 of file lib_table_base.h.

153 { return options; }
wxString options

References options.

Referenced by SYMBOL_LIB_TABLE::EnumerateSymbolLib(), SCH_EDIT_FRAME::LoadSheetFromFile(), SYMBOL_LIB_TABLE::LoadSymbolLib(), and FP_GRID_TRICKS::optionsEditor().

◆ GetProperties()

◆ GetType()

virtual const wxString LIB_TABLE_ROW::GetType ( ) const
pure virtual

Return the type of library represented by this row.

Implemented in SYMBOL_LIB_TABLE_ROW, FP_LIB_TABLE_ROW, and TEST_LIB_TABLE_ROW.

Referenced by FP_GRID_TRICKS::optionsEditor().

◆ operator!=()

bool LIB_TABLE_ROW::operator!= ( const LIB_TABLE_ROW r) const
inline

Definition at line 93 of file lib_table_base.h.

93 { return !( *this == r ); }
E_SERIE r
Definition: eserie.cpp:41

References r.

◆ operator=()

void LIB_TABLE_ROW::operator= ( const LIB_TABLE_ROW aRow)
protected

◆ operator==()

bool LIB_TABLE_ROW::operator== ( const LIB_TABLE_ROW r) const

Definition at line 105 of file lib_table_base.cpp.

106 {
107  return nickName == r.nickName
108  && uri_user == r.uri_user
109  && options == r.options
110  && description == r.description
111  && enabled == r.enabled;
112 }
bool enabled
Whether the LIB_TABLE_ROW is enabled.
wxString description
E_SERIE r
Definition: eserie.cpp:41
wxString options
wxString nickName
wxString uri_user
what user entered from UI or loaded from disk

References r.

Referenced by FP_LIB_TABLE_ROW::operator==(), and SYMBOL_LIB_TABLE_ROW::operator==().

◆ SetDescr()

void LIB_TABLE_ROW::SetDescr ( const wxString &  aDescr)
inline

Change the description of the library referenced by this row.

Definition at line 168 of file lib_table_base.h.

168 { description = aDescr; }
wxString description

References description.

◆ SetEnabled()

void LIB_TABLE_ROW::SetEnabled ( bool  aEnabled = true)
inline

Change the enabled status of this library.

Definition at line 123 of file lib_table_base.h.

123 { enabled = aEnabled; }
bool enabled
Whether the LIB_TABLE_ROW is enabled.

References enabled.

Referenced by LIB_TABLE_GRID::SetValueAsBool(), and SYMBOL_LIB_TABLE_ROW::SYMBOL_LIB_TABLE_ROW().

◆ SetFullURI()

void LIB_TABLE_ROW::SetFullURI ( const wxString &  aFullURI)

Change the full URI for the library.

Definition at line 54 of file lib_table_base.cpp.

55 {
56  uri_user = aFullURI;
57 
58 #if !FP_LATE_ENVVAR
59  uri_expanded = FP_LIB_TABLE::ExpandSubstitutions( aFullURI );
60 #endif
61 }
wxString uri_user
what user entered from UI or loaded from disk

Referenced by SYMBOL_EDIT_FRAME::addLibTableEntry(), LIB_TABLE_ROW(), SYMBOL_EDIT_FRAME::replaceLibTableEntry(), and SCH::IFACE::SaveFileAs().

◆ SetLoaded()

void LIB_TABLE_ROW::SetLoaded ( bool  aLoaded)
inline

Mark the row as being a loaded library.

Definition at line 113 of file lib_table_base.h.

113 { m_loaded = aLoaded; };
bool m_loaded
Whether the LIB_TABLE_ROW is loaded.

References m_loaded.

Referenced by SYMBOL_LIB_TABLE::EnumerateSymbolLib(), and SYMBOL_LIB_TABLE::LoadSymbolLib().

◆ SetNickName()

void LIB_TABLE_ROW::SetNickName ( const wxString &  aNickName)
inline

Change the logical name of this library, useful for an editor.

Definition at line 103 of file lib_table_base.h.

103 { nickName = aNickName; }
wxString nickName

References nickName.

Referenced by SYMBOL_EDIT_FRAME::addLibTableEntry().

◆ SetOptions()

void LIB_TABLE_ROW::SetOptions ( const wxString &  aOptions)

Change the library options strings.

Definition at line 115 of file lib_table_base.cpp.

116 {
117  options = aOptions;
118 
119  // set PROPERTIES* from options
121 }
void setProperties(PROPERTIES *aProperties)
#define TO_UTF8(wxstring)
Convert a wxString to a UTF8 encoded C string for all wxWidgets build modes.
Definition: macros.h:96
static PROPERTIES * ParseOptions(const std::string &aOptionsList)
Parses aOptionsList and places the result into a PROPERTIES object which is returned.
wxString options

References LIB_TABLE::ParseOptions(), and TO_UTF8.

Referenced by SYMBOL_LIB_TABLE::EnumerateSymbolLib(), LIB_TABLE_ROW(), SYMBOL_LIB_TABLE::LoadSymbolLib(), and FP_GRID_TRICKS::optionsEditor().

◆ setProperties()

void LIB_TABLE_ROW::setProperties ( PROPERTIES aProperties)
private

Definition at line 48 of file lib_table_base.cpp.

49 {
50  properties.reset( aProperties );
51 }
std::unique_ptr< PROPERTIES > properties

◆ SetType()

virtual void LIB_TABLE_ROW::SetType ( const wxString &  aType)
pure virtual

Change the type of library represented by this row that must be implemented in the derived object to provide the library table row type.

Implemented in SYMBOL_LIB_TABLE_ROW, FP_LIB_TABLE_ROW, and TEST_LIB_TABLE_ROW.

Member Data Documentation

◆ description

wxString LIB_TABLE_ROW::description
private

Definition at line 224 of file lib_table_base.h.

Referenced by GetDescr(), and SetDescr().

◆ enabled

bool LIB_TABLE_ROW::enabled = true
private

Whether the LIB_TABLE_ROW is enabled.

Definition at line 226 of file lib_table_base.h.

Referenced by GetIsEnabled(), and SetEnabled().

◆ m_loaded

bool LIB_TABLE_ROW::m_loaded = false
private

Whether the LIB_TABLE_ROW is loaded.

Definition at line 227 of file lib_table_base.h.

Referenced by GetIsLoaded(), and SetLoaded().

◆ nickName

wxString LIB_TABLE_ROW::nickName
private

Definition at line 216 of file lib_table_base.h.

Referenced by GetNickName(), and SetNickName().

◆ options

wxString LIB_TABLE_ROW::options
private

Definition at line 223 of file lib_table_base.h.

Referenced by GetOptions().

◆ properties

std::unique_ptr< PROPERTIES > LIB_TABLE_ROW::properties
private

Definition at line 229 of file lib_table_base.h.

Referenced by GetProperties(), and LIB_TABLE_ROW().

◆ uri_user

wxString LIB_TABLE_ROW::uri_user
private

what user entered from UI or loaded from disk

Definition at line 217 of file lib_table_base.h.


The documentation for this class was generated from the following files: