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 (const wxString &aFilename=wxT("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, const COLOR4D &aColor)
 
const wxString & GetName () const
 
void SetName (const wxString &aName)
 
bool GetOverrideSchItemColors () const
 
void SetOverrideSchItemColors (bool aFlag)
 
bool GetUseBoardStackupColors () const
 
void SetUseBoardStackupColors (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)
 
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...
 
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 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::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 Member Functions

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

Private Attributes

wxString m_displayName
 
bool m_overrideSchItemColors
 
bool m_useBoardStackupColors
 
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 51 of file color_settings.h.

Constructor & Destructor Documentation

◆ COLOR_SETTINGS() [1/2]

COLOR_SETTINGS::COLOR_SETTINGS ( const wxString &  aFilename = wxT( "user" ))
explicit

Definition at line 36 of file color_settings.cpp.

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

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_BOTTOM, LAYER_3D_SOLDERMASK_TOP, 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_DRAWINGSHEET, 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_DRAWINGSHEET, LAYER_GERBVIEW_GRID, LAYER_GLOBLABEL, LAYER_GRID, LAYER_GRID_AXES, LAYER_HIDDEN, LAYER_HIERLABEL, LAYER_JUNCTION, LAYER_LOCLABEL, LAYER_MOD_TEXT_INVISIBLE, LAYER_NEGATIVE_OBJECTS, LAYER_NO_CONNECTS, LAYER_NOCONNECT, LAYER_NON_PLATEDHOLES, LAYER_NOTES, LAYER_PAD_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_DRAWINGSHEET, LAYER_SCHEMATIC_GRID, LAYER_SCHEMATIC_GRID_AXES, LAYER_SELECTION_SHADOWS, LAYER_SHEET, LAYER_SHEET_BACKGROUND, LAYER_SHEETFIELDS, LAYER_SHEETFILENAME, LAYER_SHEETLABEL, LAYER_SHEETNAME, LAYER_VALUEPART, LAYER_VIA_BBLIND, LAYER_VIA_HOLES, LAYER_VIA_MICROVIA, LAYER_VIA_THROUGH, LAYER_WIRE, m_colors, m_displayName, m_overrideSchItemColors, m_Palette, JSON_SETTINGS::m_params, m_useBoardStackupColors, Margin, migrateSchema0to1(), move, path, JSON_SETTINGS::registerMigration(), JSON_SETTINGS::Set(), 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 63 of file color_settings.h.

63 {}

◆ 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 257 of file color_settings.cpp.

257  :
259 {
260  initFromOther( aOther );
261 }
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:63
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 741 of file json_settings.cpp.

742 {
743  wxLogTrace( traceSettings, "AddNestedSettings %s", aSettings->GetFilename() );
744  m_nested_settings.push_back( aSettings );
745 }
wxString GetFilename() const
Definition: json_settings.h:72
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(), migrateSchema0to1(), BOARD_DESIGN_SETTINGS::migrateSchema0to1(), PCBNEW_SETTINGS::PCBNEW_SETTINGS(), and PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_SETTINGS().

◆ 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(), migrateSchema0to1(), BOARD_DESIGN_SETTINGS::migrateSchema0to1(), PROJECT_LOCAL_SETTINGS::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().

◆ 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 381 of file color_settings.cpp.

382 {
383  COLOR_SETTINGS* defaultTheme = new COLOR_SETTINGS( wxT( "_builtin_default" ) );
384  defaultTheme->SetName( _( "KiCad Default" ) );
385  defaultTheme->m_writeFile = false;
386  defaultTheme->Load(); // We can just get the colors out of the param defaults for this one
387 
388  COLOR_SETTINGS* classicTheme = new COLOR_SETTINGS( wxT( "_builtin_classic" ) );
389  classicTheme->SetName( _( "KiCad Classic" ) );
390  classicTheme->m_writeFile = false;
391 
392  for( PARAM_BASE* param : classicTheme->m_params )
393  delete param;
394 
395  classicTheme->m_params.clear(); // Disable load/store
396 
397  for( const std::pair<int, COLOR4D> entry : s_classicTheme )
398  classicTheme->m_colors[entry.first] = entry.second;
399 
400  std::vector<COLOR_SETTINGS*> ret;
401 
402  ret.push_back( defaultTheme );
403  ret.push_back( classicTheme );
404 
405  return ret;
406 }
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)
COLOR_SETTINGS(const wxString &aFilename=wxT("user"))
static const std::map< int, COLOR4D > s_classicTheme
#define _(s)
void SetName(const wxString &aName)
std::unordered_map< int, COLOR4D > m_colors
Map of all layer colors.
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_params, 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 653 of file json_settings.cpp.

655 {
656  ValueType val;
657 
658  if( aConfig->Read( aKey, &val ) )
659  {
660  try
661  {
662  ( *m_internals )[aDest] = val;
663  }
664  catch( ... )
665  {
666  wxASSERT_MSG( false, wxT( "Could not write value in fromLegacy!" ) );
667  return false;
668  }
669 
670  return true;
671  }
672 
673  return false;
674 }

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

715 {
716  wxString str;
717 
718  if( aConfig->Read( aKey, &str ) )
719  {
721  color.SetFromWxString( str );
722 
723  try
724  {
725  nlohmann::json js = nlohmann::json::array( { color.r, color.g, color.b, color.a } );
726  ( *m_internals )[aDest] = js;
727  }
728  catch( ... )
729  {
730  wxASSERT_MSG( false, wxT( "Could not write value in fromLegacyColor!" ) );
731  return false;
732  }
733 
734  return true;
735  }
736 
737  return false;
738 }
int color
Definition: DXF_plotter.cpp:57
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 689 of file json_settings.cpp.

691 {
692  wxString str;
693 
694  if( aConfig->Read( aKey, &str ) )
695  {
696  try
697  {
698  ( *m_internals )[aDest] = str.ToUTF8();
699  }
700  catch( ... )
701  {
702  wxASSERT_MSG( false, wxT( "Could not write value in fromLegacyString!" ) );
703  return false;
704  }
705 
706  return true;
707  }
708 
709  return false;
710 }

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

493 {
494  if( OPT<nlohmann::json> ret = GetJson( aPath ) )
495  {
496  try
497  {
498  return ret->get<ValueType>();
499  }
500  catch( ... )
501  {
502  }
503  }
504 
505  return NULLOPT;
506 }
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 771 of file json_settings.cpp.

772 {
773  if( OPT<nlohmann::json> opt_json = GetJson( aPath ) )
774  return wxString( opt_json->get<std::string>().c_str(), wxConvUTF8 );
775 
776  return NULLOPT;
777 }
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 342 of file color_settings.cpp.

343 {
344  if( m_colors.count( aLayer ) )
345  return m_colors.at( aLayer );
346 
347  return COLOR4D::UNSPECIFIED;
348 }
std::unordered_map< int, COLOR4D > m_colors
Map of all layer colors.

References m_colors.

Referenced by SYMBOL_VIEWER_FRAME::CommonSettingsChanged(), SYMBOL_EDIT_FRAME::CommonSettingsChanged(), PANEL_COLOR_SETTINGS::createSwatch(), PANEL_FP_EDITOR_COLOR_SETTINGS::createSwatches(), GRID_CELL_LAYER_RENDERER::Draw(), SCH_MARKER::getColor(), PCB_MARKER::getColor(), BRDITEMS_PLOTTER::getColor(), SCH_BASE_FRAME::GetDrawBgColor(), FOOTPRINT_VIEWER_FRAME::GetGridColor(), BOARD_ADAPTER::GetItemColor(), PCB_LAYER_SELECTOR::getLayerColor(), PCB_LAYER_BOX_SELECTOR::getLayerColor(), SCH_BASE_FRAME::GetLayerColor(), BOARD_ADAPTER::GetLayerColor(), DIALOG_PLOT_SCHEMATIC::getPlotOptions(), GERBVIEW_FRAME::GetVisibleElementColor(), BOARD_ADAPTER::InitSettings(), PCB_CONTROL::LayerAlphaDec(), PCB_CONTROL::LayerAlphaInc(), KIGFX::GERBVIEW_RENDER_SETTINGS::LoadColors(), KIGFX::DS_RENDER_SETTINGS::LoadColors(), KIGFX::SCH_RENDER_SETTINGS::LoadColors(), KIGFX::PCB_RENDER_SETTINGS::LoadColors(), PANEL_PREVIEW_3D_MODEL::loadSettings(), 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(), SYMBOL_EDIT_FRAME::SwitchCanvas(), SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME(), APPEARANCE_CONTROLS::syncColorsAndVisibility(), APPEARANCE_CONTROLS::syncObjectSettings(), PANEL_EESCHEMA_EDITING_OPTIONS::TransferDataToWindow(), PANEL_3D_COLORS::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 351 of file color_settings.cpp.

352 {
353  if( !m_defaultColors.count( aLayer ) )
354  {
355  COLOR_MAP_PARAM* p = nullptr;
356 
357  for( PARAM_BASE* param : m_params )
358  {
359  COLOR_MAP_PARAM* cmp = dynamic_cast<COLOR_MAP_PARAM*>( param );
360 
361  if( cmp && cmp->GetKey() == aLayer )
362  p = cmp;
363  }
364 
365  if( p )
366  m_defaultColors[aLayer] = p->GetDefault();
367  else
368  m_defaultColors[aLayer] = COLOR4D::UNSPECIFIED;
369  }
370 
371  return m_defaultColors.at( aLayer );
372 }
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)
COLOR4D GetDefault() const
int GetKey() const
std::unordered_map< int, COLOR4D > m_defaultColors

References COLOR_MAP_PARAM::GetDefault(), COLOR_MAP_PARAM::GetKey(), 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 269 of file json_settings.h.

270  {
271  return wxT( "json" );
272  }

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

◆ GetFilename()

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

473 {
474  nlohmann::json::json_pointer ptr = m_internals->PointerFromString( aPath );
475 
476  if( m_internals->contains( ptr ) )
477  {
478  try
479  {
480  return OPT<nlohmann::json>{ m_internals->at( ptr ) };
481  }
482  catch( ... )
483  {
484  }
485  }
486 
487  return OPT<nlohmann::json>{};
488 }
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()

virtual wxString JSON_SETTINGS::getLegacyFileExt ( ) const
inlineprotectedvirtualinherited

Reimplemented in PROJECT_FILE, and PROJECT_LOCAL_SETTINGS.

Definition at line 274 of file json_settings.h.

275  {
276  return wxEmptyString;
277  }

Referenced by JSON_SETTINGS::LoadFromFile().

◆ GetLocation()

SETTINGS_LOC JSON_SETTINGS::GetLocation ( ) const
inlineinherited

Definition at line 78 of file json_settings.h.

78 { 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()

◆ GetUseBoardStackupColors()

bool COLOR_SETTINGS::GetUseBoardStackupColors ( ) const
inline

◆ initFromOther()

void COLOR_SETTINGS::initFromOther ( const COLOR_SETTINGS aOther)
private

Definition at line 274 of file color_settings.cpp.

275 {
276  m_displayName = aOther.m_displayName;
279  m_colors = aOther.m_colors;
281  m_writeFile = aOther.m_writeFile;
282 
283  // Ensure default colors are present
284  for( PARAM_BASE* param : aOther.m_params )
285  {
286  if( COLOR_MAP_PARAM* cmp = dynamic_cast<COLOR_MAP_PARAM*>( param ) )
287  m_defaultColors[cmp->GetKey()] = cmp->GetDefault();
288  }
289 }
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_useBoardStackupColors
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, m_useBoardStackupColors, and JSON_SETTINGS::m_writeFile.

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

◆ 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 migrateSchema0to1(), and SETTINGS_MANAGER::SaveColorSettings().

◆ IsReadOnly()

◆ Load()

void JSON_SETTINGS::Load ( )
virtualinherited

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

Definition at line 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 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 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 550 of file json_settings.cpp.

551 {
552  int filever = m_internals->Get<int>( "meta.version" );
553 
554  while( filever < m_schemaVersion )
555  {
556  if( !m_migrators.count( filever ) )
557  {
558  wxLogTrace( traceSettings, "Migrator missing for %s version %d!",
559  typeid( *this ).name(), filever );
560  return false;
561  }
562 
563  std::pair<int, std::function<bool()>> pair = m_migrators.at( filever );
564 
565  if( pair.second() )
566  {
567  wxLogTrace( traceSettings, "Migrated %s from %d to %d", typeid( *this ).name(),
568  filever, pair.first );
569  filever = pair.first;
570  m_internals->At( "meta.version" ) = filever;
571  }
572  else
573  {
574  wxLogTrace( traceSettings, "Migration failed for %s from %d to %d",
575  typeid( *this ).name(), filever, pair.first );
576  return false;
577  }
578  }
579 
580  return true;
581 }
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 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 292 of file color_settings.cpp.

293 {
294  return false;
295 }

◆ 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 298 of file color_settings.cpp.

299 {
307  if( !m_manager )
308  {
309  wxLogTrace( traceSettings, "Error: COLOR_SETTINGS migration cannot run unmanaged!" );
310  return false;
311  }
312 
313  if( !Contains( "fpedit" ) )
314  {
315  wxLogTrace( traceSettings, "migrateSchema0to1: %s doesn't have fpedit settings; skipping.",
316  m_filename );
317  return true;
318  }
319 
320  wxString filename = m_filename + wxT( "_footprints" );
321 
322  COLOR_SETTINGS* fpsettings = m_manager->AddNewColorSettings( filename );
323 
324  // Start out with a clone
325  fpsettings->m_internals->CloneFrom( *m_internals );
326 
327  // Footprint editor now just looks at the "board" namespace
328  fpsettings->Set( "board", fpsettings->At( "fpedit" ) );
329 
330  fpsettings->Internals()->erase( "fpedit" );
331  fpsettings->Load();
332  fpsettings->SetName( fpsettings->GetName() + wxS( " " ) + _( "(Footprints)" ) );
333  m_manager->Save( fpsettings );
334 
335  // Now we can get rid of our own copy
336  m_internals->erase( "fpedit" );
337 
338  return true;
339 }
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...
JSON_SETTINGS_INTERNALS * Internals()
const wxString & GetName() const
COLOR_SETTINGS * AddNewColorSettings(const wxString &aFilename)
Registers a new color settings object with the given filename.
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...
wxString m_filename
The filename (not including path) of this settings file (inicode)
std::unique_ptr< JSON_SETTINGS_INTERNALS > m_internals
#define _(s)
void SetName(const wxString &aName)
Color settings are a bit different than most of the settings objects in that there can be more than o...
bool Contains(const std::string &aPath) const
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(), JSON_SETTINGS::At(), JSON_SETTINGS::Contains(), GetName(), JSON_SETTINGS::Internals(), JSON_SETTINGS::Load(), JSON_SETTINGS::m_filename, JSON_SETTINGS::m_internals, JSON_SETTINGS::m_manager, SETTINGS_MANAGER::Save(), JSON_SETTINGS::Set(), SetName(), and traceSettings.

Referenced by COLOR_SETTINGS().

◆ operator=()

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

Definition at line 264 of file color_settings.cpp.

265 {
266  m_filename = aOther.m_filename;
267 
268  initFromOther( aOther );
269 
270  return *this;
271 }
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.

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

543 {
544  wxASSERT( aNewSchemaVersion > aOldSchemaVersion );
545  wxASSERT( aNewSchemaVersion <= m_schemaVersion );
546  m_migrators[aOldSchemaVersion] = std::make_pair( aNewSchemaVersion, aMigrator );
547 }
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(), EDA_3D_VIEWER_SETTINGS::EDA_3D_VIEWER_SETTINGS(), EESCHEMA_SETTINGS::EESCHEMA_SETTINGS(), FOOTPRINT_EDITOR_SETTINGS::FOOTPRINT_EDITOR_SETTINGS(), NET_SETTINGS::NET_SETTINGS(), PCBNEW_SETTINGS::PCBNEW_SETTINGS(), PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_SETTINGS(), and SCHEMATIC_SETTINGS::SCHEMATIC_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 748 of file json_settings.cpp.

749 {
750  if( !aSettings )
751  return;
752 
753  auto it = std::find_if( m_nested_settings.begin(), m_nested_settings.end(),
754  [&aSettings]( const JSON_SETTINGS* aPtr ) {
755  return aPtr == aSettings;
756  } );
757 
758  if( it != m_nested_settings.end() )
759  {
760  wxLogTrace( traceSettings, "Flush and release %s", ( *it )->GetFilename() );
761  ( *it )->SaveToFile();
762  m_nested_settings.erase( it );
763  }
764 
765  aSettings->SetParent( nullptr );
766 }
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().

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

373 {
374  if( !m_writeFile )
375  return false;
376 
377  // Default PROJECT won't have a filename set
378  if( m_filename.IsEmpty() )
379  return false;
380 
381  wxFileName path;
382 
383  if( aDirectory.empty() )
384  {
385  path.Assign( m_filename );
386  path.SetExt( getFileExt() );
387  }
388  else
389  {
390  wxString dir( aDirectory );
391  path.Assign( dir, m_filename, getFileExt() );
392  }
393 
394  if( !m_createIfMissing && !path.FileExists() )
395  {
396  wxLogTrace( traceSettings,
397  "File for %s doesn't exist and m_createIfMissing == false; not saving",
398  GetFullFilename() );
399  return false;
400  }
401 
402  // Ensure the path exists, and create it if not.
403  if( !path.DirExists() && !path.Mkdir() )
404  {
405  wxLogTrace( traceSettings, "Warning: could not create path %s, can't save %s",
406  path.GetPath(), GetFullFilename() );
407  return false;
408  }
409 
410  if( ( path.FileExists() && !path.IsFileWritable() ) ||
411  ( !path.FileExists() && !path.IsDirWritable() ) )
412  {
413  wxLogTrace( traceSettings, "File for %s is read-only; not saving", GetFullFilename() );
414  return false;
415  }
416 
417  bool modified = false;
418 
419  for( auto settings : m_nested_settings )
420  modified |= settings->SaveToFile();
421 
422  modified |= Store();
423 
424  if( !modified && !aForce && path.FileExists() )
425  {
426  wxLogTrace( traceSettings, "%s contents not modified, skipping save", GetFullFilename() );
427  return false;
428  }
429  else if( !modified && !aForce && !m_createIfDefault )
430  {
431  wxLogTrace( traceSettings,
432  "%s contents still default and m_createIfDefault == false; not saving",
433  GetFullFilename() );
434  return false;
435  }
436 
437  wxLogTrace( traceSettings, "Saving %s", GetFullFilename() );
438 
440  bool success = true;
441 
442  try
443  {
444  std::stringstream buffer;
445  buffer << std::setw( 2 ) << *m_internals << std::endl;
446 
447  wxFFileOutputStream fileStream( path.GetFullPath(), "wb" );
448 
449  if( !fileStream.IsOk()
450  || !fileStream.WriteAll( buffer.str().c_str(), buffer.str().size() ) )
451  {
452  wxLogTrace( traceSettings, "Warning: could not save %s", GetFullFilename() );
453  success = false;
454  }
455  }
456  catch( nlohmann::json::exception& error )
457  {
458  wxLogTrace( traceSettings, "Catch error: could not save %s. Json error %s",
459  GetFullFilename(), error.what() );
460  success = false;
461  }
462  catch( ... )
463  {
464  wxLogTrace( traceSettings, "Error: could not save %s." );
465  success = false;
466  }
467 
468  return success;
469 }
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
static LIB_SYMBOL * dummy()
Used to draw a dummy shape when a LIB_SYMBOL is not found in library.
Definition: sch_symbol.cpp:72
wxString m_filename
The filename (not including path) of this settings file (inicode)
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.
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_internals, JSON_SETTINGS::m_nested_settings, JSON_SETTINGS::m_writeFile, path, 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 >
template void JSON_SETTINGS::Set< const char * > ( const std::string &  aPath,
ValueType  aVal 
)
inherited

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

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

Definition at line 522 of file json_settings.cpp.

523 {
524  m_internals->SetFromString( aPath, aVal );
525 }
std::unique_ptr< JSON_SETTINGS_INTERNALS > m_internals

References JSON_SETTINGS::m_internals.

Referenced by COLOR_SETTINGS(), BOARD_DESIGN_SETTINGS::LoadFromFile(), APP_SETTINGS_BASE::migrateFindReplace(), FOOTPRINT_EDITOR_SETTINGS::MigrateFromLegacy(), GERBVIEW_SETTINGS::MigrateFromLegacy(), SYMBOL_EDITOR_SETTINGS::MigrateFromLegacy(), PROJECT_FILE::MigrateFromLegacy(), EDA_3D_VIEWER_SETTINGS::MigrateFromLegacy(), COMMON_SETTINGS::MigrateFromLegacy(), APP_SETTINGS_BASE::MigrateFromLegacy(), EESCHEMA_SETTINGS::MigrateFromLegacy(), PCBNEW_SETTINGS::MigrateFromLegacy(), FOOTPRINT_EDITOR_SETTINGS::migrateSchema0to1(), migrateSchema0to1(), BOARD_DESIGN_SETTINGS::migrateSchema0to1(), PCBNEW_SETTINGS::PCBNEW_SETTINGS(), PROJECT_LOCAL_SETTINGS::SaveToFile(), PROJECT_FILE::SaveToFile(), SCHEMATIC_SETTINGS::SCHEMATIC_SETTINGS(), PARAM< wxString >::Store(), COLOR_MAP_PARAM::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 780 of file json_settings.cpp.

781 {
782  ( *m_internals )[aPath] = aVal.ToUTF8();
783 }

◆ SetColor()

◆ SetFilename()

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

Definition at line 76 of file json_settings.h.

76 { 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::GetColorSettings(), 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 592 of file json_settings.cpp.

594 {
595  nlohmann::json::json_pointer ptr = JSON_SETTINGS_INTERNALS::PointerFromString( aPath );
596 
597  if( aObj.contains( ptr ) && aObj.at( ptr ).is_string() )
598  {
599  aTarget = aObj.at( ptr ).get<wxString>();
600  return true;
601  }
602 
603  return false;
604 }
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::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 607 of file json_settings.cpp.

609 {
610  nlohmann::json::json_pointer ptr = JSON_SETTINGS_INTERNALS::PointerFromString( aPath );
611 
612  if( aObj.contains( ptr ) && aObj.at( ptr ).is_boolean() )
613  {
614  aTarget = aObj.at( ptr ).get<bool>();
615  return true;
616  }
617 
618  return false;
619 }
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 622 of file json_settings.cpp.

624 {
625  nlohmann::json::json_pointer ptr = JSON_SETTINGS_INTERNALS::PointerFromString( aPath );
626 
627  if( aObj.contains( ptr ) && aObj.at( ptr ).is_number_integer() )
628  {
629  aTarget = aObj.at( ptr ).get<int>();
630  return true;
631  }
632 
633  return false;
634 }
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 637 of file json_settings.cpp.

639 {
640  nlohmann::json::json_pointer ptr = JSON_SETTINGS_INTERNALS::PointerFromString( aPath );
641 
642  if( aObj.contains( ptr ) && aObj.at( ptr ).is_number_unsigned() )
643  {
644  aTarget = aObj.at( ptr ).get<unsigned int>();
645  return true;
646  }
647 
648  return false;
649 }
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 80 of file json_settings.h.

80 { 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 190 of file json_settings.h.

191  {
192  m_manager = aManager;
193  }
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

◆ SetUseBoardStackupColors()

void COLOR_SETTINGS::SetUseBoardStackupColors ( bool  aFlag)
inline

Definition at line 88 of file color_settings.h.

88 { m_useBoardStackupColors = aFlag; }
bool m_useBoardStackupColors

References m_useBoardStackupColors.

Referenced by PANEL_3D_COLORS::TransferDataFromWindow().

◆ 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_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 layer_ids.h

Definition at line 113 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 301 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 295 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 115 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 307 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 104 of file color_settings.h.

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

◆ m_filename

wxString JSON_SETTINGS::m_filename
protectedinherited

◆ 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 283 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 286 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 316 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 319 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 292 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 59 of file color_settings.h.

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

◆ m_params

◆ 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 310 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_useBoardStackupColors

bool COLOR_SETTINGS::m_useBoardStackupColors
private

◆ m_writeFile

bool JSON_SETTINGS::m_writeFile
protectedinherited

Whether or not the backing store file should be written.

Definition at line 304 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: