KiCad PCB EDA Suite
Loading...
Searching...
No Matches
eeschema_helpers.cpp
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) 2022 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 3
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/gpl-3.0.html
19 * or you may search the http://www.gnu.org website for the version 3 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
24#include <eeschema_helpers.h>
25#include <sch_edit_frame.h>
28#include <schematic.h>
29#include <sch_io/sch_io_mgr.h>
30#include <locale_io.h>
31#include <wx/app.h>
32#include <sch_label.h>
33#include <connection_graph.h>
34
37
38
40{
41 s_SchEditFrame = aSchEditFrame;
42}
43
44
46{
48 {
49 if( s_SchEditFrame )
50 {
52 }
53 else
54 {
56 }
57 }
58
59 return s_SettingsManager;
60}
61
62
64{
65 // For some reasons, LoadProject() needs a C locale, so ensure we have the right locale
66 // This is mainly when running QA Python tests
68
70
71 if( !project )
72 {
75 }
76
77 return project;
78}
79
80
81SCHEMATIC* EESCHEMA_HELPERS::LoadSchematic( wxString& aFileName, bool aSetActive )
82{
83 if( aFileName.EndsWith( FILEEXT::KiCadSchematicFileExtension ) )
84 return LoadSchematic( aFileName, SCH_IO_MGR::SCH_KICAD, aSetActive );
85 else if( aFileName.EndsWith( FILEEXT::LegacySchematicFileExtension ) )
86 return LoadSchematic( aFileName, SCH_IO_MGR::SCH_LEGACY, aSetActive );
87
88 // as fall back for any other kind use the legacy format
89 return LoadSchematic( aFileName, SCH_IO_MGR::SCH_LEGACY, aSetActive );
90}
91
92
93SCHEMATIC* EESCHEMA_HELPERS::LoadSchematic( wxString& aFileName, SCH_IO_MGR::SCH_FILE_T aFormat,
94 bool aSetActive )
95{
96 wxFileName pro = aFileName;
98 pro.MakeAbsolute();
99 wxString projectPath = pro.GetFullPath();
100
101 // Ensure the "C" locale is temporary set, before reading any file
102 // It also avoid wxWidget alerts about locale issues, later, when using Python 3
104
105 PROJECT* project = GetSettingsManager()->GetProject( projectPath );
106
107 if( !project )
108 {
109 if( wxFileExists( projectPath ) )
110 {
111 GetSettingsManager()->LoadProject( projectPath, aSetActive );
112 project = GetSettingsManager()->GetProject( projectPath );
113 }
114 }
115 else if( s_SchEditFrame && project == &GetSettingsManager()->Prj() )
116 {
117 // Project is already loaded? Then so is the board
118 return &s_SchEditFrame->Schematic();
119 }
120
121 // Board cannot be loaded without a project, so create the default project
122 if( !project )
124
125 IO_RELEASER<SCH_IO> pi( SCH_IO_MGR::FindPlugin( aFormat ) );
126
127 SCHEMATIC* schematic = new SCHEMATIC( project );
128
129 SCH_SHEET* rootSheet = new SCH_SHEET( schematic );
130 schematic->SetRoot( rootSheet );
131
132 SCH_SCREEN* rootScreen = new SCH_SCREEN( schematic );
133 const_cast<KIID&>( rootSheet->m_Uuid ) = rootScreen->GetUuid();
134 schematic->Root().SetScreen( rootScreen );
135
136
137 schematic->RootScreen()->SetFileName( wxEmptyString );
138
139 // Don't leave root page number empty
140 schematic->RootScreen()->SetPageNumber( wxT( "1" ) );
141
142 wxFileName schFile = aFileName;
143 schFile.MakeAbsolute();
144
145 try
146 {
147 schematic->SetRoot( pi->LoadSchematicFile( schFile.GetFullPath(), schematic ) );
148 }
149 catch( ... )
150 {
151 return nullptr;
152 }
153
154 SCH_SHEET_LIST sheetList = schematic->GetSheets();
155 SCH_SCREENS screens( schematic->Root() );
156
157 for( SCH_SCREEN* screen = screens.GetFirst(); screen; screen = screens.GetNext() )
158 screen->UpdateLocalLibSymbolLinks();
159
160 if( schematic->RootScreen()->GetFileFormatVersionAtLoad() < 20221002 )
161 sheetList.UpdateSymbolInstanceData( schematic->RootScreen()->GetSymbolInstances());
162
163 sheetList.UpdateSheetInstanceData( schematic->RootScreen()->GetSheetInstances());
164
165 if( schematic->RootScreen()->GetFileFormatVersionAtLoad() < 20230221 )
167
168 for( SCH_SCREEN* screen = screens.GetFirst(); screen; screen = screens.GetNext() )
169 screen->MigrateSimModels();
170
171 sheetList.AnnotatePowerSymbols();
172
173 schematic->ConnectionGraph()->Reset();
174
175 schematic->SetSheetNumberAndCount();
176 schematic->RecomputeIntersheetRefs( []( SCH_GLOBALLABEL* aGlobal )
177 {
178 for( SCH_FIELD& field : aGlobal->GetFields() )
179 field.ClearBoundingBoxCache();
180
181 aGlobal->ClearBoundingBoxCache();
182 } );
183
184 for( SCH_SHEET_PATH& sheet : sheetList )
185 {
186 sheet.UpdateAllScreenReferences();
187 sheet.LastScreen()->TestDanglingEnds( nullptr, nullptr );
188 }
189
190 schematic->ConnectionGraph()->Recalculate( sheetList, true );
191
192
193 return schematic;
194}
void SetPageNumber(const wxString &aPageNumber)
Definition: base_screen.h:79
void Recalculate(const SCH_SHEET_LIST &aSheetList, bool aUnconditional=false, std::function< void(SCH_ITEM *)> *aChangedItemHandler=nullptr)
Update the connection graph for the given list of sheets.
SETTINGS_MANAGER * GetSettingsManager() const
const KIID m_Uuid
Definition: eda_item.h:485
virtual void ClearBoundingBoxCache()
Definition: eda_text.cpp:505
static PROJECT * GetDefaultProject()
static SETTINGS_MANAGER * s_SettingsManager
static void SetSchEditFrame(SCH_EDIT_FRAME *aSchEditFrame)
static SETTINGS_MANAGER * GetSettingsManager()
static SCHEMATIC * LoadSchematic(wxString &aFileName, bool aSetActive)
static SCH_EDIT_FRAME * s_SchEditFrame
Definition: kiid.h:49
Instantiate the current locale within a scope in which you are expecting exceptions to be thrown.
Definition: locale_io.h:49
Container for project specific data.
Definition: project.h:62
Holds all the data relating to one schematic.
Definition: schematic.h:75
CONNECTION_GRAPH * ConnectionGraph() const override
Definition: schematic.h:146
SCH_SHEET_LIST GetSheets() const override
Builds and returns an updated schematic hierarchy TODO: can this be cached?
Definition: schematic.h:100
void SetRoot(SCH_SHEET *aRootSheet)
Initialize the schematic with a new root sheet.
Definition: schematic.cpp:184
SCH_SCREEN * RootScreen() const
Helper to retrieve the screen of the root sheet.
Definition: schematic.cpp:197
void RecomputeIntersheetRefs(const std::function< void(SCH_GLOBALLABEL *)> &aItemCallback)
Update the schematic's page reference map for all global labels, and refresh the labels so that they ...
Definition: schematic.cpp:656
SCH_SHEET & Root() const
Definition: schematic.h:105
void SetSheetNumberAndCount()
Set the m_ScreenNumber and m_NumberOfScreens members for screens.
Definition: schematic.cpp:627
Schematic editor (Eeschema) main window.
SCHEMATIC & Schematic() const
Instances are attached to a symbol or sheet and provide a place for the symbol's value,...
Definition: sch_field.h:51
std::vector< SCH_FIELD > & GetFields()
Definition: sch_label.h:194
Container class that holds multiple SCH_SCREEN objects in a hierarchy.
Definition: sch_screen.h:704
SCH_SCREEN * GetNext()
void FixLegacyPowerSymbolMismatches()
Fix legacy power symbols that have mismatched value text fields and invisible power pin names.
SCH_SCREEN * GetFirst()
const KIID & GetUuid() const
Definition: sch_screen.h:525
void SetFileName(const wxString &aFileName)
Set the file name for this screen to aFileName.
Definition: sch_screen.cpp:115
const std::vector< SCH_SYMBOL_INSTANCE > & GetSymbolInstances() const
Definition: sch_screen.h:515
int GetFileFormatVersionAtLoad() const
Definition: sch_screen.h:129
const std::vector< SCH_SHEET_INSTANCE > & GetSheetInstances() const
Definition: sch_screen.h:520
A container for handling SCH_SHEET_PATH objects in a flattened hierarchy.
void UpdateSheetInstanceData(const std::vector< SCH_SHEET_INSTANCE > &aSheetInstances)
Update all of the sheet instance information using aSheetInstances.
void AnnotatePowerSymbols()
Silently annotate the not yet annotated power symbols of the entire hierarchy of the sheet path list.
void UpdateSymbolInstanceData(const std::vector< SCH_SYMBOL_INSTANCE > &aSymbolInstances)
Update all of the symbol instance information using aSymbolInstances.
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition: sch_sheet.h:57
void SetScreen(SCH_SCREEN *aScreen)
Set the SCH_SCREEN associated with this sheet to aScreen.
Definition: sch_sheet.cpp:162
bool LoadProject(const wxString &aFullPath, bool aSetActive=true)
Loads a project or sets up a new project with a specified path.
PROJECT * GetProject(const wxString &aFullPath) const
Retrieves a loaded project by name.
static const std::string LegacySchematicFileExtension
static const std::string ProjectFileExtension
static const std::string KiCadSchematicFileExtension
std::unique_ptr< T > IO_RELEASER
Helper to hold and release an IO_BASE object when exceptions are thrown.
Definition: io_mgr.h:33
PROJECT & Prj()
Definition: kicad.cpp:595
std::vector< FAB_LAYER_COLOR > dummy
Definition of file extensions used in Kicad.