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 3202 of file legacy_plugin.cpp.

Constructor & Destructor Documentation

◆ LP_CACHE()

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

Definition at line 3233 of file legacy_plugin.cpp.

3233  :
3234  m_owner( aOwner ),
3235  m_lib_path( aLibraryPath ),
3236  m_writable( true ),
3237  m_cache_dirty( true ),
3238  m_cache_timestamp( 0 )
3239 {
3240 }
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 3251 of file legacy_plugin.cpp.

3252 {
3253  return wxFileName( aLibPath ).GetModificationTime().GetValue().GetValue();
3254 }

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

◆ IsModified()

bool LP_CACHE::IsModified ( )

Definition at line 3243 of file legacy_plugin.cpp.

3244 {
3246 
3247  return m_cache_dirty;
3248 }
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 3257 of file legacy_plugin.cpp.

3258 {
3259  m_cache_dirty = false;
3260 
3261  FILE_LINE_READER reader( m_lib_path );
3262 
3263  ReadAndVerifyHeader( &reader );
3264  SkipIndex( &reader );
3265  LoadModules( &reader );
3266 
3267  // Remember the file modification time of library file when the
3268  // cache snapshot was made, so that in a networked environment we will
3269  // reload the cache as needed.
3271 }
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 3336 of file legacy_plugin.cpp.

3337 {
3338  m_owner->SetReader( aReader );
3339 
3340  char* line = aReader->Line();
3341 
3342  do
3343  {
3344  // test first for the $MODULE, even before reading because of INDEX bug.
3345  if( TESTLINE( "$MODULE" ) )
3346  {
3347  unique_ptr<MODULE> module( new MODULE( m_owner->m_board ) );
3348 
3349  std::string footprintName = StrPurge( line + SZ( "$MODULE" ) );
3350 
3351  // The footprint names in legacy libraries can contain the '/' and ':'
3352  // characters which will cause the LIB_ID parser to choke.
3353  ReplaceIllegalFileNameChars( &footprintName );
3354 
3355  // set the footprint name first thing, so exceptions can use name.
3356  module->SetFPID( LIB_ID( wxEmptyString, footprintName ) );
3357 
3358  m_owner->loadMODULE( module.get() );
3359 
3360  MODULE* m = module.release(); // exceptions after this are not expected.
3361 
3362  // Not sure why this is asserting on debug builds. The debugger shows the
3363  // strings are the same. If it's not really needed maybe it can be removed.
3364 // wxASSERT( footprintName == m->GetFPID().GetLibItemName() );
3365 
3366  /*
3367 
3368  There was a bug in old legacy library management code
3369  (pre-LEGACY_PLUGIN) which was introducing duplicate footprint names
3370  in legacy libraries without notification. To best recover from such
3371  bad libraries, and use them to their fullest, there are a few
3372  strategies that could be used. (Note: footprints must have unique
3373  names to be accepted into this cache.) The strategy used here is to
3374  append a differentiating version counter to the end of the name as:
3375  _v2, _v3, etc.
3376 
3377  */
3378 
3379  MODULE_CITER it = m_modules.find( footprintName );
3380 
3381  if( it == m_modules.end() ) // footprintName is not present in cache yet.
3382  {
3383  std::pair<MODULE_ITER, bool> r = m_modules.insert( footprintName, m );
3384 
3385  wxASSERT_MSG( r.second, wxT( "error doing cache insert using guaranteed unique name" ) );
3386  (void) r;
3387  }
3388 
3389  // Bad library has a duplicate of this footprintName, generate a
3390  // unique footprint name and load it anyway.
3391  else
3392  {
3393  bool nameOK = false;
3394  int version = 2;
3395  char buf[48];
3396 
3397  while( !nameOK )
3398  {
3399  std::string newName = footprintName;
3400 
3401  newName += "_v";
3402  sprintf( buf, "%d", version++ );
3403  newName += buf;
3404 
3405  it = m_modules.find( newName );
3406 
3407  if( it == m_modules.end() )
3408  {
3409  nameOK = true;
3410 
3411  m->SetFPID( LIB_ID( wxEmptyString, newName ) );
3412  std::pair<MODULE_ITER, bool> r = m_modules.insert( newName, m );
3413 
3414  wxASSERT_MSG( r.second, wxT( "error doing cache insert using guaranteed unique name" ) );
3415  (void) r;
3416  }
3417  }
3418  }
3419  }
3420 
3421  } while( ( line = aReader->ReadLine() ) != NULL );
3422 }
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:298
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:668
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:193
#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 3274 of file legacy_plugin.cpp.

3275 {
3276  char* line = aReader->ReadLine();
3277  char* saveptr;
3278 
3279  if( !line )
3280  goto L_bad_library;
3281 
3282  if( !TESTLINE( "PCBNEW-LibModule-V1" ) )
3283  goto L_bad_library;
3284 
3285  while( ( line = aReader->ReadLine() ) != NULL )
3286  {
3287  if( TESTLINE( "Units" ) )
3288  {
3289  const char* units = strtok_r( line + SZ( "Units" ), delims, &saveptr );
3290 
3291  if( !strcmp( units, "mm" ) )
3292  {
3293  m_owner->diskToBiu = IU_PER_MM;
3294  }
3295 
3296  }
3297  else if( TESTLINE( "$INDEX" ) )
3298  return;
3299  }
3300 
3301 L_bad_library:
3302  THROW_IO_ERROR( wxString::Format( _( "File \"%s\" is empty or is not a legacy library" ),
3303  m_lib_path.GetData() ) );
3304 }
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
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 3307 of file legacy_plugin.cpp.

3308 {
3309  // Some broken INDEX sections have more than one section, due to prior bugs.
3310  // So we must read the next line after $EndINDEX tag,
3311  // to see if this is not a new $INDEX tag.
3312  bool exit = false;
3313  char* line = aReader->Line();
3314 
3315  do
3316  {
3317  if( TESTLINE( "$INDEX" ) )
3318  {
3319  exit = false;
3320 
3321  while( ( line = aReader->ReadLine() ) != NULL )
3322  {
3323  if( TESTLINE( "$EndINDEX" ) )
3324  {
3325  exit = true;
3326  break;
3327  }
3328  }
3329  }
3330  else if( exit )
3331  break;
3332  } while( ( line = aReader->ReadLine() ) != NULL );
3333 }
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 3209 of file legacy_plugin.cpp.

Referenced by IsModified(), and Load().

◆ m_cache_timestamp

long long LP_CACHE::m_cache_timestamp

Definition at line 3211 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 3204 of file legacy_plugin.cpp.

Referenced by LoadModules(), and ReadAndVerifyHeader().

◆ m_writable

bool LP_CACHE::m_writable

Definition at line 3207 of file legacy_plugin.cpp.

Referenced by LEGACY_PLUGIN::IsFootprintLibWritable().


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