LIB_TABLE_ROW Class Reference

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:

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, LIB_TABLE *aParent=nullptr)
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...
bool	GetIsVisible () const
void	SetVisible (bool aVisible=true)
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...
LIB_TABLE *	GetParent () const
void	SetParent (LIB_TABLE *aParent)
std::mutex &	GetMutex ()
const STRING_UTF8_MAP *	GetProperties () 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_ROW *	clone () 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_ROW *	do_clone () const =0
void	setProperties (STRING_UTF8_MAP *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	visible = true
	Whether the LIB_TABLE_ROW is visible in choosers. More...
bool	m_loaded = false
	Whether the LIB_TABLE_ROW is loaded. More...
LIB_TABLE *	m_parent
	Pointer to the table this row lives in (maybe null) More...
std::unique_ptr< STRING_UTF8_MAP >	properties
std::mutex	m_loadMutex

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 65 of file lib_table_base.h.

Constructor & Destructor Documentation

LIB_TABLE_ROW() [1/3]

LIB_TABLE_ROW::LIB_TABLE_ROW ( )

inline

Definition at line 68 of file lib_table_base.h.

 :
 enabled( true ),
 visible( true ),
 m_loaded( false ),
 m_parent( nullptr )
 {
 }

~LIB_TABLE_ROW()

virtual LIB_TABLE_ROW::~LIB_TABLE_ROW ( )

inlinevirtual

Definition at line 76 of file lib_table_base.h.

 {
 }

LIB_TABLE_ROW() [2/3]

LIB_TABLE_ROW::LIB_TABLE_ROW ( const wxString &  aNick, const wxString &  aURI, const wxString &  aOptions, const wxString &  aDescr = wxEmptyString, LIB_TABLE *  aParent = nullptr  )

inline

Definition at line 80 of file lib_table_base.h.

 :
 nickName( aNick ),
 description( aDescr ),
 enabled( true ),
 visible( true ),
 m_loaded( false ),
 m_parent( aParent )
 {
 properties.reset();
 SetOptions( aOptions );
 SetFullURI( aURI );
 }

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 205 of file lib_table_base.h.

 :
 nickName( aRow.nickName ),
 uri_user( aRow.uri_user ),
 options( aRow.options ),
 description( aRow.description ),
 enabled( aRow.enabled ),
 visible( aRow.visible ),
 m_loaded( aRow.m_loaded ),
 m_parent( aRow.m_parent )
 {
 if( aRow.properties )
 properties = std::make_unique<STRING_UTF8_MAP>( *aRow.properties.get() );
 else
 properties.reset();
 }

References properties.

Member Function Documentation

clone()

LIB_TABLE_ROW * LIB_TABLE_ROW::clone ( ) const

inline

Definition at line 199 of file lib_table_base.h.

 {
 return do_clone();
 }

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

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

Definition at line 71 of file lib_table_base.cpp.

{
 // In Kicad, we save path and file names using the Unix notation (separator = '/')
 // So ensure separator is always '/' is saved URI string
 wxString uri = GetFullURI();
 uri.Replace( '\\', '/' );
 
 wxString extraOptions;
 
 if( !GetIsEnabled() )
 extraOptions += "(disabled)";
 
 if( !GetIsVisible() )
 extraOptions += "(hidden)";
 
 out->Print( nestLevel, "(lib (name %s)(type %s)(uri %s)(options %s)(descr %s)%s)\n",
 out->Quotew( GetNickName() ).c_str(),
 out->Quotew( GetType() ).c_str(),
 out->Quotew( uri ).c_str(),
 out->Quotew( GetOptions() ).c_str(),
 out->Quotew( GetDescr() ).c_str(),
 extraOptions.ToStdString().c_str() );
}

References GetDescr(), GetFullURI(), GetIsEnabled(), GetIsVisible(), GetNickName(), GetOptions(), GetType(), 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 170 of file lib_table_base.h.

{ return description; }

References description.

Referenced by Format(), LIB_TABLE::GetDescription(), LIB_TABLE_GRID::GetValue(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetValue(), FP_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

aSubstituted

Tells if caller wanted the substituted form, else not.

Definition at line 60 of file lib_table_base.cpp.

{
 if( aSubstituted )
 {
 return ExpandEnvVarSubstitutions( uri_user, nullptr );
 }
 
 return uri_user;
}

References ExpandEnvVarSubstitutions(), and uri_user.

Referenced by EXPORTER_STEP::composePCB(), SYMBOL_LIB_TABLE::CreateSymbolLib(), FOOTPRINT_EDIT_FRAME::DeleteFootprintFromLibrary(), SYMBOL_LIB_TABLE::DeleteSymbol(), SYMBOL_LIB_TABLE::DeleteSymbolLib(), SYMBOL_VIEWER_FRAME::DisplayLibInfos(), FOOTPRINT_EDIT_FRAME::DuplicateFootprint(), SYMBOL_LIB_TABLE::EnumerateSymbolLib(), SCH_EDITOR_CONTROL::ExportSymbolsToLibrary(), EXPORTER_PCB_VRML::ExportVrmlFootprint(), 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(), Format(), FP_LIB_TABLE::GenerateTimestamp(), FP_LIB_TABLE::GetEnumeratedFootprint(), LIB_TABLE::GetFullURI(), SYMBOL_LIBRARY_MANAGER::GetLibraryHash(), LIB_TABLE_GRID::GetValue(), idf_export_footprint(), FP_LIB_TABLE::IsFootprintLibWritable(), SYMBOL_LIB_TABLE::IsSymbolLibWritable(), RENDER_3D_RAYTRACE::load3DModels(), RENDER_3D_OPENGL::load3dModels(), FP_LIB_TABLE::LoadGlobalTable(), SYMBOL_LIB_TABLE::LoadGlobalTable(), SCH_EDIT_FRAME::LoadSheetFromFile(), SYMBOL_LIB_TABLE::LoadSymbol(), SYMBOL_LIB_TABLE::LoadSymbolLib(), FP_LIB_TABLE::PrefetchLib(), SYMBOL_LIB_TABLE_ROW::Refresh(), PCB::IFACE::SaveFileAs(), FOOTPRINT_EDIT_FRAME::SaveFootprint(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), SYMBOL_LIBRARY_MANAGER::SaveLibrary(), SYMBOL_LIB_TABLE::SaveSymbol(), FOOTPRINT_VIEWER_FRAME::UpdateTitle(), and PANEL_FP_PROPERTIES_3D_MODEL::validateModelExists().

GetIsEnabled()

bool LIB_TABLE_ROW::GetIsEnabled ( ) const

inline

Returns

the enabled status of this library row

Definition at line 121 of file lib_table_base.h.

{ return enabled; }

References enabled.

Referenced by LIB_TABLE::findRow(), Format(), LIB_TABLE_GRID::GetValue(), 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 111 of file lib_table_base.h.

{ return m_loaded; }

References m_loaded.

Referenced by SYMBOL_LIB_TABLE::IsSymbolLibLoaded().

GetIsVisible()

bool LIB_TABLE_ROW::GetIsVisible ( ) const

inline

Definition at line 128 of file lib_table_base.h.

{ return visible; }

References visible.

Referenced by SYMBOL_TREE_MODEL_ADAPTER::AddLibraries(), Format(), LIB_TABLE_GRID::GetValue(), LIB_TABLE_GRID::GetValueAsBool(), SCH_BASE_FRAME::PickSymbolFromLibTree(), and SYMBOL_VIEWER_FRAME::ReCreateLibList().

GetMutex()

std::mutex & LIB_TABLE_ROW::GetMutex ( )

inline

Definition at line 181 of file lib_table_base.h.

{ return m_loadMutex; }

References m_loadMutex.

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

GetNickName()

const wxString & LIB_TABLE_ROW::GetNickName ( ) const

inline

Returns

the logical name of this library table row.

Definition at line 101 of file lib_table_base.h.

{ return nickName; }

References nickName.

Referenced by BOOST_AUTO_TEST_CASE(), LIB_TABLE_GRID::ContainsNickname(), PCB_EDIT_FRAME::ExportFootprintsToLibrary(), FP_LIB_TABLE::FootprintLoad(), Format(), LIB_TABLE_GRID::GetValue(), LIB_TABLE::InsertRow(), SYMBOL_EDIT_FRAME::KiwayMailIn(), FOOTPRINT_EDIT_FRAME::KiwayMailIn(), FP_LIB_TABLE::LoadGlobalTable(), SYMBOL_LIB_TABLE::LoadGlobalTable(), SYMBOL_LIB_TABLE::LoadSymbol(), SYMBOL_LIB_TABLE::LoadSymbolLib(), FP_GRID_TRICKS::optionsEditor(), DIALOG_SYMBOL_REMAP::remapSymbolToLibTable(), and PANEL_SYM_LIB_TABLE::verifyTables().

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 160 of file lib_table_base.h.

{ return options; }

References options.

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

GetParent()

LIB_TABLE * LIB_TABLE_ROW::GetParent ( void  ) const

inline

Definition at line 177 of file lib_table_base.h.

{ return m_parent; }

References m_parent.

Referenced by SYMBOL_LIB_TABLE_ROW::Refresh(), and PANEL_SYM_LIB_TABLE::verifyTables().

GetProperties()

const STRING_UTF8_MAP * LIB_TABLE_ROW::GetProperties ( ) const

inline

Return the constant #PROPERTIES for this library (LIB_TABLE_ROW).

These are the "options" in a table.

Definition at line 187 of file lib_table_base.h.

{ return properties.get(); }

References properties.

Referenced by SYMBOL_LIB_TABLE::CreateSymbolLib(), SYMBOL_LIB_TABLE::DeleteSymbol(), SYMBOL_LIB_TABLE::DeleteSymbolLib(), 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::GetEnumeratedFootprint(), SYMBOL_LIB_TABLE::LoadSymbol(), SYMBOL_LIB_TABLE::LoadSymbolLib(), FP_LIB_TABLE::PrefetchLib(), SYMBOL_LIB_TABLE_ROW::Refresh(), and SYMBOL_LIB_TABLE::SaveSymbol().

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 Format(), LIB_TABLE_GRID::GetValue(), and FP_GRID_TRICKS::optionsEditor().

operator!=()

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

inline

Definition at line 96 of file lib_table_base.h.

{ return !( *this == 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 96 of file lib_table_base.cpp.

{
 return nickName == r.nickName
 && uri_user == r.uri_user
 && options == r.options
 && description == r.description
 && enabled == r.enabled
 && visible == r.visible;
}

References description, enabled, nickName, options, uri_user, and visible.

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 175 of file lib_table_base.h.

{ description = aDescr; }

References description.

Referenced by LIB_TABLE_GRID::SetValue().

SetEnabled()

void LIB_TABLE_ROW::SetEnabled ( bool  aEnabled = true )

inline

Change the enabled status of this library.

Definition at line 126 of file lib_table_base.h.

{ enabled = aEnabled; }

References enabled.

Referenced by LIB_TABLE_GRID::SetValue(), 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.

{
 uri_user = aFullURI;
}

References uri_user.

Referenced by SYMBOL_EDIT_FRAME::addLibTableEntry(), LIB_TABLE_ROW(), SYMBOL_EDIT_FRAME::replaceLibTableEntry(), PCB::IFACE::SaveFileAs(), and LIB_TABLE_GRID::SetValue().

SetLoaded()

void LIB_TABLE_ROW::SetLoaded ( bool  aLoaded )

inline

Mark the row as being a loaded library.

Definition at line 116 of file lib_table_base.h.

{ m_loaded = aLoaded; };

References m_loaded.

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

SetNickName()

void LIB_TABLE_ROW::SetNickName ( const wxString &  aNickName )

inline

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

Definition at line 106 of file lib_table_base.h.

{ nickName = aNickName; }

References nickName.

Referenced by SYMBOL_EDIT_FRAME::addLibTableEntry(), and LIB_TABLE_GRID::SetValue().

SetOptions()

void LIB_TABLE_ROW::SetOptions

(

const wxString &

aOptions

)

Change the library options strings.

Definition at line 107 of file lib_table_base.cpp.

{
 options = aOptions;
 
 // set PROPERTIES* from options
 setProperties( LIB_TABLE::ParseOptions( TO_UTF8( aOptions ) ) );
}

References options, LIB_TABLE::ParseOptions(), setProperties(), and TO_UTF8.

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

SetParent()

void LIB_TABLE_ROW::SetParent ( LIB_TABLE *  aParent )

inline

Definition at line 179 of file lib_table_base.h.

{ m_parent = aParent; }

References m_parent.

Referenced by LIB_TABLE::InsertRow(), and PANEL_SYM_LIB_TABLE::verifyTables().

setProperties()

void LIB_TABLE_ROW::setProperties ( STRING_UTF8_MAP *  aProperties )

private

Definition at line 48 of file lib_table_base.cpp.

{
 properties.reset( aProperties );
}

References properties.

Referenced by SetOptions().

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.

Referenced by LIB_TABLE_GRID::SetValue().

SetVisible()

void LIB_TABLE_ROW::SetVisible ( bool  aVisible = true )

inline

Definition at line 130 of file lib_table_base.h.

{ visible = aVisible; }

References visible.

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

Member Data Documentation

description

wxString LIB_TABLE_ROW::description

private

Definition at line 231 of file lib_table_base.h.

Referenced by GetDescr(), operator==(), and SetDescr().

enabled

bool LIB_TABLE_ROW::enabled = true

private

Whether the LIB_TABLE_ROW is enabled.

Definition at line 233 of file lib_table_base.h.

Referenced by GetIsEnabled(), operator==(), and SetEnabled().

m_loaded

bool LIB_TABLE_ROW::m_loaded = false

private

Whether the LIB_TABLE_ROW is loaded.

Definition at line 235 of file lib_table_base.h.

Referenced by GetIsLoaded(), and SetLoaded().

m_loadMutex

std::mutex LIB_TABLE_ROW::m_loadMutex

private

Definition at line 240 of file lib_table_base.h.

Referenced by GetMutex().

m_parent

LIB_TABLE* LIB_TABLE_ROW::m_parent

private

Pointer to the table this row lives in (maybe null)

Definition at line 236 of file lib_table_base.h.

Referenced by GetParent(), and SetParent().

nickName

wxString LIB_TABLE_ROW::nickName

private

Definition at line 228 of file lib_table_base.h.

Referenced by GetNickName(), operator==(), and SetNickName().

options

wxString LIB_TABLE_ROW::options

private

Definition at line 230 of file lib_table_base.h.

Referenced by GetOptions(), operator==(), and SetOptions().

properties

std::unique_ptr<STRING_UTF8_MAP> LIB_TABLE_ROW::properties

private

Definition at line 238 of file lib_table_base.h.

Referenced by GetProperties(), LIB_TABLE_ROW(), and setProperties().

uri_user

wxString LIB_TABLE_ROW::uri_user

private

what user entered from UI or loaded from disk

Definition at line 229 of file lib_table_base.h.

Referenced by GetFullURI(), operator==(), and SetFullURI().

visible

bool LIB_TABLE_ROW::visible = true

private

Whether the LIB_TABLE_ROW is visible in choosers.

Definition at line 234 of file lib_table_base.h.

Referenced by GetIsVisible(), operator==(), and SetVisible().

---

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

• lib_table_base.h
• lib_table_base.cpp