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

Constructor & Destructor Documentation

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

Definition at line 3201 of file legacy_plugin.cpp.

3201  :
3202  m_owner( aOwner ),
3203  m_lib_path( aLibraryPath ),
3204  m_writable( true )
3205 {
3206 }
LEGACY_PLUGIN * m_owner
wxString m_lib_path

Member Function Documentation

wxDateTime LP_CACHE::GetLibModificationTime ( )

Definition at line 3209 of file legacy_plugin.cpp.

References m_lib_path, and m_writable.

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

3210 {
3211  wxFileName fn( m_lib_path );
3212 
3213  // update the writable flag while we have a wxFileName, in a network this
3214  // is possibly quite dynamic anyway.
3215  m_writable = fn.IsFileWritable();
3216 
3217  return fn.GetModificationTime();
3218 }
wxString m_lib_path
void LP_CACHE::Load ( )

Definition at line 3221 of file legacy_plugin.cpp.

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

Referenced by LEGACY_PLUGIN::cacheLib().

3222 {
3223  FILE_LINE_READER reader( m_lib_path );
3224 
3225  ReadAndVerifyHeader( &reader );
3226  SkipIndex( &reader );
3227  LoadModules( &reader );
3228 
3229  // Remember the file modification time of library file when the
3230  // cache snapshot was made, so that in a networked environment we will
3231  // reload the cache as needed.
3233 }
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 3298 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().

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

3237 {
3238  char* line = aReader->ReadLine();
3239  char* saveptr;
3240 
3241  if( !line )
3242  goto L_bad_library;
3243 
3244  if( !TESTLINE( "PCBNEW-LibModule-V1" ) )
3245  goto L_bad_library;
3246 
3247  while( ( line = aReader->ReadLine() ) != NULL )
3248  {
3249  if( TESTLINE( "Units" ) )
3250  {
3251  const char* units = strtok_r( line + SZ( "Units" ), delims, &saveptr );
3252 
3253  if( !strcmp( units, "mm" ) )
3254  {
3255  m_owner->diskToBiu = IU_PER_MM;
3256  }
3257 
3258  }
3259  else if( TESTLINE( "$INDEX" ) )
3260  return;
3261  }
3262 
3263 L_bad_library:
3264  THROW_IO_ERROR( wxString::Format( _( "File '%s' is empty or is not a legacy library" ),
3265  m_lib_path.GetData() ) );
3266 }
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 3184 of file legacy_plugin.cpp.

3185  {
3186  fprintf( aFile, "$EndLIBRARY\n" );
3187  }
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 3269 of file legacy_plugin.cpp.

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

Referenced by Load().

3270 {
3271  // Some broken INDEX sections have more than one section, due to prior bugs.
3272  // So we must read the next line after $EndINDEX tag,
3273  // to see if this is not a new $INDEX tag.
3274  bool exit = false;
3275  char* line = aReader->Line();
3276 
3277  do
3278  {
3279  if( TESTLINE( "$INDEX" ) )
3280  {
3281  exit = false;
3282 
3283  while( ( line = aReader->ReadLine() ) != NULL )
3284  {
3285  if( TESTLINE( "$EndINDEX" ) )
3286  {
3287  exit = true;
3288  break;
3289  }
3290  }
3291  }
3292  else if( exit )
3293  break;
3294  } while( ( line = aReader->ReadLine() ) != NULL );
3295 }
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 3165 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 3163 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: