PROJECT Class Reference

Container for project specific data. More...

#include <project.h>

Classes
class	_ELEM
	A PROJECT can hold stuff it knows nothing about, in the form of _ELEM derivatives. More...

Public Types
enum class	ELEM {   FPTBL , SCH_SYMBOL_LIBS , SCH_SEARCH_STACK , S3DCACHE ,   SYMBOL_LIB_TABLE , SEARCH_STACK , DESIGN_BLOCK_LIB_TABLE , SCHEMATIC ,   BOARD , COUNT }
	The set of #_ELEMs that a PROJECT can hold. More...
enum	LIB_TYPE_T { SYMBOL_LIB , FOOTPRINT_LIB , DESIGN_BLOCK_LIB , LIB_TYPE_COUNT }
enum	RSTRING_T {   DOC_PATH , SCH_LIB_PATH , SCH_LIB_SELECT , SCH_LIBEDIT_CUR_LIB ,   SCH_LIBEDIT_CUR_SYMBOL , VIEWER_3D_PATH , VIEWER_3D_FILTER_INDEX , PCB_LIB_NICKNAME ,   PCB_FOOTPRINT , PCB_FOOTPRINT_EDITOR_FP_NAME , PCB_FOOTPRINT_EDITOR_LIB_NICKNAME , PCB_FOOTPRINT_VIEWER_FP_NAME ,   PCB_FOOTPRINT_VIEWER_LIB_NICKNAME , RSTRING_COUNT }
	Retain a number of project specific wxStrings, enumerated here: More...

Public Member Functions
	PROJECT ()
virtual	~PROJECT ()
virtual bool	TextVarResolver (wxString *aToken) const
virtual std::map< wxString, wxString > &	GetTextVars () const
virtual void	ApplyTextVars (const std::map< wxString, wxString > &aVarsMap)
	Applies the given var map, it will create or update existing vars.
int	GetTextVarsTicker () const
void	IncrementTextVarsTicker ()
int	GetNetclassesTicker () const
void	IncrementNetclassesTicker ()
virtual const wxString	GetProjectFullName () const
	Return the full path and name of the project.
virtual const wxString	GetProjectPath () const
	Return the full path of the project.
virtual const wxString	GetProjectDirectory () const
	Return the full path of the project DIRECTORY.
virtual const wxString	GetProjectName () const
	Return the short name of the project.
virtual bool	IsNullProject () const
	Check if this project is a null project (i.e.
virtual bool	IsReadOnly () const
virtual void	SetReadOnly (bool aReadOnly=true)
virtual const wxString	GetSheetName (const KIID &aSheetID)
	Return the name of the sheet identified by the given UUID.
virtual const wxString	FootprintLibTblName () const
	Returns the path and filename of this project's footprint library table.
virtual const wxString	SymbolLibTableName () const
	Return the path and file name of this projects symbol library table.
virtual const wxString	DesignBlockLibTblName () const
	Return the path and file name of this projects design block library table.
void	PinLibrary (const wxString &aLibrary, enum LIB_TYPE_T aLibType)
void	UnpinLibrary (const wxString &aLibrary, enum LIB_TYPE_T aLibType)
virtual PROJECT_FILE &	GetProjectFile () const
virtual PROJECT_LOCAL_SETTINGS &	GetLocalSettings () const
virtual const wxString &	GetRString (RSTRING_T aStringId)
	Return a "retained string", which is any session and project specific string identified in enum RSTRING_T.
virtual void	SetRString (RSTRING_T aStringId, const wxString &aString)
	Store a "retained string", which is any session and project specific string identified in enum RSTRING_T.
virtual _ELEM *	GetElem (PROJECT::ELEM aIndex)
	Get and set the elements for this project.
virtual void	SetElem (PROJECT::ELEM aIndex, _ELEM *aElem)
void	Clear ()
	Clear the _ELEMs and RSTRINGs.
virtual const wxString	AbsolutePath (const wxString &aFileName) const
	Fix up aFileName if it is relative to the project's directory to be an absolute path and filename.
virtual FP_LIB_TABLE *	PcbFootprintLibs (KIWAY &aKiway)
	Return the table of footprint libraries.
virtual DESIGN_BLOCK_LIB_TABLE *	DesignBlockLibs ()
	Return the table of design block libraries.
void	SetProjectLock (LOCKFILE *aLockFile)
LOCKFILE *	GetProjectLock () const

Private Member Functions
virtual void	elemsClear ()
	Delete all the _ELEMs and set their pointers to NULL.
virtual void	setProjectFullName (const wxString &aFullPathAndName)
	Set the full directory, basename, and extension of the project.
virtual void	setProjectFile (PROJECT_FILE *aFile)
	Set the backing store file for this project.
virtual void	setLocalSettings (PROJECT_LOCAL_SETTINGS *aSettings)
	Set the local settings backing store.
const wxString	libTableName (const wxString &aLibTableName) const
	Return the full path and file name of the project specific library table aLibTableName.

Private Attributes
wxFileName	m_project_name
	<fullpath>/<basename>.pro
wxString	m_pro_date_and_time
bool	m_readOnly
	No project files will be written to disk.
int	m_textVarsTicker
	Update counter on text vars.
int	m_netclassesTicker
	Update counter on netclasses.
PROJECT_FILE *	m_projectFile
	Backing store for project data – owned by SETTINGS_MANAGER.
PROJECT_LOCAL_SETTINGS *	m_localSettings
	Backing store for project local settings – owned by SETTINGS_MANAGER.
std::map< KIID, wxString >	m_sheetNames
std::array< wxString, RSTRING_COUNT >	m_rstrings
std::array< _ELEM *, static_cast< unsigned int >(PROJECT::ELEM::COUNT)>	m_elems
std::unique_ptr< LOCKFILE >	m_project_lock
	Lock.

Friends
class	SETTINGS_MANAGER
class	TEST_NETLISTS_FIXTURE

Detailed Description

Container for project specific data.

Because it is in the neutral program top, which is not linked to by subsidiary DSOs, any functions in this interface must be virtual.

Definition at line 64 of file project.h.

Member Enumeration Documentation

ELEM

enum class PROJECT::ELEM

strong

The set of #_ELEMs that a PROJECT can hold.

Enumerator
FPTBL
SCH_SYMBOL_LIBS
SCH_SEARCH_STACK
S3DCACHE
SYMBOL_LIB_TABLE
SEARCH_STACK
DESIGN_BLOCK_LIB_TABLE
SCHEMATIC
BOARD
COUNT

Definition at line 70 of file project.h.

LIB_TYPE_T

enum PROJECT::LIB_TYPE_T

Enumerator
SYMBOL_LIB
FOOTPRINT_LIB
DESIGN_BLOCK_LIB
LIB_TYPE_COUNT

Definition at line 192 of file project.h.

RSTRING_T

enum PROJECT::RSTRING_T

Retain a number of project specific wxStrings, enumerated here:

Enumerator
DOC_PATH
SCH_LIB_PATH
SCH_LIB_SELECT
SCH_LIBEDIT_CUR_LIB
SCH_LIBEDIT_CUR_SYMBOL
VIEWER_3D_PATH
VIEWER_3D_FILTER_INDEX
PCB_LIB_NICKNAME
PCB_FOOTPRINT
PCB_FOOTPRINT_EDITOR_FP_NAME
PCB_FOOTPRINT_EDITOR_LIB_NICKNAME
PCB_FOOTPRINT_VIEWER_FP_NAME
PCB_FOOTPRINT_VIEWER_LIB_NICKNAME
RSTRING_COUNT

Definition at line 217 of file project.h.

Constructor & Destructor Documentation

PROJECT()

PROJECT::PROJECT

(

)

Definition at line 47 of file project.cpp.

References m_elems.

~PROJECT()

PROJECT::~PROJECT ( )

virtual

Definition at line 69 of file project.cpp.

References elemsClear().

Member Function Documentation

AbsolutePath()

const wxString PROJECT::AbsolutePath ( const wxString &  aFileName ) const

virtual

Fix up aFileName if it is relative to the project's directory to be an absolute path and filename.

This intends to overcome the now missing chdir() into the project directory.

Definition at line 372 of file project.cpp.

References FN_NORMALIZE_FLAGS, and GetProjectFullName().

Referenced by PCB_EDIT_FRAME::DoAutoSave(), SCH_EDIT_FRAME::doCloseWindow(), PCB_BASE_EDIT_FRAME::GetDesignRulesPath(), API_HANDLER_PCB::handleRevertDocument(), PANEL_SETUP_RULES::ImportSettingsFrom(), DIALOG_EXPORT_STEP::onExportButton(), DIALOG_GENDRILL::onGenReportFile(), SCH_EDIT_FRAME::OnOpenCvpcb(), DIALOG_PLOT::onOpenOutputDirectory(), SCH_EDIT_FRAME::OnOpenPcbnew(), DIALOG_PLOT_SCHEMATIC::onOutputDirectoryBrowseClicked(), DIALOG_GEN_FOOTPRINT_POSITION::onOutputDirectoryBrowseClicked(), DIALOG_GENDRILL::onOutputDirectoryBrowseClicked(), DIALOG_PLOT::onOutputDirectoryBrowseClicked(), DIALOG_SYMBOL_FIELDS_TABLE::OnOutputFileBrowseClicked(), BOARD_EDITOR_CONTROL::Open(), SCH_EDIT_FRAME::OpenProjectFiles(), BOARD_EDITOR_CONTROL::RescueAutosave(), SIM_LIB_MGR::ResolveLibraryPath(), BOARD_EDITOR_CONTROL::Revert(), SCH_EDIT_FRAME::SaveProject(), SCH_EDIT_FRAME::saveSchematicFile(), SIMULATOR_CONTROL::SaveWorkbook(), PROJECT_SCH::SchSearchS(), DIALOG_SHEET_PROPERTIES::TransferDataFromWindow(), SIMULATOR_FRAME::UpdateTitle(), and WriteDRCReport().

ApplyTextVars()

void PROJECT::ApplyTextVars ( const std::map< wxString, wxString > &  aVarsMap )

virtual

Applies the given var map, it will create or update existing vars.

Definition at line 103 of file project.cpp.

References GetTextVars().

Referenced by EESCHEMA_JOBS_HANDLER::JobExportBom(), PCBNEW_JOBS_HANDLER::JobExportDrc(), PCBNEW_JOBS_HANDLER::JobExportDxf(), PCBNEW_JOBS_HANDLER::JobExportGerber(), PCBNEW_JOBS_HANDLER::JobExportGerbers(), EESCHEMA_JOBS_HANDLER::JobExportNetlist(), PCBNEW_JOBS_HANDLER::JobExportPdf(), EESCHEMA_JOBS_HANDLER::JobExportPlot(), PCBNEW_JOBS_HANDLER::JobExportPs(), EESCHEMA_JOBS_HANDLER::JobExportPythonBom(), PCBNEW_JOBS_HANDLER::JobExportRender(), PCBNEW_JOBS_HANDLER::JobExportStep(), PCBNEW_JOBS_HANDLER::JobExportSvg(), and EESCHEMA_JOBS_HANDLER::JobSchErc().

Clear()

void PROJECT::Clear ( )

inline

Clear the _ELEMs and RSTRINGs.

Definition at line 274 of file project.h.

Referenced by setProjectFullName().

DesignBlockLibs()

DESIGN_BLOCK_LIB_TABLE * PROJECT::DesignBlockLibs ( )

virtual

Return the table of design block libraries.

Definition at line 431 of file project.cpp.

References _, DESIGN_BLOCK_LIB_TABLE, DesignBlockLibTblName(), DisplayErrorMessage(), GetElem(), DESIGN_BLOCK_LIB_TABLE::GetGlobalLibTable(), LIB_TABLE::Load(), DESIGN_BLOCK_LIB_TABLE::ProjectElementType(), SetElem(), and IO_ERROR::What().

Referenced by DESIGN_BLOCK_PANE::AddDesignBlockLibrary(), DESIGN_BLOCK_PANE::DeleteDesignBlockFromLibrary(), DESIGN_BLOCK_PANE::DeleteDesignBlockLibrary(), DESIGN_BLOCK_PANE::EditDesignBlockProperties(), DESIGN_BLOCK_PANE::GetDesignBlock(), InvokeEditDesignBlockLibTable(), PANEL_DESIGN_BLOCK_CHOOSER::PANEL_DESIGN_BLOCK_CHOOSER(), PANEL_DESIGN_BLOCK_CHOOSER::RefreshLibs(), PCB_EDIT_FRAME::SaveBoardAsDesignBlock(), PCB_EDIT_FRAME::SaveBoardToDesignBlock(), SCH_EDIT_FRAME::SaveSelectionAsDesignBlock(), SCH_EDIT_FRAME::SaveSelectionToDesignBlock(), PCB_EDIT_FRAME::SaveSelectionToDesignBlock(), PCB_EDIT_FRAME::saveSelectionToDesignBlock(), SCH_EDIT_FRAME::SaveSheetAsDesignBlock(), SCH_EDIT_FRAME::SaveSheetToDesignBlock(), and DESIGN_BLOCK_PANE::selectDesignBlockLibTable().

DesignBlockLibTblName()

const wxString PROJECT::DesignBlockLibTblName ( ) const

virtual

Return the path and file name of this projects design block library table.

Definition at line 184 of file project.cpp.

References FILEEXT::DesignBlockLibraryTableFileName, and libTableName().

Referenced by DESIGN_BLOCK_PANE::AddDesignBlockLibrary(), DesignBlockLibs(), and InvokeEditDesignBlockLibTable().

elemsClear()

void PROJECT::elemsClear ( )

privatevirtual

Delete all the _ELEMs and set their pointers to NULL.

Definition at line 58 of file project.cpp.

References m_elems, and SetElem().

Referenced by ~PROJECT().

FootprintLibTblName()

const wxString PROJECT::FootprintLibTblName ( ) const

virtual

Returns the path and filename of this project's footprint library table.

This project specific footprint library table not the global one.

Definition at line 178 of file project.cpp.

References FILEEXT::FootprintLibraryTableFileName, and libTableName().

Referenced by InvokePcbLibTableEditor(), PCB_EDIT_FRAME::OpenProjectFiles(), PcbFootprintLibs(), and PROJECT_PCB::PcbFootprintLibs().

GetElem()

PROJECT::_ELEM * PROJECT::GetElem ( PROJECT::ELEM  aIndex )

virtual

Get and set the elements for this project.

This is a cross module API, therefore the #_ELEM destructor is virtual and can point to a destructor function in another link image. Be careful that that program module is resident at time of destruction.

Summary: -#) cross module API. -#) PROJECT knows nothing about #_ELEM objects except how to delete them and set and get pointers to them.

Definition at line 350 of file project.cpp.

References m_elems.

Referenced by PROJECT_PCB::Cleanup3DCache(), DesignBlockLibs(), PROJECT_PCB::Get3DCacheManager(), PcbFootprintLibs(), PROJECT_PCB::PcbFootprintLibs(), PROJECT_SCH::SchLibs(), PROJECT_SCH::SchSearchS(), PROJECT_SCH::SchSymbolLibTable(), and LEGACY_RESCUER::WriteRescueLibrary().

GetLocalSettings()

virtual PROJECT_LOCAL_SETTINGS & PROJECT::GetLocalSettings ( ) const

inlinevirtual

Definition at line 210 of file project.h.

Referenced by PCB_NET_INSPECTOR_PANEL::buildColumns(), PCB_NET_INSPECTOR_PANEL::buildNetsList(), KICAD_MANAGER_FRAME::CloseProject(), ZONE_FILLER::Fill(), ZONE_FILLER::fillCopperZone(), BOARD::GetVisibleElements(), BOARD::GetVisibleLayers(), BOARD::IsElementVisible(), BOARD::IsLayerVisible(), SCH_EDIT_FRAME::LoadProjectSettings(), PCB_EDIT_FRAME::LoadProjectSettings(), EDA_BASE_FRAME::LoadWindowState(), PCB_NET_INSPECTOR_PANEL::netFilterMatches(), KICAD_MANAGER_CONTROL::NewFromRepository(), PCB_NET_INSPECTOR_PANEL::OnBoardChanged(), PCB_EDIT_FRAME::OnBoardLoaded(), PCB_NET_INSPECTOR_PANEL::OnConfigButton(), PROJECT_TREE_PANE::onGitInitializeProject(), KICAD_MANAGER_FRAME::OnIdle(), PCB_EDIT_FRAME::OpenProjectFiles(), APPEARANCE_CONTROLS::rebuildNets(), KICAD_MANAGER_FRAME::SaveOpenJobSetsToLocalSettings(), SETTINGS_MANAGER::SaveProject(), KICAD_MANAGER_CONTROL::SaveProjectAs(), SETTINGS_MANAGER::SaveProjectAs(), SETTINGS_MANAGER::SaveProjectCopy(), SCH_EDIT_FRAME::SaveProjectLocalSettings(), PCB_EDIT_FRAME::saveProjectSettings(), ROUTER_TOOL::saveRouterDebugLog(), PCB_NET_INSPECTOR_PANEL::SaveSettings(), EDA_BASE_FRAME::SaveSettings(), BOARD::SetElementVisibility(), BOARD::SetVisibleLayers(), APPEARANCE_CONTROLS::showNetclass(), KICAD_MANAGER_CONTROL::ShowPlayer(), and SETTINGS_MANAGER::unloadProjectFile().

GetNetclassesTicker()

int PROJECT::GetNetclassesTicker ( ) const

inline

Definition at line 121 of file project.h.

Referenced by PANEL_SETUP_NETCLASSES::PANEL_SETUP_NETCLASSES(), and PANEL_SETUP_NETCLASSES::TransferDataToWindow().

GetProjectDirectory()

const wxString PROJECT::GetProjectDirectory ( ) const

virtual

Return the full path of the project DIRECTORY.

This is the path of the project file and will always be an absolute path, ending with a path separator.

Definition at line 154 of file project.cpp.

References m_project_name.

Referenced by PROJECT_SCH::SchSearchS().

GetProjectFile()

virtual PROJECT_FILE & PROJECT::GetProjectFile ( ) const

inlinevirtual

Definition at line 204 of file project.h.

Referenced by SYMBOL_TREE_MODEL_ADAPTER::AddLibraries(), DESIGN_BLOCK_TREE_MODEL_ADAPTER::AddLibraries(), FP_TREE_MODEL_ADAPTER::AddLibraries(), DIALOG_PLOT::applyPlotSettings(), CONNECTION_GRAPH::buildConnectionGraph(), CVPCB_MAINFRAME::buildEquivalenceList(), CVPCB_MAINFRAME::BuildLibrariesList(), BOARD::ClearProject(), KICAD_MANAGER_FRAME::CloseProject(), DIALOG_ASSIGN_NETCLASS::DIALOG_ASSIGN_NETCLASS(), DIALOG_BOARD_SETUP::DIALOG_BOARD_SETUP(), DIALOG_CONFIG_EQUFILES::DIALOG_CONFIG_EQUFILES(), DIALOG_SCHEMATIC_SETUP::DIALOG_SCHEMATIC_SETUP(), SCHEMATIC::ErcSettings(), EVT_UPDATE_UI_RANGE(), FIELDS_GRID_TABLE::GetAttr(), SCH_ITEM::GetEffectiveNetClass(), PCB_EDIT_FRAME::GetLastPath(), SYMBOL_LIBS::GetLibNamesAndPaths(), SCH_EDIT_FRAME::GetSchematicJunctionSize(), GetSheetName(), GetTextVars(), API_HANDLER_COMMON::handleGetNetClasses(), API_HANDLER_COMMON::handleSetNetClasses(), DIALOG_EXPORT_2581::Init(), DIALOG_PLOT::init_Dialog(), DIALOG_GEN_FOOTPRINT_POSITION::initDialog(), FIELDS_GRID_TABLE::initGrid(), PCB_EDIT_FRAME::LoadDrawingSheet(), PCBNEW_JOBS_HANDLER::loadOverrideDrawingSheet(), PCB_EDIT_FRAME::LoadProjectSettings(), SCH_IO_ALTIUM::LoadSchematicFile(), SIMULATOR_FRAME::LoadSettings(), DIALOG_SCHEMATIC_SETUP::onAuxiliaryAction(), DIALOG_BOARD_SETUP::onAuxiliaryAction(), PCB_EDIT_FRAME::OnBoardLoaded(), DIALOG_GEN_FOOTPRINT_POSITION::onGenerate(), DIALOG_CONFIG_EQUFILES::OnOkClick(), PANEL_SYMBOL_CHOOSER::PANEL_SYMBOL_CHOOSER(), SCHEMATIC::RecalculateConnections(), SYMBOL_VIEWER_FRAME::ReCreateLibList(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), SCHEMATIC::Reset(), SAVE_AS_DIALOG::SAVE_AS_DIALOG(), SCH_EDIT_FRAME::SaveProject(), KICAD_MANAGER_CONTROL::SaveProjectAs(), PCB_EDIT_FRAME::SaveProjectLocalSettings(), SCH_EDIT_FRAME::saveProjectSettings(), ROUTER_TOOL::saveRouterDebugLog(), SIMULATOR_FRAME::SaveSettings(), PCB_BASE_FRAME::SelectLibrary(), SCH_BASE_FRAME::SelectLibraryFromList(), PCB_EDIT_FRAME::SetLastPath(), SYMBOL_LIBS::SetLibNamesAndPaths(), SCHEMATIC::SetProject(), BOARD::SetProject(), SCHEMATIC::Settings(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::Sync(), FP_TREE_SYNCHRONIZING_ADAPTER::Sync(), BOARD::SynchronizeComponentClasses(), ERC_TESTER::TestMissingNetclasses(), DIALOG_ASSIGN_NETCLASS::TransferDataFromWindow(), DIALOG_EXPORT_2581::TransferDataFromWindow(), and EDA_3D_VIEWER_FRAME::~EDA_3D_VIEWER_FRAME().

GetProjectFullName()

const wxString PROJECT::GetProjectFullName ( ) const

virtual

Return the full path and name of the project.

This is the same as the name of the project file (.pro prior to version 6 and .kicad_prj from version 6 onwards) and will always be an absolute path.

Definition at line 142 of file project.cpp.

References m_project_name.

Referenced by AbsolutePath(), DIALOG_SYMBOL_REMAP::backupProject(), DIALOG_BOARD_STATISTICS::DIALOG_BOARD_STATISTICS(), SCH_EDIT_FRAME::doCloseWindow(), BOARD_EDITOR_CONTROL::ExportCmpFile(), BOARD_EDITOR_CONTROL::ExportNetlist(), SYMBOL_EDITOR_CONTROL::ExportSymbolAsSVG(), SYMBOL_EDITOR_CONTROL::ExportView(), BACK_ANNOTATE::FetchNetlistFromPCB(), BOARD_EDITOR_CONTROL::GenD356File(), PCBNEW_JOBS_HANDLER::getBoard(), KICAD_MANAGER_FRAME::GetProjectFileName(), SCH_EDITOR_CONTROL::ImportFPAssignments(), SCH_DRAWING_TOOLS::ImportSheet(), libTableName(), SYMBOL_LIBS::LoadAllLibraries(), SETTINGS_MANAGER::loadProjectFile(), SCH_IO_CADSTAR_ARCHIVE::LoadSchematicFile(), SCH_EDIT_FRAME::OnImportProject(), SCH_EDIT_FRAME::OnUpdatePCB(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), SETTINGS_MANAGER::SaveProject(), SETTINGS_MANAGER::SaveProjectAs(), SETTINGS_MANAGER::SaveProjectCopy(), PCB_EDIT_FRAME::SaveProjectLocalSettings(), PCB_EDIT_FRAME::saveProjectSettings(), setProjectFullName(), EDA_3D_VIEWER_FRAME::TakeScreenshot(), KICAD_MANAGER_FRAME::UnarchiveFiles(), SETTINGS_MANAGER::UnloadProject(), SETTINGS_MANAGER::unloadProjectFile(), and SCH_EDIT_FRAME::updateAutoSaveFile().

GetProjectLock()

LOCKFILE * PROJECT::GetProjectLock

(

)

const

Definition at line 473 of file project.cpp.

References m_project_lock.

GetProjectName()

const wxString PROJECT::GetProjectName ( ) const

virtual

Return the short name of the project.

This is the file name without extension or path.

Definition at line 160 of file project.cpp.

References m_project_name.

Referenced by SIMULATOR_CONTROL::getDefaultFilename(), SCH_IO_ALTIUM::getLibName(), SCH_IO_EAGLE::getLibName(), SETTINGS_MANAGER::GetProjectBackupsPath(), SCH_IO_EAGLE::loadLibrary(), DIALOG_SHEET_PROPERTIES::onSheetFilenameChanged(), SCH_EDITOR_CONTROL::Paste(), SCH_EDITOR_CONTROL::prunePastedSymbolInstances(), SCHEMATIC::ResolveTextVar(), BOARD::ResolveTextVar(), KICAD_MANAGER_CONTROL::SaveProjectAs(), DIALOG_BOARD_STATISTICS::saveReportClicked(), SCH_IO_KICAD_SEXPR::saveSheet(), PROJECT_FILE::SaveToFile(), PROJECT_LOCAL_SETTINGS::SaveToFile(), TextVarResolver(), SETTINGS_MANAGER::TriggerBackupIfNeeded(), SCH_EDITOR_CONTROL::updatePastedSymbol(), and NETLIST_EXPORTER_SPICE_MODEL::WriteHead().

GetProjectPath()

const wxString PROJECT::GetProjectPath ( ) const

virtual

Return the full path of the project.

This is the path of the project file and will always be an absolute path, ending with a path separator.

Definition at line 148 of file project.cpp.

References m_project_name.

Referenced by PANEL_SYM_LIB_TABLE::browseLibrariesHandler(), DESIGN_BLOCK_PANE::createNewDesignBlockLibrary(), PCB_BASE_EDIT_FRAME::createNewLibrary(), DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS(), DIALOG_SYMBOL_REMAP::DIALOG_SYMBOL_REMAP(), KICAD_MANAGER_CONTROL::Execute(), SCH_EDITOR_CONTROL::ExportSymbolsToLibrary(), SIMULATOR_CONTROL::getDefaultPath(), FOOTPRINT_LIST::GetInstance(), SCH_IO_ALTIUM::getLibFileName(), SCH_IO_EAGLE::getLibFileName(), SETTINGS_MANAGER::GetPathForSettingsFile(), SETTINGS_MANAGER::GetProjectBackupsPath(), FIELDS_GRID_TABLE::initGrid(), SIMULATOR_FRAME_UI::InitWorkbook(), InvokeEditDesignBlockLibTable(), InvokePcbLibTableEditor(), InvokeSchEditSymbolLibTable(), EDA_DRAW_FRAME::LibraryFileBrowser(), LTSPICE_SCHEMATIC::Load(), PCBNEW_JOBS_HANDLER::loadOverrideDrawingSheet(), SCH_EDIT_FRAME::LoadProject(), SCH_IO_ALTIUM::LoadSchematicFile(), SCH_IO_CADSTAR_ARCHIVE::LoadSchematicFile(), SCH_IO_EAGLE::LoadSchematicFile(), SCH_IO_EASYEDAPRO::LoadSchematicFile(), SCH_IO_KICAD_LEGACY::LoadSchematicFile(), SCH_IO_KICAD_SEXPR::LoadSchematicFile(), SCH_IO_ALTIUM::LoadSchematicProject(), CADSTAR_SCH_ARCHIVE_LOADER::loadSheetAndChildSheets(), SCH_EDIT_FRAME::LoadSheetFromFile(), CADSTAR_SCH_ARCHIVE_LOADER::loadSheets(), SIMULATOR_FRAME_UI::LoadWorkbook(), NormalizePath(), PANEL_FP_PROPERTIES_3D_MODEL::OnAdd3DModel(), DIALOG_SIM_MODEL< T >::onBrowseButtonClick(), PROJECT_TREE_PANE::onGitCommit(), KICAD_MANAGER_FRAME::OnOpenFileInTextEditor(), DIALOG_ERC::OnSaveReport(), DIALOG_DRC::OnSaveReport(), PANEL_FP_PROPERTIES_3D_MODEL::PANEL_FP_PROPERTIES_3D_MODEL(), PANEL_SYM_LIB_TABLE::PANEL_SYM_LIB_TABLE(), SCH_IO_ALTIUM::ParseAltiumSch(), SCH_EDITOR_CONTROL::Paste(), PathIsInsideProject(), SYMBOL_EDIT_FRAME::replaceLibTableEntry(), ResolveFile(), JOBS_RUNNER::runSpecialCopyFiles(), SETTINGS_MANAGER::SaveProject(), SIMULATOR_FRAME_UI::SaveWorkbook(), FILENAME_RESOLVER::SetProject(), PANEL_SYM_LIB_TABLE::setupGrid(), SCH_EDIT_FRAME::WriteNetListFile(), and SYMBOL_LIB_TABLE_RESCUER::WriteRescueLibrary().

GetRString()

const wxString & PROJECT::GetRString ( RSTRING_T  aStringId )

virtual

Return a "retained string", which is any session and project specific string identified in enum RSTRING_T.

Retained strings are not written to disk, and are therefore good only for the current session.

Definition at line 331 of file project.cpp.

References m_rstrings.

Referenced by PCB_EDIT_FRAME::ExportFootprintsToLibrary(), FOOTPRINT_VIEWER_FRAME::getCurFootprintName(), SYMBOL_EDIT_FRAME::GetCurLib(), FOOTPRINT_VIEWER_FRAME::getCurNickname(), PANEL_FP_PROPERTIES_3D_MODEL::OnAdd3DModel(), FOOTPRINT_EDIT_FRAME::restoreLastFootprint(), SYMBOL_EDIT_FRAME::saveLibrary(), and SCH_BASE_FRAME::SelectLibraryFromList().

GetSheetName()

const wxString PROJECT::GetSheetName ( const KIID &  aSheetID )

virtual

Return the name of the sheet identified by the given UUID.

Definition at line 305 of file project.cpp.

References KIID::AsString(), GetProjectFile(), and m_sheetNames.

GetTextVars()

std::map< wxString, wxString > & PROJECT::GetTextVars ( ) const

virtual

Definition at line 97 of file project.cpp.

References GetProjectFile(), and PROJECT_FILE::m_TextVars.

Referenced by ApplyTextVars(), PANEL_TEXT_VARIABLES::checkReload(), DIALOG_TABLE_PROPERTIES::getContextualTextVars(), DIALOG_TABLECELL_PROPERTIES::getContextualTextVars(), DIALOG_TEXT_PROPERTIES::getContextualTextVars(), SCHEMATIC::GetContextualTextVars(), PANEL_TEXT_VARIABLES::ImportSettingsFrom(), CADSTAR_SCH_ARCHIVE_LOADER::loadTextVariables(), CADSTAR_PCB_ARCHIVE_LOADER::loadTextVariables(), NETLIST_EXPORTER_XML::makeDesignHeader(), SCH_FIELD::OnScintillaCharAdded(), PROPERTIES_FRAME::onScintillaCharAdded(), SCH_IO_ALTIUM::ParseParameter(), BOARD::SynchronizeProperties(), TextVarResolver(), PANEL_TEXT_VARIABLES::TransferDataFromWindow(), and PANEL_TEXT_VARIABLES::TransferDataToWindow().

GetTextVarsTicker()

int PROJECT::GetTextVarsTicker ( ) const

inline

Definition at line 118 of file project.h.

Referenced by PANEL_SETUP_NETCLASSES::checkReload(), PANEL_TEXT_VARIABLES::checkReload(), PANEL_TEXT_VARIABLES::ImportSettingsFrom(), PANEL_TEXT_VARIABLES::PANEL_TEXT_VARIABLES(), and PANEL_TEXT_VARIABLES::TransferDataToWindow().

IncrementNetclassesTicker()

void PROJECT::IncrementNetclassesTicker ( )

inline

Definition at line 122 of file project.h.

Referenced by PCB_EDIT_FRAME::ShowBoardSetupDialog(), and SCH_EDIT_FRAME::ShowSchematicSetupDialog().

IncrementTextVarsTicker()

void PROJECT::IncrementTextVarsTicker ( )

inline

Definition at line 119 of file project.h.

Referenced by PCB_EDIT_FRAME::ShowBoardSetupDialog(), and SCH_EDIT_FRAME::ShowSchematicSetupDialog().

IsNullProject()

bool PROJECT::IsNullProject ( ) const

virtual

Check if this project is a null project (i.e.

the default project object created when no real project is open).

The null project still presents all the same project interface, but is not backed by any files, so saving it makes no sense.

Returns

true if this is an empty project.

Definition at line 166 of file project.cpp.

References m_project_name.

Referenced by AskSaveBoardFileName(), SCH_EDITOR_CONTROL::ExportSymbolsToLibrary(), PANEL_SETUP_RULES::ImportSettingsFrom(), InvokeEditDesignBlockLibTable(), InvokePcbLibTableEditor(), InvokeSchEditSymbolLibTable(), EDA_DRAW_FRAME::LibraryFileBrowser(), SYMBOL_LIBS::LoadAllLibraries(), SCHEMATIC::Reset(), PCB_EDIT_FRAME::SaveProjectLocalSettings(), DESIGN_BLOCK_PANE::selectDesignBlockLibTable(), BOARD::SynchronizeProperties(), PANEL_SETUP_RULES::TransferDataFromWindow(), and PANEL_SETUP_RULES::TransferDataToWindow().

IsReadOnly()

virtual bool PROJECT::IsReadOnly ( ) const

inlinevirtual

Definition at line 166 of file project.h.

Referenced by SETTINGS_MANAGER::SaveProject(), and SETTINGS_MANAGER::SaveProjectAs().

libTableName()

const wxString PROJECT::libTableName ( const wxString &  aLibTableName ) const

private

Return the full path and file name of the project specific library table aLibTableName.

Definition at line 260 of file project.cpp.

References GetProjectFullName(), KIPLATFORM::ENV::GetUserConfigPath(), and path.

Referenced by DesignBlockLibTblName(), FootprintLibTblName(), and SymbolLibTableName().

PcbFootprintLibs()

FP_LIB_TABLE * PROJECT::PcbFootprintLibs ( KIWAY &  aKiway )

virtual

Return the table of footprint libraries.

Requires an active Kiway as this is fetched from Pcbnew.

Definition at line 391 of file project.cpp.

References _, DisplayErrorMessage(), KIWAY::FACE_PCB, FootprintLibTblName(), FPTBL, GetElem(), IFACE::IfaceOrAddress(), kiface(), KIWAY::KiFACE(), KIFACE_NEW_FOOTPRINT_TABLE, LIB_TABLE::Load(), FP_LIB_TABLE::ProjectElementType(), SetElem(), and IO_ERROR::What().

Referenced by FOOTPRINT_SELECT_WIDGET::Load().

PinLibrary()

void PROJECT::PinLibrary	(	const wxString &	aLibrary,
		enum LIB_TYPE_T	aLibType
	)

Definition at line 190 of file project.cpp.

References alg::contains(), DESIGN_BLOCK_LIB, FOOTPRINT_LIB, PGM_BASE::GetCommonSettings(), GetSettingsManager(), PGM_BASE::GetSettingsManager(), PROJECT_FILE::m_PinnedDesignBlockLibs, PROJECT_FILE::m_PinnedFootprintLibs, PROJECT_FILE::m_PinnedSymbolLibs, m_projectFile, COMMON_SETTINGS::m_Session, Pgm(), COMMON_SETTINGS::SESSION::pinned_design_block_libs, COMMON_SETTINGS::SESSION::pinned_fp_libs, COMMON_SETTINGS::SESSION::pinned_symbol_libs, SETTINGS_MANAGER::SaveProject(), JSON_SETTINGS::SaveToFile(), and SYMBOL_LIB.

Referenced by LIBRARY_EDITOR_CONTROL::changeSelectedPinStatus(), DESIGN_BLOCK_CONTROL::PinLibrary(), and LIB_TREE_MODEL_ADAPTER::PinLibrary().

SetElem()

void PROJECT::SetElem ( PROJECT::ELEM  aIndex, _ELEM *  aElem  )

virtual

Definition at line 361 of file project.cpp.

References m_elems.

Referenced by DesignBlockLibs(), elemsClear(), PROJECT_PCB::Get3DCacheManager(), KI_TEST::LoadSchematic(), SCH_IO_ALTIUM::LoadSchematicFile(), SCH_IO_CADSTAR_ARCHIVE::LoadSchematicFile(), SCH_IO_EAGLE::LoadSchematicFile(), SCH_IO_EASYEDAPRO::LoadSchematicFile(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), SCH_EDIT_FRAME::OpenProjectFiles(), PcbFootprintLibs(), PROJECT_PCB::PcbFootprintLibs(), PROJECT_SCH::SchLibs(), PROJECT_SCH::SchSearchS(), PROJECT_SCH::SchSymbolLibTable(), KICAD_MANAGER_CONTROL::ShowPluginManager(), LEGACY_RESCUER::WriteRescueLibrary(), and SYMBOL_LIB_TABLE_RESCUER::WriteRescueLibrary().

setLocalSettings()

virtual void PROJECT::setLocalSettings ( PROJECT_LOCAL_SETTINGS *  aSettings )

inlineprivatevirtual

Set the local settings backing store.

This should only be called by SETTINGS_MANAGER on load.

Parameters

aSettings

is the local settings object (may or may not exist on disk at this point)

Definition at line 343 of file project.h.

setProjectFile()

virtual void PROJECT::setProjectFile ( PROJECT_FILE *  aFile )

inlineprivatevirtual

Set the backing store file for this project.

This should only be called by #SETTINGS_MANGER on load.

Parameters

aFile

is a loaded PROJECT_FILE.

Definition at line 331 of file project.h.

Referenced by SETTINGS_MANAGER::loadProjectFile().

setProjectFullName()

void PROJECT::setProjectFullName ( const wxString &  aFullPathAndName )

privatevirtual

Set the full directory, basename, and extension of the project.

This is the name of the project file with full absolute path and it also defines the name of the project. The project name and the project file names are exactly the same, providing the project filename is absolute.

Definition at line 118 of file project.cpp.

References Clear(), GetProjectFullName(), m_project_name, FILEEXT::ProjectFileExtension, TO_UTF8, and tracePathsAndFiles.

Referenced by SETTINGS_MANAGER::SaveProjectAs().

SetProjectLock()

void PROJECT::SetProjectLock

(

LOCKFILE *

aLockFile

)

Definition at line 467 of file project.cpp.

References m_project_lock.

Referenced by KICAD_MANAGER_FRAME::ProjectChanged().

SetReadOnly()

virtual void PROJECT::SetReadOnly ( bool  aReadOnly = true )

inlinevirtual

Definition at line 168 of file project.h.

Referenced by SCH_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), KICAD_MANAGER_FRAME::ProjectChanged(), PCB_EDIT_FRAME::SavePcbFile(), and SCH_EDIT_FRAME::SaveProject().

SetRString()

void PROJECT::SetRString ( RSTRING_T  aStringId, const wxString &  aString  )

virtual

Store a "retained string", which is any session and project specific string identified in enum RSTRING_T.

Retained strings are not written to disk, and are therefore good only for the current session.

Definition at line 320 of file project.cpp.

References m_rstrings.

Referenced by PCB_EDIT_FRAME::ExportFootprintsToLibrary(), SYMBOL_EDIT_FRAME::GetCurLib(), PANEL_FP_PROPERTIES_3D_MODEL::OnAdd3DModel(), FOOTPRINT_EDIT_FRAME::retainLastFootprint(), SYMBOL_EDIT_FRAME::saveLibrary(), SCH_BASE_FRAME::SelectLibraryFromList(), FOOTPRINT_VIEWER_FRAME::setCurFootprintName(), SYMBOL_EDIT_FRAME::SetCurLib(), FOOTPRINT_VIEWER_FRAME::setCurNickname(), and SYMBOL_EDIT_FRAME::SetCurSymbol().

SymbolLibTableName()

const wxString PROJECT::SymbolLibTableName ( ) const

virtual

Return the path and file name of this projects symbol library table.

Definition at line 172 of file project.cpp.

References libTableName(), and FILEEXT::SymbolLibraryTableFileName.

Referenced by SCH_EDIT_FRAME::KiwayMailIn().

TextVarResolver()

bool PROJECT::TextVarResolver ( wxString *  aToken ) const

virtual

Definition at line 75 of file project.cpp.

References TITLE_BLOCK::GetCurrentDate(), GetProjectName(), and GetTextVars().

Referenced by ExpandTextVars(), JOB::GetFullOutputPath(), KIwxExpandEnvVars(), and SCHEMATIC::ResolveTextVar().

UnpinLibrary()

void PROJECT::UnpinLibrary	(	const wxString &	aLibrary,
		enum LIB_TYPE_T	aLibType
	)

Definition at line 227 of file project.cpp.

References alg::delete_matching(), DESIGN_BLOCK_LIB, FOOTPRINT_LIB, PGM_BASE::GetCommonSettings(), GetSettingsManager(), PGM_BASE::GetSettingsManager(), PROJECT_FILE::m_PinnedDesignBlockLibs, PROJECT_FILE::m_PinnedFootprintLibs, PROJECT_FILE::m_PinnedSymbolLibs, m_projectFile, COMMON_SETTINGS::m_Session, Pgm(), COMMON_SETTINGS::SESSION::pinned_design_block_libs, COMMON_SETTINGS::SESSION::pinned_fp_libs, COMMON_SETTINGS::SESSION::pinned_symbol_libs, SETTINGS_MANAGER::SaveProject(), JSON_SETTINGS::SaveToFile(), and SYMBOL_LIB.

Referenced by LIBRARY_EDITOR_CONTROL::changeSelectedPinStatus(), DESIGN_BLOCK_CONTROL::UnpinLibrary(), and LIB_TREE_MODEL_ADAPTER::UnpinLibrary().

Friends And Related Function Documentation

SETTINGS_MANAGER

friend class SETTINGS_MANAGER

friend

Definition at line 306 of file project.h.

TEST_NETLISTS_FIXTURE

friend class TEST_NETLISTS_FIXTURE

friend

Definition at line 307 of file project.h.

Member Data Documentation

m_elems

std::array<_ELEM*,static_cast<unsigned int>( PROJECT::ELEM::COUNT )> PROJECT::m_elems

private

See also

this::Elem() and enum ELEM_T.

Definition at line 373 of file project.h.

Referenced by elemsClear(), GetElem(), PROJECT(), and SetElem().

m_localSettings

PROJECT_LOCAL_SETTINGS* PROJECT::m_localSettings

private

Backing store for project local settings – owned by SETTINGS_MANAGER.

Definition at line 365 of file project.h.

m_netclassesTicker

int PROJECT::m_netclassesTicker

private

Update counter on netclasses.

Definition at line 359 of file project.h.

m_pro_date_and_time

wxString PROJECT::m_pro_date_and_time

private

Definition at line 355 of file project.h.

m_project_lock

std::unique_ptr<LOCKFILE> PROJECT::m_project_lock

private

Lock.

Definition at line 376 of file project.h.

Referenced by GetProjectLock(), and SetProjectLock().

m_project_name

wxFileName PROJECT::m_project_name

private

<fullpath>/<basename>.pro

Definition at line 354 of file project.h.

Referenced by GetProjectDirectory(), GetProjectFullName(), GetProjectName(), GetProjectPath(), IsNullProject(), and setProjectFullName().

m_projectFile

PROJECT_FILE* PROJECT::m_projectFile

private

Backing store for project data – owned by SETTINGS_MANAGER.

Definition at line 362 of file project.h.

Referenced by PinLibrary(), and UnpinLibrary().

m_readOnly

bool PROJECT::m_readOnly

private

No project files will be written to disk.

Definition at line 357 of file project.h.

m_rstrings

std::array<wxString,RSTRING_COUNT> PROJECT::m_rstrings

private

See also

this::SetRString(), GetRString(), and enum RSTRING_T.

Definition at line 370 of file project.h.

Referenced by GetRString(), and SetRString().

m_sheetNames

std::map<KIID, wxString> PROJECT::m_sheetNames

private

Definition at line 367 of file project.h.

Referenced by GetSheetName().

m_textVarsTicker

int PROJECT::m_textVarsTicker

private

Update counter on text vars.

Definition at line 358 of file project.h.

---

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

• project.h
• project.cpp