#include <pcb_io_kicad_sexpr.h>

Public Member Functions
	FP_CACHE (PCB_IO_KICAD_SEXPR *aOwner, const wxString &aLibraryPath)

wxString	GetPath () const

bool	IsWritable () const

bool	Exists () const

boost::ptr_map< wxString, FP_CACHE_ENTRY > &	GetFootprints ()

void	Save (FOOTPRINT *aFootprintFilter=nullptr)
	Save the footprint cache or a single footprint from it to disk.

void	Load ()

void	Remove (const wxString &aFootprintName)

bool	IsModified ()
	Return true if the cache is not up-to-date.

bool	IsPath (const wxString &aPath) const
	Check if aPath is the same as the current cache path.

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

Private Attributes
PCB_IO_KICAD_SEXPR *	m_owner

wxFileName	m_lib_path

wxString	m_lib_raw_path

boost::ptr_map< wxString, FP_CACHE_ENTRY >	m_footprints

bool	m_cache_dirty

long long	m_cache_timestamp

Detailed Description

Definition at line 229 of file pcb_io_kicad_sexpr.h.

Constructor & Destructor Documentation

◆ FP_CACHE()

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

Definition at line 81 of file pcb_io_kicad_sexpr.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 250 of file pcb_io_kicad_sexpr.h.

References m_lib_path.

Referenced by PCB_IO_KICAD_SEXPR::FootprintSave().

◆ GetFootprints()

boost::ptr_map< wxString, FP_CACHE_ENTRY > & FP_CACHE::GetFootprints ( )

inline

Definition at line 252 of file pcb_io_kicad_sexpr.h.

References m_footprints.

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

◆ GetPath()

wxString FP_CACHE::GetPath ( ) const

inline

Definition at line 246 of file pcb_io_kicad_sexpr.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 280 of file pcb_io_kicad_sexpr.cpp.

References FILEEXT::KiCadFootprintFileExtension, and TimestampDir().

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

◆ IsModified()

bool FP_CACHE::IsModified ( )

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

Definition at line 272 of file pcb_io_kicad_sexpr.cpp.

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

Referenced by PCB_IO_KICAD_SEXPR::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.