KiCad PCB EDA Suite
symbol_editor_settings.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-2021 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 2
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/old-licenses/gpl-2.0.html
19* or you may search the http://www.gnu.org website for the version 2 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
25#include <settings/parameters.h>
28#include <default_values.h>
29
30
33
34
36 APP_SETTINGS_BASE( "symbol_editor", libeditSchemaVersion ),
37 m_Defaults(),
38 m_Repeat(),
39 m_ShowPinElectricalType( true ),
40 m_LibWidth(),
41 m_EditSymbolVisibleColumns()
42{
43 // Make Coverity happy
45
46 // Init settings:
47 SetLegacyFilename( "eeschema" );
48
49 m_params.emplace_back( new PARAM<int>( "defaults.line_width",
50 &m_Defaults.line_width, 0 ) );
51
52 m_params.emplace_back( new PARAM<int>( "defaults.text_size",
54
55 m_params.emplace_back( new PARAM<int>( "defaults.pin_length",
57
58 m_params.emplace_back( new PARAM<int>( "defaults.pin_name_size",
60
61 m_params.emplace_back( new PARAM<int>( "defaults.pin_num_size",
63
64 m_params.emplace_back( new PARAM<int>( "repeat.label_delta",
65 &m_Repeat.label_delta, 1 ) );
66
67 m_params.emplace_back( new PARAM<int>( "repeat.pin_step",
68 &m_Repeat.pin_step, 100 ) );
69
70 m_params.emplace_back( new PARAM<bool>( "show_pin_electrical_type",
71 &m_ShowPinElectricalType, true ) );
72
73 m_params.emplace_back( new PARAM<int>( "lib_table_width",
74 &m_LibWidth, 250 ) );
75
76 m_params.emplace_back( new PARAM<wxString>( "edit_symbol_visible_columns",
77 &m_EditSymbolVisibleColumns, "0 1 2 3 4 5 6 7" ) );
78
79 m_params.emplace_back( new PARAM<wxString>( "pin_table_visible_columns",
80 &m_PinTableVisibleColumns, "0 1 2 3 4 5 9 10" ) );
81
82 m_params.emplace_back( new PARAM<bool>( "use_eeschema_color_settings",
84
86 [&]() -> bool
87 {
88 // This is actually a migration for APP_SETTINGS_BASE::m_LibTree
89 return migrateLibTreeWidth();
90 } );
91}
92
93
95{
96 bool ret = APP_SETTINGS_BASE::MigrateFromLegacy( aCfg );
97
98 // Now modify the loaded grid selection, because in earlier versions the grids index was shared
99 // between all applications and started at 1000 mils. There is a 4-position offset between
100 // this index and the possible eeschema grids list that we have to subtract.
101 std::string gridSizePtr = "window.grid.last_size";
102
103 if( std::optional<int> currentSize = Get<int>( gridSizePtr ) )
104 {
105 Set( gridSizePtr, *currentSize - 4 );
106 }
107 else
108 {
109 // Otherwise, default grid size should be 50 mils; index 1
110 Set( gridSizePtr, 1 );
111 }
112
113 ret &= fromLegacy<int>( aCfg, "DefaultWireWidth", "defaults.line_width" );
114 ret &= fromLegacy<int>( aCfg, "DefaultPinLength", "defaults.pin_length" );
115 ret &= fromLegacy<int>( aCfg, "LibeditPinNameSize", "defaults.pin_name_size" );
116 ret &= fromLegacy<int>( aCfg, "LibeditPinNumSize", "defaults.pin_num_size" );
117
118 ret &= fromLegacy<int>( aCfg, "LibeditRepeatLabelInc", "repeat.label_delta" );
119 ret &= fromLegacy<int>( aCfg, "LibeditPinRepeatStep", "repeat.pin_step" );
120 ret &= fromLegacy<int>( aCfg, "LibeditRepeatStepX", "repeat.x_step" );
121 ret &= fromLegacy<int>( aCfg, "LibeditRepeatStepY", "repeat.y_step" );
122
123 ret &= fromLegacy<int>( aCfg, "LibeditLibWidth", "lib_table_width" );
124 ret &= fromLegacy<bool>( aCfg, "LibeditShowPinElectricalType", "show_pin_electrical_type" );
125
126 ret &= fromLegacyString( aCfg, "LibEditFieldsShownColumns", "edit_symbol_visible_columns" );
127
128 ret &= fromLegacyString( aCfg, "PinTableShownColumns", "pin_table_visible_columns" );
129
130 return ret;
131}
APP_SETTINGS_BASE is a settings class that should be derived for each standalone KiCad application.
Definition: app_settings.h:101
virtual bool MigrateFromLegacy(wxConfigBase *aCfg) override
Migrates from wxConfig to JSON-based configuration.
bool migrateLibTreeWidth()
Migrates the library tree width setting from a single column (Item) to multi-column.
bool fromLegacyString(wxConfigBase *aConfig, const std::string &aKey, const std::string &aDest)
Translates a legacy wxConfig string value to a given JSON pointer value.
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)
void registerMigration(int aOldSchemaVersion, int aNewSchemaVersion, std::function< bool(void)> aMigrator)
Registers a migration from one schema version to another.
void Set(const std::string &aPath, ValueType aVal)
Stores a value into the JSON document Will throw an exception if ValueType isn't something that the l...
void SetLegacyFilename(const wxString &aFilename)
Definition: json_settings.h:82
virtual bool MigrateFromLegacy(wxConfigBase *aLegacyConfig) override
Migrates from wxConfig to JSON-based configuration.
#define DEFAULT_PINNUM_SIZE
The default pin name size when creating pins(can be changed in preference menu)
#define DEFAULT_PINNAME_SIZE
The default selection highlight thickness (can be changed in preference menu)
#define DEFAULT_PIN_LENGTH
The default pin number size when creating pins(can be changed in preference menu)
#define DEFAULT_TEXT_SIZE
Ratio of the font height to the baseline of the text above the wire.
const int libeditSchemaVersion
! Update the schema version whenever a migration is required