KiCad PCB EDA Suite
Loading...
Searching...
No Matches
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 The 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
24#include <json_common.h>
25
27#include <settings/parameters.h>
30#include <default_values.h>
31
32
35
36
38 APP_SETTINGS_BASE( "symbol_editor", libeditSchemaVersion ),
39 m_Defaults(),
40 m_Repeat(),
43 m_LibWidth(),
45{
46 // Make Coverity happy
48
49 // Init settings:
50 SetLegacyFilename( wxS( "eeschema" ) );
51
52 m_params.emplace_back( new PARAM<bool>( "aui.show_properties",
53 &m_AuiPanels.show_properties, true ) );
54
55 m_params.emplace_back( new PARAM<int>( "aui.properties_panel_width",
56 &m_AuiPanels.properties_panel_width, -1 ) );
57
58 m_params.emplace_back( new PARAM<float>( "aui.properties_splitter_proportion",
59 &m_AuiPanels.properties_splitter, 0.5f ) );
60
61 m_params.emplace_back( new PARAM<int>( "defaults.line_width",
62 &m_Defaults.line_width, 0 ) );
63
64 m_params.emplace_back( new PARAM<int>( "defaults.text_size",
65 &m_Defaults.text_size, DEFAULT_TEXT_SIZE ) );
66
67 m_params.emplace_back( new PARAM<int>( "defaults.pin_length",
68 &m_Defaults.pin_length, DEFAULT_PIN_LENGTH ) );
69
70 m_params.emplace_back( new PARAM<int>( "defaults.pin_name_size",
71 &m_Defaults.pin_name_size, DEFAULT_PINNAME_SIZE ) );
72
73 m_params.emplace_back( new PARAM<int>( "defaults.pin_num_size",
74 &m_Defaults.pin_num_size, DEFAULT_PINNUM_SIZE ) );
75
76 m_params.emplace_back( new PARAM<int>( "repeat.label_delta",
77 &m_Repeat.label_delta, 1 ) );
78
79 m_params.emplace_back( new PARAM<int>( "repeat.pin_step",
80 &m_Repeat.pin_step, 100 ) );
81
82 m_params.emplace_back( new PARAM<bool>( "import_graphics.interactive_placement",
83 &m_ImportGraphics.interactive_placement, true ) );
84
85 m_params.emplace_back( new PARAM<int>( "import_graphics.line_width_units",
86 &m_ImportGraphics.dxf_line_width_units, 0 ) );
87
88 m_params.emplace_back( new PARAM<double>( "import_graphics.line_width",
89 &m_ImportGraphics.dxf_line_width, 0.2 ) );
90
91 m_params.emplace_back( new PARAM<int>( "import_graphics.origin_units",
92 &m_ImportGraphics.origin_units, 0 ) );
93
94 m_params.emplace_back( new PARAM<double>( "import_graphics.origin_x",
95 &m_ImportGraphics.origin_x, 0 ) );
96
97 m_params.emplace_back( new PARAM<double>( "import_graphics.origin_y",
98 &m_ImportGraphics.origin_y, 0 ) );
99
100 m_params.emplace_back( new PARAM<int>( "import_graphics.dxf_units",
101 &m_ImportGraphics.dxf_units, 0 ) );
102
103 m_params.emplace_back( new PARAM<bool>( "show_pin_electrical_type",
104 &m_ShowPinElectricalType, true ) );
105
106 m_params.emplace_back( new PARAM<bool>( "show_pin_alt_icons",
107 &m_ShowPinAltIcons, true ) );
108
109 m_params.emplace_back( new PARAM<bool>( "show_hidden_lib_fields",
110 &m_ShowHiddenFields, true ) );
111
112 m_params.emplace_back( new PARAM<bool>( "show_hidden_lib_pins",
113 &m_ShowHiddenPins, true ) );
114
115 m_params.emplace_back( new PARAM<bool>( "drag_pins_along_with_edges",
116 &m_dragPinsAlongWithEdges, true ) );
117
118 m_params.emplace_back( new PARAM<int>( "lib_table_width",
119 &m_LibWidth, 250 ) );
120
121 m_params.emplace_back( new PARAM<int>( "library.sort_mode",
122 &m_LibrarySortMode, 0 ) );
123
124 m_params.emplace_back( new PARAM<wxString>( "edit_symbol_visible_columns",
125 &m_EditSymbolVisibleColumns, "0 1 2 3 4 5 6 7" ) );
126
127 m_params.emplace_back( new PARAM<wxString>( "pin_table_visible_columns",
128 &m_PinTableVisibleColumns, "0 1 2 3 4 5 9 10" ) );
129
130 m_params.emplace_back( new PARAM<bool>( "use_eeschema_color_settings",
132
133 m_params.emplace_back( new PARAM_MAP<int>( "lib_field_editor.field_widths",
134 &m_LibFieldEditor.field_widths, {} ) );
135
136 m_params.emplace_back( new PARAM<wxString>( "lib_field_editor.view_controls_visible_columns",
137 &m_LibFieldEditor.view_controls_visible_columns, "0 2 3" ) );
138
139 m_params.emplace_back( new PARAM<int>( "lib_field_editor.sash_pos",
140 &m_LibFieldEditor.sash_pos, 400 ) );
141
142 m_params.emplace_back( new PARAM<bool>( "lib_field_editor.sidebar_collapsed",
143 &m_LibFieldEditor.sidebar_collapsed, false ) );
144
145 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "selection_filter",
146 [&]() -> nlohmann::json
147 {
148 nlohmann::json ret;
149
150 ret["lockedItems"] = m_SelectionFilter.lockedItems;
151 ret["symbols"] = m_SelectionFilter.symbols;
152 ret["text"] = m_SelectionFilter.text;
153 ret["wires"] = m_SelectionFilter.wires;
154 ret["labels"] = m_SelectionFilter.labels;
155 ret["pins"] = m_SelectionFilter.pins;
156 ret["graphics"] = m_SelectionFilter.graphics;
157 ret["images"] = m_SelectionFilter.images;
158 ret["otherItems"] = m_SelectionFilter.otherItems;
159
160 return ret;
161 },
162 [&]( const nlohmann::json& aVal )
163 {
164 if( aVal.empty() || !aVal.is_object() )
165 return;
166
167 SetIfPresent( aVal, "lockedItems", m_SelectionFilter.lockedItems );
168 SetIfPresent( aVal, "symbols", m_SelectionFilter.symbols );
169 SetIfPresent( aVal, "text", m_SelectionFilter.text );
170 SetIfPresent( aVal, "wires", m_SelectionFilter.wires );
171 SetIfPresent( aVal, "labels", m_SelectionFilter.labels );
172 SetIfPresent( aVal, "pins", m_SelectionFilter.pins );
173 SetIfPresent( aVal, "graphics", m_SelectionFilter.graphics );
174 SetIfPresent( aVal, "images", m_SelectionFilter.images );
175 SetIfPresent( aVal, "otherItems", m_SelectionFilter.otherItems );
176 },
177 {
178 { "lockedItems", false },
179 { "symbols", true },
180 { "text", true },
181 { "wires", true },
182 { "labels", true },
183 { "pins", true },
184 { "graphics", true },
185 { "images", true },
186 { "otherItems", true }
187 } ) );
188
189 registerMigration( 0, 1,
190 [&]() -> bool
191 {
192 // This is actually a migration for APP_SETTINGS_BASE::m_LibTree
193 return migrateLibTreeWidth();
194 } );
195}
196
197
199{
200 bool ret = APP_SETTINGS_BASE::MigrateFromLegacy( aCfg );
201
202 // Now modify the loaded grid selection, because in earlier versions the grids index was shared
203 // between all applications and started at 1000 mils. There is a 4-position offset between
204 // this index and the possible eeschema grids list that we have to subtract.
205 std::string gridSizePtr = "window.grid.last_size";
206
207 if( std::optional<int> currentSize = Get<int>( gridSizePtr ) )
208 {
209 Set( gridSizePtr, *currentSize - 4 );
210 }
211 else
212 {
213 // Otherwise, default grid size should be 50 mils; index 1
214 Set( gridSizePtr, 1 );
215 }
216
217 ret &= fromLegacy<int>( aCfg, "DefaultWireWidth", "defaults.line_width" );
218 ret &= fromLegacy<int>( aCfg, "DefaultPinLength", "defaults.pin_length" );
219 ret &= fromLegacy<int>( aCfg, "LibeditPinNameSize", "defaults.pin_name_size" );
220 ret &= fromLegacy<int>( aCfg, "LibeditPinNumSize", "defaults.pin_num_size" );
221
222 ret &= fromLegacy<int>( aCfg, "LibeditRepeatLabelInc", "repeat.label_delta" );
223 ret &= fromLegacy<int>( aCfg, "LibeditPinRepeatStep", "repeat.pin_step" );
224 ret &= fromLegacy<int>( aCfg, "LibeditRepeatStepX", "repeat.x_step" );
225 ret &= fromLegacy<int>( aCfg, "LibeditRepeatStepY", "repeat.y_step" );
226
227 ret &= fromLegacy<int>( aCfg, "LibeditLibWidth", "lib_table_width" );
228 ret &= fromLegacy<bool>( aCfg, "LibeditShowPinElectricalType", "show_pin_electrical_type" );
229
230 ret &= fromLegacyString( aCfg, "LibEditFieldsShownColumns", "edit_symbol_visible_columns" );
231
232 ret &= fromLegacyString( aCfg, "PinTableShownColumns", "pin_table_visible_columns" );
233
234 return ret;
235}
APP_SETTINGS_BASE(const std::string &aFilename, int aSchemaVersion)
virtual bool MigrateFromLegacy(wxConfigBase *aCfg) override
Migrates from wxConfig to JSON-based configuration.
bool migrateLibTreeWidth()
Migrate 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.
bool fromLegacy(wxConfigBase *aConfig, const std::string &aKey, const std::string &aDest)
Translates a legacy wxConfig value to a given JSON pointer value.
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...
static bool SetIfPresent(const nlohmann::json &aObj, const std::string &aPath, wxString &aTarget)
Sets the given string if the given key/path is present.
std::optional< ValueType > Get(const std::string &aPath) const
Fetches a value from within the JSON document.
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 SetLegacyFilename(const wxString &aFilename)
Like a normal param, but with custom getter and setter functions.
Definition parameters.h:296
Represents a map of <std::string, Value>.
Definition parameters.h:735
virtual bool MigrateFromLegacy(wxConfigBase *aLegacyConfig) override
Migrates from wxConfig to JSON-based configuration.
PANEL_LIB_FIELDS_TABLE m_LibFieldEditor
DIALOG_IMPORT_GRAPHICS m_ImportGraphics
SCH_SELECTION_FILTER_OPTIONS m_SelectionFilter
bool m_ShowPinAltIcons
When true, dragging an outline edge will drag pins rooted on it.
#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