#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 198 of file pcb_plugin.h.

Constructor & Destructor Documentation

◆ FP_CACHE()

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

Definition at line 74 of file pcb_plugin.cpp.

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 217 of file pcb_plugin.h.

References m_lib_path.

Referenced by PCB_PLUGIN::FootprintSave().

◆ GetFootprints()

FP_CACHE_FOOTPRINT_MAP & FP_CACHE::GetFootprints ( )

inline

Definition at line 219 of file pcb_plugin.h.

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 213 of file pcb_plugin.h.

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 264 of file pcb_plugin.cpp.

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 256 of file pcb_plugin.cpp.

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.