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 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)
 
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
 
size_t Count (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...
 
bool IsDefault (const std::string &aParamName)
 Checks if the current state of a parameter matches its default value. More...
 
OPT< 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 >
OPT< ValueType > Get (const std::string &aPath) const
 Fetches a value from within the JSON document. More...
 
template<>
OPT< 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)
 

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...
 
RATSNEST_MODE m_RatsnestMode
 The current ratsnest draw 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...
 
std::vector< wxString > m_HiddenNets
 A list of netnames that have been manually hidden in the board editor. More...
 
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...
 

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 ),
35  m_project( aProject )
36 {
37  m_params.emplace_back( new PARAM_LAMBDA<std::string>( "board.visible_layers",
38  [&]() -> std::string
39  {
40  return m_VisibleLayers.FmtHex();
41  },
42  [&]( const std::string& aString )
43  {
44  m_VisibleLayers.ParseHex( aString.c_str(), aString.size() );
45  },
47 
48  m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "board.visible_items",
49  [&]() -> nlohmann::json
50  {
51  nlohmann::json ret = nlohmann::json::array();
52 
53  for( size_t i = 0; i < m_VisibleItems.size(); i++ )
54  if( m_VisibleItems.test( i ) )
55  ret.push_back( i );
56 
57  return ret;
58  },
59  [&]( const nlohmann::json& aVal )
60  {
61  if( !aVal.is_array() || aVal.empty() )
62  {
64  return;
65  }
66 
67  m_VisibleItems.reset();
68 
69  for( const nlohmann::json& entry : aVal )
70  {
71  try
72  {
73  int i = entry.get<int>();
74  m_VisibleItems.set( i );
75  }
76  catch( ... )
77  {
78  // Non-integer or out of range entry in the array; ignore
79  }
80  }
81  },
82  {} ) );
83 
84  m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "board.selection_filter",
85  [&]() -> nlohmann::json
86  {
87  nlohmann::json ret;
88 
89  ret["lockedItems"] = m_SelectionFilter.lockedItems;
90  ret["footprints"] = m_SelectionFilter.footprints;
91  ret["text"] = m_SelectionFilter.text;
92  ret["tracks"] = m_SelectionFilter.tracks;
93  ret["vias"] = m_SelectionFilter.vias;
94  ret["pads"] = m_SelectionFilter.pads;
95  ret["graphics"] = m_SelectionFilter.graphics;
96  ret["zones"] = m_SelectionFilter.zones;
97  ret["keepouts"] = m_SelectionFilter.keepouts;
98  ret["dimensions"] = m_SelectionFilter.dimensions;
99  ret["otherItems"] = m_SelectionFilter.otherItems;
100 
101  return ret;
102  },
103  [&]( const nlohmann::json& aVal )
104  {
105  if( aVal.empty() || !aVal.is_object() )
106  return;
107 
108  SetIfPresent( aVal, "lockedItems", m_SelectionFilter.lockedItems );
109  SetIfPresent( aVal, "footprints", m_SelectionFilter.footprints );
110  SetIfPresent( aVal, "text", m_SelectionFilter.text );
111  SetIfPresent( aVal, "tracks", m_SelectionFilter.tracks );
112  SetIfPresent( aVal, "vias", m_SelectionFilter.vias );
113  SetIfPresent( aVal, "pads", m_SelectionFilter.pads );
114  SetIfPresent( aVal, "graphics", m_SelectionFilter.graphics );
115  SetIfPresent( aVal, "zones", m_SelectionFilter.zones );
116  SetIfPresent( aVal, "keepouts", m_SelectionFilter.keepouts );
117  SetIfPresent( aVal, "dimensions", m_SelectionFilter.dimensions );
118  SetIfPresent( aVal, "otherItems", m_SelectionFilter.otherItems );
119  },
120  {
121  { "lockedItems", true },
122  { "footprints", true },
123  { "text", true },
124  { "tracks", true },
125  { "vias", true },
126  { "pads", true },
127  { "graphics", true },
128  { "zones", true },
129  { "keepouts", true },
130  { "dimensions", true },
131  { "otherItems", true }
132  } ) );
133 
134  m_params.emplace_back( new PARAM_ENUM<PCB_LAYER_ID>( "board.active_layer",
136 
137  m_params.emplace_back( new PARAM<wxString>( "board.active_layer_preset",
138  &m_ActiveLayerPreset, "" ) );
139 
140  m_params.emplace_back( new PARAM_ENUM<HIGH_CONTRAST_MODE>( "board.high_contrast_mode",
143 
144  m_params.emplace_back( new PARAM<double>( "board.opacity.tracks", &m_TrackOpacity, 1.0 ) );
145  m_params.emplace_back( new PARAM<double>( "board.opacity.vias", &m_ViaOpacity, 1.0 ) );
146  m_params.emplace_back( new PARAM<double>( "board.opacity.pads", &m_PadOpacity, 1.0 ) );
147  m_params.emplace_back( new PARAM<double>( "board.opacity.zones", &m_ZoneOpacity, 0.6 ) );
148 
149  m_params.emplace_back( new PARAM_LIST<wxString>( "board.hidden_nets", &m_HiddenNets, {} ) );
150 
151  m_params.emplace_back( new PARAM_ENUM<NET_COLOR_MODE>( "board.net_color_mode",
154 
155  m_params.emplace_back( new PARAM_ENUM<RATSNEST_MODE>( "board.ratsnest_display_mode",
158 
159  m_params.emplace_back( new PARAM<bool>( "board.auto_track_width",
160  &m_AutoTrackWidth, true ) );
161 
162  m_params.emplace_back( new PARAM_ENUM<ZONE_DISPLAY_MODE>( "board.zone_display_mode",
166 
167  m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "project.files",
168  [&]() -> nlohmann::json
169  {
170  nlohmann::json ret = nlohmann::json::array();
171 
172  for( PROJECT_FILE_STATE& fileState : m_files )
173  {
174  nlohmann::json file;
175  file["name"] = fileState.fileName;
176  file["open"] = fileState.open;
177 
178  nlohmann::json window;
179  window["maximized"] = fileState.window.maximized;
180  window["size_x"] = fileState.window.size_x;
181  window["size_y"] = fileState.window.size_y;
182  window["pos_x"] = fileState.window.pos_x;
183  window["pos_y"] = fileState.window.pos_y;
184  window["display"] = fileState.window.display;
185 
186  file["window"] = window;
187 
188  ret.push_back( file );
189  }
190 
191  return ret;
192  },
193  [&]( const nlohmann::json& aVal )
194  {
195  if( !aVal.is_array() || aVal.empty() )
196  {
197  return;
198  }
199 
200  for( const nlohmann::json& file : aVal )
201  {
202  PROJECT_FILE_STATE fileState;
203 
204  try
205  {
206  SetIfPresent( file, "name", fileState.fileName );
207  SetIfPresent( file, "open", fileState.open );
208  SetIfPresent( file, "window.size_x", fileState.window.size_x );
209  SetIfPresent( file, "window.size_y", fileState.window.size_y );
210  SetIfPresent( file, "window.pos_x", fileState.window.pos_x );
211  SetIfPresent( file, "window.pos_y", fileState.window.pos_y );
212  SetIfPresent( file, "window.maximized", fileState.window.maximized );
213  SetIfPresent( file, "window.display", fileState.window.display );
214 
215  m_files.push_back( fileState );
216  }
217  catch( ... )
218  {
219  // Non-integer or out of range entry in the array; ignore
220  }
221  }
222 
223  },
224  {
225  } ) );
226 
227  registerMigration( 1, 2,
228  [&]()
229  {
235  std::string ptr( "board.visible_items" );
236 
237  if( Contains( ptr ) )
238  {
239  if( At( ptr ).is_array() )
240  {
241  At( ptr ).push_back( LAYER_PADS );
242  At( ptr ).push_back( LAYER_ZONES );
243  }
244  else
245  {
246  At( "board" ).erase( "visible_items" );
247  }
248  }
249 
250  return true;
251  } );
252 
253  registerMigration( 2, 3,
254  [&]()
255  {
262  const std::map<int, int> offsets = {
264  { 22, 34 }, // LAYER_PAD_HOLEWALLS
265  { 23, 22 }, // LAYER_VIA_HOLES
266  { 24, 35 }, // LAYER_VIA_HOLEWALLS
267  { 25, 23 }, // LAYER_DRC_ERROR
268  { 26, 36 }, // LAYER_DRC_WARNING
269  { 27, 37 }, // LAYER_DRC_EXCLUSION
270  { 28, 38 }, // LAYER_MARKER_SHADOWS
271  { 29, 24 }, // LAYER_DRAWINGSHEET
272  { 30, 25 }, // LAYER_GP_OVERLAY
273  { 31, 26 }, // LAYER_SELECT_OVERLAY
274  { 32, 27 }, // LAYER_PCB_BACKGROUND
275  { 33, 28 }, // LAYER_CURSOR
276  { 34, 29 }, // LAYER_AUX_ITEM
277  { 35, 30 }, // LAYER_DRAW_BITMAPS
278  { 39, 32 }, // LAYER_PADS
279  { 40, 33 }, // LAYER_ZONES
280  };
281 
282  std::string ptr( "board.visible_items" );
283 
284  if( Contains( ptr ) && At( ptr ).is_array() )
285  {
286  nlohmann::json visible = nlohmann::json::array();
287 
288  for( const nlohmann::json& val : At( ptr ) )
289  {
290  try
291  {
292  int layer = val.get<int>();
293 
294  if( offsets.count( layer ) )
295  visible.push_back( offsets.at( layer ) );
296  else
297  visible.push_back( layer );
298  }
299  catch( ... )
300  {
301  // skip invalid value
302  }
303  }
304 
305  At( "board" )["visible_items"] = visible;
306  }
307 
308  return true;
309  } );
310 }
LSET m_VisibleLayers
Board settings.
Filled polygons are shown.
bool otherItems
Anything not fitting one of the above categories.
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)
const int projectLocalSettingsVersion
Like a normal param, but with custom getter and setter functions.
Definition: parameters.h:296
Ratsnest lines are drawn to items on visible layers only.
double m_TrackOpacity
Opacity override for all tracks.
Outlines of filled polygons are shown.
ZONE_DISPLAY_MODE m_ZoneDisplayMode
How zones are drawn.
Control for copper zone opacity/visibility (color ignored)
Net/netclass colors are shown on all net copper.
Net/netclass colors are shown on ratsnest lines only.
double m_ViaOpacity
Opacity override for all types of via.
Stores an enum as an integer.
Definition: parameters.h:226
NET_COLOR_MODE m_NetColorMode
The current net color mode.
PCB_LAYER_ID m_ActiveLayer
The current (active) board layer for editing.
nlohmann::json json
Definition: gerbview.cpp:41
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...
Ratsnest lines are drawn to items on all layers (default)
double m_PadOpacity
Opacity override for SMD pads and PTH.
bool text
Text (free or attached to a footprint)
GAL_SET m_VisibleItems
The GAL layers (aka items) that are turned on for viewing (.
The settings directory inside a project folder.
wxString m_ActiveLayerPreset
The name of a LAYER_PRESET that is currently activated (or blank if none)
bool dimensions
Dimension items.
bool graphics
Graphic lines, shapes, polygons.
static bool SetIfPresent(const nlohmann::json &aObj, const std::string &aPath, wxString &aTarget)
Sets the given string if the given key/path is present.
struct WINDOW_STATE window
PROJECT * m_project
A link to the owning project.
Meta control for all pads opacity/visibility (color ignored)
Inactive layers are shown normally (no high-contrast mode)
static GAL_SET DefaultVisible()
Definition: lset.cpp:933
RATSNEST_MODE m_RatsnestMode
The current ratsnest draw mode.
static LSET AllLayersMask()
Definition: lset.cpp:787
bool m_AutoTrackWidth
The current setting for whether to automatically adjust track widths to match.
double m_ZoneOpacity
Opacity override for filled zones.
JSON_SETTINGS(const wxString &aFilename, SETTINGS_LOC aLocation, int aSchemaVersion)
Definition: json_settings.h:63
bool footprints
Allow selecting entire footprints.
bool lockedItems
Allow selecting locked items.
HIGH_CONTRAST_MODE m_ContrastModeDisplay
The current contrast mode.
void registerMigration(int aOldSchemaVersion, int aNewSchemaVersion, std::function< bool(void)> aMigrator)
Registers a migration from one schema version to another.
Net (and netclass) colors are not shown.
std::string FmtHex() const
Return a hex string showing contents of this LSEQ.
Definition: lset.cpp:321
std::vector< wxString > m_HiddenNets
A list of netnames that have been manually hidden in the board editor.
SELECTION_FILTER_OPTIONS m_SelectionFilter
State of the selection filter widget.
bool Contains(const std::string &aPath) const
Inactive layers are hidden.
unsigned int display
Definition: app_settings.h:75
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
std::vector< PROJECT_FILE_STATE > m_files
Project scope.

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, m_files, m_HiddenNets, m_NetColorMode, m_PadOpacity, JSON_SETTINGS::m_params, m_RatsnestMode, 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_FILLED_OUTLINE, WINDOW_STATE::size_x, WINDOW_STATE::size_y, SELECTION_FILTER_OPTIONS::text, SELECTION_FILTER_OPTIONS::tracks, SELECTION_FILTER_OPTIONS::vias, VISIBLE, 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 753 of file json_settings.cpp.

754 {
755  wxLogTrace( traceSettings, "AddNestedSettings %s", aSettings->GetFilename() );
756  m_nested_settings.push_back( aSettings );
757 }
wxString GetFilename() const
Definition: json_settings.h:71
std::vector< NESTED_SETTINGS * > m_nested_settings
Nested settings files that live inside this one, if any.
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 110 of file json_settings.cpp.

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

References JSON_SETTINGS::m_internals.

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

◆ ClearFileState()

void PROJECT_LOCAL_SETTINGS::ClearFileState ( )

Definition at line 375 of file project_local_settings.cpp.

376 {
377  m_files.clear();
378 }
std::vector< PROJECT_FILE_STATE > m_files
Project scope.

References m_files.

Referenced by KICAD_MANAGER_FRAME::OnIdle().

◆ Contains()

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

Definition at line 116 of file json_settings.cpp.

117 {
118  return m_internals->contains( JSON_SETTINGS_INTERNALS::PointerFromString( aPath ) );
119 }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.
std::unique_ptr< JSON_SETTINGS_INTERNALS > m_internals

References JSON_SETTINGS::m_internals, and JSON_SETTINGS_INTERNALS::PointerFromString().

Referenced by BOARD_DESIGN_SETTINGS::LoadFromFile(), EESCHEMA_SETTINGS::migrateBomSettings(), COLOR_SETTINGS::migrateSchema0to1(), BOARD_DESIGN_SETTINGS::migrateSchema0to1(), PROJECT_LOCAL_SETTINGS(), and SETTINGS_MANAGER::SaveColorSettings().

◆ Count()

size_t JSON_SETTINGS::Count ( const std::string &  aPath) const
inherited

Definition at line 122 of file json_settings.cpp.

123 {
125 }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.
std::unique_ptr< JSON_SETTINGS_INTERNALS > m_internals

References JSON_SETTINGS::m_internals, and JSON_SETTINGS_INTERNALS::PointerFromString().

Referenced by FOOTPRINT_EDITOR_SETTINGS::migrateSchema0to1().

◆ 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 665 of file json_settings.cpp.

667 {
668  ValueType val;
669 
670  if( aConfig->Read( aKey, &val ) )
671  {
672  try
673  {
674  ( *m_internals )[aDest] = val;
675  }
676  catch( ... )
677  {
678  wxASSERT_MSG( false, wxT( "Could not write value in fromLegacy!" ) );
679  return false;
680  }
681 
682  return true;
683  }
684 
685  return false;
686 }

◆ 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 725 of file json_settings.cpp.

727 {
728  wxString str;
729 
730  if( aConfig->Read( aKey, &str ) )
731  {
733  color.SetFromWxString( str );
734 
735  try
736  {
737  nlohmann::json js = nlohmann::json::array( { color.r, color.g, color.b, color.a } );
738  ( *m_internals )[aDest] = js;
739  }
740  catch( ... )
741  {
742  wxASSERT_MSG( false, wxT( "Could not write value in fromLegacyColor!" ) );
743  return false;
744  }
745 
746  return true;
747  }
748 
749  return false;
750 }
int color
Definition: DXF_plotter.cpp:60
nlohmann::json json
Definition: gerbview.cpp:41
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:103

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 701 of file json_settings.cpp.

703 {
704  wxString str;
705 
706  if( aConfig->Read( aKey, &str ) )
707  {
708  try
709  {
710  ( *m_internals )[aDest] = str.ToUTF8();
711  }
712  catch( ... )
713  {
714  wxASSERT_MSG( false, wxT( "Could not write value in fromLegacyString!" ) );
715  return false;
716  }
717 
718  return true;
719  }
720 
721  return false;
722 }

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

◆ Get() [1/2]

template<typename ValueType >
template OPT< 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 504 of file json_settings.cpp.

505 {
506  if( OPT<nlohmann::json> ret = GetJson( aPath ) )
507  {
508  try
509  {
510  return ret->get<ValueType>();
511  }
512  catch( ... )
513  {
514  }
515  }
516 
517  return NULLOPT;
518 }
OPT< 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....
const auto NULLOPT
Definition: optional.h:9
boost::optional< T > OPT
Definition: optional.h:7

References JSON_SETTINGS::GetJson(), and NULLOPT.

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

◆ Get() [2/2]

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

Definition at line 783 of file json_settings.cpp.

784 {
785  if( OPT<nlohmann::json> opt_json = GetJson( aPath ) )
786  return wxString( opt_json->get<std::string>().c_str(), wxConvUTF8 );
787 
788  return NULLOPT;
789 }
OPT< 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....
const auto NULLOPT
Definition: optional.h:9
boost::optional< T > OPT
Definition: optional.h:7

References JSON_SETTINGS::GetJson(), and NULLOPT.

◆ getFileExt()

wxString PROJECT_LOCAL_SETTINGS::getFileExt ( ) const
inlineoverrideprotectedvirtual

Reimplemented from JSON_SETTINGS.

Definition at line 76 of file project_local_settings.h.

77  {
79  }
const std::string ProjectLocalSettingsFileExtension

References ProjectLocalSettingsFileExtension.

◆ GetFilename()

◆ GetFileState()

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

Definition at line 334 of file project_local_settings.cpp.

335 {
336  auto it = std::find_if( m_files.begin(), m_files.end(),
337  [&aFileName]( const PROJECT_FILE_STATE &a )
338  {
339  return a.fileName == aFileName;
340  } );
341 
342  if( it != m_files.end() )
343  {
344  return &( *it );
345  }
346 
347  return nullptr;
348 }
std::vector< PROJECT_FILE_STATE > m_files
Project scope.

References m_files.

Referenced by EDA_BASE_FRAME::LoadWindowState().

◆ GetFullFilename()

wxString JSON_SETTINGS::GetFullFilename ( ) const
inherited

Definition at line 104 of file json_settings.cpp.

105 {
106  return wxString( m_filename + "." + getFileExt() );
107 }
wxString m_filename
The filename (not including path) of this settings file (inicode)
virtual wxString getFileExt() const

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

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

◆ GetJson()

OPT< 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 484 of file json_settings.cpp.

485 {
486  nlohmann::json::json_pointer ptr = m_internals->PointerFromString( aPath );
487 
488  if( m_internals->contains( ptr ) )
489  {
490  try
491  {
492  return OPT<nlohmann::json>{ m_internals->at( ptr ) };
493  }
494  catch( ... )
495  {
496  }
497  }
498 
499  return OPT<nlohmann::json>{};
500 }
std::unique_ptr< JSON_SETTINGS_INTERNALS > m_internals
boost::optional< T > OPT
Definition: optional.h:7

References JSON_SETTINGS::m_internals.

Referenced by JSON_SETTINGS::Get(), PARAM_LAMBDA< nlohmann::json >::Load(), PARAM_LIST< wxString >::Load(), PARAM_MAP< Value >::Load(), PARAM_WXSTRING_MAP::Load(), PARAM_LAMBDA< nlohmann::json >::MatchesFile(), PARAM_LIST< wxString >::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 81 of file project_local_settings.h.

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

◆ GetLocation()

SETTINGS_LOC JSON_SETTINGS::GetLocation ( ) const
inlineinherited

Definition at line 77 of file json_settings.h.

77 { 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 128 of file json_settings.cpp.

129 {
130  return m_internals.get();
131 }
std::unique_ptr< JSON_SETTINGS_INTERNALS > m_internals

References JSON_SETTINGS::m_internals.

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

◆ IsDefault()

bool JSON_SETTINGS::IsDefault ( const std::string &  aParamName)
inherited

Checks if the current state of a parameter matches its default value.

Parameters
aParamNameis the JSON path to the parameter
Returns
true if the given parameter is at its default value

Definition at line 372 of file json_settings.cpp.

373 {
374  for( const PARAM_BASE* param : m_params )
375  {
376  if( param->GetJsonPath() == aParamName )
377  return param->IsDefault();
378  }
379 
380  return false;
381 }
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)

References JSON_SETTINGS::m_params.

◆ IsReadOnly()

◆ Load()

void JSON_SETTINGS::Load ( )
virtualinherited

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

Definition at line 134 of file json_settings.cpp.

135 {
136  for( auto param : m_params )
137  {
138  try
139  {
140  param->Load( this, m_resetParamsIfMissing );
141  }
142  catch( ... )
143  {
144  // Skip unreadable parameters in file
145  wxLogTrace( traceSettings, "param '%s' load err", param->GetJsonPath().c_str() );
146  }
147  }
148 }
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)
bool m_resetParamsIfMissing
Whether or not to set parameters to their default value if missing from JSON on Load()
const wxChar *const traceSettings
Flag to enable debug output of settings operations and management.

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

Referenced by COLOR_SETTINGS::CreateBuiltinColorSettings(), NESTED_SETTINGS::LoadFromFile(), JSON_SETTINGS::LoadFromFile(), BOARD_DESIGN_SETTINGS::LoadFromFile(), COLOR_SETTINGS::migrateSchema0to1(), 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 151 of file json_settings.cpp.

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

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::SaveColorSettings().

◆ 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 562 of file json_settings.cpp.

563 {
564  int filever = m_internals->Get<int>( "meta.version" );
565 
566  while( filever < m_schemaVersion )
567  {
568  if( !m_migrators.count( filever ) )
569  {
570  wxLogTrace( traceSettings, "Migrator missing for %s version %d!",
571  typeid( *this ).name(), filever );
572  return false;
573  }
574 
575  std::pair<int, std::function<bool()>> pair = m_migrators.at( filever );
576 
577  if( pair.second() )
578  {
579  wxLogTrace( traceSettings, "Migrated %s from %d to %d", typeid( *this ).name(),
580  filever, pair.first );
581  filever = pair.first;
582  m_internals->At( "meta.version" ) = filever;
583  }
584  else
585  {
586  wxLogTrace( traceSettings, "Migration failed for %s from %d to %d",
587  typeid( *this ).name(), filever, pair.first );
588  return false;
589  }
590  }
591 
592  return true;
593 }
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>
std::unique_ptr< JSON_SETTINGS_INTERNALS > m_internals
const wxChar *const traceSettings
Flag to enable debug output of settings operations and management.
int m_schemaVersion
Version of this settings schema.

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

Referenced by NESTED_SETTINGS::LoadFromFile(), and JSON_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 313 of file project_local_settings.cpp.

314 {
320  return true;
321 }

◆ 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 553 of file json_settings.cpp.

555 {
556  wxASSERT( aNewSchemaVersion > aOldSchemaVersion );
557  wxASSERT( aNewSchemaVersion <= m_schemaVersion );
558  m_migrators[aOldSchemaVersion] = std::make_pair( aNewSchemaVersion, aMigrator );
559 }
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>
int m_schemaVersion
Version of this settings schema.

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

Referenced by BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), COLOR_SETTINGS::COLOR_SETTINGS(), EESCHEMA_SETTINGS::EESCHEMA_SETTINGS(), FOOTPRINT_EDITOR_SETTINGS::FOOTPRINT_EDITOR_SETTINGS(), NET_SETTINGS::NET_SETTINGS(), and PROJECT_LOCAL_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 760 of file json_settings.cpp.

761 {
762  if( !aSettings )
763  return;
764 
765  auto it = std::find_if( m_nested_settings.begin(), m_nested_settings.end(),
766  [&aSettings]( const JSON_SETTINGS* aPtr ) {
767  return aPtr == aSettings;
768  } );
769 
770  if( it != m_nested_settings.end() )
771  {
772  wxLogTrace( traceSettings, "Flush and release %s", ( *it )->GetFilename() );
773  ( *it )->SaveToFile();
774  m_nested_settings.erase( it );
775  }
776 
777  aSettings->SetParent( nullptr );
778 }
void SetParent(JSON_SETTINGS *aParent, bool aLoadFromFile=true)
std::vector< NESTED_SETTINGS * > m_nested_settings
Nested settings files that live inside this one, if any.
const wxChar *const traceSettings
Flag to enable debug output of settings operations and management.

References 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 365 of file json_settings.cpp.

366 {
367  for( auto param : m_params )
368  param->SetDefault();
369 }
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)

References JSON_SETTINGS::m_params.

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

◆ SaveFileState()

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

Definition at line 351 of file project_local_settings.cpp.

353 {
354  auto it = std::find_if( m_files.begin(), m_files.end(),
355  [&aFileName]( const PROJECT_FILE_STATE& a )
356  {
357  return a.fileName == aFileName;
358  } );
359 
360  if( it == m_files.end() )
361  {
362  PROJECT_FILE_STATE fileState;
363  fileState.fileName = aFileName;
364 
365  m_files.push_back( fileState );
366 
367  it = m_files.end() - 1;
368  }
369 
370  ( *it ).window = aWindowCfg->state;
371  ( *it ).open = aOpen;
372 }
WINDOW_STATE state
Definition: app_settings.h:83
std::vector< PROJECT_FILE_STATE > m_files
Project scope.

References PROJECT_FILE_STATE::fileName, m_files, and WINDOW_SETTINGS::state.

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 324 of file project_local_settings.cpp.

325 {
326  wxASSERT( m_project );
327 
328  Set( "meta.filename", m_project->GetProjectName() + "." + ProjectLocalSettingsFileExtension );
329 
330  return JSON_SETTINGS::SaveToFile( aDirectory, aForce );
331 }
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...
const std::string ProjectLocalSettingsFileExtension
virtual bool SaveToFile(const wxString &aDirectory="", bool aForce=false)
PROJECT * m_project
A link to the owning project.
virtual const wxString GetProjectName() const
Return the short name of the project.
Definition: project.cpp:129

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

Referenced by SETTINGS_MANAGER::SaveProject(), 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

◆ Set() [2/3]

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

◆ Set() [3/3]

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

Definition at line 792 of file json_settings.cpp.

793 {
794  ( *m_internals )[aPath] = aVal.ToUTF8();
795 }

◆ SetFilename()

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

Definition at line 75 of file json_settings.h.

75 { m_filename = aFilename; }
wxString m_filename
The filename (not including path) of this settings file (inicode)

References JSON_SETTINGS::m_filename.

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

◆ SetIfPresent() [1/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 604 of file json_settings.cpp.

606 {
607  nlohmann::json::json_pointer ptr = JSON_SETTINGS_INTERNALS::PointerFromString( aPath );
608 
609  if( aObj.contains( ptr ) && aObj.at( ptr ).is_string() )
610  {
611  aTarget = aObj.at( ptr ).get<wxString>();
612  return true;
613  }
614 
615  return false;
616 }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS_INTERNALS::PointerFromString().

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

◆ SetIfPresent() [2/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 619 of file json_settings.cpp.

621 {
622  nlohmann::json::json_pointer ptr = JSON_SETTINGS_INTERNALS::PointerFromString( aPath );
623 
624  if( aObj.contains( ptr ) && aObj.at( ptr ).is_boolean() )
625  {
626  aTarget = aObj.at( ptr ).get<bool>();
627  return true;
628  }
629 
630  return false;
631 }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS_INTERNALS::PointerFromString().

◆ SetIfPresent() [3/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 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_number_integer() )
640  {
641  aTarget = aObj.at( ptr ).get<int>();
642  return true;
643  }
644 
645  return false;
646 }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS_INTERNALS::PointerFromString().

◆ SetIfPresent() [4/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 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_number_unsigned() )
655  {
656  aTarget = aObj.at( ptr ).get<unsigned int>();
657  return true;
658  }
659 
660  return false;
661 }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS_INTERNALS::PointerFromString().

◆ SetLegacyFilename()

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

Definition at line 79 of file json_settings.h.

79 { m_legacy_filename = aFilename; }
wxString m_legacy_filename
The filename of the wxConfig legacy file (if different from m_filename)

References JSON_SETTINGS::m_legacy_filename.

Referenced by SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS().

◆ SetManager()

void JSON_SETTINGS::SetManager ( SETTINGS_MANAGER aManager)
inlineinherited

Definition at line 196 of file json_settings.h.

197  {
198  m_manager = aManager;
199  }
SETTINGS_MANAGER * m_manager
A pointer to the settings manager managing this file (may be null)

References JSON_SETTINGS::m_manager.

◆ SetProject()

void PROJECT_LOCAL_SETTINGS::SetProject ( PROJECT aProject)
inline

Definition at line 64 of file project_local_settings.h.

65  {
66  m_project = aProject;
67  }
PROJECT * m_project
A link to the owning project.

References m_project.

◆ SetReadOnly()

void JSON_SETTINGS::SetReadOnly ( bool  aReadOnly)
inlineinherited

Definition at line 82 of file json_settings.h.

82 { m_writeFile = !aReadOnly; }
bool m_writeFile
Whether or not the backing store file should be written.

References JSON_SETTINGS::m_writeFile.

Referenced by PANEL_COLOR_SETTINGS::OnThemeChanged().

◆ 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 351 of file json_settings.cpp.

352 {
353  bool modified = false;
354 
355  for( auto param : m_params )
356  {
357  modified |= !param->MatchesFile( this );
358  param->Store( this );
359  }
360 
361  return modified;
362 }
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)

References JSON_SETTINGS::m_params.

Referenced by PANEL_FP_EDITOR_COLOR_SETTINGS::PANEL_FP_EDITOR_COLOR_SETTINGS(), SETTINGS_MANAGER::SaveColorSettings(), NESTED_SETTINGS::SaveToFile(), and JSON_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 106 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 109 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 121 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 307 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 301 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 313 of file json_settings.h.

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

◆ m_filename

◆ m_files

std::vector<PROJECT_FILE_STATE> PROJECT_LOCAL_SETTINGS::m_files

Project scope.

File based state

Definition at line 93 of file project_local_settings.h.

Referenced by ClearFileState(), GetFileState(), KICAD_MANAGER_FRAME::OnIdle(), PROJECT_LOCAL_SETTINGS(), and SaveFileState().

◆ 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 135 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 289 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 292 of file json_settings.h.

Referenced by JSON_SETTINGS::GetLocation().

◆ m_manager

SETTINGS_MANAGER* JSON_SETTINGS::m_manager
protectedinherited

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

Definition at line 322 of file json_settings.h.

Referenced by FOOTPRINT_EDITOR_SETTINGS::migrateSchema0to1(), COLOR_SETTINGS::migrateSchema0to1(), 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 325 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 298 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 128 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 142 of file project_local_settings.h.

Referenced by SaveToFile(), and SetProject().

◆ m_RatsnestMode

RATSNEST_MODE PROJECT_LOCAL_SETTINGS::m_RatsnestMode

The current ratsnest draw mode.

Definition at line 118 of file project_local_settings.h.

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

◆ 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 316 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 138 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 126 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 127 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 103 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 100 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 129 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: