KiCad PCB EDA Suite
fp_lib_table.cpp File Reference
#include <fctsys.h>
#include <common.h>
#include <kiface_i.h>
#include <footprint_info.h>
#include <lib_id.h>
#include <lib_table_lexer.h>
#include <fp_lib_table.h>
#include <class_module.h>

Go to the source code of this file.


#define OPT_SEP   '|'
 options separator character More...


static void setLibNickname (MODULE *aModule, const wxString &aNickname, const wxString &aFootprintName)


static const wxChar global_tbl_name [] = wxT( "fp-lib-table" )

Macro Definition Documentation

#define OPT_SEP   '|'

options separator character

Definition at line 36 of file fp_lib_table.cpp.

Function Documentation

static void setLibNickname ( MODULE aModule,
const wxString &  aNickname,
const wxString &  aFootprintName 

Definition at line 299 of file fp_lib_table.cpp.

References MODULE::GetFPID(), LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), LIB_ID::SetLibNickname(), UTF8::size(), and UTF8::wx_str().

Referenced by FP_LIB_TABLE::FootprintLoad(), and FP_LIB_TABLE::LoadEnumeratedFootprint().

301 {
302  // The library cannot know its own name, because it might have been renamed or moved.
303  // Therefore footprints cannot know their own library nickname when residing in
304  // a footprint library.
305  // Only at this API layer can we tell the footprint about its actual library nickname.
306  if( aModule )
307  {
308  // remove "const"-ness, I really do want to set nickname without
309  // having to copy the LIB_ID and its two strings, twice each.
310  LIB_ID& fpid = (LIB_ID&) aModule->GetFPID();
312  // Catch any misbehaving plugin, which should be setting internal footprint name properly:
313  wxASSERT( aFootprintName == fpid.GetLibItemName().wx_str() );
315  // and clearing nickname
316  wxASSERT( !fpid.GetLibNickname().size() );
318  fpid.SetLibNickname( aNickname );
319  }
320 }
std::string::size_type size() const
Definition: utf8.h:115
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
const LIB_ID & GetFPID() const
Definition: class_module.h:191
wxString wx_str() const
Definition: utf8.cpp:48
const UTF8 & GetLibItemName() const
Definition: lib_id.h:118
int SetLibNickname(const UTF8 &aNickname)
Override the logical library name portion of the LIB_ID to aNickname.
Definition: lib_id.cpp:219
const UTF8 & GetLibNickname() const
Return the logical library name portion of a LIB_ID.
Definition: lib_id.h:101

Variable Documentation

const wxChar global_tbl_name[] = wxT( "fp-lib-table" )