FP_CACHE Class Reference

#include <pcb_plugin.h>

Public Member Functions
	FP_CACHE (PCB_PLUGIN *aOwner, const wxString &aLibraryPath)
wxString	GetPath () const
bool	IsWritable () const
bool	Exists () const
FP_CACHE_FOOTPRINT_MAP &	GetFootprints ()
void	Save (FOOTPRINT *aFootprint=nullptr)
	Save the footprint cache or a single footprint from it to disk. More...
void	Load ()
void	Remove (const wxString &aFootprintName)
bool	IsModified ()
	Return true if the cache is not up-to-date. More...
bool	IsPath (const wxString &aPath) const
	Check if aPath is the same as the current cache path. More...
void	SetPath (const wxString &aPath)

Static Public Member Functions
static long long	GetTimestamp (const wxString &aLibPath)
	Generate a timestamp representing all source files in the cache (including the parent directory). More...

Private Attributes
PCB_PLUGIN *	m_owner
wxFileName	m_lib_path
wxString	m_lib_raw_path
FP_CACHE_FOOTPRINT_MAP	m_footprints
bool	m_cache_dirty
long long	m_cache_timestamp

Detailed Description

Definition at line 188 of file pcb_plugin.h.

Constructor & Destructor Documentation

FP_CACHE()

FP_CACHE::FP_CACHE	(	PCB_PLUGIN *	aOwner,
		const wxString &	aLibraryPath
	)

Definition at line 75 of file pcb_plugin.cpp.

{
 m_owner = aOwner;
 m_lib_raw_path = aLibraryPath;
 m_lib_path.SetPath( aLibraryPath );
 m_cache_timestamp = 0;
 m_cache_dirty = true;
}

References m_cache_dirty, m_cache_timestamp, m_lib_path, m_lib_raw_path, and m_owner.

Member Function Documentation

Exists()

bool FP_CACHE::Exists ( ) const

inline

Definition at line 207 of file pcb_plugin.h.

{ return m_lib_path.IsOk() && m_lib_path.DirExists(); }

References m_lib_path.

Referenced by PCB_PLUGIN::FootprintSave().

GetFootprints()

FP_CACHE_FOOTPRINT_MAP & FP_CACHE::GetFootprints ( )

inline

Definition at line 209 of file pcb_plugin.h.

{ return m_footprints; }

References m_footprints.

Referenced by PCB_PLUGIN::FootprintEnumerate(), PCB_PLUGIN::FootprintSave(), PCB_PLUGIN::getFootprint(), PCBNEW_JOBS_HANDLER::JobExportFpSvg(), PCBNEW_JOBS_HANDLER::JobExportFpUpgrade(), and SetPath().

GetPath()

wxString FP_CACHE::GetPath ( ) const

inline

Definition at line 203 of file pcb_plugin.h.

{ return m_lib_raw_path; }

References m_lib_raw_path.

GetTimestamp()

long long FP_CACHE::GetTimestamp ( const wxString &  aLibPath )

static

Generate a timestamp representing all source files in the cache (including the parent directory).

Timestamps should not be considered ordered. They either match or they don't.

Definition at line 263 of file pcb_plugin.cpp.

{
 wxString fileSpec = wxT( "*." ) + KiCadFootprintFileExtension;
 
 return TimestampDir( aLibPath, fileSpec );
}

References KiCadFootprintFileExtension, and TimestampDir().

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

IsModified()

bool FP_CACHE::IsModified

(

)

Return true if the cache is not up-to-date.

Definition at line 255 of file pcb_plugin.cpp.

{
 m_cache_dirty = m_cache_dirty || GetTimestamp( m_lib_path.GetFullPath() ) != m_cache_timestamp;
 
 return m_cache_dirty;
}

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

Referenced by PCB_PLUGIN::validateCache().

IsPath()

bool FP_CACHE::IsPath

(

const wxString &

aPath

)

const

Check if aPath is the same as the current cache path.

This tests paths by converting aPath using the native separators. Internally FP_CACHE stores the current path using native separators. This prevents path miscompares on Windows due to the fact that paths can be stored with / instead of \ in the footprint library table.

Parameters

aPath

is the library path to test against.

Returns

true if aPath is the same as the cache path.

Definition at line 236 of file pcb_plugin.cpp.

{
 return aPath == m_lib_raw_path;
}

References m_lib_raw_path.

Referenced by PCB_PLUGIN::FootprintLibDelete(), and PCB_PLUGIN::validateCache().

IsWritable()

bool FP_CACHE::IsWritable ( ) const

inline

Definition at line 205 of file pcb_plugin.h.

