#include <eeschema_settings.h>

Inheritance diagram for EESCHEMA_SETTINGS:

Classes
struct	APPEARANCE

struct	AUI_PANELS

struct	AUTOPLACE_FIELDS

struct	BOM_PLUGIN_SETTINGS

struct	DRAWING

struct	FIND_REPLACE_EXTRA

struct	INPUT

struct	NETLIST_PLUGIN_SETTINGS

struct	PAGE_SETTINGS

struct	PANEL_ANNOTATE

struct	PANEL_BOM

struct	PANEL_FIELD_EDITOR

struct	PANEL_LIB_VIEW

struct	PANEL_NETLIST

struct	PANEL_PLOT

struct	PANEL_SYM_CHOOSER

struct	SELECTION

struct	SIMULATOR

Public Member Functions
	EESCHEMA_SETTINGS ()

virtual	~EESCHEMA_SETTINGS ()

virtual bool	MigrateFromLegacy (wxConfigBase *aLegacyConfig) override
	Migrates from wxConfig to JSON-based configuration. More...

const std::vector< wxString >	DefaultGridSizeList () const

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::json &	At (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_INTERNALS *	Internals ()

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

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
APPEARANCE	m_Appearance

AUTOPLACE_FIELDS	m_AutoplaceFields

AUI_PANELS	m_AuiPanels

DRAWING	m_Drawing

FIND_REPLACE_EXTRA	m_FindReplaceExtra

INPUT	m_Input

PAGE_SETTINGS	m_PageSettings

PANEL_ANNOTATE	m_AnnotatePanel

PANEL_BOM	m_BomPanel

PANEL_FIELD_EDITOR	m_FieldEditorPanel

PANEL_LIB_VIEW	m_LibViewPanel

PANEL_NETLIST	m_NetlistPanel

PANEL_PLOT	m_PlotPanel

PANEL_SYM_CHOOSER	m_SymChooserPanel

SELECTION	m_Selection

SIMULATOR	m_Simulator

bool	m_RescueNeverShow

wxString	m_lastSymbolLibDir

CROSS_PROBING_SETTINGS	m_CrossProbing

FIND_REPLACE	m_FindReplace

GRAPHICS	m_Graphics

COLOR_PICKER	m_ColorPicker

LIB_TREE	m_LibTree

PRINTING	m_Printing

SYSTEM	m_System

WINDOW_SETTINGS	m_Window

wxString	m_ColorTheme
	Active color theme name. More...

int	m_appSettingsSchemaVersion
	! Local schema version for common app settings More...

Protected Member Functions
virtual std::string	getLegacyFrameName () const override

void	migrateFindReplace (wxConfigBase *aCfg)
	! Migrates the find/replace history string lists More...

bool	migrateWindowConfig (wxConfigBase *aCfg, const std::string &aFrameName, const std::string &aJsonPath)
	Migrates legacy window settings into the JSON document. More...

void	addParamsForWindow (WINDOW_SETTINGS *aWindow, const std::string &aJsonPath)
	Adds parameters for the given window object. More...

bool	migrateLibTreeWidth ()
	Migrates the library tree width setting from a single column (Item) to multi-column. More...

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_MANAGER *	m_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_INTERNALS >	m_internals

Private Member Functions
bool	migrateBomSettings ()

nlohmann::json	bomSettingsToJson () const

nlohmann::json	netlistSettingsToJson () const

Static Private Member Functions
static std::vector< BOM_PLUGIN_SETTINGS >	bomSettingsFromJson (const nlohmann::json &aObj)

static std::vector< NETLIST_PLUGIN_SETTINGS >	netlistSettingsFromJson (const nlohmann::json &aObj)

Detailed Description

Definition at line 43 of file eeschema_settings.h.

Constructor & Destructor Documentation

◆ EESCHEMA_SETTINGS()

EESCHEMA_SETTINGS::EESCHEMA_SETTINGS ( )

Definition at line 63 of file eeschema_settings.cpp.

  :
 APP_SETTINGS_BASE( "eeschema", eeschemaSchemaVersion ),
 m_Appearance(),
 m_AutoplaceFields(),
 m_Drawing(),
 m_FindReplaceExtra(),
 m_Input(),
 m_PageSettings(),
 m_AnnotatePanel(),
 m_BomPanel(),
 m_FieldEditorPanel(),
 m_LibViewPanel(),
 m_NetlistPanel(),
 m_PlotPanel(),
 m_SymChooserPanel(),
 m_Selection(),
 m_Simulator(),
 m_RescueNeverShow( false )
{
 m_params.emplace_back( new PARAM<wxString>( "appearance.edit_symbol_visible_columns",
 &m_Appearance.edit_symbol_visible_columns, "0 1 2 3 4 5 6 7" ) );
 
 m_params.emplace_back( new PARAM<int>( "appearance.edit_symbol_width",
 &m_Appearance.edit_symbol_width, -1 ) );
 
 m_params.emplace_back( new PARAM<int>( "appearance.edit_symbol_height",
 &m_Appearance.edit_symbol_height, -1 ) );
 
 m_params.emplace_back( new PARAM<wxString>( "appearance.edit_sheet_visible_columns",
 &m_Appearance.edit_sheet_visible_columns, "0 1 2 3 4 5 6 7" ) );
 
 m_params.emplace_back( new PARAM<int>( "appearance.edit_sheet_width",
 &m_Appearance.edit_sheet_width, -1 ) );
 
 m_params.emplace_back( new PARAM<int>( "appearance.edit_sheet_height",
 &m_Appearance.edit_sheet_height, -1 ) );
 
 m_params.emplace_back( new PARAM<wxString>( "appearance.edit_label_visible_columns",
 &m_Appearance.edit_label_visible_columns, "0 1 2 3 4 5 6 7" ) );
 
 m_params.emplace_back( new PARAM<int>( "appearance.edit_label_width",
 &m_Appearance.edit_label_width, -1 ) );
 
 m_params.emplace_back( new PARAM<int>( "appearance.edit_label_height",
 &m_Appearance.edit_label_height, -1 ) );
 
 m_params.emplace_back( new PARAM<int>( "appearance.erc_severities",
 &m_Appearance.erc_severities, RPT_SEVERITY_ERROR | RPT_SEVERITY_WARNING ) );
 
 m_params.emplace_back( new PARAM<bool>( "appearance.footprint_preview",
 &m_Appearance.footprint_preview, true ) );
 
 m_params.emplace_back( new PARAM<bool>( "appearance.print_sheet_reference",
 &m_Appearance.print_sheet_reference, true ) );
 
 m_params.emplace_back( new PARAM<wxString>( "appearance.default_font",
 &m_Appearance.default_font, "KiCad Font" ) );
 
 m_params.emplace_back( new PARAM<bool>( "appearance.show_hidden_pins",
 &m_Appearance.show_hidden_pins, false ) );
 
 m_params.emplace_back( new PARAM<bool>( "appearance.show_hidden_fields",
 &m_Appearance.show_hidden_fields, false ) );
 
 m_params.emplace_back( new PARAM<bool>( "appearance.show_erc_warnings",
 &m_Appearance.show_erc_warnings, true ) );
 
 m_params.emplace_back( new PARAM<bool>( "appearance.show_erc_errors",
 &m_Appearance.show_erc_errors, true ) );
 
 m_params.emplace_back( new PARAM<bool>( "appearance.show_erc_exclusions",
 &m_Appearance.show_erc_exclusions, false ) );
 
 m_params.emplace_back( new PARAM<bool>( "appearance.show_op_voltages",
 &m_Appearance.show_op_voltages, true ) );
 
 m_params.emplace_back( new PARAM<bool>( "appearance.show_op_currents",
 &m_Appearance.show_op_currents, true ) );
 
 m_params.emplace_back( new PARAM<bool>( "appearance.show_illegal_symbol_lib_dialog",
 &m_Appearance.show_illegal_symbol_lib_dialog, true ) );
 
 m_params.emplace_back( new PARAM<bool>( "appearance.show_page_limits",
 &m_Appearance.show_page_limits, true ) );
 
 m_params.emplace_back( new PARAM<bool>( "appearance.show_sexpr_file_convert_warning",
 &m_Appearance.show_sexpr_file_convert_warning, true ) );
 
 m_params.emplace_back(
 new PARAM<bool>( "appearance.show_sheet_filename_case_sensitivity_dialog",
 &m_Appearance.show_sheet_filename_case_sensitivity_dialog, true ) );
 
 m_params.emplace_back( new PARAM<bool>( "aui.show_schematic_hierarchy",
 &m_AuiPanels.show_schematic_hierarchy, true ) );
 
 m_params.emplace_back( new PARAM<int>( "aui.hierarchy_panel_docked_width",
 &m_AuiPanels.hierarchy_panel_docked_width, -1 ) );
 
 m_params.emplace_back( new PARAM<int>( "aui.hierarchy_panel_float_width",
 &m_AuiPanels.hierarchy_panel_float_width, -1 ) );
 
 m_params.emplace_back( new PARAM<int>( "aui.hierarchy_panel_float_height",
 &m_AuiPanels.hierarchy_panel_float_height, -1 ) );
 
 m_params.emplace_back( new PARAM<bool>( "aui.schematic_hierarchy_float",
 &m_AuiPanels.schematic_hierarchy_float, false ) );
 
 m_params.emplace_back( new PARAM<bool>( "autoplace_fields.enable",
 &m_AutoplaceFields.enable, true ) );
 
 m_params.emplace_back( new PARAM<bool>( "autoplace_fields.allow_rejustify",
 &m_AutoplaceFields.allow_rejustify, true ) );
 
 m_params.emplace_back( new PARAM<bool>( "autoplace_fields.align_to_grid",
 &m_AutoplaceFields.align_to_grid, true ) );
 
 m_params.emplace_back( new PARAM<int>( "drawing.default_bus_thickness",
 &m_Drawing.default_bus_thickness, DEFAULT_BUS_WIDTH_MILS ) );
 
 m_params.emplace_back( new PARAM<int>( "drawing.default_junction_size",
 &m_Drawing.default_junction_size, DEFAULT_JUNCTION_DIAM ) );
 
 m_params.emplace_back( new PARAM<int>( "drawing.pin_symbol_size",
 &m_Drawing.pin_symbol_size, DEFAULT_TEXT_SIZE / 2 ) );
 
 m_params.emplace_back( new PARAM<double>( "drawing.text_offset_ratio",
 &m_Drawing.text_offset_ratio, 0.08 ) );
 
 m_params.emplace_back( new PARAM<int>( "drawing.default_line_thickness",
 &m_Drawing.default_line_thickness, DEFAULT_LINE_WIDTH_MILS ) );
 
 m_params.emplace_back( new PARAM<int>( "drawing.default_repeat_offset_x",
 &m_Drawing.default_repeat_offset_x, 0 ) );
 
 m_params.emplace_back( new PARAM<int>( "drawing.default_repeat_offset_y",
 &m_Drawing.default_repeat_offset_y, 100 ) );
 
 m_params.emplace_back( new PARAM<int>( "drawing.default_wire_thickness",
 &m_Drawing.default_wire_thickness, DEFAULT_WIRE_WIDTH_MILS ) );
 
 m_params.emplace_back( new PARAM<int>( "drawing.default_text_size",
 &m_Drawing.default_text_size, DEFAULT_TEXT_SIZE ) );
 
 m_params.emplace_back( new PARAM<wxString>( "drawing.field_names",
  &m_Drawing.field_names, "" ) );
 
 m_params.emplace_back( new PARAM<int>( "drawing.line_mode", &m_Drawing.line_mode,
 LINE_MODE::LINE_MODE_90 ) );
 
 m_params.emplace_back( new PARAM<bool>( "drawing.auto_start_wires",
 &m_Drawing.auto_start_wires, true ) );
 
 m_params.emplace_back( new PARAM<int>( "drawing.repeat_label_increment",
 &m_Drawing.repeat_label_increment, 1 ) );
 
 m_params.emplace_back( new PARAM<COLOR4D>( "drawing.default_sheet_border_color",
 &m_Drawing.default_sheet_border_color, COLOR4D::UNSPECIFIED ) );
 
 m_params.emplace_back( new PARAM<COLOR4D>( "drawing.default_sheet_background_color",
 &m_Drawing.default_sheet_background_color, COLOR4D::UNSPECIFIED ) );
 
 m_params.emplace_back( new PARAM_LIST<double>( "drawing.junction_size_mult_list",
 &m_Drawing.junction_size_mult_list, { 0.0, 1.7, 4.0, 6.0, 9.0, 12.0 } ) );
 
 m_params.emplace_back(new PARAM <int>( "drawing.junction_size_choice",
 &m_Drawing.junction_size_choice, 3 ) );
 
 m_params.emplace_back( new PARAM<bool>( "find_replace.search_all_fields",
 &m_FindReplaceExtra.search_all_fields, false ) );
 
 m_params.emplace_back( new PARAM<bool>( "find_replace.search_all_pins",
 &m_FindReplaceExtra.search_all_pins, false ) );
 
 m_params.emplace_back( new PARAM<bool>( "find_replace.search_current_sheet_only",
 &m_FindReplaceExtra.search_current_sheet_only,
 false ) );
 
 m_params.emplace_back( new PARAM<bool>( "find_replace.replace_references",
 &m_FindReplaceExtra.replace_references, false ) );
 
 m_params.emplace_back( new PARAM<bool>( "input.drag_is_move",
 &m_Input.drag_is_move, false ) );
 
 m_params.emplace_back( new PARAM<bool>( "input.esc_clears_net_highlight",
 &m_Input.esc_clears_net_highlight, true ) );
 
 m_params.emplace_back( new PARAM<int>( "selection.thickness",
 &m_Selection.selection_thickness, 3 ) );
 
 m_params.emplace_back( new PARAM<int>( "selection.highlight_thickness",
 &m_Selection.highlight_thickness, 2 ) );
 
 m_params.emplace_back( new PARAM<bool>( "selection.draw_selected_children",
 &m_Selection.draw_selected_children, true ) );
 
 m_params.emplace_back( new PARAM<bool>( "selection.fill_shapes",
 &m_Selection.fill_shapes, false ) );
 
 m_params.emplace_back( new PARAM<bool>( "selection.select_pin_selects_symbol",
 &m_Selection.select_pin_selects_symbol, false ) );
 
 m_params.emplace_back( new PARAM<bool>( "annotation.automatic",
 &m_AnnotatePanel.automatic, true ) );
 
 m_params.emplace_back( new PARAM<bool>( "annotation.recursive",
 &m_AnnotatePanel.recursive, true ) );
 
 m_params.emplace_back( new PARAM<int>( "annotation.method",
 &m_AnnotatePanel.method, 0, 0, 2 ) );
 
 m_params.emplace_back( new PARAM<int>( "annotation.scope",
 &m_AnnotatePanel.scope, 0, 0, 2 ) );
 
 m_params.emplace_back( new PARAM<int>( "annotation.options",
 &m_AnnotatePanel.options, 0, 0, 2 ) );
 
 m_params.emplace_back( new PARAM<int>( "annotation.messages_filter",
 &m_AnnotatePanel.messages_filter, -1 ) );
 
 m_params.emplace_back( new PARAM<int>( "annotation.sort_order",
 &m_AnnotatePanel.sort_order, 0, 0, 1 ) );
 
 m_params.emplace_back( new PARAM<wxString>( "bom.selected_plugin",
 &m_BomPanel.selected_plugin, "" ) );
 
 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "bom.plugins",
 std::bind( &EESCHEMA_SETTINGS::bomSettingsToJson, this ),
 [&]( const nlohmann::json& aObj )
 {
 if( !aObj.is_array() )
 return;
 
 const nlohmann::json& list = aObj.empty() ? defaultBomPlugins : aObj;
 
 m_BomPanel.plugins = bomSettingsFromJson( list );
 },
 defaultBomPlugins ) );
 
 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "netlist.plugins",
 std::bind( &EESCHEMA_SETTINGS::netlistSettingsToJson, this ),
 [&]( const nlohmann::json& aObj )
 {
 if( !aObj.is_array() )
 return;
 
 if( aObj.empty() )
 return;
 
 const nlohmann::json& list = aObj;
 
 m_NetlistPanel.plugins = netlistSettingsFromJson( list );
 },
 nullptr ) );
 
 m_params.emplace_back( new PARAM<bool>( "page_settings.export_paper",
 &m_PageSettings.export_paper, false ) );
 
 m_params.emplace_back( new PARAM<bool>( "page_settings.export_revision",
 &m_PageSettings.export_revision, false ) );
 
 m_params.emplace_back( new PARAM<bool>( "page_settings.export_date",
 &m_PageSettings.export_date, false ) );
 
 m_params.emplace_back( new PARAM<bool>( "page_settings.export_title",
 &m_PageSettings.export_title, false ) );
 
 m_params.emplace_back( new PARAM<bool>( "page_settings.export_company",
 &m_PageSettings.export_company, false ) );
 
 m_params.emplace_back( new PARAM<bool>( "page_settings.export_comment1",
 &m_PageSettings.export_comment1, false ) );
 
 m_params.emplace_back( new PARAM<bool>( "page_settings.export_comment2",
 &m_PageSettings.export_comment2, false ) );
 
 m_params.emplace_back( new PARAM<bool>( "page_settings.export_comment3",
 &m_PageSettings.export_comment3, false ) );
 
 m_params.emplace_back( new PARAM<bool>( "page_settings.export_comment4",
 &m_PageSettings.export_comment4, false ) );
 
 m_params.emplace_back( new PARAM<bool>( "page_settings.export_comment5",
 &m_PageSettings.export_comment5, false ) );
 
 m_params.emplace_back( new PARAM<bool>( "page_settings.export_comment6",
 &m_PageSettings.export_comment6, false ) );
 
 m_params.emplace_back( new PARAM<bool>( "page_settings.export_comment7",
 &m_PageSettings.export_comment7, false ) );
 
 m_params.emplace_back( new PARAM<bool>( "page_settings.export_comment8",
 &m_PageSettings.export_comment8, false ) );
 
 m_params.emplace_back( new PARAM<bool>( "page_settings.export_comment9",
 &m_PageSettings.export_comment9, false ) );
 
 m_params.emplace_back( new PARAM_MAP<bool>( "field_editor.fields_show",
 &m_FieldEditorPanel.fields_show, {} ) );
 
 m_params.emplace_back( new PARAM_MAP<bool>( "field_editor.fields_group_by",
 &m_FieldEditorPanel.fields_group_by, {} ) );
 
 m_params.emplace_back( new PARAM_MAP<int>( "field_editor.column_widths",
 &m_FieldEditorPanel.column_widths, {} ) );
 
 m_params.emplace_back( new PARAM<bool>( "plot.background_color",
 &m_PlotPanel.background_color, false ) );
 
 m_params.emplace_back( new PARAM<bool>( "plot.color",
 &m_PlotPanel.color, true ) );
 
 m_params.emplace_back( new PARAM<wxString>( "plot.color_theme",
 &m_PlotPanel.color_theme, wxT( "user" ) ) );
 
 m_params.emplace_back( new PARAM<int>( "plot.format",
 &m_PlotPanel.format, 0 ) );
 
 m_params.emplace_back( new PARAM<bool>( "plot.frame_reference",
 &m_PlotPanel.frame_reference, true ) );
 
 m_params.emplace_back( new PARAM<int>( "plot.hpgl_paper_size",
 &m_PlotPanel.hpgl_paper_size, 0 ) );
 
 m_params.emplace_back( new PARAM<double>( "plot.hpgl_pen_size",
 &m_PlotPanel.hpgl_pen_size, 0.5 ) );
 
 m_params.emplace_back( new PARAM<int>( "plot.hpgl_origin",
 &m_PlotPanel.hpgl_origin, 0 ) );
 
 m_params.emplace_back( new PARAM<bool>( "plot.other_open_file_after_plot",
 &m_PlotPanel.open_file_after_plot, false ) );
 
 m_params.emplace_back( new PARAM<int>( "simulator.window.pos_x",
 &m_Simulator.window.state.pos_x, 0 ) );
 
 m_params.emplace_back( new PARAM<int>( "simulator.window.pos_y",
 &m_Simulator.window.state.pos_y, 0 ) );
 
 m_params.emplace_back( new PARAM<int>( "simulator.window.size_x",
 &m_Simulator.window.state.size_x, 500 ) );
 
 m_params.emplace_back( new PARAM<int>( "simulator.window.size_y",
 &m_Simulator.window.state.size_y, 400 ) );
 
 m_params.emplace_back( new PARAM<unsigned int>( "simulator.window.display",
 &m_Simulator.window.state.display, 0 ) );
 
 m_params.emplace_back( new PARAM<bool>( "simulator.window.maximized",
 &m_Simulator.window.state.maximized, false ) );
 
 m_params.emplace_back( new PARAM<wxString>( "simulator.window.perspective",
 &m_Simulator.window.perspective, "" ) );
 
 m_params.emplace_back( new PARAM<int>( "simulator.plot_panel_width",
 &m_Simulator.plot_panel_width, 0 ) );
 
 m_params.emplace_back( new PARAM<int>( "simulator.plot_panel_height",
 &m_Simulator.plot_panel_height, 0 ) );
 
 m_params.emplace_back( new PARAM<int>( "simulator.signal_panel_height",
 &m_Simulator.signal_panel_height, 0 ) );
 
 m_params.emplace_back( new PARAM<int>( "simulator.cursors_panel_height",
 &m_Simulator.cursors_panel_height, 0 ) );
 
 m_params.emplace_back( new PARAM<int>( "simulator.measurements_panel_height",
 &m_Simulator.measurements_panel_height, 0 ) );
 
 m_params.emplace_back( new PARAM<bool>( "simulator.white_background",
 &m_Simulator.white_background, false ) );
 
 m_params.emplace_back( new PARAM<int>( "symbol_chooser.sash_pos_h",
 &m_SymChooserPanel.sash_pos_h, -1 ) );
 
 m_params.emplace_back( new PARAM<int>( "symbol_chooser.sash_pos_v",
 &m_SymChooserPanel.sash_pos_v, -1 ) );
 
 m_params.emplace_back( new PARAM<int>( "symbol_chooser.width",
 &m_SymChooserPanel.width, -1 ) );
 
 m_params.emplace_back( new PARAM<int>( "symbol_chooser.height",
 &m_SymChooserPanel.height, -1 ) );
 
 m_params.emplace_back( new PARAM<bool>( "symbol_chooser.keep_symbol",
 &m_SymChooserPanel.keep_symbol, false ) );
 
 m_params.emplace_back( new PARAM<bool>( "symbol_chooser.place_all_units",
 &m_SymChooserPanel.place_all_units, true ) );
 
 m_params.emplace_back( new PARAM<bool>( "system.never_show_rescue_dialog",
 &m_RescueNeverShow, false ) );
 
 m_params.emplace_back( new PARAM<int>( "lib_view.window.pos_x",
 &m_LibViewPanel.window.state.pos_x, 0 ) );
 
 m_params.emplace_back( new PARAM<int>( "lib_view.window.pos_y",
 &m_LibViewPanel.window.state.pos_y, 0 ) );
 
 m_params.emplace_back( new PARAM<int>( "lib_view.window.size_x",
 &m_LibViewPanel.window.state.size_x, 500 ) );
 
 m_params.emplace_back( new PARAM<int>( "lib_view.window.size_y",
 &m_LibViewPanel.window.state.size_y, 400 ) );
 
 m_params.emplace_back( new PARAM<unsigned int>( "lib_view.window.display",
 &m_LibViewPanel.window.state.display, 0 ) );
 
 m_params.emplace_back( new PARAM<bool>( "lib_view.window.maximized",
 &m_LibViewPanel.window.state.maximized, false ) );
 
 m_params.emplace_back( new PARAM<wxString>( "lib_view.window.perspective",
 &m_LibViewPanel.window.perspective, "" ) );
 
 m_params.emplace_back( new PARAM<int>( "lib_view.lib_list_width",
 &m_LibViewPanel.lib_list_width, 150 ) );
 
 m_params.emplace_back( new PARAM<int>( "lib_view.cmp_list_width",
 &m_LibViewPanel.cmp_list_width, 150 ) );
 
 m_params.emplace_back( new PARAM<bool>( "lib_view.show_pin_electrical_type",
 &m_LibViewPanel.show_pin_electrical_type, true ) );
 
 m_params.emplace_back( new PARAM<wxString>( "system.last_symbol_lib_dir",
 &m_lastSymbolLibDir, "" ) );
 
 
 // Migrations
 
 registerMigration( 0, 1,
 [&]() -> bool
 {
 // Version 0 to 1: BOM plugin settings moved from sexpr to JSON
 return migrateBomSettings();
 } );
 
 
 registerMigration( 1, 2,
 [&]() -> bool
 {
 // We used to have a bug on GTK which would set the lib tree column width way
 // too narrow.
 if( std::optional<int> optval = Get<int>( "lib_tree.column_width" ) )
 {
 if( optval < 150 )
 Set( "lib_tree.column_width", 300 );
 }
 
 return true;
 } );
 
 registerMigration( 2, 3,
 [&]() -> bool
 {
 // This is actually a migration for APP_SETTINGS_BASE::m_LibTree
 return migrateLibTreeWidth();
 } );
}

◆ ~EESCHEMA_SETTINGS()

virtual EESCHEMA_SETTINGS::~EESCHEMA_SETTINGS ( )

inlinevirtual

Definition at line 262 of file eeschema_settings.h.

262{}

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

aSettings	is the settings object to take ownership of
aTarget	is a pointer to update to the passed in settings

Definition at line 790 of file json_settings.cpp.

{
 wxLogTrace( traceSettings, wxT( "AddNestedSettings %s" ), aSettings->GetFilename() );
 m_nested_settings.push_back( aSettings );
}

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

Referenced by NESTED_SETTINGS::SetParent().

◆ addParamsForWindow()

void APP_SETTINGS_BASE::addParamsForWindow	(	WINDOW_SETTINGS *	aWindow,
		const std::string &	aJsonPath
	)

protectedinherited

Adds parameters for the given window object.

Parameters

aWindow	is the target window settings object
aJsonPath	is the path to read parameters from

Definition at line 291 of file app_settings.cpp.

{
 m_params.emplace_back( new PARAM<bool>( aJsonPath + ".maximized",
 &aWindow->state.maximized, false ) );
 
 m_params.emplace_back( new PARAM<wxString>( aJsonPath + ".mru_path",
 &aWindow->mru_path, wxS( "" ) ) );
 
 m_params.emplace_back( new PARAM<int>( aJsonPath + ".size_x", &aWindow->state.size_x, 0 ) );
 
 m_params.emplace_back( new PARAM<int>( aJsonPath + ".size_y", &aWindow->state.size_y, 0 ) );
 
 m_params.emplace_back( new PARAM<wxString>( aJsonPath + ".perspective",
 &aWindow->perspective, wxS( "" ) ) );
 
 m_params.emplace_back( new PARAM<int>( aJsonPath + ".pos_x", &aWindow->state.pos_x, 0 ) );
 
 m_params.emplace_back( new PARAM<int>( aJsonPath + ".pos_y", &aWindow->state.pos_y, 0 ) );
 
 m_params.emplace_back( new PARAM<unsigned int>( aJsonPath + ".display", &aWindow->state.display, 0 ) );
 
 m_params.emplace_back( new PARAM_LIST<double>( aJsonPath + ".zoom_factors",
 &aWindow->zoom_factors, {} ) );
 
 m_params.emplace_back( new PARAM<bool>( aJsonPath + ".grid.axes_enabled",
 &aWindow->grid.axes_enabled, false ) );
 
 int defaultGridIdx;
 
 if( m_filename == wxS( "pl_editor" ) )
 {
 defaultGridIdx = 1;
 
 m_params.emplace_back( new PARAM_LIST<wxString>( aJsonPath + ".grid.sizes",
 &aWindow->grid.sizes, DefaultGridSizeList() ) );
 }
 else if( m_filename == wxS( "eeschema" ) || m_filename == wxS( "symbol_editor" ) )
 {
 defaultGridIdx = 1;
 
 // Eeschema's grids are fixed to keep wires/pins connected
 }
 else
 {
 defaultGridIdx = 4;
 
 m_params.emplace_back( new PARAM_LIST<wxString>( aJsonPath + ".grid.sizes",
 &aWindow->grid.sizes, DefaultGridSizeList() ) );
 }
 
 m_params.emplace_back( new PARAM<int>( aJsonPath + ".grid.last_size",
 &aWindow->grid.last_size_idx, defaultGridIdx ) );
 
 m_params.emplace_back( new PARAM<int>( aJsonPath + ".grid.fast_grid_1",
 &aWindow->grid.fast_grid_1, defaultGridIdx ) );
 
 m_params.emplace_back( new PARAM<int>( aJsonPath + ".grid.fast_grid_2",
 &aWindow->grid.fast_grid_2, defaultGridIdx + 1 ) );
 
 // for grid user, use a default value compatible with eeschema and pcbnew (10 mils)
 m_params.emplace_back( new PARAM<wxString>( aJsonPath + ".grid.user_grid_x",
 &aWindow->grid.user_grid_x, "10 mil" ) );
 m_params.emplace_back( new PARAM<wxString>( aJsonPath + ".grid.user_grid_y",
 &aWindow->grid.user_grid_y, "10 mil" ) );
 
 m_params.emplace_back( new PARAM<double>( aJsonPath + ".grid.line_width",
 &aWindow->grid.line_width, 1.0 ) );
 
 m_params.emplace_back( new PARAM<double>( aJsonPath + ".grid.min_spacing",
 &aWindow->grid.min_spacing, 10 ) );
 
 m_params.emplace_back( new PARAM<bool>( aJsonPath + ".grid.show",
 &aWindow->grid.show, true ) );
 
 m_params.emplace_back( new PARAM<int>( aJsonPath + ".grid.style",
 &aWindow->grid.style, 0 ) );
 
 m_params.emplace_back( new PARAM<int>( aJsonPath + ".grid.snap",
 &aWindow->grid.snap, 0 ) );
 
 m_params.emplace_back( new PARAM<bool>( aJsonPath + ".cursor.always_show_cursor",
 &aWindow->cursor.always_show_cursor, true ) );
 
 m_params.emplace_back( new PARAM<bool>( aJsonPath + ".cursor.fullscreen_cursor",
 &aWindow->cursor.fullscreen_cursor, false ) );
}

References CURSOR_SETTINGS::always_show_cursor, GRID_SETTINGS::axes_enabled, WINDOW_SETTINGS::cursor, APP_SETTINGS_BASE::DefaultGridSizeList(), WINDOW_STATE::display, GRID_SETTINGS::fast_grid_1, GRID_SETTINGS::fast_grid_2, CURSOR_SETTINGS::fullscreen_cursor, WINDOW_SETTINGS::grid, GRID_SETTINGS::last_size_idx, GRID_SETTINGS::line_width, JSON_SETTINGS::m_filename, JSON_SETTINGS::m_params, WINDOW_STATE::maximized, GRID_SETTINGS::min_spacing, WINDOW_SETTINGS::mru_path, WINDOW_SETTINGS::perspective, WINDOW_STATE::pos_x, WINDOW_STATE::pos_y, GRID_SETTINGS::show, WINDOW_STATE::size_x, WINDOW_STATE::size_y, GRID_SETTINGS::sizes, GRID_SETTINGS::snap, WINDOW_SETTINGS::state, GRID_SETTINGS::style, GRID_SETTINGS::user_grid_x, GRID_SETTINGS::user_grid_y, and WINDOW_SETTINGS::zoom_factors.

Referenced by APP_SETTINGS_BASE::APP_SETTINGS_BASE(), CVPCB_SETTINGS::CVPCB_SETTINGS(), and PCBNEW_SETTINGS::PCBNEW_SETTINGS().

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

{
 return m_internals->At( aPath );
}

References JSON_SETTINGS::m_internals.

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

◆ bomSettingsFromJson()

std::vector< EESCHEMA_SETTINGS::BOM_PLUGIN_SETTINGS > EESCHEMA_SETTINGS::bomSettingsFromJson ( const nlohmann::json & aObj )

staticprivate

Definition at line 854 of file eeschema_settings.cpp.

{
 std::vector<EESCHEMA_SETTINGS::BOM_PLUGIN_SETTINGS> ret;
 
 wxASSERT( aObj.is_array() );
 
 for( const nlohmann::json& entry : aObj )
 {
 if( entry.empty() || !entry.is_object() )
 continue;
 
 if( !entry.contains( "name" ) || !entry.contains( "path" ) )
 continue;
 
 BOM_PLUGIN_SETTINGS plugin( entry.at( "name" ).get<wxString>(),
 entry.at( "path" ).get<wxString>() );
 
 if( entry.contains( "command" ) )
 plugin.command = entry.at( "command" ).get<wxString>();
 
 ret.emplace_back( plugin );
 }
 
 return ret;
}

References EESCHEMA_SETTINGS::BOM_PLUGIN_SETTINGS::command.

Referenced by DefaultBomPlugins(), and EESCHEMA_SETTINGS().

◆ bomSettingsToJson()

nlohmann::json EESCHEMA_SETTINGS::bomSettingsToJson ( ) const

private

Definition at line 835 of file eeschema_settings.cpp.

{
 nlohmann::json js = nlohmann::json::array();
 
 for( const BOM_PLUGIN_SETTINGS& plugin : m_BomPanel.plugins )
 {
 nlohmann::json pluginJson;
 
 pluginJson["name"] = plugin.name.ToUTF8();
 pluginJson["path"] = plugin.path.ToUTF8();
 pluginJson["command"] = plugin.command.ToUTF8();
 
 js.push_back( pluginJson );
 }
 
 return js;
}

References EESCHEMA_SETTINGS::BOM_PLUGIN_SETTINGS::command, m_BomPanel, EESCHEMA_SETTINGS::BOM_PLUGIN_SETTINGS::name, EESCHEMA_SETTINGS::BOM_PLUGIN_SETTINGS::path, and EESCHEMA_SETTINGS::PANEL_BOM::plugins.

Referenced by EESCHEMA_SETTINGS(), and migrateBomSettings().

◆ Contains()

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

inherited

Definition at line 117 of file json_settings.cpp.

{
 return m_internals->contains( JSON_SETTINGS_INTERNALS::PointerFromString( aPath ) );
}

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

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

◆ DefaultBomPlugins()

std::vector< EESCHEMA_SETTINGS::BOM_PLUGIN_SETTINGS > EESCHEMA_SETTINGS::DefaultBomPlugins ( )

static

Definition at line 804 of file eeschema_settings.cpp.

{
 return bomSettingsFromJson( defaultBomPlugins );
}

References bomSettingsFromJson(), and defaultBomPlugins.

Referenced by DIALOG_BOM::DIALOG_BOM().

◆ DefaultGridSizeList()

const std::vector< wxString > APP_SETTINGS_BASE::DefaultGridSizeList ( ) const

inherited

Definition at line 379 of file app_settings.cpp.

{
 if( m_filename == wxS( "eeschema" ) || m_filename == wxS( "symbol_editor" ) )
 {
 return { wxS( "100 mil" ),
 wxS( "50 mil" ),
 wxS( "25 mil" ),
 wxS( "10 mil" ),
 wxS( "5 mil" ),
 wxS( "2 mil" ),
 wxS( "1 mil" ) };
 }
 else
 {
 return { wxS( "1000 mil" ),
 wxS( "500 mil" ),
 wxS( "250 mil" ),
 wxS( "200 mil" ),
 wxS( "100 mil" ),
 wxS( "50 mil" ),
 wxS( "25 mil" ),
 wxS( "20 mil" ),
 wxS( "10 mil" ),
 wxS( "5 mil" ),
 wxS( "2 mil" ),
 wxS( "1 mil" ),
 wxS( "5.0 mm" ),
 wxS( "2.5 mm" ),
 wxS( "1.0 mm" ),
 wxS( "0.5 mm" ),
 wxS( "0.25 mm" ),
 wxS( "0.2 mm" ),
 wxS( "0.1 mm" ),
 wxS( "0.05 mm" ),
 wxS( "0.025 mm" ),
 wxS( "0.01 mm" ) };
 }
}

References JSON_SETTINGS::m_filename.

Referenced by APP_SETTINGS_BASE::addParamsForWindow(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), PCB_BASE_FRAME::LoadSettings(), FOOTPRINT_PREVIEW_PANEL::New(), and DIALOG_GRID_SETTINGS::TransferDataToWindow().

◆ 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

ResultType is the type of the retrieved value.

Parameters

aJson	is the object to act on .
aKey	is 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.

{
 ResultType ret = aDefault;
 
 try
 {
 if( aJson.contains( aKey ) )
 ret = aJson.at( aKey ).get<ResultType>();
 }
 catch( ... )
 {
 }
 
 return ret;
}

◆ FormatAsString()

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

inherited

Definition at line 478 of file json_settings.cpp.

{
 LOCALE_IO dummy;
 
 std::stringstream buffer;
 buffer << std::setw( 2 ) << *m_internals << std::endl;
 
 return buffer.str();
}

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

ValueType is the basic type of the value

Parameters

aConfig	is the legacy config to read from
aKey	is the key (within the current path) to read
aDest	is a string that will form a JSON pointer (key1.key2.key3) to write to

Definition at line 702 of file json_settings.cpp.

{
 ValueType val;
 
 if( aConfig->Read( aKey, &val ) )
 {
 try
 {
 ( *m_internals )[aDest] = val;
 }
 catch( ... )
 {
 wxASSERT_MSG( false, wxT( "Could not write value in fromLegacy!" ) );
 return false;
 }
 
 return true;
 }
 
 return false;
}

◆ 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

aConfig	is the legacy config to read from
aKey	is the key (within the current path) to read
aDest	is a string that will form a JSON pointer (key1.key2.key3) to write to

Definition at line 762 of file json_settings.cpp.

{
 wxString str;
 
 if( aConfig->Read( aKey, &str ) )
 {
 KIGFX::COLOR4D color;
 color.SetFromWxString( str );
 
 try
 {
 nlohmann::json js = nlohmann::json::array( { color.r, color.g, color.b, color.a } );
 ( *m_internals )[aDest] = js;
 }
 catch( ... )
 {
 wxASSERT_MSG( false, wxT( "Could not write value in fromLegacyColor!" ) );
 return false;
 }
 
 return true;
 }
 
 return false;
}

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

aConfig	is the legacy config to read from
aKey	is the key (within the current path) to read
aDest	is a string that will form a JSON pointer (key1.key2.key3) to write to

Definition at line 738 of file json_settings.cpp.

{
 wxString str;
 
 if( aConfig->Read( aKey, &str ) )
 {
 try
 {
 ( *m_internals )[aDest] = str.ToUTF8();
 }
 catch( ... )
 {
 wxASSERT_MSG( false, wxT( "Could not write value in fromLegacyString!" ) );
 return false;
 }
 
 return true;
 }
 
 return false;
}

Referenced by PROJECT_FILE::MigrateFromLegacy(), APP_SETTINGS_BASE::MigrateFromLegacy(), BITMAP2CMP_SETTINGS::MigrateFromLegacy(), 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.

{
 if( std::optional<nlohmann::json> opt_json = GetJson( aPath ) )
 return wxString( opt_json->get<std::string>().c_str(), wxConvUTF8 );
 
 return std::nullopt;
}

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

ValueType is the type to cast to

Parameters

aPath is the path within the document to retrieve

Returns: a value from within this document

Definition at line 541 of file json_settings.cpp.

{
 if( std::optional<nlohmann::json> ret = GetJson( aPath ) )
 {
 try
 {
 return ret->get<ValueType>();
 }
 catch( ... )
 {
 }
 }
 
 return std::nullopt;
}

References JSON_SETTINGS::GetJson().

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

◆ getFileExt()

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.

 {
 return wxT( "json" );
 }

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

◆ GetFilename()

wxString JSON_SETTINGS::GetFilename ( ) const

inlineinherited

Definition at line 73 of file json_settings.h.

73{ return m_filename; }

References JSON_SETTINGS::m_filename.

Referenced by JSON_SETTINGS::AddNestedSettings(), DIALOG_PLOT_SCHEMATIC::getPlotOptions(), SETTINGS_MANAGER::loadColorSettingsByName(), NESTED_SETTINGS::LoadFromFile(), MigrateFromLegacy(), GERBVIEW_SETTINGS::MigrateFromLegacy(), PCBNEW_SETTINGS::MigrateFromLegacy(), PANEL_COLOR_SETTINGS::OnLeftDownTheme(), PANEL_COLOR_SETTINGS::OnThemeChanged(), DIALOG_PLOT_SCHEMATIC::plotSchematic(), SETTINGS_MANAGER::SaveColorSettings(), PANEL_COLOR_SETTINGS::saveCurrentTheme(), DIALOG_PRINT_USING_PRINTER::SavePrintOptions(), DIALOG_PRINT_PCBNEW::saveSettings(), NESTED_SETTINGS::SaveToFile(), PANEL_EESCHEMA_COLOR_SETTINGS::TransferDataFromWindow(), PANEL_SYM_COLOR_SETTINGS::TransferDataFromWindow(), PANEL_GERBVIEW_COLOR_SETTINGS::TransferDataFromWindow(), PANEL_PL_EDITOR_COLOR_SETTINGS::TransferDataFromWindow(), PANEL_FP_EDITOR_COLOR_SETTINGS::TransferDataFromWindow(), and PANEL_PCBNEW_COLOR_SETTINGS::TransferDataFromWindow().

◆ GetFullFilename()

wxString JSON_SETTINGS::GetFullFilename ( ) const

inherited

Definition at line 105 of file json_settings.cpp.

{
 return wxString( m_filename + "." + getFileExt() );
}

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

aPath is 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.

{
 nlohmann::json::json_pointer ptr = m_internals->PointerFromString( aPath );
 
 if( m_internals->contains( ptr ) )
 {
 try
 {
 return std::optional<nlohmann::json>{ m_internals->at( ptr ) };
 }
 catch( ... )
 {
 }
 }
 
 return std::optional<nlohmann::json>{};
}

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.

 {
 return wxEmptyString;
 }

Referenced by JSON_SETTINGS::LoadFromFile().

◆ getLegacyFrameName()

virtual std::string EESCHEMA_SETTINGS::getLegacyFrameName ( ) const

inlineoverrideprotectedvirtual

Reimplemented from APP_SETTINGS_BASE.

Definition at line 270 of file eeschema_settings.h.

270{ return "SchematicFrame"; }

◆ GetLocation()

SETTINGS_LOC JSON_SETTINGS::GetLocation ( ) const

inlineinherited

Definition at line 80 of file json_settings.h.

80{ return m_location; }

JSON_SETTINGS::m_location

SETTINGS_LOC m_location

The location of this settings file (.

Definition: json_settings.h:303

References JSON_SETTINGS::m_location.

Referenced by SETTINGS_MANAGER::GetPathForSettingsFile().

◆ Internals()

JSON_SETTINGS_INTERNALS * JSON_SETTINGS::Internals ( )

inherited

Definition at line 123 of file json_settings.cpp.

{
 return m_internals.get();
}

References JSON_SETTINGS::m_internals.

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

◆ IsReadOnly()

bool JSON_SETTINGS::IsReadOnly ( ) const

inlineinherited

Definition at line 84 of file json_settings.h.

84{ return !m_writeFile; }

JSON_SETTINGS::m_writeFile

bool m_writeFile

Whether or not the backing store file should be written.

Definition: json_settings.h:321

References JSON_SETTINGS::m_writeFile.

Referenced by APPEARANCE_CONTROLS::rebuildLayers(), PANEL_COLOR_SETTINGS::ResetPanel(), SETTINGS_MANAGER::SaveColorSettings(), PANEL_COLOR_SETTINGS::saveCurrentTheme(), PANEL_COLOR_SETTINGS::ShowColorContextMenu(), APPEARANCE_CONTROLS::syncColorsAndVisibility(), and PANEL_COLOR_SETTINGS::updateSwatches().

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

{
 for( auto param : m_params )
 {
 try
 {
 param->Load( this, m_resetParamsIfMissing );
 }
 catch( ... )
 {
 // Skip unreadable parameters in file
 wxLogTrace( traceSettings, wxT( "param '%s' load err" ), param->GetJsonPath().c_str() );
 }
 }
}

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

◆ LoadFromFile()

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

virtualinherited

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

Parameters

aDirectory is 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.

{
 // First, load all params to default values
 m_internals->clear();
 Load();
 
 bool success = true;
 bool migrated = false;
 bool legacy_migrated = false;
 
 LOCALE_IO locale;
 
 auto migrateFromLegacy = [&] ( wxFileName& aPath ) {
 // Backup and restore during migration so that the original can be mutated if convenient
 bool backed_up = false;
 wxFileName temp;
 
 if( aPath.IsDirWritable() )
 {
 temp.AssignTempFileName( aPath.GetFullPath() );
 
 if( !wxCopyFile( aPath.GetFullPath(), temp.GetFullPath() ) )
 {
 wxLogTrace( traceSettings, wxT( "%s: could not create temp file for migration" ),
 GetFullFilename() );
 }
 else
 backed_up = true;
 }
 
 // Silence popups if legacy file is read-only
 wxLogNull doNotLog;
 
 wxConfigBase::DontCreateOnDemand();
 auto cfg = std::make_unique<wxFileConfig>( wxT( "" ), wxT( "" ), aPath.GetFullPath() );
 
 // If migrate fails or is not implemented, fall back to built-in defaults that were
 // already loaded above
 if( !MigrateFromLegacy( cfg.get() ) )
 {
 success = false;
 wxLogTrace( traceSettings,
 wxT( "%s: migrated; not all settings were found in legacy file" ),
 GetFullFilename() );
 }
 else
 {
 success = true;
 wxLogTrace( traceSettings, wxT( "%s: migrated from legacy format" ), GetFullFilename() );
 }
 
 if( backed_up )
 {
 cfg.reset();
 
 if( !wxCopyFile( temp.GetFullPath(), aPath.GetFullPath() ) )
 {
 wxLogTrace( traceSettings,
 wxT( "migrate; copy temp file %s to %s failed" ),
 temp.GetFullPath(), aPath.GetFullPath() );
 }
 
 if( !wxRemoveFile( temp.GetFullPath() ) )
 {
 wxLogTrace( traceSettings,
 wxT( "migrate; failed to remove temp file %s" ),
 temp.GetFullPath() );
 }
 }
 
 // Either way, we want to clean up the old file afterwards
 legacy_migrated = true;
 };
 
 wxFileName path;
 
 if( aDirectory.empty() )
 {
 path.Assign( m_filename );
 path.SetExt( getFileExt() );
 }
 else
 {
 wxString dir( aDirectory );
 path.Assign( dir, m_filename, getFileExt() );
 }
 
 if( !path.Exists() )
 {
 // Case 1: legacy migration, no .json extension yet
 path.SetExt( getLegacyFileExt() );
 
 if( path.Exists() )
 {
 migrateFromLegacy( path );
 }
 // Case 2: legacy filename is different from new one
 else if( !m_legacy_filename.empty() )
 {
 path.SetName( m_legacy_filename );
 
 if( path.Exists() )
 migrateFromLegacy( path );
 }
 else
 {
 success = false;
 }
 }
 else
 {
 if( !path.IsFileWritable() )
 m_writeFile = false;
 
 try
 {
 wxFFileInputStream fp( path.GetFullPath(), wxT( "rt" ) );
 wxStdInputStream fstream( fp );
 
 if( fp.IsOk() )
 {
 *static_cast<nlohmann::json*>( m_internals.get() ) =
 nlohmann::json::parse( fstream, nullptr,
 /* allow_exceptions = */ true,
 /* ignore_comments = */ true );
 
 // Save whatever we loaded, before doing any migration etc
 m_internals->m_original = *static_cast<nlohmann::json*>( m_internals.get() );
 
 // If parse succeeds, check if schema migration is required
 int filever = -1;
 
 try
 {
 filever = m_internals->Get<int>( "meta.version" );
 }
 catch( ... )
 {
 wxLogTrace( traceSettings, wxT( "%s: file version could not be read!" ),
 GetFullFilename() );
 success = false;
 }
 
 if( filever >= 0 && filever < m_schemaVersion )
 {
 wxLogTrace( traceSettings, wxT( "%s: attempting migration from version %d to %d" ),
 GetFullFilename(), filever, m_schemaVersion );
 
 if( Migrate() )
 {
 migrated = true;
 }
 else
 {
 wxLogTrace( traceSettings, wxT( "%s: migration failed!" ), GetFullFilename() );
 }
 }
 else if( filever > m_schemaVersion )
 {
 wxLogTrace( traceSettings,
 wxT( "%s: warning: file version %d is newer than latest (%d)" ),
 GetFullFilename(), filever, m_schemaVersion );
 }
 }
 else
 {
 wxLogTrace( traceSettings, wxT( "%s exists but can't be opened for read" ),
 GetFullFilename() );
 }
 }
 catch( nlohmann::json::parse_error& error )
 {
 success = false;
 wxLogTrace( traceSettings, wxT( "Json parse error reading %s: %s" ),
 path.GetFullPath(), error.what() );
 wxLogTrace( traceSettings, wxT( "Attempting migration in case file is in legacy format" ) );
 migrateFromLegacy( path );
 }
 }
 
 // Now that we have new data in the JSON structure, load the params again
 Load();
 
 // And finally load any nested settings
 for( auto settings : m_nested_settings )
 settings->LoadFromFile();
 
 wxLogTrace( traceSettings, wxT( "Loaded <%s> with schema %d" ), GetFullFilename(), m_schemaVersion );
 
 // If we migrated, clean up the legacy file (with no extension)
 if( m_writeFile && ( legacy_migrated || migrated ) )
 {
 if( legacy_migrated && m_deleteLegacyAfterMigration && !wxRemoveFile( path.GetFullPath() ) )
 {
 wxLogTrace( traceSettings, wxT( "Warning: could not remove legacy file %s" ),
 path.GetFullPath() );
 }
 
 // And write-out immediately so that we don't lose data if the program later crashes.
 if( m_deleteLegacyAfterMigration )
 SaveToFile( aDirectory, true );
 }
 
 return success;
}

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.

{
 try
 {
 wxFFileInputStream fp( aPath, wxT( "rt" ) );
 wxStdInputStream fstream( fp );
 
 if( fp.IsOk() )
 {
 *static_cast<nlohmann::json*>( m_internals.get() ) =
 nlohmann::json::parse( fstream, nullptr,
 /* allow_exceptions = */ true,
 /* ignore_comments = */ true );
 }
 else
 {
 return false;
 }
 }
 catch( nlohmann::json::parse_error& error )
 {
 wxLogTrace( traceSettings, wxT( "Json parse error reading %s: %s" ), aPath, error.what() );
 
 return false;
 }
 
 // Now that we have new data in the JSON structure, load the params again
 Load();
 return true;
}

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.

{
 int filever = m_internals->Get<int>( "meta.version" );
 
 while( filever < m_schemaVersion )
 {
 if( !m_migrators.count( filever ) )
 {
 wxLogTrace( traceSettings, wxT( "Migrator missing for %s version %d!" ),
 typeid( *this ).name(), filever );
 return false;
 }
 
 std::pair<int, std::function<bool()>> pair = m_migrators.at( filever );
 
 if( pair.second() )
 {
 wxLogTrace( traceSettings, wxT( "Migrated %s from %d to %d" ), typeid( *this ).name(),
 filever, pair.first );
 filever = pair.first;
 m_internals->At( "meta.version" ) = filever;
 }
 else
 {
 wxLogTrace( traceSettings, wxT( "Migration failed for %s from %d to %d" ),
 typeid( *this ).name(), filever, pair.first );
 return false;
 }
 }
 
 return true;
}

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

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

◆ migrateBomSettings()

bool EESCHEMA_SETTINGS::migrateBomSettings ( )

private

Definition at line 810 of file eeschema_settings.cpp.

{
 if( !Contains( "bom.plugins" ) )
 return false;
 
 wxString list = *Get<wxString>( "bom.plugins" );
 
 BOM_CFG_PARSER cfg_parser( &m_BomPanel.plugins, TO_UTF8( list ), wxT( "plugins" ) );
 
 try
 {
 cfg_parser.Parse();
 }
 catch( const IO_ERROR& )
 {
 return false;
 }
 
 // Parser will have loaded up our array, let's dump it out to JSON
 At( "bom.plugins" ) = bomSettingsToJson();
 
 return true;
}

References JSON_SETTINGS::At(), bomSettingsToJson(), JSON_SETTINGS::Contains(), m_BomPanel, BOM_CFG_PARSER::Parse(), EESCHEMA_SETTINGS::PANEL_BOM::plugins, and TO_UTF8.

Referenced by EESCHEMA_SETTINGS(), and MigrateFromLegacy().

◆ migrateFindReplace()

void APP_SETTINGS_BASE::migrateFindReplace ( wxConfigBase * aCfg )

protectedinherited

! Migrates the find/replace history string lists

Definition at line 231 of file app_settings.cpp.

{
 const int find_replace_history_size = 10;
 nlohmann::json find_history = nlohmann::json::array();
 nlohmann::json replace_history = nlohmann::json::array();
 wxString tmp, find_key, replace_key;
 
 for( int i = 0; i < find_replace_history_size; ++i )
 {
 find_key.Printf( "FindStringHistoryList%d", i );
 replace_key.Printf( "ReplaceStringHistoryList%d", i );
 
 if( aCfg->Read( find_key, &tmp ) )
 find_history.push_back( tmp.ToStdString() );
 
 if( aCfg->Read( replace_key, &tmp ) )
 replace_history.push_back( tmp.ToStdString() );
 }
 
 Set( "find_replace.find_history", find_history );
 Set( "find_replace.replace_history", replace_history );
}

References JSON_SETTINGS::Set().

Referenced by APP_SETTINGS_BASE::MigrateFromLegacy().

◆ MigrateFromLegacy()

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

aLegacyConfig is a wxConfigBase holding a loaded configuration to migrate

Returns: true if migration was successful

Reimplemented from APP_SETTINGS_BASE.

Definition at line 522 of file eeschema_settings.cpp.

{
 bool ret = APP_SETTINGS_BASE::MigrateFromLegacy( aCfg );
 
 // Now modify the loaded grid selection, because in earlier versions the grids index was shared
 // between all applications and started at 1000 mils. There is a 4-position offset between
 // this index and the possible eeschema grids list that we have to subtract.
 std::string gridSizePtr = "window.grid.last_size";
 
 if( std::optional<int> currentSize = Get<int>( gridSizePtr ) )
 {
 Set( gridSizePtr, *currentSize - 4 );
 }
 else
 {
 // Otherwise, default grid size should be 50 mils; index 1
 Set( gridSizePtr, 1 );
 }
 
 ret &= fromLegacy<bool>( aCfg, "FootprintPreview", "appearance.footprint_preview" );
 ret &= fromLegacy<bool>( aCfg, "NavigatorStaysOpen", "appearance.navigator_stays_open" );
 ret &= fromLegacy<bool>( aCfg, "PrintSheetReferenceAndTitleBlock",
 "appearance.print_sheet_reference" );
 ret &= fromLegacy<bool>( aCfg, "ShowHiddenPins", "appearance.show_hidden_pins" );
 ret &= fromLegacy<bool>( aCfg, "ShowIllegalSymbolLibDialog",
 "appearance.show_illegal_symbol_lib_dialog" );
 ret &= fromLegacy<bool>( aCfg, "ShowPageLimits", "appearance.show_page_limits" );
 ret &= fromLegacy<bool>( aCfg, "ShowSheetFileNameCaseSensitivityDlg",
 "appearance.show_sheet_filename_case_sensitivity_dialog" );
 
 ret &= fromLegacy<bool>( aCfg, "AutoplaceFields", "autoplace_fields.enable" );
 ret &= fromLegacy<bool>( aCfg, "AutoplaceJustify", "autoplace_fields.allow_rejustify" );
 ret &= fromLegacy<bool>( aCfg, "AutoplaceAlign", "autoplace_fields.align_to_grid" );
 
 ret &= fromLegacy<int>( aCfg, "DefaultBusWidth", "drawing.default_bus_thickness" );
 ret &= fromLegacy<int>( aCfg, "DefaultJunctionSize", "drawing.default_junction_size" );
 ret &= fromLegacy<int>( aCfg, "DefaultDrawLineWidth", "drawing.default_line_thickness" );
 ret &= fromLegacy<int>( aCfg, "RepeatStepX", "drawing.default_repeat_offset_x" );
 ret &= fromLegacy<int>( aCfg, "RepeatStepY", "drawing.default_repeat_offset_y" );
 ret &= fromLegacy<int>( aCfg, "DefaultWireWidth", "drawing.default_wire_thickness" );
 ret &= fromLegacyString( aCfg, "FieldNames", "drawing.field_names" );
 ret &= fromLegacy<bool>( aCfg, "HorizVertLinesOnly", "drawing.line_mode" );
 ret &= fromLegacy<int>( aCfg, "RepeatLabelIncrement", "drawing.repeat_label_increment" );
 
 ret &= fromLegacy<bool>( aCfg, "DragActionIsMove", "input.drag_is_move" );
 
 ret &= fromLegacy<int>( aCfg, "SelectionThickness", "selection.thickness" );
 ret &= fromLegacy<bool>( aCfg, "SelectionDrawChildItems", "selection.draw_selected_children" );
 ret &= fromLegacy<bool>( aCfg, "SelectionFillShapes", "selection.fill_shapes" );
 ret &= fromLegacy<bool>( aCfg, "SelectPinSelectSymbolOpt",
 "selection.select_pin_selects_symbol" );
 
 ret &= fromLegacy<int>( aCfg, "AnnotateAlgoOption", "annotation.method" );
 ret &= fromLegacy<int>( aCfg, "AnnotateFilterMsg", "annotation.messages_filter" );
 ret &= fromLegacy<int>( aCfg, "AnnotateSortOption", "annotation.sort_order" );
 
 ret &= fromLegacyString( aCfg, "bom_plugin_selected", "bom.selected_plugin" );
 ret &= fromLegacyString( aCfg, "bom_plugins", "bom.plugins" );
 
 migrateBomSettings();
 
 ret &= fromLegacyString( aCfg, "SymbolFieldsShownColumns",
 "edit_sch_component.visible_columns" );
 
 ret &= fromLegacy<bool>( aCfg, "PageSettingsExportRevision", "page_settings.export_revision" );
 ret &= fromLegacy<bool>( aCfg, "PageSettingsExportDate", "page_settings.export_date" );
 ret &= fromLegacy<bool>( aCfg, "PageSettingsExportTitle", "page_settings.export_title" );
 ret &= fromLegacy<bool>( aCfg, "PageSettingsExportCompany", "page_settings.export_company" );
 ret &= fromLegacy<bool>( aCfg, "PageSettingsExportComment1", "page_settings.export_comment1" );
 ret &= fromLegacy<bool>( aCfg, "PageSettingsExportComment2", "page_settings.export_comment2" );
 ret &= fromLegacy<bool>( aCfg, "PageSettingsExportComment3", "page_settings.export_comment3" );
 ret &= fromLegacy<bool>( aCfg, "PageSettingsExportComment4", "page_settings.export_comment4" );
 ret &= fromLegacy<bool>( aCfg, "PageSettingsExportComment5", "page_settings.export_comment5" );
 ret &= fromLegacy<bool>( aCfg, "PageSettingsExportComment6", "page_settings.export_comment6" );
 ret &= fromLegacy<bool>( aCfg, "PageSettingsExportComment7", "page_settings.export_comment7" );
 ret &= fromLegacy<bool>( aCfg, "PageSettingsExportComment8", "page_settings.export_comment8" );
 ret &= fromLegacy<bool>( aCfg, "PageSettingsExportComment9", "page_settings.export_comment9" );
 
 #if 0 // To do: move this code to the new netlist plugin management in settings
 {
 constexpr int max_custom_commands = 8; // from DIALOG_NETLIST
 nlohmann::json js_cmd = nlohmann::json::array();
 nlohmann::json js_title = nlohmann::json::array();
 wxString cmd_key, title_key, cmd, title;
 
 for( int i = 1; i <= max_custom_commands; ++i )
 {
 // Only migrate if both title and command are specified
 cmd_key.Printf( "CustomNetlistCommand%d", i );
 title_key.Printf( "CustomNetlistTitle%d", i );
 
 if( aCfg->Read( cmd_key, &cmd ) && aCfg->Read( title_key, &title )
 && !cmd.IsEmpty() && !title.IsEmpty() )
 {
 js_cmd.push_back( cmd.ToUTF8() );
 js_title.push_back( title.ToUTF8() );
 }
 }
 
 Set( "netlist.custom_command_titles", js_title );
 Set( "netlist.custom_command_paths", js_cmd );
 }
 #endif
 
 {
 // NOTE(JE) These parameters should move to project-local storage before V6, but we are
 // migrating them here in order to preserve data. There is a bug here that is preserved:
 // keys are taken directly from the (translated) UI and stored in the config, so if the user
 // changes languages the keys will no longer work.
 aCfg->SetPath( "SymbolFieldEditor/Show/" );
 
 nlohmann::json js = nlohmann::json( {} );
 wxString key;
 bool value = false;
 long index = 0;
 
 while( aCfg->GetNextEntry( key, index ) )
 {
 if( aCfg->Read( key, &value ) )
 {
 std::string key_utf( key.ToUTF8() );
 
 try
 {
 js[key_utf] = value;
 }
 catch(...)
 {
 continue;
 }
 }
 }
 
 Set( "field_editor.fields_show", js );
 
 aCfg->SetPath( "../GroupBy" );
 
 while( aCfg->GetNextEntry( key, index ) )
 {
 if( aCfg->Read( key, &value ) )
 {
 std::string key_utf( key.ToUTF8() );
 
 try
 {
 js[key_utf] = value;
 }
 catch(...)
 {
 continue;
 }
 }
 }
 
 Set( "field_editor.fields_group_by", js );
 
 aCfg->SetPath( "../.." );
 }
 
 ret &= fromLegacy<bool>( aCfg, "PlotModeColor", "plot.color" );
 ret &= fromLegacy<int>( aCfg, "PlotFormat", "plot.format" );
 ret &= fromLegacy<bool>( aCfg, "PlotFrameRef", "plot.frame_reference" );
 ret &= fromLegacy<bool>( aCfg, "PlotHPGLOrg", "plot.hpgl_origin" );
 ret &= fromLegacy<int>( aCfg, "PlotHPGLPaperSize", "plot.hpgl_paper_size" );
 ret &= fromLegacy<double>( aCfg, "PlotHPGLPenSize", "plot.hpgl_pen_size" );
 
 ret &= fromLegacy<int>( aCfg, "SIM_PLOT_FRAMEPos_x", "simulator.window.pos_x" );
 ret &= fromLegacy<int>( aCfg, "SIM_PLOT_FRAMEPos_y", "simulator.window.pos_y" );
 ret &= fromLegacy<int>( aCfg, "SIM_PLOT_FRAMESize_x", "simulator.window.size_x" );
 ret &= fromLegacy<int>( aCfg, "SIM_PLOT_FRAMESize_y", "simulator.window.size_y" );
 ret &= fromLegacy<bool>( aCfg, "SIM_PLOT_FRAMEMaximized", "simulator.window.maximized" );
 ret &= fromLegacyString( aCfg, "SIM_PLOT_FRAMEPerspective", "simulator.window.perspective" );
 ret &= fromLegacyString( aCfg, "SIM_PLOT_FRAMEMostRecentlyUsedPath", "simulator.mru_path" );
 ret &= fromLegacy<int>( aCfg, "SimPlotPanelWidth", "simulator.plot_panel_width" );
 ret &= fromLegacy<int>( aCfg, "SimPlotPanelHeight", "simulator.plot_panel_height" );
 ret &= fromLegacy<int>( aCfg, "SimSignalPanelHeight", "simulator.signal_panel_height" );
 ret &= fromLegacy<int>( aCfg, "SimCursorsPanelHeight", "simulator.cursors_panel_height" );
 ret &= fromLegacy<bool>( aCfg, "SimPlotWhiteBg", "simulator.white_background" );
 
 ret &= fromLegacy<int>( aCfg, "SymbolChooserHSashPosition", "symbol_chooser.sash_pos_h" );
 ret &= fromLegacy<int>( aCfg, "SymbolChooserVSashPosition", "symbol_chooser.sash_pos_v" );
 ret &= fromLegacy<int>( aCfg, "SymbolChooserWidth", "symbol_chooser.width" );
 ret &= fromLegacy<int>( aCfg, "SymbolChooserHeight", "symbol_chooser.height" );
 ret &= fromLegacy<bool>( aCfg, "SymbolChooserKeepSymbol", "symbol_chooser.keep_symbol" );
 ret &= fromLegacy<bool>( aCfg, "SymbolChooserUseUnits", "symbol_chooser.place_all_units" );
 
 const std::string vlf = "ViewlibFrame";
 ret &= fromLegacy<bool>( aCfg, vlf + "Maximized", "lib_view.window.maximized" );
 ret &= fromLegacyString( aCfg, vlf + "MostRecentlyUsedPath", "lib_view.window.mru_path" );
 ret &= fromLegacy<int>( aCfg, vlf + "Size_x", "lib_view.window.size_x" );
 ret &= fromLegacy<int>( aCfg, vlf + "Size_y", "lib_view.window.size_y" );
 ret &= fromLegacyString( aCfg, vlf + "Perspective", "lib_view.window.perspective" );
 ret &= fromLegacy<int>( aCfg, vlf + "Pos_x", "lib_view.window.pos_x" );
 ret &= fromLegacy<int>( aCfg, vlf + "Pos_y", "lib_view.window.pos_y" );
 ret &= fromLegacy<int>( aCfg, "ViewLiblistWidth", "lib_view.lib_list_width" );
 ret &= fromLegacy<int>( aCfg, "ViewCmplistWidth", "lib_view.cmp_list_width" );
 ret &= fromLegacy<bool>( aCfg,
 "ViewCmpShowPinElectricalType", "lib_view.show_pin_electrical_type" );
 ret &= fromLegacy<bool>( aCfg, vlf + "ShowGrid", "lib_view.grid.show" );
 ret &= fromLegacy<int>( aCfg, vlf + "_LastGridSize", "lib_view.grid.last_size" );
 
 ret &= fromLegacy<bool>( aCfg, "RescueNeverShow", "system.never_show_rescue_dialog" );
 
 // Legacy version stored this setting in eeschema, so move it to common if it exists
 bool tmp;
 
 if( aCfg->Read( "MoveWarpsCursor", &tmp ) )
 Pgm().GetCommonSettings()->m_Input.warp_mouse_on_move = tmp;
 
 COLOR_SETTINGS* cs = Pgm().GetSettingsManager().GetMigratedColorSettings();
 
 auto migrateLegacyColor = [&] ( const std::string& aKey, int aLayerId ) {
 wxString str;
 
 if( aCfg->Read( aKey, &str ) )
 cs->SetColor( aLayerId, COLOR4D( str ) );
 };
 
 migrateLegacyColor( "Color4DBgCanvasEx", LAYER_SCHEMATIC_BACKGROUND );
 migrateLegacyColor( "Color4DBodyBgEx", LAYER_DEVICE_BACKGROUND );
 migrateLegacyColor( "Color4DBodyEx", LAYER_DEVICE );
 migrateLegacyColor( "Color4DBrightenedEx", LAYER_BRIGHTENED );
 migrateLegacyColor( "Color4DBusEx", LAYER_BUS );
 migrateLegacyColor( "Color4DConnEx", LAYER_JUNCTION );
 migrateLegacyColor( "Color4DCursorEx", LAYER_SCHEMATIC_CURSOR );
 migrateLegacyColor( "Color4DErcEEx", LAYER_ERC_ERR );
 migrateLegacyColor( "Color4DErcWEx", LAYER_ERC_WARN );
 migrateLegacyColor( "Color4DFieldEx", LAYER_FIELDS );
 migrateLegacyColor( "Color4DGLabelEx", LAYER_GLOBLABEL );
 migrateLegacyColor( "Color4DGridEx", LAYER_SCHEMATIC_GRID );
 migrateLegacyColor( "Color4DHLabelEx", LAYER_HIERLABEL );
 migrateLegacyColor( "Color4DHiddenEx", LAYER_HIDDEN );
 migrateLegacyColor( "Color4DLLabelEx", LAYER_LOCLABEL );
 migrateLegacyColor( "Color4DNoConnectEx", LAYER_NOCONNECT );
 migrateLegacyColor( "Color4DNoteEx", LAYER_NOTES );
 migrateLegacyColor( "Color4DPinEx", LAYER_PIN );
 migrateLegacyColor( "Color4DPinNameEx", LAYER_PINNAM );
 migrateLegacyColor( "Color4DPinNumEx", LAYER_PINNUM );
 migrateLegacyColor( "Color4DReferenceEx", LAYER_REFERENCEPART );
 migrateLegacyColor( "Color4DShadowEx", LAYER_SELECTION_SHADOWS );
 migrateLegacyColor( "Color4DSheetEx", LAYER_SHEET );
 migrateLegacyColor( "Color4DSheetFileNameEx", LAYER_SHEETFILENAME );
 migrateLegacyColor( "Color4DSheetLabelEx", LAYER_SHEETLABEL );
 migrateLegacyColor( "Color4DSheetNameEx", LAYER_SHEETNAME );
 migrateLegacyColor( "Color4DValueEx", LAYER_VALUEPART );
 migrateLegacyColor( "Color4DWireEx", LAYER_WIRE );
 migrateLegacyColor( "Color4DWorksheetEx", LAYER_SCHEMATIC_DRAWINGSHEET );
 
 Pgm().GetSettingsManager().SaveColorSettings( cs, "schematic" );
 
 Set( "appearance.color_theme", cs->GetFilename() );
 
 // LibEdit settings were stored with eeschema. If eeschema is the first app to run,
 // we need to migrate the LibEdit settings here
 
 auto libedit = Pgm().GetSettingsManager().GetAppSettings<SYMBOL_EDITOR_SETTINGS>( false );
 libedit->MigrateFromLegacy( aCfg );
 libedit->Load();
 
 return ret;
}

References JSON_SETTINGS::fromLegacyString(), JSON_SETTINGS::GetFilename(), LAYER_BRIGHTENED, LAYER_BUS, LAYER_DEVICE, LAYER_DEVICE_BACKGROUND, LAYER_ERC_ERR, LAYER_ERC_WARN, LAYER_FIELDS, LAYER_GLOBLABEL, LAYER_HIDDEN, LAYER_HIERLABEL, LAYER_JUNCTION, LAYER_LOCLABEL, LAYER_NOCONNECT, LAYER_NOTES, LAYER_PIN, LAYER_PINNAM, LAYER_PINNUM, LAYER_REFERENCEPART, LAYER_SCHEMATIC_BACKGROUND, LAYER_SCHEMATIC_CURSOR, LAYER_SCHEMATIC_DRAWINGSHEET, LAYER_SCHEMATIC_GRID, LAYER_SELECTION_SHADOWS, LAYER_SHEET, LAYER_SHEETFILENAME, LAYER_SHEETLABEL, LAYER_SHEETNAME, LAYER_VALUEPART, LAYER_WIRE, libedit, migrateBomSettings(), APP_SETTINGS_BASE::MigrateFromLegacy(), Pgm(), JSON_SETTINGS::Set(), and COLOR_SETTINGS::SetColor().

◆ migrateLibTreeWidth()

bool APP_SETTINGS_BASE::migrateLibTreeWidth ( )

protectedinherited

Migrates the library tree width setting from a single column (Item) to multi-column.

Definition at line 419 of file app_settings.cpp.

{
 // We used to store only the width of the first column, because there were only
 // two possible columns.
 if( std::optional<int> optWidth = Get<int>( "lib_tree.column_width" ) )
 {
 Set<nlohmann::json>( "lib_tree.column_widths", { { "Item", *optWidth } } );
 At( "lib_tree" ).erase( "column_width" );
 }
 
 return true;
}

References JSON_SETTINGS::At().

Referenced by EESCHEMA_SETTINGS(), FOOTPRINT_EDITOR_SETTINGS::FOOTPRINT_EDITOR_SETTINGS(), PCBNEW_SETTINGS::PCBNEW_SETTINGS(), and SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS().

◆ migrateWindowConfig()

bool APP_SETTINGS_BASE::migrateWindowConfig	(	wxConfigBase *	aCfg,
		const std::string &	aFrameName,
		const std::string &	aJsonPath
	)

protectedinherited

Migrates legacy window settings into the JSON document.

Parameters

aCfg	is the wxConfig object to read from
aFrameName	is the prefix for window settings in the legacy config file
aJsonPath	is the prefix for storing window settings in the JSON file

Returns: true if all settings were migrated

Definition at line 255 of file app_settings.cpp.

{
 bool ret = true;
 
 const std::string frameGDO = aFrame + "GalDisplayOptions";
 const std::string cursorPath = aJsonPath + ".cursor";
 const std::string gridPath = aJsonPath + ".grid";
 
 ret &= fromLegacy<bool>( aCfg, aFrame + "Maximized", aJsonPath + ".maximized" );
 ret &= fromLegacyString( aCfg, aFrame + "MostRecentlyUsedPath", aJsonPath + ".mru_path" );
 ret &= fromLegacy<int>( aCfg, aFrame + "Size_x", aJsonPath + ".size_x" );
 ret &= fromLegacy<int>( aCfg, aFrame + "Size_y", aJsonPath + ".size_y" );
 ret &= fromLegacyString( aCfg, aFrame + "Perspective", aJsonPath + ".perspective" );
 ret &= fromLegacy<int>( aCfg, aFrame + "Pos_x", aJsonPath + ".pos_x" );
 ret &= fromLegacy<int>( aCfg, aFrame + "Pos_y", aJsonPath + ".pos_y" );
 
 ret &= fromLegacy<bool>( aCfg, frameGDO + "ForceDisplayCursor", cursorPath + ".always_show_cursor" );
 ret &= fromLegacy<bool>( aCfg, frameGDO + "CursorFullscreen", cursorPath + ".fullscreen_cursor" );
 
 ret &= fromLegacy<int>( aCfg, aFrame + "_LastGridSize", gridPath + ".last_size" );
 
 ret &= fromLegacy<int>( aCfg, aFrame + "FastGrid1", gridPath + ".fast_grid_1" );
 ret &= fromLegacy<int>( aCfg, aFrame + "FastGrid2", gridPath + ".fast_grid_2" );
 
 ret &= fromLegacy<bool>( aCfg, frameGDO + "GridAxesEnabled", gridPath + ".axes_enabled" );
 ret &= fromLegacy<double>( aCfg, frameGDO + "GridLineWidth", gridPath + ".line_width" );
 ret &= fromLegacy<double>( aCfg, frameGDO + "GridMaxDensity", gridPath + ".min_spacing" );
 ret &= fromLegacy<bool>( aCfg, frameGDO + "ShowGrid", gridPath + ".show" );
 ret &= fromLegacy<int>( aCfg, frameGDO + "GridStyle", gridPath + ".style" );
 ret &= fromLegacyColor( aCfg, frameGDO + "GridColor", gridPath + ".color" );
 
 return ret;
}

References JSON_SETTINGS::fromLegacyColor(), and JSON_SETTINGS::fromLegacyString().

Referenced by APP_SETTINGS_BASE::MigrateFromLegacy(), CVPCB_SETTINGS::MigrateFromLegacy(), and PCBNEW_SETTINGS::MigrateFromLegacy().

◆ netlistSettingsFromJson()

std::vector< EESCHEMA_SETTINGS::NETLIST_PLUGIN_SETTINGS > EESCHEMA_SETTINGS::netlistSettingsFromJson ( const nlohmann::json & aObj )

staticprivate

Definition at line 901 of file eeschema_settings.cpp.

{
 std::vector<EESCHEMA_SETTINGS::NETLIST_PLUGIN_SETTINGS> ret;
 
 wxASSERT( aObj.is_array() );
 
 for( const nlohmann::json& entry : aObj )
 {
 if( entry.empty() || !entry.is_object() )
 continue;
 
 if( !entry.contains( "name" ) || !entry.contains( "path" ) )
 continue;
 
 NETLIST_PLUGIN_SETTINGS plugin( entry.at( "name" ).get<wxString>(),
 entry.at( "path" ).get<wxString>() );
 
 if( entry.contains( "command" ) )
 plugin.command = entry.at( "command" ).get<wxString>();
 
 ret.emplace_back( plugin );
 }
 
 return ret;
}

References EESCHEMA_SETTINGS::NETLIST_PLUGIN_SETTINGS::command.

Referenced by EESCHEMA_SETTINGS().

◆ netlistSettingsToJson()

nlohmann::json EESCHEMA_SETTINGS::netlistSettingsToJson ( ) const

private

Definition at line 882 of file eeschema_settings.cpp.

{
 nlohmann::json js = nlohmann::json::array();
 
 for( const NETLIST_PLUGIN_SETTINGS& plugin : m_NetlistPanel.plugins )
 {
 nlohmann::json pluginJson;
 
 pluginJson["name"] = plugin.name.ToUTF8();
 pluginJson["path"] = plugin.path.ToUTF8();
 pluginJson["command"] = plugin.command.ToUTF8();
 
 js.push_back( pluginJson );
 }
 
 return js;
}

References EESCHEMA_SETTINGS::NETLIST_PLUGIN_SETTINGS::command, m_NetlistPanel, EESCHEMA_SETTINGS::NETLIST_PLUGIN_SETTINGS::name, EESCHEMA_SETTINGS::NETLIST_PLUGIN_SETTINGS::path, and EESCHEMA_SETTINGS::PANEL_NETLIST::plugins.

Referenced by EESCHEMA_SETTINGS().

◆ 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

aOldSchemaVersion	is the starting schema version for this migration
aNewSchemaVersion	is the ending schema version for this migration
aMigrator	is a function that performs the migration and returns true if successful

Definition at line 590 of file json_settings.cpp.

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

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

Referenced by BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), COLOR_SETTINGS::COLOR_SETTINGS(), EDA_3D_VIEWER_SETTINGS::EDA_3D_VIEWER_SETTINGS(), EESCHEMA_SETTINGS(), 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

aSettings is a pointer to a NESTED_SETTINGS that has already been added to this one

Definition at line 797 of file json_settings.cpp.

{
 if( !aSettings || !m_manager )
 return;
 
 auto it = std::find_if( m_nested_settings.begin(), m_nested_settings.end(),
 [&aSettings]( const JSON_SETTINGS* aPtr ) {
 return aPtr == aSettings;
 } );
 
 if( it != m_nested_settings.end() )
 {
 wxLogTrace( traceSettings, wxT( "Flush and release %s" ), ( *it )->GetFilename() );
 ( *it )->SaveToFile();
 m_nested_settings.erase( it );
 }
 
 aSettings->SetParent( nullptr );
}

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.

{
 for( auto param : m_params )
 param->SetDefault();
}

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.

{
 if( !m_writeFile )
 return false;
 
 // Default PROJECT won't have a filename set
 if( m_filename.IsEmpty() )
 return false;
 
 wxFileName path;
 
 if( aDirectory.empty() )
 {
 path.Assign( m_filename );
 path.SetExt( getFileExt() );
 }
 else
 {
 wxString dir( aDirectory );
 path.Assign( dir, m_filename, getFileExt() );
 }
 
 if( !m_createIfMissing && !path.FileExists() )
 {
 wxLogTrace( traceSettings,
 wxT( "File for %s doesn't exist and m_createIfMissing == false; not saving" ),
 GetFullFilename() );
 return false;
 }
 
 // Ensure the path exists, and create it if not.
 if( !path.DirExists() && !path.Mkdir() )
 {
 wxLogTrace( traceSettings, wxT( "Warning: could not create path %s, can't save %s" ),
 path.GetPath(), GetFullFilename() );
 return false;
 }
 
 if( ( path.FileExists() && !path.IsFileWritable() ) ||
 ( !path.FileExists() && !path.IsDirWritable() ) )
 {
 wxLogTrace( traceSettings, wxT( "File for %s is read-only; not saving" ), GetFullFilename() );
 return false;
 }
 
 bool modified = false;
 
 for( auto settings : m_nested_settings )
 modified |= settings->SaveToFile();
 
 modified |= Store();
 
 if( !modified && !aForce && path.FileExists() )
 {
 wxLogTrace( traceSettings, wxT( "%s contents not modified, skipping save" ), GetFullFilename() );
 return false;
 }
 else if( !modified && !aForce && !m_createIfDefault )
 {
 wxLogTrace( traceSettings,
 wxT( "%s contents still default and m_createIfDefault == false; not saving" ),
 GetFullFilename() );
 return false;
 }
 
 wxLogTrace( traceSettings, wxT( "Saving %s" ), GetFullFilename() );
 
 LOCALE_IO dummy;
 bool success = true;
 
 nlohmann::json toSave = m_internals->m_original;
 
 toSave.update( m_internals->begin(), m_internals->end(), /* merge_objects = */ true );
 
 try
 {
 std::stringstream buffer;
 buffer << std::setw( 2 ) << toSave << std::endl;
 
 wxFFileOutputStream fileStream( path.GetFullPath(), "wb" );
 
 if( !fileStream.IsOk()
 || !fileStream.WriteAll( buffer.str().c_str(), buffer.str().size() ) )
 {
 wxLogTrace( traceSettings, wxT( "Warning: could not save %s" ), GetFullFilename() );
 success = false;
 }
 }
 catch( nlohmann::json::exception& error )
 {
 wxLogTrace( traceSettings, wxT( "Catch error: could not save %s. Json error %s" ),
 GetFullFilename(), error.what() );
 success = false;
 }
 catch( ... )
 {
 wxLogTrace( traceSettings, wxT( "Error: could not save %s." ) );
 success = false;
 }
 
 return success;
}

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

ValueType is the type to store

Parameters

aPath	is a path to store in the form "key1.key2.key3"
aVal	is the value to store

Definition at line 571 of file json_settings.cpp.

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

References JSON_SETTINGS::m_internals.

Referenced by COLOR_SETTINGS::COLOR_SETTINGS(), EDA_3D_VIEWER_SETTINGS::EDA_3D_VIEWER_SETTINGS(), EESCHEMA_SETTINGS(), BOARD_DESIGN_SETTINGS::LoadFromFile(), APP_SETTINGS_BASE::migrateFindReplace(), PROJECT_FILE::MigrateFromLegacy(), APP_SETTINGS_BASE::MigrateFromLegacy(), EDA_3D_VIEWER_SETTINGS::MigrateFromLegacy(), MigrateFromLegacy(), SYMBOL_EDITOR_SETTINGS::MigrateFromLegacy(), GERBVIEW_SETTINGS::MigrateFromLegacy(), FOOTPRINT_EDITOR_SETTINGS::MigrateFromLegacy(), COMMON_SETTINGS::MigrateFromLegacy(), KICAD_SETTINGS::MigrateFromLegacy(), PCBNEW_SETTINGS::MigrateFromLegacy(), BOARD_DESIGN_SETTINGS::migrateSchema0to1(), FOOTPRINT_EDITOR_SETTINGS::migrateSchema0to1(), COLOR_SETTINGS::migrateSchema0to1(), PCBNEW_SETTINGS::PCBNEW_SETTINGS(), PROJECT_FILE::SaveAs(), 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.

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

◆ Set() [3/3]

template<>

void JSON_SETTINGS::Set	(	const std::string &	aPath,
		wxString	aVal
	)

inherited

◆ SetFilename()

void JSON_SETTINGS::SetFilename ( const wxString & aFilename )

inlineinherited

Definition at line 77 of file json_settings.h.

77{ m_filename = aFilename; }

References JSON_SETTINGS::m_filename.

Referenced by SETTINGS_MANAGER::GetColorSettings(), PROJECT_FILE::SaveAs(), PROJECT_LOCAL_SETTINGS::SaveAs(), SETTINGS_MANAGER::SaveProjectAs(), and SETTINGS_MANAGER::SaveProjectCopy().

◆ 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

aObj	is the source object
aTarget	is the storage destination

Returns: True if set, false if not

Definition at line 656 of file json_settings.cpp.

{
 nlohmann::json::json_pointer ptr = JSON_SETTINGS_INTERNALS::PointerFromString( aPath );
 
 if( aObj.contains( ptr ) && aObj.at( ptr ).is_boolean() )
 {
 aTarget = aObj.at( ptr ).get<bool>();
 return true;
 }
 
 return false;
}

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

aObj	is the source object
aTarget	is the storage destination

Returns: True if set, false if not

Definition at line 671 of file json_settings.cpp.

{
 nlohmann::json::json_pointer ptr = JSON_SETTINGS_INTERNALS::PointerFromString( aPath );
 
 if( aObj.contains( ptr ) && aObj.at( ptr ).is_number_integer() )
 {
 aTarget = aObj.at( ptr ).get<int>();
 return true;
 }
 
 return false;
}

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

aObj	is the source object
aTarget	is the storage destination

Returns: True if set, false if not

Definition at line 686 of file json_settings.cpp.

{
 nlohmann::json::json_pointer ptr = JSON_SETTINGS_INTERNALS::PointerFromString( aPath );
 
 if( aObj.contains( ptr ) && aObj.at( ptr ).is_number_unsigned() )
 {
 aTarget = aObj.at( ptr ).get<unsigned int>();
 return true;
 }
 
 return false;
}

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

aObj	is the source object
aTarget	is the storage destination

Returns: True if set, false if not

Definition at line 641 of file json_settings.cpp.

{
 nlohmann::json::json_pointer ptr = JSON_SETTINGS_INTERNALS::PointerFromString( aPath );
 
 if( aObj.contains( ptr ) && aObj.at( ptr ).is_string() )
 {
 aTarget = aObj.at( ptr ).get<wxString>();
 return true;
 }
 
 return false;
}

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

◆ SetManager()

void JSON_SETTINGS::SetManager ( SETTINGS_MANAGER * aManager )

inlineinherited

Definition at line 191 of file json_settings.h.

 {
 m_manager = aManager;
 }

References JSON_SETTINGS::m_manager.

◆ SetReadOnly()

void JSON_SETTINGS::SetReadOnly ( bool aReadOnly )

inlineinherited

Definition at line 85 of file json_settings.h.

85{ m_writeFile = !aReadOnly; }

References JSON_SETTINGS::m_writeFile.

Referenced by SETTINGS_MANAGER::GetColorSettings(), SETTINGS_MANAGER::loadAllColorSettings(), PANEL_COLOR_SETTINGS::OnThemeChanged(), PANEL_FP_PROPERTIES_3D_MODEL::PANEL_FP_PROPERTIES_3D_MODEL(), PROJECT_FILE::SaveAs(), and SETTINGS_MANAGER::SaveProjectAs().

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

{
 bool modified = false;
 
 for( auto param : m_params )
 {
 modified |= !param->MatchesFile( this );
 param->Store( this );
 }
 
 return modified;
}

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_AnnotatePanel

PANEL_ANNOTATE EESCHEMA_SETTINGS::m_AnnotatePanel

Definition at line 297 of file eeschema_settings.h.

Referenced by EESCHEMA_SETTINGS(), DIALOG_ANNOTATE::InitValues(), PANEL_EESCHEMA_ANNOTATION_OPTIONS::loadEEschemaSettings(), SCH_EDITOR_CONTROL::Paste(), SCH_DRAWING_TOOLS::PlaceSymbol(), SCH_EDIT_TOOL::RepeatDrawItem(), SCH_EDIT_FRAME::setupUIConditions(), SCH_EDITOR_CONTROL::ToggleAnnotateAuto(), SCH_EDITOR_CONTROL::ToggleAnnotateRecursive(), PANEL_EESCHEMA_ANNOTATION_OPTIONS::TransferDataFromWindow(), and DIALOG_ANNOTATE::~DIALOG_ANNOTATE().

◆ m_Appearance

APPEARANCE EESCHEMA_SETTINGS::m_Appearance

Definition at line 283 of file eeschema_settings.h.

Referenced by SCH_EDIT_FRAME::AllowCaseSensitiveFileNameClashes(), SCH_EDIT_FRAME::CommonSettingsChanged(), DIALOG_ERC::DIALOG_ERC(), DIALOG_SHEET_PROPERTIES::DIALOG_SHEET_PROPERTIES(), DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_PROPERTIES(), EESCHEMA_SETTINGS(), LIB_PIN::GetBoundingBox(), LIB_ITEM::GetDefaultFont(), SCH_ITEM::GetDefaultFont(), DIALOG_PLOT_SCHEMATIC::getPlotOptions(), SCH_EDIT_FRAME::GetShowAllPins(), KIGFX::SCH_RENDER_SETTINGS::GetShowPageLimits(), PANEL_EESCHEMA_DISPLAY_OPTIONS::loadEEschemaSettings(), PANEL_EESCHEMA_EDITING_OPTIONS::loadEEschemaSettings(), DIALOG_SHEET_PROPERTIES::OnInitDlg(), DIALOG_SYMBOL_PROPERTIES::OnInitDlg(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_DRAWING_TOOLS::PlaceSymbol(), SCH_PRINTOUT::PrintPage(), SCH_EDIT_FRAME::SCH_EDIT_FRAME(), SCH_EDIT_FRAME::setupUIConditions(), SCH_EDITOR_CONTROL::ToggleERCErrors(), SCH_EDITOR_CONTROL::ToggleERCExclusions(), SCH_EDITOR_CONTROL::ToggleERCWarnings(), SCH_EDITOR_CONTROL::ToggleHiddenFields(), SCH_EDITOR_CONTROL::ToggleHiddenPins(), SCH_EDITOR_CONTROL::ToggleOPCurrents(), SCH_EDITOR_CONTROL::ToggleOPVoltages(), PANEL_EESCHEMA_DISPLAY_OPTIONS::TransferDataFromWindow(), PANEL_EESCHEMA_EDITING_OPTIONS::TransferDataFromWindow(), DIALOG_ERC::~DIALOG_ERC(), DIALOG_LABEL_PROPERTIES::~DIALOG_LABEL_PROPERTIES(), DIALOG_SHEET_PROPERTIES::~DIALOG_SHEET_PROPERTIES(), and DIALOG_SYMBOL_PROPERTIES::~DIALOG_SYMBOL_PROPERTIES().

◆ m_appSettingsSchemaVersion

int APP_SETTINGS_BASE::m_appSettingsSchemaVersion

inherited

! Local schema version for common app settings

Definition at line 193 of file app_settings.h.

◆ m_AuiPanels

AUI_PANELS EESCHEMA_SETTINGS::m_AuiPanels

Definition at line 287 of file eeschema_settings.h.

Referenced by EESCHEMA_SETTINGS(), SCH_EDIT_FRAME::OnResizeHierarchyNavigator(), SCH_EDIT_FRAME::SaveSettings(), SCH_EDIT_FRAME::SCH_EDIT_FRAME(), and SCH_EDIT_FRAME::ToggleSchematicHierarchy().

◆ m_AutoplaceFields

AUTOPLACE_FIELDS EESCHEMA_SETTINGS::m_AutoplaceFields

Definition at line 285 of file eeschema_settings.h.

Referenced by SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), SCH_EDIT_TOOL::editFieldText(), EESCHEMA_SETTINGS(), PANEL_EESCHEMA_EDITING_OPTIONS::loadEEschemaSettings(), SCH_DRAWING_TOOLS::PlaceSymbol(), DIALOG_CHANGE_SYMBOLS::processSymbols(), SCH_EDIT_TOOL::Properties(), SCH_EDIT_TOOL::Rotate(), and PANEL_EESCHEMA_EDITING_OPTIONS::TransferDataFromWindow().

◆ m_BomPanel

PANEL_BOM EESCHEMA_SETTINGS::m_BomPanel

Definition at line 299 of file eeschema_settings.h.

Referenced by bomSettingsToJson(), DIALOG_BOM::DIALOG_BOM(), EESCHEMA_SETTINGS(), DIALOG_BOM::installGeneratorsList(), migrateBomSettings(), and DIALOG_BOM::~DIALOG_BOM().

◆ m_ColorPicker

COLOR_PICKER APP_SETTINGS_BASE::m_ColorPicker

inherited

Definition at line 179 of file app_settings.h.

Referenced by APP_SETTINGS_BASE::APP_SETTINGS_BASE(), DIALOG_COLOR_PICKER::DIALOG_COLOR_PICKER(), and DIALOG_COLOR_PICKER::~DIALOG_COLOR_PICKER().

◆ m_ColorTheme

wxString APP_SETTINGS_BASE::m_ColorTheme

inherited

Active color theme name.

Definition at line 190 of file app_settings.h.

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

CROSS_PROBING_SETTINGS APP_SETTINGS_BASE::m_CrossProbing

inherited

Definition at line 173 of file app_settings.h.

Referenced by APP_SETTINGS_BASE::APP_SETTINGS_BASE(), PCB_SELECTION_TOOL::doSyncSelection(), SCH_EDIT_FRAME::ExecuteRemoteCommand(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), SCH_EDITOR_CONTROL::FindSymbolAndItem(), PANEL_EESCHEMA_DISPLAY_OPTIONS::loadEEschemaSettings(), PANEL_DISPLAY_OPTIONS::loadPCBSettings(), EE_SELECTION_TOOL::SyncSelection(), PANEL_EESCHEMA_DISPLAY_OPTIONS::TransferDataFromWindow(), and PANEL_DISPLAY_OPTIONS::TransferDataFromWindow().

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

DRAWING EESCHEMA_SETTINGS::m_Drawing

Definition at line 289 of file eeschema_settings.h.

Referenced by EE_SELECTION_TOOL::autostartEvent(), SCH_EDITOR_CONTROL::ChangeLineMode(), SCH_EDIT_FRAME::CommonSettingsChanged(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SCH_DRAWING_TOOLS::DrawSheet(), EESCHEMA_SETTINGS(), SCH_EDIT_FRAME::GetSchematicJunctionSize(), SCH_EDITOR_CONDITIONS::lineModeFunc(), PANEL_EESCHEMA_EDITING_OPTIONS::loadEEschemaSettings(), SCH_MOVE_TOOL::Main(), SCH_EDITOR_CONTROL::NextLineMode(), DIALOG_SHAPE_PROPERTIES::onBorderChecked(), DIALOG_TEXT_PROPERTIES::onBorderChecked(), PANEL_TEMPLATE_FIELDNAMES::PANEL_TEMPLATE_FIELDNAMES(), SCH_EDIT_TOOL::RepeatDrawItem(), SCHEMATIC_SETTINGS::SCHEMATIC_SETTINGS(), SCH_LINE_WIRE_BUS_TOOL::startSegments(), PANEL_EESCHEMA_EDITING_OPTIONS::TransferDataFromWindow(), and PANEL_TEMPLATE_FIELDNAMES::TransferDataFromWindow().

◆ m_FieldEditorPanel

PANEL_FIELD_EDITOR EESCHEMA_SETTINGS::m_FieldEditorPanel

Definition at line 301 of file eeschema_settings.h.

Referenced by DIALOG_SYMBOL_FIELDS_TABLE::AddField(), DIALOG_SYMBOL_FIELDS_TABLE::DIALOG_SYMBOL_FIELDS_TABLE(), EESCHEMA_SETTINGS(), DIALOG_SYMBOL_FIELDS_TABLE::LoadFieldNames(), DIALOG_SYMBOL_FIELDS_TABLE::OnAddField(), DIALOG_SYMBOL_FIELDS_TABLE::OnColumnItemToggled(), and DIALOG_SYMBOL_FIELDS_TABLE::OnTableColSize().

◆ m_filename

wxString JSON_SETTINGS::m_filename

protectedinherited

The filename (not including path) of this settings file (inicode)

Definition at line 297 of file json_settings.h.

Referenced by APP_SETTINGS_BASE::addParamsForWindow(), APP_SETTINGS_BASE::DefaultGridSizeList(), JSON_SETTINGS::GetFilename(), JSON_SETTINGS::GetFullFilename(), JSON_SETTINGS::LoadFromFile(), NESTED_SETTINGS::LoadFromFile(), COLOR_SETTINGS::migrateSchema0to1(), COLOR_SETTINGS::operator=(), JSON_SETTINGS::SaveToFile(), NESTED_SETTINGS::SaveToFile(), and JSON_SETTINGS::SetFilename().

◆ m_FindReplace

FIND_REPLACE APP_SETTINGS_BASE::m_FindReplace

inherited

Definition at line 175 of file app_settings.h.

Referenced by APP_SETTINGS_BASE::APP_SETTINGS_BASE(), EDA_DRAW_FRAME::LoadSettings(), and EDA_DRAW_FRAME::SaveSettings().

◆ m_FindReplaceExtra

FIND_REPLACE_EXTRA EESCHEMA_SETTINGS::m_FindReplaceExtra

Definition at line 291 of file eeschema_settings.h.

Referenced by EESCHEMA_SETTINGS(), SCH_EDIT_FRAME::LoadSettings(), and SCH_EDIT_FRAME::SaveSettings().

◆ m_Graphics

GRAPHICS APP_SETTINGS_BASE::m_Graphics

inherited

Definition at line 177 of file app_settings.h.

Referenced by APP_SETTINGS_BASE::APP_SETTINGS_BASE(), EDA_DRAW_FRAME::loadCanvasTypeSetting(), PCB_BASE_FRAME::LoadSettings(), FOOTPRINT_PREVIEW_PANEL::New(), PANEL_EESCHEMA_COLOR_SETTINGS::PANEL_EESCHEMA_COLOR_SETTINGS(), EDA_DRAW_FRAME::saveCanvasTypeSetting(), GAL_OPTIONS_PANEL::TransferDataFromWindow(), and GAL_OPTIONS_PANEL::TransferDataToWindow().

◆ m_Input

INPUT EESCHEMA_SETTINGS::m_Input

Definition at line 293 of file eeschema_settings.h.

Referenced by EESCHEMA_SETTINGS(), PANEL_EESCHEMA_EDITING_OPTIONS::loadEEschemaSettings(), EE_SELECTION_TOOL::Main(), SCH_MOVE_TOOL::Main(), and PANEL_EESCHEMA_EDITING_OPTIONS::TransferDataFromWindow().

◆ m_internals

std::unique_ptr<JSON_SETTINGS_INTERNALS> JSON_SETTINGS::m_internals

protectedinherited

◆ m_lastSymbolLibDir

wxString EESCHEMA_SETTINGS::m_lastSymbolLibDir

Definition at line 317 of file eeschema_settings.h.

Referenced by PANEL_SYM_LIB_TABLE::browseLibrariesHandler(), EESCHEMA_SETTINGS(), and PANEL_SYM_LIB_TABLE::PANEL_SYM_LIB_TABLE().

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

LIB_TREE APP_SETTINGS_BASE::m_LibTree

inherited

Definition at line 181 of file app_settings.h.

Referenced by APP_SETTINGS_BASE::APP_SETTINGS_BASE(), LIB_TREE_MODEL_ADAPTER::LIB_TREE_MODEL_ADAPTER(), and LIB_TREE_MODEL_ADAPTER::SaveSettings().

◆ m_LibViewPanel

PANEL_LIB_VIEW EESCHEMA_SETTINGS::m_LibViewPanel

Definition at line 303 of file eeschema_settings.h.

Referenced by EESCHEMA_SETTINGS(), and SYMBOL_VIEWER_FRAME::SaveSettings().

◆ m_location

SETTINGS_LOC JSON_SETTINGS::m_location

protectedinherited

The location of this settings file (.

See also: SETTINGS_LOC)

Definition at line 303 of file json_settings.h.

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

◆ m_manager

SETTINGS_MANAGER* JSON_SETTINGS::m_manager

protectedinherited

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

Definition at line 333 of file json_settings.h.

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

◆ m_migrators

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

protectedinherited

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

Definition at line 336 of file json_settings.h.

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

◆ m_nested_settings

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

protectedinherited

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

Definition at line 309 of file json_settings.h.

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

◆ m_NetlistPanel

PANEL_NETLIST EESCHEMA_SETTINGS::m_NetlistPanel

Definition at line 305 of file eeschema_settings.h.

Referenced by EESCHEMA_SETTINGS(), DIALOG_EXPORT_NETLIST::InstallCustomPages(), netlistSettingsToJson(), and DIALOG_EXPORT_NETLIST::WriteCurrentNetlistSetup().

◆ m_PageSettings

PAGE_SETTINGS EESCHEMA_SETTINGS::m_PageSettings

Definition at line 295 of file eeschema_settings.h.

Referenced by EESCHEMA_SETTINGS().

◆ m_params

std::vector<PARAM_BASE*> JSON_SETTINGS::m_params

protectedinherited

The list of parameters (owned by this object)

Definition at line 306 of file json_settings.h.

Referenced by APP_SETTINGS_BASE::addParamsForWindow(), APP_SETTINGS_BASE::APP_SETTINGS_BASE(), BITMAP2CMP_SETTINGS::BITMAP2CMP_SETTINGS(), BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), COLOR_SETTINGS::COLOR_SETTINGS(), COMMON_SETTINGS::COMMON_SETTINGS(), COLOR_SETTINGS::CreateBuiltinColorSettings(), CVPCB_SETTINGS::CVPCB_SETTINGS(), DATABASE_LIB_SETTINGS::DATABASE_LIB_SETTINGS(), EDA_3D_VIEWER_SETTINGS::EDA_3D_VIEWER_SETTINGS(), EESCHEMA_SETTINGS(), ERC_SETTINGS::ERC_SETTINGS(), FOOTPRINT_EDITOR_SETTINGS::FOOTPRINT_EDITOR_SETTINGS(), GERBVIEW_SETTINGS::GERBVIEW_SETTINGS(), COLOR_SETTINGS::GetDefaultColor(), COLOR_SETTINGS::initFromOther(), JSON_SETTINGS::JSON_SETTINGS(), KICAD_SETTINGS::KICAD_SETTINGS(), JSON_SETTINGS::Load(), NET_SETTINGS::NET_SETTINGS(), NGSPICE_SIMULATOR_SETTINGS::NGSPICE_SIMULATOR_SETTINGS(), PCB_CALCULATOR_SETTINGS::PCB_CALCULATOR_SETTINGS(), PCBNEW_SETTINGS::PCBNEW_SETTINGS(), PL_EDITOR_SETTINGS::PL_EDITOR_SETTINGS(), PROJECT_FILE::PROJECT_FILE(), PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_SETTINGS(), JSON_SETTINGS::ResetToDefaults(), PNS::ROUTING_SETTINGS::ROUTING_SETTINGS(), SCHEMATIC_SETTINGS::SCHEMATIC_SETTINGS(), SPICE_SIMULATOR_SETTINGS::SPICE_SIMULATOR_SETTINGS(), JSON_SETTINGS::Store(), SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS(), and JSON_SETTINGS::~JSON_SETTINGS().

◆ m_PlotPanel

PANEL_PLOT EESCHEMA_SETTINGS::m_PlotPanel

Definition at line 307 of file eeschema_settings.h.

Referenced by EESCHEMA_SETTINGS(), and DIALOG_PLOT_SCHEMATIC::getPlotOptions().

◆ m_Printing

PRINTING APP_SETTINGS_BASE::m_Printing

inherited

Definition at line 183 of file app_settings.h.

Referenced by APP_SETTINGS_BASE::APP_SETTINGS_BASE(), PRINTOUT_SETTINGS::Load(), BOARD_PRINTOUT_SETTINGS::Load(), DIALOG_PRINT_PCBNEW::onColorModeClicked(), DIALOG_PRINT_USING_PRINTER::OnOutputChoice(), SCH_PRINTOUT::PrintPage(), PRINTOUT_SETTINGS::Save(), BOARD_PRINTOUT_SETTINGS::Save(), DIALOG_PRINT_USING_PRINTER::SavePrintOptions(), DIALOG_PRINT_PCBNEW::saveSettings(), DIALOG_PRINT_USING_PRINTER::TransferDataToWindow(), and DIALOG_PRINT_PCBNEW::TransferDataToWindow().

◆ m_RescueNeverShow

bool EESCHEMA_SETTINGS::m_RescueNeverShow

Definition at line 315 of file eeschema_settings.h.

Referenced by EESCHEMA_SETTINGS(), DIALOG_RESCUE_EACH::OnNeverShowClick(), and SCH_EDIT_FRAME::OpenProjectFiles().

◆ 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

Version of this settings schema.

Definition at line 330 of file json_settings.h.

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

◆ m_Selection

SELECTION EESCHEMA_SETTINGS::m_Selection

Definition at line 311 of file eeschema_settings.h.

Referenced by EE_SELECTION_TOOL::CollectHits(), EESCHEMA_SETTINGS(), KIGFX::SCH_PAINTER::getShadowWidth(), EE_SELECTION_TOOL::GuessSelectionCandidates(), PANEL_EESCHEMA_DISPLAY_OPTIONS::loadEEschemaSettings(), PANEL_EESCHEMA_EDITING_OPTIONS::loadEEschemaSettings(), EE_SELECTION_TOOL::Selectable(), PANEL_EESCHEMA_DISPLAY_OPTIONS::TransferDataFromWindow(), and PANEL_EESCHEMA_EDITING_OPTIONS::TransferDataFromWindow().

◆ m_Simulator

SIMULATOR EESCHEMA_SETTINGS::m_Simulator

Definition at line 313 of file eeschema_settings.h.

Referenced by EESCHEMA_SETTINGS(), SIMULATOR_FRAME::GetWindowSettings(), SIMULATOR_FRAME::LoadSettings(), and SIMULATOR_FRAME::SaveSettings().

◆ m_SymChooserPanel

PANEL_SYM_CHOOSER EESCHEMA_SETTINGS::m_SymChooserPanel

Definition at line 309 of file eeschema_settings.h.

Referenced by EESCHEMA_SETTINGS(), and SCH_DRAWING_TOOLS::PlaceSymbol().

◆ m_System

SYSTEM APP_SETTINGS_BASE::m_System

inherited

Definition at line 185 of file app_settings.h.

Referenced by APP_SETTINGS_BASE::APP_SETTINGS_BASE(), PNS_KICAD_IFACE::GetUnits(), FILE_HISTORY::Load(), EDA_DRAW_FRAME::LoadSettings(), FILE_HISTORY::Save(), SCH_EDIT_FRAME::SaveSettings(), EDA_DRAW_FRAME::SaveSettings(), and EDA_DRAW_FRAME::setupUnits().

◆ m_Window

WINDOW_SETTINGS APP_SETTINGS_BASE::m_Window

inherited

Definition at line 187 of file app_settings.h.

Referenced by APP_SETTINGS_BASE::APP_SETTINGS_BASE(), GRID_MENU::BuildChoiceList(), SCH_EDIT_FRAME::CommonSettingsChanged(), SYMBOL_EDIT_FRAME::CommonSettingsChanged(), GERBVIEW_FRAME::CommonSettingsChanged(), PL_EDITOR_FRAME::CommonSettingsChanged(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), COMMON_TOOLS::doZoomInOut(), COMMON_TOOLS::doZoomToPreset(), DIALOG_BOARD_REANNOTATE::GetParameters(), EDA_BASE_FRAME::GetWindowSettings(), COMMON_TOOLS::GridFast1(), COMMON_TOOLS::GridFast2(), COMMON_TOOLS::GridNext(), COMMON_TOOLS::GridPreset(), COMMON_TOOLS::GridPrev(), EDA_DRAW_FRAME::IsGridVisible(), SCH_BASE_FRAME::LoadSettings(), SCH_EDIT_FRAME::LoadSettings(), GERBVIEW_FRAME::LoadSettings(), PCB_BASE_FRAME::LoadSettings(), PL_EDITOR_FRAME::LoadSettings(), FOOTPRINT_PREVIEW_PANEL::New(), COMMON_TOOLS::OnGridChanged(), EDA_DRAW_FRAME::OnUpdateSelectGrid(), EDA_DRAW_FRAME::OnUpdateSelectZoom(), PANEL_EESCHEMA_COLOR_SETTINGS::PANEL_EESCHEMA_COLOR_SETTINGS(), COMMON_TOOLS::Reset(), EDA_BASE_FRAME::SaveSettings(), EDA_DRAW_FRAME::SetGridVisibility(), COMMON_TOOLS::ToggleCursor(), COMMON_TOOLS::ToggleCursorStyle(), DIALOG_GRID_SETTINGS::TransferDataFromWindow(), GAL_OPTIONS_PANEL::TransferDataFromWindow(), DIALOG_GRID_SETTINGS::TransferDataToWindow(), GAL_OPTIONS_PANEL::TransferDataToWindow(), GRID_MENU::update(), ZOOM_MENU::update(), and EDA_DRAW_FRAME::UpdateZoomSelectBox().

◆ 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 COLOR_SETTINGS::CreateBuiltinColorSettings(), COLOR_SETTINGS::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:

Classes

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Member Functions

Static Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ EESCHEMA_SETTINGS()

◆ ~EESCHEMA_SETTINGS()

Member Function Documentation

◆ AddNestedSettings()

◆ addParamsForWindow()

◆ At()

◆ bomSettingsFromJson()

◆ bomSettingsToJson()

◆ Contains()

◆ DefaultBomPlugins()

◆ DefaultGridSizeList()

◆ fetchOrDefault()

◆ FormatAsString()

◆ fromLegacy()

◆ fromLegacyColor()

◆ fromLegacyString()

◆ Get() [1/2]

◆ Get() [2/2]

◆ getFileExt()

◆ GetFilename()

◆ GetFullFilename()

◆ GetJson()

◆ getLegacyFileExt()

◆ getLegacyFrameName()

◆ GetLocation()

◆ Internals()

◆ IsReadOnly()

◆ Load()

◆ LoadFromFile()

◆ LoadFromRawFile()

◆ Migrate()

◆ migrateBomSettings()

◆ migrateFindReplace()

◆ MigrateFromLegacy()

◆ migrateLibTreeWidth()

◆ migrateWindowConfig()

◆ netlistSettingsFromJson()

◆ netlistSettingsToJson()

◆ registerMigration()

◆ ReleaseNestedSettings()

◆ ResetToDefaults()

◆ SaveToFile()

◆ Set() [1/3]

◆ Set() [2/3]

◆ Set() [3/3]

◆ SetFilename()

◆ SetIfPresent() [1/4]

◆ SetIfPresent() [2/4]

◆ SetIfPresent() [3/4]

◆ SetIfPresent() [4/4]

◆ SetLegacyFilename()

◆ SetLocation()

◆ SetManager()

◆ SetReadOnly()

◆ Store()

Member Data Documentation

◆ m_AnnotatePanel

◆ m_Appearance

◆ m_appSettingsSchemaVersion

◆ m_AuiPanels

◆ m_AutoplaceFields

◆ m_BomPanel

◆ m_ColorPicker

◆ m_ColorTheme

◆ m_createIfDefault

◆ m_createIfMissing

◆ m_CrossProbing

◆ m_deleteLegacyAfterMigration

◆ m_Drawing