LIB_TABLE Class Reference

Manage LIB_TABLE_ROW records (rows), and can be searched based on library nickname. More...

#include <lib_table_base.h>

Inheritance diagram for LIB_TABLE:

Public Member Functions
virtual void	Parse (LIB_TABLE_LEXER *aLexer)=0
	Parse the #LIB_TABLE_LEXER s-expression library table format into the appropriate LIB_TABLE_ROW objects. More...
virtual void	Format (OUTPUTFORMATTER *aOutput, int aIndentLevel) const =0
	Generate the table in s-expression format to aOutput with an indention level of aIndentLevel. More...
	LIB_TABLE (LIB_TABLE *aFallBackTable=nullptr)
	Build a library table by pre-pending this table fragment in front of aFallBackTable. More...
virtual	~LIB_TABLE ()
void	Clear ()
	Delete all rows. More...
bool	operator== (const LIB_TABLE &r) const
	Compares this table against another. More...
bool	operator!= (const LIB_TABLE &r) const
unsigned	GetCount () const
	Get the number of rows contained in the table. More...
LIB_TABLE_ROW &	At (unsigned aIndex)
	Get the 'n'th LIB_TABLE_ROW object. More...
const LIB_TABLE_ROW &	At (unsigned aIndex) const
	Get the 'n'th LIB_TABLE_ROW object. More...
bool	IsEmpty (bool aIncludeFallback=true)
	Return true if the table is empty. More...
const wxString	GetDescription (const wxString &aNickname)
bool	HasLibrary (const wxString &aNickname, bool aCheckEnabled=false) const
	Test for the existence of aNickname in the library table. More...
std::vector< wxString >	GetLogicalLibs ()
	Return the logical library names, all of them that are pertinent to a look up done on this LIB_TABLE. More...
wxString	GetFullURI (const wxString &aLibNickname, bool aExpandEnvVars=true) const
	Return the full URI of the library mapped to aLibNickname. More...
bool	InsertRow (LIB_TABLE_ROW *aRow, bool doReplace=false)
	Adds aRow if it does not already exist or if doReplace is true. More...
bool	RemoveRow (LIB_TABLE_ROW *aRow)
	Removes a row from the table. More...
const LIB_TABLE_ROW *	FindRowByURI (const wxString &aURI)
void	Load (const wxString &aFileName)
	Load the library table using the path defined by aFileName aFallBackTable. More...
void	Save (const wxString &aFileName) const
	Write this library table to aFileName in s-expression form. More...
virtual KICAD_T	Type ()=0

Static Public Member Functions
static PROPERTIES *	ParseOptions (const std::string &aOptionsList)
	Parses aOptionsList and places the result into a PROPERTIES object which is returned. More...
static UTF8	FormatOptions (const PROPERTIES *aProperties)
	Returns a list of options from the aProperties parameter. More...

Protected Types
typedef std::map< wxString, int >	INDEX
	this is a non-owning index into the LIB_TABLE_ROWS table More...
typedef INDEX::iterator	INDEX_ITER
typedef INDEX::const_iterator	INDEX_CITER
typedef INDEX::value_type	INDEX_VALUE

Protected Member Functions
LIB_TABLE_ROW *	findRow (const wxString &aNickname, bool aCheckIfEnabled=false) const
	Return a LIB_TABLE_ROW if aNickname is found in this table or in any chained fallBack table fragment, else NULL. More...
void	reindex ()
void	ensureIndex ()

Protected Attributes
LIB_TABLE_ROWS	rows
INDEX	nickIndex
	this particular key is the nickName within each row. More...
LIB_TABLE *	fallBack
std::recursive_mutex	m_nickIndexMutex
	Mutex to protect access to the nickIndex variable. More...

Friends
class	PANEL_FP_LIB_TABLE
class	LIB_TABLE_GRID

Detailed Description

Manage LIB_TABLE_ROW records (rows), and can be searched based on library nickname.

This class owns the library table, which is like fstab in concept and maps logical library name to the library URI, type, and options. It is heavily based on the SWEET parser work done by Dick Hollenbeck and can be seen in new/sch_lib_table.h. A library table has the following columns:

• Logical Library Name (Nickname)
• Library Type, used to determine which plugin to load to access the library.
• Library URI. The full URI to the library source, form dependent on Type.
• Options, used for as yet to be defined information such as user names or passwords

The Library Type can be one of:

• "file"
• "ftp"
• "http"

For now, the Library URI types needed to support the various types can be one of those shown below, which are typical of each type:

• "file://C:/mylibdir"
• "ftp://kicad.org/partlib/trunk"
• "http://kicad.org/partlib"

The library table is built up from several additive entries (table fragments), and the final table is a (conceptual) merging of the table fragments. Two anticipated sources of the entries are a personal table saved in the KiCad configuration and a project resident table that resides in project file. The project footprint table entries are considered a higher priority in the final dynamically assembled library table. An row in the project file contribution to the library table takes precedence over the personal table if there is a collision of logical library names. Otherwise, the entries simply combine without issue to make up the applicable library table.

Author

Wayne Stambaugh

Definition at line 278 of file lib_table_base.h.

Member Typedef Documentation

INDEX

typedef std::map<wxString,int> LIB_TABLE::INDEX

protected

this is a non-owning index into the LIB_TABLE_ROWS table

Definition at line 534 of file lib_table_base.h.

INDEX_CITER

typedef INDEX::const_iterator LIB_TABLE::INDEX_CITER

protected

Definition at line 536 of file lib_table_base.h.

INDEX_ITER

typedef INDEX::iterator LIB_TABLE::INDEX_ITER

protected

Definition at line 535 of file lib_table_base.h.

INDEX_VALUE

typedef INDEX::value_type LIB_TABLE::INDEX_VALUE

protected

Definition at line 537 of file lib_table_base.h.

Constructor & Destructor Documentation

LIB_TABLE()

LIB_TABLE::LIB_TABLE

(

LIB_TABLE *

aFallBackTable = nullptr

)

Build a library table by pre-pending this table fragment in front of aFallBackTable.

Loading of this table fragment is done by using Parse().

Parameters

aFallBackTable

is another LIB_TABLE which is searched only when a row is not found in this table. No ownership is taken of aFallBackTable.

Definition at line 124 of file lib_table_base.cpp.

                                                :
    fallBack( aFallBackTable )
{
    // not copying fall back, simply search aFallBackTable separately
    // if "nickName not found".
}

~LIB_TABLE()

LIB_TABLE::~LIB_TABLE ( )

virtual

Definition at line 132 of file lib_table_base.cpp.

{
    // *fallBack is not owned here.
}

Member Function Documentation

At() [1/2]

LIB_TABLE_ROW& LIB_TABLE::At ( unsigned  aIndex )

inline

Get the 'n'th LIB_TABLE_ROW object.

Parameters

aIndex

index of row (must exist: from 0 to GetCount() - 1)

Returns

reference to the row

Definition at line 365 of file lib_table_base.h.

    {
        return rows[aIndex];
    }

References rows.

Referenced by SYMBOL_GRID_TRICKS::paste_text(), FP_GRID_TRICKS::paste_text(), and SCH::IFACE::SaveFileAs().

At() [2/2]

const LIB_TABLE_ROW& LIB_TABLE::At ( unsigned  aIndex ) const

inline

Get the 'n'th LIB_TABLE_ROW object.

Parameters

aIndex

index of row (must exist: from 0 to GetCount() - 1)

Returns

reference to the row

Definition at line 373 of file lib_table_base.h.

    {
        return rows[aIndex];
    }

References rows.

Clear()

void LIB_TABLE::Clear ( )

inline

Delete all rows.

Definition at line 320 of file lib_table_base.h.

    {
        std::lock_guard<std::recursive_mutex> lock( m_nickIndexMutex );

        rows.clear();
        nickIndex.clear();
    }

References m_nickIndexMutex, nickIndex, and rows.

Referenced by PANEL_FP_LIB_TABLE::TransferDataFromWindow(), and PANEL_SYM_LIB_TABLE::TransferDataFromWindow().

ensureIndex()

void LIB_TABLE::ensureIndex ( )

inlineprotected

Definition at line 515 of file lib_table_base.h.

    {
        std::lock_guard<std::recursive_mutex> lock( m_nickIndexMutex );

        // The dialog lib table editor may not maintain the nickIndex.
        // Lazy indexing may be required.  To handle lazy indexing, we must enforce
        // that "nickIndex" is either empty or accurate, but never inaccurate.
        if( !nickIndex.size() )
            reindex();
    }

References m_nickIndexMutex, nickIndex, and reindex().

Referenced by findRow(), FindRowByURI(), and InsertRow().

findRow()

LIB_TABLE_ROW * LIB_TABLE::findRow ( const wxString &  aNickname, bool  aCheckIfEnabled = false  ) const

protected

Return a LIB_TABLE_ROW if aNickname is found in this table or in any chained fallBack table fragment, else NULL.

Parameters

aNickname	is the name of the library table entry to find.
aCheckIfEnabled	is a flag to check if the library table entry is enabled.

Returns

a pointer to the LIB_TABLE_ROW found.

Definition at line 183 of file lib_table_base.cpp.

{
    LIB_TABLE_ROW* row = nullptr;
    LIB_TABLE* cur = (LIB_TABLE*) this;

    std::lock_guard<std::recursive_mutex> lock( m_nickIndexMutex );

    do
    {
        cur->ensureIndex();

        for( const std::pair<const wxString, int>& entry : cur->nickIndex )
        {
            if( entry.first == aNickName )
            {
                row = &cur->rows[entry.second];

                if( !aCheckIfEnabled || ( aCheckIfEnabled && row->GetIsEnabled() ) )
                    return row;
            }
        }

        // Repeat, this time looking for names that were "fixed" by legacy versions because
        // the old eeschema file format didn't support spaces in tokens.
        for( const std::pair<const wxString, int>& entry : cur->nickIndex )
        {
            wxString legacyLibName = entry.first;
            legacyLibName.Replace( " ", "_" );

            if( legacyLibName == aNickName )
            {
                row = &cur->rows[entry.second];

                if( !aCheckIfEnabled || ( aCheckIfEnabled && row->GetIsEnabled() ) )
                    return row;
            }
        }

        // not found, search fall back table(s), if any
    } while( ( cur = cur->fallBack ) != nullptr );

    return nullptr; // not found
}

References ensureIndex(), fallBack, LIB_TABLE_ROW::GetIsEnabled(), m_nickIndexMutex, nickIndex, and rows.

Referenced by FP_LIB_TABLE::FindRow(), SYMBOL_LIB_TABLE::FindRow(), GetDescription(), GetFullURI(), and HasLibrary().

FindRowByURI()

const LIB_TABLE_ROW * LIB_TABLE::FindRowByURI

(

const wxString &

aURI

)

Returns

a LIB_TABLE_ROW pointer if aURI is found in this table or in any chained fallBack table fragments, else NULL.

Definition at line 228 of file lib_table_base.cpp.

{
    LIB_TABLE* cur = this;

    do
    {
        cur->ensureIndex();

        for( unsigned i = 0;  i < cur->rows.size();  i++ )
        {
            wxString tmp = cur->rows[i].GetFullURI( true );

            if( tmp.Find( "://" ) != wxNOT_FOUND )
            {
                if( tmp == aURI )
                    return &cur->rows[i];  // found as URI
            }
            else
            {
                wxFileName fn = aURI;

                // This will also test if the file is a symlink so if we are comparing
                // a symlink to the same real file, the comparison will be true.  See
                // wxFileName::SameAs() in the wxWidgets source.
                if( fn == wxFileName( tmp ) )
                    return &cur->rows[i];  // found as full path and file name
            }
        }

        // not found, search fall back table(s), if any
    } while( ( cur = cur->fallBack ) != nullptr );

    return nullptr; // not found
}

References ensureIndex(), fallBack, and rows.

Referenced by FOOTPRINT_EDIT_FRAME::KiwayMailIn(), and SYMBOL_EDIT_FRAME::KiwayMailIn().

Format()

virtual void LIB_TABLE::Format ( OUTPUTFORMATTER *  aOutput, int  aIndentLevel  ) const

pure virtual

Generate the table in s-expression format to aOutput with an indention level of aIndentLevel.

Parameters

aOutput	is the OUTPUTFORMATTER to format the table into.
aIndentLevel	is the indentation level (2 spaces) to indent.

Exceptions

IO_ERROR	if an I/O error occurs during output.
boost::interprocess::lock_except	if separate process attempt to access the table.

Implemented in SYMBOL_LIB_TABLE, FP_LIB_TABLE, and TEST_LIB_TABLE.

Referenced by Save().

FormatOptions()

UTF8 LIB_TABLE::FormatOptions ( const PROPERTIES *  aProperties )

static

Returns a list of options from the aProperties parameter.

The name=value pairs will be separated with the '|' character. The =value portion may not be present. You might expect something like "name1=value1|name2=value2|flag_me". Notice that flag_me does not have a value. This is ok.

Parameters

aProperties

is the PROPERTIES to format or NULL. If NULL the returned string will be empty.

Definition at line 411 of file lib_table_base.cpp.

{
    UTF8 ret;

    if( aProperties )
    {
        for( PROPERTIES::const_iterator it = aProperties->begin(); it != aProperties->end(); ++it )
        {
            const std::string& name = it->first;

            const UTF8& value = it->second;

            if( ret.size() )
                ret += OPT_SEP;

            ret += name;

            // the separation between name and value is '='
            if( value.size() )
            {
                ret += '=';

                for( std::string::const_iterator si = value.begin();  si != value.end();  ++si )
                {
                    // escape any separator in the value.
                    if( *si == OPT_SEP )
                        ret += '\\';

                    ret += *si;
                }
            }
        }
    }

    return ret;
}

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

Referenced by DIALOG_FP_PLUGIN_OPTIONS::TransferDataFromWindow().

GetCount()

unsigned LIB_TABLE::GetCount ( ) const

inline

Get the number of rows contained in the table.

Definition at line 355 of file lib_table_base.h.

    {
        return rows.size();
    }

References rows.

Referenced by BOOST_AUTO_TEST_CASE(), FP_TREE_SYNCHRONIZING_ADAPTER::GetLibrariesCount(), SYMBOL_GRID_TRICKS::paste_text(), FP_GRID_TRICKS::paste_text(), and SCH::IFACE::SaveFileAs().

GetDescription()

const wxString LIB_TABLE::GetDescription

(

const wxString &

aNickname

)

Returns

the library description from aNickname, or an empty string if aNickname does not exist.

Definition at line 147 of file lib_table_base.cpp.

{
    // Use "no exception" form of find row and ignore disabled flag.
    const LIB_TABLE_ROW* row = findRow( aNickname );

    if( row )
        return row->GetDescr();
    else
        return wxEmptyString;
}

References findRow(), and LIB_TABLE_ROW::GetDescr().

Referenced by SYMBOL_TREE_MODEL_ADAPTER::AddLibraries(), SYMBOL_TREE_MODEL_ADAPTER::AddLibrary(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), SYMBOL_EDIT_FRAME::saveSymbolAs(), and PCB_BASE_FRAME::SelectLibrary().

GetFullURI()

wxString LIB_TABLE::GetFullURI	(	const wxString &	aLibNickname,
		bool	aExpandEnvVars = true
	)		const

Return the full URI of the library mapped to aLibNickname.

Definition at line 170 of file lib_table_base.cpp.

{
    const LIB_TABLE_ROW* row = findRow( aNickname, true );

    wxString retv;

    if( row )
        retv = row->GetFullURI( aExpandEnvVars );

    return retv;
}

References findRow(), and LIB_TABLE_ROW::GetFullURI().

Referenced by CVPCB_MAINFRAME::DisplayStatus(), SCH_EDIT_FRAME::LoadSheetFromFile(), NETLIST_EXPORTER_XML::makeLibraries(), and FOOTPRINT_EDITOR_CONTROL::SaveAs().

GetLogicalLibs()

std::vector< wxString > LIB_TABLE::GetLogicalLibs

(

)

Return the logical library names, all of them that are pertinent to a look up done on this LIB_TABLE.

Definition at line 264 of file lib_table_base.cpp.

{
    // Only return unique logical library names.  Use std::set::insert() to
    // quietly reject any duplicates, which can happen when encountering a duplicate
    // nickname from one of the fall back table(s).

    std::set< wxString >       unique;
    std::vector< wxString >    ret;
    const LIB_TABLE*           cur = this;

    do
    {
        for( LIB_TABLE_ROWS_CITER it = cur->rows.begin();  it!=cur->rows.end();  ++it )
        {
            if( it->GetIsEnabled() )
            {
                unique.insert( it->GetNickName() );
            }
        }

    } while( ( cur = cur->fallBack ) != nullptr );

    ret.reserve( unique.size() );

    // return a sorted, unique set of nicknames in a std::vector<wxString> to caller
    for( std::set< wxString >::const_iterator it = unique.begin();  it!=unique.end();  ++it )
    {
        ret.push_back( *it );
    }

    // We want to allow case-sensitive duplicates but sort by case-insensitive ordering
    std::sort( ret.begin(), ret.end(), []( const wxString& lhs, const wxString& rhs )
    {
        return lhs.CmpNoCase( rhs ) < 0;
    } );

    return ret;
}

References fallBack, and rows.

Referenced by FP_TREE_MODEL_ADAPTER::AddLibraries(), CVPCB_MAINFRAME::BuildLibrariesListBox(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), FP_LIB_TABLE::FootprintLoadWithOptionalNickname(), FP_LIB_TABLE::GenerateTimestamp(), GetFootprintLibraries(), SYMBOL_LIBRARY_MANAGER::GetLibraryCount(), SYMBOL_LIB_TABLE::GetModifyHash(), guessNickname(), CVPCB_MAINFRAME::LoadFootprintFiles(), SYMBOL_LIB_TABLE::LoadSymbolWithOptionalNickname(), FOOTPRINT_VIEWER_FRAME::OnActivate(), SYMBOL_VIEWER_FRAME::OnSelectSymbol(), SCH_BASE_FRAME::PickSymbolFromLibTree(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), SYMBOL_EDIT_FRAME::saveSymbolAs(), PCB_BASE_FRAME::SelectLibrary(), FOOTPRINT_LIST_IMPL::startWorkers(), and FP_TREE_SYNCHRONIZING_ADAPTER::Sync().

HasLibrary()

bool LIB_TABLE::HasLibrary	(	const wxString &	aNickname,
		bool	aCheckEnabled = false
	)		const

Test for the existence of aNickname in the library table.

Parameters

aCheckEnabled

if true will only return true for enabled libraries

Returns

true if a library aNickname exists in the table.

Definition at line 159 of file lib_table_base.cpp.

{
    const LIB_TABLE_ROW* row = findRow( aNickname, aCheckEnabled );

    if( row == nullptr )
        return false;

    return true;
}

References findRow().

Referenced by SYMBOL_EDIT_FRAME::addLibTableEntry(), CVPCB_MAINFRAME::DisplayStatus(), FOOTPRINT_EDIT_FRAME::KiwayMailIn(), SYMBOL_EDIT_FRAME::KiwayMailIn(), SYMBOL_LIBRARY_MANAGER::LibraryExists(), CADSTAR_SCH_ARCHIVE_PLUGIN::Load(), SCH_ALTIUM_PLUGIN::Load(), SCH_EAGLE_PLUGIN::Load(), SCH_EDIT_FRAME::LoadSheetFromFile(), NETLIST_EXPORTER_XML::makeLibraries(), SCH_BASE_FRAME::PickSymbolFromLibTree(), SYMBOL_VIEWER_FRAME::ShowModal(), FOOTPRINT_VIEWER_FRAME::ShowModal(), FP_TREE_SYNCHRONIZING_ADAPTER::Sync(), ERC_TESTER::TestLibSymbolIssues(), and SCH_SCREEN::UpdateSymbolLinks().

InsertRow()

bool LIB_TABLE::InsertRow	(	LIB_TABLE_ROW *	aRow,
		bool	doReplace = false
	)

Adds aRow if it does not already exist or if doReplace is true.

If doReplace is not true and the key for aRow already exists, the function fails and returns false.

The key for the table is the nickName, and all in this table must be unique.

Parameters

aRow	is the new row to insert, or to forcibly add if doReplace is true.
doReplace	if true, means insert regardless of whether aRow's key already exists. If false, then fail if the key already exists.

