LIB_ID Class Reference

A logical library item identifier and consists of various portions much like a URI. More...

#include <lib_id.h>

Public Member Functions
	LIB_ID ()
	LIB_ID (const wxString &aLibraryName, const wxString &aItemName, const wxString &aRevision=wxEmptyString)
	This LIB_ID ctor is a special version which ignores the parsing due to symbol names allowing '/' as a valid character. More...
int	Parse (const UTF8 &aId, bool aFix=false)
	Parse LIB_ID with the information from aId. More...
const UTF8 &	GetLibNickname () const
	Return the logical library name portion of a LIB_ID. More...
int	SetLibNickname (const UTF8 &aNickname)
	Override the logical library name portion of the LIB_ID to aNickname. More...
const UTF8 &	GetLibItemName () const
const wxString	GetUniStringLibItemName () const
	Get strings for display messages in dialogs. More...
int	SetLibItemName (const UTF8 &aLibItemName, bool aTestForRev=true)
	Override the library item name portion of the LIB_ID to aLibItemName. More...
int	SetRevision (const UTF8 &aRevision)
const UTF8 &	GetRevision () const
UTF8	GetLibItemNameAndRev () const
UTF8	Format () const
wxString	GetUniStringLibId () const
bool	IsValid () const
	Check if this LID_ID is valid. More...
bool	IsLegacy () const
void	clear ()
	Clear the contents of the library nickname, library entry name, and revision strings. More...
bool	empty () const
int	compare (const LIB_ID &aLibId) const
	Compare the contents of LIB_ID objects by performing a std::string comparison of the library nickname, library entry name, and revision strings respectively. More...
bool	operator< (const LIB_ID &aLibId) const
bool	operator > (const LIB_ID &aLibId) const
bool	operator== (const LIB_ID &aLibId) const
bool	operator != (const LIB_ID &aLibId) const

Static Public Member Functions
static UTF8	Format (const UTF8 &aLibraryName, const UTF8 &aLibItemName, const UTF8 &aRevision="")
static int	HasIllegalChars (const UTF8 &aLibItemName)
	Examine aLibItemName for invalid LIB_ID item name characters. More...
static UTF8	FixIllegalChars (const UTF8 &aLibItemName, bool aLib=false)
	Replace illegal LIB_ID item name characters with underscores '_'. More...
static unsigned	FindIllegalLibraryNameChar (const UTF8 &aLibraryName)
	Looks for characters that are illegal in library nicknames. More...

Static Protected Member Functions
static bool	isLegalChar (unsigned aUniChar)
	Tests whether a Unicode character is a legal LIB_ID item name character. More...
static bool	isLegalLibraryNameChar (unsigned aUniChar)
	Tests whether a Unicode character is a legal LIB_ID library nickname character. More...

Protected Attributes
UTF8	m_libraryName
	The nickname of the library or empty. More...
UTF8	m_itemName
	The name of the entry in the logical library. More...
UTF8	m_revision
	The revision of the entry. More...

Detailed Description

A logical library item identifier and consists of various portions much like a URI.

It consists of of triad of the library nickname, the name of the item in the library, and an optional revision of the item. This is a generic library identifier that can be used for any type of library that contains multiple named items such as footprint or symbol libraries.

Example LIB_ID string: "smt:R_0805/rev0".

• "smt" is the logical library name used to look up library information saved in the LIB_TABLE.
• "R" is the name of the item within the library.
• "rev0" is the revision, which is optional. If missing then its delimiter should also not be present. A revision must begin with "rev" and be followed by at least one or more decimal digits.

Author

Dick Hollenbeck

Definition at line 51 of file lib_id.h.

Constructor & Destructor Documentation

LIB_ID() [1/2]

LIB_ID::LIB_ID ( )

inline

Definition at line 54 of file lib_id.h.

{}

LIB_ID() [2/2]

LIB_ID::LIB_ID	(	const wxString &	aLibraryName,
		const wxString &	aItemName,
		const wxString &	aRevision = wxEmptyString
	)

This LIB_ID ctor is a special version which ignores the parsing due to symbol names allowing '/' as a valid character.

This was causing the symbol names to be truncated at the first occurrence of '/' in the symbol name.

Parameters

aLibraryName	is the library name used to look up the library item in the LIB_TABLE.
aItemName	is the name of the library item which is not parsed by the standard LIB_ID::Parse() function.
aRevision	is the revision of the library item.

Definition at line 184 of file lib_id.cpp.

                                            :
        m_libraryName( aLibraryName ),
        m_itemName( aItemName ),
        m_revision( aRevision )
{
}

Member Function Documentation

clear()

void LIB_ID::clear

(

)

Clear the contents of the library nickname, library entry name, and revision strings.

Definition at line 114 of file lib_id.cpp.

{
    m_libraryName.clear();
    m_itemName.clear();
    m_revision.clear();
}

References UTF8::clear(), m_itemName, m_libraryName, and m_revision.