{ return m_lib_path.IsOk() && m_lib_path.IsDirWritable(); }

References m_lib_path.

Referenced by PCB_PLUGIN::FootprintDelete(), PCB_PLUGIN::FootprintSave(), and PCB_PLUGIN::IsFootprintLibWritable().

Load()

void FP_CACHE::Load

(

)

Definition at line 152 of file pcb_plugin.cpp.

{
 m_cache_dirty = false;
 m_cache_timestamp = 0;
 
 wxDir dir( m_lib_raw_path );
 
 if( !dir.IsOpened() )
 {
 wxString msg = wxString::Format( _( "Footprint library '%s' not found." ),
 m_lib_raw_path );
 THROW_IO_ERROR( msg );
 }
 
 wxString fullName;
 wxString fileSpec = wxT( "*." ) + KiCadFootprintFileExtension;
 
 // wxFileName construction is egregiously slow. Construct it once and just swap out
 // the filename thereafter.
 WX_FILENAME fn( m_lib_raw_path, wxT( "dummyName" ) );
 
 if( dir.GetFirst( &fullName, fileSpec ) )
 {
 wxString cacheError;
 
 do
 {
 fn.SetFullName( fullName );
 
 // Queue I/O errors so only files that fail to parse don't get loaded.
 try
 {
 FILE_LINE_READER reader( fn.GetFullPath() );
 PCB_PARSER parser( &reader, nullptr, nullptr );
 
 // use dynamic cast in case somebody renames a .kicad_pcb as .kicad_mod and chucks it into a library folder
 // the parsing definitely fails then
 FOOTPRINT* footprint = dynamic_cast<FOOTPRINT*>( parser.Parse() );
 wxString fpName = fn.GetName();
 
 if( !footprint )
 {
 THROW_IO_ERROR( wxString::Format( _( "Unable to read file '%s'" ), fn.GetFullPath() ) );
 }
 
 footprint->SetFPID( LIB_ID( wxEmptyString, fpName ) );
 m_footprints.insert( fpName, new FP_CACHE_ITEM( footprint, fn ) );
 }
 catch( const IO_ERROR& ioe )
 {
 if( !cacheError.IsEmpty() )
 cacheError += wxT( "\n\n" );
 
 cacheError += ioe.What();
 }
 } while( dir.GetNext( &fullName ) );
 
 m_cache_timestamp = GetTimestamp( m_lib_raw_path );
 
 if( !cacheError.IsEmpty() )
 THROW_IO_ERROR( cacheError );
 }
}

References _, Format(), WX_FILENAME::GetFullPath(), WX_FILENAME::GetName(), GetTimestamp(), KiCadFootprintFileExtension, m_cache_dirty, m_cache_timestamp, m_footprints, m_lib_raw_path, PCB_PARSER::Parse(), FOOTPRINT::SetFPID(), WX_FILENAME::SetFullName(), THROW_IO_ERROR, and IO_ERROR::What().

Referenced by PCBNEW_JOBS_HANDLER::JobExportFpSvg(), PCBNEW_JOBS_HANDLER::JobExportFpUpgrade(), and PCB_PLUGIN::validateCache().

Remove()

void FP_CACHE::Remove

(

const wxString &

aFootprintName

)

Definition at line 217 of file pcb_plugin.cpp.

{
 FP_CACHE_FOOTPRINT_MAP::const_iterator it = m_footprints.find( aFootprintName );
 
 if( it == m_footprints.end() )
 {
 wxString msg = wxString::Format( _( "Library '%s' has no footprint '%s'." ),
 m_lib_raw_path,
 aFootprintName );
 THROW_IO_ERROR( msg );
 }
 
 // Remove the footprint from the cache and delete the footprint file from the library.
 wxString fullPath = it->second->GetFileName().GetFullPath();
 m_footprints.erase( aFootprintName );
 wxRemoveFile( fullPath );
}

References _, Format(), m_footprints, m_lib_raw_path, and THROW_IO_ERROR.

Referenced by PCB_PLUGIN::FootprintDelete().

Save()

void FP_CACHE::Save

(

FOOTPRINT *

aFootprint = nullptr

)

Save the footprint cache or a single footprint from it to disk.

Parameters

aFootprint

if set, save only this footprint, otherwise, save the full library

Definition at line 85 of file pcb_plugin.cpp.

