KiCad PCB EDA Suite
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  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...
 
enum  ELEM_T {
  ELEM_FPTBL , ELEM_SCH_SYMBOL_LIBS , ELEM_SCH_SEARCH_STACK , ELEM_3DCACHE ,
  ELEM_SYMBOL_LIB_TABLE , ELEM_COUNT
}
 The set of #_ELEMs that a PROJECT can hold. More...
 

Public Member Functions

 PROJECT ()
 
virtual ~PROJECT ()
 
virtual bool TextVarResolver (wxString *aToken) const
 
virtual std::map< wxString, wxString > & GetTextVars () const
 
virtual const wxString GetProjectFullName () const
 Return the full path and name of the project. More...
 
virtual const wxString GetProjectPath () const
 Return the full path of the project. More...
 
virtual const wxString GetProjectName () const
 Return the short name of the project. More...
 
virtual bool IsNullProject () const
 Check if this project is a null project (i.e. More...
 
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. More...
 
virtual const wxString FootprintLibTblName () const
 Returns the path and filename of this project's footprint library table. More...
 
virtual const wxString SymbolLibTableName () const
 Return the path and file name of this projects symbol library table. More...
 
void PinLibrary (const wxString &aLibrary, bool isSymbolLibrary)
 
void UnpinLibrary (const wxString &aLibrary, bool isSymbolLibrary)
 
virtual PROJECT_FILEGetProjectFile () const
 
virtual PROJECT_LOCAL_SETTINGSGetLocalSettings () 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. More...
 
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. More...
 
virtual _ELEMGetElem (ELEM_T aIndex)
 Get and set the elements for this project. More...
 
virtual void SetElem (ELEM_T aIndex, _ELEM *aElem)
 
virtual void ElemsClear ()
 Delete all the _ELEMs and set their pointers to NULL. More...
 
void Clear ()
 Clear the _ELEMs and RSTRINGs. More...
 
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. More...
 
virtual FP_LIB_TABLEPcbFootprintLibs (KIWAY &aKiway)
 Return the table of footprint libraries. More...
 

Private Member Functions

virtual void setProjectFullName (const wxString &aFullPathAndName)
 Set the full directory, basename, and extension of the project. More...
 
virtual void setProjectFile (PROJECT_FILE *aFile)
 Set the backing store file for this project. More...
 
virtual void setLocalSettings (PROJECT_LOCAL_SETTINGS *aSettings)
 Set the local settings backing store. More...
 
const wxString libTableName (const wxString &aLibTableName) const
 Return the full path and file name of the project specific library table aLibTableName. More...
 

Private Attributes

wxFileName m_project_name
 <fullpath>/<basename>.pro More...
 
wxString m_pro_date_and_time
 True if the project is read-only: no project files will be written. More...
 
bool m_readOnly
 
PROJECT_FILEm_projectFile
 Backing store for project data – owned by SETTINGS_MANAGER. More...
 
PROJECT_LOCAL_SETTINGSm_localSettings
 Backing store for project local settings – owned by SETTINGS_MANAGER. More...
 
std::map< KIID, wxString > m_sheetNames
 
wxString m_rstrings [RSTRING_COUNT]
 
_ELEMm_elems [ELEM_COUNT]
 

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 62 of file project.h.

Member Enumeration Documentation

◆ ELEM_T

The set of #_ELEMs that a PROJECT can hold.

Enumerator
ELEM_FPTBL 
ELEM_SCH_SYMBOL_LIBS 
ELEM_SCH_SEARCH_STACK 
ELEM_3DCACHE 
ELEM_SYMBOL_LIB_TABLE 
ELEM_COUNT 

Definition at line 203 of file project.h.

204 {
206
211
213 };
@ ELEM_SYMBOL_LIB_TABLE
Definition: project.h:210
@ ELEM_SCH_SEARCH_STACK
Definition: project.h:208
@ ELEM_3DCACHE
Definition: project.h:209
@ ELEM_COUNT
Definition: project.h:212
@ ELEM_FPTBL
Definition: project.h:205
@ ELEM_SCH_SYMBOL_LIBS
Definition: project.h:207

◆ 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 161 of file project.h.

162 {
163 DOC_PATH,
165 SCH_LIB_SELECT, // eeschema/selpart.cpp
167 SCH_LIBEDIT_CUR_SYMBOL, // eeschema/libeditframe.cpp
168
171
178
180 };
@ RSTRING_COUNT
Definition: project.h:179
@ VIEWER_3D_FILTER_INDEX
Definition: project.h:170
@ PCB_FOOTPRINT
Definition: project.h:173
@ VIEWER_3D_PATH
Definition: project.h:169
@ SCH_LIBEDIT_CUR_LIB
Definition: project.h:166
@ PCB_FOOTPRINT_EDITOR_FP_NAME
Definition: project.h:174
@ PCB_FOOTPRINT_EDITOR_LIB_NICKNAME
Definition: project.h:175
@ PCB_FOOTPRINT_VIEWER_FP_NAME
Definition: project.h:176
@ DOC_PATH
Definition: project.h:163
@ SCH_LIB_SELECT
Definition: project.h:165
@ PCB_LIB_NICKNAME
Definition: project.h:172
@ PCB_FOOTPRINT_VIEWER_LIB_NICKNAME
Definition: project.h:177
@ SCH_LIBEDIT_CUR_SYMBOL
Definition: project.h:167
@ SCH_LIB_PATH
Definition: project.h:164

Constructor & Destructor Documentation

◆ PROJECT()

PROJECT::PROJECT ( )

Definition at line 43 of file project.cpp.

43 :
44 m_readOnly( false ),
45 m_projectFile( nullptr ),
46 m_localSettings( nullptr )
47{
48 memset( m_elems, 0, sizeof( m_elems ) );
49}
PROJECT_FILE * m_projectFile
Backing store for project data – owned by SETTINGS_MANAGER.
Definition: project.h:352
_ELEM * m_elems[ELEM_COUNT]
Definition: project.h:363
PROJECT_LOCAL_SETTINGS * m_localSettings
Backing store for project local settings – owned by SETTINGS_MANAGER.
Definition: project.h:355
bool m_readOnly
Definition: project.h:349

References m_elems.

◆ ~PROJECT()

PROJECT::~PROJECT ( )
virtual

Definition at line 63 of file project.cpp.

64{
65 ElemsClear();
66}
virtual void ElemsClear()
Delete all the _ELEMs and set their pointers to NULL.
Definition: project.cpp:52

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 304 of file project.cpp.

305{
306 wxFileName fn = aFileName;
307
308 if( !fn.IsAbsolute() )
309 {
310 wxString pro_dir = wxPathOnly( GetProjectFullName() );
311 fn.Normalize( FN_NORMALIZE_FLAGS | wxPATH_NORM_ENV_VARS, pro_dir );
312 }
313
314 return fn.GetFullPath();
315}
virtual const wxString GetProjectFullName() const
Return the full path and name of the project.
Definition: project.cpp:119
#define FN_NORMALIZE_FLAGS
Default flags to pass to wxFileName::Normalize().
Definition: wx_filename.h:38

References FN_NORMALIZE_FLAGS, and GetProjectFullName().

Referenced by PCB_EDIT_FRAME::doAutoSave(), SCH_EDIT_FRAME::doCloseWindow(), PCB_EDIT_FRAME::Files_io_from_id(), PCB_BASE_EDIT_FRAME::GetDesignRulesPath(), DIALOG_SIM_MODEL< T >::loadLibrary(), DIALOG_GENDRILL::OnGenReportFile(), SCH_EDIT_FRAME::OnOpenCvpcb(), SCH_EDIT_FRAME::OnOpenPcbnew(), DIALOG_PLOT_SCHEMATIC::OnOutputDirectoryBrowseClicked(), DIALOG_EXPORT_SVG::OnOutputDirectoryBrowseClicked(), DIALOG_GENDRILL::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT::OnOutputDirectoryBrowseClicked(), DIALOG_GEN_FOOTPRINT_POSITION::OnOutputDirectoryBrowseClicked(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_EDITOR_CONTROL::Print(), SCH_EDIT_FRAME::PrintPage(), NETLIST_EXPORTER_SPICE::readLibraryField(), NETLIST_EXPORTER_SPICE::ReadSchematicAndLibraries(), SCH_EDIT_FRAME::SaveProject(), SCH_EDIT_FRAME::saveSchematicFile(), DIALOG_SHEET_PROPERTIES::TransferDataFromWindow(), DIALOG_SIM_MODEL< T >::updateModelCodeTab(), SIM_PLOT_FRAME::updateTitle(), and WriteDRCReport().

◆ Clear()

void PROJECT::Clear ( )
inline

Clear the _ELEMs and RSTRINGs.

Definition at line 238 of file project.h.

239 {
240 ElemsClear();
241
242 for( unsigned i = 0; i<RSTRING_COUNT; ++i )
243 SetRString( RSTRING_T( i ), wxEmptyString );
244 }
RSTRING_T
Retain a number of project specific wxStrings, enumerated here:
Definition: project.h:162
virtual void SetRString(RSTRING_T aStringId, const wxString &aString)
Store a "retained string", which is any session and project specific string identified in enum RSTRIN...
Definition: project.cpp:253

References ElemsClear(), RSTRING_COUNT, and SetRString().

Referenced by setProjectFullName().

◆ ElemsClear()

void PROJECT::ElemsClear ( )
virtual

Delete all the _ELEMs and set their pointers to NULL.

Definition at line 52 of file project.cpp.

53{
54 // careful here, this should work, but the virtual destructor may not
55 // be in the same link image as PROJECT.
56 for( unsigned i = 0; i < arrayDim( m_elems ); ++i )
57 {
58 SetElem( ELEM_T( i ), nullptr );
59 }
60}
constexpr std::size_t arrayDim(T const (&)[N]) noexcept
Returns # of elements in an array.
Definition: arraydim.h:31
virtual void SetElem(ELEM_T aIndex, _ELEM *aElem)
Definition: project.cpp:293
ELEM_T
The set of #_ELEMs that a PROJECT can hold.
Definition: project.h:204

References arrayDim(), m_elems, and SetElem().

Referenced by Clear(), and ~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 149 of file project.cpp.

150{
151 return libTableName( "fp-lib-table" );
152}
const wxString libTableName(const wxString &aLibTableName) const
Return the full path and file name of the project specific library table aLibTableName.
Definition: project.cpp:193

References libTableName().

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

◆ GetElem()

PROJECT::_ELEM * PROJECT::GetElem ( ELEM_T  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 283 of file project.cpp.

284{
285 // This is virtual, so implement it out of line
286 if( unsigned( aIndex ) < arrayDim( m_elems ) )
287 return m_elems[aIndex];
288
289 return nullptr;
290}

References arrayDim(), and m_elems.

Referenced by PcbFootprintLibs(), and LEGACY_RESCUER::WriteRescueLibrary().

◆ GetLocalSettings()

◆ GetProjectFile()

virtual PROJECT_FILE & PROJECT::GetProjectFile ( ) const
inlinevirtual

Definition at line 148 of file project.h.

149 {
150 wxASSERT( m_projectFile );
151 return *m_projectFile;
152 }

References m_projectFile.

Referenced by SYMBOL_TREE_MODEL_ADAPTER::AddLibraries(), FP_TREE_MODEL_ADAPTER::AddLibraries(), CONNECTION_GRAPH::buildConnectionGraph(), CVPCB_MAINFRAME::buildEquivalenceList(), CVPCB_MAINFRAME::BuildLibrariesListBox(), FOOTPRINT_EDIT_FRAME::buildSaveAsDialog(), SYMBOL_EDIT_FRAME::buildSaveAsDialog(), BOARD::ClearProject(), DIALOG_ASSIGN_NETCLASS::DIALOG_ASSIGN_NETCLASS(), DIALOG_BOARD_SETUP::DIALOG_BOARD_SETUP(), DIALOG_SCHEMATIC_SETUP::DIALOG_SCHEMATIC_SETUP(), SCH_EDIT_FRAME::doCloseWindow(), SCHEMATIC::ErcSettings(), SCH_ITEM::GetEffectiveNetClass(), PCB_EDIT_FRAME::GetLastPath(), SCH_EDIT_FRAME::GetSchematicJunctionSize(), GetSheetName(), GetTextVars(), DIALOG_CONFIG_EQUFILES::Init(), FIELDS_GRID_TABLE< T >::initGrid(), SYMBOL_LIBS::LibNamesAndPaths(), PCB_EDIT_FRAME::LoadProjectSettings(), SIM_PLOT_FRAME::LoadSettings(), DIALOG_SCHEMATIC_SETUP::onAuxiliaryAction(), DIALOG_BOARD_SETUP::onAuxiliaryAction(), DIALOG_CONFIG_EQUFILES::OnOkClick(), SCH_BASE_FRAME::PickSymbolFromLibTree(), SYMBOL_VIEWER_FRAME::ReCreateLibList(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), SCHEMATIC::Reset(), SCH_EDIT_FRAME::SaveProject(), KICAD_MANAGER_CONTROL::SaveProjectAs(), PCB_EDIT_FRAME::SaveProjectSettings(), ROUTER_TOOL::saveRouterDebugLog(), SIM_PLOT_FRAME::SaveSettings(), PCB_BASE_FRAME::SelectLibrary(), SCH_BASE_FRAME::SelectLibraryFromList(), PCB_EDIT_FRAME::SetLastPath(), SCHEMATIC::SetProject(), BOARD::SetProject(), SCHEMATIC::Settings(), FP_TREE_SYNCHRONIZING_ADAPTER::Sync(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::Sync(), DIALOG_ASSIGN_NETCLASS::TransferDataFromWindow(), and EDA_3D_VIEWER_FRAME::~EDA_3D_VIEWER_FRAME().

◆ GetProjectFullName()

const wxString PROJECT::GetProjectFullName ( ) const
virtual

◆ GetProjectName()

◆ 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 125 of file project.cpp.

126{
127 return m_project_name.GetPathWithSep();
128}

References m_project_name.

Referenced by PANEL_SYM_LIB_TABLE::browseLibrariesHandler(), PCB_BASE_EDIT_FRAME::createNewLibrary(), DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS(), KICAD_MANAGER_CONTROL::Execute(), FOOTPRINT_LIST::GetInstance(), SCH_ALTIUM_PLUGIN::getLibFileName(), SCH_EAGLE_PLUGIN::getLibFileName(), SETTINGS_MANAGER::GetPathForSettingsFile(), SETTINGS_MANAGER::GetProjectBackupsPath(), InvokePcbLibTableEditor(), InvokeSchEditSymbolLibTable(), EDA_DRAW_FRAME::LibraryFileBrowser(), SCH_ALTIUM_PLUGIN::Load(), CADSTAR_SCH_ARCHIVE_PLUGIN::Load(), SCH_EAGLE_PLUGIN::Load(), SCH_SEXPR_PLUGIN::Load(), SCH_LEGACY_PLUGIN::Load(), SCH_EDIT_FRAME::LoadProject(), CADSTAR_SCH_ARCHIVE_LOADER::loadSheetAndChildSheets(), CADSTAR_SCH_ARCHIVE_LOADER::loadSheets(), NormalizePath(), PANEL_FP_PROPERTIES_3D_MODEL::OnAdd3DModel(), WX_HTML_REPORT_PANEL::onBtnSaveToFile(), 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_EDITOR_CONTROL::Paste(), PathIsInsideProject(), SYMBOL_EDIT_FRAME::replaceLibTableEntry(), ResolveFile(), SETTINGS_MANAGER::SaveProject(), SIM_PLOT_FRAME::saveWorkbook(), FILENAME_RESOLVER::SetProject(), 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 264 of file project.cpp.

265{
266 unsigned ndx = unsigned( aIndex );
267
268 if( ndx < arrayDim( m_rstrings ) )
269 {
270 return m_rstrings[ndx];
271 }
272 else
273 {
274 static wxString no_cookie_for_you;
275
276 wxASSERT( 0 ); // bad index
277
278 return no_cookie_for_you;
279 }
280}
wxString m_rstrings[RSTRING_COUNT]
Definition: project.h:360

References arrayDim(), and 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 238 of file project.cpp.

239{
240 if( m_sheetNames.empty() )
241 {
242 for( const std::pair<KIID, wxString>& pair : GetProjectFile().GetSheets() )
243 m_sheetNames[pair.first] = pair.second;
244 }
245
246 if( m_sheetNames.count( aSheetID ) )
247 return m_sheetNames.at( aSheetID );
248 else
249 return aSheetID.AsString();
250}
wxString AsString() const
Definition: kiid.cpp:249
std::map< KIID, wxString > m_sheetNames
Definition: project.h:357
virtual PROJECT_FILE & GetProjectFile() const
Definition: project.h:148

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

◆ GetTextVars()

◆ 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 137 of file project.cpp.

138{
139 return m_project_name.GetName().IsEmpty();
140}

References m_project_name.

Referenced by AskSaveBoardFileName(), InvokePcbLibTableEditor(), InvokeSchEditSymbolLibTable(), IsReadOnly(), EDA_DRAW_FRAME::LibraryFileBrowser(), SYMBOL_LIBS::LoadAllLibraries(), PCB_EDIT_FRAME::SaveProjectSettings(), BOARD::SynchronizeProperties(), PANEL_SETUP_RULES::TransferDataFromWindow(), and PANEL_SETUP_RULES::TransferDataToWindow().

◆ IsReadOnly()

virtual bool PROJECT::IsReadOnly ( ) const
inlinevirtual

Definition at line 124 of file project.h.

124{ return m_readOnly || IsNullProject(); }
virtual bool IsNullProject() const
Check if this project is a null project (i.e.
Definition: project.cpp:137

References IsNullProject(), and m_readOnly.

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 193 of file project.cpp.

194{
195 wxFileName fn = GetProjectFullName();
196 wxString path = fn.GetPath();
197
198 // if there's no path to the project name, or the name as a whole is bogus or its not
199 // write-able then use a template file.
200 if( !fn.GetDirCount() || !fn.IsOk() || !wxFileName::IsDirWritable( path ) )
201 {
202 // return a template filename now.
203
204 // this next line is likely a problem now, since it relies on an
205 // application title which is no longer constant or known. This next line needs
206 // to be re-thought out.
207
208#ifndef __WXMAC__
209 fn.AssignDir( wxStandardPaths::Get().GetUserConfigDir() );
210#else
211 // don't pollute home folder, temp folder seems to be more appropriate
212 fn.AssignDir( wxStandardPaths::Get().GetTempDir() );
213#endif
214
215#if defined( __WINDOWS__ )
216 fn.AppendDir( wxT( "kicad" ) );
217#endif
218
219 /*
220 * The library table name used when no project file is passed to the appropriate
221 * code. This is used temporarily to store the project specific library table
222 * until the project file being edited is saved. It is then moved to the correct
223 * file in the folder where the project file is saved.
224 */
225 fn.SetName( "prj-" + aLibTableName );
226 }
227 else // normal path.
228 {
229 fn.SetName( aLibTableName );
230 }
231
232 fn.ClearExt();
233
234 return fn.GetFullPath();
235}

References GetProjectFullName(), and path.

Referenced by 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 318 of file project.cpp.

319{
320 // This is a lazy loading function, it loads the project specific table when
321 // that table is asked for, not before.
322
324
325 if( tbl )
326 {
327 wxASSERT( tbl->Type() == FP_LIB_TABLE_T );
328 }
329 else
330 {
331 try
332 {
333 // Build a new project specific FP_LIB_TABLE with the global table as a fallback.
334 // ~FP_LIB_TABLE() will not touch the fallback table, so multiple projects may
335 // stack this way, all using the same global fallback table.
336 KIFACE* kiface = aKiway.KiFACE( KIWAY::FACE_PCB );
337
338 tbl = (FP_LIB_TABLE*) kiface->IfaceOrAddress( KIFACE_NEW_FOOTPRINT_TABLE );
339 tbl->Load( FootprintLibTblName() );
340
341 SetElem( ELEM_FPTBL, tbl );
342 }
343 catch( const IO_ERROR& ioe )
344 {
345 DisplayErrorMessage( nullptr, _( "Error loading project footprint library table." ),
346 ioe.What() );
347 }
348 catch( ... )
349 {
350 DisplayErrorMessage( nullptr, _( "Error loading project footprint library table." ) );
351 }
352 }
353
354 return tbl;
355}
KICAD_T Type() override
Definition: fp_lib_table.h:99
Hold an error message and may be used when throwing exceptions containing meaningful error messages.
Definition: ki_exception.h:76
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:30
virtual KIFACE * KiFACE(FACE_T aFaceId, bool doLoad=true)
Return the KIFACE* given a FACE_T.
Definition: kiway.cpp:198
@ FACE_PCB
pcbnew DSO
Definition: kiway.h:275
void Load(const wxString &aFileName)
Load the library table using the path defined by aFileName aFallBackTable.
virtual const wxString FootprintLibTblName() const
Returns the path and filename of this project's footprint library table.
Definition: project.cpp:149
virtual _ELEM * GetElem(ELEM_T aIndex)
Get and set the elements for this project.
Definition: project.cpp:283
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
Definition: confirm.cpp:299
return & kiface
Definition: cvpcb.cpp:112
#define _(s)
@ KIFACE_NEW_FOOTPRINT_TABLE
Return a new FP_LIB_TABLE with the global table installed as a fallback.
Definition: kiface_ids.h:46
Implement a participant in the KIWAY alchemy.
Definition: kiway.h:150
@ FP_LIB_TABLE_T
Definition: typeinfo.h:235

References _, DisplayErrorMessage(), ELEM_FPTBL, KIWAY::FACE_PCB, FootprintLibTblName(), FP_LIB_TABLE_T, GetElem(), kiface, KIWAY::KiFACE(), KIFACE_NEW_FOOTPRINT_TABLE, LIB_TABLE::Load(), SetElem(), FP_LIB_TABLE::Type(), and IO_ERROR::What().

Referenced by PCB_BASE_EDIT_FRAME::AddLibrary(), CVPCB_MAINFRAME::BuildLibrariesListBox(), FOOTPRINT_EDIT_FRAME::buildSaveAsDialog(), FOOTPRINT_EDIT_FRAME::DeleteFootprintFromLibrary(), FOOTPRINT_PREVIEW_PANEL::DisplayFootprint(), CVPCB_MAINFRAME::DisplayStatus(), FOOTPRINT_EDIT_FRAME::DuplicateFootprint(), PCB_EDIT_FRAME::ExportFootprintsToLibrary(), EXPORTER_PCB_VRML::ExportVrmlFootprint(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), idf_export_footprint(), FOOTPRINT_EDIT_FRAME::initLibraryTree(), InvokePcbLibTableEditor(), FOOTPRINT_EDIT_FRAME::KiwayMailIn(), FOOTPRINT_SELECT_WIDGET::Load(), RENDER_3D_RAYTRACE::load3DModels(), RENDER_3D_OPENGL::load3dModels(), PCB_BASE_FRAME::loadFootprint(), CVPCB_MAINFRAME::LoadFootprintFiles(), FOOTPRINT_VIEWER_FRAME::OnActivate(), PCB_EDIT_FRAME::OpenProjectFiles(), FOOTPRINT_EDITOR_CONTROL::PasteFootprint(), CVPCB_MAINFRAME::readNetListAndFpFiles(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), FOOTPRINT_EDITOR_CONTROL::RenameFootprint(), FOOTPRINT_EDITOR_CONTROL::SaveAs(), FOOTPRINT_EDIT_FRAME::SaveFootprint(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), FOOTPRINT_EDIT_FRAME::SaveFootprintInLibrary(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), PCB_BASE_FRAME::SelectFootprintFromLibTree(), PCB_BASE_FRAME::SelectLibrary(), PCB_BASE_EDIT_FRAME::selectLibTable(), FOOTPRINT_VIEWER_FRAME::ShowModal(), FOOTPRINT_EDIT_FRAME::SyncLibraryTree(), FOOTPRINT_EDIT_FRAME::UpdateTitle(), FOOTPRINT_VIEWER_FRAME::UpdateTitle(), and PANEL_FP_PROPERTIES_3D_MODEL::validateModelExists().

◆ PinLibrary()

void PROJECT::PinLibrary ( const wxString &  aLibrary,
bool  isSymbolLibrary 
)

Definition at line 155 of file project.cpp.

156{
157 COMMON_SETTINGS* cfg = Pgm().GetCommonSettings();
158 std::vector<wxString>& pinnedLibs = isSymbolLibrary ? m_projectFile->m_PinnedSymbolLibs
160
161 if( !alg::contains( pinnedLibs, aLibrary ) )
162 pinnedLibs.push_back( aLibrary );
163
164 Pgm().GetSettingsManager().SaveProject();
165
166 pinnedLibs = isSymbolLibrary ? cfg->m_Session.pinned_symbol_libs
168
169 if( !alg::contains( pinnedLibs, aLibrary ) )
170 pinnedLibs.push_back( aLibrary );
171
172 cfg->SaveToFile( Pgm().GetSettingsManager().GetPathForSettingsFile( cfg ) );
173}
virtual bool SaveToFile(const wxString &aDirectory="", bool aForce=false)
std::vector< wxString > m_PinnedFootprintLibs
The list of pinned footprint libraries.
Definition: project_file.h:118
std::vector< wxString > m_PinnedSymbolLibs
Below are project-level settings that have not been moved to a dedicated file.
Definition: project_file.h:115
bool contains(const _Container &__container, _Value __value)
Returns true if the container contains the given value.
Definition: kicad_algo.h:99
SETTINGS_MANAGER * GetSettingsManager()
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:111
std::vector< wxString > pinned_fp_libs
std::vector< wxString > pinned_symbol_libs

References alg::contains(), GetSettingsManager(), PROJECT_FILE::m_PinnedFootprintLibs, PROJECT_FILE::m_PinnedSymbolLibs, m_projectFile, COMMON_SETTINGS::m_Session, Pgm(), COMMON_SETTINGS::SESSION::pinned_fp_libs, COMMON_SETTINGS::SESSION::pinned_symbol_libs, and JSON_SETTINGS::SaveToFile().

Referenced by SYMBOL_EDITOR_CONTROL::PinLibrary(), FOOTPRINT_EDITOR_CONTROL::PinLibrary(), and LIB_TREE_MODEL_ADAPTER::PinLibrary().

◆ SetElem()

void PROJECT::SetElem ( ELEM_T  aIndex,
_ELEM aElem 
)
virtual

◆ 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
aSettingsis the local settings object (may or may not exist on disk at this point)

Definition at line 335 of file project.h.

336 {
337 m_localSettings = aSettings;
338 }

References m_localSettings.

◆ 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
aFileis a loaded PROJECT_FILE.

Definition at line 323 of file project.h.

324 {
325 m_projectFile = aFile;
326 }

References m_projectFile.

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 87 of file project.cpp.

88{
89 // Compare paths, rather than inodes, to be less surprising to the user.
90 // Create a temporary wxFileName to normalize the path
91 wxFileName candidate_path( aFullPathAndName );
92
93 // Edge transitions only. This is what clears the project
94 // data using the Clear() function.
95 if( m_project_name.GetFullPath() != candidate_path.GetFullPath() )
96 {
97 Clear(); // clear the data when the project changes.
98
99 wxLogTrace( tracePathsAndFiles, "%s: old:'%s' new:'%s'", __func__,
100 TO_UTF8( GetProjectFullName() ), TO_UTF8( aFullPathAndName ) );
101
102 m_project_name = aFullPathAndName;
103
104 wxASSERT( m_project_name.IsAbsolute() );
105
106 wxASSERT( m_project_name.GetExt() == ProjectFileExtension );
107
108 // until multiple projects are in play, set an environment variable for the
109 // the project pointer.
110 {
111 wxString path = m_project_name.GetPath();
112
113 wxSetEnv( PROJECT_VAR_NAME, path );
114 }
115 }
116}
void Clear()
Clear the _ELEMs and RSTRINGs.
Definition: project.h:238
const std::string ProjectFileExtension
const wxChar *const tracePathsAndFiles
Flag to enable path and file name debug output.
#define TO_UTF8(wxstring)
Convert a wxString to a UTF8 encoded C string for all wxWidgets build modes.
Definition: macros.h:96
#define PROJECT_VAR_NAME
A variable name whose value holds the current project directory.
Definition: project.h:38

References Clear(), GetProjectFullName(), m_project_name, path, PROJECT_VAR_NAME, ProjectFileExtension, TO_UTF8, and tracePathsAndFiles.

Referenced by SETTINGS_MANAGER::SaveProjectAs().

◆ SetReadOnly()

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

◆ 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 253 of file project.cpp.

254{
255 unsigned ndx = unsigned( aIndex );
256
257 if( ndx < arrayDim( m_rstrings ) )
258 m_rstrings[ndx] = aString;
259 else
260 wxASSERT( 0 ); // bad index
261}

References arrayDim(), and m_rstrings.

Referenced by Clear(), 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 143 of file project.cpp.

144{
145 return libTableName( "sym-lib-table" );
146}

References libTableName().

◆ TextVarResolver()

bool PROJECT::TextVarResolver ( wxString *  aToken) const
virtual

Definition at line 69 of file project.cpp.

70{
71 if( GetTextVars().count( *aToken ) > 0 )
72 {
73 *aToken = GetTextVars().at( *aToken );
74 return true;
75 }
76
77 return false;
78}
virtual std::map< wxString, wxString > & GetTextVars() const
Definition: project.cpp:81

References GetTextVars().

Referenced by ExpandTextVars(), and KIwxExpandEnvVars().

◆ UnpinLibrary()

void PROJECT::UnpinLibrary ( const wxString &  aLibrary,
bool  isSymbolLibrary 
)

Definition at line 176 of file project.cpp.

177{
178 COMMON_SETTINGS* cfg = Pgm().GetCommonSettings();
179 std::vector<wxString>& pinnedLibs = isSymbolLibrary ? m_projectFile->m_PinnedSymbolLibs
181
182 alg::delete_matching( pinnedLibs, aLibrary );
183 Pgm().GetSettingsManager().SaveProject();
184
185 pinnedLibs = isSymbolLibrary ? cfg->m_Session.pinned_symbol_libs
187
188 alg::delete_matching( pinnedLibs, aLibrary );
189 cfg->SaveToFile( Pgm().GetSettingsManager().GetPathForSettingsFile( cfg ) );
190}
void delete_matching(_Container &__c, _Value __value)
Covers for the horrifically named std::remove and std::remove_if (neither of which remove anything).
Definition: kicad_algo.h:164

References alg::delete_matching(), GetSettingsManager(), PROJECT_FILE::m_PinnedFootprintLibs, PROJECT_FILE::m_PinnedSymbolLibs, m_projectFile, COMMON_SETTINGS::m_Session, Pgm(), COMMON_SETTINGS::SESSION::pinned_fp_libs, COMMON_SETTINGS::SESSION::pinned_symbol_libs, and JSON_SETTINGS::SaveToFile().

Referenced by SYMBOL_EDITOR_CONTROL::UnpinLibrary(), FOOTPRINT_EDITOR_CONTROL::UnpinLibrary(), and LIB_TREE_MODEL_ADAPTER::UnpinLibrary().

Friends And Related Function Documentation

◆ SETTINGS_MANAGER

friend class SETTINGS_MANAGER
friend

Definition at line 304 of file project.h.

◆ TEST_NETLISTS_FIXTURE

friend class TEST_NETLISTS_FIXTURE
friend

Definition at line 305 of file project.h.

Member Data Documentation

◆ m_elems

_ELEM* PROJECT::m_elems[ELEM_COUNT]
private
See also
this::Elem() and enum ELEM_T.

Definition at line 363 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 355 of file project.h.

Referenced by GetLocalSettings(), and setLocalSettings().

◆ m_pro_date_and_time

wxString PROJECT::m_pro_date_and_time
private

True if the project is read-only: no project files will be written.

Definition at line 346 of file project.h.

◆ m_project_name

wxFileName PROJECT::m_project_name
private

<fullpath>/<basename>.pro

Definition at line 345 of file project.h.

Referenced by 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 352 of file project.h.

Referenced by GetProjectFile(), PinLibrary(), setProjectFile(), and UnpinLibrary().

◆ m_readOnly

bool PROJECT::m_readOnly
private

Definition at line 349 of file project.h.

Referenced by IsReadOnly(), and SetReadOnly().

◆ m_rstrings

wxString PROJECT::m_rstrings[RSTRING_COUNT]
private
See also
this::SetRString(), GetRString(), and enum RSTRING_T.

Definition at line 360 of file project.h.

Referenced by GetRString(), and SetRString().

◆ m_sheetNames

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

Definition at line 357 of file project.h.

Referenced by GetSheetName().


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