Referenced by Parse().

compare()

int LIB_ID::compare

(

const LIB_ID &

aLibId

)

const

Compare the contents of LIB_ID objects by performing a std::string comparison of the library nickname, library entry name, and revision strings respectively.

Parameters

aLibId

is the LIB_ID to compare against.

Returns

-1 if less than aLibId, 1 if greater than aLibId, and 0 if equal to aLibId.

Definition at line 311 of file lib_id.cpp.

{
    // Don't bother comparing the same object.
    if( this == &aLibId )
        return 0;

    int retv = m_libraryName.compare( aLibId.m_libraryName );

    if( retv != 0 )
        return retv;

    retv = m_itemName.compare( aLibId.m_itemName );

    if( retv != 0 )
        return retv;

    return m_revision.compare( aLibId.m_revision );
}

References UTF8::compare(), m_itemName, m_libraryName, and m_revision.

Referenced by LIB_PART::Compare(), operator >(), operator<(), and operator==().

empty()

bool LIB_ID::empty ( ) const

inline

Returns

a boolean true value if the LIB_ID is empty. Otherwise return false.

Definition at line 189 of file lib_id.h.

    {
        return m_libraryName.empty() && m_itemName.empty() && m_revision.empty();
    }

References UTF8::empty(), m_itemName, m_libraryName, and m_revision.

Referenced by BOARD_NETLIST_UPDATER::addNewComponent(), CVPCB_ASSOCIATION_TOOL::Associate(), CVPCB_MAINFRAME::AssociateFootprint(), CVPCB_MAINFRAME::AutomaticFootprintMatching(), CVPCB_MAINFRAME::GetComponentIndices(), CMP_READER::Load(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), BOARD_NETLIST_UPDATER::replaceComponent(), and DIALOG_EDIT_COMPONENTS_LIBID::setLibIdByBrowser().

FindIllegalLibraryNameChar()

unsigned LIB_ID::FindIllegalLibraryNameChar ( const UTF8 &  aLibraryName )

static

Looks for characters that are illegal in library nicknames.

Parameters

aLibraryName

is the logical library name to be tested.

Returns

Invalid character found in the name or 0 is the name is valid.

Definition at line 398 of file lib_id.cpp.

{
    for( unsigned ch : aLibraryName )
    {
        if( !isLegalLibraryNameChar( ch ) )
            return ch;
    }

    return 0;
}

References isLegalLibraryNameChar().

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

FixIllegalChars()

UTF8 LIB_ID::FixIllegalChars ( const UTF8 &  aLibItemName, bool  aLib = false  )

static

Replace illegal LIB_ID item name characters with underscores '_'.

Parameters

aLibItemName	is the LIB_ID item name to replace illegal characters.
aLib	True if we are checking library names, false if we are checking item names

Returns

the corrected version of aLibItemName.

Definition at line 347 of file lib_id.cpp.

{
    UTF8 fixedName;

    for( UTF8::uni_iter chIt = aLibItemName.ubegin(); chIt < aLibItemName.uend(); ++chIt )
    {
        auto ch = *chIt;
        if( aLib )
            fixedName += isLegalLibraryNameChar( ch ) ? ch : '_';
        else
            fixedName += isLegalChar( ch ) ? ch : '_';
    }

    return fixedName;
}

References isLegalChar(), isLegalLibraryNameChar(), UTF8::ubegin(), and UTF8::uend().

Referenced by PANEL_SYM_LIB_TABLE::browseLibrariesHandler(), PANEL_FP_LIB_TABLE::browseLibrariesHandler(), SYMBOL_EDITOR_EDIT_TOOL::editFieldProperties(), find_component(), RESCUE_CASE_CANDIDATE::FindRescues(), RESCUE_CACHE_CANDIDATE::FindRescues(), RESCUE_SYMBOL_LIB_TABLE_CANDIDATE::FindRescues(), SCH_EAGLE_PLUGIN::fixSymbolName(), SCH_ALTIUM_PLUGIN::getLibName(), SCH_EAGLE_PLUGIN::getLibName(), CADSTAR_SCH_ARCHIVE_PLUGIN::Load(), SCH_LEGACY_PLUGIN_CACHE::loadDocs(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), Parse(), and LIB_PART::SetName().

Format() [1/2]

UTF8 LIB_ID::Format

(

)

const

Returns

the fully formatted text of the LIB_ID in a UTF8 string.

Definition at line 233 of file lib_id.cpp.

{
    UTF8    ret;

    if( m_libraryName.size() )
    {
        ret += m_libraryName;
        ret += ':';
    }

    ret += m_itemName;

    if( m_revision.size() )
    {
        ret += '/';
        ret += m_revision;
    }

    return ret;
}

References m_itemName, m_libraryName, m_revision, and UTF8::size().

Referenced by SCH_SCREEN::AddLibSymbol(), BOARD_NETLIST_UPDATER::addNewComponent(), SCH_SCREEN::Append(), CVPCB_ASSOCIATION_TOOL::Associate(), CVPCB_MAINFRAME::AssociateFootprint(), CVPCB_MAINFRAME::BuildCmpListBox(), CMP_CANDIDATE::CMP_CANDIDATE(), CreateDevicesSection(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), DIALOG_EXCHANGE_FOOTPRINTS::DIALOG_EXCHANGE_FOOTPRINTS(), PART_LIB::FindPart(), RESCUE_SYMBOL_LIB_TABLE_CANDIDATE::FindRescues(), SCH_SEXPR_PLUGIN::Format(), COMPONENT::Format(), PCB_IO::format(), RESCUE_SYMBOL_LIB_TABLE_CANDIDATE::GetActionDescription(), FOOTPRINT::GetMsgPanelInfo(), SCH_COMPONENT::GetSchSymbolLibraryName(), GetUniStringLibId(), SCH_EDIT_FRAME::importFile(), PCB_EDIT_FRAME::LoadFootprints(), DSN::SPECCTRA_DB::makeIMAGE(), RESCUE_SYMBOL_LIB_TABLE_CANDIDATE::PerformAction(), DIALOG_EXCHANGE_FOOTPRINTS::processFootprint(), DIALOG_CHANGE_SYMBOLS::processSymbol(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), CVPCB_MAINFRAME::refreshAfterComponentSearch(), BOARD_NETLIST_UPDATER::replaceComponent(), RESCUE_SYMBOL_LIB_TABLE_CANDIDATE::RESCUE_SYMBOL_LIB_TABLE_CANDIDATE(), SCH_LEGACY_PLUGIN::saveComponent(), SCH_SEXPR_PLUGIN::saveSymbol(), SCH_SEXPR_PLUGIN_CACHE::SaveSymbol(), PCB_BASE_FRAME::SelectFootprintFromLibTree(), DIALOG_EDIT_COMPONENTS_LIBID::setLibIdByBrowser(), FOOTPRINTS_LISTBOX::SetSelectedFootprint(), BOARD_NETLIST_UPDATER::testConnectivity(), DIALOG_SYMBOL_PROPERTIES::TransferDataToWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataToWindow(), BOARD_NETLIST_UPDATER::UpdateNetlist(), FOOTPRINT_EDIT_FRAME::updateTitle(), SYMBOL_EDIT_FRAME::updateTitle(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

Format() [2/2]

UTF8 LIB_ID::Format ( const UTF8 &  aLibraryName, const UTF8 &  aLibItemName, const UTF8 &  aRevision = ""  )

static

Returns

a string in the proper format as an LIB_ID for a combination of aLibraryName, aLibItemName, and aRevision.

Exceptions

PARSE_ERROR

if any of the pieces are illegal.

Definition at line 269 of file lib_id.cpp.

{
    UTF8    ret;
    int     offset;

    if( aLibraryName.size() )
    {
        offset = okLogical( aLibraryName );

        if( offset != -1 )
        {
            THROW_PARSE_ERROR( _( "Illegal character found in logical library name" ),
                               wxString::FromUTF8( aLibraryName.c_str() ), aLibraryName.c_str(), 0, offset );
        }

        ret += aLibraryName;
        ret += ':';
    }

    ret += aLibItemName;    // TODO: Add validity test.

    if( aRevision.size() )
    {
        offset = okRevision( aRevision );

        if( offset != -1 )
        {
            THROW_PARSE_ERROR( _( "Illegal character found in revision" ),
                               wxString::FromUTF8( aRevision.c_str() ),
                               aRevision.c_str(),
                               0,
                               offset );
        }

        ret += '/';
        ret += aRevision;
    }

    return ret;
}

References _, UTF8::c_str(), okLogical(), okRevision(), UTF8::size(), and THROW_PARSE_ERROR.

GetLibItemName()

const UTF8& LIB_ID::GetLibItemName ( ) const

inline

Returns

the library item name, i.e. footprintName, in UTF8.

Definition at line 106 of file lib_id.h.

{ return m_itemName; }

References m_itemName.

Referenced by FOOTPRINT_EDIT_FRAME::AddFootprintToBoard(), BASIC_FOOTPRINT_INFO::BASIC_FOOTPRINT_INFO(), FOOTPRINT_EDIT_FRAME::canCloseWindow(), FOOTPRINT_EDIT_FRAME::ClearModify(), SCH_REFERENCE::CompareLibName(), SYMBOL_EDIT_FRAME::CopyPartToClipboard(), FOOTPRINT_EDIT_FRAME::DeleteFootprintFromLibrary(), SYMBOL_EDIT_FRAME::DeletePartFromLibrary(), SYMBOL_PREVIEW_WIDGET::DisplaySymbol(), SYMBOL_EDIT_FRAME::DuplicatePart(), SYMBOL_EDITOR_CONTROL::EditSymbol(), PCB_EDIT_FRAME::ExchangeFootprint(), FOOTPRINT_EDIT_FRAME::ExportFootprint(), LIB_TREE_MODEL_ADAPTER::FindItem(), PART_LIBS::FindLibPart(), RESCUE_CASE_CANDIDATE::FindRescues(), RESCUE_CACHE_CANDIDATE::FindRescues(), RESCUE_SYMBOL_LIB_TABLE_CANDIDATE::FindRescues(), FP_LIB_TABLE::FootprintLoadWithOptionalNickname(), PCB_IO::FootprintSave(), FP_LIB_TABLE::FootprintSave(), FOOTPRINT_INFO_GENERATOR::GenerateHtml(), PLACE_FILE_EXPORTER::GenPositionData(), RESCUE_SYMBOL_LIB_TABLE_CANDIDATE::GetActionDescription(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), FOOTPRINT_LIST::GetFootprintInfo(), SYMBOL_EDIT_FRAME::getTargetPart(), FP_TREE_SYNCHRONIZING_ADAPTER::GetValue(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetValue(), guessNickname(), PCB_EDIT_FRAME::importFile(), SYMBOL_EDITOR_CONTROL::Init(), FOOTPRINT_EDITOR_CONTROL::Init(), SYMBOL_EDIT_FRAME::isCurrentPart(), LEGACY_PLUGIN::loadFOOTPRINT(), PCB_EDIT_FRAME::LoadFootprints(), LEGACY_PLUGIN::loadFP_SHAPE(), LEGACY_PLUGIN::loadPAD(), SYMBOL_LIB_TABLE::LoadSymbol(), SYMBOL_EDIT_FRAME::LoadSymbolAndSelectLib(), SYMBOL_LIB_TABLE::LoadSymbolWithOptionalNickname(), NETLIST_EXPORTER_XML::makeSymbols(), DIALOG_EDIT_COMPONENTS_LIBID::onClickOrphansButton(), RESCUE_SYMBOL_LIB_TABLE_CANDIDATE::PerformAction(), SCH_BASE_FRAME::PickSymbolFromLibBrowser(), DIALOG_CHOOSE_SYMBOL::PopulateFootprintSelector(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), CVPCB_MAINFRAME::ReadSchematicNetlist(), PCB_EDIT_FRAME::RecreateBOMFileFromBoard(), DIALOG_SYMBOL_REMAP::remapSymbolToLibTable(), SYMBOL_EDIT_FRAME::Revert(), FOOTPRINT_EDITOR_CONTROL::SaveAs(), SYMBOL_EDIT_FRAME::saveCurrentPart(), FOOTPRINT_EDIT_FRAME::SaveFootprint(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), FOOTPRINT_EDIT_FRAME::SaveFootprintInLibrary(), SYMBOL_EDIT_FRAME::savePartAs(), SYMBOL_LIB_TABLE::SaveSymbol(), SCH_SEXPR_PLUGIN_CACHE::SaveSymbol(), SchGetLibPart(), setLibNickname(), LIB_TREE::setState(), FOOTPRINT_EDIT_FRAME::setupUIConditions(), DIALOG_CHOOSE_SYMBOL::ShowFootprintFor(), SYMBOL_VIEWER_FRAME::ShowModal(), FOOTPRINT_VIEWER_FRAME::ShowModal(), ERC_TESTER::TestLibSymbolIssues(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_FOOTPRINT_FP_EDITOR::TransferDataToWindow(), SCH_COMPONENT::UpdateFields(), PCB_CONTROL::UpdateMessagePanel(), SYMBOL_LIBRARY_MANAGER::UpdatePart(), and FOOTPRINT_EDIT_FRAME::updateTitle().

GetLibItemNameAndRev()

UTF8 LIB_ID::GetLibItemNameAndRev

(

)

const

Definition at line 255 of file lib_id.cpp.

{
    UTF8 ret = m_itemName;

    if( m_revision.size() )
    {
        ret += '/';
        ret += m_revision;
    }

    return ret;
}

References m_itemName, m_revision, and UTF8::size().

Referenced by PCB_IO::format().

GetLibNickname()

const UTF8& LIB_ID::GetLibNickname ( ) const

inline

Return the logical library name portion of a LIB_ID.

Definition at line 92 of file lib_id.h.

{ return m_libraryName; }

References m_libraryName.

Referenced by BASIC_FOOTPRINT_INFO::BASIC_FOOTPRINT_INFO(), SYMBOL_EDIT_FRAME::CopyPartToClipboard(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), FOOTPRINT_EDIT_FRAME::DeleteFootprintFromLibrary(), SYMBOL_EDIT_FRAME::DeletePartFromLibrary(), CVPCB_MAINFRAME::DisplayStatus(), SYMBOL_PREVIEW_WIDGET::DisplaySymbol(), LIB_TREE_MODEL_ADAPTER::DoAddLibraryNode(), SYMBOL_EDIT_FRAME::DuplicatePart(), SYMBOL_EDITOR_CONTROL::EditSymbol(), LIB_TREE_MODEL_ADAPTER::FindItem(), RESCUE_SYMBOL_LIB_TABLE_CANDIDATE::FindRescues(), FP_LIB_TABLE::FootprintLoadWithOptionalNickname(), FOOTPRINT_INFO_GENERATOR::GenerateHtml(), FP_TREE_SYNCHRONIZING_ADAPTER::GetAttr(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetAttr(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), FOOTPRINT_LIST::GetFootprintInfo(), SCH_SCREENS::GetLibNicknames(), LIB_PART::GetLibraryName(), FOOTPRINT_EDIT_FRAME::GetLoadedFPID(), SCH_COMPONENT::GetMsgPanelInfo(), SYMBOL_EDIT_FRAME::getTargetLib(), SYMBOL_EDIT_FRAME::getTargetPart(), guessNickname(), SCH_SCREENS::HasNoFullyDefinedLibIds(), SYMBOL_EDITOR_CONTROL::Init(), FOOTPRINT_EDITOR_CONTROL::Init(), SYMBOL_EDIT_FRAME::isCurrentPart(), SYMBOL_LIB_TABLE::LoadSymbol(), SYMBOL_EDIT_FRAME::LoadSymbolAndSelectLib(), SYMBOL_LIB_TABLE::LoadSymbolWithOptionalNickname(), FOOTPRINT_EDITOR_CONTROL::NewFootprint(), FOOTPRINT_EDITOR_CONTROL::PasteFootprint(), SCH_BASE_FRAME::PickSymbolFromLibBrowser(), DIALOG_CHOOSE_SYMBOL::PopulateFootprintSelector(), DIALOG_SYMBOL_REMAP::remapSymbolToLibTable(), SYMBOL_EDIT_FRAME::Revert(), SYMBOL_EDIT_FRAME::Save(), FOOTPRINT_EDITOR_CONTROL::SaveAs(), SYMBOL_EDIT_FRAME::saveCurrentPart(), FOOTPRINT_EDIT_FRAME::SaveFootprint(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), SYMBOL_EDIT_FRAME::SaveLibraryAs(), SYMBOL_EDIT_FRAME::savePartAs(), SchGetLibPart(), setLibNickname(), LIB_TREE::setState(), SYMBOL_EDIT_FRAME::setupUIConditions(), DIALOG_CHOOSE_SYMBOL::ShowFootprintFor(), SYMBOL_VIEWER_FRAME::ShowModal(), FOOTPRINT_VIEWER_FRAME::ShowModal(), ERC_TESTER::TestLibSymbolIssues(), LIB_TREE_NODE_LIB_ID::Update(), PCB_CONTROL::UpdateMessagePanel(), and FOOTPRINT_EDIT_FRAME::updateTitle().

GetRevision()

const UTF8& LIB_ID::GetRevision ( ) const

inline

Definition at line 129 of file lib_id.h.

{ return m_revision; }

References m_revision.

GetUniStringLibId()

wxString LIB_ID::GetUniStringLibId ( ) const

inline

Returns

the fully formatted text of the LIB_ID in a wxString (UTF16 or UTF32), suitable to display the LIB_ID in dialogs.

Definition at line 142 of file lib_id.h.

    {
        return Format().wx_str();
    }

References Format(), and UTF8::wx_str().

Referenced by CVPCB_ASSOCIATION_TOOL::CopyAssoc(), CVPCB_ASSOCIATION_TOOL::CutAssoc(), CMP_CANDIDATE::GetStringLibId(), DISPLAY_FOOTPRINTS_FRAME::InitDisplay(), and ERC_TESTER::TestLibSymbolIssues().

GetUniStringLibItemName()

const wxString LIB_ID::GetUniStringLibItemName ( ) const

inline

Get strings for display messages in dialogs.

Equivalent to m_itemName.wx_str(), but more explicit when building a Unicode string in messages.

Returns

the library item name, i.e. footprintName in a wxString (UTF16 or 32).

Definition at line 116 of file lib_id.h.

{ return m_itemName.wx_str(); }

References m_itemName, and UTF8::wx_str().

Referenced by SYMBOL_EDIT_FRAME::DeletePartFromLibrary().

HasIllegalChars()

int LIB_ID::HasIllegalChars ( const UTF8 &  aLibItemName )

static

Examine aLibItemName for invalid LIB_ID item name characters.

Parameters

aLibItemName

is the LIB_ID name to test for illegal characters.

Returns

offset of first illegal character otherwise -1.

Definition at line 331 of file lib_id.cpp.

{
    int offset = 0;

    for( auto ch : aLibItemName )
    {
        if( !isLegalChar( ch ) )
            return offset;
        else
            ++offset;
    }

    return -1;
}

References isLegalChar().

Referenced by RESCUE_SYMBOL_LIB_TABLE_CANDIDATE::FindRescues(), and Parse().

IsLegacy()

bool LIB_ID::IsLegacy ( ) const

inline

Returns

true if the LIB_ID only has the m_itemName name defined.

Definition at line 176 of file lib_id.h.

    {
        return m_libraryName.empty() && !m_itemName.empty() && m_revision.empty();
    }

References UTF8::empty(), m_itemName, m_libraryName, and m_revision.

Referenced by CVPCB_MAINFRAME::ReadNetListAndFpFiles().

isLegalChar()

bool LIB_ID::isLegalChar ( unsigned  aUniChar )

staticprotected

Tests whether a Unicode character is a legal LIB_ID item name character.

The criteria for legal LIB_ID character is as follows:

• For both symbol and footprint names, neither '/' or ':' are legal. They are reserved characters used by LIB_ID::Parse.
• Spaces are allowed in footprint names as they are a legal filename character on all operating systems.
• Spaces are not allowed in symbol names since symbol names are not quoted in the schematic or symbol library file formats.
• Spaces are allowed in footprint library nicknames as they are quoted in the footprint library table file format.
• Spaces are now also allowed in symbol library nicknames since they are quoted in the new symbol library sexpr file format.
• Illegal file name characters are not allowed in footprint names since the file name is the footprint name.
• Illegal file name characters except '/' are allowed in symbol names since the name is not the file name.

Note

aUniChar is expected to be a 32 bit Unicode character, not a UTF8 char, that use a variable length coding value.

Definition at line 364 of file lib_id.cpp.

{
    bool const space_allowed = true;
    bool const illegal_filename_chars_allowed = false;

    if( aUniChar < ' ' )
        return false;

    // This list of characters is also duplicated in validators.cpp and footprint.cpp
    // TODO: Unify forbidden character lists
    switch( aUniChar )
    {
    case ':':
    case '/':
    case '\t':
    case '\n':
    case '\r':
        return false;

    case '\\':
    case '<':
    case '>':
    case '"':
        return illegal_filename_chars_allowed;

    case ' ':
        return space_allowed;

    default:
        return true;
    }
}

Referenced by FixIllegalChars(), and HasIllegalChars().

isLegalLibraryNameChar()

bool LIB_ID::isLegalLibraryNameChar ( unsigned  aUniChar )

staticprotected

Tests whether a Unicode character is a legal LIB_ID library nickname character.

Note

aUniChar is expected to be a 32 bit Unicode character, not a UTF8 char, that use a variable length coding value.

Definition at line 410 of file lib_id.cpp.

{
    bool const space_allowed = true;

    if( aUniChar < ' ' )
        return false;

    switch( aUniChar )
    {
    case '\\':
    case ':':
        return false;

    case ' ':
        return space_allowed;

    default:
        return true;
    }
}

Referenced by FindIllegalLibraryNameChar(), and FixIllegalChars().

IsValid()

bool LIB_ID::IsValid ( ) const

inline

Check if this LID_ID is valid.

A valid LIB_ID must have both the library nickname and the library item name defined. The revision field is optional.

Note

A return value of true does not indicated that the LIB_ID is a valid LIB_TABLE entry.

Returns

true is the LIB_ID is valid.

Definition at line 168 of file lib_id.h.

    {
        return !m_libraryName.empty() && !m_itemName.empty();
    }

References UTF8::empty(), m_itemName, and m_libraryName.

Referenced by SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), CVPCB_ASSOCIATION_TOOL::Associate(), CVPCB_MAINFRAME::AssociateFootprint(), CVPCB_ASSOCIATION_TOOL::CopyAssoc(), CVPCB_ASSOCIATION_TOOL::CutAssoc(), FOOTPRINT_EDIT_FRAME::DeleteFootprintFromLibrary(), FOOTPRINT_EDITOR_CONTROL::ExportFootprint(), FOOTPRINT_INFO_GENERATOR::GenerateHtml(), SYMBOL_EDIT_FRAME::getTargetPart(), DIALOG_CHOOSE_FOOTPRINT::OnComponentPreselected(), DIALOG_CHOOSE_FOOTPRINT::OnComponentSelected(), DIALOG_CHOOSE_SYMBOL::OnComponentSelected(), CVPCB_MAINFRAME::OnSelectComponent(), SCH_BASE_FRAME::PickSymbolFromLibBrowser(), SCH_BASE_FRAME::PickSymbolFromLibTree(), SCH_DRAWING_TOOLS::PlaceComponent(), DIALOG_CHOOSE_SYMBOL::PopulateFootprintSelector(), DIALOG_EXCHANGE_FOOTPRINTS::processMatchingFootprints(), DIALOG_CHANGE_SYMBOLS::processMatchingSymbols(), DIALOG_CHANGE_SYMBOLS::processSymbol(), SYMBOL_EDIT_FRAME::RegenerateLibraryTree(), FOOTPRINT_EDIT_FRAME::RegenerateLibraryTree(), PCB_BASE_FRAME::SelectFootprintFromLibTree(), DIALOG_EDIT_COMPONENTS_LIBID::setLibIdByBrowser(), DIALOG_CHOOSE_SYMBOL::ShowFootprint(), SYMBOL_VIEWER_FRAME::ShowModal(), FOOTPRINT_VIEWER_FRAME::ShowModal(), LIB_TREE_MODEL_ADAPTER::ShowPreselect(), SYMBOL_EDIT_FRAME::SyncLibraries(), DIALOG_CHANGE_SYMBOLS::updateFieldsList(), and FOOTPRINT_EDIT_FRAME::updateTitle().

operator !=()

bool LIB_ID::operator != ( const LIB_ID &  aLibId ) const

inline

Definition at line 206 of file lib_id.h.

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

operator >()

bool LIB_ID::operator > ( const LIB_ID &  aLibId ) const

inline

Definition at line 204 of file lib_id.h.

{ return this->compare( aLibId ) > 0; }

References compare().

operator<()

bool LIB_ID::operator< ( const LIB_ID &  aLibId ) const

inline

Definition at line 203 of file lib_id.h.

{ return this->compare( aLibId ) < 0; }

References compare().

operator==()

bool LIB_ID::operator== ( const LIB_ID &  aLibId ) const

inline

Definition at line 205 of file lib_id.h.

{ return this->compare( aLibId ) == 0; }

References compare().

Parse()

int LIB_ID::Parse	(	const UTF8 &	aId,
		bool	aFix = false
	)

Parse LIB_ID with the information from aId.

A typical LIB_ID string consists of a library nickname followed by a library item name. e.g.: "smt:R_0805", or e.g.: "mylib:R_0805", or e.g.: "ttl:7400"

Parameters

aId	is the string to populate the LIB_ID object.
aFix	indicates invalid chars should be replaced with '_'.

Returns

minus 1 (i.e. -1) means success, >= 0 indicates the character offset into aId at which an error was detected.

Definition at line 122 of file lib_id.cpp.

{
    clear();

    const char* buffer = aId.c_str();
    const char* rev = EndsWithRev( buffer, buffer+aId.length(), '/' );
    size_t      revNdx;
    size_t      partNdx;
    int         offset = -1;

    //=====<revision>=====================================
    // in a LIB_ID like discret:R3/rev4
    if( rev )
    {
        revNdx = rev - buffer;

        // no need to check revision, EndsWithRev did that.
        m_revision = aId.substr( revNdx );
        --revNdx;  // back up to omit the '/' which precedes the rev
    }
    else
    {
        revNdx = aId.size();
    }

    //=====<name>=========================================
    if( ( partNdx = aId.find( ':' ) ) != aId.npos )
    {
        offset = SetLibNickname( aId.substr( 0, partNdx ) );

        if( offset > -1 )
            return offset;

        ++partNdx;  // skip ':'
    }
    else
    {
        partNdx = 0;
    }

    //=====<item name>====================================
    if( partNdx >= revNdx )
        return partNdx;     // Error: no library item name.

    UTF8 fpname = aId.substr( partNdx, revNdx-partNdx );

    // Be sure the item name is valid.
    // Some chars can be found in legacy files converted files from other EDA tools.
    if( aFix )
        fpname = FixIllegalChars( fpname, false );
    else
        offset = HasIllegalChars( fpname );

    if( offset > -1 )
        return offset;

    SetLibItemName( fpname );

    return -1;
}

References UTF8::c_str(), clear(), EndsWithRev(), UTF8::find(), FixIllegalChars(), HasIllegalChars(), UTF8::length(), m_revision, UTF8::npos, SetLibItemName(), SetLibNickname(), UTF8::size(), and UTF8::substr().

Referenced by PCAD2KICAD::PCB_FOOTPRINT::AddToBoard(), AltiumToKiCadLibID(), CVPCB_ASSOCIATION_TOOL::Associate(), CVPCB_ASSOCIATION_TOOL::CopyAssoc(), CVPCB_ASSOCIATION::CVPCB_ASSOCIATION(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), FOOTPRINT_LIST::GetFootprintInfo(), SCH_EDIT_FRAME::importFile(), DIALOG_EXCHANGE_FOOTPRINTS::isMatch(), CMP_READER::Load(), LEGACY_PLUGIN::loadAllSections(), SCH_LEGACY_PLUGIN::loadComponent(), CADSTAR_PCB_ARCHIVE_LOADER::loadComponentLibrary(), FABMASTER::loadFootprints(), EAGLE_PLUGIN::makeFootprint(), DIALOG_EDIT_COMPONENTS_LIBID::onClickOrphansButton(), KICAD_NETLIST_PARSER::parseComponent(), PCB_PARSER::parseFOOTPRINT_unchecked(), SCH_SEXPR_PARSER::parseSchematicSymbol(), CVPCB_ASSOCIATION_TOOL::PasteAssoc(), DIALOG_EXCHANGE_FOOTPRINTS::processMatchingFootprints(), DIALOG_CHANGE_SYMBOLS::processMatchingSymbols(), SCH_SEXPR_PLUGIN_CACHE::SaveSymbol(), PCB_BASE_FRAME::SelectFootprintFromLibTree(), DIALOG_EDIT_COMPONENTS_LIBID::setLibIdByBrowser(), DIALOG_CHOOSE_SYMBOL::ShowFootprint(), SYMBOL_VIEWER_FRAME::ShowModal(), FOOTPRINT_VIEWER_FRAME::ShowModal(), DIALOG_EDIT_COMPONENTS_LIBID::TransferDataFromWindow(), DIALOG_CHANGE_SYMBOLS::updateFieldsList(), and DIALOG_EDIT_COMPONENTS_LIBID::validateLibIds().

SetLibItemName()

int LIB_ID::SetLibItemName	(	const UTF8 &	aLibItemName,
		bool	aTestForRev = true
	)

Override the library item name portion of the LIB_ID to aLibItemName.

Returns

int - minus 1 (i.e. -1) means success, >= 0 indicates the character offset into the parameter at which an error was detected, usually because it contained '/'.

Definition at line 204 of file lib_id.cpp.

{
    int separation = int( aLibItemName.find_first_of( "/" ) );

    if( aTestForRev && separation != -1 )
    {
        m_itemName = aLibItemName.substr( 0, separation-1 );
        return separation;
    }
    else
    {
        m_itemName = aLibItemName;
    }

    return -1;
}

References UTF8::find_first_of(), m_itemName, and UTF8::substr().

Referenced by BOOST_AUTO_TEST_CASE(), LIB_TREE_NODE_LIB_ID::LIB_TREE_NODE_LIB_ID(), SCH_LEGACY_PLUGIN::loadComponent(), LEGACY_NETLIST_READER::loadComponent(), Parse(), RESCUE_CASE_CANDIDATE::PerformAction(), RESCUE_CACHE_CANDIDATE::PerformAction(), LIB_PART::SetName(), SYMBOL_EDIT_FRAME::SyncLibraries(), DIALOG_FOOTPRINT_FP_EDITOR::TransferDataFromWindow(), and RESCUER::UndoRescues().

SetLibNickname()

int LIB_ID::SetLibNickname

(

const UTF8 &

aNickname

)

Override the logical library name portion of the LIB_ID to aNickname.

Returns

int - minus 1 (i.e. -1) means success, >= 0 indicates the character offset into the parameter at which an error was detected, usually because it contained '/' or ':'.

Definition at line 193 of file lib_id.cpp.

{
    int offset = okLogical( aLogical );

    if( offset == -1 )
        m_libraryName = aLogical;

    return offset;
}

References m_libraryName, and okLogical().

Referenced by SCH_SCREENS::ChangeSymbolLibNickname(), FOOTPRINT_VIEWER_FRAME::ClickOnFootprintList(), SYMBOL_LIBRARY_MANAGER::LIB_BUFFER::CreateBuffer(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), guessNickname(), PCB_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::importFile(), LIB_TREE_NODE_LIB::LIB_TREE_NODE_LIB(), LIB_TREE_NODE_LIB_ID::LIB_TREE_NODE_LIB_ID(), SYMBOL_LIB_TABLE::LoadSymbol(), SYMBOL_LIB_TABLE::LoadSymbolLib(), FOOTPRINT_EDITOR_CONTROL::NewFootprint(), Parse(), DIALOG_SYMBOL_REMAP::remapSymbolToLibTable(), FOOTPRINT_EDIT_FRAME::restoreLastFootprint(), setLibNickname(), and LIB_TREE_NODE_LIB_ID::Update().

SetRevision()

int LIB_ID::SetRevision

(

const UTF8 &

aRevision

)

Definition at line 222 of file lib_id.cpp.

{
    int offset = okRevision( aRevision );

    if( offset == -1 )
        m_revision = aRevision;

    return offset;
}

References m_revision, and okRevision().

Member Data Documentation

m_itemName

UTF8 LIB_ID::m_itemName

protected

The name of the entry in the logical library.

Definition at line 268 of file lib_id.h.

Referenced by clear(), compare(), empty(), Format(), GetLibItemName(), GetLibItemNameAndRev(), GetUniStringLibItemName(), IsLegacy(), IsValid(), and SetLibItemName().

m_libraryName

UTF8 LIB_ID::m_libraryName

protected

The nickname of the library or empty.

Definition at line 267 of file lib_id.h.

Referenced by clear(), compare(), empty(), Format(), GetLibNickname(), IsLegacy(), IsValid(), and SetLibNickname().

m_revision

UTF8 LIB_ID::m_revision

protected

The revision of the entry.

Definition at line 269 of file lib_id.h.

Referenced by clear(), compare(), empty(), Format(), GetLibItemNameAndRev(), GetRevision(), IsLegacy(), Parse(), and SetRevision().

---

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

• lib_id.h
• lib_id.cpp