LIB_ID Class Reference

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

#include <lib_id.h>

Public Types
enum	LIB_ID_TYPE { ID_SCH, ID_PCB }
	Types of library identifiers More...

Public Member Functions
	LIB_ID ()
	LIB_ID (const wxString &aLibName, const wxString &aLibItemName, 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, LIB_ID_TYPE aType, 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
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
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 &aLibNickname, const UTF8 &aLibItemName, const UTF8 &aRevision="")
static int	HasIllegalChars (const UTF8 &aLibItemName, LIB_ID_TYPE aType)
	Examine aLibItemName for invalid LIB_ID item name characters. More...
static UTF8	FixIllegalChars (const UTF8 &aLibItemName, LIB_ID_TYPE aType, bool aLib=false)
	Replace illegal LIB_ID item name characters with underscores '_'. More...
static unsigned	FindIllegalLibNicknameChar (const UTF8 &aNickname, LIB_ID_TYPE aType)
	Looks for characters that are illegal in library nicknames. More...

Static Protected Member Functions
static bool	isLegalChar (unsigned aUniChar, LIB_ID_TYPE aType)
	Tests whether a unicode character is a legal LIB_ID item name character. More...
static bool	isLegalLibNicknameChar (unsigned aUniChar, LIB_ID_TYPE aType)
	Tests whether a unicode character is a legal LIB_ID library nickname character. More...

Protected Attributes
UTF8	nickname
	The nickname of the library or empty. More...
UTF8	item_name
	The name of the entry in the logical library. More...
UTF8	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.

Member Enumeration Documentation

LIB_ID_TYPE

enum LIB_ID::LIB_ID_TYPE

Types of library identifiers

Enumerator
ID_SCH
ID_PCB

Definition at line 56 of file lib_id.h.

{ ID_SCH, ID_PCB };

Constructor & Destructor Documentation

LIB_ID() [1/2]

LIB_ID::LIB_ID ( )

inline

Definition at line 58 of file lib_id.h.

{}

LIB_ID() [2/2]

LIB_ID::LIB_ID	(	const wxString &	aLibName,
		const wxString &	aLibItemName,
		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

aLibName	is the library nickname used to look up the library item in the LIB_TABLE.
aLibItemName	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.

                                            :
    nickname( aLibName ),
    item_name( aLibItemName ),
    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.

{
    nickname.clear();
    item_name.clear();
    revision.clear();
}

References UTF8::clear(), item_name, nickname, and 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 316 of file lib_id.cpp.

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

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

    if( retv != 0 )
        return retv;

    retv = item_name.compare( aLibId.item_name );

    if( retv != 0 )
        return retv;

    return revision.compare( aLibId.revision );
}

References UTF8::compare(), item_name, nickname, and 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 186 of file lib_id.h.

{ return nickname.empty() && item_name.empty() && revision.empty(); }

References UTF8::empty(), item_name, nickname, and 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().

FindIllegalLibNicknameChar()

unsigned LIB_ID::FindIllegalLibNicknameChar ( const UTF8 &  aNickname, LIB_ID_TYPE  aType  )

static

Looks for characters that are illegal in library nicknames.

Parameters

aNickname	is the logical library name to be tested.
aType	is the library identifier type

Returns

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

Definition at line 403 of file lib_id.cpp.

{
    for( unsigned ch : aNickname )
    {
        if( !isLegalLibNicknameChar( ch, aType ) )
            return ch;
    }

    return 0;
}

References isLegalLibNicknameChar().

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

FixIllegalChars()

UTF8 LIB_ID::FixIllegalChars ( const UTF8 &  aLibItemName, LIB_ID_TYPE  aType, 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.
aType	is the library identifier type
aLib	True if we are checking library names, false if we are checking item names

Returns

the corrected version of aLibItemName.

Definition at line 352 of file lib_id.cpp.

{
    UTF8 fixedName;

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

    return fixedName;
}

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

Referenced by PANEL_SYM_LIB_TABLE::browseLibrariesHandler(), PANEL_FP_LIB_TABLE::browseLibrariesHandler(), LIB_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 237 of file lib_id.cpp.

{
    UTF8    ret;

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

    ret += item_name;

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

    return ret;
}

References item_name, nickname, 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(), SYMBOL_EDIT_FRAME::updateTitle(), FOOTPRINT_EDIT_FRAME::updateTitle(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

Format() [2/2]

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

static

Returns

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

Exceptions

PARSE_ERROR

if any of the pieces are illegal.

Definition at line 273 of file lib_id.cpp.

{
    UTF8    ret;
    int     offset;

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

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

        ret += aLogicalLib;
        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 114 of file lib_id.h.

{ return item_name; }

References item_name.

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(), LIB_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(), LIB_CONTROL::Init(), FOOTPRINT_EDITOR_TOOLS::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_COMPONENT::PopulateFootprintSelector(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), CVPCB_MAINFRAME::ReadSchematicNetlist(), PCB_EDIT_FRAME::RecreateBOMFileFromBoard(), DIALOG_SYMBOL_REMAP::remapSymbolToLibTable(), SYMBOL_EDIT_FRAME::Revert(), SYMBOL_EDIT_FRAME::Save(), FOOTPRINT_EDITOR_TOOLS::SaveAs(), SYMBOL_EDIT_FRAME::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(), SYMBOL_EDIT_FRAME::setupUIConditions(), FOOTPRINT_EDIT_FRAME::setupUIConditions(), DIALOG_CHOOSE_COMPONENT::ShowFootprintFor(), LIB_VIEW_FRAME::ShowModal(), FOOTPRINT_VIEWER_FRAME::ShowModal(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_FOOTPRINT_FP_EDITOR::TransferDataToWindow(), SCH_COMPONENT::UpdateFields(), PCBNEW_CONTROL::UpdateMessagePanel(), SYMBOL_LIBRARY_MANAGER::UpdatePart(), and FOOTPRINT_EDIT_FRAME::updateTitle().

GetLibItemNameAndRev()

UTF8 LIB_ID::GetLibItemNameAndRev

(

)

const

Definition at line 259 of file lib_id.cpp.

{
    UTF8 ret = item_name;

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

    return ret;
}

References item_name, 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 97 of file lib_id.h.

    {
        return nickname;
    }

References nickname.

Referenced by BASIC_FOOTPRINT_INFO::BASIC_FOOTPRINT_INFO(), SYMBOL_EDIT_FRAME::CopyPartToClipboard(), FOOTPRINT_EDITOR_TOOLS::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(), LIB_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(), 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(), LIB_CONTROL::Init(), FOOTPRINT_EDITOR_TOOLS::Init(), SYMBOL_EDIT_FRAME::isCurrentPart(), SYMBOL_LIB_TABLE::LoadSymbol(), SYMBOL_EDIT_FRAME::LoadSymbolAndSelectLib(), SYMBOL_LIB_TABLE::LoadSymbolWithOptionalNickname(), FOOTPRINT_EDITOR_TOOLS::NewFootprint(), FOOTPRINT_EDITOR_TOOLS::PasteFootprint(), SCH_BASE_FRAME::PickSymbolFromLibBrowser(), DIALOG_CHOOSE_COMPONENT::PopulateFootprintSelector(), DIALOG_SYMBOL_REMAP::remapSymbolToLibTable(), SYMBOL_EDIT_FRAME::Revert(), SYMBOL_EDIT_FRAME::Save(), FOOTPRINT_EDITOR_TOOLS::SaveAs(), SYMBOL_EDIT_FRAME::SaveAs(), SYMBOL_EDIT_FRAME::saveCurrentPart(), FOOTPRINT_EDIT_FRAME::SaveFootprint(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), SYMBOL_EDIT_FRAME::savePartAs(), SchGetLibPart(), setLibNickname(), LIB_TREE::setState(), SYMBOL_EDIT_FRAME::setupUIConditions(), DIALOG_CHOOSE_COMPONENT::ShowFootprintFor(), LIB_VIEW_FRAME::ShowModal(), FOOTPRINT_VIEWER_FRAME::ShowModal(), LIB_TREE_NODE_LIB_ID::Update(), PCBNEW_CONTROL::UpdateMessagePanel(), and FOOTPRINT_EDIT_FRAME::updateTitle().

GetRevision()

const UTF8& LIB_ID::GetRevision ( ) const

inline

Definition at line 134 of file lib_id.h.

{ return revision; }

References 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. Equivalent to Format().wx_str(), but more explicit when building a Unicode string in messages.

Definition at line 148 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

Returns

the library item name, i.e. footprintName in a wxString (UTF16 or 32). useful to display messages in dialogs Equivalent to item_name.wx_str(), but more explicit when building a Unicode string in messages.

Definition at line 121 of file lib_id.h.

{ return item_name.wx_str(); }

References item_name, and UTF8::wx_str().

Referenced by SYMBOL_EDIT_FRAME::DeletePartFromLibrary().

HasIllegalChars()

int LIB_ID::HasIllegalChars ( const UTF8 &  aLibItemName, LIB_ID_TYPE  aType  )

static

Examine aLibItemName for invalid LIB_ID item name characters.

Parameters

aLibItemName	is the LIB_ID name to test for illegal characters.
aType	is the library identifier type

Returns

offset of first illegal character otherwise -1.

Definition at line 336 of file lib_id.cpp.

{
    int offset = 0;

    for( auto ch : aLibItemName )
    {
        if( !isLegalChar( ch, aType ) )
            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 item_name name defined.

Definition at line 176 of file lib_id.h.

{ return nickname.empty() && !item_name.empty() && revision.empty(); }

References UTF8::empty(), item_name, nickname, and revision.

Referenced by CVPCB_MAINFRAME::ReadNetListAndFpFiles().

isLegalChar()

bool LIB_ID::isLegalChar ( unsigned  aUniChar, LIB_ID_TYPE  aType  )

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 not allowed in symbol library nicknames since they are not quoted in the symbol library 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 369 of file lib_id.cpp.

{
    bool const space_allowed = ( aType == ID_PCB );
    bool const illegal_filename_chars_allowed = ( aType == ID_SCH );

    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;
    }
}

References ID_PCB, and ID_SCH.

Referenced by FixIllegalChars(), and HasIllegalChars().

isLegalLibNicknameChar()

bool LIB_ID::isLegalLibNicknameChar ( unsigned  aUniChar, LIB_ID_TYPE  aType  )

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 415 of file lib_id.cpp.

{
    bool const space_allowed = ( aType != ID_SCH );

    if( aUniChar < ' ' )
        return false;

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

    case ' ':
        return space_allowed;

    default:
        return true;
    }
}

References ID_SCH.

Referenced by FindIllegalLibNicknameChar(), and FixIllegalChars().

IsValid()

bool LIB_ID::IsValid ( ) const

inline

Returns

true is the LIB_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.

Definition at line 171 of file lib_id.h.

{ return !nickname.empty() && !item_name.empty(); }

References UTF8::empty(), item_name, and nickname.

Referenced by LIB_CONTROL::AddSymbolToSchematic(), CVPCB_ASSOCIATION_TOOL::Associate(), CVPCB_MAINFRAME::AssociateFootprint(), CVPCB_ASSOCIATION_TOOL::CopyAssoc(), CVPCB_ASSOCIATION_TOOL::CutAssoc(), FOOTPRINT_EDIT_FRAME::DeleteFootprintFromLibrary(), FOOTPRINT_EDITOR_TOOLS::ExportFootprint(), FOOTPRINT_INFO_GENERATOR::GenerateHtml(), SYMBOL_EDIT_FRAME::getTargetPart(), DIALOG_CHOOSE_FOOTPRINT::OnComponentPreselected(), DIALOG_CHOOSE_FOOTPRINT::OnComponentSelected(), DIALOG_CHOOSE_COMPONENT::OnComponentSelected(), CVPCB_MAINFRAME::OnSelectComponent(), SCH_BASE_FRAME::PickSymbolFromLibBrowser(), SCH_BASE_FRAME::PickSymbolFromLibTree(), SCH_DRAWING_TOOLS::PlaceComponent(), DIALOG_CHOOSE_COMPONENT::PopulateFootprintSelector(), DIALOG_EXCHANGE_FOOTPRINTS::processMatchingFootprints(), DIALOG_CHANGE_SYMBOLS::processMatchingSymbols(), DIALOG_CHANGE_SYMBOLS::processSymbol(), FOOTPRINT_EDIT_FRAME::RegenerateLibraryTree(), SYMBOL_EDIT_FRAME::RegenerateLibraryTree(), PCB_BASE_FRAME::SelectFootprintFromLibTree(), DIALOG_EDIT_COMPONENTS_LIBID::setLibIdByBrowser(), DIALOG_CHOOSE_COMPONENT::ShowFootprint(), LIB_VIEW_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 201 of file lib_id.h.

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

operator >()

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

inline

Definition at line 199 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 198 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 200 of file lib_id.h.

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

References compare().

Parse()

int LIB_ID::Parse	(	const UTF8 &	aId,
		LIB_ID_TYPE	aType,
		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.
aType	indicates the LIB_ID type for type-specific parsing (such as allowed chars).
aFix	indicates invalid chars should be replaced with '_'.

Returns

int - 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.
        revision = aId.substr( revNdx );
        --revNdx;  // back up to omit the '/' which precedes the rev
    }
    else
    {
        revNdx = aId.size();
    }

    //=====<nickname>==========================================
    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, aType, false );
    else
        offset = HasIllegalChars( fpname, aType );

    if( offset > -1 )
        return offset;

    SetLibItemName( fpname );

    return -1;
}

References UTF8::c_str(), clear(), EndsWithRev(), UTF8::find(), FixIllegalChars(), HasIllegalChars(), UTF8::length(), UTF8::npos, revision, 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(), 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_COMPONENT::ShowFootprint(), LIB_VIEW_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 206 of file lib_id.cpp.

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

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

    return -1;
}

References UTF8::find_first_of(), item_name, 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 )
    {
        nickname = aLogical;
    }

    return offset;
}

References nickname, and okLogical().

Referenced by SCH_SCREENS::ChangeSymbolLibNickname(), FOOTPRINT_VIEWER_FRAME::ClickOnFootprintList(), SYMBOL_LIBRARY_MANAGER::LIB_BUFFER::CreateBuffer(), FOOTPRINT_EDITOR_TOOLS::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_TOOLS::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 224 of file lib_id.cpp.

{
    int offset = okRevision( aRevision );

    if( offset == -1 )
    {
        revision = aRevision;
    }

    return offset;
}

References okRevision(), and revision.

Member Data Documentation

item_name

UTF8 LIB_ID::item_name

protected

The name of the entry in the logical library.

Definition at line 266 of file lib_id.h.

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

nickname

UTF8 LIB_ID::nickname

protected

The nickname of the library or empty.

Definition at line 265 of file lib_id.h.

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

revision

UTF8 LIB_ID::revision

protected

The revision of the entry.

Definition at line 267 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