KiCad PCB EDA Suite
Loading...
Searching...
No Matches
dialog_schematic_setup.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) 2020-2023 KiCad Developers, see AUTHORS.txt for contributors.
5 *
6 * This program is free software: you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License as published by the
8 * Free Software Foundation, either version 3 of the License, or (at your
9 * option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License along
17 * with this program. If not, see <http://www.gnu.org/licenses/>.
18 */
19
20#include <confirm.h>
21#include <sch_edit_frame.h>
22#include <schematic.h>
23#include <kiface_base.h>
29#include <panel_setup_pinmap.h>
30#include <erc/erc_item.h>
32#include <panel_bom_presets.h>
40
41
43 PAGED_DIALOG( aFrame, _( "Schematic Setup" ), true, false,
44 _( "Import Settings from Another Project..." ), wxSize( 920, 460 ) ),
45 m_frame( aFrame )
46{
47 SetEvtHandlerEnabled( false );
48
50
51 /*
52 * WARNING: If you change page names you MUST update calls to ShowSchematicSetupDialog().
53 */
54
55 m_treebook->AddPage( new wxPanel( GetTreebook() ), _( "General" ) );
56
57 m_formattingPage = m_treebook->GetPageCount();
59 [this]( wxWindow* aParent ) -> wxWindow*
60 {
61 return new PANEL_SETUP_FORMATTING( aParent, m_frame );
62 }, _( "Formatting" ) );
63
64 m_fieldNameTemplatesPage = m_treebook->GetPageCount();
66 [this]( wxWindow* aParent ) -> wxWindow*
67 {
69 return new PANEL_TEMPLATE_FIELDNAMES( aParent, &settings.m_TemplateFieldNames );
70 }, _( "Field Name Templates" ) );
71
72 m_bomPresetsPage = m_treebook->GetPageCount();
74 [this]( wxWindow* aParent ) -> wxWindow*
75 {
77 return new PANEL_BOM_PRESETS( aParent, settings );
78 }, _( "BOM Presets" ) );
79
80
81 m_treebook->AddPage( new wxPanel( GetTreebook() ), _( "Electrical Rules" ) );
82
83 m_severitiesPage = m_treebook->GetPageCount();
85 [this]( wxWindow* aParent ) -> wxWindow*
86 {
87 ERC_SETTINGS& ercSettings = m_frame->Schematic().ErcSettings();
89 ercSettings.m_ERCSeverities,
90 m_pinToPinError.get() );
91 }, _( "Violation Severity" ) );
92
93 m_pinMapPage = m_treebook->GetPageCount();
95 [this]( wxWindow* aParent ) -> wxWindow*
96 {
97 return new PANEL_SETUP_PINMAP( aParent, m_frame );
98 }, _( "Pin Conflicts Map" ) );
99
100 m_treebook->AddPage( new wxPanel( GetTreebook() ), _( "Project" ) );
101
102 m_netclassesPage = m_treebook->GetPageCount();
104 [this]( wxWindow* aParent ) -> wxWindow*
105 {
106 SCHEMATIC& schematic = m_frame->Schematic();
107 return new PANEL_SETUP_NETCLASSES( aParent, m_frame,
110 true );
111 }, _( "Net Classes" ) );
112
113 m_busesPage = m_treebook->GetPageCount();
115 [this]( wxWindow* aParent ) -> wxWindow*
116 {
117 return new PANEL_SETUP_BUSES( aParent, m_frame );
118 }, _( "Bus Alias Definitions" ) );
119
120 m_textVarsPage = m_treebook->GetPageCount();
122 [this]( wxWindow* aParent ) -> wxWindow*
123 {
124 return new PANEL_TEXT_VARIABLES( aParent, &Prj() );
125 }, _( "Text Variables" ) );
126
127
128 m_treebook->AddPage( new wxPanel( GetTreebook() ), _( "Schematic Data" ) );
129
130 m_embeddedFilesPage = m_treebook->GetPageCount();
132 [this]( wxWindow* aParent ) -> wxWindow*
133 {
134 return new PANEL_EMBEDDED_FILES( aParent, &m_frame->Schematic() );
135 }, _( "Embedded Files" ) );
136
137 for( size_t i = 0; i < m_treebook->GetPageCount(); ++i )
138 m_treebook->ExpandNode( i );
139
140 SetEvtHandlerEnabled( true );
141
143
144 if( Prj().IsReadOnly() )
145 {
146 m_infoBar->ShowMessage( _( "Project is missing or read-only. Settings will not be "
147 "editable." ), wxICON_WARNING );
148 }
149
150 wxBookCtrlEvent evt( wxEVT_TREEBOOK_PAGE_CHANGED, wxID_ANY, 0 );
151
152 wxQueueEvent( m_treebook, evt.Clone() );
153}
154
155
157{
158}
159
160
161void DIALOG_SCHEMATIC_SETUP::onPageChanged( wxBookCtrlEvent& aEvent )
162{
164
165 int page = aEvent.GetSelection();
166
167 if( Prj().IsReadOnly() )
168 KIUI::Disable( m_treebook->GetPage( page ) );
169}
170
171
172void DIALOG_SCHEMATIC_SETUP::onAuxiliaryAction( wxCommandEvent& event )
173{
174 DIALOG_SCH_IMPORT_SETTINGS importDlg( this, m_frame );
175
176 if( importDlg.ShowModal() == wxID_CANCEL )
177 return;
178
179 wxFileName projectFn( importDlg.GetFilePath() );
180 bool alreadyLoaded = false;
181
182 if( m_frame->GetSettingsManager()->GetProject( projectFn.GetFullPath() ) )
183 {
184 alreadyLoaded = true;
185 }
186 else if( !m_frame->GetSettingsManager()->LoadProject( projectFn.GetFullPath(), false ) )
187 {
188 wxString msg = wxString::Format( _( "Error importing settings from project:\n"
189 "Project file %s could not be loaded." ),
190 projectFn.GetFullPath() );
191 DisplayErrorMessage( this, msg );
192
193 return;
194 }
195
196 PROJECT* otherPrj = m_frame->GetSettingsManager()->GetProject( projectFn.GetFullPath() );
197 SCHEMATIC otherSch( otherPrj );
198 PROJECT_FILE& file = otherPrj->GetProjectFile();
199
200 wxASSERT( file.m_SchematicSettings );
201
203
204 if( importDlg.m_FormattingOpt->GetValue() )
205 {
207 ->ImportSettingsFrom( *file.m_SchematicSettings );
208 }
209
210 if( importDlg.m_FieldNameTemplatesOpt->GetValue() )
211 {
213 ->ImportSettingsFrom( &otherSch.Settings().m_TemplateFieldNames );
214 }
215
216 if( importDlg.m_PinMapOpt->GetValue() )
217 {
219 ->ImportSettingsFrom( file.m_ErcSettings->m_PinMap );
220 }
221
222 if( importDlg.m_SeveritiesOpt->GetValue() )
223 {
225 ->ImportSettingsFrom( file.m_ErcSettings->m_ERCSeverities );
226 }
227
228 if( importDlg.m_NetClassesOpt->GetValue() )
229 {
231 ->ImportSettingsFrom( file.m_NetSettings );
232 }
233
234 if( importDlg.m_BomPresetsOpt->GetValue() )
235 {
237 ->ImportBomPresetsFrom( *file.m_SchematicSettings );
238 }
239
240 if( importDlg.m_BomFmtPresetsOpt->GetValue() )
241 {
243 ->ImportBomFmtPresetsFrom( *file.m_SchematicSettings );
244 }
245
246 if( importDlg.m_BusAliasesOpt->GetValue() )
247 {
248 // The bus aliases are stored on individual sheets, so we have to load the whole
249 // schematic for this one.
250
251 wxFileName schematicFn( projectFn );
252 schematicFn.SetExt( FILEEXT::KiCadSchematicFileExtension );
253
254 wxString fullFileName = schematicFn.GetFullPath();
255 wxString msg;
256 IO_RELEASER<SCH_IO> pi( SCH_IO_MGR::FindPlugin( SCH_IO_MGR::SCH_KICAD ) );
257 WX_PROGRESS_REPORTER progressReporter( this, _( "Loading Bus Aliases" ), 1 );
258
259 pi->SetProgressReporter( &progressReporter );
260
261 try
262 {
263 wxBusyCursor busy;
264 otherSch.SetRoot( pi->LoadSchematicFile( fullFileName, &otherSch ) );
265
266 // Make ${SHEETNAME} work on the root sheet until we properly support
267 // naming the root sheet
268 otherSch.Root().SetName( _( "Root" ) );
269 }
270 catch( const FUTURE_FORMAT_ERROR& ffe )
271 {
272 msg.Printf( _( "Error fetching bus aliases. Could not load schematic '%s'." ),
273 fullFileName );
274 progressReporter.Hide();
275 DisplayErrorMessage( this, msg, ffe.Problem() );
276 }
277 catch( const IO_ERROR& ioe )
278 {
279 msg.Printf( _( "Error fetching bus aliases. Could not load schematic '%s'." ),
280 fullFileName );
281 progressReporter.Hide();
282 DisplayErrorMessage( this, msg, ioe.What() );
283 }
284
285 // This fixes a focus issue after the progress reporter is done on GTK. It shouldn't
286 // cause any issues on macOS and Windows. If it does, it will have to be conditionally
287 // compiled.
288 Raise();
289
291 ->ImportSettingsFrom( otherSch );
292 }
293
294 if( importDlg.m_TextVarsOpt->GetValue() )
295 {
297 ->ImportSettingsFrom( otherPrj );
298 }
299
300 if( !alreadyLoaded )
301 m_frame->GetSettingsManager()->UnloadProject( otherPrj, false );
302}
void onPageChanged(wxBookCtrlEvent &aEvent) override
DIALOG_SCHEMATIC_SETUP(SCH_EDIT_FRAME *aFrame)
std::shared_ptr< ERC_ITEM > m_pinToPinError
void onAuxiliaryAction(wxCommandEvent &aEvent) override
void finishDialogSettings()
In all dialogs, we must call the same functions to fix minimal dlg size, the default position and per...
SETTINGS_MANAGER * GetSettingsManager() const
static std::shared_ptr< ERC_ITEM > Create(int aErrorCode)
Constructs an ERC_ITEM for the given error code.
Definition: erc_item.cpp:298
static std::vector< std::reference_wrapper< RC_ITEM > > GetItemsWithSeverities()
Definition: erc_item.h:76
Container for ERC settings.
Definition: erc_settings.h:128
std::map< int, SEVERITY > m_ERCSeverities
Definition: erc_settings.h:187
PIN_ERROR m_PinMap[ELECTRICAL_PINTYPES_TOTAL][ELECTRICAL_PINTYPES_TOTAL]
Definition: erc_settings.h:191
Hold an error message and may be used when throwing exceptions containing meaningful error messages.
Definition: ki_exception.h:77
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:30
virtual const wxString Problem() const
what was the problem?
Definition: exceptions.cpp:46
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
bool LoadFromFile(const wxString &aDirectory="") override
Loads the JSON document from the parent and then calls Load()
WX_TREEBOOK * GetTreebook()
Definition: paged_dialog.h:39
WX_INFOBAR * m_infoBar
Definition: paged_dialog.h:72
WX_TREEBOOK * m_treebook
Definition: paged_dialog.h:68
virtual void onPageChanged(wxBookCtrlEvent &aEvent)
The backing store for a PROJECT, in JSON format.
Definition: project_file.h:71
ERC_SETTINGS * m_ErcSettings
Eeschema params.
Definition: project_file.h:133
SCHEMATIC_SETTINGS * m_SchematicSettings
Definition: project_file.h:136
std::shared_ptr< NET_SETTINGS > & NetSettings()
Definition: project_file.h:102
std::shared_ptr< NET_SETTINGS > m_NetSettings
Net settings for this project (owned here)
Definition: project_file.h:174
Container for project specific data.
Definition: project.h:63
virtual PROJECT_FILE & GetProjectFile() const
Definition: project.h:183
These are loaded from Eeschema settings but then overwritten by the project settings.
Holds all the data relating to one schematic.
Definition: schematic.h:76
SCHEMATIC_SETTINGS & Settings() const
Definition: schematic.cpp:297
void SetRoot(SCH_SHEET *aRootSheet)
Initialize the schematic with a new root sheet.
Definition: schematic.cpp:194
std::set< wxString > GetNetClassAssignmentCandidates()
Return the set of netname candidates for netclass assignment.
Definition: schematic.cpp:408
SCH_SHEET & Root() const
Definition: schematic.h:113
ERC_SETTINGS & ErcSettings() const
Definition: schematic.cpp:304
Schematic editor (Eeschema) main window.
SCHEMATIC & Schematic() const
void SetName(const wxString &aName)
Definition: sch_sheet.h:108
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.
bool UnloadProject(PROJECT *aProject, bool aSave=true)
Saves, unloads and unregisters the given PROJECT.
void ShowMessage(const wxString &aMessage, int aFlags=wxICON_INFORMATION) override
Show the info bar with the provided message and icon.
Definition: wx_infobar.cpp:154
Multi-thread safe progress reporter dialog, intended for use of tasks that parallel reporting back of...
wxWindow * ResolvePage(size_t aPage)
bool AddLazySubPage(std::function< wxWindow *(wxWindow *aParent)> aLazyCtor, const wxString &text, bool bSelect=false, int imageId=NO_IMAGE)
Definition: wx_treebook.cpp:96
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
Definition: confirm.cpp:195
This file is part of the common library.
#define _(s)
@ ERCE_PIN_TO_PIN_WARNING
Definition: erc_settings.h:97
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
KICOMMON_API void Disable(wxWindow *aWindow)
Makes a window read-only.
Definition: ui_common.cpp:323
Variant of PARSE_ERROR indicating that a syntax or related error was likely caused by a file generate...
Definition: ki_exception.h:176