KiCad PCB EDA Suite
PROJECT_LOCAL_SETTINGS Class Reference

The project local settings are things that are attached to a particular project, but also might be particular to a certain user editing that project, or change quickly, and therefore may not want to be checked in to version control or otherwise distributed with the main project. More...

#include <project_local_settings.h>

Inheritance diagram for PROJECT_LOCAL_SETTINGS:
JSON_SETTINGS

Public Member Functions

 PROJECT_LOCAL_SETTINGS (PROJECT *aProject, const wxString &aFilename)
 
virtual ~PROJECT_LOCAL_SETTINGS ()
 
bool MigrateFromLegacy (wxConfigBase *aLegacyConfig) override
 Migrates from wxConfig to JSON-based configuration. More...
 
bool SaveAs (const wxString &aDirectory, const wxString &aFile)
 
bool SaveToFile (const wxString &aDirectory="", bool aForce=false) override
 
void SetProject (PROJECT *aProject)
 
void SaveFileState (const wxString &aFileName, const WINDOW_SETTINGS *aWindowCfg, bool aOpen)
 
const PROJECT_FILE_STATEGetFileState (const wxString &aFileName)
 
void ClearFileState ()
 
wxString GetFilename () const
 
wxString GetFullFilename () const
 
void SetFilename (const wxString &aFilename)
 
void SetLocation (SETTINGS_LOC aLocation)
 
SETTINGS_LOC GetLocation () const
 
void SetLegacyFilename (const wxString &aFilename)
 
bool IsReadOnly () const
 
void SetReadOnly (bool aReadOnly)
 
nlohmann::jsonAt (const std::string &aPath)
 Wrappers for the underlying JSON API so that most consumers don't need json.hpp All of these functions take a string that is passed to PointerFromString internally. More...
 
bool Contains (const std::string &aPath) const
 
JSON_SETTINGS_INTERNALSInternals ()
 
virtual void Load ()
 Updates the parameters of this object based on the current JSON document contents. More...
 
virtual bool Store ()
 Stores the current parameters into the JSON document represented by this object Note: this doesn't do any writing to disk; that's handled by SETTINGS_MANAGER. More...
 
virtual bool LoadFromFile (const wxString &aDirectory="")
 Loads the backing file from disk and then calls Load() More...
 
void ResetToDefaults ()
 Resets all parameters to default values. More...
 
std::optional< nlohmann::jsonGetJson (const std::string &aPath) const
 Fetches a JSON object that is a subset of this JSON_SETTINGS object, using a path of the form "key1.key2.key3" to refer to nested objects. More...
 
template<typename ValueType >
std::optional< ValueType > Get (const std::string &aPath) const
 Fetches a value from within the JSON document. More...
 
template<>
std::optional< wxString > Get (const std::string &aPath) const
 
template<typename ValueType >
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 library can handle. More...
 
template<>
void Set (const std::string &aPath, wxString aVal)
 
template<>
void Set (const std::string &aPath, wxString aVal)
 
bool Migrate ()
 Migrates the schema of this settings from the version in the file to the latest version. More...
 
void AddNestedSettings (NESTED_SETTINGS *aSettings)
 Transfers ownership of a given NESTED_SETTINGS to this object. More...
 
void ReleaseNestedSettings (NESTED_SETTINGS *aSettings)
 Saves and frees a nested settings object, if it exists within this one. More...
 
void SetManager (SETTINGS_MANAGER *aManager)
 
const std::string FormatAsString () const
 
bool LoadFromRawFile (const wxString &aPath)
 

Static Public Member Functions

static bool SetIfPresent (const nlohmann::json &aObj, const std::string &aPath, wxString &aTarget)
 Sets the given string if the given key/path is present. More...
 
static bool SetIfPresent (const nlohmann::json &aObj, const std::string &aPath, bool &aTarget)
 Sets the given bool if the given key/path is present. More...
 
static bool SetIfPresent (const nlohmann::json &aObj, const std::string &aPath, int &aTarget)
 Sets the given int if the given key/path is present. More...
 
static bool SetIfPresent (const nlohmann::json &aObj, const std::string &aPath, unsigned int &aTarget)
 Sets the given unsigned int if the given key/path is present. More...
 

Public Attributes

std::vector< PROJECT_FILE_STATEm_files
 Project scope. More...
 
LSET m_VisibleLayers
 Board settings. More...
 
GAL_SET m_VisibleItems
 The GAL layers (aka items) that are turned on for viewing (. More...
 
PCB_LAYER_ID m_ActiveLayer
 The current (active) board layer for editing. More...
 
wxString m_ActiveLayerPreset
 The name of a LAYER_PRESET that is currently activated (or blank if none) More...
 
HIGH_CONTRAST_MODE m_ContrastModeDisplay
 The current contrast mode. More...
 
NET_COLOR_MODE m_NetColorMode
 The current net color mode. More...
 
bool m_AutoTrackWidth
 The current setting for whether to automatically adjust track widths to match. More...
 
ZONE_DISPLAY_MODE m_ZoneDisplayMode
 How zones are drawn. More...
 
double m_TrackOpacity
 Opacity override for all tracks. More...
 
double m_ViaOpacity
 Opacity override for all types of via. More...
 
double m_PadOpacity
 Opacity override for SMD pads and PTH. More...
 
double m_ZoneOpacity
 Opacity override for filled zones. More...
 
double m_ImageOpacity
 Opacity override for user images. More...
 
std::vector< wxString > m_HiddenNets
 A list of netnames that have been manually hidden in the board editor. More...
 
std::set< wxString > m_HiddenNetclasses
 
SELECTION_FILTER_OPTIONS m_SelectionFilter
 State of the selection filter widget. More...
 

Protected Member Functions

wxString getFileExt () const override
 
wxString getLegacyFileExt () const override
 
void registerMigration (int aOldSchemaVersion, int aNewSchemaVersion, std::function< bool(void)> aMigrator)
 Registers a migration from one schema version to another. More...
 
template<typename ValueType >
bool fromLegacy (wxConfigBase *aConfig, const std::string &aKey, const std::string &aDest)
 Translates a legacy wxConfig value to a given JSON pointer value. More...
 
bool fromLegacyString (wxConfigBase *aConfig, const std::string &aKey, const std::string &aDest)
 Translates a legacy wxConfig string value to a given JSON pointer value. More...
 
bool fromLegacyColor (wxConfigBase *aConfig, const std::string &aKey, const std::string &aDest)
 Translates a legacy COLOR4D stored in a wxConfig string to a given JSON pointer value. More...
 

Static Protected Member Functions

template<typename ResultType >
static ResultType fetchOrDefault (const nlohmann::json &aJson, const std::string &aKey, ResultType aDefault=ResultType())
 Helper to retrieve a value from a JSON object (dictionary) as a certain result type. More...
 

Protected Attributes

wxString m_filename
 The filename (not including path) of this settings file (inicode) More...
 
wxString m_legacy_filename
 The filename of the wxConfig legacy file (if different from m_filename) More...
 
SETTINGS_LOC m_location
 The location of this settings file (. More...
 
std::vector< PARAM_BASE * > m_params
 The list of parameters (owned by this object) More...
 
std::vector< NESTED_SETTINGS * > m_nested_settings
 Nested settings files that live inside this one, if any. More...
 
bool m_createIfMissing
 Whether or not the backing store file should be created it if doesn't exist. More...
 
bool m_createIfDefault
 Whether or not the backing store file should be created if all parameters are still at their default values. More...
 
bool m_writeFile
 Whether or not the backing store file should be written. More...
 
bool m_deleteLegacyAfterMigration
 Whether or not to delete legacy file after migration. More...
 
bool m_resetParamsIfMissing
 Whether or not to set parameters to their default value if missing from JSON on Load() More...
 
int m_schemaVersion
 Version of this settings schema. More...
 
SETTINGS_MANAGERm_manager
 A pointer to the settings manager managing this file (may be null) More...
 
std::map< int, std::pair< int, std::function< bool()> > > m_migrators
 A map of starting schema version to a pair of <ending version, migrator function> More...
 
std::unique_ptr< JSON_SETTINGS_INTERNALSm_internals
 

Private Attributes

PROJECTm_project
 A link to the owning project. More...
 

Detailed Description

The project local settings are things that are attached to a particular project, but also might be particular to a certain user editing that project, or change quickly, and therefore may not want to be checked in to version control or otherwise distributed with the main project.

Examples include layer visibility, recently-used design entry settings, and so on.

The backing store is a JSON file named <project>.kicad_prl

This file doesn't need to exist for a project to be loaded. It will be created on-demand if any of the things stored here are modified by the user.

Definition at line 53 of file project_local_settings.h.

Constructor & Destructor Documentation

◆ PROJECT_LOCAL_SETTINGS()

PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_SETTINGS ( PROJECT aProject,
const wxString &  aFilename 
)

Schema version 1 to 2: LAYER_PADS and LAYER_ZONES added to visibility controls

Schema version 2 to 3: Fix issue with object visibility not migrating from legacy, which required remapping of GAL_LAYER_ID to match the legacy bitmask ordering.

Stores a mapping from old to new enum offset

Definition at line 30 of file project_local_settings.cpp.

30 :
32 /* aCreateIfMissing = */ true, /* aCreateIfDefault = */ false,
33 /* aWriteFile = */ true ),
37 m_AutoTrackWidth( true ),
39 m_TrackOpacity( 1.0 ),
40 m_ViaOpacity( 1.0 ),
41 m_PadOpacity( 1.0 ),
42 m_ZoneOpacity( 0.6 ),
43 m_ImageOpacity( 0.6 ),
45 m_project( aProject )
46{
47 // Keep old files around
49
50 m_params.emplace_back( new PARAM_LAMBDA<std::string>( "board.visible_layers",
51 [&]() -> std::string
52 {
53 return m_VisibleLayers.FmtHex();
54 },
55 [&]( const std::string& aString )
56 {
57 m_VisibleLayers.ParseHex( aString.c_str(), aString.size() );
58 },
60
61 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "board.visible_items",
62 [&]() -> nlohmann::json
63 {
64 nlohmann::json ret = nlohmann::json::array();
65
66 for( size_t i = 0; i < m_VisibleItems.size(); i++ )
67 if( m_VisibleItems.test( i ) )
68 ret.push_back( i );
69
70 return ret;
71 },
72 [&]( const nlohmann::json& aVal )
73 {
74 if( !aVal.is_array() || aVal.empty() )
75 {
77 return;
78 }
79
80 m_VisibleItems.reset();
81
82 for( const nlohmann::json& entry : aVal )
83 {
84 try
85 {
86 int i = entry.get<int>();
88 }
89 catch( ... )
90 {
91 // Non-integer or out of range entry in the array; ignore
92 }
93 }
94 },
95 {} ) );
96
97 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "board.selection_filter",
98 [&]() -> nlohmann::json
99 {
100 nlohmann::json ret;
101
102 ret["lockedItems"] = m_SelectionFilter.lockedItems;
103 ret["footprints"] = m_SelectionFilter.footprints;
104 ret["text"] = m_SelectionFilter.text;
105 ret["tracks"] = m_SelectionFilter.tracks;
106 ret["vias"] = m_SelectionFilter.vias;
107 ret["pads"] = m_SelectionFilter.pads;
108 ret["graphics"] = m_SelectionFilter.graphics;
109 ret["zones"] = m_SelectionFilter.zones;
110 ret["keepouts"] = m_SelectionFilter.keepouts;
111 ret["dimensions"] = m_SelectionFilter.dimensions;
112 ret["otherItems"] = m_SelectionFilter.otherItems;
113
114 return ret;
115 },
116 [&]( const nlohmann::json& aVal )
117 {
118 if( aVal.empty() || !aVal.is_object() )
119 return;
120
121 SetIfPresent( aVal, "lockedItems", m_SelectionFilter.lockedItems );
122 SetIfPresent( aVal, "footprints", m_SelectionFilter.footprints );
123 SetIfPresent( aVal, "text", m_SelectionFilter.text );
124 SetIfPresent( aVal, "tracks", m_SelectionFilter.tracks );
125 SetIfPresent( aVal, "vias", m_SelectionFilter.vias );
126 SetIfPresent( aVal, "pads", m_SelectionFilter.pads );
127 SetIfPresent( aVal, "graphics", m_SelectionFilter.graphics );
128 SetIfPresent( aVal, "zones", m_SelectionFilter.zones );
129 SetIfPresent( aVal, "keepouts", m_SelectionFilter.keepouts );
130 SetIfPresent( aVal, "dimensions", m_SelectionFilter.dimensions );
131 SetIfPresent( aVal, "otherItems", m_SelectionFilter.otherItems );
132 },
133 {
134 { "lockedItems", false },
135 { "footprints", true },
136 { "text", true },
137 { "tracks", true },
138 { "vias", true },
139 { "pads", true },
140 { "graphics", true },
141 { "zones", true },
142 { "keepouts", true },
143 { "dimensions", true },
144 { "otherItems", true }
145 } ) );
146
147 m_params.emplace_back( new PARAM_ENUM<PCB_LAYER_ID>( "board.active_layer",
149
150 m_params.emplace_back( new PARAM<wxString>( "board.active_layer_preset",
151 &m_ActiveLayerPreset, "" ) );
152
153 m_params.emplace_back( new PARAM_ENUM<HIGH_CONTRAST_MODE>( "board.high_contrast_mode",
156
157 m_params.emplace_back( new PARAM<double>( "board.opacity.tracks", &m_TrackOpacity, 1.0 ) );
158 m_params.emplace_back( new PARAM<double>( "board.opacity.vias", &m_ViaOpacity, 1.0 ) );
159 m_params.emplace_back( new PARAM<double>( "board.opacity.pads", &m_PadOpacity, 1.0 ) );
160 m_params.emplace_back( new PARAM<double>( "board.opacity.zones", &m_ZoneOpacity, 0.6 ) );
161 m_params.emplace_back( new PARAM<double>( "board.opacity.images", &m_ImageOpacity, 0.6 ) );
162
163 m_params.emplace_back( new PARAM_LIST<wxString>( "board.hidden_nets", &m_HiddenNets, {} ) );
164
165 m_params.emplace_back( new PARAM_SET<wxString>( "board.hidden_netclasses",
166 &m_HiddenNetclasses, {} ) );
167
168 m_params.emplace_back( new PARAM_ENUM<NET_COLOR_MODE>( "board.net_color_mode",
171
172 m_params.emplace_back( new PARAM<bool>( "board.auto_track_width",
173 &m_AutoTrackWidth, true ) );
174
175 m_params.emplace_back( new PARAM_ENUM<ZONE_DISPLAY_MODE>( "board.zone_display_mode",
179
180 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "project.files",
181 [&]() -> nlohmann::json
182 {
183 nlohmann::json ret = nlohmann::json::array();
184
185 for( PROJECT_FILE_STATE& fileState : m_files )
186 {
187 nlohmann::json file;
188 file["name"] = fileState.fileName;
189 file["open"] = fileState.open;
190
191 nlohmann::json window;
192 window["maximized"] = fileState.window.maximized;
193 window["size_x"] = fileState.window.size_x;
194 window["size_y"] = fileState.window.size_y;
195 window["pos_x"] = fileState.window.pos_x;
196 window["pos_y"] = fileState.window.pos_y;
197 window["display"] = fileState.window.display;
198
199 file["window"] = window;
200
201 ret.push_back( file );
202 }
203
204 return ret;
205 },
206 [&]( const nlohmann::json& aVal )
207 {
208 if( !aVal.is_array() || aVal.empty() )
209 {
210 return;
211 }
212
213 for( const nlohmann::json& file : aVal )
214 {
215 PROJECT_FILE_STATE fileState;
216
217 try
218 {
219 SetIfPresent( file, "name", fileState.fileName );
220 SetIfPresent( file, "open", fileState.open );
221 SetIfPresent( file, "window.size_x", fileState.window.size_x );
222 SetIfPresent( file, "window.size_y", fileState.window.size_y );
223 SetIfPresent( file, "window.pos_x", fileState.window.pos_x );
224 SetIfPresent( file, "window.pos_y", fileState.window.pos_y );
225 SetIfPresent( file, "window.maximized", fileState.window.maximized );
226 SetIfPresent( file, "window.display", fileState.window.display );
227
228 m_files.push_back( fileState );
229 }
230 catch( ... )
231 {
232 // Non-integer or out of range entry in the array; ignore
233 }
234 }
235
236 },
237 {
238 } ) );
239
240 registerMigration( 1, 2,
241 [&]()
242 {
248 std::string ptr( "board.visible_items" );
249
250 if( Contains( ptr ) )
251 {
252 if( At( ptr ).is_array() )
253 {
254 At( ptr ).push_back( LAYER_PADS );
255 At( ptr ).push_back( LAYER_ZONES );
256 }
257 else
258 {
259 At( "board" ).erase( "visible_items" );
260 }
261 }
262
263 return true;
264 } );
265
266 registerMigration( 2, 3,
267 [&]()
268 {
276 const std::map<int, int> offsets = {
277 { 22, 34 }, // LAYER_PAD_HOLEWALLS
278 { 23, 22 }, // LAYER_VIA_HOLES
279 { 24, 35 }, // LAYER_VIA_HOLEWALLS
280 { 25, 23 }, // LAYER_DRC_ERROR
281 { 26, 36 }, // LAYER_DRC_WARNING
282 { 27, 37 }, // LAYER_DRC_EXCLUSION
283 { 28, 38 }, // LAYER_MARKER_SHADOWS
284 { 29, 24 }, // LAYER_DRAWINGSHEET
285 { 30, 25 }, // LAYER_GP_OVERLAY
286 { 31, 26 }, // LAYER_SELECT_OVERLAY
287 { 32, 27 }, // LAYER_PCB_BACKGROUND
288 { 33, 28 }, // LAYER_CURSOR
289 { 34, 29 }, // LAYER_AUX_ITEM
290 { 35, 30 }, // LAYER_DRAW_BITMAPS
291 { 39, 32 }, // LAYER_PADS
292 { 40, 33 }, // LAYER_ZONES
293 };
294
295 std::string ptr( "board.visible_items" );
296
297 if( Contains( ptr ) && At( ptr ).is_array() )
298 {
299 nlohmann::json visible = nlohmann::json::array();
300
301 for( const nlohmann::json& val : At( ptr ) )
302 {
303 try
304 {
305 int layer = val.get<int>();
306
307 if( offsets.count( layer ) )
308 visible.push_back( offsets.at( layer ) );
309 else
310 visible.push_back( layer );
311 }
312 catch( ... )
313 {
314 // skip invalid value
315 }
316 }
317
318 At( "board" )["visible_items"] = visible;
319 }
320
321 return true;
322 } );
323}
@ NORMAL
Inactive layers are shown normally (no high-contrast mode)
@ HIDDEN
Inactive layers are hidden.
@ RATSNEST
Net/netclass colors are shown on ratsnest lines only.
@ ALL
Net/netclass colors are shown on all net copper.
@ OFF
Net (and netclass) colors are not shown.
GAL_SET & set()
Definition: layer_ids.h:311
static GAL_SET DefaultVisible()
Definition: lset.cpp:960
bool Contains(const std::string &aPath) const
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::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.
nlohmann::json & At(const std::string &aPath)
Wrappers for the underlying JSON API so that most consumers don't need json.hpp All of these function...
JSON_SETTINGS(const wxString &aFilename, SETTINGS_LOC aLocation, int aSchemaVersion)
Definition: json_settings.h:64
bool m_deleteLegacyAfterMigration
Whether or not to delete legacy file after migration.
int ParseHex(const char *aStart, int aCount)
Convert the output of FmtHex() and replaces this set's values with those given in the input string.
Definition: lset.cpp:359
static LSET AllLayersMask()
Definition: lset.cpp:808
std::string FmtHex() const
Return a hex string showing contents of this LSEQ.
Definition: lset.cpp:321
Stores an enum as an integer.
Definition: parameters.h:217
Like a normal param, but with custom getter and setter functions.
Definition: parameters.h:282
LSET m_VisibleLayers
Board settings.
SELECTION_FILTER_OPTIONS m_SelectionFilter
State of the selection filter widget.
double m_PadOpacity
Opacity override for SMD pads and PTH.
std::vector< PROJECT_FILE_STATE > m_files
Project scope.
double m_ViaOpacity
Opacity override for all types of via.
wxString m_ActiveLayerPreset
The name of a LAYER_PRESET that is currently activated (or blank if none)
double m_TrackOpacity
Opacity override for all tracks.
PROJECT * m_project
A link to the owning project.
double m_ZoneOpacity
Opacity override for filled zones.
bool m_AutoTrackWidth
The current setting for whether to automatically adjust track widths to match.
ZONE_DISPLAY_MODE m_ZoneDisplayMode
How zones are drawn.
PCB_LAYER_ID m_ActiveLayer
The current (active) board layer for editing.
HIGH_CONTRAST_MODE m_ContrastModeDisplay
The current contrast mode.
NET_COLOR_MODE m_NetColorMode
The current net color mode.
GAL_SET m_VisibleItems
The GAL layers (aka items) that are turned on for viewing (.
std::vector< wxString > m_HiddenNets
A list of netnames that have been manually hidden in the board editor.
std::set< wxString > m_HiddenNetclasses
double m_ImageOpacity
Opacity override for user images.
nlohmann::json json
Definition: gerbview.cpp:44
@ PROJECT
The settings directory inside a project folder.
@ LAYER_ZONES
Control for copper zone opacity/visibility (color ignored)
Definition: layer_ids.h:231
@ LAYER_PADS
Meta control for all pads opacity/visibility (color ignored)
Definition: layer_ids.h:230
@ PCBNEW_LAYER_ID_START
Definition: layer_ids.h:63
@ F_Fab
Definition: layer_ids.h:120
@ UNDEFINED_LAYER
Definition: layer_ids.h:60
@ F_Cu
Definition: layer_ids.h:64
const int projectLocalSettingsVersion
struct WINDOW_STATE window
bool graphics
Graphic lines, shapes, polygons.
bool text
Text (free or attached to a footprint)
bool lockedItems
Allow selecting locked items.
bool footprints
Allow selecting entire footprints.
bool dimensions
Dimension items.
bool otherItems
Anything not fitting one of the above categories.
unsigned int display
Definition: app_settings.h:85

References ALL, LSET::AllLayersMask(), JSON_SETTINGS::At(), JSON_SETTINGS::Contains(), GAL_SET::DefaultVisible(), SELECTION_FILTER_OPTIONS::dimensions, WINDOW_STATE::display, F_Cu, F_Fab, PROJECT_FILE_STATE::fileName, LSET::FmtHex(), SELECTION_FILTER_OPTIONS::footprints, SELECTION_FILTER_OPTIONS::graphics, HIDDEN, SELECTION_FILTER_OPTIONS::keepouts, LAYER_PADS, LAYER_ZONES, SELECTION_FILTER_OPTIONS::lockedItems, m_ActiveLayer, m_ActiveLayerPreset, m_AutoTrackWidth, m_ContrastModeDisplay, JSON_SETTINGS::m_deleteLegacyAfterMigration, m_files, m_HiddenNetclasses, m_HiddenNets, m_ImageOpacity, m_NetColorMode, m_PadOpacity, JSON_SETTINGS::m_params, m_SelectionFilter, m_TrackOpacity, m_ViaOpacity, m_VisibleItems, m_VisibleLayers, m_ZoneDisplayMode, m_ZoneOpacity, WINDOW_STATE::maximized, NORMAL, OFF, PROJECT_FILE_STATE::open, SELECTION_FILTER_OPTIONS::otherItems, SELECTION_FILTER_OPTIONS::pads, LSET::ParseHex(), PCBNEW_LAYER_ID_START, WINDOW_STATE::pos_x, WINDOW_STATE::pos_y, RATSNEST, JSON_SETTINGS::registerMigration(), GAL_SET::set(), JSON_SETTINGS::SetIfPresent(), SHOW_FILLED, SHOW_TRIANGULATION, WINDOW_STATE::size_x, WINDOW_STATE::size_y, SELECTION_FILTER_OPTIONS::text, SELECTION_FILTER_OPTIONS::tracks, SELECTION_FILTER_OPTIONS::vias, PROJECT_FILE_STATE::window, and SELECTION_FILTER_OPTIONS::zones.

◆ ~PROJECT_LOCAL_SETTINGS()

virtual PROJECT_LOCAL_SETTINGS::~PROJECT_LOCAL_SETTINGS ( )
inlinevirtual

Definition at line 58 of file project_local_settings.h.

58{}

Member Function Documentation

◆ AddNestedSettings()

void JSON_SETTINGS::AddNestedSettings ( NESTED_SETTINGS aSettings)
inherited

Transfers ownership of a given NESTED_SETTINGS to this object.

Can be used to construct a NESTED_SETTINGS without the parent object needing to know about the implementation of the nested object;

Parameters
aSettingsis the settings object to take ownership of
aTargetis a pointer to update to the passed in settings

Definition at line 783 of file json_settings.cpp.

784{
785 wxLogTrace( traceSettings, wxT( "AddNestedSettings %s" ), aSettings->GetFilename() );
786 m_nested_settings.push_back( aSettings );
787}
std::vector< NESTED_SETTINGS * > m_nested_settings
Nested settings files that live inside this one, if any.
wxString GetFilename() const
Definition: json_settings.h:73
const wxChar *const traceSettings
Flag to enable debug output of settings operations and management.

References JSON_SETTINGS::GetFilename(), JSON_SETTINGS::m_nested_settings, and traceSettings.

Referenced by NESTED_SETTINGS::SetParent().

◆ At()

nlohmann::json & JSON_SETTINGS::At ( const std::string &  aPath)
inherited

Wrappers for the underlying JSON API so that most consumers don't need json.hpp All of these functions take a string that is passed to PointerFromString internally.

Definition at line 111 of file json_settings.cpp.

112{
113 return m_internals->At( aPath );
114}
std::unique_ptr< JSON_SETTINGS_INTERNALS > m_internals

References JSON_SETTINGS::m_internals.

Referenced by EESCHEMA_SETTINGS::migrateBomSettings(), GERBVIEW_SETTINGS::MigrateFromLegacy(), APP_SETTINGS_BASE::migrateLibTreeWidth(), BOARD_DESIGN_SETTINGS::migrateSchema0to1(), FOOTPRINT_EDITOR_SETTINGS::migrateSchema0to1(), COLOR_SETTINGS::migrateSchema0to1(), PCBNEW_SETTINGS::PCBNEW_SETTINGS(), and PROJECT_LOCAL_SETTINGS().

◆ ClearFileState()

void PROJECT_LOCAL_SETTINGS::ClearFileState ( )

Definition at line 404 of file project_local_settings.cpp.

405{
406 m_files.clear();
407}

References m_files.

Referenced by KICAD_MANAGER_FRAME::OnIdle().

◆ Contains()

bool JSON_SETTINGS::Contains ( const std::string &  aPath) const
inherited

◆ fetchOrDefault()

template<typename ResultType >
template bool JSON_SETTINGS::fetchOrDefault ( const nlohmann::json aJson,
const std::string &  aKey,
ResultType  aDefault = ResultType() 
)
staticprotectedinherited

Helper to retrieve a value from a JSON object (dictionary) as a certain result type.

Template Parameters
ResultTypeis the type of the retrieved value.
Parameters
aJsonis the object to act on .
aKeyis the object key to retrieve the value for.
Returns
the result, or aDefault if aKey is not found.

Definition at line 842 of file json_settings.cpp.

844{
845 ResultType ret = aDefault;
846
847 try
848 {
849 if( aJson.contains( aKey ) )
850 ret = aJson.at( aKey ).get<ResultType>();
851 }
852 catch( ... )
853 {
854 }
855
856 return ret;
857}

◆ FormatAsString()

const std::string JSON_SETTINGS::FormatAsString ( ) const
inherited

Definition at line 471 of file json_settings.cpp.

472{
474
475 std::stringstream buffer;
476 buffer << std::setw( 2 ) << *m_internals << std::endl;
477
478 return buffer.str();
479}
Instantiate the current locale within a scope in which you are expecting exceptions to be thrown.
Definition: locale_io.h:41
std::vector< FAB_LAYER_COLOR > dummy

References dummy, and JSON_SETTINGS::m_internals.

Referenced by ROUTER_TOOL::saveRouterDebugLog().

◆ fromLegacy()

template<typename ValueType >
template bool JSON_SETTINGS::fromLegacy< bool > ( wxConfigBase *  aConfig,
const std::string &  aKey,
const std::string &  aDest 
)
protectedinherited

Translates a legacy wxConfig value to a given JSON pointer value.

Template Parameters
ValueTypeis the basic type of the value
Parameters
aConfigis the legacy config to read from
aKeyis the key (within the current path) to read
aDestis a string that will form a JSON pointer (key1.key2.key3) to write to

Definition at line 695 of file json_settings.cpp.

697{
698 ValueType val;
699
700 if( aConfig->Read( aKey, &val ) )
701 {
702 try
703 {
704 ( *m_internals )[aDest] = val;
705 }
706 catch( ... )
707 {
708 wxASSERT_MSG( false, wxT( "Could not write value in fromLegacy!" ) );
709 return false;
710 }
711
712 return true;
713 }
714
715 return false;
716}

◆ fromLegacyColor()

bool JSON_SETTINGS::fromLegacyColor ( wxConfigBase *  aConfig,
const std::string &  aKey,
const std::string &  aDest 
)
protectedinherited

Translates a legacy COLOR4D stored in a wxConfig string to a given JSON pointer value.

Parameters
aConfigis the legacy config to read from
aKeyis the key (within the current path) to read
aDestis a string that will form a JSON pointer (key1.key2.key3) to write to

Definition at line 755 of file json_settings.cpp.

757{
758 wxString str;
759
760 if( aConfig->Read( aKey, &str ) )
761 {
763 color.SetFromWxString( str );
764
765 try
766 {
767 nlohmann::json js = nlohmann::json::array( { color.r, color.g, color.b, color.a } );
768 ( *m_internals )[aDest] = js;
769 }
770 catch( ... )
771 {
772 wxASSERT_MSG( false, wxT( "Could not write value in fromLegacyColor!" ) );
773 return false;
774 }
775
776 return true;
777 }
778
779 return false;
780}
int color
Definition: DXF_plotter.cpp:57
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:104

References color.

Referenced by APP_SETTINGS_BASE::migrateWindowConfig().

◆ fromLegacyString()

bool JSON_SETTINGS::fromLegacyString ( wxConfigBase *  aConfig,
const std::string &  aKey,
const std::string &  aDest 
)
protectedinherited

Translates a legacy wxConfig string value to a given JSON pointer value.

Parameters
aConfigis the legacy config to read from
aKeyis the key (within the current path) to read
aDestis a string that will form a JSON pointer (key1.key2.key3) to write to

Definition at line 731 of file json_settings.cpp.

733{
734 wxString str;
735
736 if( aConfig->Read( aKey, &str ) )
737 {
738 try
739 {
740 ( *m_internals )[aDest] = str.ToUTF8();
741 }
742 catch( ... )
743 {
744 wxASSERT_MSG( false, wxT( "Could not write value in fromLegacyString!" ) );
745 return false;
746 }
747
748 return true;
749 }
750
751 return false;
752}

Referenced by PROJECT_FILE::MigrateFromLegacy(), APP_SETTINGS_BASE::MigrateFromLegacy(), BITMAP2CMP_SETTINGS::MigrateFromLegacy(), EESCHEMA_SETTINGS::MigrateFromLegacy(), SYMBOL_EDITOR_SETTINGS::MigrateFromLegacy(), GERBVIEW_SETTINGS::MigrateFromLegacy(), FOOTPRINT_EDITOR_SETTINGS::MigrateFromLegacy(), COMMON_SETTINGS::MigrateFromLegacy(), PCB_CALCULATOR_SETTINGS::MigrateFromLegacy(), PCBNEW_SETTINGS::MigrateFromLegacy(), and APP_SETTINGS_BASE::migrateWindowConfig().

◆ Get() [1/2]

template<>
std::optional< wxString > JSON_SETTINGS::Get ( const std::string &  aPath) const
inherited

Definition at line 813 of file json_settings.cpp.

814{
815 if( std::optional<nlohmann::json> opt_json = GetJson( aPath ) )
816 return wxString( opt_json->get<std::string>().c_str(), wxConvUTF8 );
817
818 return std::nullopt;
819}
std::optional< nlohmann::json > GetJson(const std::string &aPath) const
Fetches a JSON object that is a subset of this JSON_SETTINGS object, using a path of the form "key1....

References JSON_SETTINGS::GetJson().

◆ Get() [2/2]

template<typename ValueType >
template std::optional< unsigned long long > JSON_SETTINGS::Get< unsigned long long > ( const std::string &  aPath) const
inherited

Fetches a value from within the JSON document.

Will return an empty optional if the value is not found or a mismatching type.

Template Parameters
ValueTypeis the type to cast to
Parameters
aPathis the path within the document to retrieve
Returns
a value from within this document

Definition at line 534 of file json_settings.cpp.

535{
536 if( std::optional<nlohmann::json> ret = GetJson( aPath ) )
537 {
538 try
539 {
540 return ret->get<ValueType>();
541 }
542 catch( ... )
543 {
544 }
545 }
546
547 return std::nullopt;
548}

References JSON_SETTINGS::GetJson().

Referenced by COLOR_MAP_PARAM::Load(), PARAM< ValueType >::Load(), PARAM_ENUM< EnumType >::Load(), PARAM_LAMBDA< ValueType >::Load(), PARAM_SCALED< ValueType >::Load(), COLOR_MAP_PARAM::MatchesFile(), PARAM< ValueType >::MatchesFile(), PARAM_PATH::MatchesFile(), PARAM_ENUM< EnumType >::MatchesFile(), PARAM_LAMBDA< ValueType >::MatchesFile(), and PARAM_SCALED< ValueType >::MatchesFile().

◆ getFileExt()

wxString PROJECT_LOCAL_SETTINGS::getFileExt ( ) const
inlineoverrideprotectedvirtual

Reimplemented from JSON_SETTINGS.

Definition at line 75 of file project_local_settings.h.

76 {
78 }
const std::string ProjectLocalSettingsFileExtension

References ProjectLocalSettingsFileExtension.

◆ GetFilename()

◆ GetFileState()

const PROJECT_FILE_STATE * PROJECT_LOCAL_SETTINGS::GetFileState ( const wxString &  aFileName)

Definition at line 356 of file project_local_settings.cpp.

357{
358 auto it = std::find_if( m_files.begin(), m_files.end(),
359 [&aFileName]( const PROJECT_FILE_STATE &a )
360 {
361 return a.fileName == aFileName;
362 } );
363
364 if( it != m_files.end() )
365 {
366 return &( *it );
367 }
368
369 return nullptr;
370}

References m_files.

Referenced by EDA_BASE_FRAME::LoadWindowState().

◆ GetFullFilename()

wxString JSON_SETTINGS::GetFullFilename ( ) const
inherited

Definition at line 105 of file json_settings.cpp.

106{
107 return wxString( m_filename + "." + getFileExt() );
108}
virtual wxString getFileExt() const

References JSON_SETTINGS::getFileExt(), and JSON_SETTINGS::m_filename.

Referenced by JSON_SETTINGS::JSON_SETTINGS(), JSON_SETTINGS::LoadFromFile(), NESTED_SETTINGS::LoadFromFile(), and JSON_SETTINGS::SaveToFile().

◆ GetJson()

std::optional< nlohmann::json > JSON_SETTINGS::GetJson ( const std::string &  aPath) const
inherited

Fetches a JSON object that is a subset of this JSON_SETTINGS object, using a path of the form "key1.key2.key3" to refer to nested objects.

Parameters
aPathis a string containing one or more keys separated by '.'
Returns
a JSON object from within this one

Definition at line 514 of file json_settings.cpp.

515{
516 nlohmann::json::json_pointer ptr = m_internals->PointerFromString( aPath );
517
518 if( m_internals->contains( ptr ) )
519 {
520 try
521 {
522 return std::optional<nlohmann::json>{ m_internals->at( ptr ) };
523 }
524 catch( ... )
525 {
526 }
527 }
528
529 return std::optional<nlohmann::json>{};
530}

References JSON_SETTINGS::m_internals.

Referenced by JSON_SETTINGS::Get(), PARAM_LAMBDA< ValueType >::Load(), PARAM_LIST< Type >::Load(), PARAM_SET< Type >::Load(), PARAM_MAP< Value >::Load(), PARAM_LAMBDA< ValueType >::MatchesFile(), PARAM_LIST< Type >::MatchesFile(), PARAM_SET< Type >::MatchesFile(), PARAM_PATH_LIST::MatchesFile(), PARAM_MAP< Value >::MatchesFile(), PARAM_WXSTRING_MAP::MatchesFile(), SETTINGS_MANAGER::SaveColorSettings(), and NESTED_SETTINGS::SaveToFile().

◆ getLegacyFileExt()

wxString PROJECT_LOCAL_SETTINGS::getLegacyFileExt ( ) const
inlineoverrideprotectedvirtual

Reimplemented from JSON_SETTINGS.

Definition at line 80 of file project_local_settings.h.

81 {
82 return wxT( "NO_SUCH_FILE_EXTENSION" );
83 }

◆ GetLocation()

SETTINGS_LOC JSON_SETTINGS::GetLocation ( ) const
inlineinherited

Definition at line 80 of file json_settings.h.

80{ return m_location; }
SETTINGS_LOC m_location
The location of this settings file (.

References JSON_SETTINGS::m_location.

Referenced by SETTINGS_MANAGER::GetPathForSettingsFile().

◆ Internals()

JSON_SETTINGS_INTERNALS * JSON_SETTINGS::Internals ( )
inherited

Definition at line 123 of file json_settings.cpp.

124{
125 return m_internals.get();
126}

References JSON_SETTINGS::m_internals.

Referenced by COLOR_SETTINGS::migrateSchema0to1(), and SETTINGS_MANAGER::SaveColorSettings().

◆ IsReadOnly()

◆ Load()

void JSON_SETTINGS::Load ( )
virtualinherited

Updates the parameters of this object based on the current JSON document contents.

Definition at line 129 of file json_settings.cpp.

130{
131 for( auto param : m_params )
132 {
133 try
134 {
135 param->Load( this, m_resetParamsIfMissing );
136 }
137 catch( ... )
138 {
139 // Skip unreadable parameters in file
140 wxLogTrace( traceSettings, wxT( "param '%s' load err" ), param->GetJsonPath().c_str() );
141 }
142 }
143}
bool m_resetParamsIfMissing
Whether or not to set parameters to their default value if missing from JSON on Load()

References JSON_SETTINGS::m_params, JSON_SETTINGS::m_resetParamsIfMissing, and traceSettings.

Referenced by COLOR_SETTINGS::CreateBuiltinColorSettings(), JSON_SETTINGS::LoadFromFile(), BOARD_DESIGN_SETTINGS::LoadFromFile(), NESTED_SETTINGS::LoadFromFile(), JSON_SETTINGS::LoadFromRawFile(), COLOR_SETTINGS::migrateSchema0to1(), PANEL_3D_DISPLAY_OPTIONS::ResetPanel(), PANEL_3D_OPENGL_OPTIONS::ResetPanel(), PANEL_3D_RAYTRACING_OPTIONS::ResetPanel(), PANEL_EESCHEMA_ANNOTATION_OPTIONS::ResetPanel(), PANEL_EESCHEMA_DISPLAY_OPTIONS::ResetPanel(), PANEL_EESCHEMA_EDITING_OPTIONS::ResetPanel(), PANEL_SYM_DISPLAY_OPTIONS::ResetPanel(), PANEL_SYM_EDITING_OPTIONS::ResetPanel(), PANEL_GERBVIEW_DISPLAY_OPTIONS::ResetPanel(), PANEL_PL_EDITOR_DISPLAY_OPTIONS::ResetPanel(), PANEL_DISPLAY_OPTIONS::ResetPanel(), PANEL_EDIT_OPTIONS::ResetPanel(), PANEL_FP_EDITOR_DEFAULTS::ResetPanel(), PANEL_PCBNEW_DISPLAY_ORIGIN::ResetPanel(), and SETTINGS_MANAGER::SaveColorSettings().

◆ LoadFromFile()

bool JSON_SETTINGS::LoadFromFile ( const wxString &  aDirectory = "")
virtualinherited

Loads the backing file from disk and then calls Load()

Parameters
aDirectoryis the path to the file
Returns
true if the file was found on disk and loaded or migrated

Reimplemented in BOARD_DESIGN_SETTINGS, and NESTED_SETTINGS.

Definition at line 146 of file json_settings.cpp.

147{
148 // First, load all params to default values
149 m_internals->clear();
150 Load();
151
152 bool success = true;
153 bool migrated = false;
154 bool legacy_migrated = false;
155
156 LOCALE_IO locale;
157
158 auto migrateFromLegacy = [&] ( wxFileName& aPath ) {
159 // Backup and restore during migration so that the original can be mutated if convenient
160 bool backed_up = false;
161 wxFileName temp;
162
163 if( aPath.IsDirWritable() )
164 {
165 temp.AssignTempFileName( aPath.GetFullPath() );
166
167 if( !wxCopyFile( aPath.GetFullPath(), temp.GetFullPath() ) )
168 {
169 wxLogTrace( traceSettings, wxT( "%s: could not create temp file for migration" ),
170 GetFullFilename() );
171 }
172 else
173 backed_up = true;
174 }
175
176 // Silence popups if legacy file is read-only
177 wxLogNull doNotLog;
178
179 wxConfigBase::DontCreateOnDemand();
180 auto cfg = std::make_unique<wxFileConfig>( wxT( "" ), wxT( "" ), aPath.GetFullPath() );
181
182 // If migrate fails or is not implemented, fall back to built-in defaults that were
183 // already loaded above
184 if( !MigrateFromLegacy( cfg.get() ) )
185 {
186 success = false;
187 wxLogTrace( traceSettings,
188 wxT( "%s: migrated; not all settings were found in legacy file" ),
189 GetFullFilename() );
190 }
191 else
192 {
193 success = true;
194 wxLogTrace( traceSettings, wxT( "%s: migrated from legacy format" ), GetFullFilename() );
195 }
196
197 if( backed_up )
198 {
199 cfg.reset();
200
201 if( !wxCopyFile( temp.GetFullPath(), aPath.GetFullPath() ) )
202 {
203 wxLogTrace( traceSettings,
204 wxT( "migrate; copy temp file %s to %s failed" ),
205 temp.GetFullPath(), aPath.GetFullPath() );
206 }
207
208 if( !wxRemoveFile( temp.GetFullPath() ) )
209 {
210 wxLogTrace( traceSettings,
211 wxT( "migrate; failed to remove temp file %s" ),
212 temp.GetFullPath() );
213 }
214 }
215
216 // Either way, we want to clean up the old file afterwards
217 legacy_migrated = true;
218 };
219
220 wxFileName path;
221
222 if( aDirectory.empty() )
223 {
224 path.Assign( m_filename );
225 path.SetExt( getFileExt() );
226 }
227 else
228 {
229 wxString dir( aDirectory );
230 path.Assign( dir, m_filename, getFileExt() );
231 }
232
233 if( !path.Exists() )
234 {
235 // Case 1: legacy migration, no .json extension yet
236 path.SetExt( getLegacyFileExt() );
237
238 if( path.Exists() )
239 {
240 migrateFromLegacy( path );
241 }
242 // Case 2: legacy filename is different from new one
243 else if( !m_legacy_filename.empty() )
244 {
245 path.SetName( m_legacy_filename );
246
247 if( path.Exists() )
248 migrateFromLegacy( path );
249 }
250 else
251 {
252 success = false;
253 }
254 }
255 else
256 {
257 if( !path.IsFileWritable() )
258 m_writeFile = false;
259
260 try
261 {
262 wxFFileInputStream fp( path.GetFullPath(), wxT( "rt" ) );
263 wxStdInputStream fstream( fp );
264
265 if( fp.IsOk() )
266 {
267 *static_cast<nlohmann::json*>( m_internals.get() ) =
268 nlohmann::json::parse( fstream, nullptr,
269 /* allow_exceptions = */ true,
270 /* ignore_comments = */ true );
271
272 // If parse succeeds, check if schema migration is required
273 int filever = -1;
274
275 try
276 {
277 filever = m_internals->Get<int>( "meta.version" );
278 }
279 catch( ... )
280 {
281 wxLogTrace( traceSettings, wxT( "%s: file version could not be read!" ),
282 GetFullFilename() );
283 success = false;
284 }
285
286 if( filever >= 0 && filever < m_schemaVersion )
287 {
288 wxLogTrace( traceSettings, wxT( "%s: attempting migration from version %d to %d" ),
289 GetFullFilename(), filever, m_schemaVersion );
290
291 if( Migrate() )
292 {
293 migrated = true;
294 }
295 else
296 {
297 wxLogTrace( traceSettings, wxT( "%s: migration failed!" ), GetFullFilename() );
298 }
299 }
300 else if( filever > m_schemaVersion )
301 {
302 wxLogTrace( traceSettings,
303 wxT( "%s: warning: file version %d is newer than latest (%d)" ),
304 GetFullFilename(), filever, m_schemaVersion );
305 }
306 }
307 else
308 {
309 wxLogTrace( traceSettings, wxT( "%s exists but can't be opened for read" ),
310 GetFullFilename() );
311 }
312 }
313 catch( nlohmann::json::parse_error& error )
314 {
315 success = false;
316 wxLogTrace( traceSettings, wxT( "Json parse error reading %s: %s" ),
317 path.GetFullPath(), error.what() );
318 wxLogTrace( traceSettings, wxT( "Attempting migration in case file is in legacy format" ) );
319 migrateFromLegacy( path );
320 }
321 }
322
323 // Now that we have new data in the JSON structure, load the params again
324 Load();
325
326 // And finally load any nested settings
327 for( auto settings : m_nested_settings )
328 settings->LoadFromFile();
329
330 wxLogTrace( traceSettings, wxT( "Loaded <%s> with schema %d" ), GetFullFilename(), m_schemaVersion );
331
332 // If we migrated, clean up the legacy file (with no extension)
333 if( m_writeFile && ( legacy_migrated || migrated ) )
334 {
335 if( legacy_migrated && m_deleteLegacyAfterMigration && !wxRemoveFile( path.GetFullPath() ) )
336 {
337 wxLogTrace( traceSettings, wxT( "Warning: could not remove legacy file %s" ),
338 path.GetFullPath() );
339 }
340
341 // And write-out immediately so that we don't lose data if the program later crashes.
343 SaveToFile( aDirectory, true );
344 }
345
346 return success;
347}
virtual void Load()
Updates the parameters of this object based on the current JSON document contents.
wxString GetFullFilename() const
bool Migrate()
Migrates the schema of this settings from the version in the file to the latest version.
virtual bool MigrateFromLegacy(wxConfigBase *aLegacyConfig)
Migrates from wxConfig to JSON-based configuration.
virtual bool SaveToFile(const wxString &aDirectory="", bool aForce=false)
virtual wxString getLegacyFileExt() const
int m_schemaVersion
Version of this settings schema.
wxString m_legacy_filename
The filename of the wxConfig legacy file (if different from m_filename)
bool parse(std::istream &aStream, bool aVerbose)
Parse a PCB or footprint file from the given input stream.

References JSON_SETTINGS::getFileExt(), JSON_SETTINGS::GetFullFilename(), JSON_SETTINGS::getLegacyFileExt(), JSON_SETTINGS::Load(), JSON_SETTINGS::m_deleteLegacyAfterMigration, JSON_SETTINGS::m_filename, JSON_SETTINGS::m_internals, JSON_SETTINGS::m_legacy_filename, JSON_SETTINGS::m_nested_settings, JSON_SETTINGS::m_schemaVersion, JSON_SETTINGS::m_writeFile, JSON_SETTINGS::Migrate(), JSON_SETTINGS::MigrateFromLegacy(), parse(), path, JSON_SETTINGS::SaveToFile(), and traceSettings.

Referenced by SETTINGS_MANAGER::LoadProject(), SETTINGS_MANAGER::loadProjectFile(), SETTINGS_MANAGER::MigrateIfNeeded(), SAVE_AS_TRAVERSER::OnFile(), and SETTINGS_MANAGER::SaveColorSettings().

◆ LoadFromRawFile()

bool JSON_SETTINGS::LoadFromRawFile ( const wxString &  aPath)
inherited

Definition at line 482 of file json_settings.cpp.

483{
484 try
485 {
486 wxFFileInputStream fp( aPath, wxT( "rt" ) );
487 wxStdInputStream fstream( fp );
488
489 if( fp.IsOk() )
490 {
491 *static_cast<nlohmann::json*>( m_internals.get() ) =
492 nlohmann::json::parse( fstream, nullptr,
493 /* allow_exceptions = */ true,
494 /* ignore_comments = */ true );
495 }
496 else
497 {
498 return false;
499 }
500 }
501 catch( nlohmann::json::parse_error& error )
502 {
503 wxLogTrace( traceSettings, wxT( "Json parse error reading %s: %s" ), aPath, error.what() );
504
505 return false;
506 }
507
508 // Now that we have new data in the JSON structure, load the params again
509 Load();
510 return true;
511}

References JSON_SETTINGS::Load(), JSON_SETTINGS::m_internals, parse(), and traceSettings.

◆ Migrate()

bool JSON_SETTINGS::Migrate ( )
inherited

Migrates the schema of this settings from the version in the file to the latest version.

Schema migration doesn't need to be used every time a setting is added! This is intended to be more of an "escape hatch" in the event that we decide to move settings around or make other changes to a settings file format that can't simply be handled by loading a new default

Returns
true if migration was successful

Definition at line 592 of file json_settings.cpp.

593{
594 int filever = m_internals->Get<int>( "meta.version" );
595
596 while( filever < m_schemaVersion )
597 {
598 if( !m_migrators.count( filever ) )
599 {
600 wxLogTrace( traceSettings, wxT( "Migrator missing for %s version %d!" ),
601 typeid( *this ).name(), filever );
602 return false;
603 }
604
605 std::pair<int, std::function<bool()>> pair = m_migrators.at( filever );
606
607 if( pair.second() )
608 {
609 wxLogTrace( traceSettings, wxT( "Migrated %s from %d to %d" ), typeid( *this ).name(),
610 filever, pair.first );
611 filever = pair.first;
612 m_internals->At( "meta.version" ) = filever;
613 }
614 else
615 {
616 wxLogTrace( traceSettings, wxT( "Migration failed for %s from %d to %d" ),
617 typeid( *this ).name(), filever, pair.first );
618 return false;
619 }
620 }
621
622 return true;
623}
std::map< int, std::pair< int, std::function< bool()> > > m_migrators
A map of starting schema version to a pair of <ending version, migrator function>

References JSON_SETTINGS::m_internals, JSON_SETTINGS::m_migrators, JSON_SETTINGS::m_schemaVersion, and traceSettings.

Referenced by JSON_SETTINGS::LoadFromFile(), and NESTED_SETTINGS::LoadFromFile().

◆ MigrateFromLegacy()

bool PROJECT_LOCAL_SETTINGS::MigrateFromLegacy ( wxConfigBase *  aLegacyConfig)
overridevirtual

Migrates from wxConfig to JSON-based configuration.

Should be implemented by any subclasses of JSON_SETTINGS that map to a legacy (wxConfig-based) config file.

Parameters
aLegacyConfigis a wxConfigBase holding a loaded configuration to migrate
Returns
true if migration was successful

The normal legacy migration code won't be used for this because the only legacy information stored here was stored in board files, so we do that migration when loading the board.

Reimplemented from JSON_SETTINGS.

Definition at line 326 of file project_local_settings.cpp.

327{
333 return true;
334}

◆ registerMigration()

void JSON_SETTINGS::registerMigration ( int  aOldSchemaVersion,
int  aNewSchemaVersion,
std::function< bool(void)>  aMigrator 
)
protectedinherited

Registers a migration from one schema version to another.

If the schema version in the file loaded from disk is less than the schema version of the JSON_SETTINGS class, migration functions will be called one after the other until the data is up-to-date.

Parameters
aOldSchemaVersionis the starting schema version for this migration
aNewSchemaVersionis the ending schema version for this migration
aMigratoris a function that performs the migration and returns true if successful

Definition at line 583 of file json_settings.cpp.

585{
586 wxASSERT( aNewSchemaVersion > aOldSchemaVersion );
587 wxASSERT( aNewSchemaVersion <= m_schemaVersion );
588 m_migrators[aOldSchemaVersion] = std::make_pair( aNewSchemaVersion, aMigrator );
589}

References JSON_SETTINGS::m_migrators, and JSON_SETTINGS::m_schemaVersion.

Referenced by BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), COLOR_SETTINGS::COLOR_SETTINGS(), EDA_3D_VIEWER_SETTINGS::EDA_3D_VIEWER_SETTINGS(), EESCHEMA_SETTINGS::EESCHEMA_SETTINGS(), FOOTPRINT_EDITOR_SETTINGS::FOOTPRINT_EDITOR_SETTINGS(), NET_SETTINGS::NET_SETTINGS(), PCBNEW_SETTINGS::PCBNEW_SETTINGS(), PROJECT_LOCAL_SETTINGS(), SCHEMATIC_SETTINGS::SCHEMATIC_SETTINGS(), and SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS().

◆ ReleaseNestedSettings()

void JSON_SETTINGS::ReleaseNestedSettings ( NESTED_SETTINGS aSettings)
inherited

Saves and frees a nested settings object, if it exists within this one.

Parameters
aSettingsis a pointer to a NESTED_SETTINGS that has already been added to this one

Definition at line 790 of file json_settings.cpp.

791{
792 if( !aSettings || !m_manager )
793 return;
794
795 auto it = std::find_if( m_nested_settings.begin(), m_nested_settings.end(),
796 [&aSettings]( const JSON_SETTINGS* aPtr ) {
797 return aPtr == aSettings;
798 } );
799
800 if( it != m_nested_settings.end() )
801 {
802 wxLogTrace( traceSettings, wxT( "Flush and release %s" ), ( *it )->GetFilename() );
803 ( *it )->SaveToFile();
804 m_nested_settings.erase( it );
805 }
806
807 aSettings->SetParent( nullptr );
808}
SETTINGS_MANAGER * m_manager
A pointer to the settings manager managing this file (may be null)
void SetParent(JSON_SETTINGS *aParent, bool aLoadFromFile=true)

References JSON_SETTINGS::m_manager, JSON_SETTINGS::m_nested_settings, NESTED_SETTINGS::SetParent(), and traceSettings.

Referenced by BOARD_DESIGN_SETTINGS::~BOARD_DESIGN_SETTINGS(), ERC_SETTINGS::~ERC_SETTINGS(), NESTED_SETTINGS::~NESTED_SETTINGS(), NET_SETTINGS::~NET_SETTINGS(), and SCHEMATIC_SETTINGS::~SCHEMATIC_SETTINGS().

◆ ResetToDefaults()

void JSON_SETTINGS::ResetToDefaults ( )
inherited

Resets all parameters to default values.

Does NOT write to file or update underlying JSON.

Definition at line 364 of file json_settings.cpp.

365{
366 for( auto param : m_params )
367 param->SetDefault();
368}

References JSON_SETTINGS::m_params.

Referenced by EDA_3D_VIEWER_FRAME::Process_Special_Functions(), PANEL_COMMON_SETTINGS::ResetPanel(), and PANEL_MOUSE_SETTINGS::ResetPanel().

◆ SaveAs()

bool PROJECT_LOCAL_SETTINGS::SaveAs ( const wxString &  aDirectory,
const wxString &  aFile 
)

Definition at line 347 of file project_local_settings.cpp.

348{
349 Set( "meta.filename", aFile + "." + ProjectLocalSettingsFileExtension );
350 SetFilename( aFile );
351
352 return JSON_SETTINGS::SaveToFile( aDirectory, true );
353}
void SetFilename(const wxString &aFilename)
Definition: json_settings.h:77
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...

References ProjectLocalSettingsFileExtension, JSON_SETTINGS::SaveToFile(), JSON_SETTINGS::Set(), and JSON_SETTINGS::SetFilename().

Referenced by SAVE_AS_TRAVERSER::OnFile().

◆ SaveFileState()

void PROJECT_LOCAL_SETTINGS::SaveFileState ( const wxString &  aFileName,
const WINDOW_SETTINGS aWindowCfg,
bool  aOpen 
)

Definition at line 373 of file project_local_settings.cpp.

375{
376 auto it = std::find_if( m_files.begin(), m_files.end(),
377 [&aFileName]( const PROJECT_FILE_STATE& a )
378 {
379 return a.fileName == aFileName;
380 } );
381
382 if( it == m_files.end() )
383 {
384 PROJECT_FILE_STATE fileState;
385 fileState.fileName = aFileName;
386 fileState.open = false;
387 fileState.window.maximized = false;
388 fileState.window.size_x = -1;
389 fileState.window.size_y = -1;
390 fileState.window.pos_x = -1;
391 fileState.window.pos_y = -1;
392 fileState.window.display = 0;
393
394 m_files.push_back( fileState );
395
396 it = m_files.end() - 1;
397 }
398
399 ( *it ).window = aWindowCfg->state;
400 ( *it ).open = aOpen;
401}
WINDOW_STATE state
Definition: app_settings.h:93

References WINDOW_STATE::display, PROJECT_FILE_STATE::fileName, m_files, WINDOW_STATE::maximized, PROJECT_FILE_STATE::open, WINDOW_STATE::pos_x, WINDOW_STATE::pos_y, WINDOW_STATE::size_x, WINDOW_STATE::size_y, WINDOW_SETTINGS::state, and PROJECT_FILE_STATE::window.

Referenced by EDA_BASE_FRAME::SaveSettings().

◆ SaveToFile()

bool PROJECT_LOCAL_SETTINGS::SaveToFile ( const wxString &  aDirectory = "",
bool  aForce = false 
)
overridevirtual
   Calls Store() and then writes the contents of the JSON document to a file
   @param aDirectory is the directory to save to, including trailing separator

c *

Returns
true if the file was saved

Reimplemented from JSON_SETTINGS.

Definition at line 337 of file project_local_settings.cpp.

338{
339 wxASSERT( m_project );
340
341 Set( "meta.filename", m_project->GetProjectName() + "." + ProjectLocalSettingsFileExtension );
342
343 return JSON_SETTINGS::SaveToFile( aDirectory, aForce );
344}
virtual const wxString GetProjectName() const
Return the short name of the project.
Definition: project.cpp:132

References PROJECT::GetProjectName(), m_project, ProjectLocalSettingsFileExtension, JSON_SETTINGS::SaveToFile(), and JSON_SETTINGS::Set().

Referenced by SETTINGS_MANAGER::SaveProject(), KICAD_MANAGER_CONTROL::SaveProjectAs(), SETTINGS_MANAGER::SaveProjectAs(), and SETTINGS_MANAGER::SaveProjectCopy().

◆ Set() [1/3]

template<typename ValueType >
template void JSON_SETTINGS::Set< const char * > ( const std::string &  aPath,
ValueType  aVal 
)
inherited

Stores a value into the JSON document Will throw an exception if ValueType isn't something that the library can handle.

Template Parameters
ValueTypeis the type to store
Parameters
aPathis a path to store in the form "key1.key2.key3"
aValis the value to store

Definition at line 564 of file json_settings.cpp.

565{
566 m_internals->SetFromString( aPath, aVal );
567}

References JSON_SETTINGS::m_internals.

Referenced by COLOR_SETTINGS::COLOR_SETTINGS(), EDA_3D_VIEWER_SETTINGS::EDA_3D_VIEWER_SETTINGS(), EESCHEMA_SETTINGS::EESCHEMA_SETTINGS(), BOARD_DESIGN_SETTINGS::LoadFromFile(), APP_SETTINGS_BASE::migrateFindReplace(), PROJECT_FILE::MigrateFromLegacy(), APP_SETTINGS_BASE::MigrateFromLegacy(), EDA_3D_VIEWER_SETTINGS::MigrateFromLegacy(), EESCHEMA_SETTINGS::MigrateFromLegacy(), SYMBOL_EDITOR_SETTINGS::MigrateFromLegacy(), GERBVIEW_SETTINGS::MigrateFromLegacy(), FOOTPRINT_EDITOR_SETTINGS::MigrateFromLegacy(), COMMON_SETTINGS::MigrateFromLegacy(), KICAD_SETTINGS::MigrateFromLegacy(), PCBNEW_SETTINGS::MigrateFromLegacy(), BOARD_DESIGN_SETTINGS::migrateSchema0to1(), FOOTPRINT_EDITOR_SETTINGS::migrateSchema0to1(), COLOR_SETTINGS::migrateSchema0to1(), PCBNEW_SETTINGS::PCBNEW_SETTINGS(), PROJECT_FILE::SaveAs(), SaveAs(), PROJECT_FILE::SaveToFile(), SaveToFile(), SCHEMATIC_SETTINGS::SCHEMATIC_SETTINGS(), COLOR_MAP_PARAM::Store(), PARAM< ValueType >::Store(), PARAM_PATH::Store(), PARAM_ENUM< EnumType >::Store(), PARAM_LAMBDA< ValueType >::Store(), PARAM_SCALED< ValueType >::Store(), PARAM_LIST< Type >::Store(), PARAM_SET< Type >::Store(), PARAM_PATH_LIST::Store(), and PARAM_MAP< Value >::Store().

◆ Set() [2/3]

template<>
void JSON_SETTINGS::Set ( const std::string &  aPath,
wxString  aVal 
)
inherited

Definition at line 822 of file json_settings.cpp.

823{
824 ( *m_internals )[aPath] = aVal.ToUTF8();
825}

◆ Set() [3/3]

template<>
void JSON_SETTINGS::Set ( const std::string &  aPath,
wxString  aVal 
)
inherited

◆ SetFilename()

void JSON_SETTINGS::SetFilename ( const wxString &  aFilename)
inlineinherited

◆ SetIfPresent() [1/4]

bool JSON_SETTINGS::SetIfPresent ( const nlohmann::json aObj,
const std::string &  aPath,
bool &  aTarget 
)
staticinherited

Sets the given bool if the given key/path is present.

Parameters
aObjis the source object
aTargetis the storage destination
Returns
True if set, false if not

Definition at line 649 of file json_settings.cpp.

651{
652 nlohmann::json::json_pointer ptr = JSON_SETTINGS_INTERNALS::PointerFromString( aPath );
653
654 if( aObj.contains( ptr ) && aObj.at( ptr ).is_boolean() )
655 {
656 aTarget = aObj.at( ptr ).get<bool>();
657 return true;
658 }
659
660 return false;
661}

References JSON_SETTINGS_INTERNALS::PointerFromString().

◆ SetIfPresent() [2/4]

bool JSON_SETTINGS::SetIfPresent ( const nlohmann::json aObj,
const std::string &  aPath,
int &  aTarget 
)
staticinherited

Sets the given int if the given key/path is present.

Parameters
aObjis the source object
aTargetis the storage destination
Returns
True if set, false if not

Definition at line 664 of file json_settings.cpp.

666{
667 nlohmann::json::json_pointer ptr = JSON_SETTINGS_INTERNALS::PointerFromString( aPath );
668
669 if( aObj.contains( ptr ) && aObj.at( ptr ).is_number_integer() )
670 {
671 aTarget = aObj.at( ptr ).get<int>();
672 return true;
673 }
674
675 return false;
676}

References JSON_SETTINGS_INTERNALS::PointerFromString().

◆ SetIfPresent() [3/4]

bool JSON_SETTINGS::SetIfPresent ( const nlohmann::json aObj,
const std::string &  aPath,
unsigned int &  aTarget 
)
staticinherited

Sets the given unsigned int if the given key/path is present.

Parameters
aObjis the source object
aTargetis the storage destination
Returns
True if set, false if not

Definition at line 679 of file json_settings.cpp.

681{
682 nlohmann::json::json_pointer ptr = JSON_SETTINGS_INTERNALS::PointerFromString( aPath );
683
684 if( aObj.contains( ptr ) && aObj.at( ptr ).is_number_unsigned() )
685 {
686 aTarget = aObj.at( ptr ).get<unsigned int>();
687 return true;
688 }
689
690 return false;
691}

References JSON_SETTINGS_INTERNALS::PointerFromString().

◆ SetIfPresent() [4/4]

bool JSON_SETTINGS::SetIfPresent ( const nlohmann::json aObj,
const std::string &  aPath,
wxString &  aTarget 
)
staticinherited

Sets the given string if the given key/path is present.

Parameters
aObjis the source object
aTargetis the storage destination
Returns
True if set, false if not

Definition at line 634 of file json_settings.cpp.

636{
637 nlohmann::json::json_pointer ptr = JSON_SETTINGS_INTERNALS::PointerFromString( aPath );
638
639 if( aObj.contains( ptr ) && aObj.at( ptr ).is_string() )
640 {
641 aTarget = aObj.at( ptr ).get<wxString>();
642 return true;
643 }
644
645 return false;
646}

References JSON_SETTINGS_INTERNALS::PointerFromString().

Referenced by FOOTPRINT_EDITOR_SETTINGS::FOOTPRINT_EDITOR_SETTINGS(), and PROJECT_LOCAL_SETTINGS().

◆ SetLegacyFilename()

void JSON_SETTINGS::SetLegacyFilename ( const wxString &  aFilename)
inlineinherited

Definition at line 82 of file json_settings.h.

82{ m_legacy_filename = aFilename; }

References JSON_SETTINGS::m_legacy_filename.

Referenced by SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS().

◆ SetLocation()

void JSON_SETTINGS::SetLocation ( SETTINGS_LOC  aLocation)
inlineinherited

Definition at line 79 of file json_settings.h.

79{ m_location = aLocation; }

References JSON_SETTINGS::m_location.

Referenced by COLOR_SETTINGS::COLOR_SETTINGS().

◆ SetManager()

void JSON_SETTINGS::SetManager ( SETTINGS_MANAGER aManager)
inlineinherited

Definition at line 191 of file json_settings.h.

192 {
193 m_manager = aManager;
194 }

References JSON_SETTINGS::m_manager.

◆ SetProject()

void PROJECT_LOCAL_SETTINGS::SetProject ( PROJECT aProject)
inline

Definition at line 66 of file project_local_settings.h.

66{ m_project = aProject; }

References m_project.

◆ SetReadOnly()

◆ Store()

bool JSON_SETTINGS::Store ( )
virtualinherited

Stores the current parameters into the JSON document represented by this object Note: this doesn't do any writing to disk; that's handled by SETTINGS_MANAGER.

Returns
true if any part of the JSON document was updated

Definition at line 350 of file json_settings.cpp.

351{
352 bool modified = false;
353
354 for( auto param : m_params )
355 {
356 modified |= !param->MatchesFile( this );
357 param->Store( this );
358 }
359
360 return modified;
361}

References JSON_SETTINGS::m_params.

Referenced by PANEL_FP_EDITOR_COLOR_SETTINGS::PANEL_FP_EDITOR_COLOR_SETTINGS(), SETTINGS_MANAGER::SaveColorSettings(), JSON_SETTINGS::SaveToFile(), and NESTED_SETTINGS::SaveToFile().

Member Data Documentation

◆ m_ActiveLayer

PCB_LAYER_ID PROJECT_LOCAL_SETTINGS::m_ActiveLayer

The current (active) board layer for editing.

Definition at line 105 of file project_local_settings.h.

Referenced by PCB_EDIT_FRAME::onBoardLoaded(), PROJECT_LOCAL_SETTINGS(), and PCB_EDIT_FRAME::SaveProjectSettings().

◆ m_ActiveLayerPreset

wxString PROJECT_LOCAL_SETTINGS::m_ActiveLayerPreset

The name of a LAYER_PRESET that is currently activated (or blank if none)

Definition at line 108 of file project_local_settings.h.

Referenced by PCB_EDIT_FRAME::onBoardLoaded(), PROJECT_LOCAL_SETTINGS(), and PCB_EDIT_FRAME::SaveProjectSettings().

◆ m_AutoTrackWidth

bool PROJECT_LOCAL_SETTINGS::m_AutoTrackWidth

The current setting for whether to automatically adjust track widths to match.

Definition at line 117 of file project_local_settings.h.

Referenced by PCB_EDIT_FRAME::LoadProjectSettings(), PROJECT_LOCAL_SETTINGS(), and PCB_EDIT_FRAME::SaveProjectSettings().

◆ m_ContrastModeDisplay

HIGH_CONTRAST_MODE PROJECT_LOCAL_SETTINGS::m_ContrastModeDisplay

◆ m_createIfDefault

bool JSON_SETTINGS::m_createIfDefault
protectedinherited

Whether or not the backing store file should be created if all parameters are still at their default values.

Ignored if m_createIfMissing is false or m_writeFile is false.

Definition at line 318 of file json_settings.h.

Referenced by JSON_SETTINGS::SaveToFile().

◆ m_createIfMissing

bool JSON_SETTINGS::m_createIfMissing
protectedinherited

Whether or not the backing store file should be created it if doesn't exist.

Definition at line 312 of file json_settings.h.

Referenced by JSON_SETTINGS::SaveToFile().

◆ m_deleteLegacyAfterMigration

bool JSON_SETTINGS::m_deleteLegacyAfterMigration
protectedinherited

Whether or not to delete legacy file after migration.

Definition at line 324 of file json_settings.h.

Referenced by JSON_SETTINGS::LoadFromFile(), PROJECT_FILE::PROJECT_FILE(), and PROJECT_LOCAL_SETTINGS().

◆ m_filename

◆ m_files

std::vector<PROJECT_FILE_STATE> PROJECT_LOCAL_SETTINGS::m_files

Project scope.

File based state

Definition at line 92 of file project_local_settings.h.

Referenced by ClearFileState(), GetFileState(), PROJECT_LOCAL_SETTINGS(), and SaveFileState().

◆ m_HiddenNetclasses

std::set<wxString> PROJECT_LOCAL_SETTINGS::m_HiddenNetclasses

◆ m_HiddenNets

std::vector<wxString> PROJECT_LOCAL_SETTINGS::m_HiddenNets

A list of netnames that have been manually hidden in the board editor.

Currently, hiding nets means hiding the ratsnest for those nets.

Definition at line 132 of file project_local_settings.h.

Referenced by PCB_EDIT_FRAME::LoadProjectSettings(), PROJECT_LOCAL_SETTINGS(), and PCB_EDIT_FRAME::SaveProjectSettings().

◆ m_ImageOpacity

double PROJECT_LOCAL_SETTINGS::m_ImageOpacity

Opacity override for user images.

Definition at line 126 of file project_local_settings.h.

Referenced by PCB_EDIT_FRAME::LoadProjectSettings(), PROJECT_LOCAL_SETTINGS(), and PCB_EDIT_FRAME::SaveProjectSettings().

◆ m_internals

◆ m_legacy_filename

wxString JSON_SETTINGS::m_legacy_filename
protectedinherited

The filename of the wxConfig legacy file (if different from m_filename)

Definition at line 300 of file json_settings.h.

Referenced by JSON_SETTINGS::LoadFromFile(), and JSON_SETTINGS::SetLegacyFilename().

◆ m_location

SETTINGS_LOC JSON_SETTINGS::m_location
protectedinherited

The location of this settings file (.

See also
SETTINGS_LOC)

Definition at line 303 of file json_settings.h.

Referenced by JSON_SETTINGS::GetLocation(), and JSON_SETTINGS::SetLocation().

◆ m_manager

SETTINGS_MANAGER* JSON_SETTINGS::m_manager
protectedinherited

A pointer to the settings manager managing this file (may be null)

Definition at line 333 of file json_settings.h.

Referenced by FOOTPRINT_EDITOR_SETTINGS::migrateSchema0to1(), COLOR_SETTINGS::migrateSchema0to1(), JSON_SETTINGS::ReleaseNestedSettings(), and JSON_SETTINGS::SetManager().

◆ m_migrators

std::map<int, std::pair<int, std::function<bool()> > > JSON_SETTINGS::m_migrators
protectedinherited

A map of starting schema version to a pair of <ending version, migrator function>

Definition at line 336 of file json_settings.h.

Referenced by JSON_SETTINGS::Migrate(), and JSON_SETTINGS::registerMigration().

◆ m_nested_settings

std::vector<NESTED_SETTINGS*> JSON_SETTINGS::m_nested_settings
protectedinherited

Nested settings files that live inside this one, if any.

Definition at line 309 of file json_settings.h.

Referenced by JSON_SETTINGS::AddNestedSettings(), JSON_SETTINGS::LoadFromFile(), JSON_SETTINGS::ReleaseNestedSettings(), and JSON_SETTINGS::SaveToFile().

◆ m_NetColorMode

NET_COLOR_MODE PROJECT_LOCAL_SETTINGS::m_NetColorMode

◆ m_PadOpacity

double PROJECT_LOCAL_SETTINGS::m_PadOpacity

Opacity override for SMD pads and PTH.

Definition at line 124 of file project_local_settings.h.

Referenced by PCB_EDIT_FRAME::LoadProjectSettings(), PROJECT_LOCAL_SETTINGS(), and PCB_EDIT_FRAME::SaveProjectSettings().

◆ m_params

◆ m_project

PROJECT* PROJECT_LOCAL_SETTINGS::m_project
private

A link to the owning project.

Definition at line 140 of file project_local_settings.h.

Referenced by SaveToFile(), and SetProject().

◆ m_resetParamsIfMissing

bool JSON_SETTINGS::m_resetParamsIfMissing
protectedinherited

Whether or not to set parameters to their default value if missing from JSON on Load()

Definition at line 327 of file json_settings.h.

Referenced by BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), and JSON_SETTINGS::Load().

◆ m_schemaVersion

int JSON_SETTINGS::m_schemaVersion
protectedinherited

◆ m_SelectionFilter

SELECTION_FILTER_OPTIONS PROJECT_LOCAL_SETTINGS::m_SelectionFilter

State of the selection filter widget.

Definition at line 136 of file project_local_settings.h.

Referenced by PCB_EDIT_FRAME::LoadProjectSettings(), PROJECT_LOCAL_SETTINGS(), and PCB_EDIT_FRAME::SaveProjectSettings().

◆ m_TrackOpacity

double PROJECT_LOCAL_SETTINGS::m_TrackOpacity

Opacity override for all tracks.

Definition at line 122 of file project_local_settings.h.

Referenced by PCB_EDIT_FRAME::LoadProjectSettings(), PROJECT_LOCAL_SETTINGS(), and PCB_EDIT_FRAME::SaveProjectSettings().

◆ m_ViaOpacity

double PROJECT_LOCAL_SETTINGS::m_ViaOpacity

Opacity override for all types of via.

Definition at line 123 of file project_local_settings.h.

Referenced by PCB_EDIT_FRAME::LoadProjectSettings(), PROJECT_LOCAL_SETTINGS(), and PCB_EDIT_FRAME::SaveProjectSettings().

◆ m_VisibleItems

GAL_SET PROJECT_LOCAL_SETTINGS::m_VisibleItems

The GAL layers (aka items) that are turned on for viewing (.

See also
GAL_LAYER_ID)

Definition at line 102 of file project_local_settings.h.

Referenced by BOARD::GetVisibleElements(), BOARD::IsElementVisible(), PCB_EDIT_FRAME::OpenProjectFiles(), PROJECT_LOCAL_SETTINGS(), and BOARD::SetElementVisibility().

◆ m_VisibleLayers

LSET PROJECT_LOCAL_SETTINGS::m_VisibleLayers

Board settings.

The board layers that are turned on for viewing (

See also
PCB_LAYER_ID)

Definition at line 99 of file project_local_settings.h.

Referenced by BOARD::GetVisibleLayers(), BOARD::IsLayerVisible(), PCB_EDIT_FRAME::OpenProjectFiles(), PROJECT_LOCAL_SETTINGS(), and BOARD::SetVisibleLayers().

◆ m_writeFile

bool JSON_SETTINGS::m_writeFile
protectedinherited

◆ m_ZoneDisplayMode

ZONE_DISPLAY_MODE PROJECT_LOCAL_SETTINGS::m_ZoneDisplayMode

◆ m_ZoneOpacity

double PROJECT_LOCAL_SETTINGS::m_ZoneOpacity

Opacity override for filled zones.

Definition at line 125 of file project_local_settings.h.

Referenced by PCB_EDIT_FRAME::LoadProjectSettings(), PROJECT_LOCAL_SETTINGS(), and PCB_EDIT_FRAME::SaveProjectSettings().


The documentation for this class was generated from the following files: