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

Static Public Member Functions

static 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...
 

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
 

Static Protected Member Functions

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

Protected Attributes

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

Private 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" ),
bool  aAbsolutePath = false 
)
explicit

Definition at line 36 of file color_settings.cpp.

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

References B_Adhes, B_CrtYd, B_Cu, B_Fab, B_Mask, B_Paste, B_SilkS, CLR, Cmts_User, COLORS, 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_CONFLICTS_SHADOW, 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_EXCLUSION, LAYER_ERC_WARN, LAYER_FIELDS, LAYER_GERBVIEW_AXES, LAYER_GERBVIEW_BACKGROUND, LAYER_GERBVIEW_DRAWINGSHEET, LAYER_GERBVIEW_GRID, LAYER_GERBVIEW_PAGE_LIMITS, LAYER_GLOBLABEL, LAYER_GRID, LAYER_GRID_AXES, LAYER_HIDDEN, LAYER_HIERLABEL, LAYER_HOVERED, LAYER_JUNCTION, LAYER_LOCKED_ITEM_SHADOW, LAYER_LOCLABEL, LAYER_MOD_TEXT_INVISIBLE, LAYER_NEGATIVE_OBJECTS, LAYER_NETCLASS_REFS, LAYER_NOCONNECT, LAYER_NON_PLATEDHOLES, LAYER_NOTES, LAYER_NOTES_BACKGROUND, LAYER_OP_CURRENTS, LAYER_OP_VOLTAGES, LAYER_PAD_PLATEDHOLES, LAYER_PADS_TH, LAYER_PAGE_LIMITS, LAYER_PCB_BACKGROUND, LAYER_PIN, LAYER_PINNAM, LAYER_PINNUM, LAYER_PRIVATE_NOTES, LAYER_RATSNEST, LAYER_REFERENCEPART, LAYER_SCHEMATIC_ANCHOR, LAYER_SCHEMATIC_AUX_ITEMS, LAYER_SCHEMATIC_BACKGROUND, LAYER_SCHEMATIC_CURSOR, LAYER_SCHEMATIC_DRAWINGSHEET, LAYER_SCHEMATIC_GRID, LAYER_SCHEMATIC_GRID_AXES, LAYER_SCHEMATIC_PAGE_LIMITS, 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, JSON_SETTINGS::m_params, m_useBoardStackupColors, Margin, migrateSchema0to1(), move, NONE, path, JSON_SETTINGS::registerMigration(), s_defaultTheme, JSON_SETTINGS::Set(), JSON_SETTINGS::SetLocation(), KIGFX::COLOR4D::ToCSSString(), 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 57 of file color_settings.h.

57{}

◆ 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}
void initFromOther(const COLOR_SETTINGS &aOther)
wxString m_filename
The filename (not including path) of this settings file (inicode)

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

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

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

Referenced by NESTED_SETTINGS::SetParent().

◆ At()

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

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

Definition at line 111 of file json_settings.cpp.

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

References JSON_SETTINGS::m_internals.

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

◆ Contains()

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

◆ 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}
static const std::map< int, COLOR4D > s_classicTheme
Color settings are a bit different than most of the settings objects in that there can be more than o...
void SetName(const wxString &aName)
COLOR_SETTINGS(const wxString &aFilename=wxT("user"), bool aAbsolutePath=false)
bool m_writeFile
Whether or not the backing store file should be written.
virtual void Load()
Updates the parameters of this object based on the current JSON document contents.
#define _(s)

References _, COLOR_SETTINGS(), JSON_SETTINGS::Load(), m_colors, JSON_SETTINGS::m_params, JSON_SETTINGS::m_writeFile, s_classicTheme, and SetName().

Referenced by SETTINGS_MANAGER::registerBuiltinColorSettings().

◆ fetchOrDefault()

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

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

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

Definition at line 849 of file json_settings.cpp.

851{
852 ResultType ret = aDefault;
853
854 try
855 {
856 if( aJson.contains( aKey ) )
857 ret = aJson.at( aKey ).get<ResultType>();
858 }
859 catch( ... )
860 {
861 }
862
863 return ret;
864}

◆ FormatAsString()

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

Definition at line 478 of file json_settings.cpp.

479{
481
482 std::stringstream buffer;
483 buffer << std::setw( 2 ) << *m_internals << std::endl;
484
485 return buffer.str();
486}
Instantiate the current locale within a scope in which you are expecting exceptions to be thrown.
Definition: locale_io.h:41
std::vector< FAB_LAYER_COLOR > dummy

References dummy, and JSON_SETTINGS::m_internals.

Referenced by ROUTER_TOOL::saveRouterDebugLog().

◆ fromLegacy()

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

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

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

Definition at line 702 of file json_settings.cpp.

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

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

764{
765 wxString str;
766
767 if( aConfig->Read( aKey, &str ) )
768 {
770 color.SetFromWxString( str );
771
772 try
773 {
774 nlohmann::json js = nlohmann::json::array( { color.r, color.g, color.b, color.a } );
775 ( *m_internals )[aDest] = js;
776 }
777 catch( ... )
778 {
779 wxASSERT_MSG( false, wxT( "Could not write value in fromLegacyColor!" ) );
780 return false;
781 }
782
783 return true;
784 }
785
786 return false;
787}
int color
Definition: DXF_plotter.cpp:57
nlohmann::json json
Definition: gerbview.cpp:44

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

740{
741 wxString str;
742
743 if( aConfig->Read( aKey, &str ) )
744 {
745 try
746 {
747 ( *m_internals )[aDest] = str.ToUTF8();
748 }
749 catch( ... )
750 {
751 wxASSERT_MSG( false, wxT( "Could not write value in fromLegacyString!" ) );
752 return false;
753 }
754
755 return true;
756 }
757
758 return false;
759}

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

◆ Get() [1/2]

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

Definition at line 820 of file json_settings.cpp.

821{
822 if( std::optional<nlohmann::json> opt_json = GetJson( aPath ) )
823 return wxString( opt_json->get<std::string>().c_str(), wxConvUTF8 );
824
825 return std::nullopt;
826}
std::optional< nlohmann::json > GetJson(const std::string &aPath) const
Fetches a JSON object that is a subset of this JSON_SETTINGS object, using a path of the form "key1....

References JSON_SETTINGS::GetJson().

◆ Get() [2/2]

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

Fetches a value from within the JSON document.

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

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

Definition at line 541 of file json_settings.cpp.

542{
543 if( std::optional<nlohmann::json> ret = GetJson( aPath ) )
544 {
545 try
546 {
547 return ret->get<ValueType>();
548 }
549 catch( ... )
550 {
551 }
552 }
553
554 return std::nullopt;
555}

References JSON_SETTINGS::GetJson().

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

◆ 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}

References m_colors.

Referenced by SCH_BASE_FRAME::CommonSettingsChanged(), SYMBOL_VIEWER_FRAME::CommonSettingsChanged(), PANEL_COLOR_SETTINGS::createSwatch(), PANEL_FP_EDITOR_COLOR_SETTINGS::createSwatches(), DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), DIALOG_JUNCTION_PROPS::DIALOG_JUNCTION_PROPS(), DIALOG_LABEL_PROPERTIES::DIALOG_LABEL_PROPERTIES(), DIALOG_LIB_SHAPE_PROPERTIES::DIALOG_LIB_SHAPE_PROPERTIES(), DIALOG_LIB_TEXT_PROPERTIES::DIALOG_LIB_TEXT_PROPERTIES(), DIALOG_LIB_TEXTBOX_PROPERTIES::DIALOG_LIB_TEXTBOX_PROPERTIES(), DIALOG_LINE_PROPERTIES::DIALOG_LINE_PROPERTIES(), DIALOG_SHAPE_PROPERTIES::DIALOG_SHAPE_PROPERTIES(), DIALOG_SHEET_PIN_PROPERTIES::DIALOG_SHEET_PIN_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_WIRE_BUS_PROPERTIES::DIALOG_WIRE_BUS_PROPERTIES(), KIGFX::SCH_PAINTER::draw(), GRID_CELL_LAYER_RENDERER::Draw(), SCH_MARKER::getColor(), PCB_MARKER::getColor(), BRDITEMS_PLOTTER::getColor(), SCH_BASE_FRAME::GetDrawBgColor(), GERBVIEW_FRAME::GetGridColor(), FOOTPRINT_EDIT_FRAME::GetGridColor(), FOOTPRINT_VIEWER_FRAME::GetGridColor(), PCB_EDIT_FRAME::GetGridColor(), BOARD_ADAPTER::GetItemColor(), GERBVIEW_FRAME::GetLayerColor(), PCB_LAYER_BOX_SELECTOR::getLayerColor(), PCB_LAYER_SELECTOR::getLayerColor(), BOARD_ADAPTER::GetLayerColor(), SCH_BASE_FRAME::GetLayerColor(), DIALOG_PLOT_SCHEMATIC::getPlotOptions(), GERBVIEW_FRAME::GetVisibleElementColor(), BOARD_ADAPTER::InitSettings(), PCB_CONTROL::LayerAlphaDec(), PCB_CONTROL::LayerAlphaInc(), KIGFX::SCH_RENDER_SETTINGS::LoadColors(), KIGFX::GERBVIEW_RENDER_SETTINGS::LoadColors(), KIGFX::DS_RENDER_SETTINGS::LoadColors(), KIGFX::PCB_RENDER_SETTINGS::LoadColors(), PANEL_EESCHEMA_EDITING_OPTIONS::loadEEschemaSettings(), PANEL_PREVIEW_3D_MODEL::loadSettings(), PANEL_COLOR_SETTINGS::OnThemeChanged(), BRDITEMS_PLOTTER::PlotDimension(), SCH_SYMBOL::PlotDNP(), PlotStandardLayer(), PCB_EDIT_FRAME::PrepareLayerIndicator(), SCH_PRINTOUT::PrintPage(), APPEARANCE_CONTROLS::rebuildLayers(), APPEARANCE_CONTROLS::rebuildNets(), APPEARANCE_CONTROLS::rebuildObjects(), PANEL_COLOR_SETTINGS::saveCurrentTheme(), PANEL_EESCHEMA_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_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}
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(), PANEL_3D_COLORS::ResetPanel(), and PANEL_COLOR_SETTINGS::ResetPanel().

◆ getFileExt()

virtual wxString JSON_SETTINGS::getFileExt ( ) const
inlineprotectedvirtualinherited

Reimplemented in DATABASE_LIB_SETTINGS, PROJECT_FILE, and PROJECT_LOCAL_SETTINGS.

Definition at line 275 of file json_settings.h.

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

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

◆ GetFilename()

◆ GetFullFilename()

wxString JSON_SETTINGS::GetFullFilename ( ) const
inherited

Definition at line 105 of file json_settings.cpp.

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

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

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

◆ GetJson()

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

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

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

Definition at line 521 of file json_settings.cpp.

522{
523 nlohmann::json::json_pointer ptr = m_internals->PointerFromString( aPath );
524
525 if( m_internals->contains( ptr ) )
526 {
527 try
528 {
529 return std::optional<nlohmann::json>{ m_internals->at( ptr ) };
530 }
531 catch( ... )
532 {
533 }
534 }
535
536 return std::optional<nlohmann::json>{};
537}

References JSON_SETTINGS::m_internals.

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

◆ getLegacyFileExt()

virtual wxString JSON_SETTINGS::getLegacyFileExt ( ) const
inlineprotectedvirtualinherited

Reimplemented in PROJECT_FILE, and PROJECT_LOCAL_SETTINGS.

Definition at line 280 of file json_settings.h.

281 {
282 return wxEmptyString;
283 }

Referenced by JSON_SETTINGS::LoadFromFile().

◆ GetLocation()

SETTINGS_LOC JSON_SETTINGS::GetLocation ( ) const
inlineinherited

Definition at line 80 of file json_settings.h.

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

References JSON_SETTINGS::m_location.

Referenced by SETTINGS_MANAGER::GetPathForSettingsFile().

◆ GetName()

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

Definition at line 75 of file color_settings.h.

75{ return m_displayName; }

References m_displayName.

Referenced by migrateSchema0to1(), and PANEL_COLOR_SETTINGS::OnThemeChanged().

◆ 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{
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}

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

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

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

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

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

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

◆ LoadFromFile()

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

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

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

Reimplemented in BOARD_DESIGN_SETTINGS, and NESTED_SETTINGS.

Definition at line 146 of file json_settings.cpp.

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

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

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

◆ LoadFromRawFile()

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

Definition at line 489 of file json_settings.cpp.

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

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

◆ Migrate()

bool JSON_SETTINGS::Migrate ( )
inherited

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

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

Returns
true if migration was successful

Definition at line 599 of file json_settings.cpp.

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

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

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

◆ MigrateFromLegacy()

bool 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, wxT( "Error: COLOR_SETTINGS migration cannot run unmanaged!" ) );
310 return false;
311 }
312
313 if( !Contains( "fpedit" ) )
314 {
315 wxLogTrace( traceSettings, wxT( "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}
const wxString & GetName() const
SETTINGS_MANAGER * m_manager
A pointer to the settings manager managing this file (may be null)
bool Contains(const std::string &aPath) const
nlohmann::json & At(const std::string &aPath)
Wrappers for the underlying JSON API so that most consumers don't need json.hpp All of these function...
JSON_SETTINGS_INTERNALS * Internals()
COLOR_SETTINGS * AddNewColorSettings(const wxString &aFilename)
Registers a new color settings object with the given filename.

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}

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

592{
593 wxASSERT( aNewSchemaVersion > aOldSchemaVersion );
594 wxASSERT( aNewSchemaVersion <= m_schemaVersion );
595 m_migrators[aOldSchemaVersion] = std::make_pair( aNewSchemaVersion, aMigrator );
596}

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(), SCHEMATIC_SETTINGS::SCHEMATIC_SETTINGS(), and SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS().

◆ ReleaseNestedSettings()

void JSON_SETTINGS::ReleaseNestedSettings ( NESTED_SETTINGS aSettings)
inherited

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

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

Definition at line 797 of file json_settings.cpp.

798{
799 if( !aSettings || !m_manager )
800 return;
801
802 auto it = std::find_if( m_nested_settings.begin(), m_nested_settings.end(),
803 [&aSettings]( const JSON_SETTINGS* aPtr ) {
804 return aPtr == aSettings;
805 } );
806
807 if( it != m_nested_settings.end() )
808 {
809 wxLogTrace( traceSettings, wxT( "Flush and release %s" ), ( *it )->GetFilename() );
810 ( *it )->SaveToFile();
811 m_nested_settings.erase( it );
812 }
813
814 aSettings->SetParent( nullptr );
815}
void SetParent(JSON_SETTINGS *aParent, bool aLoadFromFile=true)

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

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

◆ ResetToDefaults()

void JSON_SETTINGS::ResetToDefaults ( )
inherited

Resets all parameters to default values.

Does NOT write to file or update underlying JSON.

Definition at line 367 of file json_settings.cpp.

368{
369 for( auto param : m_params )
370 param->SetDefault();
371}

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

375{
376 if( !m_writeFile )
377 return false;
378
379 // Default PROJECT won't have a filename set
380 if( m_filename.IsEmpty() )
381 return false;
382
383 wxFileName path;
384
385 if( aDirectory.empty() )
386 {
387 path.Assign( m_filename );
388 path.SetExt( getFileExt() );
389 }
390 else
391 {
392 wxString dir( aDirectory );
393 path.Assign( dir, m_filename, getFileExt() );
394 }
395
396 if( !m_createIfMissing && !path.FileExists() )
397 {
398 wxLogTrace( traceSettings,
399 wxT( "File for %s doesn't exist and m_createIfMissing == false; not saving" ),
400 GetFullFilename() );
401 return false;
402 }
403
404 // Ensure the path exists, and create it if not.
405 if( !path.DirExists() && !path.Mkdir() )
406 {
407 wxLogTrace( traceSettings, wxT( "Warning: could not create path %s, can't save %s" ),
408 path.GetPath(), GetFullFilename() );
409 return false;
410 }
411
412 if( ( path.FileExists() && !path.IsFileWritable() ) ||
413 ( !path.FileExists() && !path.IsDirWritable() ) )
414 {
415 wxLogTrace( traceSettings, wxT( "File for %s is read-only; not saving" ), GetFullFilename() );
416 return false;
417 }
418
419 bool modified = false;
420
421 for( auto settings : m_nested_settings )
422 modified |= settings->SaveToFile();
423
424 modified |= Store();
425
426 if( !modified && !aForce && path.FileExists() )
427 {
428 wxLogTrace( traceSettings, wxT( "%s contents not modified, skipping save" ), GetFullFilename() );
429 return false;
430 }
431 else if( !modified && !aForce && !m_createIfDefault )
432 {
433 wxLogTrace( traceSettings,
434 wxT( "%s contents still default and m_createIfDefault == false; not saving" ),
435 GetFullFilename() );
436 return false;
437 }
438
439 wxLogTrace( traceSettings, wxT( "Saving %s" ), GetFullFilename() );
440
442 bool success = true;
443
444 nlohmann::json toSave = m_internals->m_original;
445
446 toSave.update( m_internals->begin(), m_internals->end(), /* merge_objects = */ true );
447
448 try
449 {
450 std::stringstream buffer;
451 buffer << std::setw( 2 ) << toSave << std::endl;
452
453 wxFFileOutputStream fileStream( path.GetFullPath(), "wb" );
454
455 if( !fileStream.IsOk()
456 || !fileStream.WriteAll( buffer.str().c_str(), buffer.str().size() ) )
457 {
458 wxLogTrace( traceSettings, wxT( "Warning: could not save %s" ), GetFullFilename() );
459 success = false;
460 }
461 }
462 catch( nlohmann::json::exception& error )
463 {
464 wxLogTrace( traceSettings, wxT( "Catch error: could not save %s. Json error %s" ),
465 GetFullFilename(), error.what() );
466 success = false;
467 }
468 catch( ... )
469 {
470 wxLogTrace( traceSettings, wxT( "Error: could not save %s." ) );
471 success = false;
472 }
473
474 return success;
475}
bool m_createIfDefault
Whether or not the backing store file should be created if all parameters are still at their default ...
bool m_createIfMissing
Whether or not the backing store file should be created it if doesn't exist.
virtual bool Store()
Stores the current parameters into the JSON document represented by this object Note: this doesn't do...

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(), SETTINGS_MANAGER::MigrateIfNeeded(), PANEL_COLOR_SETTINGS::OnThemeChanged(), PROJECT::PinLibrary(), PROJECT_FILE::SaveAs(), PROJECT_LOCAL_SETTINGS::SaveAs(), SETTINGS_MANAGER::SaveColorSettings(), PROJECT_FILE::SaveToFile(), PROJECT_LOCAL_SETTINGS::SaveToFile(), PGM_BASE::SetLanguage(), and PROJECT::UnpinLibrary().

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

572{
573 m_internals->SetFromString( aPath, aVal );
574}

References JSON_SETTINGS::m_internals.

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

◆ Set() [2/3]

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

Definition at line 829 of file json_settings.cpp.

830{
831 ( *m_internals )[aPath] = aVal.ToUTF8();
832}

◆ Set() [3/3]

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

◆ SetColor()

◆ SetFilename()

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

◆ SetIfPresent() [1/4]

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

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

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

Definition at line 656 of file json_settings.cpp.

658{
659 nlohmann::json::json_pointer ptr = JSON_SETTINGS_INTERNALS::PointerFromString( aPath );
660
661 if( aObj.contains( ptr ) && aObj.at( ptr ).is_boolean() )
662 {
663 aTarget = aObj.at( ptr ).get<bool>();
664 return true;
665 }
666
667 return false;
668}

References JSON_SETTINGS_INTERNALS::PointerFromString().

◆ SetIfPresent() [2/4]

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

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

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

Definition at line 671 of file json_settings.cpp.

673{
674 nlohmann::json::json_pointer ptr = JSON_SETTINGS_INTERNALS::PointerFromString( aPath );
675
676 if( aObj.contains( ptr ) && aObj.at( ptr ).is_number_integer() )
677 {
678 aTarget = aObj.at( ptr ).get<int>();
679 return true;
680 }
681
682 return false;
683}

References JSON_SETTINGS_INTERNALS::PointerFromString().

◆ SetIfPresent() [3/4]

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

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

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

Definition at line 686 of file json_settings.cpp.

688{
689 nlohmann::json::json_pointer ptr = JSON_SETTINGS_INTERNALS::PointerFromString( aPath );
690
691 if( aObj.contains( ptr ) && aObj.at( ptr ).is_number_unsigned() )
692 {
693 aTarget = aObj.at( ptr ).get<unsigned int>();
694 return true;
695 }
696
697 return false;
698}

References JSON_SETTINGS_INTERNALS::PointerFromString().

◆ SetIfPresent() [4/4]

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

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

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

Definition at line 641 of file json_settings.cpp.

643{
644 nlohmann::json::json_pointer ptr = JSON_SETTINGS_INTERNALS::PointerFromString( aPath );
645
646 if( aObj.contains( ptr ) && aObj.at( ptr ).is_string() )
647 {
648 aTarget = aObj.at( ptr ).get<wxString>();
649 return true;
650 }
651
652 return false;
653}

References JSON_SETTINGS_INTERNALS::PointerFromString().

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

◆ SetLegacyFilename()

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

Definition at line 82 of file json_settings.h.

82{ m_legacy_filename = aFilename; }

References JSON_SETTINGS::m_legacy_filename.

Referenced by SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS().

◆ SetLocation()

void JSON_SETTINGS::SetLocation ( SETTINGS_LOC  aLocation)
inlineinherited

Definition at line 79 of file json_settings.h.

79{ m_location = aLocation; }

References JSON_SETTINGS::m_location.

Referenced by COLOR_SETTINGS().

◆ SetManager()

void JSON_SETTINGS::SetManager ( SETTINGS_MANAGER aManager)
inlineinherited

Definition at line 191 of file json_settings.h.

192 {
193 m_manager = aManager;
194 }

References JSON_SETTINGS::m_manager.

◆ SetName()

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

◆ SetOverrideSchItemColors()

void COLOR_SETTINGS::SetOverrideSchItemColors ( bool  aFlag)
inline

◆ SetReadOnly()

◆ SetUseBoardStackupColors()

void COLOR_SETTINGS::SetUseBoardStackupColors ( bool  aFlag)
inline

Definition at line 82 of file color_settings.h.

82{ m_useBoardStackupColors = aFlag; }

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

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

References JSON_SETTINGS::m_params.

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

Member Data Documentation

◆ m_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 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 318 of file json_settings.h.

Referenced by JSON_SETTINGS::SaveToFile().

◆ m_createIfMissing

bool JSON_SETTINGS::m_createIfMissing
protectedinherited

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

Definition at line 312 of file json_settings.h.

Referenced by JSON_SETTINGS::SaveToFile().

◆ m_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 324 of file json_settings.h.

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

◆ m_displayName

wxString COLOR_SETTINGS::m_displayName
private

Definition at line 98 of file color_settings.h.

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

◆ m_filename

◆ m_internals

◆ m_legacy_filename

wxString JSON_SETTINGS::m_legacy_filename
protectedinherited

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

Definition at line 300 of file json_settings.h.

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

◆ m_location

SETTINGS_LOC JSON_SETTINGS::m_location
protectedinherited

The location of this settings file (.

See also
SETTINGS_LOC)

Definition at line 303 of file json_settings.h.

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

◆ m_manager

SETTINGS_MANAGER* JSON_SETTINGS::m_manager
protectedinherited

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

Definition at line 333 of file json_settings.h.

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

◆ m_migrators

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

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

Definition at line 336 of file json_settings.h.

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

◆ m_nested_settings

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

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

Definition at line 309 of file json_settings.h.

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

◆ m_overrideSchItemColors

bool COLOR_SETTINGS::m_overrideSchItemColors
private

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

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

◆ m_schemaVersion

int JSON_SETTINGS::m_schemaVersion
protectedinherited

◆ m_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 321 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: