KiCad PCB EDA Suite
COLOR_SETTINGS Class Reference

Color settings are a bit different than most of the settings objects in that there can be more than one of them loaded at once. More...

#include <color_settings.h>

Inheritance diagram for COLOR_SETTINGS:
JSON_SETTINGS

Public Member Functions

 COLOR_SETTINGS (wxString aFilename="user")
 
virtual ~COLOR_SETTINGS ()
 
 COLOR_SETTINGS (const COLOR_SETTINGS &aOther)
 Copy ctor provided for temporary manipulation of themes in the theme editor. More...
 
COLOR_SETTINGSoperator= (const COLOR_SETTINGS &aOther)
 
bool MigrateFromLegacy (wxConfigBase *aCfg) override
 Migrates from wxConfig to JSON-based configuration. More...
 
COLOR4D GetColor (int aLayer) const
 
COLOR4D GetDefaultColor (int aLayer)
 
void SetColor (int aLayer, COLOR4D aColor)
 
const wxString & GetName () const
 
void SetName (const wxString &aName)
 
bool GetOverrideSchItemColors () const
 
void SetOverrideSchItemColors (bool aFlag)
 
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)
 
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...
 
virtual bool SaveToFile (const wxString &aDirectory="", bool aForce=false)
 
void ResetToDefaults ()
 Resets all parameters to default values. 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 std::vector< COLOR_SETTINGS * > CreateBuiltinColorSettings ()
 Constructs and returns a list of color settings objects based on the built-in color themes. More...
 
static nlohmann::json::json_pointer PointerFromString (std::string aPath)
 Builds a JSON pointer based on a given string. More...
 
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< COLOR4Dm_Palette
 m_Pallete stores a list of colors that are used, in order, when a list of colors needs to be generated for an application. More...
 

Protected Member Functions

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...
 
virtual wxString getFileExt () const
 
virtual wxString getLegacyFileExt () const
 

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::vector< nlohmann::json::json_pointer > m_preserved_paths
 A list of JSON pointers that are preserved during a read-update-write to disk. 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...
 

Private Member Functions

bool migrateSchema0to1 ()
 
void initFromOther (const COLOR_SETTINGS &aOther)
 

Private Attributes

wxString m_displayName
 
bool m_overrideSchItemColors
 
std::unordered_map< int, COLOR4Dm_colors
 Map of all layer colors. More...
 
std::unordered_map< int, COLOR4Dm_defaultColors
 

Detailed Description

Color settings are a bit different than most of the settings objects in that there can be more than one of them loaded at once.

Each COLOR_SETTINGS object corresponds to a single color scheme file on disk. The default color scheme is called "default" and will be created on first run.

When users change color settings, they have the option of modifying the default scheme or saving their changes to a new color scheme file.

Each COLOR_SETTINGS defines all the settings used across all parts of KiCad, but it's not necessary for the underlying theme file to contain all of them. The color settings cascade, so if a user chooses a non-default scheme for a certain application, and that non-default scheme file is missing some color definitions, those will fall back to those from the "default" scheme (which is either loaded from disk or created if missing)

Each application (eeschema, gerbview, pcbnew) can have a different active color scheme selected. The "child applications" (library editors) inherit from either eeschema or pcbnew.

Definition at line 49 of file color_settings.h.

Constructor & Destructor Documentation

◆ COLOR_SETTINGS() [1/2]

COLOR_SETTINGS::COLOR_SETTINGS ( wxString  aFilename = "user")
explicit

Definition at line 34 of file color_settings.cpp.

