KiCad PCB EDA Suite
project.h
Go to the documentation of this file.
1 /*
2  * This program source code file is part of KiCad, a free EDA CAD application.
3  *
4  * Copyright (C) 2014-2017 KiCad Developers, see AUTHORS.txt for contributors.
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, you may find one here:
18  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
19  * or you may search the http://www.gnu.org website for the version 2 license,
20  * or you may write to the Free Software Foundation, Inc.,
21  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
22  */
23 #ifndef PROJECT_H_
24 #define PROJECT_H_
25 
26 #include <vector>
27 #include <wx/string.h>
28 #include <wx/filename.h>
29 
32 #define PROJECT_VAR_NAME wxT( "KIPRJMOD" )
33 
34 
35 class wxConfigBase;
36 class PARAM_CFG_ARRAY;
37 class FP_LIB_TABLE;
38 class PART_LIBS;
39 class SEARCH_STACK;
40 class S3D_CACHE;
41 class KIWAY;
42 
43 #define VTBL_ENTRY virtual
44 
51 class PROJECT
52 {
53 public:
54 
61  class _ELEM
62  {
63  public:
64  virtual ~_ELEM() {}
65  };
66 
67  PROJECT();
68  ~PROJECT();
69 
70  //-----<Cross Module API>----------------------------------------------------
71 
72  // VTBL_ENTRY bool MaybeLoadProjectSettings( const std::vector<wxString>& aFileSet );
73 
82  VTBL_ENTRY void SetProjectFullName( const wxString& aFullPathAndName );
83 
89  VTBL_ENTRY const wxString GetProjectFullName() const;
90 
96  VTBL_ENTRY const wxString GetProjectPath() const;
97 
103  VTBL_ENTRY const wxString GetProjectName() const;
104 
110  VTBL_ENTRY const wxString FootprintLibTblName() const;
111 
125  VTBL_ENTRY void ConfigSave( const SEARCH_STACK& aSList, const wxString& aGroupName,
126  const PARAM_CFG_ARRAY& aParams, const wxString& aFileName = wxEmptyString );
127 
146  VTBL_ENTRY bool ConfigLoad( const SEARCH_STACK& aSearchS, const wxString& aGroupName,
147  const PARAM_CFG_ARRAY& aParams, const wxString& aForeignConfigFileName = wxEmptyString );
148 
151  {
154  SCH_LIB_SELECT, // eeschema/selpart.cpp
156  SCH_LIBEDIT_CUR_PART, // eeschema/libeditframe.cpp
157 
160 
165 
167  };
168 
175  VTBL_ENTRY const wxString& GetRString( RSTRING_T aStringId );
176 
183  VTBL_ENTRY void SetRString( RSTRING_T aStringId, const wxString& aString );
184 
189  enum ELEM_T
190  {
192 
196 
198  };
199 
209  VTBL_ENTRY _ELEM* GetElem( ELEM_T aIndex );
210  VTBL_ENTRY void SetElem( ELEM_T aIndex, _ELEM* aElem );
211 
216  VTBL_ENTRY void ElemsClear();
217 
222  void Clear() // inline not virtual
223  {
224  ElemsClear();
225 
226  for( unsigned i = 0; i<RSTRING_COUNT; ++i )
227  SetRString( RSTRING_T( i ), wxEmptyString );
228  }
229 
236  VTBL_ENTRY const wxString AbsolutePath( const wxString& aFileName ) const;
237 
243 
244  //-----</Cross Module API>---------------------------------------------------
245 
246  //-----<KIFACE Specific APIs>------------------------------------------------
247 
248  // These are the non-virtual DATA LOAD ON DEMAND members. They load project related
249  // data on demand, and do so typicallly into m_elems[] at a particular index using
250  // SetElem() & GetElem(). That is, they wrap SetElem() and GetElem().
251  // To get the data to reload on demand, first SetProjectFullName(),
252  // then call SetElem( ELEM_T, NULL ) from client code.
253 
254  // non-virtuals resident in PCBNEW link image(s). By being non-virtual, these
255  // functions can get linked into the KIFACE that needs them, and only there.
256  // In fact, the other KIFACEs don't even know they exist.
257 #if defined(PCBNEW) || defined(CVPCB)
258 
263 
271  S3D_CACHE* Get3DCacheManager( bool updateProjDir = false );
272 #endif
273 
274 
275 #if defined(EESCHEMA)
276  // These are all prefaced with "Sch"
277  PART_LIBS* SchLibs();
278 
280  SEARCH_STACK* SchSearchS();
281 #endif
282 
283  //-----</KIFACE Specific APIs>-----------------------------------------------
284 
285 private:
286 
295  wxConfigBase* configCreate( const SEARCH_STACK& aSList,
296  const wxString& aGroupName, const wxString& aProjectFileName = wxEmptyString );
297 
298  wxFileName m_project_name;
300 
303 
306 };
307 
308 
309 //-----<possible futures>---------------------------------------------------------
310 
311 #if 0
312 
323  VTBL_ENTRY bool Value( const wxString& aVariable, wxString* aFetchedValue = NULL );
324 
331  VTBL_ENTRY const wxString Substitute( const wxString& aString );
332 
340  VTBL_ENTRY const wxString SubstituteAndEvaluate( const wxString& aString );
341 #endif
342 
343 #endif // PROJECT_H_
wxConfigBase * configCreate(const SEARCH_STACK &aSList, const wxString &aGroupName, const wxString &aProjectFileName=wxEmptyString)
Function configCreate loads a *.pro file and returns a wxConfigBase.
Definition: project.cpp:280
_ELEM * m_elems[ELEM_COUNT]
Definition: project.h:305
A list of parameters type.
void Clear()
Function Clear clears the _ELEMs and RSTRINGs.
Definition: project.h:222
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...
Definition: project.cpp:307
Class PROJECT holds project specific data.
Definition: project.h:51
VTBL_ENTRY const wxString GetProjectFullName() const
Function GetProjectFullName returns the full path and name of the project.
Definition: project.cpp:96
Class SEARCH_STACK looks for files in a number of places.
Definition: search_stack.h:41
VTBL_ENTRY _ELEM * GetElem(ELEM_T aIndex)
Typically wrapped somewhere else in a more meaningful function wrapper.
Definition: project.cpp:196
VTBL_ENTRY void SetElem(ELEM_T aIndex, _ELEM *aElem)
Definition: project.cpp:208
wxFileName m_project_name
/.pro
Definition: project.h:298
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...
Definition: project.cpp:371
Class KIWAY is a minimalistic software bus for communications between various DLLs/DSOs (DSOs) within...
Definition: kiway.h:257
VTBL_ENTRY const wxString FootprintLibTblName() const
Function FootprintLibTblName returns the path and filename of this project's fp-lib-table, i.e.
Definition: project.cpp:114
VTBL_ENTRY void SetProjectFullName(const wxString &aFullPathAndName)
Function SetProjectFullName sets the: 1) full directory, 2) basename, and 3) extension of the project...
Definition: project.cpp:65
VTBL_ENTRY void ElemsClear()
Function ElemsClear deletes all the _ELEMs and set their pointers to NULL.
Definition: project.cpp:46
PROJECT()
Definition: project.cpp:40
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...
Definition: project.cpp:162
VTBL_ENTRY FP_LIB_TABLE * PcbFootprintLibs(KIWAY &aKiway)
Return the table of footprint libraries.
Class PART_LIBS is a collection of PART_LIBs.
VTBL_ENTRY const wxString & GetRString(RSTRING_T aStringId)
Function GetRString returns a "retained string", which is any session and project specific string ide...
Definition: project.cpp:177
ELEM_T
Enum ELEM_T is the set of _ELEMs that a PROJECT can hold.
Definition: project.h:189
#define VTBL_ENTRY
Definition: project.h:43
RSTRING_T
Retain a number of project specific wxStrings, enumerated here:
Definition: project.h:150
wxString m_rstrings[RSTRING_COUNT]
Definition: project.h:302
VTBL_ENTRY const wxString GetProjectPath() const
Function GetProjectPath returns the full path of the project.
Definition: project.cpp:102
A PROJECT can hold stuff it knows nothing about, in the form of _ELEM derivatives.
Definition: project.h:61
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.
Definition: project.cpp:342
wxString m_pro_date_and_time
Definition: project.h:299
virtual ~_ELEM()
Definition: project.h:64
~PROJECT()
Definition: project.cpp:59
VTBL_ENTRY const wxString GetProjectName() const
Function GetProjectName returns the short name of the project.
Definition: project.cpp:108