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_PART, 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_PART_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...
 
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
 
bool m_readOnly
 

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

More...
 
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 subsidiarly 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_PART_LIBS 
ELEM_SCH_SEARCH_STACK 
ELEM_3DCACHE 
ELEM_SYMBOL_LIB_TABLE 
ELEM_COUNT 

Definition at line 200 of file project.h.

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

Constructor & Destructor Documentation

◆ PROJECT()

PROJECT::PROJECT ( )

Definition at line 40 of file common/project.cpp.

40  :
41  m_readOnly( false ),
42  m_projectFile( nullptr ),
43  m_localSettings( nullptr )
44 {
45  memset( m_elems, 0, sizeof(m_elems) );
46 }
_ELEM * m_elems[ELEM_COUNT]
Definition: project.h:360
bool m_readOnly
True if the project is read-only: no project files will be written
Definition: project.h:346
PROJECT_FILE * m_projectFile
Backing store for project data – owned by SETTINGS_MANAGER.
Definition: project.h:349
PROJECT_LOCAL_SETTINGS * m_localSettings
Backing store for project local settings – owned by SETTINGS_MANAGER.
Definition: project.h:352

References m_elems.

◆ ~PROJECT()

PROJECT::~PROJECT ( )
virtual

Definition at line 60 of file common/project.cpp.

61 {
62  ElemsClear();
63 }
virtual void ElemsClear()
Delete all the _ELEMs and set their pointers to NULL.

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 270 of file common/project.cpp.

271 {
272  wxFileName fn = aFileName;
273 
274  if( !fn.IsAbsolute() )
275  {
276  wxString pro_dir = wxPathOnly( GetProjectFullName() );
277  fn.Normalize( wxPATH_NORM_ALL, pro_dir );
278  }
279 
280  return fn.GetFullPath();
281 }
virtual const wxString GetProjectFullName() const
Return the full path and name of the project.

References GetProjectFullName().

Referenced by DIALOG_PLOT_SCHEMATIC::createPlotFileName(), PCB_EDIT_FRAME::doAutoSave(), SCH_EDIT_FRAME::doCloseWindow(), PCB_EDIT_FRAME::Files_io_from_id(), PCB_BASE_EDIT_FRAME::GetDesignRulesPath(), DIALOG_GENDRILL::OnGenReportFile(), SCH_EDIT_FRAME::OnOpenCvpcb(), SCH_EDIT_FRAME::OnOpenPcbnew(), DIALOG_EXPORT_SVG::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT::OnOutputDirectoryBrowseClicked(), DIALOG_GEN_FOOTPRINT_POSITION::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT_SCHEMATIC::OnOutputDirectoryBrowseClicked(), DIALOG_GENDRILL::OnOutputDirectoryBrowseClicked(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_EDITOR_CONTROL::Print(), SCH_EDIT_FRAME::PrintPage(), SCH_EDIT_FRAME::SaveEEFile(), SCH_EDIT_FRAME::SaveProject(), and WriteDRCReport().

◆ Clear()

void PROJECT::Clear ( )
inline

Clear the _ELEMs and RSTRINGs.

Definition at line 235 of file project.h.

236  {
237  ElemsClear();
238 
239  for( unsigned i = 0; i<RSTRING_COUNT; ++i )
240  SetRString( RSTRING_T( i ), wxEmptyString );
241  }
virtual void ElemsClear()
Delete all the _ELEMs and set their pointers to NULL.
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...
RSTRING_T
Retain a number of project specific wxStrings, enumerated here:
Definition: project.h:158

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 49 of file common/project.cpp.

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

References arrayDim(), m_elems, NULL, 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 146 of file common/project.cpp.

147 {
148  return libTableName( "fp-lib-table" );
149 }
const wxString libTableName(const wxString &aLibTableName) const
Return the full path and file name of the project specific library table aLibTableName.

References libTableName().

Referenced by PCB_EDIT_FRAME::importFile(), InvokePcbLibTableEditor(), 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 246 of file common/project.cpp.

247 {
248  // This is virtual, so implement it out of line
249 
250  if( unsigned( aIndex ) < arrayDim( m_elems ) )
251  {
252  return m_elems[aIndex];
253  }
254  return NULL;
255 }
_ELEM * m_elems[ELEM_COUNT]
Definition: project.h:360
#define NULL
constexpr std::size_t arrayDim(T const (&)[N]) noexcept
Returns # of elements in an array.
Definition: arraydim.h:31

References arrayDim(), m_elems, and NULL.

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

◆ GetLocalSettings()

◆ GetProjectFile()

◆ GetProjectFullName()

const wxString PROJECT::GetProjectFullName ( ) const
virtual

◆ GetProjectName()

const wxString PROJECT::GetProjectName ( ) const
virtual

◆ 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 122 of file common/project.cpp.

123 {
124  return m_project_name.GetPathWithSep();
125 }
wxFileName m_project_name
<fullpath>/<basename>.pro
Definition: project.h:342

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(), PCB_EDIT_FRAME::ExportVRML_File(), FOOTPRINT_LIST::GetInstance(), SCH_ALTIUM_PLUGIN::getLibFileName(), SETTINGS_MANAGER::GetPathForSettingsFile(), SETTINGS_MANAGER::GetProjectBackupsPath(), PCB_EDIT_FRAME::importFile(), InvokePcbLibTableEditor(), InvokeSchEditSymbolLibTable(), EDA_DRAW_FRAME::LibraryFileBrowser(), CADSTAR_SCH_ARCHIVE_PLUGIN::Load(), SCH_ALTIUM_PLUGIN::Load(), SCH_SEXPR_PLUGIN::Load(), SCH_LEGACY_PLUGIN::Load(), KICAD_MANAGER_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadSheetFromFile(), NormalizePath(), DIALOG_FOOTPRINT_FP_EDITOR::OnAdd3DModel(), DIALOG_FOOTPRINT_PROPERTIES::OnAdd3DModel(), KICAD_MANAGER_FRAME::OnOpenFileInTextEditor(), DIALOG_ERC::OnSaveReport(), DIALOG_DRC::OnSaveReport(), DIALOG_SPICE_MODEL::onSelectLibrary(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), PANEL_SYM_LIB_TABLE::PANEL_SYM_LIB_TABLE(), SCH_EDITOR_CONTROL::Paste(), PathIsInsideProject(), SYMBOL_EDIT_FRAME::replaceLibTableEntry(), ResolveFile(), FILENAME_RESOLVER::SetProject(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), 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 227 of file common/project.cpp.

228 {
229  unsigned ndx = unsigned( aIndex );
230 
231  if( ndx < arrayDim( m_rstrings ) )
232  {
233  return m_rstrings[ndx];
234  }
235  else
236  {
237  static wxString no_cookie_for_you;
238 
239  wxASSERT( 0 ); // bad index
240 
241  return no_cookie_for_you;
242  }
243 }
constexpr std::size_t arrayDim(T const (&)[N]) noexcept
Returns # of elements in an array.
Definition: arraydim.h:31
wxString m_rstrings[RSTRING_COUNT]
Definition: project.h:357

References arrayDim(), and m_rstrings.

Referenced by PCB_EDIT_FRAME::ExportFootprintsToLibrary(), FOOTPRINT_VIEWER_FRAME::getCurFootprintName(), SYMBOL_EDIT_FRAME::GetCurLib(), FOOTPRINT_VIEWER_FRAME::getCurNickname(), DIALOG_FOOTPRINT_FP_EDITOR::OnAdd3DModel(), DIALOG_FOOTPRINT_PROPERTIES::OnAdd3DModel(), FOOTPRINT_EDIT_FRAME::restoreLastFootprint(), SYMBOL_EDIT_FRAME::saveLibrary(), and SYMBOL_EDIT_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 197 of file common/project.cpp.

198 {
199  if( m_sheetNames.empty() )
200  {
201  for( auto pair : GetProjectFile().GetSheets() )
202  m_sheetNames[pair.first] = pair.second;
203  }
204 
205  if( m_sheetNames.count( aSheetID ) )
206  return m_sheetNames.at( aSheetID );
207  else
208  return aSheetID.AsString();
209 }
virtual PROJECT_FILE & GetProjectFile() const
Definition: project.h:145
wxString AsString() const
Definition: kiid.cpp:213
std::vector< FILE_INFO_PAIR > & GetSheets()
Definition: project_file.h:82
std::map< KIID, wxString > m_sheetNames
Definition: project.h:354

References KIID::AsString(), GetProjectFile(), PROJECT_FILE::GetSheets(), 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 134 of file common/project.cpp.

135 {
136  return m_project_name.GetName().IsEmpty();
137 }
wxFileName m_project_name
<fullpath>/<basename>.pro
Definition: project.h:342

References m_project_name.

Referenced by PCB_BASE_EDIT_FRAME::AddLibrary(), AskSaveBoardFileName(), InvokePcbLibTableEditor(), InvokeSchEditSymbolLibTable(), IsReadOnly(), EDA_DRAW_FRAME::LibraryFileBrowser(), SCH_EDIT_FRAME::OnImportProject(), SCH_EDIT_FRAME::SaveProject(), 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(); }
bool m_readOnly
True if the project is read-only: no project files will be written
Definition: project.h:346
virtual bool IsNullProject() const
Check if this project is a null project (i.e.

References IsNullProject(), and m_readOnly.

◆ 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 152 of file common/project.cpp.

153 {
154  wxFileName fn = GetProjectFullName();
155  wxString path = fn.GetPath();
156 
157  // if there's no path to the project name, or the name as a whole is bogus or its not
158  // write-able then use a template file.
159  if( !fn.GetDirCount() || !fn.IsOk() || !wxFileName::IsDirWritable( path ) )
160  {
161  // return a template filename now.
162 
163  // this next line is likely a problem now, since it relies on an
164  // application title which is no longer constant or known. This next line needs
165  // to be re-thought out.
166 
167 #ifndef __WXMAC__
168  fn.AssignDir( wxStandardPaths::Get().GetUserConfigDir() );
169 #else
170  // don't pollute home folder, temp folder seems to be more appropriate
171  fn.AssignDir( wxStandardPaths::Get().GetTempDir() );
172 #endif
173 
174 #if defined( __WINDOWS__ )
175  fn.AppendDir( wxT( "kicad" ) );
176 #endif
177 
178  /*
179  * The library table name used when no project file is passed to the appropriate
180  * code. This is used temporarily to store the project specific library table
181  * until the project file being edited is saved. It is then moved to the correct
182  * file in the folder where the project file is saved.
183  */
184  fn.SetName( "prj-" + aLibTableName );
185  }
186  else // normal path.
187  {
188  fn.SetName( aLibTableName );
189  }
190 
191  fn.ClearExt();
192 
193  return fn.GetFullPath();
194 }
virtual const wxString GetProjectFullName() const
Return the full path and name of the project.

References GetProjectFullName().

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 284 of file common/project.cpp.

285 {
286  // This is a lazy loading function, it loads the project specific table when
287  // that table is asked for, not before.
288 
290 
291  if( tbl )
292  {
293  wxASSERT( tbl->Type() == FP_LIB_TABLE_T );
294  }
295  else
296  {
297  try
298  {
299  // Build a new project specific FP_LIB_TABLE with the global table as a fallback.
300  // ~FP_LIB_TABLE() will not touch the fallback table, so multiple projects may
301  // stack this way, all using the same global fallback table.
302  KIFACE* kiface = aKiway.KiFACE( KIWAY::FACE_PCB );
303 
304  tbl = (FP_LIB_TABLE*) kiface->IfaceOrAddress( KIFACE_NEW_FOOTPRINT_TABLE );
305  tbl->Load( FootprintLibTblName() );
306 
307  SetElem( ELEM_FPTBL, tbl );
308  }
309  catch( const IO_ERROR& ioe )
310  {
311  DisplayErrorMessage( NULL, _( "Error loading project footprint library table" ),
312  ioe.What() );
313  }
314  catch( ... )
315  {
316  DisplayErrorMessage( NULL, _( "Error loading project footprint library table" ) );
317  }
318  }
319 
320  return tbl;
321 }
BITMAP2CMP_SETTINGS kiface
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
Definition: confirm.cpp:266
virtual _ELEM * GetElem(ELEM_T aIndex)
Get and set the elements for this project.
virtual void SetElem(ELEM_T aIndex, _ELEM *aElem)
#define NULL
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:29
pcbnew DSO
Definition: kiway.h:269
Return a new FP_LIB_TABLE with the global table installed as a fallback.
Definition: kiface_ids.h:46
virtual KIFACE * KiFACE(FACE_T aFaceId, bool doLoad=true)
Return the KIFACE* given a FACE_T.
Definition: kiway.cpp:180
void Load(const wxString &aFileName)
Load the library table using the path defined by aFileName aFallBackTable.
KICAD_T Type() override
Definition: fp_lib_table.h:99
#define _(s)
Definition: 3d_actions.cpp:33
Implement a participant in the KIWAY alchemy.
Definition: kiway.h:147
Hold an error message and may be used when throwing exceptions containing meaningful error messages.
Definition: ki_exception.h:75
virtual const wxString FootprintLibTblName() const
Returns the path and filename of this project's footprint library table.

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

Referenced by PCB_BASE_EDIT_FRAME::AddLibrary(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), FOOTPRINT_EDIT_FRAME::DeleteFootprintFromLibrary(), FOOTPRINT_PREVIEW_PANEL::DisplayFootprint(), CVPCB_MAINFRAME::DisplayStatus(), PCB_EDIT_FRAME::ExportFootprintsToLibrary(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), GetFootprintLibraryTable(), PCB_EDIT_FRAME::importFile(), FOOTPRINT_EDIT_FRAME::initLibraryTree(), InvokePcbLibTableEditor(), FOOTPRINT_EDIT_FRAME::KiwayMailIn(), PCB_BASE_FRAME::loadFootprint(), CVPCB_MAINFRAME::LoadFootprintFiles(), PCB_EDIT_FRAME::LoadFootprints(), FOOTPRINT_VIEWER_FRAME::OnActivate(), FOOTPRINT_EDITOR_CONTROL::PasteFootprint(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), 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(), FOOTPRINT_VIEWER_FRAME::ShowModal(), FOOTPRINT_EDIT_FRAME::SyncLibraryTree(), FOOTPRINT_VIEWER_FRAME::UpdateTitle(), and FOOTPRINT_EDIT_FRAME::updateTitle().

◆ SetElem()

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

Definition at line 258 of file common/project.cpp.

259 {
260  // This is virtual, so implement it out of line
261 
262  if( unsigned( aIndex ) < arrayDim( m_elems ) )
263  {
264  delete m_elems[aIndex];
265  m_elems[aIndex] = aElem;
266  }
267 }
_ELEM * m_elems[ELEM_COUNT]
Definition: project.h:360
constexpr std::size_t arrayDim(T const (&)[N]) noexcept
Returns # of elements in an array.
Definition: arraydim.h:31

References arrayDim(), and m_elems.

Referenced by ElemsClear(), CADSTAR_SCH_ARCHIVE_PLUGIN::Load(), SCH_ALTIUM_PLUGIN::Load(), TEST_NETLISTS_FIXTURE::loadSchematic(), TEST_SCH_SHEET_LIST_FIXTURE::loadSchematic(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), SCH_EDIT_FRAME::OpenProjectFiles(), PcbFootprintLibs(), 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
aSettingsis the local settings object (may or may not exist on disk at this point)

Definition at line 332 of file project.h.

333  {
334  m_localSettings = aSettings;
335  }
PROJECT_LOCAL_SETTINGS * m_localSettings
Backing store for project local settings – owned by SETTINGS_MANAGER.
Definition: project.h:352

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

321  {
322  m_projectFile = aFile;
323  }
PROJECT_FILE * m_projectFile
Backing store for project data – owned by SETTINGS_MANAGER.
Definition: project.h:349

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 84 of file common/project.cpp.

85 {
86  // Compare paths, rather than inodes, to be less surprising to the user.
87  // Create a temporary wxFileName to normalize the path
88  wxFileName candidate_path( aFullPathAndName );
89 
90  // Edge transitions only. This is what clears the project
91  // data using the Clear() function.
92  if( m_project_name.GetFullPath() != candidate_path.GetFullPath() )
93  {
94  Clear(); // clear the data when the project changes.
95 
96  wxLogTrace( tracePathsAndFiles, "%s: old:'%s' new:'%s'", __func__,
97  TO_UTF8( GetProjectFullName() ), TO_UTF8( aFullPathAndName ) );
98 
99  m_project_name = aFullPathAndName;
100 
101  wxASSERT( m_project_name.IsAbsolute() );
102 
103  wxASSERT( m_project_name.GetExt() == ProjectFileExtension );
104 
105  // until multiple projects are in play, set an environment variable for the
106  // the project pointer.
107  {
108  wxString path = m_project_name.GetPath();
109 
110  wxSetEnv( PROJECT_VAR_NAME, path );
111  }
112  }
113 }
void Clear()
Clear the _ELEMs and RSTRINGs.
Definition: project.h:235
const std::string ProjectFileExtension
#define PROJECT_VAR_NAME
A variable name whose value holds the current project directory.
Definition: project.h:38
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
wxFileName m_project_name
<fullpath>/<basename>.pro
Definition: project.h:342
virtual const wxString GetProjectFullName() const
Return the full path and name of the project.

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

Referenced by SETTINGS_MANAGER::SaveProjectAs().

◆ SetReadOnly()

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

Definition at line 126 of file project.h.

126 { m_readOnly = aReadOnly; }
bool m_readOnly
True if the project is read-only: no project files will be written
Definition: project.h:346

References m_readOnly.

Referenced by SCH_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), and SCH_EDIT_FRAME::Save_File().

◆ 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 212 of file common/project.cpp.

213 {
214  unsigned ndx = unsigned( aIndex );
215 
216  if( ndx < arrayDim( m_rstrings ) )
217  {
218  m_rstrings[ndx] = aString;
219  }
220  else
221  {
222  wxASSERT( 0 ); // bad index
223  }
224 }
constexpr std::size_t arrayDim(T const (&)[N]) noexcept
Returns # of elements in an array.
Definition: arraydim.h:31
wxString m_rstrings[RSTRING_COUNT]
Definition: project.h:357

References arrayDim(), and m_rstrings.

Referenced by Clear(), PCB_EDIT_FRAME::ExportFootprintsToLibrary(), SYMBOL_EDIT_FRAME::GetCurLib(), DIALOG_FOOTPRINT_FP_EDITOR::OnAdd3DModel(), DIALOG_FOOTPRINT_PROPERTIES::OnAdd3DModel(), FOOTPRINT_EDIT_FRAME::retainLastFootprint(), SYMBOL_EDIT_FRAME::saveLibrary(), SYMBOL_EDIT_FRAME::SelectLibraryFromList(), FOOTPRINT_VIEWER_FRAME::setCurFootprintName(), SYMBOL_EDIT_FRAME::SetCurLib(), FOOTPRINT_VIEWER_FRAME::setCurNickname(), and SYMBOL_EDIT_FRAME::SetCurPart().