34  :
35  JSON_SETTINGS( std::move( aFilename ), SETTINGS_LOC::COLORS, colorsSchemaVersion ),
37 {
38 
39  m_params.emplace_back( new PARAM<wxString>( "meta.name", &m_displayName, "KiCad Default" ) );
40 
41  std::vector<COLOR4D> default_palette = {
42  CSS_COLOR( 200, 52, 52, 1 ),
43  CSS_COLOR( 127, 200, 127, 1 ),
44  CSS_COLOR( 206, 125, 44, 1 ),
45  CSS_COLOR( 79, 203, 203, 1 ),
46  CSS_COLOR( 219, 98, 139, 1 ),
47  CSS_COLOR( 167, 165, 198, 1 ),
48  CSS_COLOR( 40, 204, 217, 1 ),
49  CSS_COLOR( 232, 178, 167, 1 ),
50  CSS_COLOR( 242, 237, 161, 1 ),
51  CSS_COLOR( 141, 203, 129, 1 ),
52  CSS_COLOR( 237, 124, 51, 1 ),
53  CSS_COLOR( 91, 195, 235, 1 ),
54  CSS_COLOR( 247, 111, 142, 1 ),
55  CSS_COLOR( 77, 127, 196, 1 )
56  };
57 
58  // TODO(JE) in actual usage, how long does the default palette need to be?
59  m_params.emplace_back( new PARAM_LIST<COLOR4D>( "palette", &m_Palette, default_palette ) );
60 
61  m_params.emplace_back( new PARAM<bool>( "schematic.override_item_colors",
62  &m_overrideSchItemColors, false ) );
63 
64 #define CLR( x, y ) \
65  wxASSERT( s_defaultTheme.count( y ) ); \
66  m_params.emplace_back( new COLOR_MAP_PARAM( x, y, s_defaultTheme.at( y ), &m_colors ) );
67 
68  CLR( "schematic.aux_items", LAYER_SCHEMATIC_AUX_ITEMS );
69  CLR( "schematic.background", LAYER_SCHEMATIC_BACKGROUND );
70  CLR( "schematic.brightened", LAYER_BRIGHTENED );
71  CLR( "schematic.bus", LAYER_BUS );
72  CLR( "schematic.bus_junction", LAYER_BUS_JUNCTION );
73  CLR( "schematic.component_body", LAYER_DEVICE_BACKGROUND );
74  CLR( "schematic.component_outline", LAYER_DEVICE );
75  CLR( "schematic.cursor", LAYER_SCHEMATIC_CURSOR );
76  CLR( "schematic.erc_error", LAYER_ERC_ERR );
77  CLR( "schematic.erc_warning", LAYER_ERC_WARN );
78  CLR( "schematic.fields", LAYER_FIELDS );
79  CLR( "schematic.grid", LAYER_SCHEMATIC_GRID );
80  CLR( "schematic.grid_axes", LAYER_SCHEMATIC_GRID_AXES );
81  CLR( "schematic.hidden", LAYER_HIDDEN );
82  CLR( "schematic.junction", LAYER_JUNCTION );
83  CLR( "schematic.label_global", LAYER_GLOBLABEL );
84  CLR( "schematic.label_hier", LAYER_HIERLABEL );
85  CLR( "schematic.label_local", LAYER_LOCLABEL );
86  CLR( "schematic.net_name", LAYER_NETNAM );
87  CLR( "schematic.no_connect", LAYER_NOCONNECT );
88  CLR( "schematic.note", LAYER_NOTES );
89  CLR( "schematic.pin", LAYER_PIN );
90  CLR( "schematic.pin_name", LAYER_PINNAM );
91  CLR( "schematic.pin_number", LAYER_PINNUM );
92  CLR( "schematic.reference", LAYER_REFERENCEPART );
93  // Macs look better with a lighter shadow
94 #ifdef __WXMAC__
95  CLR( "schematic.shadow", LAYER_SELECTION_SHADOWS );
96 #else
97  CLR( "schematic.shadow", LAYER_SELECTION_SHADOWS );
98 #endif
99  CLR( "schematic.sheet", LAYER_SHEET );
100  CLR( "schematic.sheet_background", LAYER_SHEET_BACKGROUND );
101  CLR( "schematic.sheet_filename", LAYER_SHEETFILENAME );
102  CLR( "schematic.sheet_fields", LAYER_SHEETFIELDS );
103  CLR( "schematic.sheet_label", LAYER_SHEETLABEL );
104  CLR( "schematic.sheet_name", LAYER_SHEETNAME );
105  CLR( "schematic.value", LAYER_VALUEPART );
106  CLR( "schematic.wire", LAYER_WIRE );
107  CLR( "schematic.worksheet", LAYER_SCHEMATIC_WORKSHEET );
108 
109  CLR( "gerbview.axes", LAYER_GERBVIEW_AXES );
110  CLR( "gerbview.background", LAYER_GERBVIEW_BACKGROUND );
111  CLR( "gerbview.dcodes", LAYER_DCODES );
112  CLR( "gerbview.grid", LAYER_GERBVIEW_GRID );
113  CLR( "gerbview.negative_objects", LAYER_NEGATIVE_OBJECTS );
114  CLR( "gerbview.worksheet", LAYER_GERBVIEW_WORKSHEET );
115 
116  for( int i = 0, id = GERBVIEW_LAYER_ID_START;
118  {
119  m_params.emplace_back( new COLOR_MAP_PARAM( "gerbview.layers." + std::to_string( i ), id,
120  default_palette[ i % default_palette.size() ],
121  &m_colors ) );
122  }
123 
124  CLR( "board.anchor", LAYER_ANCHOR );
125  CLR( "board.aux_items", LAYER_AUX_ITEMS );
126  CLR( "board.background", LAYER_PCB_BACKGROUND );
127  CLR( "board.cursor", LAYER_CURSOR );
128  CLR( "board.drc_error", LAYER_DRC_ERROR );
129  CLR( "board.drc_warning", LAYER_DRC_WARNING );
130  CLR( "board.drc_exclusion", LAYER_DRC_EXCLUSION );
131  CLR( "board.footprint_text_invisible", LAYER_MOD_TEXT_INVISIBLE );
132  CLR( "board.grid", LAYER_GRID );
133  CLR( "board.grid_axes", LAYER_GRID_AXES );
134  CLR( "board.no_connect", LAYER_NO_CONNECTS );
135  CLR( "board.pad_back", LAYER_PAD_BK );
136  CLR( "board.pad_front", LAYER_PAD_FR );
137  CLR( "board.pad_plated_hole", LAYER_PADS_PLATEDHOLES );
138  CLR( "board.pad_through_hole", LAYER_PADS_TH );
139  CLR( "board.plated_hole", LAYER_NON_PLATEDHOLES );
140  CLR( "board.ratsnest", LAYER_RATSNEST );
141  CLR( "board.select_overlay", LAYER_SELECT_OVERLAY );
142  CLR( "board.via_blind_buried", LAYER_VIA_BBLIND );
143  CLR( "board.via_hole", LAYER_VIAS_HOLES );
144  CLR( "board.via_micro", LAYER_VIA_MICROVIA );
145  CLR( "board.via_through", LAYER_VIA_THROUGH );
146  CLR( "board.worksheet", LAYER_WORKSHEET );
147 
148  CLR( "board.copper.f", F_Cu );
149  CLR( "board.copper.in1", In1_Cu );
150  CLR( "board.copper.in2", In2_Cu );
151  CLR( "board.copper.in3", In3_Cu );
152  CLR( "board.copper.in4", In4_Cu );
153  CLR( "board.copper.in5", In5_Cu );
154  CLR( "board.copper.in6", In6_Cu );
155  CLR( "board.copper.in7", In7_Cu );
156  CLR( "board.copper.in8", In8_Cu );
157  CLR( "board.copper.in9", In9_Cu );
158  CLR( "board.copper.in10", In10_Cu );
159  CLR( "board.copper.in11", In11_Cu );
160  CLR( "board.copper.in12", In12_Cu );
161  CLR( "board.copper.in13", In13_Cu );
162  CLR( "board.copper.in14", In14_Cu );
163  CLR( "board.copper.in15", In15_Cu );
164  CLR( "board.copper.in16", In16_Cu );
165  CLR( "board.copper.in17", In17_Cu );
166  CLR( "board.copper.in18", In18_Cu );
167  CLR( "board.copper.in19", In19_Cu );
168  CLR( "board.copper.in20", In20_Cu );
169  CLR( "board.copper.in21", In21_Cu );
170  CLR( "board.copper.in22", In22_Cu );
171  CLR( "board.copper.in23", In23_Cu );
172  CLR( "board.copper.in24", In24_Cu );
173  CLR( "board.copper.in25", In25_Cu );
174  CLR( "board.copper.in26", In26_Cu );
175  CLR( "board.copper.in27", In27_Cu );
176  CLR( "board.copper.in28", In28_Cu );
177  CLR( "board.copper.in29", In29_Cu );
178  CLR( "board.copper.in30", In30_Cu );
179  CLR( "board.copper.b", B_Cu );
180 
181  CLR( "board.b_adhes", B_Adhes );
182  CLR( "board.f_adhes", F_Adhes );
183  CLR( "board.b_paste", B_Paste );
184  CLR( "board.f_paste", F_Paste );
185  CLR( "board.b_silks", B_SilkS );
186  CLR( "board.f_silks", F_SilkS );
187  CLR( "board.b_mask", B_Mask );
188  CLR( "board.f_mask", F_Mask );
189  CLR( "board.dwgs_user", Dwgs_User );
190  CLR( "board.cmts_user", Cmts_User );
191  CLR( "board.eco1_user", Eco1_User );
192  CLR( "board.eco2_user", Eco2_User );
193  CLR( "board.edge_cuts", Edge_Cuts );
194  CLR( "board.margin", Margin );
195  CLR( "board.b_crtyd", B_CrtYd );
196  CLR( "board.f_crtyd", F_CrtYd );
197  CLR( "board.b_fab", B_Fab );
198  CLR( "board.f_fab", F_Fab );
199  CLR( "board.user_1", User_1 );
200  CLR( "board.user_2", User_2 );
201  CLR( "board.user_3", User_3 );
202  CLR( "board.user_4", User_4 );
203  CLR( "board.user_5", User_5 );
204  CLR( "board.user_6", User_6 );
205  CLR( "board.user_7", User_7 );
206  CLR( "board.user_8", User_8 );
207  CLR( "board.user_9", User_9 );
208 
209  // Colors for 3D viewer, which are used as defaults unless overridden by the board
210  CLR( "3d_viewer.background_bottom", LAYER_3D_BACKGROUND_BOTTOM );
211  CLR( "3d_viewer.background_top", LAYER_3D_BACKGROUND_TOP );
212  CLR( "3d_viewer.board", LAYER_3D_BOARD );
213  CLR( "3d_viewer.copper", LAYER_3D_COPPER );
214  CLR( "3d_viewer.silkscreen_bottom", LAYER_3D_SILKSCREEN_BOTTOM );
215  CLR( "3d_viewer.silkscreen_top", LAYER_3D_SILKSCREEN_TOP );
216  CLR( "3d_viewer.soldermask", LAYER_3D_SOLDERMASK );
217  CLR( "3d_viewer.solderpaste", LAYER_3D_SOLDERPASTE );
218 
219  registerMigration( 0, 1, std::bind( &COLOR_SETTINGS::migrateSchema0to1, this ) );
220 
221  registerMigration( 1, 2,
222  [&]()
223  {
224  // Fix LAYER_VIAS_HOLES color - before version 2, this setting had no effect
225  nlohmann::json::json_pointer ptr( "/board/via_hole");
226 
227  ( *this )[ptr] = COLOR4D( 0.5, 0.4, 0, 0.8 ).ToWxString( wxC2S_CSS_SYNTAX );
228 
229  return true;
230  } );
231 }
to draw blind/buried vias
show a marker on pads with no nets
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)
multilayer pads, usually with holes
handle color for not plated holes (holes, not pads)
anchor of items having an anchor point (texts, footprints)
bool m_overrideSchItemColors
to draw via holes (pad holes do not use this layer)
const int colorsSchemaVersion
! Update the schema version whenever a migration is required
wxString m_displayName
The color scheme directory (e.g. ~/.config/kicad/colors/)
Auxiliary items (guides, rule, etc)
#define GERBER_DRAWLAYERS_COUNT
#define CSS_COLOR(r, g, b, a)
to draw usual through hole vias
#define CLR(x, y)
JSON_SETTINGS(const wxString &aFilename, SETTINGS_LOC aLocation, int aSchemaVersion)
Definition: json_settings.h:56
layer for drc markers which have been individually excluded
layer for drc markers with SEVERITY_WARNING
std::vector< COLOR4D > m_Palette
m_Pallete stores a list of colors that are used, in order, when a list of colors needs to be generate...
std::unordered_map< int, COLOR4D > m_colors
Map of all layer colors.
smd pads, front layer
void registerMigration(int aOldSchemaVersion, int aNewSchemaVersion, std::function< bool(void)> aMigrator)
Registers a migration from one schema version to another.
currently selected items overlay
layer for drc markers with SEVERITY_ERROR
COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:100

References B_Adhes, B_CrtYd, B_Cu, B_Fab, B_Mask, B_Paste, B_SilkS, CLR, Cmts_User, COLORS, CSS_COLOR, Dwgs_User, Eco1_User, Eco2_User, Edge_Cuts, F_Adhes, F_CrtYd, F_Cu, F_Fab, F_Mask, F_Paste, F_SilkS, GERBER_DRAWLAYERS_COUNT, GERBVIEW_LAYER_ID_START, In10_Cu, In11_Cu, In12_Cu, In13_Cu, In14_Cu, In15_Cu, In16_Cu, In17_Cu, In18_Cu, In19_Cu, In1_Cu, In20_Cu, In21_Cu, In22_Cu, In23_Cu, In24_Cu, In25_Cu, In26_Cu, In27_Cu, In28_Cu, In29_Cu, In2_Cu, In30_Cu, In3_Cu, In4_Cu, In5_Cu, In6_Cu, In7_Cu, In8_Cu, In9_Cu, LAYER_3D_BACKGROUND_BOTTOM, LAYER_3D_BACKGROUND_TOP, LAYER_3D_BOARD, LAYER_3D_COPPER, LAYER_3D_SILKSCREEN_BOTTOM, LAYER_3D_SILKSCREEN_TOP, LAYER_3D_SOLDERMASK, LAYER_3D_SOLDERPASTE, LAYER_ANCHOR, LAYER_AUX_ITEMS, LAYER_BRIGHTENED, LAYER_BUS, LAYER_BUS_JUNCTION, LAYER_CURSOR, LAYER_DCODES, LAYER_DEVICE, LAYER_DEVICE_BACKGROUND, LAYER_DRC_ERROR, LAYER_DRC_EXCLUSION, LAYER_DRC_WARNING, LAYER_ERC_ERR, LAYER_ERC_WARN, LAYER_FIELDS, LAYER_GERBVIEW_AXES, LAYER_GERBVIEW_BACKGROUND, LAYER_GERBVIEW_GRID, LAYER_GERBVIEW_WORKSHEET, LAYER_GLOBLABEL, LAYER_GRID, LAYER_GRID_AXES, LAYER_HIDDEN, LAYER_HIERLABEL, LAYER_JUNCTION, LAYER_LOCLABEL, LAYER_MOD_TEXT_INVISIBLE, LAYER_NEGATIVE_OBJECTS, LAYER_NETNAM, LAYER_NO_CONNECTS, LAYER_NOCONNECT, LAYER_NON_PLATEDHOLES, LAYER_NOTES, LAYER_PAD_BK, LAYER_PAD_FR, LAYER_PADS_PLATEDHOLES, LAYER_PADS_TH, LAYER_PCB_BACKGROUND, LAYER_PIN, LAYER_PINNAM, LAYER_PINNUM, LAYER_RATSNEST, LAYER_REFERENCEPART, LAYER_SCHEMATIC_AUX_ITEMS, LAYER_SCHEMATIC_BACKGROUND, LAYER_SCHEMATIC_CURSOR, LAYER_SCHEMATIC_GRID, LAYER_SCHEMATIC_GRID_AXES, LAYER_SCHEMATIC_WORKSHEET, LAYER_SELECT_OVERLAY, LAYER_SELECTION_SHADOWS, LAYER_SHEET, LAYER_SHEET_BACKGROUND, LAYER_SHEETFIELDS, LAYER_SHEETFILENAME, LAYER_SHEETLABEL, LAYER_SHEETNAME, LAYER_VALUEPART, LAYER_VIA_BBLIND, LAYER_VIA_MICROVIA, LAYER_VIA_THROUGH, LAYER_VIAS_HOLES, LAYER_WIRE, LAYER_WORKSHEET, m_colors, m_displayName, m_overrideSchItemColors, m_Palette, JSON_SETTINGS::m_params, Margin, migrateSchema0to1(), JSON_SETTINGS::registerMigration(), User_1, User_2, User_3, User_4, User_5, User_6, User_7, User_8, and User_9.

Referenced by CreateBuiltinColorSettings().

◆ ~COLOR_SETTINGS()

virtual COLOR_SETTINGS::~COLOR_SETTINGS ( )
inlinevirtual

Definition at line 61 of file color_settings.h.

61 {}

◆ COLOR_SETTINGS() [2/2]

COLOR_SETTINGS::COLOR_SETTINGS ( const COLOR_SETTINGS aOther)

Copy ctor provided for temporary manipulation of themes in the theme editor.

This will not copy the JSON_SETTINGS underlying data.

Definition at line 234 of file color_settings.cpp.

234  :
236 {
237  initFromOther( aOther );
238 }
const int colorsSchemaVersion
! Update the schema version whenever a migration is required
The color scheme directory (e.g. ~/.config/kicad/colors/)
wxString m_filename
The filename (not including path) of this settings file (inicode)
JSON_SETTINGS(const wxString &aFilename, SETTINGS_LOC aLocation, int aSchemaVersion)
Definition: json_settings.h:56
void initFromOther(const COLOR_SETTINGS &aOther)

References COLORS, and initFromOther().

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

657 {
658  wxLogTrace( traceSettings, "AddNestedSettings %s", aSettings->GetFilename() );
659  m_nested_settings.push_back( aSettings );
660 }
wxString GetFilename() const
Definition: json_settings.h:64
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().

◆ CreateBuiltinColorSettings()

std::vector< COLOR_SETTINGS * > COLOR_SETTINGS::CreateBuiltinColorSettings ( )
static

Constructs and returns a list of color settings objects based on the built-in color themes.

These color settings are not backed by a file and cannot be modified by the user. This is expected to be called by SETTINGS_MANAGER which will take ownership of the objects and handle freeing them at the end of its lifetime.

Returns
a list of pointers COLOR_SETTINGS objects containing the default color theme(s)

Definition at line 361 of file color_settings.cpp.

362 {
363  COLOR_SETTINGS* defaultTheme = new COLOR_SETTINGS( wxT( "_builtin_default" ) );
364  defaultTheme->SetName( _( "KiCad Default" ) );
365  defaultTheme->m_writeFile = false;
366  defaultTheme->Load(); // We can just get the colors out of the param defaults for this one
367 
368  COLOR_SETTINGS* classicTheme = new COLOR_SETTINGS( wxT( "_builtin_classic" ) );
369  classicTheme->SetName( _( "KiCad Classic" ) );
370  classicTheme->m_writeFile = false;
371 
372  for( const std::pair<int, COLOR4D> entry : s_classicTheme )
373  classicTheme->m_colors[entry.first] = entry.second;
374 
375  std::vector<COLOR_SETTINGS*> ret;
376 
377  ret.push_back( defaultTheme );
378  ret.push_back( classicTheme );
379 
380  return ret;
381 }
static const std::map< int, COLOR4D > s_classicTheme
void SetName(const wxString &aName)
std::unordered_map< int, COLOR4D > m_colors
Map of all layer colors.
#define _(s)
Definition: 3d_actions.cpp:33
COLOR_SETTINGS(wxString aFilename="user")
Color settings are a bit different than most of the settings objects in that there can be more than o...
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 _, COLOR_SETTINGS(), JSON_SETTINGS::Load(), m_colors, JSON_SETTINGS::m_writeFile, s_classicTheme, and SetName().

Referenced by SETTINGS_MANAGER::loadAllColorSettings().

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

570 {
571  ValueType val;
572 
573  if( aConfig->Read( aKey, &val ) )
574  {
575  try
576  {
577  ( *this )[PointerFromString( aDest )] = val;
578  }
579  catch( ... )
580  {
581  wxASSERT_MSG( false, wxT( "Could not write value in fromLegacy!" ) );
582  return false;
583  }
584 
585  return true;
586  }
587 
588  return false;
589 }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS::PointerFromString().

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

630 {
631  wxString str;
632 
633  if( aConfig->Read( aKey, &str ) )
634  {
636  color.SetFromWxString( str );
637 
638  try
639  {
640  nlohmann::json js = nlohmann::json::array( { color.r, color.g, color.b, color.a } );
641  ( *this )[PointerFromString( aDest )] = js;
642  }
643  catch( ... )
644  {
645  wxASSERT_MSG( false, wxT( "Could not write value in fromLegacyColor!" ) );
646  return false;
647  }
648 
649  return true;
650  }
651 
652  return false;
653 }
int color
Definition: DXF_plotter.cpp:60
nlohmann::json json
Definition: gerbview.cpp:39
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.
COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:100

References color, and JSON_SETTINGS::PointerFromString().

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

606 {
607  wxString str;
608 
609  if( aConfig->Read( aKey, &str ) )
610  {
611  try
612  {
613  ( *this )[PointerFromString( aDest )] = str.ToUTF8();
614  }
615  catch( ... )
616  {
617  wxASSERT_MSG( false, wxT( "Could not write value in fromLegacyString!" ) );
618  return false;
619  }
620 
621  return true;
622  }
623 
624  return false;
625 }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS::PointerFromString().

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

◆ Get() [1/2]

template<typename ValueType >
OPT<ValueType> JSON_SETTINGS::Get ( const std::string &  aPath) const
inlineinherited

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 124 of file json_settings.h.

125  {
126  if( OPT<nlohmann::json> ret = GetJson( aPath ) )
127  {
128  try
129  {
130  return ret->get<ValueType>();
131  }
132  catch( ... )
133  {
134  }
135  }
136 
137  return NULLOPT;
138  }
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(), BOARD_DESIGN_SETTINGS::LoadFromFile(), 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 686 of file json_settings.cpp.

687 {
688  if( OPT<nlohmann::json> opt_json = GetJson( aPath ) )
689  return wxString( opt_json->get<std::string>().c_str(), wxConvUTF8 );
690 
691  return NULLOPT;
692 }
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.

◆ GetColor()

COLOR4D COLOR_SETTINGS::GetColor ( int  aLayer) const

Definition at line 322 of file color_settings.cpp.

323 {
324  if( m_colors.count( aLayer ) )
325  return m_colors.at( aLayer );
326 
327  return COLOR4D::UNSPECIFIED;
328 }
std::unordered_map< int, COLOR4D > m_colors
Map of all layer colors.

References m_colors.

Referenced by LIB_EDIT_FRAME::CommonSettingsChanged(), PANEL_COLOR_SETTINGS::createSwatch(), PANEL_MODEDIT_COLOR_SETTINGS::createSwatches(), GRID_CELL_LAYER_RENDERER::Draw(), BRDITEMS_PLOTTER::getColor(), FOOTPRINT_VIEWER_FRAME::GetGridColor(), BOARD_ADAPTER::GetItemColor(), PCB_LAYER_SELECTOR::getLayerColor(), PCB_LAYER_BOX_SELECTOR::getLayerColor(), SCH_BASE_FRAME::GetLayerColor(), BOARD_ADAPTER::GetLayerColor(), GERBVIEW_FRAME::GetVisibleElementColor(), KIGFX::WS_RENDER_SETTINGS::LoadColors(), KIGFX::GERBVIEW_RENDER_SETTINGS::LoadColors(), KIGFX::SCH_RENDER_SETTINGS::LoadColors(), KIGFX::PCB_RENDER_SETTINGS::LoadColors(), APPEARANCE_CONTROLS::OnLayerAlphaChanged(), PANEL_COLOR_SETTINGS::OnThemeChanged(), BRDITEMS_PLOTTER::PlotDimension(), PlotStandardLayer(), PCB_EDIT_FRAME::PrepareLayerIndicator(), SCH_PRINTOUT::PrintPage(), APPEARANCE_CONTROLS::rebuildLayers(), APPEARANCE_CONTROLS::rebuildNets(), APPEARANCE_CONTROLS::rebuildObjects(), PANEL_EESCHEMA_COLOR_SETTINGS::saveCurrentTheme(), PANEL_COLOR_SETTINGS::saveCurrentTheme(), ZONE_SETTINGS::SetupLayersList(), PANEL_COLOR_SETTINGS::ShowColorContextMenu(), LIB_EDIT_FRAME::SwitchCanvas(), APPEARANCE_CONTROLS::syncColorsAndVisibility(), APPEARANCE_CONTROLS::syncObjectSettings(), PANEL_EESCHEMA_EDITING_OPTIONS::TransferDataToWindow(), DIALOG_SHEET_PROPERTIES::TransferDataToWindow(), PANEL_COLOR_SETTINGS::updateColor(), PCB_DRAW_PANEL_GAL::UpdateColors(), PANEL_COLOR_SETTINGS::updateSwatches(), and PANEL_EESCHEMA_COLOR_SETTINGS::validateSave().

◆ GetDefaultColor()

COLOR4D COLOR_SETTINGS::GetDefaultColor ( int  aLayer)

Definition at line 331 of file color_settings.cpp.

332 {
333  if( !m_defaultColors.count( aLayer ) )
334  {
335  COLOR_MAP_PARAM* p = nullptr;
336 
337  for( PARAM_BASE* param : m_params )
338  {
339  COLOR_MAP_PARAM* cmp = dynamic_cast<COLOR_MAP_PARAM*>( param );
340 
341  if( cmp && cmp->GetKey() == aLayer )
342  p = cmp;
343  }
344 
345  if( p )
346  m_defaultColors[aLayer] = p->GetDefault();
347  else
348  m_defaultColors[aLayer] = COLOR4D::UNSPECIFIED;
349  }
350 
351  return m_defaultColors.at( aLayer );
352 }
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)
COLOR4D GetDefault() const
std::unordered_map< int, COLOR4D > m_defaultColors

References COLOR_MAP_PARAM::GetDefault(), m_defaultColors, and JSON_SETTINGS::m_params.

Referenced by PANEL_COLOR_SETTINGS::createSwatch(), APPEARANCE_CONTROLS::rebuildObjects(), and PANEL_COLOR_SETTINGS::ResetPanel().

◆ getFileExt()

virtual wxString JSON_SETTINGS::getFileExt ( ) const
inlineprotectedvirtualinherited

Reimplemented in PROJECT_FILE, and PROJECT_LOCAL_SETTINGS.

Definition at line 274 of file json_settings.h.

275  {
276  return wxT( "json" );
277  }

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

◆ GetFilename()

◆ GetFullFilename()

wxString JSON_SETTINGS::GetFullFilename ( ) const
inherited

Definition at line 79 of file json_settings.cpp.

80 {
81  return wxString( m_filename + "." + getFileExt() );
82 }
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 417 of file json_settings.cpp.

418 {
419  nlohmann::json::json_pointer ptr = PointerFromString( aPath );
420 
421  if( this->contains( ptr ) )
422  {
423  try
424  {
425  return OPT<nlohmann::json>{ this->at( ptr ) };
426  }
427  catch( ... )
428  {
429  }
430  }
431 
432  return OPT<nlohmann::json>{};
433 }
bool contains(const _Container &__container, _Value __value)
Returns true if the container contains the given value.
Definition: kicad_algo.h:81
boost::optional< T > OPT
Definition: optional.h:7
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References alg::contains(), and JSON_SETTINGS::PointerFromString().

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(), and PARAM_WXSTRING_MAP::MatchesFile().

◆ getLegacyFileExt()

virtual wxString JSON_SETTINGS::getLegacyFileExt ( ) const
inlineprotectedvirtualinherited

Reimplemented in PROJECT_FILE, and PROJECT_LOCAL_SETTINGS.

Definition at line 279 of file json_settings.h.

280  {
281  return wxEmptyString;
282  }

Referenced by JSON_SETTINGS::LoadFromFile().

◆ GetLocation()

SETTINGS_LOC JSON_SETTINGS::GetLocation ( ) const
inlineinherited

Definition at line 70 of file json_settings.h.

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

References JSON_SETTINGS::m_location.

Referenced by SETTINGS_MANAGER::GetPathForSettingsFile().

◆ GetName()

const wxString& COLOR_SETTINGS::GetName ( void  ) const
inline

◆ GetOverrideSchItemColors()

◆ initFromOther()

void COLOR_SETTINGS::initFromOther ( const COLOR_SETTINGS aOther)
private

Definition at line 251 of file color_settings.cpp.

252 {
253  m_displayName = aOther.m_displayName;
255  m_colors = aOther.m_colors;
257  m_writeFile = aOther.m_writeFile;
258 
259  // Ensure default colors are present
260  for( PARAM_BASE* param : aOther.m_params )
261  {
262  if( COLOR_MAP_PARAM* cmp = dynamic_cast<COLOR_MAP_PARAM*>( param ) )
263  m_defaultColors[cmp->GetKey()] = cmp->GetDefault();
264  }
265 }
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)
bool m_overrideSchItemColors
wxString m_displayName
std::unordered_map< int, COLOR4D > m_defaultColors
std::unordered_map< int, COLOR4D > m_colors
Map of all layer colors.
bool m_writeFile
Whether or not the backing store file should be written.

References m_colors, m_defaultColors, m_displayName, m_overrideSchItemColors, JSON_SETTINGS::m_params, and JSON_SETTINGS::m_writeFile.

Referenced by COLOR_SETTINGS(), and operator=().

◆ IsReadOnly()

bool JSON_SETTINGS::IsReadOnly ( ) const
inlineinherited

◆ Load()

void JSON_SETTINGS::Load ( )
virtualinherited

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

Definition at line 85 of file json_settings.cpp.

86 {
87  for( auto param : m_params )
88  {
89  try
90  {
91  param->Load( this, m_resetParamsIfMissing );
92  }
93  catch( ... )
94  {
95  // Skip unreadable parameters in file
96  wxLogTrace( traceSettings, "param '%s' load err", param->GetJsonPath().c_str() );
97  }
98  }
99 }
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 CreateBuiltinColorSettings(), NESTED_SETTINGS::LoadFromFile(), JSON_SETTINGS::LoadFromFile(), BOARD_DESIGN_SETTINGS::LoadFromFile(), 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 102 of file json_settings.cpp.

103 {
104  // First, load all params to default values
105  clear();
106  Load();
107 
108  bool success = true;
109  bool migrated = false;
110  bool legacy_migrated = false;
111 
112  LOCALE_IO locale;
113 
114  auto migrateFromLegacy = [&] ( wxFileName& aPath ) {
115  // Backup and restore during migration so that the original can be mutated if convenient
116  bool backed_up = false;
117  wxFileName temp;
118 
119  if( aPath.IsDirWritable() )
120  {
121  temp.AssignTempFileName( aPath.GetFullPath() );
122 
123  if( !wxCopyFile( aPath.GetFullPath(), temp.GetFullPath() ) )
124  {
125  wxLogTrace( traceSettings, "%s: could not create temp file for migration",
126  GetFullFilename() );
127  }
128  else
129  backed_up = true;
130  }
131 
132  wxConfigBase::DontCreateOnDemand();
133  auto cfg = std::make_unique<wxFileConfig>( wxT( "" ), wxT( "" ), aPath.GetFullPath() );
134 
135  // If migrate fails or is not implemented, fall back to built-in defaults that were
136  // already loaded above
137  if( !MigrateFromLegacy( cfg.get() ) )
138  {
139  wxLogTrace( traceSettings,
140  "%s: migrated; not all settings were found in legacy file",
141  GetFullFilename() );
142  }
143  else
144  {
145  wxLogTrace( traceSettings, "%s: migrated from legacy format", GetFullFilename() );
146  }
147 
148  if( backed_up )
149  {
150  cfg.reset();
151 
152  if( !wxCopyFile( temp.GetFullPath(), aPath.GetFullPath() ) )
153  {
154  wxLogTrace( traceSettings,
155  "migrate; copy temp file %s to %s failed",
156  temp.GetFullPath(), aPath.GetFullPath() );
157  }
158 
159  if( !wxRemoveFile( temp.GetFullPath() ) )
160  {
161  wxLogTrace( traceSettings,
162  "migrate; failed to remove temp file %s",
163  temp.GetFullPath() );
164  }
165  }
166 
167  // Either way, we want to clean up the old file afterwards
168  legacy_migrated = true;
169  };
170 
171  wxFileName path;
172 
173  if( aDirectory.empty() )
174  {
175  path.Assign( m_filename );
176  path.SetExt( getFileExt() );
177  }
178  else
179  {
180  wxString dir( aDirectory );
181  path.Assign( dir, m_filename, getFileExt() );
182  }
183 
184  if( !path.Exists() )
185  {
186  // Case 1: legacy migration, no .json extension yet
187  path.SetExt( getLegacyFileExt() );
188 
189  if( path.Exists() )
190  {
191  migrateFromLegacy( path );
192  }
193  // Case 2: legacy filename is different from new one
194  else if( !m_legacy_filename.empty() )
195  {
196  path.SetName( m_legacy_filename );
197 
198  if( path.Exists() )
199  migrateFromLegacy( path );
200  }
201  else
202  {
203  success = false;
204  }
205  }
206  else
207  {
208  if( !path.IsFileWritable() )
209  m_writeFile = false;
210 
211  try
212  {
213  FILE* fp = wxFopen( path.GetFullPath(), wxT( "rt" ) );
214 
215  if( fp )
216  {
217  *static_cast<nlohmann::json*>( this ) = nlohmann::json::parse( fp, nullptr,
218  /* allow_exceptions = */ true,
219  /* ignore_comments = */ true );
220 
221  // If parse succeeds, check if schema migration is required
222  int filever = -1;
223 
224  try
225  {
226  filever = at( PointerFromString( "meta.version" ) ).get<int>();
227  }
228  catch( ... )
229  {
230  wxLogTrace( traceSettings, "%s: file version could not be read!",
231  GetFullFilename() );
232  success = false;
233  }
234 
235  if( filever >= 0 && filever < m_schemaVersion )
236  {
237  wxLogTrace( traceSettings, "%s: attempting migration from version %d to %d",
238  GetFullFilename(), filever, m_schemaVersion );
239 
240  if( Migrate() )
241  {
242  migrated = true;
243  }
244  else
245  {
246  wxLogTrace( traceSettings, "%s: migration failed!", GetFullFilename() );
247  }
248  }
249  else if( filever > m_schemaVersion )
250  {
251  wxLogTrace( traceSettings,
252  "%s: warning: file version %d is newer than latest (%d)",
253  GetFullFilename(), filever, m_schemaVersion );
254  }
255  }
256  else
257  {
258  wxLogTrace( traceSettings, "%s exists but can't be opened for read",
259  GetFullFilename() );
260  }
261  }
262  catch( nlohmann::json::parse_error& error )
263  {
264  wxLogTrace( traceSettings, "Json parse error reading %s: %s",
265  path.GetFullPath(), error.what() );
266  wxLogTrace( traceSettings, "Attempting migration in case file is in legacy format" );
267  migrateFromLegacy( path );
268  }
269  }
270 
271  // Now that we have new data in the JSON structure, load the params again
272  Load();
273 
274  // And finally load any nested settings
275  for( auto settings : m_nested_settings )
276  settings->LoadFromFile();
277 
278  wxLogTrace( traceSettings, "Loaded <%s> with schema %d", GetFullFilename(), m_schemaVersion );
279 
280  // If we migrated, clean up the legacy file (with no extension)
281  if( legacy_migrated || migrated )
282  {
283  if( legacy_migrated && m_deleteLegacyAfterMigration && !wxRemoveFile( path.GetFullPath() ) )
284  {
285  wxLogTrace( traceSettings, "Warning: could not remove legacy file %s",
286  path.GetFullPath() );
287  }
288 
289  // And write-out immediately so that we don't lose data if the program later crashes.
290  SaveToFile( aDirectory, true );
291  }
292 
293  return success;
294 }
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::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
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.
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_legacy_filename, JSON_SETTINGS::m_nested_settings, JSON_SETTINGS::m_schemaVersion, JSON_SETTINGS::m_writeFile, JSON_SETTINGS::Migrate(), JSON_SETTINGS::MigrateFromLegacy(), parse(), JSON_SETTINGS::PointerFromString(), 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 445 of file json_settings.cpp.

446 {
447  int filever = at( PointerFromString( "meta.version" ) ).get<int>();
448 
449  while( filever < m_schemaVersion )
450  {
451  if( !m_migrators.count( filever ) )
452  {
453  wxLogTrace( traceSettings, "Migrator missing for %s version %d!",
454  typeid( *this ).name(), filever );
455  return false;
456  }
457 
458  std::pair<int, std::function<bool()>> pair = m_migrators.at( filever );
459 
460  if( pair.second() )
461  {
462  wxLogTrace( traceSettings, "Migrated %s from %d to %d", typeid( *this ).name(),
463  filever, pair.first );
464  filever = pair.first;
465  ( *this )[PointerFromString( "meta.version" )] = filever;
466  }
467  else
468  {
469  wxLogTrace( traceSettings, "Migration failed for %s from %d to %d",
470  typeid( *this ).name(), filever, pair.first );
471  return false;
472  }
473  }
474 
475  return true;
476 }
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>
const wxChar *const traceSettings
Flag to enable debug output of settings operations and management.
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.
int m_schemaVersion
Version of this settings schema.

References JSON_SETTINGS::m_migrators, JSON_SETTINGS::m_schemaVersion, JSON_SETTINGS::PointerFromString(), and traceSettings.

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

◆ MigrateFromLegacy()

bool COLOR_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

Reimplemented from JSON_SETTINGS.

Definition at line 268 of file color_settings.cpp.

269 {
270  return false;
271 }

◆ migrateSchema0to1()

bool COLOR_SETTINGS::migrateSchema0to1 ( )
private

Schema version 0 to 1:

  • Footprint editor settings are split out into a new file called "ThemeName (Footprints)"
  • fpedit namespace is removed from the schema

Definition at line 274 of file color_settings.cpp.

275 {
283  if( !m_manager )
284  {
285  wxLogTrace( traceSettings, "Error: COLOR_SETTINGS migration cannot run unmanaged!" );
286  return false;
287  }
288 
289  nlohmann::json::json_pointer board( "/board" );
290  nlohmann::json::json_pointer fpedit( "/fpedit" );
291 
292  if( !contains( fpedit ) )
293  {
294  wxLogTrace( traceSettings, "migrateSchema0to1: %s doesn't have fpedit settings; skipping.",
295  m_filename );
296  return true;
297  }
298 
299  wxString filename = m_filename + wxT( "_footprints" );
300 
301  COLOR_SETTINGS* fpsettings = m_manager->AddNewColorSettings( filename );
302 
303  // Start out with a clone
304  nlohmann::json::json_pointer root( "" );
305  ( *fpsettings )[root] = at( root );
306 
307  // Footprint editor now just looks at the "board" namespace
308  ( *fpsettings )[board] = fpsettings->at( fpedit );
309 
310  fpsettings->erase( "fpedit" );
311  fpsettings->Load();
312  fpsettings->SetName( fpsettings->GetName() + wxS( " " ) + _( "(Footprints)" ) );
313  m_manager->Save( fpsettings );
314 
315  // Now we can get rid of our own copy
316  erase( "fpedit" );
317 
318  return true;
319 }
const wxString & GetName() const
COLOR_SETTINGS * AddNewColorSettings(const wxString &aFilename)
Registers a new color settings object with the given filename.
wxString m_filename
The filename (not including path) of this settings file (inicode)
void SetName(const wxString &aName)
bool contains(const _Container &__container, _Value __value)
Returns true if the container contains the given value.
Definition: kicad_algo.h:81
#define _(s)
Definition: 3d_actions.cpp:33
Color settings are a bit different than most of the settings objects in that there can be more than o...
const wxChar *const traceSettings
Flag to enable debug output of settings operations and management.
SETTINGS_MANAGER * m_manager
A pointer to the settings manager managing this file (may be null)
virtual void Load()
Updates the parameters of this object based on the current JSON document contents.

References _, SETTINGS_MANAGER::AddNewColorSettings(), alg::contains(), GetName(), JSON_SETTINGS::Load(), JSON_SETTINGS::m_filename, JSON_SETTINGS::m_manager, SETTINGS_MANAGER::Save(), SetName(), and traceSettings.

Referenced by COLOR_SETTINGS().

◆ operator=()

COLOR_SETTINGS & COLOR_SETTINGS::operator= ( const COLOR_SETTINGS aOther)

Definition at line 241 of file color_settings.cpp.

242 {
243  m_filename = aOther.m_filename;
244 
245  initFromOther( aOther );
246 
247  return *this;
248 }
wxString m_filename
The filename (not including path) of this settings file (inicode)
void initFromOther(const COLOR_SETTINGS &aOther)

References initFromOther(), and JSON_SETTINGS::m_filename.

◆ PointerFromString()

nlohmann::json::json_pointer JSON_SETTINGS::PointerFromString ( std::string  aPath)
staticinherited

Builds a JSON pointer based on a given string.

Parameters
aPathis the path in the form "key1.key2.key3"
Returns
a JSON pointer that can be used to index into a JSON object

Definition at line 487 of file json_settings.cpp.

488 {
489  std::replace( aPath.begin(), aPath.end(), '.', '/' );
490  aPath.insert( 0, "/" );
491 
492  nlohmann::json::json_pointer p;
493 
494  try
495  {
496  p = nlohmann::json::json_pointer( aPath );
497  }
498  catch( ... )
499  {
500  wxASSERT_MSG( false, wxT( "Invalid pointer path in PointerFromString!" ) );
501  }
502 
503  return p;
504 }

Referenced by JSON_SETTINGS::fromLegacy(), JSON_SETTINGS::fromLegacyColor(), JSON_SETTINGS::fromLegacyString(), JSON_SETTINGS::GetJson(), JSON_SETTINGS::JSON_SETTINGS(), NESTED_SETTINGS::LoadFromFile(), JSON_SETTINGS::LoadFromFile(), BOARD_DESIGN_SETTINGS::LoadFromFile(), JSON_SETTINGS::Migrate(), APP_SETTINGS_BASE::migrateFindReplace(), FOOTPRINT_EDITOR_SETTINGS::MigrateFromLegacy(), GERBVIEW_SETTINGS::MigrateFromLegacy(), PROJECT_FILE::MigrateFromLegacy(), EDA_3D_VIEWER_SETTINGS::MigrateFromLegacy(), COMMON_SETTINGS::MigrateFromLegacy(), PCB_CALCULATOR_SETTINGS::MigrateFromLegacy(), APP_SETTINGS_BASE::MigrateFromLegacy(), EESCHEMA_SETTINGS::MigrateFromLegacy(), PCBNEW_SETTINGS::MigrateFromLegacy(), SETTINGS_MANAGER::SaveColorSettings(), NESTED_SETTINGS::SaveToFile(), PROJECT_LOCAL_SETTINGS::SaveToFile(), PROJECT_FILE::SaveToFile(), JSON_SETTINGS::Set(), and JSON_SETTINGS::SetIfPresent().

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

438 {
439  wxASSERT( aNewSchemaVersion > aOldSchemaVersion );
440  wxASSERT( aNewSchemaVersion <= m_schemaVersion );
441  m_migrators[aOldSchemaVersion] = std::make_pair( aNewSchemaVersion, aMigrator );
442 }
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(), COMMON_SETTINGS::COMMON_SETTINGS(), FOOTPRINT_EDITOR_SETTINGS::FOOTPRINT_EDITOR_SETTINGS(), and PROJECT_LOCAL_SETTINGS::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 663 of file json_settings.cpp.

664 {
665  if( !aSettings )
666  return;
667 
668  auto it = std::find_if( m_nested_settings.begin(), m_nested_settings.end(),
669  [&aSettings]( const JSON_SETTINGS* aPtr ) {
670  return aPtr == aSettings;
671  } );
672 
673  if( it != m_nested_settings.end() )
674  {
675  wxLogTrace( traceSettings, "Flush and release %s", ( *it )->GetFilename() );
676  ( *it )->SaveToFile();
677  m_nested_settings.erase( it );
678  }
679 
680  aSettings->SetParent( nullptr );
681 }
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.
void SetParent(JSON_SETTINGS *aParent)

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

Referenced by BOARD::ClearProject(), 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 311 of file json_settings.cpp.

312 {
313  for( auto param : m_params )
314  param->SetDefault();
315 }
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)

References JSON_SETTINGS::m_params.

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

◆ SaveToFile()

bool JSON_SETTINGS::SaveToFile ( const wxString &  aDirectory = "",
bool  aForce = false 
)
virtualinherited
   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 in PROJECT_FILE, PROJECT_LOCAL_SETTINGS, and NESTED_SETTINGS.

Definition at line 318 of file json_settings.cpp.

319 {
320  if( !m_writeFile )
321  return false;
322 
323  // Default PROJECT won't have a filename set
324  if( m_filename.IsEmpty() )
325  return false;
326 
327  wxFileName path;
328 
329  if( aDirectory.empty() )
330  {
331  path.Assign( m_filename );
332  path.SetExt( getFileExt() );
333  }
334  else
335  {
336  wxString dir( aDirectory );
337  path.Assign( dir, m_filename, getFileExt() );
338  }
339 
340  if( !m_createIfMissing && !path.FileExists() )
341  {
342  wxLogTrace( traceSettings,
343  "File for %s doesn't exist and m_createIfMissing == false; not saving",
344  GetFullFilename() );
345  return false;
346  }
347 
348  // Ensure the path exists, and create it if not.
349  if( !path.DirExists() && !path.Mkdir() )
350  {
351  wxLogTrace( traceSettings, "Warning: could not create path %s, can't save %s",
352  path.GetPath(), GetFullFilename() );
353  return false;
354  }
355 
356  if( ( path.FileExists() && !path.IsFileWritable() ) ||
357  ( !path.FileExists() && !path.IsDirWritable() ) )
358  {
359  wxLogTrace( traceSettings, "File for %s is read-only; not saving", GetFullFilename() );
360  return false;
361  }
362 
363  bool modified = false;
364 
365  for( auto settings : m_nested_settings )
366  modified |= settings->SaveToFile();
367 
368  modified |= Store();
369 
370  if( !modified && !aForce && path.FileExists() )
371  {
372  wxLogTrace( traceSettings, "%s contents not modified, skipping save", GetFullFilename() );
373  return false;
374  }
375  else if( !modified && !aForce && !m_createIfDefault )
376  {
377  wxLogTrace( traceSettings,
378  "%s contents still default and m_createIfDefault == false; not saving",
379  GetFullFilename() );
380  return false;
381  }
382 
383  wxLogTrace( traceSettings, "Saving %s", GetFullFilename() );
384 
386  bool success = true;
387 
388  try
389  {
390  std::stringstream buffer;
391  buffer << std::setw( 2 ) << *this << std::endl;
392 
393  wxFile file( path.GetFullPath(), wxFile::write );
394 
395  if( !file.IsOpened() || !file.Write( buffer.str().c_str(), buffer.str().size() ) )
396  {
397  wxLogTrace( traceSettings, "Warning: could not save %s", GetFullFilename() );
398  success = false;
399  }
400  }
401  catch( nlohmann::json::exception& error )
402  {
403  wxLogTrace( traceSettings, "Catch error: could not save %s. Json error %s",
404  GetFullFilename(), error.what() );
405  success = false;
406  }
407  catch( ... )
408  {
409  wxLogTrace( traceSettings, "Error: could not save %s." );
410  success = false;
411  }
412 
413  return success;
414 }
virtual bool Store()
Stores the current parameters into the JSON document represented by this object Note: this doesn't do...
Instantiate the current locale within a scope in which you are expecting exceptions to be thrown.
Definition: locale_io.h:40
bool m_createIfMissing
Whether or not the backing store file should be created it if doesn't exist.
wxString GetFullFilename() const
wxString m_filename
The filename (not including path) of this settings file (inicode)
std::vector< NESTED_SETTINGS * > m_nested_settings
Nested settings files that live inside this one, if any.
static LIB_PART * dummy()
Used to draw a dummy shape when a LIB_PART is not found in library.
const wxChar *const traceSettings
Flag to enable debug output of settings operations and management.
bool m_createIfDefault
Whether or not the backing store file should be created if all parameters are still at their default ...
virtual wxString getFileExt() const
bool m_writeFile
Whether or not the backing store file should be written.

