#include <library_table.h>

Public Member Functions
	LIBRARY_TABLE (const wxFileName &aPath, LIBRARY_TABLE_SCOPE aScope)
	Creates a library table from a file on disk.

	LIBRARY_TABLE (const wxString &aBuffer, LIBRARY_TABLE_SCOPE aScope)
	Creates a library table from parsed text.

	~LIBRARY_TABLE ()=default

bool	operator== (const LIBRARY_TABLE &aOther) const

LIBRARY_TABLE_ROW	MakeRow () const
	Builds a new row that is suitable for this table (does not insert it)

LIBRARY_TABLE_ROW &	InsertRow ()
	Builds a new row and inserts it at the end of the table; returning a reference to the row.

const wxString &	Path () const

void	SetPath (const wxString &aPath)

LIBRARY_TABLE_TYPE	Type () const

void	SetType (const LIBRARY_TABLE_TYPE aType)

void	SetScope (LIBRARY_TABLE_SCOPE aScope)

LIBRARY_TABLE_SCOPE	Scope () const

std::optional< int >	Version () const

void	SetVersion (const std::optional< int > &aVersion)

bool	IsOk () const

const wxString &	ErrorDescription () const

const std::vector< LIBRARY_TABLE_ROW > &	Rows () const

std::vector< LIBRARY_TABLE_ROW > &	Rows ()

void	Format (OUTPUTFORMATTER *aOutput) const

bool	HasRow (const wxString &aNickname) const

bool	HasRowWithURI (const wxString &aUri, const PROJECT &aProject, bool aSubstituted=false) const
	Returns true if the given (fully-expanded) URI exists as a library in this table.

std::optional< LIBRARY_TABLE_ROW * >	Row (const wxString &aNickname)

std::optional< const LIBRARY_TABLE_ROW * >	Row (const wxString &aNickname) const

LIBRARY_RESULT< void >	Save ()

Static Public Member Functions
static std::map< std::string, UTF8 >	ParseOptions (const std::string &aOptionsList)

static UTF8	FormatOptions (const std::map< std::string, UTF8 > *aProperties)

Private Member Functions
bool	initFromIR (const LIBRARY_TABLE_IR &aIR)

bool	addRowFromIR (const LIBRARY_TABLE_ROW_IR &aIR)

Private Attributes
wxString	m_path
	The full path to the file this table was parsed from, if any.

LIBRARY_TABLE_SCOPE	m_scope = LIBRARY_TABLE_SCOPE::UNINITIALIZED

LIBRARY_TABLE_TYPE	m_type = LIBRARY_TABLE_TYPE::UNINITIALIZED
	What type of content this table contains (footprint, symbol, design block, etc)

std::optional< int >	m_version
	The format version, if present in the parsed file.

bool	m_ok = false

wxString	m_errorDescription

std::vector< LIBRARY_TABLE_ROW >	m_rows

Detailed Description

Definition at line 131 of file library_table.h.

Constructor & Destructor Documentation

◆ LIBRARY_TABLE() [1/2]

LIBRARY_TABLE::LIBRARY_TABLE	(	const wxFileName &	aPath,
		LIBRARY_TABLE_SCOPE	aScope )

Creates a library table from a file on disk.

Parameters

aPath	is the path to a library table file to parse
aScope	is the scope of this table (is it global or part of a project)

Definition at line 55 of file library_table.cpp.

References _, initFromIR(), m_errorDescription, m_ok, m_path, m_scope, LIBRARY_TABLE_PARSER::Parse(), and WX_FILENAME::ResolvePossibleSymlinks().

Referenced by operator==(), and ~LIBRARY_TABLE().

◆ LIBRARY_TABLE() [2/2]

LIBRARY_TABLE::LIBRARY_TABLE	(	const wxString &	aBuffer,
		LIBRARY_TABLE_SCOPE	aScope )

Creates a library table from parsed text.

Parameters

aBuffer	is a string containing data to parse
aScope	is the scope of this table (is it global or part of a project)

Definition at line 86 of file library_table.cpp.

References m_path, m_scope, and LIBRARY_TABLE_PARSER::ParseBuffer().

◆ ~LIBRARY_TABLE()

LIBRARY_TABLE::~LIBRARY_TABLE ( )

default

References InsertRow(), LIBRARY_TABLE(), and MakeRow().

Member Function Documentation

◆ addRowFromIR()

bool LIBRARY_TABLE::addRowFromIR ( const LIBRARY_TABLE_ROW_IR & aIR )

private

◆ ErrorDescription()

const wxString & LIBRARY_TABLE::ErrorDescription ( ) const

inline

Definition at line 171 of file library_table.h.

References m_errorDescription.

◆ Format()

void LIBRARY_TABLE::Format ( OUTPUTFORMATTER * aOutput ) const

Definition at line 156 of file library_table.cpp.

References XNODE::AddAttribute(), DESIGN_BLOCK, FOOTPRINT, XNODE::Format(), Rows(), SYMBOL, and Type().

Referenced by Save().

◆ FormatOptions()

UTF8 LIBRARY_TABLE::FormatOptions ( const std::map< std::string, UTF8 > * aProperties )

static

Definition at line 352 of file library_table.cpp.

References UTF8::begin(), UTF8::end(), name, OPT_SEP, and UTF8::size().

Referenced by DIALOG_PLUGIN_OPTIONS::TransferDataFromWindow().

◆ HasRow()

bool LIBRARY_TABLE::HasRow ( const wxString & aNickname ) const

Definition at line 213 of file library_table.cpp.

References m_rows.

Referenced by PCM_LIB_TRAVERSER::ensureUnique().

◆ HasRowWithURI()

bool LIBRARY_TABLE::HasRowWithURI	(	const wxString &	aUri,
		const PROJECT &	aProject,
		bool	aSubstituted = false ) const

Returns true if the given (fully-expanded) URI exists as a library in this table.

Parameters

aSubstituted is true if the URI should be compared with full (expanded/substituted) versions of the row URIs

Definition at line 225 of file library_table.cpp.

References LIBRARY_MANAGER::ExpandURI(), m_rows, and PROJECT.

Referenced by PCM_LIB_TRAVERSER::addRowIfNecessary().

◆ initFromIR()

bool LIBRARY_TABLE::initFromIR ( const LIBRARY_TABLE_IR & aIR )

private

Definition at line 117 of file library_table.cpp.

References addRowFromIR(), m_type, m_version, LIBRARY_TABLE_IR::rows, LIBRARY_TABLE_IR::type, and LIBRARY_TABLE_IR::version.

Referenced by LIBRARY_TABLE().

◆ InsertRow()

LIBRARY_TABLE_ROW & LIBRARY_TABLE::InsertRow ( )

Builds a new row and inserts it at the end of the table; returning a reference to the row.

Definition at line 207 of file library_table.cpp.

References MakeRow(), and Rows().

Referenced by PCM_LIB_TRAVERSER::addRowIfNecessary(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), SCH_EDIT_FRAME::LoadSheetFromFile(), SYMBOL_LIB_TABLE_RESCUER::WriteRescueLibrary(), and ~LIBRARY_TABLE().

◆ IsOk()

bool LIBRARY_TABLE::IsOk ( ) const

inline

Definition at line 170 of file library_table.h.

References m_ok.

Referenced by LIBRARY_MANAGER::IsTableValid(), and LIB_TABLE_GRID_TRICKS::paste_text().

◆ MakeRow()

LIBRARY_TABLE_ROW LIBRARY_TABLE::MakeRow ( ) const

Builds a new row that is suitable for this table (does not insert it)

Definition at line 196 of file library_table.cpp.

References m_scope, LIBRARY_TABLE_ROW::SetOk(), and LIBRARY_TABLE_ROW::SetScope().

Referenced by InsertRow(), and ~LIBRARY_TABLE().

◆ operator==()

bool LIBRARY_TABLE::operator== ( const LIBRARY_TABLE & aOther ) const

Definition at line 107 of file library_table.cpp.

References LIBRARY_TABLE(), m_path, m_rows, m_scope, m_type, and m_version.

◆ ParseOptions()

std::map< std::string, UTF8 > LIBRARY_TABLE::ParseOptions ( const std::string & aOptionsList )

static

Definition at line 289 of file library_table.cpp.

References end, name, and OPT_SEP.

Referenced by LIBRARY_TABLE_ROW::GetOptionsMap(), PANEL_SYM_LIB_TABLE::onConvertLegacyLibraries(), PANEL_DESIGN_BLOCK_LIB_TABLE::onMigrateLibraries(), PANEL_FP_LIB_TABLE::onMigrateLibraries(), and DIALOG_PLUGIN_OPTIONS::TransferDataToWindow().

◆ Path()

const wxString & LIBRARY_TABLE::Path ( ) const

inline

Definition at line 158 of file library_table.h.

References m_path.

Referenced by PANEL_FP_LIB_TABLE::AddTable(), Save(), and LIB_TABLE_NOTEBOOK_PANEL::TableModified().

◆ Row() [1/2]

std::optional< LIBRARY_TABLE_ROW * > LIBRARY_TABLE::Row ( const wxString & aNickname )

Definition at line 241 of file library_table.cpp.

References m_rows.

Referenced by SYMBOL_LIB_TABLE_RESCUER::WriteRescueLibrary().

◆ Row() [2/2]

std::optional< const LIBRARY_TABLE_ROW * > LIBRARY_TABLE::Row ( const wxString & aNickname ) const

Definition at line 253 of file library_table.cpp.

References m_rows.

◆ Rows() [1/2]

std::vector< LIBRARY_TABLE_ROW > & LIBRARY_TABLE::Rows ( )

inline

Definition at line 174 of file library_table.h.

References m_rows.

◆ Rows() [2/2]

const std::vector< LIBRARY_TABLE_ROW > & LIBRARY_TABLE::Rows ( ) const

inline

Definition at line 173 of file library_table.h.

References m_rows.

Referenced by DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), Format(), InsertRow(), LIB_TABLE_GRID_TRICKS::MoveDownHandler(), LIB_TABLE_GRID_TRICKS::MoveUpHandler(), and LIB_TABLE_GRID_TRICKS::paste_text().

◆ Save()

LIBRARY_RESULT< void > LIBRARY_TABLE::Save ( )

Definition at line 265 of file library_table.cpp.

References FN_NORMALIZE_FLAGS, Format(), Path(), traceLibraries, and IO_ERROR::What().

Referenced by DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), SCH_EDITOR_CONTROL::ExportSymbolsToLibrary(), SCH_EDIT_FRAME::LoadSheetFromFile(), LIB_TABLE_NOTEBOOK_PANEL::SaveTable(), PANEL_DESIGN_BLOCK_LIB_TABLE::TransferDataFromWindow(), PANEL_FP_LIB_TABLE::TransferDataFromWindow(), PANEL_SYM_LIB_TABLE::TransferDataFromWindow(), and SYMBOL_LIB_TABLE_RESCUER::WriteRescueLibrary().

◆ Scope()

LIBRARY_TABLE_SCOPE LIBRARY_TABLE::Scope ( ) const

inline

Definition at line 165 of file library_table.h.

References m_scope.

Referenced by LIBRARY_MANAGER::loadNestedTables(), and LIB_TABLE_GRID_TRICKS::paste_text().

◆ SetPath()

void LIBRARY_TABLE::SetPath ( const wxString & aPath )

inline

Definition at line 159 of file library_table.h.

References m_path.

◆ SetScope()

void LIBRARY_TABLE::SetScope ( LIBRARY_TABLE_SCOPE aScope )

inline

Definition at line 164 of file library_table.h.

References m_scope.

◆ SetType()

void LIBRARY_TABLE::SetType ( const LIBRARY_TABLE_TYPE aType )

inline

Definition at line 162 of file library_table.h.

References m_type.

◆ SetVersion()

void LIBRARY_TABLE::SetVersion ( const std::optional< int > & aVersion )

inline

Definition at line 168 of file library_table.h.

References m_version.

◆ Type()

LIBRARY_TABLE_TYPE LIBRARY_TABLE::Type ( ) const

inline

Definition at line 161 of file library_table.h.

References m_type.

Referenced by Format().

◆ Version()

std::optional< int > LIBRARY_TABLE::Version ( ) const

inline

Definition at line 167 of file library_table.h.

References m_version.

Member Data Documentation

◆ m_errorDescription

wxString LIBRARY_TABLE::m_errorDescription

private

Definition at line 212 of file library_table.h.

Referenced by ErrorDescription(), and LIBRARY_TABLE().

◆ m_ok

bool LIBRARY_TABLE::m_ok = false

private

Definition at line 211 of file library_table.h.

Referenced by IsOk(), and LIBRARY_TABLE().

◆ m_path

wxString LIBRARY_TABLE::m_path

private

The full path to the file this table was parsed from, if any.

Definition at line 201 of file library_table.h.

Referenced by LIBRARY_TABLE(), LIBRARY_TABLE(), operator==(), Path(), and SetPath().

◆ m_rows

std::vector<LIBRARY_TABLE_ROW> LIBRARY_TABLE::m_rows

private

Definition at line 214 of file library_table.h.

Referenced by addRowFromIR(), HasRow(), HasRowWithURI(), operator==(), Row(), Row(), Rows(), and Rows().

◆ m_scope

LIBRARY_TABLE_SCOPE LIBRARY_TABLE::m_scope = LIBRARY_TABLE_SCOPE::UNINITIALIZED

private

Definition at line 203 of file library_table.h.

Referenced by addRowFromIR(), LIBRARY_TABLE(), LIBRARY_TABLE(), MakeRow(), operator==(), Scope(), and SetScope().

◆ m_type

LIBRARY_TABLE_TYPE LIBRARY_TABLE::m_type = LIBRARY_TABLE_TYPE::UNINITIALIZED

private

What type of content this table contains (footprint, symbol, design block, etc)

Definition at line 206 of file library_table.h.

Referenced by initFromIR(), operator==(), SetType(), and Type().

◆ m_version

std::optional<int> LIBRARY_TABLE::m_version

private

The format version, if present in the parsed file.

Definition at line 209 of file library_table.h.

Referenced by initFromIR(), operator==(), SetVersion(), and Version().

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

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ LIBRARY_TABLE() [1/2]

◆ LIBRARY_TABLE() [2/2]

◆ ~LIBRARY_TABLE()

Member Function Documentation

◆ addRowFromIR()

◆ ErrorDescription()

◆ Format()

◆ FormatOptions()

◆ HasRow()

◆ HasRowWithURI()

◆ initFromIR()

◆ InsertRow()

◆ IsOk()

◆ MakeRow()

◆ operator==()

◆ ParseOptions()

◆ Path()

◆ Row() [1/2]

◆ Row() [2/2]

◆ Rows() [1/2]

◆ Rows() [2/2]

◆ Save()

◆ Scope()

◆ SetPath()

◆ SetScope()

◆ SetType()

◆ SetVersion()

◆ Type()

◆ Version()

Member Data Documentation

◆ m_errorDescription

◆ m_ok

◆ m_path

◆ m_rows

◆ m_scope

◆ m_type

◆ m_version