KiCad PCB EDA Suite
Loading...
Searching...
No Matches
sch_sheet_path.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) 2017 Jean-Pierre Charras, jp.charras at wanadoo.fr
5 * Copyright (C) 2011 Wayne Stambaugh <[email protected]>
6 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
7 *
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License
10 * as published by the Free Software Foundation; either version 2
11 * of the License, or (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, you may find one here:
20 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
21 * or you may search the http://www.gnu.org website for the version 2 license,
22 * or you may write to the Free Software Foundation, Inc.,
23 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
24 */
25
30
31#ifndef CLASS_DRAWSHEET_PATH_H
32#define CLASS_DRAWSHEET_PATH_H
33
34#include <map>
35#include <optional>
36
37#include <kiid.h>
38#include <wx/string.h>
39
44{
46
47 // Things that can be annotated:
48 wxString m_Reference;
49 int m_Unit = 1;
50
51 // Do not use. This is left over from the dubious decision to instantiate symbol value
52 // and footprint fields.
53 wxString m_Value;
54 wxString m_Footprint;
55
56 // The project name associated with this instance.
57 wxString m_ProjectName;
58};
59
60
65{
67
68 wxString m_PageNumber;
69
70 // The project name associated with this instance.
71 wxString m_ProjectName;
72};
73
74
107
108
109class EDA_ITEM;
110class SCH_SHEET;
111class SCH_SCREEN;
112class SCH_MARKER;
113class SCH_ITEM;
114class SCH_SYMBOL;
116
117
121typedef std::map<wxString, SCH_REFERENCE_LIST> SCH_MULTI_UNIT_REFERENCE_MAP;
122
133{
134public:
136
137 SCH_SHEET_PATH( const SCH_SHEET_PATH& aOther );
138
139 SCH_SHEET_PATH& operator=( const SCH_SHEET_PATH& aOther );
140
141 // Move assignment operator
143
144 SCH_SHEET_PATH operator+( const SCH_SHEET_PATH& aOther );
145
146 ~SCH_SHEET_PATH() = default;
147
149 SCH_SHEET* at( size_t aIndex ) const { return m_sheets.at( aIndex ); }
150
152 void clear()
153 {
154 m_sheets.clear();
155 Rehash();
156 }
157
159 bool empty() const { return m_sheets.empty(); }
160
162 void pop_back()
163 {
164 m_sheets.pop_back();
165 Rehash();
166 }
167
169 void push_back( SCH_SHEET* aSheet )
170 {
171 m_sheets.push_back( aSheet );
172 Rehash();
173 }
174
176 size_t size() const { return m_sheets.size(); }
177
178 std::vector<SCH_SHEET*>::iterator erase( std::vector<SCH_SHEET*>::const_iterator aPosition )
179 {
180 return m_sheets.erase( aPosition );
181 }
182
183 void Rehash();
184
185 size_t GetCurrentHash() const { return m_current_hash; }
186
196 void SetVirtualPageNumber( int aPageNumber ) { m_virtualPageNumber = aPageNumber; }
197
199
205 void SetPageNumber( const wxString& aPageNumber );
206
207 wxString GetPageNumber() const;
208
209 int GetPageNumberAsInt() const;
210
211 const SCH_SHEET* GetSheet( unsigned aIndex ) const
212 {
213 SCH_SHEET* retv = nullptr;
214
215 if( aIndex < size() )
216 retv = at( aIndex );
217
218 return retv;
219 }
220
221 bool IsFullPath() const;
222
231 int Cmp( const SCH_SHEET_PATH& aSheetPathToTest ) const;
232
234 wxString GetCachedPageNumber() const { return m_cached_page_number; }
235
244 int ComparePageNum( const SCH_SHEET_PATH& aSheetPathToTest ) const;
245
252 bool IsContainedWithin( const SCH_SHEET_PATH& aSheetPathToTest ) const;
253
259 SCH_SHEET* Last() const;
260
265
266
268 SCH_SCREEN* LastScreen() const;
269
270 bool GetExcludedFromSim() const;
271 bool GetExcludedFromBOM() const;
272 bool GetExcludedFromBoard() const;
273 bool GetDNP() const;
274
278 SCH_ITEM* ResolveItem( const KIID& aID ) const;
279
285 wxString PathAsString() const;
286
292 KIID_PATH Path() const;
293
300 wxString PathHumanReadable( bool aUseShortRootName = true,
301 bool aStripTrailingSeparator = false ) const;
302
309 void UpdateAllScreenReferences() const;
310
321 void AppendSymbol( SCH_REFERENCE_LIST& aReferences, SCH_SYMBOL* aSymbol,
322 bool aIncludePowerSymbols = true,
323 bool aForceIncludeOrphanSymbols = false ) const;
324
334 void GetSymbols( SCH_REFERENCE_LIST& aReferences, bool aIncludePowerSymbols = true,
335 bool aForceIncludeOrphanSymbols = false ) const;
336
348 bool aIncludePowerSymbols = true ) const;
349
360 bool aIncludePowerSymbols = true ) const;
361
371 bool TestForRecursion( const wxString& aSrcFileName, const wxString& aDestFileName );
372
390
408 void AddNewSymbolInstances( const SCH_SHEET_PATH& aPrefixSheetPath,
409 const wxString& aProjectName );
410
411 void RemoveSymbolInstances( const SCH_SHEET_PATH& aPrefixSheetPath );
412
413 void CheckForMissingSymbolInstances( const wxString& aProjectName );
414
415 bool operator==( const SCH_SHEET_PATH& d1 ) const;
416
417 bool operator!=( const SCH_SHEET_PATH& d1 ) const { return !( *this == d1 ) ; }
418
419 bool operator<( const SCH_SHEET_PATH& d1 ) const { return m_sheets < d1.m_sheets; }
420
421private:
422 void initFromOther( const SCH_SHEET_PATH& aOther );
423
424protected:
425 std::vector<SCH_SHEET*> m_sheets;
426
428 mutable wxString m_cached_page_number;
429
431
432 std::map<std::pair<wxString, wxString>, bool> m_recursion_test_cache;
433};
434
435
436namespace std
437{
438 template<> struct hash<SCH_SHEET_PATH>
439 {
440 size_t operator()( const SCH_SHEET_PATH& path ) const;
441 };
442}
443
445{
446 size_t operator()( const SCH_SHEET_PATH& path ) const
447 {
448 return path.GetCurrentHash();
449 }
450};
451
453{
454 bool operator()( const SCH_SHEET_PATH& lhs, const SCH_SHEET_PATH& rhs ) const
455 {
456 return lhs.GetCurrentHash() < rhs.GetCurrentHash();
457 }
458};
459
460
469class SCH_SHEET_LIST : public std::vector<SCH_SHEET_PATH>
470{
471public:
477 SCH_SHEET_LIST( SCH_SHEET* aSheet = nullptr );
478
480
486 bool IsModified() const;
487
488 void ClearModifyStatus();
489
495 SCH_ITEM* ResolveItem( const KIID& aID, SCH_SHEET_PATH* aPathOut = nullptr,
496 bool aAllowNullptrReturn = false ) const;
497
501 void FillItemMap( std::map<KIID, EDA_ITEM*>& aMap );
502
512
522 void GetSymbols( SCH_REFERENCE_LIST& aReferences, bool aIncludePowerSymbols = true,
523 bool aForceIncludeOrphanSymbols = false ) const;
524
536 void GetSymbolsWithinPath( SCH_REFERENCE_LIST& aReferences, const SCH_SHEET_PATH& aSheetPath,
537 bool aIncludePowerSymbols = true,
538 bool aForceIncludeOrphanSymbols = false ) const;
539
547 void GetSheetsWithinPath( std::vector<SCH_SHEET_PATH>& aSheets,
548 const SCH_SHEET_PATH& aSheetPath ) const;
549
550
556 std::optional<SCH_SHEET_PATH> GetSheetPathByKIIDPath( const KIID_PATH& aPath,
557 bool aIncludeLastSheet = true ) const;
558
559
569 bool aIncludePowerSymbols = true ) const;
570
579 bool TestForRecursion( const SCH_SHEET_LIST& aSrcSheetHierarchy,
580 const wxString& aDestFileName );
581
587
593
597 SCH_SHEET_LIST FindAllSheetsForScreen( const SCH_SCREEN* aScreen ) const;
598
613 void BuildSheetList( SCH_SHEET* aSheet, bool aCheckIntegrity );
614
624 void SortByPageNumbers( bool aUpdateVirtualPageNums = true );
625
631 void SortByHierarchicalPageNumbers( bool aUpdateVirtualPageNums = true );
632
633 bool NameExists( const wxString& aSheetName ) const;
634
635 bool PageNumberExists( const wxString& aPageNumber ) const;
636
642 void TrimToPageNumbers( const std::vector<wxString>& aPageInclusions );
643
651 void UpdateSymbolInstanceData( const std::vector<SCH_SYMBOL_INSTANCE>& aSymbolInstances );
652
660 void UpdateSheetInstanceData( const std::vector<SCH_SHEET_INSTANCE>& aSheetInstances );
661
662 std::vector<KIID_PATH> GetPaths() const;
663
669 std::vector<SCH_SHEET_INSTANCE> GetSheetInstances() const;
670
679 bool AllSheetPageNumbersEmpty() const;
680
688
696 void AddNewSymbolInstances( const SCH_SHEET_PATH& aPrefixSheetPath,
697 const wxString& aProjectName );
698
699 void AddNewSheetInstances( const SCH_SHEET_PATH& aPrefixSheetPath,
700 int aLastVirtualPageNumber );
701
702 int GetLastVirtualPageNumber() const;
703
704 void RemoveSymbolInstances( const SCH_SHEET_PATH& aPrefixSheetPath );
705
706 void CheckForMissingSymbolInstances( const wxString& aProjectName );
707
708 bool HasPath( const KIID_PATH& aPath ) const;
709
710 bool ContainsSheet( const SCH_SHEET* aSheet ) const;
711
721 std::optional<SCH_SHEET_PATH> GetOrdinalPath( const SCH_SCREEN* aScreen ) const;
722
723private:
725};
726
727#endif // CLASS_DRAWSHEET_PATH_H
A base class for most all the KiCad significant classes used in schematics and boards.
Definition eda_item.h:98
Definition kiid.h:49
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition sch_item.h:167
Container to create a flattened list of symbols because in a complex hierarchy, a symbol can be used ...
A container for handling SCH_SHEET_PATH objects in a flattened hierarchy.
std::optional< SCH_SHEET_PATH > GetSheetPathByKIIDPath(const KIID_PATH &aPath, bool aIncludeLastSheet=true) const
Finds a SCH_SHEET_PATH that matches the provided KIID_PATH.
SCH_ITEM * ResolveItem(const KIID &aID, SCH_SHEET_PATH *aPathOut=nullptr, bool aAllowNullptrReturn=false) const
Fetch a SCH_ITEM by ID.
void GetMultiUnitSymbols(SCH_MULTI_UNIT_REFERENCE_MAP &aRefList, bool aIncludePowerSymbols=true) const
Add a SCH_REFERENCE_LIST object to aRefList for each same-reference set of multi-unit parts in the li...
std::optional< SCH_SHEET_PATH > GetOrdinalPath(const SCH_SCREEN *aScreen) const
Return the ordinal sheet path of aScreen.
void FillItemMap(std::map< KIID, EDA_ITEM * > &aMap)
Fill an item cache for temporary use when many items need to be fetched.
SCH_SHEET_PATH m_currentSheetPath
void TrimToPageNumbers(const std::vector< wxString > &aPageInclusions)
Truncates the list by removing sheet's with page numbers not in the given list.
void SortByPageNumbers(bool aUpdateVirtualPageNums=true)
Sort the list of sheets by page number.
void AddNewSymbolInstances(const SCH_SHEET_PATH &aPrefixSheetPath, const wxString &aProjectName)
Attempt to add new symbol instances for all symbols in this list of sheet paths prefixed with aPrefix...
bool NameExists(const wxString &aSheetName) const
std::vector< SCH_SHEET_INSTANCE > GetSheetInstances() const
Fetch the instance information for all of the sheets in the hierarchy.
void UpdateSheetInstanceData(const std::vector< SCH_SHEET_INSTANCE > &aSheetInstances)
Update all of the sheet instance information using aSheetInstances.
void SetInitialPageNumbers()
Set initial sheet page numbers.
void RemoveSymbolInstances(const SCH_SHEET_PATH &aPrefixSheetPath)
SCH_SHEET_LIST FindAllSheetsForScreen(const SCH_SCREEN *aScreen) const
Return a SCH_SHEET_LIST with a copy of all the SCH_SHEET_PATH using a particular screen.
bool AllSheetPageNumbersEmpty() const
Check all of the sheet instance for empty page numbers.
void GetSymbols(SCH_REFERENCE_LIST &aReferences, bool aIncludePowerSymbols=true, bool aForceIncludeOrphanSymbols=false) const
Add a SCH_REFERENCE object to aReferences for each symbol in the list of sheets.
bool IsModified() const
Check the entire hierarchy for any modifications.
SCH_SHEET_LIST(SCH_SHEET *aSheet=nullptr)
Construct a flattened list of SCH_SHEET_PATH objects from aSheet.
void AnnotatePowerSymbols()
Silently annotate the not yet annotated power symbols of the entire hierarchy of the sheet path list.
int GetLastVirtualPageNumber() const
void UpdateSymbolInstanceData(const std::vector< SCH_SYMBOL_INSTANCE > &aSymbolInstances)
Update all of the symbol instance information using aSymbolInstances.
void GetSheetsWithinPath(std::vector< SCH_SHEET_PATH > &aSheets, const SCH_SHEET_PATH &aSheetPath) const
Add a SCH_SHEET_PATH object to aSheets for each sheet in the list that are contained within aSheetPat...
bool PageNumberExists(const wxString &aPageNumber) const
void SortByHierarchicalPageNumbers(bool aUpdateVirtualPageNums=true)
This works like SortByPageNumbers, but it sorts the sheets first by their hierarchical depth and then...
void AddNewSheetInstances(const SCH_SHEET_PATH &aPrefixSheetPath, int aLastVirtualPageNumber)
bool ContainsSheet(const SCH_SHEET *aSheet) const
std::vector< KIID_PATH > GetPaths() const
void GetSymbolsWithinPath(SCH_REFERENCE_LIST &aReferences, const SCH_SHEET_PATH &aSheetPath, bool aIncludePowerSymbols=true, bool aForceIncludeOrphanSymbols=false) const
Add a SCH_REFERENCE object to aReferences for each symbol in the list of sheets that are contained wi...
void BuildSheetList(SCH_SHEET *aSheet, bool aCheckIntegrity)
Build the list of sheets and their sheet path from aSheet.
SCH_SHEET_PATH FindSheetForScreen(const SCH_SCREEN *aScreen)
Return the first SCH_SHEET_PATH object (not necessarily the only one) using a particular screen.
void CheckForMissingSymbolInstances(const wxString &aProjectName)
bool HasPath(const KIID_PATH &aPath) const
SCH_SHEET_PATH * FindSheetForPath(const SCH_SHEET_PATH *aPath)
Return a pointer to the first SCH_SHEET_PATH object (not necessarily the only one) matching the provi...
bool TestForRecursion(const SCH_SHEET_LIST &aSrcSheetHierarchy, const wxString &aDestFileName)
Test every SCH_SHEET_PATH in this SCH_SHEET_LIST to verify if adding the sheets stored in aSrcSheetHi...
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...
bool GetExcludedFromBOM() const
bool operator!=(const SCH_SHEET_PATH &d1) const
void AppendMultiUnitSymbol(SCH_MULTI_UNIT_REFERENCE_MAP &aRefList, SCH_SYMBOL *aSymbol, bool aIncludePowerSymbols=true) const
Append a SCH_REFERENCE_LIST object to aRefList based on aSymbol, storing same-reference set of multi-...
const SCH_SHEET * GetSheet(unsigned aIndex) const
bool empty() const
Forwarded method from std::vector.
void GetSymbols(SCH_REFERENCE_LIST &aReferences, bool aIncludePowerSymbols=true, bool aForceIncludeOrphanSymbols=false) const
Adds SCH_REFERENCE object to aReferences for each symbol in the sheet.
int ComparePageNum(const SCH_SHEET_PATH &aSheetPathToTest) const
Compare sheets by their page number.
size_t GetCurrentHash() const
wxString PathHumanReadable(bool aUseShortRootName=true, bool aStripTrailingSeparator=false) const
Return the sheet path in a human readable form made from the sheet names.
std::vector< SCH_SHEET * >::iterator erase(std::vector< SCH_SHEET * >::const_iterator aPosition)
bool operator==(const SCH_SHEET_PATH &d1) const
void AddNewSymbolInstances(const SCH_SHEET_PATH &aPrefixSheetPath, const wxString &aProjectName)
Attempt to add new symbol instances for all symbols in this sheet path prefixed with aPrefixSheetPath...
KIID_PATH Path() const
Get the sheet path as an KIID_PATH.
bool TestForRecursion(const wxString &aSrcFileName, const wxString &aDestFileName)
Test the SCH_SHEET_PATH file names to check adding the sheet stored in the file aSrcFileName to the s...
void UpdateAllScreenReferences() const
Update all the symbol references for this sheet path.
bool operator<(const SCH_SHEET_PATH &d1) const
bool IsFullPath() const
void MakeFilePathRelativeToParentSheet()
Make the sheet file name relative to its parent sheet.
SCH_ITEM * ResolveItem(const KIID &aID) const
Fetch a SCH_ITEM by ID.
wxString GetCachedPageNumber() const
std::vector< SCH_SHEET * > m_sheets
SCH_SCREEN * LastScreen()
int Cmp(const SCH_SHEET_PATH &aSheetPathToTest) const
Compare if this is the same sheet path as aSheetPathToTest.
void GetMultiUnitSymbols(SCH_MULTI_UNIT_REFERENCE_MAP &aRefList, bool aIncludePowerSymbols=true) const
Add a SCH_REFERENCE_LIST object to aRefList for each same-reference set of multi-unit parts in the sh...
void initFromOther(const SCH_SHEET_PATH &aOther)
wxString m_cached_page_number
wxString GetPageNumber() const
void RemoveSymbolInstances(const SCH_SHEET_PATH &aPrefixSheetPath)
void CheckForMissingSymbolInstances(const wxString &aProjectName)
bool IsContainedWithin(const SCH_SHEET_PATH &aSheetPathToTest) const
Check if this path is contained inside aSheetPathToTest.
~SCH_SHEET_PATH()=default
void CachePageNumber() const
SCH_SHEET * at(size_t aIndex) const
Forwarded method from std::vector.
void SetVirtualPageNumber(int aPageNumber)
Set the sheet instance virtual page number.
void AppendSymbol(SCH_REFERENCE_LIST &aReferences, SCH_SYMBOL *aSymbol, bool aIncludePowerSymbols=true, bool aForceIncludeOrphanSymbols=false) const
Append a SCH_REFERENCE object to aReferences based on aSymbol.
std::map< std::pair< wxString, wxString >, bool > m_recursion_test_cache
bool GetExcludedFromSim() const
wxString PathAsString() const
Return the path of time stamps which do not changes even when editing sheet parameters.
bool GetExcludedFromBoard() const
void SetPageNumber(const wxString &aPageNumber)
Set the sheet instance user definable page number.
SCH_SHEET_PATH & operator=(const SCH_SHEET_PATH &aOther)
int GetPageNumberAsInt() const
bool GetDNP() const
SCH_SHEET * Last() const
Return a pointer to the last SCH_SHEET of the list.
SCH_SHEET_PATH operator+(const SCH_SHEET_PATH &aOther)
int m_virtualPageNumber
Page numbers are maintained by the sheet load order.
void push_back(SCH_SHEET *aSheet)
Forwarded method from std::vector.
void clear()
Forwarded method from std::vector.
size_t size() const
Forwarded method from std::vector.
int GetVirtualPageNumber() const
void pop_back()
Forwarded method from std::vector.
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition sch_sheet.h:47
Schematic symbol object.
Definition sch_symbol.h:75
STL namespace.
std::map< wxString, SCH_REFERENCE_LIST > SCH_MULTI_UNIT_REFERENCE_MAP
Container to map reference designators for multi-unit parts.
A simple container for sheet instance information.
A simple container for schematic symbol instance information.
bool operator()(const SCH_SHEET_PATH &lhs, const SCH_SHEET_PATH &rhs) const
size_t operator()(const SCH_SHEET_PATH &path) const
size_t operator()(const SCH_SHEET_PATH &path) const