KiCad PCB EDA Suite
Loading...
Searching...
No Matches
eeschema_config.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) 2014-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 <mutex>
21#include <wx/ffile.h>
22
23#include <symbol_library.h>
24#include <confirm.h>
26#include <kiway.h>
27#include <symbol_edit_frame.h>
29#include <filename_resolver.h>
30#include <pgm_base.h>
34#include <sch_edit_frame.h>
35#include <sch_painter.h>
36#include <schematic.h>
46#include <zoom_defines.h>
47#include <sim/spice_settings.h>
48#include <tool/tool_manager.h>
50
51
54{
55 return Pgm().GetSettingsManager().GetColorSettings()->GetColor( aLayer );
56}
57
58
60{
63
68
71
73
74 PROJECT_LOCAL_SETTINGS& localSettings = Prj().GetLocalSettings();
75
77 selTool->GetFilter() = localSettings.m_SchSelectionFilter;
79
80 return true;
81}
82
83
85{
86 // Load the drawing sheet from the filename stored in BASE_SCREEN::m_DrawingSheetFileName.
87 // If empty, or not existing, the default drawing sheet is loaded.
88
93
94 wxString filename = resolver.ResolvePath( settings.m_SchDrawingSheetFileName,
95 Prj().GetProjectPath(),
96 Schematic().GetEmbeddedFiles() );
97 wxString msg;
98
99 if( !DS_DATA_MODEL::GetTheInstance().LoadDrawingSheet( filename, &msg ) )
100 ShowInfoBarError( msg, true );
101}
102
103
104void SCH_EDIT_FRAME::ShowSchematicSetupDialog( const wxString& aInitialPage )
105{
106 static std::mutex dialogMutex; // Local static mutex
107
108 std::unique_lock<std::mutex> dialogLock( dialogMutex, std::try_to_lock );
109
110 // One dialog at a time.
111 if( !dialogLock.owns_lock() )
112 {
114 {
115 m_schematicSetupDialog->Raise(); // Brings the existing dialog to the front
116 }
117
118 return;
119 }
120
121 SCH_SCREENS screens( Schematic().Root() );
122 std::vector<std::shared_ptr<BUS_ALIAS>> oldAliases;
123
124 for( SCH_SCREEN* screen = screens.GetFirst(); screen != nullptr; screen = screens.GetNext() )
125 {
126 for( const std::shared_ptr<BUS_ALIAS>& alias : screen->GetBusAliases() )
127 oldAliases.push_back( alias );
128 }
129
130 DIALOG_SCHEMATIC_SETUP dlg( this );
131
132 if( !aInitialPage.IsEmpty() )
133 dlg.SetInitialPage( aInitialPage, wxEmptyString );
134
135 // Assign dlg to the m_schematicSetupDialog pointer to track its status.
137
138 // TODO: is QuasiModal required here?
139 if( dlg.ShowQuasiModal() == wxID_OK )
140 {
141 // Mark document as modified so that project settings can be saved as part of doc save
142 OnModify();
143
144 Kiway().CommonSettingsChanged( false, true );
145
149
150 GetRenderSettings()->SetDefaultPenWidth( Schematic().Settings().m_DefaultLineWidth );
154
155 GetRenderSettings()->SetDashLengthRatio( Schematic().Settings().m_DashedLineDashRatio );
156 GetRenderSettings()->SetGapLengthRatio( Schematic().Settings().m_DashedLineGapRatio );
157
160
161 std::vector<std::shared_ptr<BUS_ALIAS>> newAliases;
162
163 for( SCH_SCREEN* screen = screens.GetFirst(); screen != nullptr; screen = screens.GetNext() )
164 {
165 for( const std::shared_ptr<BUS_ALIAS>& alias : screen->GetBusAliases() )
166 newAliases.push_back( alias );
167 }
168
169 if( oldAliases != newAliases )
171
173 GetCanvas()->Refresh();
174 }
175
176 // Reset m_schematicSetupDialog after the dialog is closed
177 m_schematicSetupDialog = nullptr;
178}
179
180
182{
183 std::vector<double>& sizeMultipliers = eeconfig()->m_Drawing.junction_size_mult_list;
184
185 const std::shared_ptr<NET_SETTINGS>& netSettings = Prj().GetProjectFile().NetSettings();
186 int sizeChoice = Schematic().Settings().m_JunctionSizeChoice;
187 int dotSize = netSettings->GetDefaultNetclass()->GetWireWidth() * sizeMultipliers[sizeChoice];
188
189 return std::max( dotSize, 1 );
190}
191
192
194{
195 wxFileName fn = Schematic().RootScreen()->GetFileName(); //ConfigFileName
196
198
199 if( !fn.HasName() || !IsWritable( fn, false ) )
200 return;
201
203
204 if( Kiway().Player( FRAME_SIMULATOR, false ) )
206
207 // Save the page layout file if doesn't exist yet (e.g. if we opened a non-kicad schematic)
208
209 // TODO: We need to remove dependence on BASE_SCREEN
212
214 {
215 FILENAME_RESOLVER resolve;
216 resolve.SetProject( &Prj() );
217 resolve.SetProgramBase( &Pgm() );
218
219 wxFileName layoutfn( resolve.ResolvePath( BASE_SCREEN::m_DrawingSheetFileName,
220 Prj().GetProjectPath(),
221 Schematic().GetEmbeddedFiles() ) );
222
223 bool success = true;
224
225 if( !layoutfn.IsAbsolute() )
226 success = layoutfn.MakeAbsolute( Prj().GetProjectPath() );
227
228 if( success && layoutfn.IsOk() && !layoutfn.FileExists() && layoutfn.HasName() )
229 {
230 if( layoutfn.DirExists() && layoutfn.IsDirWritable() )
231 DS_DATA_MODEL::GetTheInstance().Save( layoutfn.GetFullPath() );
232 }
233 }
234
235 GetSettingsManager()->SaveProject( fn.GetFullPath() );
236}
237
238
240{
241 if( m_schematic )
243
244 PROJECT_LOCAL_SETTINGS& localSettings = Prj().GetLocalSettings();
246
247 localSettings.m_SchSelectionFilter = selTool->GetFilter();
248}
249
250
252{
253 // For now, axes are forced off in Eeschema even if turned on in config
255 cfg->m_Window.grid.axes_enabled = false;
256
258
259 SCH_SEARCH_DATA* searchData = dynamic_cast<SCH_SEARCH_DATA*>( m_findReplaceData.get() );
260
261 if( searchData )
262 {
268 }
269
271
276}
277
278
280{
283 wxAuiPaneInfo& hierarchy_pane = m_auimgr.GetPane( SchematicHierarchyPaneName() );
284
285 if( cfg )
286 {
287 cfg->m_System.units = static_cast<int>( GetUserUnits() );
288 cfg->m_AuiPanels.show_schematic_hierarchy = hierarchy_pane.IsShown();
289 cfg->m_AuiPanels.schematic_hierarchy_float = hierarchy_pane.IsFloating();
290
291 // Other parameters (hierarchy_panel_float_width, hierarchy_panel_float_height,
292 // and hierarchy_panel_docked_width should have been updated when resizing the
293 // hierarchy panel
294
295 SCH_SEARCH_DATA* searchData = dynamic_cast<SCH_SEARCH_DATA*>( m_findReplaceData.get() );
296
297 if( searchData )
298 {
303 searchData->searchCurrentSheetOnly;
305 }
306
307 wxAuiPaneInfo& searchPaneInfo = m_auimgr.GetPane( SearchPaneName() );
308 m_show_search = searchPaneInfo.IsShown();
310 cfg->m_AuiPanels.search_panel_height = m_searchPane->GetSize().y;
311 cfg->m_AuiPanels.search_panel_width = m_searchPane->GetSize().x;
312 cfg->m_AuiPanels.search_panel_dock_direction = searchPaneInfo.dock_direction;
313
314 wxAuiPaneInfo& propertiesPane = m_auimgr.GetPane( PropertiesPaneName() );
315 cfg->m_AuiPanels.show_properties = propertiesPane.IsShown();
318
319 wxAuiPaneInfo& netNavigatorPane = m_auimgr.GetPane( NetNavigatorPaneName() );
320 cfg->m_AuiPanels.show_net_nav_panel = netNavigatorPane.IsShown();
321 cfg->m_AuiPanels.float_net_nav_panel = netNavigatorPane.IsFloating();
322
323 if( netNavigatorPane.IsDocked() )
325 else
326 {
327 cfg->m_AuiPanels.net_nav_panel_float_pos = netNavigatorPane.floating_pos;
328 cfg->m_AuiPanels.net_nav_panel_float_size = netNavigatorPane.floating_size;
329 }
330
331 wxAuiPaneInfo& designBlocksPane = m_auimgr.GetPane( DesignBlocksPaneName() );
332 cfg->m_AuiPanels.design_blocks_show = designBlocksPane.IsShown();
333
334 if( designBlocksPane.IsDocked() )
336 else
337 {
338 cfg->m_AuiPanels.design_blocks_panel_float_height = designBlocksPane.floating_size.y;
339 cfg->m_AuiPanels.design_blocks_panel_float_width = designBlocksPane.floating_size.x;
340 }
341 }
342}
343
344
346{
347 wxCHECK_RET( aCfg, "Call to SCH_BASE_FRAME::LoadSettings with null settings" );
348
350
351 if( aCfg->m_Window.grid.grids.empty() )
352 aCfg->m_Window.grid.grids = aCfg->DefaultGridSizeList();
353
354 // Move legacy user grids to grid list
355 if( !aCfg->m_Window.grid.user_grid_x.empty() )
356 {
357 aCfg->m_Window.grid.grids.emplace_back( GRID{ "User Grid", aCfg->m_Window.grid.user_grid_x,
358 aCfg->m_Window.grid.user_grid_y } );
359 aCfg->m_Window.grid.user_grid_x = wxEmptyString;
360 aCfg->m_Window.grid.user_grid_y = wxEmptyString;
361 }
362
363 if( aCfg->m_Window.grid.last_size_idx > (int) aCfg->m_Window.grid.grids.size() )
364 aCfg->m_Window.grid.last_size_idx = 1;
365
366 if( aCfg->m_Window.grid.fast_grid_1 > (int) aCfg->m_Window.grid.grids.size() )
367 aCfg->m_Window.grid.fast_grid_1 = 1;
368
369 if( aCfg->m_Window.grid.fast_grid_2 > (int) aCfg->m_Window.grid.grids.size() )
370 aCfg->m_Window.grid.fast_grid_2 = 2;
371
372 if( aCfg->m_Window.zoom_factors.empty() )
373 {
375 }
376}
377
378
380{
381 wxCHECK_RET( aCfg, wxS( "Call to SCH_BASE_FRAME::SaveSettings with null settings" ) );
382
384}
APP_SETTINGS_BASE is a settings class that should be derived for each standalone KiCad application.
Definition: app_settings.h:92
WINDOW_SETTINGS m_Window
Definition: app_settings.h:186
const std::vector< GRID > DefaultGridSizeList() const
static wxString m_DrawingSheetFileName
the name of the drawing sheet file, or empty to use the default drawing sheet
Definition: base_screen.h:85
COLOR4D GetColor(int aLayer) const
int ShowQuasiModal()
static DS_DATA_MODEL & GetTheInstance()
static function: returns the instance of DS_DATA_MODEL used in the application
void Save(const wxString &aFullFileName)
Save the description in a file.
SETTINGS_MANAGER * GetSettingsManager() const
wxAuiManager m_auimgr
bool IsWritable(const wxFileName &aFileName, bool aVerbose=true)
Checks if aFileName can be written.
void ShowInfoBarError(const wxString &aErrorMsg, bool aShowCloseButton=false, WX_INFOBAR::MESSAGE_TYPE aType=WX_INFOBAR::MESSAGE_TYPE::GENERIC)
Show the WX_INFOBAR displayed on the top of the canvas with a message and an error icon on the left o...
void SaveSettings(APP_SETTINGS_BASE *aCfg) override
Save common frame parameters to a configuration data file.
void LoadSettings(APP_SETTINGS_BASE *aCfg) override
Load common frame parameters from a configuration file.
static const wxString PropertiesPaneName()
SEARCH_PANE * m_searchPane
static const wxString DesignBlocksPaneName()
std::unique_ptr< EDA_SEARCH_DATA > m_findReplaceData
PROPERTIES_PANEL * m_propertiesPanel
virtual void Refresh(bool aEraseBackground=true, const wxRect *aRect=nullptr) override
FIND_REPLACE_EXTRA m_FindReplaceExtra
SCH_SELECTION_FILTER_OPTIONS & GetFilter()
Provide an extensible class to resolve 3D model paths.
bool SetProject(PROJECT *aProject, bool *flgChanged=nullptr)
Set the current KiCad project directory as the first entry in the model path list.
void SetProgramBase(PGM_BASE *aBase)
Set a pointer to the application's PGM_BASE instance used to extract the local env vars.
wxString ResolvePath(const wxString &aFileName, const wxString &aWorkingPath, const EMBEDDED_FILES *aFiles)
Determines the full path of the given file name.
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:104
void SetDefaultPenWidth(int aWidth)
void SetDefaultFont(const wxString &aFont)
void SetGapLengthRatio(double aRatio)
void SetDashLengthRatio(double aRatio)
void UpdateAllItems(int aUpdateFlags)
Update all items in the view according to the given flags.
Definition: view.cpp:1545
void MarkDirty()
Force redraw of view on the next rendering.
Definition: view.h:656
virtual void CommonSettingsChanged(bool aEnvVarsChanged, bool aTextVarsChanged)
Call CommonSettingsChanged() on all KIWAY_PLAYERs.
Definition: kiway.cpp:617
void SetInitialPage(const wxString &aPage, const wxString &aParentPage=wxEmptyString)
void SetCheckboxesFromFilter(SCH_SELECTION_FILTER_OPTIONS &aOptions)
virtual SETTINGS_MANAGER & GetSettingsManager() const
Definition: pgm_base.h:142
SCHEMATIC_SETTINGS * m_SchematicSettings
Definition: project_file.h:140
std::shared_ptr< NET_SETTINGS > & NetSettings()
Definition: project_file.h:103
The project local settings are things that are attached to a particular project, but also might be pa...
SCH_SELECTION_FILTER_OPTIONS m_SchSelectionFilter
virtual PROJECT_LOCAL_SETTINGS & GetLocalSettings() const
Definition: project.h:206
void IncrementNetclassesTicker()
Definition: project.h:118
virtual PROJECT_FILE & GetProjectFile() const
Definition: project.h:200
void IncrementTextVarsTicker()
Definition: project.h:115
float SplitterProportion() const
These are loaded from Eeschema settings but then overwritten by the project settings.
wxString m_SchDrawingSheetFileName
std::shared_ptr< NGSPICE_SETTINGS > m_NgspiceSettings
Ngspice simulator settings.
SCHEMATIC_SETTINGS & Settings() const
Definition: schematic.cpp:314
void RecordERCExclusions()
Scan existing markers and record data from any that are Excluded.
Definition: schematic.cpp:817
SCH_SCREEN * RootScreen() const
Helper to retrieve the screen of the root sheet.
Definition: schematic.cpp:208
SCH_RENDER_SETTINGS * GetRenderSettings()
void SaveSettings(APP_SETTINGS_BASE *aCfg) override
Save common frame parameters to a configuration data file.
void LoadSettings(APP_SETTINGS_BASE *aCfg) override
Load common frame parameters from a configuration file.
SCH_DRAW_PANEL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
EESCHEMA_SETTINGS * eeconfig() const
PANEL_SCH_SELECTION_FILTER * m_selectionFilterPanel
KIGFX::SCH_VIEW * GetView() const override
Return a pointer to the #VIEW instance used in the panel.
void ShowSchematicSetupDialog(const wxString &aInitialPage=wxEmptyString)
void RefreshOperatingPointDisplay()
Refresh the display of any operaintg points.
wxTreeCtrl * m_netNavigator
void OnModify() override
Must be called after a schematic change in order to set the "modify" flag and update other data struc...
void SaveProjectLocalSettings() override
Save changes to the project settings to the project (.pro) file.
DIALOG_SCHEMATIC_SETUP * m_schematicSetupDialog
SCHEMATIC * m_schematic
The currently loaded schematic.
SCHEMATIC & Schematic() const
bool LoadProjectSettings()
Load the KiCad project file (*.pro) settings specific to Eeschema.
void LoadSettings(APP_SETTINGS_BASE *aCfg) override
Load common frame parameters from a configuration file.
static const wxString SearchPaneName()
void LoadDrawingSheet()
Load the drawing sheet file.
void SaveSettings(APP_SETTINGS_BASE *aCfg) override
Save common frame parameters to a configuration data file.
void RecalculateConnections(SCH_COMMIT *aCommit, SCH_CLEANUP_FLAGS aCleanupFlags)
Generate the connection data for the entire schematic hierarchy.
static const wxString SchematicHierarchyPaneName()
int GetSchematicJunctionSize()
DESIGN_BLOCK_PANE * m_designBlocksPane
static const wxString NetNavigatorPaneName()
void saveProjectSettings() override
Saves any design-related project settings associated with this frame.
Container class that holds multiple SCH_SCREEN objects in a hierarchy.
Definition: sch_screen.h:712
SCH_SCREEN * GetNext()
SCH_SCREEN * GetFirst()
const wxString & GetFileName() const
Definition: sch_screen.h:143
COLOR_SETTINGS * GetColorSettings(const wxString &aName="user")
Retrieves a color settings object that applications can read colors from.
bool SaveProject(const wxString &aFullPath=wxEmptyString, PROJECT *aProject=nullptr)
Saves a loaded project.
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
Definition: tools_holder.h:55
This file is part of the common library.
COLOR4D GetLayerColor(SCH_LAYER_ID aLayer)
Helper for all the old plotting/printing code while it still exists.
static FILENAME_RESOLVER * resolver
Definition: export_idf.cpp:53
@ FRAME_SIMULATOR
Definition: frame_type.h:38
static const std::string ProjectFileExtension
PROJECT & Prj()
Definition: kicad.cpp:597
SCH_LAYER_ID
Eeschema drawing layers.
Definition: layer_ids.h:353
@ REPAINT
Item needs to be redrawn.
Definition: view_item.h:57
int GetUserUnits()
Return the currently selected user unit value for the interface.
PGM_BASE & Pgm()
The global Program "get" accessor.
Definition: pgm_base.cpp:1060
see class PGM_BASE
@ GLOBAL_CLEANUP
KIWAY Kiway(KFCTL_STANDALONE)
std::vector< double > junction_size_mult_list
wxString user_grid_x
Definition: grid_settings.h:67
std::vector< GRID > grids
Definition: grid_settings.h:66
wxString user_grid_y
Definition: grid_settings.h:68
Common grid settings, available to every frame.
Definition: grid_settings.h:34
GRID_SETTINGS grid
Definition: app_settings.h:81
std::vector< double > zoom_factors
Definition: app_settings.h:78
Definition for symbol library class.
Definition of file extensions used in Kicad.
#define ZOOM_LIST_EESCHEMA
Definition: zoom_defines.h:41