{
 m_cache_timestamp = 0;
 
 if( !m_lib_path.DirExists() && !m_lib_path.Mkdir() )
 {
 THROW_IO_ERROR( wxString::Format( _( "Cannot create footprint library '%s'." ),
 m_lib_raw_path ) );
 }
 
 if( !m_lib_path.IsDirWritable() )
 {
 THROW_IO_ERROR( wxString::Format( _( "Footprint library '%s' is read only." ),
 m_lib_raw_path ) );
 }
 
 for( FP_CACHE_FOOTPRINT_MAP::iterator it = m_footprints.begin(); it != m_footprints.end(); ++it )
 {
 if( aFootprint && aFootprint != it->second->GetFootprint() )
 continue;
 
 WX_FILENAME fn = it->second->GetFileName();
 
 wxString tempFileName =
#ifdef USE_TMP_FILE
 wxFileName::CreateTempFileName( fn.GetPath() );
#else
 fn.GetFullPath();
#endif
 // Allow file output stream to go out of scope to close the file stream before
 // renaming the file.
 {
 wxLogTrace( traceKicadPcbPlugin, wxT( "Creating temporary library file '%s'." ),
 tempFileName );
 
 FILE_OUTPUTFORMATTER formatter( tempFileName );
 
 m_owner->SetOutputFormatter( &formatter );
 m_owner->Format( (BOARD_ITEM*) it->second->GetFootprint() );
 }
 
#ifdef USE_TMP_FILE
 wxRemove( fn.GetFullPath() ); // it is not an error if this does not exist
 
 // Even on Linux you can see an _intermittent_ error when calling wxRename(),
 // and it is fully inexplicable. See if this dodges the error.
 wxMilliSleep( 250L );
 
 if( !wxRenameFile( tempFileName, fn.GetFullPath() ) )
 {
 wxString msg = wxString::Format( _( "Cannot rename temporary file '%s' to '%s'" ),
  tempFileName,
 fn.GetFullPath() );
 THROW_IO_ERROR( msg );
 }
#endif
 m_cache_timestamp += fn.GetTimestamp();
 }
 
 m_cache_timestamp += m_lib_path.GetModificationTime().GetValue().GetValue();
 
 // If we've saved the full cache, we clear the dirty flag.
 if( !aFootprint )
 m_cache_dirty = false;
}

References _, PCB_PLUGIN::Format(), Format(), WX_FILENAME::GetFullPath(), WX_FILENAME::GetPath(), WX_FILENAME::GetTimestamp(), m_cache_dirty, m_cache_timestamp, m_footprints, m_lib_path, m_lib_raw_path, m_owner, PCB_PLUGIN::SetOutputFormatter(), THROW_IO_ERROR, and traceKicadPcbPlugin.

Referenced by PCB_PLUGIN::FootprintLibCreate(), PCB_PLUGIN::FootprintSave(), and PCBNEW_JOBS_HANDLER::JobExportFpUpgrade().

SetPath()

void FP_CACHE::SetPath

(

const wxString &

aPath

)

Definition at line 242 of file pcb_plugin.cpp.

{
 m_lib_raw_path = aPath;
 m_lib_path.SetPath( aPath );
 
 
 for( const auto& footprint : GetFootprints() )
 {
 footprint.second->SetFilePath( aPath );
 }
}

References GetFootprints(), m_lib_path, and m_lib_raw_path.

Referenced by PCBNEW_JOBS_HANDLER::JobExportFpUpgrade().

Member Data Documentation

m_cache_dirty

bool FP_CACHE::m_cache_dirty

private

Definition at line 195 of file pcb_plugin.h.

Referenced by FP_CACHE(), IsModified(), Load(), and Save().

m_cache_timestamp

long long FP_CACHE::m_cache_timestamp

private

Definition at line 197 of file pcb_plugin.h.

Referenced by FP_CACHE(), IsModified(), Load(), and Save().

m_footprints

FP_CACHE_FOOTPRINT_MAP FP_CACHE::m_footprints

private

Definition at line 193 of file pcb_plugin.h.

Referenced by GetFootprints(), Load(), Remove(), and Save().

m_lib_path

wxFileName FP_CACHE::m_lib_path

private

Definition at line 191 of file pcb_plugin.h.

Referenced by Exists(), FP_CACHE(), IsModified(), IsWritable(), Save(), and SetPath().

m_lib_raw_path

wxString FP_CACHE::m_lib_raw_path

private

Definition at line 192 of file pcb_plugin.h.

Referenced by FP_CACHE(), GetPath(), IsPath(), Load(), Remove(), Save(), and SetPath().

m_owner

PCB_PLUGIN* FP_CACHE::m_owner

private

Definition at line 190 of file pcb_plugin.h.

Referenced by FP_CACHE(), and Save().

---

The documentation for this class was generated from the following files:

• pcb_plugin.h
• pcb_plugin.cpp