KiCad PCB EDA Suite
Loading...
Searching...
No Matches
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 The KiCad Developers, see AUTHORS.txt for contributors.
5 * Copyright (C) 2022 CERN
6 *
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version 2
10 * of the License, or (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, you may find one here:
19 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20 * or you may search the http://www.gnu.org website for the version 2 license,
21 * or you may write to the Free Software Foundation, Inc.,
22 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23 */
24#ifndef PROJECT_H_
25#define PROJECT_H_
26
30#include <array>
31#include <map>
32#include <vector>
33#include <kiid.h>
34#include <wx_filename.h>
35#include <wx/string.h>
36#include <core/typeinfo.h>
37
40#define PROJECT_VAR_NAME wxT( "KIPRJMOD" )
41
43#define NAMELESS_PROJECT _( "untitled" )
44
46class FP_LIB_TABLE;
47class SYMBOL_LIBS;
48class SEARCH_STACK;
49class S3D_CACHE;
50class KIWAY;
53class PROJECT_FILE;
55class LOCKFILE;
56
57
65{
66public:
70 enum class ELEM
71 {
72 FPTBL,
73
74 SCH_SYMBOL_LIBS,
75 SCH_SEARCH_STACK,
76 S3DCACHE,
79
81
83 BOARD,
84
85 COUNT
86 };
87
97 {
98 public:
99 virtual ~_ELEM() {}
100
101 virtual PROJECT::ELEM ProjectElementType() = 0; // Sanity-checking for returned values.
102 };
103
104 PROJECT();
105 virtual ~PROJECT();
106
107 //-----<Cross Module API>----------------------------------------------------
108
109 virtual bool TextVarResolver( wxString* aToken ) const;
110
111 virtual std::map<wxString, wxString>& GetTextVars() const;
112
116 virtual void ApplyTextVars( const std::map<wxString, wxString>& aVarsMap );
117
118 int GetTextVarsTicker() const { return m_textVarsTicker; }
119 void IncrementTextVarsTicker() { m_textVarsTicker++; }
120
121 int GetNetclassesTicker() const { return m_netclassesTicker; }
122 void IncrementNetclassesTicker() { m_netclassesTicker++; }
123
130 virtual const wxString GetProjectFullName() const;
131
138 virtual const wxString GetProjectPath() const;
139
146 virtual const wxString GetProjectDirectory() const;
147
153 virtual const wxString GetProjectName() const;
154
164 virtual bool IsNullProject() const;
165
166 virtual bool IsReadOnly() const { return m_readOnly || IsNullProject(); }
167
168 virtual void SetReadOnly( bool aReadOnly = true ) { m_readOnly = aReadOnly; }
169
173 virtual const wxString GetSheetName( const KIID& aSheetID );
174
180 virtual const wxString FootprintLibTblName() const;
181
185 virtual const wxString SymbolLibTableName() const;
186
190 virtual const wxString DesignBlockLibTblName() const;
191
193 {
197
198 LIB_TYPE_COUNT
199 };
200
201 void PinLibrary( const wxString& aLibrary, enum LIB_TYPE_T aLibType );
202 void UnpinLibrary( const wxString& aLibrary, enum LIB_TYPE_T aLibType );
203
205 {
206 wxASSERT( m_projectFile );
207 return *m_projectFile;
208 }
209
211 {
212 wxASSERT( m_localSettings );
213 return *m_localSettings;
214 }
215
218 {
221 SCH_LIB_SELECT, // eeschema/selpart.cpp
223 SCH_LIBEDIT_CUR_SYMBOL, // eeschema/libeditframe.cpp
224
227
234
235 RSTRING_COUNT
236 };
237
245 virtual const wxString& GetRString( RSTRING_T aStringId );
246
254 virtual void SetRString( RSTRING_T aStringId, const wxString& aString );
255
268 virtual _ELEM* GetElem( PROJECT::ELEM aIndex );
269 virtual void SetElem( PROJECT::ELEM aIndex, _ELEM* aElem );
270
274 void Clear() // inline not virtual
275 {
276 elemsClear();
277
278 for( unsigned i = 0; i < RSTRING_COUNT; ++i )
279 SetRString( RSTRING_T( i ), wxEmptyString );
280 }
281
288 virtual const wxString AbsolutePath( const wxString& aFileName ) const;
289
294 virtual FP_LIB_TABLE* PcbFootprintLibs( KIWAY& aKiway );
295
299 virtual DESIGN_BLOCK_LIB_TABLE* DesignBlockLibs();
300
301 void SetProjectLock( LOCKFILE* aLockFile );
302
303 LOCKFILE* GetProjectLock() const;
304
305private:
306 friend class SETTINGS_MANAGER; // so that SM can set project path
307 friend class TEST_NETLISTS_FIXTURE; // TODO(JE) make this not required
308
309
313 virtual void elemsClear();
314
322 virtual void setProjectFullName( const wxString& aFullPathAndName );
323
331 virtual void setProjectFile( PROJECT_FILE* aFile )
332 {
333 m_projectFile = aFile;
334 }
335
343 virtual void setLocalSettings( PROJECT_LOCAL_SETTINGS* aSettings )
344 {
345 m_localSettings = aSettings;
346 }
347
351 const wxString libTableName( const wxString& aLibTableName ) const;
352
353private:
354 wxFileName m_project_name;
356
360
363
366
367 std::map<KIID, wxString> m_sheetNames;
368
370 std::array<wxString,RSTRING_COUNT> m_rstrings;
371
373 std::array<_ELEM*,static_cast<unsigned int>( PROJECT::ELEM::COUNT )> m_elems;
374
376 std::unique_ptr<LOCKFILE> m_project_lock;
377};
378
379
380#endif // PROJECT_H_
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:297
Provide an extensible class to resolve 3D model paths.
Definition: kiid.h:49
A minimalistic software bus for communications between various DLLs/DSOs (DSOs) within the same KiCad...
Definition: kiway.h:285
A PROJECT can hold stuff it knows nothing about, in the form of _ELEM derivatives.
Definition: project.h:97
virtual PROJECT::ELEM ProjectElementType()=0
virtual ~_ELEM()
Definition: project.h:99
The backing store for a PROJECT, in JSON format.
Definition: project_file.h:74
The project local settings are things that are attached to a particular project, but also might be pa...
Container for project specific data.
Definition: project.h:65
PROJECT_FILE * m_projectFile
Backing store for project data – owned by SETTINGS_MANAGER.
Definition: project.h:362
virtual void SetReadOnly(bool aReadOnly=true)
Definition: project.h:168
virtual void setProjectFile(PROJECT_FILE *aFile)
Set the backing store file for this project.
Definition: project.h:331
virtual bool IsReadOnly() const
Definition: project.h:166
LIB_TYPE_T
Definition: project.h:193
@ SYMBOL_LIB
Definition: project.h:194
@ DESIGN_BLOCK_LIB
Definition: project.h:196
@ FOOTPRINT_LIB
Definition: project.h:195
RSTRING_T
Retain a number of project specific wxStrings, enumerated here:
Definition: project.h:218
@ VIEWER_3D_FILTER_INDEX
Definition: project.h:226
@ PCB_FOOTPRINT
Definition: project.h:229
@ VIEWER_3D_PATH
Definition: project.h:225
@ SCH_LIBEDIT_CUR_LIB
Definition: project.h:222
@ PCB_FOOTPRINT_EDITOR_FP_NAME
Definition: project.h:230
@ PCB_FOOTPRINT_EDITOR_LIB_NICKNAME
Definition: project.h:231
@ PCB_FOOTPRINT_VIEWER_FP_NAME
Definition: project.h:232
@ DOC_PATH
Definition: project.h:219
@ SCH_LIB_SELECT
Definition: project.h:221
@ PCB_LIB_NICKNAME
Definition: project.h:228
@ PCB_FOOTPRINT_VIEWER_LIB_NICKNAME
Definition: project.h:233
@ SCH_LIBEDIT_CUR_SYMBOL
Definition: project.h:223
@ SCH_LIB_PATH
Definition: project.h:220
wxString m_pro_date_and_time
Definition: project.h:355
std::map< KIID, wxString > m_sheetNames
Definition: project.h:367
std::unique_ptr< LOCKFILE > m_project_lock
Lock.
Definition: project.h:376
virtual void setLocalSettings(PROJECT_LOCAL_SETTINGS *aSettings)
Set the local settings backing store.
Definition: project.h:343
int m_netclassesTicker
Update counter on netclasses.
Definition: project.h:359
int GetNetclassesTicker() const
Definition: project.h:121
virtual PROJECT_LOCAL_SETTINGS & GetLocalSettings() const
Definition: project.h:210
void IncrementNetclassesTicker()
Definition: project.h:122
virtual PROJECT_FILE & GetProjectFile() const
Definition: project.h:204
int GetTextVarsTicker() const
Definition: project.h:118
std::array< _ELEM *, static_cast< unsigned int >(PROJECT::ELEM::COUNT)> m_elems
Definition: project.h:373
wxFileName m_project_name
<fullpath>/<basename>.pro
Definition: project.h:354
void Clear()
Clear the _ELEMs and RSTRINGs.
Definition: project.h:274
PROJECT_LOCAL_SETTINGS * m_localSettings
Backing store for project local settings – owned by SETTINGS_MANAGER.
Definition: project.h:365
int m_textVarsTicker
Update counter on text vars.
Definition: project.h:358
std::array< wxString, RSTRING_COUNT > m_rstrings
Definition: project.h:370
bool m_readOnly
No project files will be written to disk.
Definition: project.h:357
void IncrementTextVarsTicker()
Definition: project.h:119
ELEM
The set of #_ELEMs that a PROJECT can hold.
Definition: project.h:71
Cache for storing the 3D shapes.
Definition: 3d_cache.h:55
Holds all the data relating to one schematic.
Definition: schematic.h:87
Look for files in a number of paths.
Definition: search_stack.h:43
A collection of SYMBOL_LIB objects.
#define KICOMMON_API
Definition: kicommon.h:28