KiCad PCB EDA Suite
LP_CACHE Struct Reference

Class LP_CACHE assists only for the footprint portion of the PLUGIN API, and only for the LEGACY_PLUGIN, so therefore is private to this implementation file, i.e. More...

Public Member Functions

 LP_CACHE (LEGACY_PLUGIN *aOwner, const wxString &aLibraryPath)
 
void Load ()
 
void ReadAndVerifyHeader (LINE_READER *aReader)
 
void SkipIndex (LINE_READER *aReader)
 
void LoadModules (LINE_READER *aReader)
 
bool IsModified ()
 

Static Public Member Functions

static long long GetTimestamp (const wxString &aLibPath)
 

Public Attributes

LEGACY_PLUGINm_owner
 
wxString m_lib_path
 
MODULE_MAP m_modules
 
bool m_writable
 
bool m_cache_dirty
 
long long m_cache_timestamp
 

Detailed Description

Class LP_CACHE assists only for the footprint portion of the PLUGIN API, and only for the LEGACY_PLUGIN, so therefore is private to this implementation file, i.e.

not placed into a header.

Definition at line 3194 of file legacy_plugin.cpp.

Constructor & Destructor Documentation

◆ LP_CACHE()

LP_CACHE::LP_CACHE ( LEGACY_PLUGIN aOwner,
const wxString &  aLibraryPath 
)

Definition at line 3225 of file legacy_plugin.cpp.

3225  :
3226  m_owner( aOwner ),
3227  m_lib_path( aLibraryPath ),
3228  m_writable( true ),
3229  m_cache_dirty( true ),
3230  m_cache_timestamp( 0 )
3231 {
3232 }
LEGACY_PLUGIN * m_owner
bool m_cache_dirty
long long m_cache_timestamp
wxString m_lib_path

Member Function Documentation

◆ GetTimestamp()

long long LP_CACHE::GetTimestamp ( const wxString &  aLibPath)
static

Definition at line 3243 of file legacy_plugin.cpp.

3244 {
3245  return wxFileName( aLibPath ).GetModificationTime().GetValue().GetValue();
3246 }

Referenced by LEGACY_PLUGIN::GetLibraryTimestamp(), IsModified(), and Load().

◆ IsModified()

bool LP_CACHE::IsModified ( )

Definition at line 3235 of file legacy_plugin.cpp.

3236 {
3238 
3239  return m_cache_dirty;
3240 }
bool m_cache_dirty
long long m_cache_timestamp
wxString m_lib_path
static long long GetTimestamp(const wxString &aLibPath)

References GetTimestamp(), m_cache_dirty, m_cache_timestamp, and m_lib_path.

Referenced by LEGACY_PLUGIN::cacheLib().

◆ Load()

void LP_CACHE::Load ( )

Definition at line 3249 of file legacy_plugin.cpp.

3250 {
3251  m_cache_dirty = false;
3252 
3253  FILE_LINE_READER reader( m_lib_path );
3254 
3255  ReadAndVerifyHeader( &reader );
3256  SkipIndex( &reader );
3257  LoadModules( &reader );
3258 
3259  // Remember the file modification time of library file when the
3260  // cache snapshot was made, so that in a networked environment we will
3261  // reload the cache as needed.
3263 }
void SkipIndex(LINE_READER *aReader)
bool m_cache_dirty
Class FILE_LINE_READER is a LINE_READER that reads from an open file.
Definition: richio.h:180
void LoadModules(LINE_READER *aReader)
long long m_cache_timestamp
wxString m_lib_path
static long long GetTimestamp(const wxString &aLibPath)
void ReadAndVerifyHeader(LINE_READER *aReader)

References GetTimestamp(), LoadModules(), m_cache_dirty, m_cache_timestamp, m_lib_path, ReadAndVerifyHeader(), and SkipIndex().

Referenced by LEGACY_PLUGIN::cacheLib().

◆ LoadModules()

void LP_CACHE::LoadModules ( LINE_READER aReader)

Definition at line 3322 of file legacy_plugin.cpp.

3323 {
3324  m_owner->SetReader( aReader );
3325 
3326  char* line = aReader->Line();
3327 
3328  do
3329  {
3330  // test first for the $MODULE, even before reading because of INDEX bug.
3331  if( TESTLINE( "$MODULE" ) )
3332  {
3333  unique_ptr<MODULE> module( new MODULE( m_owner->m_board ) );
3334 
3335  std::string footprintName = StrPurge( line + SZ( "$MODULE" ) );
3336 
3337  // The footprint names in legacy libraries can contain the '/' and ':'
3338  // characters which will cause the LIB_ID parser to choke.
3339  ReplaceIllegalFileNameChars( &footprintName );
3340 
3341  // set the footprint name first thing, so exceptions can use name.
3342  module->SetFPID( LIB_ID( wxEmptyString, footprintName ) );
3343 
3344  m_owner->loadMODULE( module.get() );
3345 
3346  MODULE* m = module.release(); // exceptions after this are not expected.
3347 
3348  // Not sure why this is asserting on debug builds. The debugger shows the
3349  // strings are the same. If it's not really needed maybe it can be removed.
3350 // wxASSERT( footprintName == m->GetFPID().GetLibItemName() );
3351 
3352  /*
3353 
3354  There was a bug in old legacy library management code
3355  (pre-LEGACY_PLUGIN) which was introducing duplicate footprint names
3356  in legacy libraries without notification. To best recover from such
3357  bad libraries, and use them to their fullest, there are a few
3358  strategies that could be used. (Note: footprints must have unique
3359  names to be accepted into this cache.) The strategy used here is to
3360  append a differentiating version counter to the end of the name as:
3361  _v2, _v3, etc.
3362 
3363  */
3364 
3365  MODULE_CITER it = m_modules.find( footprintName );
3366 
3367  if( it == m_modules.end() ) // footprintName is not present in cache yet.
3368  {
3369  std::pair<MODULE_ITER, bool> r = m_modules.insert( footprintName, m );
3370 
3371  wxASSERT_MSG( r.second, wxT( "error doing cache insert using guaranteed unique name" ) );
3372  (void) r;
3373  }
3374 
3375  // Bad library has a duplicate of this footprintName, generate a
3376  // unique footprint name and load it anyway.
3377  else
3378  {
3379  bool nameOK = false;
3380  int version = 2;
3381  char buf[48];
3382 
3383  while( !nameOK )
3384  {
3385  std::string newName = footprintName;
3386 
3387  newName += "_v";
3388  sprintf( buf, "%d", version++ );
3389  newName += buf;
3390 
3391  it = m_modules.find( newName );
3392 
3393  if( it == m_modules.end() )
3394  {
3395  nameOK = true;
3396 
3397  m->SetFPID( LIB_ID( wxEmptyString, newName ) );
3398  std::pair<MODULE_ITER, bool> r = m_modules.insert( newName, m );
3399 
3400  wxASSERT_MSG( r.second, wxT( "error doing cache insert using guaranteed unique name" ) );
3401  (void) r;
3402  }
3403  }
3404  }
3405  }
3406 
3407  } while( ( line = aReader->ReadLine() ) != NULL );
3408 }
char * Line() const
Function Line returns a pointer to the last line that was read in.
Definition: richio.h:139
char * StrPurge(char *text)
Remove leading and training spaces, tabs and end of line chars in text.
Definition: string.cpp:310
LEGACY_PLUGIN * m_owner
void loadMODULE(MODULE *aModule)
bool ReplaceIllegalFileNameChars(std::string *aName, int aReplaceChar)
Checks aName for illegal file name characters.
Definition: string.cpp:680
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
void SetReader(LINE_READER *aReader)
BOARD * m_board
which BOARD, no ownership here
MODULE_MAP::const_iterator MODULE_CITER
virtual char * ReadLine()=0
Function ReadLine reads a line of text into the buffer and increments the line number counter.
#define SZ(x)
Get the length of a string constant, at compile time.
void SetFPID(const LIB_ID &aFPID)
Definition: class_module.h:223
#define TESTLINE(x)
C string compare test for a specific length of characters.
MODULE_MAP m_modules

References LINE_READER::Line(), LEGACY_PLUGIN::loadMODULE(), LEGACY_PLUGIN::m_board, m_modules, m_owner, LINE_READER::ReadLine(), ReplaceIllegalFileNameChars(), MODULE::SetFPID(), LEGACY_PLUGIN::SetReader(), StrPurge(), SZ, and TESTLINE.

Referenced by Load().

◆ ReadAndVerifyHeader()

void LP_CACHE::ReadAndVerifyHeader ( LINE_READER aReader)

Definition at line 3266 of file legacy_plugin.cpp.

3267 {
3268  char* line = aReader->ReadLine();
3269  char* saveptr;
3270 
3271  if( !line )
3272  THROW_IO_ERROR( wxString::Format( _( "File '%s' is empty." ), m_lib_path ) );
3273 
3274  if( !TESTLINE( "PCBNEW-LibModule-V1" ) )
3275  THROW_IO_ERROR( wxString::Format( _( "File '%s' is not a legacy library." ), m_lib_path ) );
3276 
3277  while( ( line = aReader->ReadLine() ) != NULL )
3278  {
3279  if( TESTLINE( "Units" ) )
3280  {
3281  const char* units = strtok_r( line + SZ( "Units" ), delims, &saveptr );
3282 
3283  if( !strcmp( units, "mm" ) )
3284  m_owner->diskToBiu = IU_PER_MM;
3285 
3286  }
3287  else if( TESTLINE( "$INDEX" ) )
3288  return;
3289  }
3290 }
LEGACY_PLUGIN * m_owner
static const char delims[]
#define THROW_IO_ERROR(msg)
double diskToBiu
convert from disk engineering units to BIUs with this scale factor
#define _(s)
virtual char * ReadLine()=0
Function ReadLine reads a line of text into the buffer and increments the line number counter.
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205
wxString m_lib_path
char * strtok_r(char *str, const char *delim, char **nextp)
#define SZ(x)
Get the length of a string constant, at compile time.
#define TESTLINE(x)
C string compare test for a specific length of characters.

References _, delims, LEGACY_PLUGIN::diskToBiu, Format(), m_lib_path, m_owner, LINE_READER::ReadLine(), strtok_r(), SZ, TESTLINE, and THROW_IO_ERROR.

Referenced by Load().

◆ SkipIndex()

void LP_CACHE::SkipIndex ( LINE_READER aReader)

Definition at line 3293 of file legacy_plugin.cpp.

3294 {
3295  // Some broken INDEX sections have more than one section, due to prior bugs.
3296  // So we must read the next line after $EndINDEX tag,
3297  // to see if this is not a new $INDEX tag.
3298  bool exit = false;
3299  char* line = aReader->Line();
3300 
3301  do
3302  {
3303  if( TESTLINE( "$INDEX" ) )
3304  {
3305  exit = false;
3306 
3307  while( ( line = aReader->ReadLine() ) != NULL )
3308  {
3309  if( TESTLINE( "$EndINDEX" ) )
3310  {
3311  exit = true;
3312  break;
3313  }
3314  }
3315  }
3316  else if( exit )
3317  break;
3318  } while( ( line = aReader->ReadLine() ) != NULL );
3319 }
char * Line() const
Function Line returns a pointer to the last line that was read in.
Definition: richio.h:139
virtual char * ReadLine()=0
Function ReadLine reads a line of text into the buffer and increments the line number counter.
#define TESTLINE(x)
C string compare test for a specific length of characters.

References LINE_READER::Line(), LINE_READER::ReadLine(), and TESTLINE.

Referenced by Load().

Member Data Documentation

◆ m_cache_dirty

bool LP_CACHE::m_cache_dirty

Definition at line 3201 of file legacy_plugin.cpp.

Referenced by IsModified(), and Load().

◆ m_cache_timestamp

long long LP_CACHE::m_cache_timestamp

Definition at line 3203 of file legacy_plugin.cpp.

Referenced by IsModified(), and Load().

◆ m_lib_path

wxString LP_CACHE::m_lib_path

◆ m_modules

MODULE_MAP LP_CACHE::m_modules

◆ m_owner

LEGACY_PLUGIN* LP_CACHE::m_owner

Definition at line 3196 of file legacy_plugin.cpp.

Referenced by LoadModules(), and ReadAndVerifyHeader().

◆ m_writable

bool LP_CACHE::m_writable

Definition at line 3199 of file legacy_plugin.cpp.

Referenced by LEGACY_PLUGIN::IsFootprintLibWritable().


The documentation for this struct was generated from the following file: