31 #include <wx/string.h> 32 #include <wx/filename.h> 36 #define PROJECT_VAR_NAME wxT( "KIPRJMOD" ) 48 #define VTBL_ENTRY virtual 136 const PARAM_CFG_ARRAY& aParams,
const wxString& aFileName = wxEmptyString );
157 const PARAM_CFG_ARRAY& aParams,
const wxString& aForeignConfigFileName = wxEmptyString );
270 #if defined(PCBNEW) || defined(CVPCB) 284 S3D_CACHE* Get3DCacheManager(
bool updateProjDir =
false );
288 #if defined(EESCHEMA) 312 const wxString& aGroupName,
const wxString& aProjectFileName = wxEmptyString );
317 const wxString
libTableName(
const wxString& aLibTableName )
const;
344 VTBL_ENTRY bool Value(
const wxString& aVariable, wxString* aFetchedValue = NULL );
352 VTBL_ENTRY const wxString Substitute(
const wxString& aString );
361 VTBL_ENTRY const wxString SubstituteAndEvaluate(
const wxString& aString );
wxConfigBase * configCreate(const SEARCH_STACK &aSList, const wxString &aGroupName, const wxString &aProjectFileName=wxEmptyString)
Function configCreate loads a *.pro file and returns a wxConfigBase.
_ELEM * m_elems[ELEM_COUNT]
A list of parameters type.
void Clear()
Function Clear clears the _ELEMs and RSTRINGs.
VTBL_ENTRY void ConfigSave(const SEARCH_STACK &aSList, const wxString &aGroupName, const PARAM_CFG_ARRAY &aParams, const wxString &aFileName=wxEmptyString)
Function ConfigSave saves the current "project" parameters into the wxConfigBase* derivative...
Class PROJECT holds project specific data.
VTBL_ENTRY const wxString GetProjectFullName() const
Function GetProjectFullName returns the full path and name of the project.
Class SEARCH_STACK looks for files in a number of places.
VTBL_ENTRY _ELEM * GetElem(ELEM_T aIndex)
Typically wrapped somewhere else in a more meaningful function wrapper.
VTBL_ENTRY void SetElem(ELEM_T aIndex, _ELEM *aElem)
VTBL_ENTRY const wxString SymbolLibTableName() const
Return the path and file name of this projects symbol library table.
wxFileName m_project_name
<fullpath>/<basename>.pro
VTBL_ENTRY const wxString AbsolutePath(const wxString &aFileName) const
Function AbsolutePath fixes up aFileName if it is relative to the project's directory to be an absolu...
Class KIWAY is a minimalistic software bus for communications between various DLLs/DSOs (DSOs) within...
VTBL_ENTRY const wxString FootprintLibTblName() const
Function FootprintLibTblName returns the path and filename of this project's fp-lib-table, i.e.
VTBL_ENTRY void SetProjectFullName(const wxString &aFullPathAndName)
Function SetProjectFullName sets the: 1) full directory, 2) basename, and 3) extension of the project...
VTBL_ENTRY void ElemsClear()
Function ElemsClear deletes all the _ELEMs and set their pointers to NULL.
VTBL_ENTRY void SetRString(RSTRING_T aStringId, const wxString &aString)
Function SetRString stores a "retained string", which is any session and project specific string iden...
VTBL_ENTRY FP_LIB_TABLE * PcbFootprintLibs(KIWAY &aKiway)
Return the table of footprint libraries.
A collection of PART_LIB objects.
VTBL_ENTRY const wxString & GetRString(RSTRING_T aStringId)
Function GetRString returns a "retained string", which is any session and project specific string ide...
ELEM_T
Enum ELEM_T is the set of _ELEMs that a PROJECT can hold.
RSTRING_T
Retain a number of project specific wxStrings, enumerated here:
wxString m_rstrings[RSTRING_COUNT]
VTBL_ENTRY const wxString GetProjectPath() const
Function GetProjectPath returns the full path of the project.
A PROJECT can hold stuff it knows nothing about, in the form of _ELEM derivatives.
VTBL_ENTRY bool ConfigLoad(const SEARCH_STACK &aSearchS, const wxString &aGroupName, const PARAM_CFG_ARRAY &aParams, const wxString &aForeignConfigFileName=wxEmptyString)
Function ConfigLoad reads a subset of parameters from the "project" file.
wxString m_pro_date_and_time
const wxString libTableName(const wxString &aLibTableName) const
Return the full path and file name of the project specific library table aLibTableName.
VTBL_ENTRY const wxString GetProjectName() const
Function GetProjectName returns the short name of the project.