Returns

bool - true if the operation succeeded.

Definition at line 304 of file lib_table_base.cpp.

{
    std::lock_guard<std::recursive_mutex> lock( m_nickIndexMutex );

    ensureIndex();

    INDEX_CITER it = nickIndex.find( aRow->GetNickName() );

    if( it == nickIndex.end() )
    {
        rows.push_back( aRow );
        nickIndex.insert( INDEX_VALUE( aRow->GetNickName(), rows.size() - 1 ) );
        return true;
    }

    if( doReplace )
    {
        rows.replace( it->second, aRow );
        return true;
    }

    return false;
}

References ensureIndex(), LIB_TABLE_ROW::GetNickName(), m_nickIndexMutex, nickIndex, and rows.

Referenced by PCB_BASE_EDIT_FRAME::AddLibrary(), SYMBOL_LIBRARY_MANAGER::addLibrary(), SYMBOL_EDIT_FRAME::addLibTableEntry(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), LIB_TABLE_TEST_FIXTURE::LIB_TABLE_TEST_FIXTURE(), CADSTAR_SCH_ARCHIVE_PLUGIN::Load(), SCH_ALTIUM_PLUGIN::Load(), SCH_EAGLE_PLUGIN::Load(), PCB_EDIT_FRAME::OpenProjectFiles(), FP_LIB_TABLE::Parse(), and SYMBOL_LIB_TABLE::Parse().

IsEmpty()

bool LIB_TABLE::IsEmpty

(

bool

aIncludeFallback = true

)

Return true if the table is empty.

Parameters

aIncludeFallback

is used to determine if the fallback table should be included in the test.

Returns

true if the footprint library table is empty.

Definition at line 138 of file lib_table_base.cpp.

{
    if( !aIncludeFallback || !fallBack )
        return rows.empty();

    return rows.empty() && fallBack->IsEmpty( true );
}

References fallBack, IsEmpty(), and rows.

Referenced by BOOST_AUTO_TEST_CASE(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), IsEmpty(), PCB_EDIT_FRAME::LoadFootprints(), and SCH_EDIT_FRAME::LoadSheetFromFile().

Load()

void LIB_TABLE::Load

(

const wxString &

aFileName

)

Load the library table using the path defined by aFileName aFallBackTable.

Parameters

aFileName

contains the full path to the s-expression file.

Exceptions

IO_ERROR

if an error occurs attempting to load the footprint library table.

Definition at line 329 of file lib_table_base.cpp.

{
    // It's OK if footprint library tables are missing.
    if( wxFileName::IsFileReadable( aFileName ) )
    {
        FILE_LINE_READER    reader( aFileName );
        LIB_TABLE_LEXER     lexer( &reader );

        Parse( &lexer );
    }
}

References Parse().

Referenced by SYMBOL_LIB_TABLE::LoadGlobalTable(), FP_LIB_TABLE::LoadGlobalTable(), SCH_EDIT_FRAME::LoadSheetFromFile(), PROJECT::PcbFootprintLibs(), SCH::IFACE::SaveFileAs(), DIALOG_GLOBAL_FP_LIB_TABLE_CONFIG::TransferDataFromWindow(), and DIALOG_GLOBAL_SYM_LIB_TABLE_CONFIG::TransferDataFromWindow().

operator!=()

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

inline

Definition at line 350 of file lib_table_base.h.

{ return !( *this == r ); }

operator==()

bool LIB_TABLE::operator== ( const LIB_TABLE &  r ) const

inline

Compares this table against another.

This compares the row contents against each other. Any fallback tables are not checked.

Definition at line 334 of file lib_table_base.h.

    {
        if( rows.size() == r.rows.size() )
        {
            unsigned i;

            for( i = 0; i < rows.size() && rows[i] == r.rows[i];  ++i )
                ;

            if( i == rows.size() )
                return true;
        }

        return false;
    }

References rows.

Parse()

virtual void LIB_TABLE::Parse ( LIB_TABLE_LEXER *  aLexer )

pure virtual

Parse the #LIB_TABLE_LEXER s-expression library table format into the appropriate LIB_TABLE_ROW objects.

Parameters

aLexer

is the lexer to parse.

Exceptions

IO_ERROR	if an I/O error occurs during parsing.
PARSER_ERROR	if the lexer format to parse is invalid.
boost::bad_pointer	if an any attempt to add an invalid pointer to the boost::ptr_vector.
boost::bad_index	if an index outside the row table bounds is accessed.

Implemented in SYMBOL_LIB_TABLE, FP_LIB_TABLE, and TEST_LIB_TABLE.

Referenced by Load().

ParseOptions()

PROPERTIES * LIB_TABLE::ParseOptions ( const std::string &  aOptionsList )

static

Parses aOptionsList and places the result into a PROPERTIES object which is returned.

If the options field is empty, then the returned PROPERTIES will be a NULL pointer.

Typically aOptionsList comes from the "options" field within a LIB_TABLE_ROW and the format is simply a comma separated list of name value pairs. e.g.: [name1[=value1][|name2[=value2]]] etc. When using the UI to create or edit a library table, this formatting is handled for you.

Definition at line 350 of file lib_table_base.cpp.

{
    if( aOptionsList.size() )
    {
        const char* cp  = &aOptionsList[0];
        const char* end = cp + aOptionsList.size();

        PROPERTIES  props;
        std::string pair;

        // Parse all name=value pairs
        while( cp < end )
        {
            pair.clear();

            // Skip leading white space.
            while( cp < end && isspace( *cp )  )
                ++cp;

            // Find the end of pair/field
            while( cp < end )
            {
                if( *cp == '\\'  &&  cp + 1 < end  &&  cp[1] == OPT_SEP  )
                {
                    ++cp;           // skip the escape
                    pair += *cp++;  // add the separator
                }
                else if( *cp == OPT_SEP )
                {
                    ++cp;           // skip the separator
                    break;          // process the pair
                }
                else
                    pair += *cp++;
            }

            // stash the pair
            if( pair.size() )
            {
                // first equals sign separates 'name' and 'value'.
                size_t  eqNdx = pair.find( '=' );

                if( eqNdx != pair.npos )
                {
                    std::string name  = pair.substr( 0, eqNdx );
                    std::string value = pair.substr( eqNdx + 1 );
                    props[name] = value;
                }
                else
                    props[pair] = "";       // property is present, but with no value.
            }
        }

        if( props.size() )
            return new PROPERTIES( props );
    }

    return nullptr;
}

References name, and OPT_SEP.

Referenced by LIB_TABLE_ROW::SetOptions(), and DIALOG_FP_PLUGIN_OPTIONS::TransferDataToWindow().

reindex()

void LIB_TABLE::reindex ( )

inlineprotected

Definition at line 505 of file lib_table_base.h.

    {
        std::lock_guard<std::recursive_mutex> lock( m_nickIndexMutex );

        nickIndex.clear();

        for( LIB_TABLE_ROWS_ITER it = rows.begin(); it != rows.end(); ++it )
            nickIndex.insert( INDEX_VALUE( it->GetNickName(), it - rows.begin() ) );
    }

References m_nickIndexMutex, nickIndex, and rows.

Referenced by ensureIndex(), PANEL_FP_LIB_TABLE::TransferDataFromWindow(), and PANEL_SYM_LIB_TABLE::TransferDataFromWindow().

RemoveRow()

bool LIB_TABLE::RemoveRow ( LIB_TABLE_ROW *  aRow )

inline

Removes a row from the table.

Parameters

aRow	is the row to remove

Returns

true if the row was found (and removed)

Definition at line 432 of file lib_table_base.h.

    {
        for( auto iter = rows.begin(); iter != rows.end(); ++iter )
        {
            if( *iter == *aRow )
            {
                rows.erase( iter, iter + 1 );
                return true;
            }
        }
        return false;
    }

References rows.

Referenced by SYMBOL_LIBRARY_MANAGER::addLibrary().

Save()

void LIB_TABLE::Save

(

const wxString &

aFileName

)

const

Write this library table to aFileName in s-expression form.

Parameters

aFileName

is the name of the file to write to.

Definition at line 343 of file lib_table_base.cpp.

{
    FILE_OUTPUTFORMATTER sf( aFileName );
    Format( &sf, 0 );
}

References Format().

Referenced by PCB_BASE_EDIT_FRAME::AddLibrary(), SYMBOL_EDIT_FRAME::addLibTableEntry(), InvokePcbLibTableEditor(), InvokeSchEditSymbolLibTable(), SYMBOL_LIB_TABLE::LoadGlobalTable(), FP_LIB_TABLE::LoadGlobalTable(), PCB_EDIT_FRAME::OpenProjectFiles(), SYMBOL_EDIT_FRAME::replaceLibTableEntry(), SCH::IFACE::SaveFileAs(), SCH_BASE_FRAME::saveSymbolLibTables(), DIALOG_GLOBAL_FP_LIB_TABLE_CONFIG::TransferDataFromWindow(), and DIALOG_GLOBAL_SYM_LIB_TABLE_CONFIG::TransferDataFromWindow().

Type()

virtual KICAD_T PROJECT::_ELEM::Type ( )

pure virtualinherited

Implemented in SYMBOL_LIBS, SYMBOL_LIB_TABLE, FP_LIB_TABLE, TEST_LIB_TABLE, S3D_CACHE, and SEARCH_STACK.

Friends And Related Function Documentation

LIB_TABLE_GRID

friend class LIB_TABLE_GRID

friend

Definition at line 528 of file lib_table_base.h.

PANEL_FP_LIB_TABLE

friend class PANEL_FP_LIB_TABLE

friend

Definition at line 527 of file lib_table_base.h.

Member Data Documentation

fallBack

LIB_TABLE* LIB_TABLE::fallBack

protected

Definition at line 542 of file lib_table_base.h.

Referenced by findRow(), FindRowByURI(), GetLogicalLibs(), and IsEmpty().

m_nickIndexMutex

std::recursive_mutex LIB_TABLE::m_nickIndexMutex

mutableprotected

Mutex to protect access to the nickIndex variable.

Definition at line 545 of file lib_table_base.h.

Referenced by Clear(), ensureIndex(), findRow(), InsertRow(), and reindex().

nickIndex

INDEX LIB_TABLE::nickIndex

protected

this particular key is the nickName within each row.

Definition at line 540 of file lib_table_base.h.

Referenced by Clear(), ensureIndex(), findRow(), InsertRow(), and reindex().

rows

LIB_TABLE_ROWS LIB_TABLE::rows

protected

Definition at line 531 of file lib_table_base.h.

Referenced by SYMBOL_LIB_TABLE_GRID::at(), FP_LIB_TABLE_GRID::at(), At(), SYMBOL_LIB_TABLE_GRID::begin(), FP_LIB_TABLE_GRID::begin(), Clear(), SYMBOL_LIB_TABLE_GRID::erase(), FP_LIB_TABLE_GRID::erase(), findRow(), FindRowByURI(), FP_LIB_TABLE::Format(), SYMBOL_LIB_TABLE::Format(), FP_LIB_TABLE_GRID::FP_LIB_TABLE_GRID(), GetCount(), GetLogicalLibs(), SYMBOL_LIB_TABLE_GRID::insert(), FP_LIB_TABLE_GRID::insert(), InsertRow(), IsEmpty(), PANEL_SYM_LIB_TABLE::moveDownHandler(), PANEL_FP_LIB_TABLE::moveDownHandler(), PANEL_SYM_LIB_TABLE::moveUpHandler(), PANEL_FP_LIB_TABLE::moveUpHandler(), FP_LIB_TABLE::operator==(), operator==(), SYMBOL_GRID_TRICKS::paste_text(), FP_GRID_TRICKS::paste_text(), SYMBOL_LIB_TABLE_GRID::push_back(), FP_LIB_TABLE_GRID::push_back(), reindex(), RemoveRow(), SYMBOL_LIB_TABLE_GRID::size(), FP_LIB_TABLE_GRID::size(), SYMBOL_LIB_TABLE_GRID::SYMBOL_LIB_TABLE_GRID(), PANEL_FP_LIB_TABLE::TransferDataFromWindow(), and PANEL_SYM_LIB_TABLE::TransferDataFromWindow().

---

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

• lib_table_base.h
• lib_table_base.cpp