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 Save ()
 save the entire legacy library to m_lib_path; More...
 
void SaveHeader (FILE *aFile)
 
void SaveIndex (FILE *aFile)
 
void SaveModules (FILE *aFile)
 
void SaveEndOfFile (FILE *aFile)
 
void Load ()
 
void ReadAndVerifyHeader (LINE_READER *aReader)
 
void SkipIndex (LINE_READER *aReader)
 
void LoadModules (LINE_READER *aReader)
 
wxDateTime GetLibModificationTime ()
 

Public Attributes

LEGACY_PLUGINm_owner
 
wxString m_lib_path
 
wxDateTime m_mod_time
 
MODULE_MAP m_modules
 
bool m_writable
 

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

Constructor & Destructor Documentation

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

Definition at line 3191 of file legacy_plugin.cpp.

3191  :
3192  m_owner( aOwner ),
3193  m_lib_path( aLibraryPath ),
3194  m_writable( true )
3195 {
3196 }
LEGACY_PLUGIN * m_owner
wxString m_lib_path

Member Function Documentation

wxDateTime LP_CACHE::GetLibModificationTime ( )

Definition at line 3199 of file legacy_plugin.cpp.

References m_lib_path, and m_writable.

Referenced by LEGACY_PLUGIN::cacheLib(), and Load().

3200 {
3201  wxFileName fn( m_lib_path );
3202 
3203  // update the writable flag while we have a wxFileName, in a network this
3204  // is possibly quite dynamic anyway.
3205  m_writable = fn.IsFileWritable();
3206 
3207  return fn.GetModificationTime();
3208 }
wxString m_lib_path
void LP_CACHE::Load ( )

Definition at line 3211 of file legacy_plugin.cpp.

References GetLibModificationTime(), LoadModules(), m_lib_path, m_mod_time, ReadAndVerifyHeader(), and SkipIndex().

Referenced by LEGACY_PLUGIN::cacheLib().

3212 {
3213  FILE_LINE_READER reader( m_lib_path );
3214 
3215  ReadAndVerifyHeader( &reader );
3216  SkipIndex( &reader );
3217  LoadModules( &reader );
3218 
3219  // Remember the file modification time of library file when the
3220  // cache snapshot was made, so that in a networked environment we will
3221  // reload the cache as needed.
3223 }
wxDateTime m_mod_time
void SkipIndex(LINE_READER *aReader)
Class FILE_LINE_READER is a LINE_READER that reads from an open file.
Definition: richio.h:180
void LoadModules(LINE_READER *aReader)
wxDateTime GetLibModificationTime()
wxString m_lib_path
void ReadAndVerifyHeader(LINE_READER *aReader)
void LP_CACHE::LoadModules ( LINE_READER aReader)

Definition at line 3288 of file legacy_plugin.cpp.

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().

3289 {
3290  m_owner->SetReader( aReader );
3291 
3292  char* line = aReader->Line();
3293 
3294  do
3295  {
3296  // test first for the $MODULE, even before reading because of INDEX bug.
3297  if( TESTLINE( "$MODULE" ) )
3298  {
3299  unique_ptr<MODULE> module( new MODULE( m_owner->m_board ) );
3300 
3301  std::string footprintName = StrPurge( line + SZ( "$MODULE" ) );
3302 
3303  // The footprint names in legacy libraries can contain the '/' and ':'
3304  // characters which will cause the LIB_ID parser to choke.
3305  ReplaceIllegalFileNameChars( &footprintName );
3306 
3307  // set the footprint name first thing, so exceptions can use name.
3308  module->SetFPID( LIB_ID( footprintName ) );
3309 
3310  m_owner->loadMODULE( module.get() );
3311 
3312  MODULE* m = module.release(); // exceptions after this are not expected.
3313 
3314  // Not sure why this is asserting on debug builds. The debugger shows the
3315  // strings are the same. If it's not really needed maybe it can be removed.
3316 // wxASSERT( footprintName == m->GetFPID().GetLibItemName() );
3317 
3318  /*
3319 
3320  There was a bug in old legacy library management code
3321  (pre-LEGACY_PLUGIN) which was introducing duplicate footprint names
3322  in legacy libraries without notification. To best recover from such
3323  bad libraries, and use them to their fullest, there are a few
3324  strategies that could be used. (Note: footprints must have unique
3325  names to be accepted into this cache.) The strategy used here is to
3326  append a differentiating version counter to the end of the name as:
3327  _v2, _v3, etc.
3328 
3329  */
3330 
3331  MODULE_CITER it = m_modules.find( footprintName );
3332 
3333  if( it == m_modules.end() ) // footprintName is not present in cache yet.
3334  {
3335  std::pair<MODULE_ITER, bool> r = m_modules.insert( footprintName, m );
3336 
3337  wxASSERT_MSG( r.second, wxT( "error doing cache insert using guaranteed unique name" ) );
3338  (void) r;
3339  }
3340 
3341  // Bad library has a duplicate of this footprintName, generate a
3342  // unique footprint name and load it anyway.
3343  else
3344  {
3345  bool nameOK = false;
3346  int version = 2;
3347  char buf[48];
3348 
3349  while( !nameOK )
3350  {
3351  std::string newName = footprintName;
3352 
3353  newName += "_v";
3354  sprintf( buf, "%d", version++ );
3355  newName += buf;
3356 
3357  it = m_modules.find( newName );
3358 
3359  if( it == m_modules.end() )
3360  {
3361  nameOK = true;
3362 
3363  m->SetFPID( LIB_ID( newName ) );
3364  std::pair<MODULE_ITER, bool> r = m_modules.insert( newName, m );
3365 
3366  wxASSERT_MSG( r.second, wxT( "error doing cache insert using guaranteed unique name" ) );
3367  (void) r;
3368  }
3369  }
3370  }
3371  }
3372 
3373  } while( ( line = aReader->ReadLine() ) != NULL );
3374 }
char * StrPurge(char *text)
Function StrPurge removes leading and training spaces, tabs and end of line chars in text return a po...
Definition: string.cpp:194
LEGACY_PLUGIN * m_owner
void loadMODULE(MODULE *aModule)
bool ReplaceIllegalFileNameChars(std::string *aName, int aReplaceChar)
Function ReplaceIllegalFileNameChars checks aName for illegal file name characters.
Definition: string.cpp:483
Class LIB_ID.
Definition: lib_id.h:56
void SetReader(LINE_READER *aReader)
char * Line() const
Function Line returns a pointer to the last line that was read in.
Definition: richio.h:139
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:152
#define TESTLINE(x)
C string compare test for a specific length of characters.
MODULE_MAP m_modules
void LP_CACHE::ReadAndVerifyHeader ( LINE_READER aReader)

Definition at line 3226 of file legacy_plugin.cpp.

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().

3227 {
3228  char* line = aReader->ReadLine();
3229  char* saveptr;
3230 
3231  if( !line )
3232  goto L_bad_library;
3233 
3234  if( !TESTLINE( "PCBNEW-LibModule-V1" ) )
3235  goto L_bad_library;
3236 
3237  while( ( line = aReader->ReadLine() ) != NULL )
3238  {
3239  if( TESTLINE( "Units" ) )
3240  {
3241  const char* units = strtok_r( line + SZ( "Units" ), delims, &saveptr );
3242 
3243  if( !strcmp( units, "mm" ) )
3244  {
3245  m_owner->diskToBiu = IU_PER_MM;
3246  }
3247 
3248  }
3249  else if( TESTLINE( "$INDEX" ) )
3250  return;
3251  }
3252 
3253 L_bad_library:
3254  THROW_IO_ERROR( wxString::Format( _( "File '%s' is empty or is not a legacy library" ),
3255  m_lib_path.GetData() ) );
3256 }
LEGACY_PLUGIN * m_owner
static const char delims[]
#define THROW_IO_ERROR(x)
Definition: utf8.cpp:60
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.
void LP_CACHE::Save ( )

save the entire legacy library to m_lib_path;

void LP_CACHE::SaveEndOfFile ( FILE *  aFile)
inline

Definition at line 3174 of file legacy_plugin.cpp.

3175  {
3176  fprintf( aFile, "$EndLIBRARY\n" );
3177  }
void LP_CACHE::SaveHeader ( FILE *  aFile)
void LP_CACHE::SaveIndex ( FILE *  aFile)
void LP_CACHE::SaveModules ( FILE *  aFile)
void LP_CACHE::SkipIndex ( LINE_READER aReader)

Definition at line 3259 of file legacy_plugin.cpp.

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

Referenced by Load().

3260 {
3261  // Some broken INDEX sections have more than one section, due to prior bugs.
3262  // So we must read the next line after $EndINDEX tag,
3263  // to see if this is not a new $INDEX tag.
3264  bool exit = false;
3265  char* line = aReader->Line();
3266 
3267  do
3268  {
3269  if( TESTLINE( "$INDEX" ) )
3270  {
3271  exit = false;
3272 
3273  while( ( line = aReader->ReadLine() ) != NULL )
3274  {
3275  if( TESTLINE( "$EndINDEX" ) )
3276  {
3277  exit = true;
3278  break;
3279  }
3280  }
3281  }
3282  else if( exit )
3283  break;
3284  } while( ( line = aReader->ReadLine() ) != NULL );
3285 }
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.

Member Data Documentation

wxString LP_CACHE::m_lib_path
wxDateTime LP_CACHE::m_mod_time

Definition at line 3155 of file legacy_plugin.cpp.

Referenced by LEGACY_PLUGIN::cacheLib(), and Load().

MODULE_MAP LP_CACHE::m_modules
LEGACY_PLUGIN* LP_CACHE::m_owner

Definition at line 3153 of file legacy_plugin.cpp.

Referenced by LoadModules(), and ReadAndVerifyHeader().

bool LP_CACHE::m_writable

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