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 The 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>
30#include <panel_setup_pinmap.h>
31#include <erc/erc_item.h>
33#include <panel_bom_presets.h>
37#include <sch_io/sch_io.h>
42
43
45 PAGED_DIALOG( aFrame, _( "Schematic Setup" ), true, false,
46 _( "Import Settings from Another Project..." ), wxSize( 920, 460 ) ),
47 m_frame( aFrame )
48{
49 SetEvtHandlerEnabled( false );
50
52
53 /*
54 * WARNING: If you change page names you MUST update calls to ShowSchematicSetupDialog().
55 */
56
57 m_treebook->AddPage( new wxPanel( GetTreebook() ), _( "General" ) );
58
59 m_formattingPage = m_treebook->GetPageCount();
61 [this]( wxWindow* aParent ) -> wxWindow*
62 {
63 return new PANEL_SETUP_FORMATTING( aParent, m_frame );
64 }, _( "Formatting" ) );
65
66 m_annotationPage = m_treebook->GetPageCount();
68 [this]( wxWindow* aParent ) -> wxWindow*
69 {
70 return new PANEL_SETUP_ANNOTATION( aParent, m_frame );
71 }, _( "Annotation" ) );
72
73 m_fieldNameTemplatesPage = m_treebook->GetPageCount();
75 [this]( wxWindow* aParent ) -> wxWindow*
76 {
78 return new PANEL_TEMPLATE_FIELDNAMES( aParent, &settings.m_TemplateFieldNames );
79 }, _( "Field Name Templates" ) );
80
81 m_bomPresetsPage = m_treebook->GetPageCount();
83 [this]( wxWindow* aParent ) -> wxWindow*
84 {
86 return new PANEL_BOM_PRESETS( aParent, settings );
87 }, _( "BOM Presets" ) );
88
89
90 m_treebook->AddPage( new wxPanel( GetTreebook() ), _( "Electrical Rules" ) );
91
92 m_severitiesPage = m_treebook->GetPageCount();
94 [this]( wxWindow* aParent ) -> wxWindow*
95 {
96 ERC_SETTINGS& ercSettings = m_frame->Schematic().ErcSettings();
98 ercSettings.m_ERCSeverities, m_pinToPinError.get() );
99 }, _( "Violation Severity" ) );
100
101 m_pinMapPage = m_treebook->GetPageCount();
103 [this]( wxWindow* aParent ) -> wxWindow*
104 {
105 return new PANEL_SETUP_PINMAP( aParent, m_frame );
106 }, _( "Pin Conflicts Map" ) );
107
108 m_treebook->AddPage( new wxPanel( GetTreebook() ), _( "Project" ) );
109
110 m_netclassesPage = m_treebook->GetPageCount();
112 [this]( wxWindow* aParent ) -> wxWindow*
113 {
114 SCHEMATIC& schematic = m_frame->Schematic();
115 return new PANEL_SETUP_NETCLASSES( aParent, m_frame,
117 schematic.GetNetClassAssignmentCandidates(), true );
118 }, _( "Net Classes" ) );
119
120 m_busesPage = m_treebook->GetPageCount();
122 [this]( wxWindow* aParent ) -> wxWindow*
123 {
124 return new PANEL_SETUP_BUSES( aParent, m_frame );
125 }, _( "Bus Alias Definitions" ) );
126
127 m_textVarsPage = m_treebook->GetPageCount();
129 [this]( wxWindow* aParent ) -> wxWindow*
130 {
131 return new PANEL_TEXT_VARIABLES( aParent, &Prj() );
132 }, _( "Text Variables" ) );
133
134
135 m_treebook->AddPage( new wxPanel( GetTreebook() ), _( "Schematic Data" ) );
136
137 m_embeddedFilesPage = m_treebook->GetPageCount();
139 [this]( wxWindow* aParent ) -> wxWindow*
140 {
141 return new PANEL_EMBEDDED_FILES( aParent, &m_frame->Schematic() );
142 }, _( "Embedded Files" ) );
143
144 for( size_t i = 0; i < m_treebook->GetPageCount(); ++i )
145 m_treebook->ExpandNode( i );
146
147 SetEvtHandlerEnabled( true );
148
150
151 if( Prj().IsReadOnly() )
152 {
153 m_infoBar->ShowMessage( _( "Project is missing or read-only. Settings will not be editable." ),
154 wxICON_WARNING );
155 }
156
157 wxBookCtrlEvent evt( wxEVT_TREEBOOK_PAGE_CHANGED, wxID_ANY, 0 );
158
159 wxQueueEvent( m_treebook, evt.Clone() );
160}
161
162
163void DIALOG_SCHEMATIC_SETUP::onPageChanged( wxBookCtrlEvent& aEvent )
164{
166
167 int page = aEvent.GetSelection();
168
169 if( Prj().IsReadOnly() )
170 KIUI::Disable( m_treebook->GetPage( page ) );
171}
172
173
174void DIALOG_SCHEMATIC_SETUP::onAuxiliaryAction( wxCommandEvent& event )
175{
176 DIALOG_SCH_IMPORT_SETTINGS importDlg( this, m_frame );
177
178 if( importDlg.ShowModal() == wxID_CANCEL )
179 return;
180
181 wxFileName projectFn( importDlg.GetFilePath() );
182 bool alreadyLoaded = false;
183
184 if( m_frame->GetSettingsManager()->GetProject( projectFn.GetFullPath() ) )
185 {
186 alreadyLoaded = true;
187 }
188 else if( !m_frame->GetSettingsManager()->LoadProject( projectFn.GetFullPath(), false ) )
189 {
190 wxString msg = wxString::Format( _( "Error importing settings from project:\n"
191 "Project file %s could not be loaded." ),
192 projectFn.GetFullPath() );
193 DisplayErrorMessage( this, msg );
194
195 return;
196 }
197
198 PROJECT* otherPrj = m_frame->GetSettingsManager()->GetProject( projectFn.GetFullPath() );
199 SCHEMATIC otherSch( otherPrj );
200 PROJECT_FILE& file = otherPrj->GetProjectFile();
201
202 wxASSERT( file.m_SchematicSettings );
203
205
206 if( importDlg.m_FormattingOpt->GetValue() )
207 {
209 ->ImportSettingsFrom( *file.m_SchematicSettings );
210 }
211
212 if( importDlg.m_FieldNameTemplatesOpt->GetValue() )
213 {
215 ->ImportSettingsFrom( &otherSch.Settings().m_TemplateFieldNames );
216 }
217
218 if( importDlg.m_PinMapOpt->GetValue() )
219 {
221 ->ImportSettingsFrom( file.m_ErcSettings->m_PinMap );
222 }
223
224 if( importDlg.m_SeveritiesOpt->GetValue() )
225 {
227 ->ImportSettingsFrom( file.m_ErcSettings->m_ERCSeverities );
228 }
229
230 if( importDlg.m_NetClassesOpt->GetValue() )
231 {
233 ->ImportSettingsFrom( file.m_NetSettings );
234 }
235
236 if( importDlg.m_BomPresetsOpt->GetValue() )
237 {
239 ->ImportBomPresetsFrom( *file.m_SchematicSettings );
240 }
241
242 if( importDlg.m_BomFmtPresetsOpt->GetValue() )
243 {
245 ->ImportBomFmtPresetsFrom( *file.m_SchematicSettings );
246 }
247
248 if( importDlg.m_BusAliasesOpt->GetValue() )
249 {
250 // The bus aliases are stored on individual sheets, so we have to load the whole
251 // schematic for this one.
252
253 wxFileName schematicFn( projectFn );
254 schematicFn.SetExt( FILEEXT::KiCadSchematicFileExtension );
255
256 wxString fullFileName = schematicFn.GetFullPath();
257 wxString msg;
258 IO_RELEASER<SCH_IO> pi( SCH_IO_MGR::FindPlugin( SCH_IO_MGR::SCH_KICAD ) );
259 WX_PROGRESS_REPORTER progressReporter( this, _( "Load Bus Aliases" ), 1, PR_CAN_ABORT );
260
261 pi->SetProgressReporter( &progressReporter );
262
263 try
264 {
265 wxBusyCursor busy;
266 otherSch.SetRoot( pi->LoadSchematicFile( fullFileName, &otherSch ) );
267
268 // Make ${SHEETNAME} work on the root sheet until we properly support
269 // naming the root sheet
270 otherSch.Root().SetName( _( "Root" ) );
271 }
272 catch( const FUTURE_FORMAT_ERROR& ffe )
273 {
274 msg.Printf( _( "Error fetching bus aliases. Could not load schematic '%s'." ),
275 fullFileName );
276 progressReporter.Hide();
277 DisplayErrorMessage( this, msg, ffe.Problem() );
278 }
279 catch( const IO_ERROR& ioe )
280 {
281 msg.Printf( _( "Error fetching bus aliases. Could not load schematic '%s'." ),
282 fullFileName );
283 progressReporter.Hide();
284 DisplayErrorMessage( this, msg, ioe.What() );
285 }
286
287 // This fixes a focus issue after the progress reporter is done on GTK. It shouldn't
288 // cause any issues on macOS and Windows. If it does, it will have to be conditionally
289 // compiled.
290 Raise();
291
293 ->ImportSettingsFrom( otherSch );
294 }
295
296 if( importDlg.m_TextVarsOpt->GetValue() )
297 {
299 ->ImportSettingsFrom( otherPrj );
300 }
301
302 if( !alreadyLoaded )
303 m_frame->GetSettingsManager()->UnloadProject( otherPrj, false );
304}
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...
int ShowModal() override
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:302
static std::vector< std::reference_wrapper< RC_ITEM > > GetItemsWithSeverities()
Definition: erc_item.h:76
Container for ERC settings.
Definition: erc_settings.h:132
std::map< int, SEVERITY > m_ERCSeverities
Definition: erc_settings.h:209
PIN_ERROR m_PinMap[ELECTRICAL_PINTYPES_TOTAL][ELECTRICAL_PINTYPES_TOTAL]
Definition: erc_settings.h:213
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:68
ERC_SETTINGS * m_ErcSettings
Eeschema params.
Definition: project_file.h:148
SCHEMATIC_SETTINGS * m_SchematicSettings
Definition: project_file.h:151
std::shared_ptr< NET_SETTINGS > & NetSettings()
Definition: project_file.h:99
std::shared_ptr< NET_SETTINGS > m_NetSettings
Net settings for this project (owned here)
Definition: project_file.h:189
Container for project specific data.
Definition: project.h:65
virtual PROJECT_FILE & GetProjectFile() const
Definition: project.h:204
These are loaded from Eeschema settings but then overwritten by the project settings.
TEMPLATES m_TemplateFieldNames
Holds all the data relating to one schematic.
Definition: schematic.h:88
SCHEMATIC_SETTINGS & Settings() const
Definition: schematic.cpp:356
void SetRoot(SCH_SHEET *aRootSheet)
Initialize the schematic with a new root sheet.
Definition: schematic.cpp:238
std::set< wxString > GetNetClassAssignmentCandidates()
Return the set of netname candidates for netclass assignment.
Definition: schematic.cpp:467
SCH_SHEET & Root() const
Definition: schematic.h:140
ERC_SETTINGS & ErcSettings() const
Definition: schematic.cpp:363
Schematic editor (Eeschema) main window.
SCHEMATIC & Schematic() const
void SetName(const wxString &aName)
Definition: sch_sheet.h:114
bool LoadProject(const wxString &aFullPath, bool aSetActive=true)
Load a project or sets up a new project with a specified path.
PROJECT * GetProject(const wxString &aFullPath) const
Retrieve a loaded project by name.
bool UnloadProject(PROJECT *aProject, bool aSave=true)
Save, unload and unregister 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:156
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:194
This file is part of the common library.
#define _(s)
@ ERCE_PIN_TO_PIN_WARNING
Definition: erc_settings.h:94
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:332
Variant of PARSE_ERROR indicating that a syntax or related error was likely caused by a file generate...
Definition: ki_exception.h:176
#define PR_CAN_ABORT