#include <footprint_editor_settings.h>

Inheritance diagram for FOOTPRINT_EDITOR_SETTINGS:

Classes
struct	USER_GRID

Public Member Functions
	FOOTPRINT_EDITOR_SETTINGS ()

virtual	~FOOTPRINT_EDITOR_SETTINGS ()

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

virtual const std::vector< wxString >	DefaultGridSizeList () const
	By default, this returns the list of grids available in PcbNew-based applications. More...

wxString	GetFilename () const

wxString	GetFullFilename () const

void	SetFilename (const wxString &aFilename)

SETTINGS_LOC	GetLocation () const

void	SetLegacyFilename (const wxString &aFilename)

bool	IsReadOnly () const

void	SetReadOnly (bool aReadOnly)

nlohmann::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

size_t	Count (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...

OPT< nlohmann::json >	GetJson (const std::string &aPath) const
	Fetches a JSON object that is a subset of this JSON_SETTINGS object, using a path of the form "key1.key2.key3" to refer to nested objects. More...

template<typename ValueType >
OPT< ValueType >	Get (const std::string &aPath) const
	Fetches a value from within the JSON document. More...

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

template<typename ValueType >
void	Set (const std::string &aPath, ValueType aVal)
	Stores a value into the JSON document Will throw an exception if ValueType isn't something that the library can handle. More...

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

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

bool	Migrate ()
	Migrates the schema of this settings from the version in the file to the latest version. More...

void	AddNestedSettings (NESTED_SETTINGS *aSettings)
	Transfers ownership of a given NESTED_SETTINGS to this object. More...

void	ReleaseNestedSettings (NESTED_SETTINGS *aSettings)
	Saves and frees a nested settings object, if it exists within this one. More...

void	SetManager (SETTINGS_MANAGER *aManager)

Static Public Member Functions
static bool	SetIfPresent (const nlohmann::json &aObj, const std::string &aPath, wxString &aTarget)
	Sets the given string if the given key/path is present. More...

static bool	SetIfPresent (const nlohmann::json &aObj, const std::string &aPath, bool &aTarget)
	Sets the given bool if the given key/path is present. More...

static bool	SetIfPresent (const nlohmann::json &aObj, const std::string &aPath, int &aTarget)
	Sets the given int if the given key/path is present. More...

static bool	SetIfPresent (const nlohmann::json &aObj, const std::string &aPath, unsigned int &aTarget)
	Sets the given unsigned int if the given key/path is present. More...

Public Attributes
BOARD_DESIGN_SETTINGS	m_DesignSettings
	Only some of these settings are actually used for footprint editing. More...

MAGNETIC_SETTINGS	m_MagneticItems

PCB_DISPLAY_OPTIONS	m_Display

USER_GRID	m_UserGrid

bool	m_PolarCoords

bool	m_Use45Limit

int	m_LibWidth

wxString	m_LastImportExportPath

wxString	m_FootprintTextShownColumns

SELECTION_FILTER_OPTIONS	m_SelectionFilter

std::vector< LAYER_PRESET >	m_LayerPresets

wxString	m_ActiveLayerPreset

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

void	registerMigration (int aOldSchemaVersion, int aNewSchemaVersion, std::function< bool(void)> aMigrator)
	Registers a migration from one schema version to another. More...

template<typename ValueType >
bool	fromLegacy (wxConfigBase *aConfig, const std::string &aKey, const std::string &aDest)
	Translates a legacy wxConfig value to a given JSON pointer value. More...

bool	fromLegacyString (wxConfigBase *aConfig, const std::string &aKey, const std::string &aDest)
	Translates a legacy wxConfig string value to a given JSON pointer value. More...

bool	fromLegacyColor (wxConfigBase *aConfig, const std::string &aKey, const std::string &aDest)
	Translates a legacy COLOR4D stored in a wxConfig string to a given JSON pointer value. More...

virtual wxString	getFileExt () const

virtual wxString	getLegacyFileExt () const

Protected Attributes
wxString	m_filename
	The filename (not including path) of this settings file (inicode) More...

wxString	m_legacy_filename
	The filename of the wxConfig legacy file (if different from m_filename) More...

SETTINGS_LOC	m_location
	The location of this settings file (. More...

std::vector< PARAM_BASE * >	m_params
	The list of parameters (owned by this object) More...

std::vector< NESTED_SETTINGS * >	m_nested_settings
	Nested settings files that live inside this one, if any. More...

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

bool	m_createIfDefault
	Whether or not the backing store file should be created if all parameters are still at their default values. More...

bool	m_writeFile
	Whether or not the backing store file should be written. More...

bool	m_deleteLegacyAfterMigration
	Whether or not to delete legacy file after migration. More...

bool	m_resetParamsIfMissing
	Whether or not to set parameters to their default value if missing from JSON on Load() More...

int	m_schemaVersion
	Version of this settings schema. More...

SETTINGS_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	migrateSchema0to1 ()

Detailed Description

Definition at line 30 of file footprint_editor_settings.h.

Constructor & Destructor Documentation

◆ FOOTPRINT_EDITOR_SETTINGS()

FOOTPRINT_EDITOR_SETTINGS::FOOTPRINT_EDITOR_SETTINGS ( )

Definition at line 40 of file footprint_editor_settings.cpp.

  :
  APP_SETTINGS_BASE( "fpedit", fpEditSchemaVersion ),
  m_DesignSettings( nullptr, "fpedit.settings" ),
  m_MagneticItems(),
  m_Display(),
  m_UserGrid(),
  m_PolarCoords( false ),
  m_Use45Limit( true ),
  m_LibWidth( 250 ),
  m_LastImportExportPath(),
  m_FootprintTextShownColumns()
 {
  m_MagneticItems.pads = MAGNETIC_OPTIONS::CAPTURE_ALWAYS;
  m_MagneticItems.tracks = MAGNETIC_OPTIONS::NO_EFFECT;
  m_MagneticItems.graphics = true;
 
  m_params.emplace_back( new PARAM<int>( "window.lib_width",
  &m_LibWidth, 250 ) );
 
  m_params.emplace_back( new PARAM<wxString>( "system.last_import_export_path",
  &m_LastImportExportPath, "" ) );
 
  m_params.emplace_back( new PARAM<wxString>( "window.footprint_text_shown_columns",
  &m_FootprintTextShownColumns, "0 1 2 3 4 5 6" ) );
 
  m_params.emplace_back( new PARAM<int>( "editing.magnetic_pads",
  reinterpret_cast<int*>( &m_MagneticItems.pads ),
  static_cast<int>( MAGNETIC_OPTIONS::CAPTURE_ALWAYS ) ) );
 
  m_params.emplace_back( new PARAM<bool>( "editing.magnetic_graphics",
  &m_MagneticItems.graphics, true ) );
 
  m_params.emplace_back( new PARAM<bool>( "editing.polar_coords", &m_PolarCoords, false ) );
 
  m_params.emplace_back( new PARAM<bool>( "editing.use_45_degree_limit",
  &m_Use45Limit, false ) );
 
  m_params.emplace_back( new PARAM<bool>( "pcb_display.text_fill",
  &m_Display.m_DisplayTextFill, true ) );
 
  m_params.emplace_back( new PARAM<bool>( "pcb_display.graphic_items_fill",
  &m_Display.m_DisplayGraphicsFill, true ) );
 
  m_params.emplace_back( new PARAM<bool>( "pcb_display.pad_fill",
  &m_Display.m_DisplayPadFill, true ) );
 
  m_params.emplace_back( new PARAM_LAYER_PRESET( "pcb_display.layer_presets", &m_LayerPresets ) );
 
  m_params.emplace_back( new PARAM<wxString>( "pcb_display.active_layer_preset",
  &m_ActiveLayerPreset, "" ) );
 
  m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>(
  "design_settings.default_footprint_text_items",
  [&] () -> nlohmann::json
  {
  nlohmann::json js = nlohmann::json::array();
 
  for( const TEXT_ITEM_INFO& item : m_DesignSettings.m_DefaultFPTextItems )
  {
  js.push_back( nlohmann::json( { item.m_Text.ToUTF8(),
  item.m_Visible,
  item.m_Layer } ) );
  }
 
  return js;
  },
  [&] ( const nlohmann::json& aObj )
  {
  m_DesignSettings.m_DefaultFPTextItems.clear();
 
  if( !aObj.is_array() )
  return;
 
  for( const nlohmann::json& entry : aObj )
  {
  if( entry.empty() || !entry.is_array() )
  continue;
 
  TEXT_ITEM_INFO textInfo( wxT( "" ), true, F_SilkS );
 
  textInfo.m_Text = entry.at(0).get<wxString>();
  textInfo.m_Visible = entry.at(1).get<bool>();
  textInfo.m_Layer = entry.at(2).get<int>();
 
  m_DesignSettings.m_DefaultFPTextItems.push_back( std::move( textInfo ) );
  }
  },
  nlohmann::json::array( {
  { "REF**", true, F_SilkS },
  { "", true, F_Fab },
  { "${REFERENCE}", true, F_Fab }
  } ) ) );
 
  m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.silk_line_width",
  &m_DesignSettings.m_LineThickness[ LAYER_CLASS_SILK ],
  Millimeter2iu( DEFAULT_SILK_LINE_WIDTH ), Millimeter2iu( 0.01 ), Millimeter2iu( 100.0 ),
  MM_PER_IU ) );
 
  m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.silk_text_size_h",
  &m_DesignSettings.m_TextSize[ LAYER_CLASS_SILK ].x,
  Millimeter2iu( DEFAULT_SILK_TEXT_SIZE ), TEXTS_MIN_SIZE, TEXTS_MAX_SIZE, MM_PER_IU ) );
 
  m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.silk_text_size_v",
  &m_DesignSettings.m_TextSize[ LAYER_CLASS_SILK ].y,
  Millimeter2iu( DEFAULT_SILK_TEXT_SIZE ), TEXTS_MIN_SIZE, TEXTS_MAX_SIZE, MM_PER_IU ) );
 
  m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.silk_text_thickness",
  &m_DesignSettings.m_TextThickness[ LAYER_CLASS_SILK ],
  Millimeter2iu( DEFAULT_SILK_TEXT_WIDTH ), 1, TEXTS_MAX_WIDTH, MM_PER_IU ) );
 
  m_params.emplace_back( new PARAM<bool>( "design_settings.silk_text_italic",
  &m_DesignSettings.m_TextItalic[ LAYER_CLASS_SILK ], false ) );
 
  m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.copper_line_width",
  &m_DesignSettings.m_LineThickness[ LAYER_CLASS_COPPER ],
  Millimeter2iu( DEFAULT_COPPER_LINE_WIDTH ), Millimeter2iu( 0.01 ), Millimeter2iu( 5.0 ),
  MM_PER_IU ) );
 
  m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.copper_text_size_h",
  &m_DesignSettings.m_TextSize[ LAYER_CLASS_COPPER ].x,
  Millimeter2iu( DEFAULT_COPPER_TEXT_SIZE ), TEXTS_MIN_SIZE, TEXTS_MAX_SIZE,
  MM_PER_IU ) );
 
  m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.copper_text_size_v",
  &m_DesignSettings.m_TextSize[ LAYER_CLASS_COPPER ].y,
  Millimeter2iu( DEFAULT_COPPER_TEXT_SIZE ), TEXTS_MIN_SIZE, TEXTS_MAX_SIZE,
  MM_PER_IU ) );
 
  m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.copper_text_thickness",
  &m_DesignSettings.m_TextThickness[ LAYER_CLASS_COPPER ],
  Millimeter2iu( DEFAULT_COPPER_TEXT_WIDTH ), Millimeter2iu( 0.01 ), Millimeter2iu( 5.0 ),
  MM_PER_IU ) );
 
  m_params.emplace_back( new PARAM<bool>( "design_settings.copper_text_italic",
  &m_DesignSettings.m_TextItalic[ LAYER_CLASS_COPPER ], false ) );
 
  m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.edge_line_width",
  &m_DesignSettings.m_LineThickness[ LAYER_CLASS_EDGES ],
  Millimeter2iu( DEFAULT_SILK_LINE_WIDTH ), Millimeter2iu( 0.01 ), Millimeter2iu( 5.0 ),
  MM_PER_IU ) );
 
  m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.courtyard_line_width",
  &m_DesignSettings.m_LineThickness[ LAYER_CLASS_COURTYARD ],
  Millimeter2iu( DEFAULT_COURTYARD_WIDTH ), Millimeter2iu( 0.01 ), Millimeter2iu( 5.0 ),
  MM_PER_IU ) );
 
  m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.fab_line_width",
  &m_DesignSettings.m_LineThickness[ LAYER_CLASS_FAB ],
  Millimeter2iu( DEFAULT_LINE_WIDTH ), Millimeter2iu( 0.01 ), Millimeter2iu( 5.0 ),
  MM_PER_IU ) );
 
  m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.fab_text_size_h",
  &m_DesignSettings.m_TextSize[ LAYER_CLASS_FAB ].x,
  Millimeter2iu( DEFAULT_TEXT_SIZE ), TEXTS_MIN_SIZE, TEXTS_MAX_SIZE, MM_PER_IU ) );
 
  m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.fab_text_size_v",
  &m_DesignSettings.m_TextSize[ LAYER_CLASS_FAB ].y,
  Millimeter2iu( DEFAULT_TEXT_SIZE ), TEXTS_MIN_SIZE, TEXTS_MAX_SIZE, MM_PER_IU ) );
 
  m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.fab_text_thickness",
  &m_DesignSettings.m_TextThickness[ LAYER_CLASS_FAB ],
  Millimeter2iu( DEFAULT_TEXT_WIDTH ), 1, TEXTS_MAX_WIDTH, MM_PER_IU ) );
 
  m_params.emplace_back( new PARAM<bool>( "design_settings.fab_text_italic",
  &m_DesignSettings.m_TextItalic[ LAYER_CLASS_FAB ], false ) );
 
  m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.others_line_width",
  &m_DesignSettings.m_LineThickness[ LAYER_CLASS_OTHERS ],
  Millimeter2iu( DEFAULT_SILK_LINE_WIDTH ), Millimeter2iu( 0.01 ), Millimeter2iu( 5.0 ),
  MM_PER_IU ) );
 
  m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.others_text_size_h",
  &m_DesignSettings.m_TextSize[ LAYER_CLASS_OTHERS ].x,
  Millimeter2iu( DEFAULT_TEXT_SIZE ), TEXTS_MIN_SIZE, TEXTS_MAX_SIZE, MM_PER_IU ) );
 
  m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.others_text_size_v",
  &m_DesignSettings.m_TextSize[ LAYER_CLASS_OTHERS ].y,
  Millimeter2iu( DEFAULT_TEXT_SIZE ), TEXTS_MIN_SIZE, TEXTS_MAX_SIZE, MM_PER_IU ) );
 
  m_params.emplace_back( new PARAM_SCALED<int>( "design_settings.others_text_thickness",
  &m_DesignSettings.m_TextThickness[ LAYER_CLASS_OTHERS ],
  Millimeter2iu( DEFAULT_TEXT_WIDTH ), 1, TEXTS_MAX_WIDTH, MM_PER_IU ) );
 
  m_params.emplace_back( new PARAM<bool>( "design_settings.others_text_italic",
  &m_DesignSettings.m_TextItalic[ LAYER_CLASS_OTHERS ], false ) );
 
  m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "editing.selection_filter",
  [&]() -> nlohmann::json
  {
  nlohmann::json ret;
 
  ret["lockedItems"] = m_SelectionFilter.lockedItems;
  ret["footprints"] = m_SelectionFilter.footprints;
  ret["text"] = m_SelectionFilter.text;
  ret["tracks"] = m_SelectionFilter.tracks;
  ret["vias"] = m_SelectionFilter.vias;
  ret["pads"] = m_SelectionFilter.pads;
  ret["graphics"] = m_SelectionFilter.graphics;
  ret["zones"] = m_SelectionFilter.zones;
  ret["keepouts"] = m_SelectionFilter.keepouts;
  ret["dimensions"] = m_SelectionFilter.dimensions;
  ret["otherItems"] = m_SelectionFilter.otherItems;
 
  return ret;
  },
  [&]( const nlohmann::json& aVal )
  {
  if( aVal.empty() || !aVal.is_object() )
  return;
 
  SetIfPresent( aVal, "lockedItems", m_SelectionFilter.lockedItems );
  SetIfPresent( aVal, "footprints", m_SelectionFilter.footprints );
  SetIfPresent( aVal, "text", m_SelectionFilter.text );
  SetIfPresent( aVal, "tracks", m_SelectionFilter.tracks );
  SetIfPresent( aVal, "vias", m_SelectionFilter.vias );
  SetIfPresent( aVal, "pads", m_SelectionFilter.pads );
  SetIfPresent( aVal, "graphics", m_SelectionFilter.graphics );
  SetIfPresent( aVal, "zones", m_SelectionFilter.zones );
  SetIfPresent( aVal, "keepouts", m_SelectionFilter.keepouts );
  SetIfPresent( aVal, "dimensions", m_SelectionFilter.dimensions );
  SetIfPresent( aVal, "otherItems", m_SelectionFilter.otherItems );
  },
  {
  { "lockedItems", true },
  { "footprints", true },
  { "text", true },
  { "tracks", true },
  { "vias", true },
  { "pads", true },
  { "graphics", true },
  { "zones", true },
  { "keepouts", true },
  { "dimensions", true },
  { "otherItems", true }
  } ) );
 
  registerMigration( 0, 1, std::bind( &FOOTPRINT_EDITOR_SETTINGS::migrateSchema0to1, this ) );
 }

◆ ~FOOTPRINT_EDITOR_SETTINGS()

virtual FOOTPRINT_EDITOR_SETTINGS::~FOOTPRINT_EDITOR_SETTINGS ( )

inlinevirtual

Definition at line 42 of file footprint_editor_settings.h.

42 {}

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

 {
  wxLogTrace( traceSettings, "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 269 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, "" ) );
 
  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, "" ) );
 
  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 ) );
 
  m_params.emplace_back( new PARAM_LIST<wxString>( aJsonPath + ".grid.sizes",
  &aWindow->grid.sizes, DefaultGridSizeList() ) );
 
  // pcbnew default grid doesn't matter much, but eeschema does, so default to the index
  // of the 50mil grid in eeschema
  m_params.emplace_back( new PARAM<int>( aJsonPath + ".grid.last_size",
  &aWindow->grid.last_size_idx, 1 ) );
 
  m_params.emplace_back( new PARAM<int>( aJsonPath + ".grid.fast_grid_1",
  &aWindow->grid.fast_grid_1, 1 ) );
 
  m_params.emplace_back( new PARAM<int>( aJsonPath + ".grid.fast_grid_2",
  &aWindow->grid.fast_grid_2, 2 ) );
 
  // 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_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 BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), EESCHEMA_SETTINGS::migrateBomSettings(), GERBVIEW_SETTINGS::MigrateFromLegacy(), migrateSchema0to1(), COLOR_SETTINGS::migrateSchema0to1(), BOARD_DESIGN_SETTINGS::migrateSchema0to1(), PCBNEW_SETTINGS::PCBNEW_SETTINGS(), and PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_SETTINGS().

◆ Contains()

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

inherited

Definition at line 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(), EESCHEMA_SETTINGS::migrateBomSettings(), COLOR_SETTINGS::migrateSchema0to1(), BOARD_DESIGN_SETTINGS::migrateSchema0to1(), PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_SETTINGS(), and SETTINGS_MANAGER::SaveColorSettings().

◆ Count()

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

inherited

Definition at line 123 of file json_settings.cpp.

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

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

Referenced by migrateSchema0to1().

◆ DefaultGridSizeList()

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

virtualinherited

By default, this returns the list of grids available in PcbNew-based applications.

Eeschema does not allow customization of the grid. If it ever does, override this in Eeschema settings to provide a different set of defaults.

Returns: a default value for the window.grid.sizes parameter

Definition at line 339 of file app_settings.cpp.

 {
  return { "1000 mil",
  "500 mil",
  "250 mil",
  "200 mil",
  "100 mil",
  "50 mil",
  "25 mil",
  "20 mil",
  "10 mil",
  "5 mil",
  "2 mil",
  "1 mil",
  "5.0 mm",
  "2.5 mm",
  "1.0 mm",
  "0.5 mm",
  "0.25 mm",
  "0.2 mm",
  "0.1 mm",
  "0.05 mm",
  "0.025 mm",
  "0.01 mm" };
 }

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

◆ 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 655 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 715 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 691 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 BITMAP2CMP_SETTINGS::MigrateFromLegacy(), MigrateFromLegacy(), GERBVIEW_SETTINGS::MigrateFromLegacy(), SYMBOL_EDITOR_SETTINGS::MigrateFromLegacy(), PROJECT_FILE::MigrateFromLegacy(), PCB_CALCULATOR_SETTINGS::MigrateFromLegacy(), COMMON_SETTINGS::MigrateFromLegacy(), APP_SETTINGS_BASE::MigrateFromLegacy(), EESCHEMA_SETTINGS::MigrateFromLegacy(), PCBNEW_SETTINGS::MigrateFromLegacy(), and APP_SETTINGS_BASE::migrateWindowConfig().

◆ Get() [1/2]

template<typename ValueType >

template OPT< unsigned long long > JSON_SETTINGS::Get< unsigned long long > ( const std::string & aPath ) const

inherited

Fetches a value from within the JSON document.

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

Template Parameters

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

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

References JSON_SETTINGS::GetJson(), and NULLOPT.

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

◆ Get() [2/2]

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

inherited

Definition at line 773 of file json_settings.cpp.

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

References JSON_SETTINGS::GetJson(), and NULLOPT.

◆ getFileExt()

virtual wxString JSON_SETTINGS::getFileExt ( ) const

inlineprotectedvirtualinherited

Reimplemented in PROJECT_FILE, and PROJECT_LOCAL_SETTINGS.

Definition at line 269 of file json_settings.h.

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

72 { return m_filename; }

JSON_SETTINGS::m_filename

wxString m_filename

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

Definition: json_settings.h:280

References JSON_SETTINGS::m_filename.

Referenced by JSON_SETTINGS::AddNestedSettings(), DIALOG_PLOT_SCHEMATIC::getPlotOptions(), SETTINGS_MANAGER::loadColorSettingsByName(), NESTED_SETTINGS::LoadFromFile(), GERBVIEW_SETTINGS::MigrateFromLegacy(), EESCHEMA_SETTINGS::MigrateFromLegacy(), PCBNEW_SETTINGS::MigrateFromLegacy(), PANEL_COLOR_SETTINGS::OnLeftDownTheme(), PANEL_COLOR_SETTINGS::OnThemeChanged(), SETTINGS_MANAGER::SaveColorSettings(), PANEL_COLOR_SETTINGS::saveCurrentTheme(), DIALOG_PRINT_USING_PRINTER::SavePrintOptions(), DIALOG_PRINT_PCBNEW::saveSettings(), NESTED_SETTINGS::SaveToFile(), PANEL_PL_EDITOR_COLOR_SETTINGS::TransferDataFromWindow(), PANEL_FP_EDITOR_COLOR_SETTINGS::TransferDataFromWindow(), PANEL_SYM_COLOR_SETTINGS::TransferDataFromWindow(), PANEL_PCBNEW_COLOR_SETTINGS::TransferDataFromWindow(), and PANEL_EESCHEMA_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(), NESTED_SETTINGS::LoadFromFile(), JSON_SETTINGS::LoadFromFile(), and JSON_SETTINGS::SaveToFile().

◆ GetJson()

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

inherited

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

Parameters

aPath is a string containing one or more keys separated by '.'

Returns: a JSON object from within this one

Definition at line 474 of file json_settings.cpp.

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

References JSON_SETTINGS::m_internals.

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

◆ getLegacyFileExt()

virtual wxString JSON_SETTINGS::getLegacyFileExt ( ) const

inlineprotectedvirtualinherited

Reimplemented in PROJECT_FILE, and PROJECT_LOCAL_SETTINGS.

Definition at line 274 of file json_settings.h.

  {
  return wxEmptyString;
  }

Referenced by JSON_SETTINGS::LoadFromFile().

◆ getLegacyFrameName()

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

inlineoverrideprotectedvirtual

Reimplemented from APP_SETTINGS_BASE.

Definition at line 75 of file footprint_editor_settings.h.

75 { return "ModEditFrame"; }

◆ GetLocation()

SETTINGS_LOC JSON_SETTINGS::GetLocation ( ) const

inlineinherited

Definition at line 78 of file json_settings.h.

78 { return m_location; }

JSON_SETTINGS::m_location

SETTINGS_LOC m_location

The location of this settings file (.

Definition: json_settings.h:286

References JSON_SETTINGS::m_location.

Referenced by SETTINGS_MANAGER::GetPathForSettingsFile().

◆ Internals()

JSON_SETTINGS_INTERNALS * JSON_SETTINGS::Internals ( )

inherited

Definition at line 129 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 82 of file json_settings.h.

82 { return !m_writeFile; }

JSON_SETTINGS::m_writeFile

bool m_writeFile

Whether or not the backing store file should be written.

Definition: json_settings.h:304

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

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

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

Referenced by COLOR_SETTINGS::CreateBuiltinColorSettings(), NESTED_SETTINGS::LoadFromFile(), JSON_SETTINGS::LoadFromFile(), BOARD_DESIGN_SETTINGS::LoadFromFile(), COLOR_SETTINGS::migrateSchema0to1(), and SETTINGS_MANAGER::SaveColorSettings().

◆ LoadFromFile()

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

virtualinherited

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

Parameters

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 152 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, "%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() ) )
  {
  wxLogTrace( traceSettings,
  "%s: migrated; not all settings were found in legacy file",
  GetFullFilename() );
  }
  else
  {
  wxLogTrace( traceSettings, "%s: migrated from legacy format", GetFullFilename() );
  }
 
  if( backed_up )
  {
  cfg.reset();
 
  if( !wxCopyFile( temp.GetFullPath(), aPath.GetFullPath() ) )
  {
  wxLogTrace( traceSettings,
  "migrate; copy temp file %s to %s failed",
  temp.GetFullPath(), aPath.GetFullPath() );
  }
 
  if( !wxRemoveFile( temp.GetFullPath() ) )
  {
  wxLogTrace( traceSettings,
  "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 );
 
  // If parse succeeds, check if schema migration is required
  int filever = -1;
 
  try
  {
  filever = m_internals->Get<int>( "meta.version" );
  }
  catch( ... )
  {
  wxLogTrace( traceSettings, "%s: file version could not be read!",
  GetFullFilename() );
  success = false;
  }
 
  if( filever >= 0 && filever < m_schemaVersion )
  {
  wxLogTrace( traceSettings, "%s: attempting migration from version %d to %d",
  GetFullFilename(), filever, m_schemaVersion );
 
  if( Migrate() )
  {
  migrated = true;
  }
  else
  {
  wxLogTrace( traceSettings, "%s: migration failed!", GetFullFilename() );
  }
  }
  else if( filever > m_schemaVersion )
  {
  wxLogTrace( traceSettings,
  "%s: warning: file version %d is newer than latest (%d)",
  GetFullFilename(), filever, m_schemaVersion );
  }
  }
  else
  {
  wxLogTrace( traceSettings, "%s exists but can't be opened for read",
  GetFullFilename() );
  }
  }
  catch( nlohmann::json::parse_error& error )
  {
  wxLogTrace( traceSettings, "Json parse error reading %s: %s",
  path.GetFullPath(), error.what() );
  wxLogTrace( traceSettings, "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, "Loaded <%s> with schema %d", GetFullFilename(), m_schemaVersion );
 
  // If we migrated, clean up the legacy file (with no extension)
  if( legacy_migrated || migrated )
  {
  if( legacy_migrated && m_deleteLegacyAfterMigration && !wxRemoveFile( path.GetFullPath() ) )
  {
  wxLogTrace( traceSettings, "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::SaveColorSettings().

◆ Migrate()

bool JSON_SETTINGS::Migrate ( )

inherited

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

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

Returns: true if migration was successful

Definition at line 552 of file json_settings.cpp.

 {
  int filever = m_internals->Get<int>( "meta.version" );
 
  while( filever < m_schemaVersion )
  {
  if( !m_migrators.count( filever ) )
  {
  wxLogTrace( traceSettings, "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, "Migrated %s from %d to %d", typeid( *this ).name(),
  filever, pair.first );
  filever = pair.first;
  m_internals->At( "meta.version" ) = filever;
  }
  else
  {
  wxLogTrace( traceSettings, "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 NESTED_SETTINGS::LoadFromFile(), and JSON_SETTINGS::LoadFromFile().

◆ migrateFindReplace()

void APP_SETTINGS_BASE::migrateFindReplace ( wxConfigBase * aCfg )

protectedinherited

! Migrates the find/replace history string lists

Definition at line 209 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 FOOTPRINT_EDITOR_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 280 of file footprint_editor_settings.cpp.

 {
  bool ret = APP_SETTINGS_BASE::MigrateFromLegacy( aCfg );
 
  //
  // NOTE: there's no value in line-wrapping these; it just makes the table unreadable.
  //
  ret &= fromLegacy<int>( aCfg, "ModeditLibWidth", "window.lib_width" );
  ret &= fromLegacyString( aCfg, "import_last_path", "system.last_import_export_path" );
  ret &= fromLegacyString( aCfg, "LibFootprintTextShownColumns", "window.footprint_text_shown_columns" );
 
  ret &= fromLegacy<int>( aCfg, "FpEditorMagneticPads", "editing.magnetic_pads" );
  ret &= fromLegacy<bool>( aCfg, "FpEditorDisplayPolarCoords", "editing.polar_coords" );
  ret &= fromLegacy<int>( aCfg, "FpEditorUse45DegreeGraphicSegments", "editing.use_45_degree_graphic_segments" );
 
  ret &= fromLegacy<bool>( aCfg, "FpEditorGraphicLinesDisplayMode", "pcb_display.graphic_items_fill" );
  ret &= fromLegacy<bool>( aCfg, "FpEditorPadDisplayMode", "pcb_display.pad_fill" );
  ret &= fromLegacy<bool>( aCfg, "FpEditorTextsDisplayMode", "pcb_display.footprint_text" );
 
  ret &= fromLegacy<double>( aCfg, "FpEditorSilkLineWidth", "design_settings.silk_line_width" );
  ret &= fromLegacy<double>( aCfg, "FpEditorSilkTextSizeH", "design_settings.silk_text_size_h" );
  ret &= fromLegacy<double>( aCfg, "FpEditorSilkTextSizeV", "design_settings.silk_text_size_v" );
  ret &= fromLegacy<double>( aCfg, "FpEditorSilkTextThickness", "design_settings.silk_text_thickness" );
  ret &= fromLegacy<bool>( aCfg, "FpEditorSilkTextItalic", "design_settings.silk_text_italic" );
  ret &= fromLegacy<double>( aCfg, "FpEditorCopperLineWidth", "design_settings.copper_line_width" );
  ret &= fromLegacy<double>( aCfg, "FpEditorCopperTextSizeH", "design_settings.copper_text_size_h" );
  ret &= fromLegacy<double>( aCfg, "FpEditorCopperTextSizeV", "design_settings.copper_text_size_v" );
  ret &= fromLegacy<double>( aCfg, "FpEditorCopperTextThickness", "design_settings.copper_text_thickness" );
  ret &= fromLegacy<bool>( aCfg, "FpEditorCopperTextItalic", "design_settings.copper_text_italic" );
  ret &= fromLegacy<double>( aCfg, "FpEditorEdgeCutLineWidth", "design_settings.edge_line_width" );
  ret &= fromLegacy<double>( aCfg, "FpEditorCourtyardLineWidth", "design_settings.courtyard_line_width" );
  ret &= fromLegacy<double>( aCfg, "FpEditorOthersLineWidth", "design_settings.others_line_width" );
  ret &= fromLegacy<double>( aCfg, "FpEditorOthersTextSizeH", "design_settings.others_text_size_h" );
  ret &= fromLegacy<double>( aCfg, "FpEditorOthersTextSizeV", "design_settings.others_text_size_v" );
  ret &= fromLegacy<double>( aCfg, "FpEditorOthersTextThickness", "design_settings.others_text_thickness" );
  ret &= fromLegacy<bool>( aCfg, "FpEditorOthersTextItalic", "design_settings.others_text_italic" );
 
  nlohmann::json textItems = nlohmann::json::array( {
  { "REF**", true, F_SilkS },
  { "", true, F_Fab }
  } );
 
  Set( "design_settings.default_footprint_text_items", textItems );
 
  ret &= fromLegacyString( aCfg, "FpEditorRefDefaultText", "design_settings.default_footprint_text_items.0.0" );
  ret &= fromLegacy<bool>( aCfg, "FpEditorRefDefaultVisibility", "design_settings.default_footprint_text_items.0.1" );
  ret &= fromLegacy<int>( aCfg, "FpEditorRefDefaultLayer", "design_settings.default_footprint_text_items.0.2" );
  ret &= fromLegacyString( aCfg, "FpEditorValueDefaultText", "design_settings.default_footprint_text_items.1.0" );
  ret &= fromLegacy<bool>( aCfg, "FpEditorValueDefaultVisibility", "design_settings.default_footprint_text_items.1.1" );
  ret &= fromLegacy<int>( aCfg, "FpEditorValueDefaultLayer", "design_settings.default_footprint_text_items.1.2" );
 
 
  std::string f = "ModEdit";
 
  // Migrate color settings that were stored in the pcbnew config file
  // We create a copy of the user scheme for the footprint editor context
 
  SETTINGS_MANAGER& manager = Pgm().GetSettingsManager();
  COLOR_SETTINGS* cs = manager.AddNewColorSettings( "user_footprints" );
 
  cs->SetName( wxT( "User (Footprints)" ) );
  manager.Save( cs );
 
  auto migrateLegacyColor = [&] ( const std::string& aKey, int aLayerId )
  {
  wxString str;
 
  if( aCfg->Read( aKey, &str ) )
   cs->SetColor( aLayerId, COLOR4D( str ) );
  };
 
  for( int i = 0; i < PCB_LAYER_ID_COUNT; ++i )
  {
  wxString layer = LSET::Name( PCB_LAYER_ID( i ) );
  migrateLegacyColor( f + "Color4DPCBLayer_" + layer.ToStdString(), PCB_LAYER_ID( i ) );
  }
 
  migrateLegacyColor( f + "Color4DAnchorEx", LAYER_ANCHOR );
  migrateLegacyColor( f + "Color4DAuxItems", LAYER_AUX_ITEMS );
  migrateLegacyColor( f + "Color4DGrid", LAYER_GRID );
  migrateLegacyColor( f + "Color4DNoNetPadMarker", LAYER_NO_CONNECTS );
  migrateLegacyColor( f + "Color4DNonPlatedEx", LAYER_NON_PLATEDHOLES );
  migrateLegacyColor( f + "Color4DPadThruHoleEx", LAYER_PADS_TH );
  migrateLegacyColor( f + "Color4DPCBBackground", LAYER_PCB_BACKGROUND );
  migrateLegacyColor( f + "Color4DPCBCursor", LAYER_CURSOR );
  migrateLegacyColor( f + "Color4DRatsEx", LAYER_RATSNEST );
  migrateLegacyColor( f + "Color4DTxtInvisEx", LAYER_MOD_TEXT_INVISIBLE );
  migrateLegacyColor( f + "Color4DViaBBlindEx", LAYER_VIA_BBLIND );
  migrateLegacyColor( f + "Color4DViaMicroEx", LAYER_VIA_MICROVIA );
  migrateLegacyColor( f + "Color4DViaThruEx", LAYER_VIA_THROUGH );
  migrateLegacyColor( f + "Color4DWorksheet", LAYER_DRAWINGSHEET );
 
  manager.SaveColorSettings( cs, "board" );
 
  ( *m_internals )[m_internals->PointerFromString( "appearance.color_theme" )] = "user_footprints";
 
  double x, y;
  f = "ModEditFrame";
 
  if( aCfg->Read( f + "PcbUserGrid_X", &x ) && aCfg->Read( f + "PcbUserGrid_Y", &y ) )
  {
  EDA_UNITS u = static_cast<EDA_UNITS>( aCfg->ReadLong( f + "PcbUserGrid_Unit",
  static_cast<long>( EDA_UNITS::INCHES ) ) );
 
  // Convert to internal units
  x = From_User_Unit( u, x );
  y = From_User_Unit( u, y );
 
  Set( "window.grid.user_grid_x", StringFromValue( u, x ) );
  Set( "window.grid.user_grid_y", StringFromValue( u, y ) );
  }
 
  return ret;
 }

References SETTINGS_MANAGER::AddNewColorSettings(), F_Fab, F_SilkS, From_User_Unit(), JSON_SETTINGS::fromLegacyString(), INCHES, LAYER_ANCHOR, LAYER_AUX_ITEMS, LAYER_CURSOR, LAYER_DRAWINGSHEET, LAYER_GRID, LAYER_MOD_TEXT_INVISIBLE, LAYER_NO_CONNECTS, LAYER_NON_PLATEDHOLES, LAYER_PADS_TH, LAYER_PCB_BACKGROUND, LAYER_RATSNEST, LAYER_VIA_BBLIND, LAYER_VIA_MICROVIA, LAYER_VIA_THROUGH, JSON_SETTINGS::m_internals, APP_SETTINGS_BASE::MigrateFromLegacy(), LSET::Name(), PCB_LAYER_ID_COUNT, Pgm(), SETTINGS_MANAGER::Save(), SETTINGS_MANAGER::SaveColorSettings(), JSON_SETTINGS::Set(), COLOR_SETTINGS::SetColor(), COLOR_SETTINGS::SetName(), and StringFromValue().

Referenced by PCBNEW_SETTINGS::MigrateFromLegacy().

◆ migrateSchema0to1()

bool FOOTPRINT_EDITOR_SETTINGS::migrateSchema0to1 ( )

private

Schema version 0 to 1:

Check to see if a footprints version of the currently selected theme exists.
If so, select it

Definition at line 396 of file footprint_editor_settings.cpp.

 {
  if( !m_manager )
  {
  wxLogTrace( traceSettings,
  "Error: FOOTPRINT_EDITOR_SETTINGS migration cannot run unmanaged!" );
  return false;
  }
 
  std::string theme_ptr( "appearance.color_theme" );
 
  if( !Count( theme_ptr ) )
  return true;
 
  wxString selected = At( theme_ptr ).get<wxString>();
  wxString search = selected + wxT( "_footprints" );
 
  for( COLOR_SETTINGS* settings : Pgm().GetSettingsManager().GetColorSettingsList() )
  {
  if( settings->GetFilename() == search )
  {
  wxLogTrace( traceSettings, "Updating footprint editor theme from %s to %s",
  selected, search );
  Set( theme_ptr, search );
  return true;
  }
  }
 
  return true;
 }

References JSON_SETTINGS::At(), JSON_SETTINGS::Count(), GetSettingsManager(), JSON_SETTINGS::m_manager, Pgm(), JSON_SETTINGS::Set(), and traceSettings.

Referenced by FOOTPRINT_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 233 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 CVPCB_SETTINGS::MigrateFromLegacy(), APP_SETTINGS_BASE::MigrateFromLegacy(), and PCBNEW_SETTINGS::MigrateFromLegacy().

◆ 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 543 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::EESCHEMA_SETTINGS(), FOOTPRINT_EDITOR_SETTINGS(), NET_SETTINGS::NET_SETTINGS(), PCBNEW_SETTINGS::PCBNEW_SETTINGS(), PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_SETTINGS(), and SCHEMATIC_SETTINGS::SCHEMATIC_SETTINGS().

◆ ReleaseNestedSettings()

void JSON_SETTINGS::ReleaseNestedSettings ( NESTED_SETTINGS * aSettings )

inherited

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

Parameters

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

Definition at line 750 of file json_settings.cpp.

 {
  if( !aSettings )
  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, "Flush and release %s", ( *it )->GetFilename() );
  ( *it )->SaveToFile();
  m_nested_settings.erase( it );
  }
 
  aSettings->SetParent( nullptr );
 }

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

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

◆ ResetToDefaults()

void JSON_SETTINGS::ResetToDefaults ( )

inherited

Resets all parameters to default values.

Does NOT write to file or update underlying JSON.

Definition at line 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,
  "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, "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, "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, "%s contents not modified, skipping save", GetFullFilename() );
  return false;
  }
  else if( !modified && !aForce && !m_createIfDefault )
  {
  wxLogTrace( traceSettings,
  "%s contents still default and m_createIfDefault == false; not saving",
  GetFullFilename() );
  return false;
  }
 
  wxLogTrace( traceSettings, "Saving %s", GetFullFilename() );
 
  LOCALE_IO dummy;
  bool success = true;
 
  try
  {
  std::stringstream buffer;
  buffer << std::setw( 2 ) << *m_internals << std::endl;
 
  wxFFileOutputStream fileStream( path.GetFullPath(), "wb" );
 
  if( !fileStream.IsOk()
  || !fileStream.WriteAll( buffer.str().c_str(), buffer.str().size() ) )
  {
  wxLogTrace( traceSettings, "Warning: could not save %s", GetFullFilename() );
  success = false;
  }
  }
  catch( nlohmann::json::exception& error )
  {
  wxLogTrace( traceSettings, "Catch error: could not save %s. Json error %s",
  GetFullFilename(), error.what() );
  success = false;
  }
  catch( ... )
  {
  wxLogTrace( traceSettings, "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(), PANEL_COLOR_SETTINGS::OnThemeChanged(), SETTINGS_MANAGER::SaveColorSettings(), PROJECT_LOCAL_SETTINGS::SaveToFile(), PROJECT_FILE::SaveToFile(), and PGM_BASE::SetLanguage().

◆ Set() [1/3]

template<typename ValueType >

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

inherited

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

Template Parameters

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

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

References JSON_SETTINGS::m_internals.

◆ Set() [2/3]

template<>

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

inherited

◆ Set() [3/3]

template<>

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

inherited

Definition at line 782 of file json_settings.cpp.

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

◆ SetFilename()

void JSON_SETTINGS::SetFilename ( const wxString & aFilename )

inlineinherited

Definition at line 76 of file json_settings.h.

76 { m_filename = aFilename; }

JSON_SETTINGS::m_filename

wxString m_filename

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

Definition: json_settings.h:280

References JSON_SETTINGS::m_filename.

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

◆ SetIfPresent() [1/4]

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

staticinherited

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

Parameters

aObj	is the source object
aTarget	is the storage destination

Returns: True if set, false if not

Definition at line 594 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(), and PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_SETTINGS().

◆ SetIfPresent() [2/4]

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

staticinherited

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

Parameters

aObj	is the source object
aTarget	is the storage destination

Returns: True if set, false if not

Definition at line 609 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() [3/4]

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

staticinherited

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

Parameters

aObj	is the source object
aTarget	is the storage destination

Returns: True if set, false if not

Definition at line 624 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() [4/4]

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

staticinherited

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

Parameters

aObj	is the source object
aTarget	is the storage destination

Returns: True if set, false if not

Definition at line 639 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().

◆ SetLegacyFilename()

void JSON_SETTINGS::SetLegacyFilename ( const wxString & aFilename )

inlineinherited

Definition at line 80 of file json_settings.h.

80 { m_legacy_filename = aFilename; }

JSON_SETTINGS::m_legacy_filename

wxString m_legacy_filename

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

Definition: json_settings.h:283

References JSON_SETTINGS::m_legacy_filename.

Referenced by SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS().

◆ SetManager()

void JSON_SETTINGS::SetManager ( SETTINGS_MANAGER * aManager )

inlineinherited

Definition at line 190 of file json_settings.h.

  {
  m_manager = aManager;
  }

References JSON_SETTINGS::m_manager.

◆ SetReadOnly()

void JSON_SETTINGS::SetReadOnly ( bool aReadOnly )

inlineinherited

Definition at line 83 of file json_settings.h.

83 { m_writeFile = !aReadOnly; }

JSON_SETTINGS::m_writeFile

bool m_writeFile

Whether or not the backing store file should be written.

Definition: json_settings.h:304

References JSON_SETTINGS::m_writeFile.

Referenced by SETTINGS_MANAGER::GetColorSettings(), PANEL_COLOR_SETTINGS::OnThemeChanged(), PANEL_FP_PROPERTIES_3D_MODEL::PANEL_FP_PROPERTIES_3D_MODEL(), 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;
 }