References dummy(), JSON_SETTINGS::getFileExt(), JSON_SETTINGS::GetFullFilename(), JSON_SETTINGS::m_createIfDefault, JSON_SETTINGS::m_createIfMissing, JSON_SETTINGS::m_filename, JSON_SETTINGS::m_nested_settings, JSON_SETTINGS::m_writeFile, JSON_SETTINGS::Store(), and traceSettings.

Referenced by JSON_SETTINGS::LoadFromFile(), PANEL_COLOR_SETTINGS::OnThemeChanged(), SETTINGS_MANAGER::SaveColorSettings(), PROJECT_LOCAL_SETTINGS::SaveToFile(), PROJECT_FILE::SaveToFile(), and PGM_BASE::SetLanguage().

◆ Set() [1/3]

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

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 148 of file json_settings.h.

149  {
150  ( *this )[PointerFromString( aPath ) ] = aVal;
151  }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS::PointerFromString().

Referenced by COLOR_MAP_PARAM::Store(), PARAM< wxString >::Store(), PARAM_PATH::Store(), PARAM_ENUM< EnumType >::Store(), PARAM_LAMBDA< nlohmann::json >::Store(), PARAM_SCALED< ValueType >::Store(), PARAM_LIST< wxString >::Store(), PARAM_PATH_LIST::Store(), PARAM_MAP< Value >::Store(), and PARAM_WXSTRING_MAP::Store().

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

696 {
697  ( *this )[PointerFromString( std::move( aPath ) ) ] = aVal.ToUTF8();
698 }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS::PointerFromString().

◆ SetColor()

◆ SetFilename()

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

Definition at line 68 of file json_settings.h.

68 { 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().

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

509 {
510  nlohmann::json::json_pointer ptr = PointerFromString( aPath );
511 
512  if( aObj.contains( ptr ) && aObj.at( ptr ).is_string() )
513  {
514  aTarget = aObj.at( ptr ).get<wxString>();
515  return true;
516  }
517 
518  return false;
519 }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS::PointerFromString().

Referenced by FOOTPRINT_EDITOR_SETTINGS::FOOTPRINT_EDITOR_SETTINGS(), and PROJECT_LOCAL_SETTINGS::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 522 of file json_settings.cpp.

524 {
525  nlohmann::json::json_pointer ptr = PointerFromString( aPath );
526 
527  if( aObj.contains( ptr ) && aObj.at( ptr ).is_boolean() )
528  {
529  aTarget = aObj.at( ptr ).get<bool>();
530  return true;
531  }
532 
533  return false;
534 }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS::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 537 of file json_settings.cpp.

539 {
540  nlohmann::json::json_pointer ptr = PointerFromString( aPath );
541 
542  if( aObj.contains( ptr ) && aObj.at( ptr ).is_number_integer() )
543  {
544  aTarget = aObj.at( ptr ).get<int>();
545  return true;
546  }
547 
548  return false;
549 }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS::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 552 of file json_settings.cpp.

554 {
555  nlohmann::json::json_pointer ptr = PointerFromString( aPath );
556 
557  if( aObj.contains( ptr ) && aObj.at( ptr ).is_number_unsigned() )
558  {
559  aTarget = aObj.at( ptr ).get<unsigned int>();
560  return true;
561  }
562 
563  return false;
564 }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS::PointerFromString().

◆ SetLegacyFilename()

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

Definition at line 72 of file json_settings.h.

72 { 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 LIBEDIT_SETTINGS::LIBEDIT_SETTINGS().

◆ SetManager()

void JSON_SETTINGS::SetManager ( SETTINGS_MANAGER aManager)
inlineinherited

Definition at line 188 of file json_settings.h.

189  {
190  m_manager = aManager;
191  }
SETTINGS_MANAGER * m_manager
A pointer to the settings manager managing this file (may be null)

References JSON_SETTINGS::m_manager.

◆ SetName()

void COLOR_SETTINGS::SetName ( const wxString &  aName)
inline

◆ SetOverrideSchItemColors()

void COLOR_SETTINGS::SetOverrideSchItemColors ( bool  aFlag)
inline

◆ SetReadOnly()

void JSON_SETTINGS::SetReadOnly ( bool  aReadOnly)
inlineinherited

Definition at line 75 of file json_settings.h.

75 { 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 297 of file json_settings.cpp.

298 {
299  bool modified = false;
300 
301  for( auto param : m_params )
302  {
303  modified |= !param->MatchesFile( this );
304  param->Store( this );
305  }
306 
307  return modified;
308 }
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)

References JSON_SETTINGS::m_params.

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

Member Data Documentation

◆ m_colors

std::unordered_map<int, COLOR4D> COLOR_SETTINGS::m_colors
private

Map of all layer colors.

The key needs to be a valid layer ID, see layers_id_colors_and_visibility.h

Definition at line 107 of file color_settings.h.

Referenced by COLOR_SETTINGS(), CreateBuiltinColorSettings(), GetColor(), initFromOther(), and SetColor().

◆ 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 306 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 300 of file json_settings.h.

Referenced by JSON_SETTINGS::SaveToFile().

◆ m_defaultColors

std::unordered_map<int, COLOR4D> COLOR_SETTINGS::m_defaultColors
private

Definition at line 109 of file color_settings.h.

Referenced by GetDefaultColor(), and initFromOther().

◆ m_deleteLegacyAfterMigration

bool JSON_SETTINGS::m_deleteLegacyAfterMigration
protectedinherited

Whether or not to delete legacy file after migration.

Definition at line 312 of file json_settings.h.

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

◆ m_displayName

wxString COLOR_SETTINGS::m_displayName
private

Definition at line 99 of file color_settings.h.

Referenced by COLOR_SETTINGS(), GetName(), initFromOther(), and SetName().

◆ m_filename

wxString JSON_SETTINGS::m_filename
protectedinherited

◆ 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 288 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 291 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 321 of file json_settings.h.

Referenced by FOOTPRINT_EDITOR_SETTINGS::migrateSchema0to1(), 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 327 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 297 of file json_settings.h.

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

◆ m_overrideSchItemColors

bool COLOR_SETTINGS::m_overrideSchItemColors
private

◆ m_Palette

std::vector<COLOR4D> COLOR_SETTINGS::m_Palette

m_Pallete stores a list of colors that are used, in order, when a list of colors needs to be generated for an application.

For example, layer colors in GerbView, or default layer colors in PcbNew.

Definition at line 57 of file color_settings.h.

Referenced by COLOR_SETTINGS(), and KIGFX::GERBVIEW_RENDER_SETTINGS::LoadColors().

◆ m_params

◆ m_preserved_paths

std::vector<nlohmann::json::json_pointer> JSON_SETTINGS::m_preserved_paths
protectedinherited

A list of JSON pointers that are preserved during a read-update-write to disk.

Definition at line 324 of file json_settings.h.

◆ 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 315 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_writeFile

bool JSON_SETTINGS::m_writeFile
protectedinherited

Whether or not the backing store file should be written.

Definition at line 309 of file json_settings.h.

Referenced by CreateBuiltinColorSettings(), initFromOther(), JSON_SETTINGS::IsReadOnly(), JSON_SETTINGS::LoadFromFile(), JSON_SETTINGS::SaveToFile(), and JSON_SETTINGS::SetReadOnly().


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