◆ SymbolLibTableName()

const wxString PROJECT::SymbolLibTableName ( ) const
virtual

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

Definition at line 140 of file common/project.cpp.

141 {
142  return libTableName( "sym-lib-table" );
143 }
const wxString libTableName(const wxString &aLibTableName) const
Return the full path and file name of the project specific library table aLibTableName.

References libTableName().

◆ TextVarResolver()

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

Definition at line 66 of file common/project.cpp.

67 {
68  if( GetTextVars().count( *aToken ) > 0 )
69  {
70  *aToken = GetTextVars().at( *aToken );
71  return true;
72  }
73 
74  return false;
75 }
virtual std::map< wxString, wxString > & GetTextVars() const

References GetTextVars().

Referenced by ExpandTextVars(), and KIwxExpandEnvVars().

Friends And Related Function Documentation

◆ SETTINGS_MANAGER

friend class SETTINGS_MANAGER
friend

Definition at line 301 of file project.h.

◆ TEST_NETLISTS_FIXTURE

friend class TEST_NETLISTS_FIXTURE
friend

Definition at line 302 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 360 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 352 of file project.h.

Referenced by GetLocalSettings(), and setLocalSettings().

◆ m_pro_date_and_time

wxString PROJECT::m_pro_date_and_time
private

Definition at line 343 of file project.h.

◆ m_project_name

wxFileName PROJECT::m_project_name
private

<fullpath>/<basename>.pro

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

Referenced by GetProjectFile(), and setProjectFile().

◆ m_readOnly

bool PROJECT::m_readOnly
private

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

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

Referenced by GetRString(), and SetRString().

◆ m_sheetNames

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

Definition at line 354 of file project.h.

Referenced by GetSheetName().


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