#include <pcbnew_settings.h>

Inheritance diagram for PCBNEW_SETTINGS:

Classes
struct	AUI_PANELS

struct	DIALOG_CLEANUP

struct	DIALOG_DRC

struct	DIALOG_EXPORT_IDF

struct	DIALOG_EXPORT_STEP

struct	DIALOG_EXPORT_SVG

struct	DIALOG_EXPORT_VRML

struct	DIALOG_FOOTPRINT_WIZARD_LIST

struct	DIALOG_GENERATE_DRILL

struct	DIALOG_IMPORT_GRAPHICS

struct	DIALOG_NETLIST

struct	DIALOG_PLACE_FILE

struct	DIALOG_PLOT

struct	DIALOG_REANNOTATE

struct	DISPLAY_OPTIONS

struct	FOOTPRINT_CHOOSER

struct	ZONES

Public Member Functions
	PCBNEW_SETTINGS ()

virtual	~PCBNEW_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)

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

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

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)

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
AUI_PANELS	m_AuiPanels

DIALOG_CLEANUP	m_Cleanup

DIALOG_DRC	m_DrcDialog

DIALOG_EXPORT_IDF	m_ExportIdf

DIALOG_EXPORT_STEP	m_ExportStep

DIALOG_EXPORT_SVG	m_ExportSvg

DIALOG_EXPORT_VRML	m_ExportVrml

DIALOG_FOOTPRINT_WIZARD_LIST	m_FootprintWizardList

DIALOG_GENERATE_DRILL	m_GenDrill

DIALOG_IMPORT_GRAPHICS	m_ImportGraphics

DIALOG_NETLIST	m_NetlistDialog

DIALOG_PLACE_FILE	m_PlaceFile

DIALOG_PLOT	m_Plot

DIALOG_REANNOTATE	m_Reannotate

FOOTPRINT_CHOOSER	m_FootprintChooser

ZONES	m_Zones

WINDOW_SETTINGS	m_FootprintViewer

WINDOW_SETTINGS	m_FootprintWizard

DISPLAY_OPTIONS	m_Display

MAGNETIC_SETTINGS	m_MagneticItems

TRACK_DRAG_ACTION	m_TrackDragAction

bool	m_CtrlClickHighlight

bool	m_Use45DegreeLimit

bool	m_FlipLeftRight

bool	m_ESCClearsNetHighlight

bool	m_PolarCoords

EDA_ANGLE	m_RotationAngle

bool	m_ShowPageLimits

bool	m_AutoRefillZones

bool	m_AllowFreePads

wxString	m_FootprintTextShownColumns

std::unique_ptr< PNS::ROUTING_SETTINGS >	m_PnsSettings

double	m_FootprintViewerZoom
	The last zoom level used (0 for auto) More...

bool	m_FootprintViewerAutoZoomOnSelect
	true to use automatic zoom on fp selection More...

int	m_FootprintViewerLibListWidth

int	m_FootprintViewerFPListWidth

wxString	m_lastFootprintLibDir

wxString	m_lastFootprint3dDir

ACTION_PLUGIN_SETTINGS_LIST	m_VisibleActionPlugins

VIEWERS_DISPLAY_OPTIONS	m_ViewersDisplay

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

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

Detailed Description

Definition at line 121 of file pcbnew_settings.h.

Constructor & Destructor Documentation

◆ PCBNEW_SETTINGS()

PCBNEW_SETTINGS::PCBNEW_SETTINGS ( )

Definition at line 49 of file pcbnew_settings.cpp.

 : PCB_VIEWERS_SETTINGS_BASE( "pcbnew", pcbnewSchemaVersion ),
 m_AuiPanels(),
 m_Cleanup(),
 m_DrcDialog(),
 m_ExportIdf(),
 m_ExportStep(),
 m_ExportSvg(),
 m_ExportVrml(),
 m_FootprintWizardList(),
 m_GenDrill(),
 m_ImportGraphics(),
 m_NetlistDialog(),
 m_PlaceFile(),
 m_Plot(),
 m_FootprintChooser(),
 m_Zones(),
 m_FootprintViewer(),
 m_FootprintWizard(),
 m_Display(),
 m_TrackDragAction( TRACK_DRAG_ACTION::DRAG ),
 m_CtrlClickHighlight( false ),
 m_Use45DegreeLimit( false ),
 m_FlipLeftRight( false ),
 m_ESCClearsNetHighlight( true ),
 m_PolarCoords( false ),
 m_RotationAngle( ANGLE_90 ),
 m_ShowPageLimits( true ),
 m_AutoRefillZones( false ),
 m_AllowFreePads( false ),
 m_PnsSettings( nullptr ),
 m_FootprintViewerZoom( 1.0 ),
 m_FootprintViewerAutoZoomOnSelect( true ),
 m_FootprintViewerLibListWidth( 200 ),
 m_FootprintViewerFPListWidth( 300 )
{
 m_MagneticItems.pads = MAGNETIC_OPTIONS::CAPTURE_CURSOR_IN_TRACK_TOOL;
 m_MagneticItems.tracks = MAGNETIC_OPTIONS::CAPTURE_CURSOR_IN_TRACK_TOOL;
 m_MagneticItems.graphics = false;
 
 m_params.emplace_back( new PARAM<bool>( "aui.show_layer_manager",
 &m_AuiPanels.show_layer_manager, true ) );
 
 m_params.emplace_back( new PARAM<int>( "aui.right_panel_width",
 &m_AuiPanels.right_panel_width, -1 ) );
 
 m_params.emplace_back( new PARAM<int>( "aui.appearance_panel_tab",
 &m_AuiPanels.appearance_panel_tab, 0, 0, 2 ) );
 
 m_params.emplace_back( new PARAM<bool>( "aui.show_properties",
 &m_AuiPanels.show_properties, true ) );
 
 m_params.emplace_back( new PARAM<bool>( "aui.show_search",
 &m_AuiPanels.show_search, false ) );
 
 m_params.emplace_back( new PARAM<int>( "footprint_chooser.width",
 &m_FootprintChooser.width, -1 ) );
 
 m_params.emplace_back( new PARAM<int>( "footprint_chooser.height",
 &m_FootprintChooser.height, -1 ) );
 
 m_params.emplace_back( new PARAM<int>( "footprint_chooser.sash_h",
 &m_FootprintChooser.sash_h, -1 ) );
 
 m_params.emplace_back( new PARAM<int>( "footprint_chooser.sash_v",
 &m_FootprintChooser.sash_v, -1 ) );
 
 m_params.emplace_back( new PARAM<bool>( "editing.flip_left_right",
 &m_FlipLeftRight, true ) );
 
 m_params.emplace_back( new PARAM<bool>( "editing.esc_clears_net_highlight",
 &m_ESCClearsNetHighlight, true ) );
 
 m_params.emplace_back( new PARAM<bool>( "editing.magnetic_graphics",
 &m_MagneticItems.graphics, true ) );
 
 m_params.emplace_back( new PARAM<int>( "editing.magnetic_pads",
 reinterpret_cast<int*>( &m_MagneticItems.pads ),
 static_cast<int>( MAGNETIC_OPTIONS::CAPTURE_CURSOR_IN_TRACK_TOOL ) ) );
 
 m_params.emplace_back( new PARAM<int>( "editing.magnetic_tracks",
 reinterpret_cast<int*>( &m_MagneticItems.tracks ),
 static_cast<int>( MAGNETIC_OPTIONS::CAPTURE_CURSOR_IN_TRACK_TOOL ) ) );
 
 m_params.emplace_back( new PARAM<bool>( "editing.polar_coords",
 &m_PolarCoords, false ) );
 
 m_params.emplace_back( new PARAM<int>( "editing.track_drag_action",
 reinterpret_cast<int*>( &m_TrackDragAction ),
 static_cast<int>( TRACK_DRAG_ACTION::DRAG ) ) );
 
 m_params.emplace_back( new PARAM<bool>( "editing.ctrl_click_highlight",
 &m_CtrlClickHighlight, false ) );
 
 m_params.emplace_back( new PARAM<bool>( "editing.pcb_use_45_degree_limit",
 &m_Use45DegreeLimit, false ) );
 
 m_params.emplace_back( new PARAM<bool>( "editing.auto_fill_zones",
 &m_AutoRefillZones, false ) );
 
 m_params.emplace_back( new PARAM<bool>( "editing.allow_free_pads",
 &m_AllowFreePads, false ) );
 
 m_params.emplace_back( new PARAM_LAMBDA<int>( "editing.rotation_angle",
 [this] () -> int
 {
 int rot = m_RotationAngle.AsTenthsOfADegree();
 
 // Don't store values larger than 360 degrees
 return rot % 3600;
 },
 [this] ( int aVal )
 {
 if( aVal )
 m_RotationAngle = EDA_ANGLE( aVal, TENTHS_OF_A_DEGREE_T );
 
 // A misconfiguration allowed some angles to be stored as tenth of a degree but read
 // as tens of degrees. By disallowing storage of values larger than 360, we can weed out
 // those invalid values here.
 while( m_RotationAngle > ANGLE_360 )
 m_RotationAngle = m_RotationAngle / 100;
 
 },
 900 ) );
 
 m_params.emplace_back( new PARAM<bool>( "pcb_display.graphic_items_fill",
 &m_ViewersDisplay.m_DisplayGraphicsFill, true ) );
 
 m_params.emplace_back( new PARAM<int>( "pcb_display.max_links_shown",
 &m_Display.m_MaxLinksShowed, 3, 0, 15 ) );
 
 m_params.emplace_back( new PARAM<bool>( "pcb_display.graphics_fill",
 &m_ViewersDisplay.m_DisplayGraphicsFill, true ) );
 
 m_params.emplace_back( new PARAM<bool>( "pcb_display.text_fill",
 &m_ViewersDisplay.m_DisplayTextFill, true ) );
 
 m_params.emplace_back( new PARAM<int>( "pcb_display.net_names_mode",
 &m_Display.m_NetNames, 3, 0, 3 ) );
 
 m_params.emplace_back( new PARAM<bool>( "pcb_display.pad_clearance",
 &m_Display.m_PadClearance, true ) );
 
 m_params.emplace_back( new PARAM<bool>( "pcb_display.pad_fill",
 &m_ViewersDisplay.m_DisplayPadFill, true ) );
 
 m_params.emplace_back( new PARAM<bool>( "pcb_display.pad_numbers",
 &m_ViewersDisplay.m_DisplayPadNumbers, true ) );
 
 m_params.emplace_back( new PARAM<bool>( "pcb_display.ratsnest_global",
 &m_Display.m_ShowGlobalRatsnest, true ) );
 
 m_params.emplace_back( new PARAM<bool>( "pcb_display.ratsnest_footprint",
 &m_Display.m_ShowModuleRatsnest, true ) );
 
 m_params.emplace_back( new PARAM<bool>( "pcb_display.ratsnest_curved",
 &m_Display.m_DisplayRatsnestLinesCurved, false ) );
 
 m_params.emplace_back( new PARAM<int>( "pcb_display.track_clearance_mode",
 reinterpret_cast<int*>( &m_Display.m_TrackClearance ), SHOW_WITH_VIA_WHILE_ROUTING ) );
 
 m_params.emplace_back( new PARAM<bool>( "pcb_display.track_fill",
 &m_Display.m_DisplayPcbTrackFill, true ) );
 
 m_params.emplace_back( new PARAM<bool>( "pcb_display.via_fill",
 &m_Display.m_DisplayViaFill, true ) );
 
 m_params.emplace_back( new PARAM<int>( "pcb_display.origin_mode",
 reinterpret_cast<int*>( &m_Display.m_DisplayOrigin ),
 PCB_DISPLAY_ORIGIN::PCB_ORIGIN_PAGE ) );
 
 m_params.emplace_back( new PARAM<bool>( "pcb_display.origin_invert_x_axis",
 &m_Display.m_DisplayInvertXAxis, false ) );
 
 m_params.emplace_back( new PARAM<bool>( "pcb_display.origin_invert_y_axis",
 &m_Display.m_DisplayInvertYAxis, false ) );
 
 m_params.emplace_back( new PARAM<bool>( "pcb_display.live_3d_refresh",
 &m_Display.m_Live3DRefresh, false ) );
 
 m_params.emplace_back( new PARAM<bool>( "pcb_display.show_page_borders",
 &m_ShowPageLimits, true ) );
 
 m_params.emplace_back( new PARAM<bool>( "cleanup.cleanup_vias",
  &m_Cleanup.cleanup_vias, true ) );
 
 m_params.emplace_back( new PARAM<bool>( "cleanup.delete_dangling_vias",
 &m_Cleanup.delete_dangling_vias, true ) );
 
 m_params.emplace_back( new PARAM<bool>( "cleanup.merge_segments",
 &m_Cleanup.merge_segments, true ) );
 
 m_params.emplace_back( new PARAM<bool>( "cleanup.cleanup_unconnected",
 &m_Cleanup.cleanup_unconnected, true ) );
 
 m_params.emplace_back( new PARAM<bool>( "cleanup.cleanup_short_circuits",
 &m_Cleanup.cleanup_short_circuits, true ) );
 
 m_params.emplace_back( new PARAM<bool>( "cleanup.cleanup_tracks_in_pad",
 &m_Cleanup.cleanup_tracks_in_pad, false ) );
 
 m_params.emplace_back( new PARAM<bool>( "drc_dialog.refill_zones",
 &m_DrcDialog.refill_zones, true ) );
 
 m_params.emplace_back( new PARAM<bool>( "drc_dialog.test_all_track_errors",
 &m_DrcDialog.test_all_track_errors, false ) );
 
 m_params.emplace_back( new PARAM<bool>( "drc_dialog.test_footprints",
 &m_DrcDialog.test_footprints, false ) );
 
 m_params.emplace_back( new PARAM<int>( "drc_dialog.severities",
 &m_DrcDialog.severities, RPT_SEVERITY_ERROR | RPT_SEVERITY_WARNING ) );
 
 m_params.emplace_back( new PARAM<bool>( "gen_drill.merge_pth_npth",
 &m_GenDrill.merge_pth_npth, false ) );
 
 m_params.emplace_back( new PARAM<bool>( "gen_drill.minimal_header",
 &m_GenDrill.minimal_header, false ) );
 
 m_params.emplace_back( new PARAM<bool>( "gen_drill.mirror",
 &m_GenDrill.mirror, false ) );
 
 m_params.emplace_back( new PARAM<bool>( "gen_drill.unit_drill_is_inch",
 &m_GenDrill.unit_drill_is_inch, true ) );
 
 m_params.emplace_back( new PARAM<bool>( "gen_drill.use_route_for_oval_holes",
 &m_GenDrill.use_route_for_oval_holes, true ) );
 
 m_params.emplace_back( new PARAM<int>( "gen_drill.drill_file_type",
 &m_GenDrill.drill_file_type, 0 ) );
 
 m_params.emplace_back( new PARAM<int>( "gen_drill.map_file_type",
 &m_GenDrill.map_file_type, 1 ) );
 
 m_params.emplace_back( new PARAM<int>( "gen_drill.zeros_format",
 &m_GenDrill.zeros_format, 0, 0, 3 ) );
 
 m_params.emplace_back( new PARAM<bool>( "export_idf.auto_adjust",
 &m_ExportIdf.auto_adjust, false ) );
 
 m_params.emplace_back( new PARAM<int>( "export_idf.ref_units",
 &m_ExportIdf.ref_units, 0 ) );
 
 m_params.emplace_back( new PARAM<double>( "export_idf.ref_x",
 &m_ExportIdf.ref_x, 0 ) );
 
 m_params.emplace_back( new PARAM<double>( "export_idf.ref_y",
 &m_ExportIdf.ref_y, 0 ) );
 
 m_params.emplace_back( new PARAM<bool>( "export_idf.units_mils",
 &m_ExportIdf.units_mils, false ) );
 
 m_params.emplace_back( new PARAM<int>( "export_step.origin_mode",
 &m_ExportStep.origin_mode, 0 ) );
 
 m_params.emplace_back( new PARAM<int>( "export_step.origin_units",
 &m_ExportStep.origin_units, 0 ) );
 
 m_params.emplace_back( new PARAM<double>( "export_step.origin_x",
 &m_ExportStep.origin_x, 0 ) );
 
 m_params.emplace_back( new PARAM<double>( "export_step.origin_y",
 &m_ExportStep.origin_y, 0 ) );
 
 m_params.emplace_back( new PARAM<bool>( "export_step.no_virtual",
 &m_ExportStep.no_virtual, false ) );
 
 m_params.emplace_back( new PARAM<bool>( "export_step.replace_models",
 &m_ExportStep.replace_models, false ) );
 
 m_params.emplace_back( new PARAM<bool>( "export_step.overwrite_file",
 &m_ExportStep.overwrite_file, true ) );
 
 m_params.emplace_back( new PARAM<bool>( "export_svg.black_and_white",
 &m_ExportSvg.black_and_white, false ) );
 
 m_params.emplace_back( new PARAM<bool>( "export_svg.mirror",
 &m_ExportSvg.mirror, false ) );
 
 m_params.emplace_back( new PARAM<bool>( "export_svg.one_file",
 &m_ExportSvg.one_file, false ) );
 
 m_params.emplace_back(new PARAM<bool>( "export_svg.plot_board_edges",
 &m_ExportSvg.plot_board_edges, true ) );
 
 m_params.emplace_back( new PARAM<int>( "export_svg.page_size",
 &m_ExportSvg.page_size, 0 ) );
 
 m_params.emplace_back( new PARAM<wxString>( "export_svg.output_dir",
 &m_ExportSvg.output_dir, "" ) );
 
 m_params.emplace_back( new PARAM_LIST<int>( "export_svg.layers",
 &m_ExportSvg.layers, {} ) );
 
 m_params.emplace_back( new PARAM<int>( "export_vrml.units",
 &m_ExportVrml.units, 1 ) );
 
 m_params.emplace_back( new PARAM<bool>( "export_vrml.copy_3d_models",
 &m_ExportVrml.copy_3d_models, false ) );
 
 m_params.emplace_back( new PARAM<bool>( "export_vrml.use_relative_paths",
 &m_ExportVrml.use_relative_paths, false ) );
 
 m_params.emplace_back( new PARAM<int>( "export_vrml.ref_units",
 &m_ExportVrml.ref_units, 0 ) );
 
 m_params.emplace_back( new PARAM<double>( "export_vrml.ref_x",
 &m_ExportVrml.ref_x, 0 ) );
 
 m_params.emplace_back( new PARAM<double>( "export_vrml.ref_y",
 &m_ExportVrml.ref_y, 0 ) );
 
 m_params.emplace_back( new PARAM<int>( "export_vrml.origin_mode",
 &m_ExportVrml.origin_mode, 0 ) );
 
 m_params.emplace_back( new PARAM<int>( "zones.net_sort_mode",
 &m_Zones.net_sort_mode, -1 ) );
 
 m_params.emplace_back( new PARAM<int>( "import_graphics.layer",
 &m_ImportGraphics.layer, Dwgs_User ) );
 
 m_params.emplace_back( new PARAM<bool>( "import_graphics.interactive_placement",
 &m_ImportGraphics.interactive_placement, true ) );
 
 m_params.emplace_back( new PARAM<int>( "import_graphics.line_width_units",
 &m_ImportGraphics.dxf_line_width_units, 0 ) );
 
 m_params.emplace_back( new PARAM<double>( "import_graphics.line_width",
 &m_ImportGraphics.dxf_line_width, 0.2 ) );
 
 m_params.emplace_back( new PARAM<int>( "import_graphics.origin_units",
 &m_ImportGraphics.origin_units, 0 ) );
 
 m_params.emplace_back( new PARAM<double>( "import_graphics.origin_x",
 &m_ImportGraphics.origin_x, 0 ) );
 
 m_params.emplace_back( new PARAM<double>( "import_graphics.origin_y",
 &m_ImportGraphics.origin_y, 0 ) );
 
 m_params.emplace_back( new PARAM<int>( "import_graphics.dxf_units",
 &m_ImportGraphics.dxf_units, 0 ) );
 
 m_params.emplace_back( new PARAM<int>( "netlist.report_filter",
 &m_NetlistDialog.report_filter, -1 ) );
 
 m_params.emplace_back( new PARAM<bool>( "netlist.update_footprints",
 &m_NetlistDialog.update_footprints, true ) );
 
 m_params.emplace_back( new PARAM<bool>( "netlist.delete_shorting_tracks",
 &m_NetlistDialog.delete_shorting_tracks, false ) );
 
 m_params.emplace_back( new PARAM<bool>( "netlist.delete_extra_footprints",
 &m_NetlistDialog.delete_extra_footprints, false ) );
 
 m_params.emplace_back( new PARAM<bool>( "netlist.associate_by_ref_sch",
 &m_NetlistDialog.associate_by_ref_sch, false ) );
 
 m_params.emplace_back(new PARAM<int>( "place_file.units",
 &m_PlaceFile.units, 1 ) );
 
 m_params.emplace_back( new PARAM<int>( "place_file.file_options",
 &m_PlaceFile.file_options, 0 ) );
 
 m_params.emplace_back( new PARAM<int>( "place_file.file_format",
 &m_PlaceFile.file_format, 0 ) );
 
 m_params.emplace_back( new PARAM<bool>( "place_file.include_board_edge",
 &m_PlaceFile.include_board_edge, false ) );
 
 m_params.emplace_back( new PARAM<bool>( "place_file.use_place_file_origin",
 &m_PlaceFile.use_aux_origin, true ) );
 
 m_params.emplace_back( new PARAM<bool>( "place_file.negate_xcoord",
 &m_PlaceFile.negate_xcoord, false ) );
 
 m_params.emplace_back( new PARAM<int>( "plot.all_layers_on_one_page",
 &m_Plot.all_layers_on_one_page, 1 ) );
 
 m_params.emplace_back( new PARAM<bool>( "plot.edgecut_on_all_layers",
 &m_Plot.edgecut_on_all_layers, true ) );
 
 m_params.emplace_back( new PARAM<int>( "plot.pads_drill_mode",
 &m_Plot.pads_drill_mode, 2 ) );
 
 m_params.emplace_back( new PARAM<double>( "plot.fine_scale_x",
 &m_Plot.fine_scale_x, 0 ) );
 
 m_params.emplace_back( new PARAM<double>( "plot.fine_scale_y",
 &m_Plot.fine_scale_y, 0 ) );
 
 m_params.emplace_back( new PARAM<double>( "plot.ps_fine_width_adjust",
 &m_Plot.ps_fine_width_adjust, 0 ) );
 
 m_params.emplace_back( new PARAM<bool>( "plot.check_zones_before_plotting",
 &m_Plot.check_zones_before_plotting, true ) );
 
 m_params.emplace_back( new PARAM<bool>( "plot.mirror",
 &m_Plot.mirror, false ) );
 
 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>( "footprint_wizard_list.width",
 &m_FootprintWizardList.width, -1 ) );
 
 m_params.emplace_back( new PARAM<int>( "footprint_wizard_list.height",
 &m_FootprintWizardList.height, -1 ) );
 
 m_params.emplace_back( new PARAM<bool>( "reannotate_dialog.annotate_sort_on_modules",
 &m_Reannotate.sort_on_fp_location, true ) );
 m_params.emplace_back( new PARAM<bool>( "reannotate_dialog.annotate_remove_front_prefix",
 &m_Reannotate.remove_front_prefix, false ) );
 m_params.emplace_back( new PARAM<bool>( "reannotate_dialog.annotate_remove_back_prefix",
 &m_Reannotate.remove_back_prefix, false ) );
 m_params.emplace_back( new PARAM<bool>( "reannotate_dialog.annotate_exclude_locked",
 &m_Reannotate.exclude_locked, false ) );
 
 m_params.emplace_back( new PARAM<int>( "reannotate_dialog.annotate_grid_index",
 &m_Reannotate.grid_index, 0 ) );
 m_params.emplace_back( new PARAM<int>( "reannotate_dialog.annotate_sort_code",
 &m_Reannotate.sort_code, 0 ) );
 m_params.emplace_back( new PARAM<int>( "reannotate_dialog.annotate_choice",
 &m_Reannotate.annotation_choice, 0 ) );
 m_params.emplace_back( new PARAM<int>( "reannotate_dialog.annotate_report_severity",
 &m_Reannotate.report_severity, 0 ) );
 
 m_params.emplace_back( new PARAM<wxString>( "reannotate_dialog.annotate_front_refdes_start",
 &m_Reannotate.front_refdes_start, "1" ) );
 m_params.emplace_back( new PARAM<wxString>( "reannotate_dialog.annotate_back_refdes_start",
 &m_Reannotate.back_refdes_start, "" ) );
 m_params.emplace_back( new PARAM<wxString>( "reannotate_dialog.annotate_front_prefix",
 &m_Reannotate.front_prefix, "" ) );
 m_params.emplace_back( new PARAM<wxString>( "reannotate_dialog.annotate_back_prefix",
 &m_Reannotate.back_prefix, "" ) );
 m_params.emplace_back( new PARAM<wxString>( "reannotate_dialog.annotate_exclude_list",
 &m_Reannotate.exclude_list, "" ) );
 m_params.emplace_back( new PARAM<wxString>( "reannotate_dialog.annotate_report_file_name",
 &m_Reannotate.report_file_name, "" ) );
 
 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "action_plugins",
 [&]() -> nlohmann::json
 {
 nlohmann::json js = nlohmann::json::array();
 
 for( const auto& pair : m_VisibleActionPlugins )
 js.push_back( nlohmann::json( { { pair.first.ToUTF8(), pair.second } } ) );
 
 return js;
 },
 [&]( const nlohmann::json& aObj )
 {
 m_VisibleActionPlugins.clear();
 
 if( !aObj.is_array() )
 {
 return;
 }
 
 for( const auto& entry : aObj )
 {
 if( entry.empty() || !entry.is_object() )
 continue;
 
 for( const auto& pair : entry.items() )
 {
 m_VisibleActionPlugins.emplace_back( std::make_pair(
 wxString( pair.key().c_str(), wxConvUTF8 ), pair.value() ) );
 }
 }
 },
 nlohmann::json::array() ) );
 
 addParamsForWindow( &m_FootprintViewer, "footprint_viewer" );
 
 m_params.emplace_back( new PARAM<double>( "footprint_viewer.zoom",
 &m_FootprintViewerZoom, 1.0 ) );
 
 m_params.emplace_back( new PARAM<bool>( "footprint_viewer.autozoom",
 &m_FootprintViewerAutoZoomOnSelect, true ) );
 
 m_params.emplace_back( new PARAM<int>( "footprint_viewer.lib_list_width",
 &m_FootprintViewerLibListWidth, 200 ) );
 
 m_params.emplace_back( new PARAM<int>( "footprint_viewer.fp_list_width",
 &m_FootprintViewerFPListWidth, 300 ) );
 
 addParamsForWindow( &m_FootprintWizard, "footprint_wizard" );
 
 m_params.emplace_back( new PARAM<wxString>( "system.last_footprint_lib_dir",
 &m_lastFootprintLibDir, "" ) );
 
 m_params.emplace_back( new PARAM<wxString>( "system.last_footprint3d_dir",
 &m_lastFootprint3dDir, "" ) );
 
 registerMigration( 0, 1,
 [&]()
 {
 if( std::optional<int> optval = Get<int>( "pcb_display.rotation_angle" ) )
 Set( "editing.rotation_angle", *optval );
 
 try
 {
 At( "pcb_display" ).erase( "rotation_angle" );
 }
 catch( ... )
 {}
 
 return true;
 } );
 
 registerMigration( 1, 2,
 [&]()
 {
 // In version 1 this meant "after Zone Properties dialog", but it now means
 // "everywhere" so we knock it off on transition.
 Set( "editing.auto_fill_zones", false );
 
 return true;
 } );
 
 
 registerMigration( 2, 3,
 [&]() -> 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( 3, 4,
 [&]() -> bool
 {
 // This is actually a migration for APP_SETTINGS_BASE::m_LibTree
 return migrateLibTreeWidth();
 } );
}

◆ ~PCBNEW_SETTINGS()

PCBNEW_SETTINGS::~PCBNEW_SETTINGS ( )

virtualdefault

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, 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 292 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() ) );
 
 int defaultGridIdx;
 
 if( m_filename == "eeschema" || m_filename == "symbol_editor" || m_filename == "pl_editor" )
 defaultGridIdx = 1;
 else
 defaultGridIdx = 4;
 
 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().

◆ 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 EESCHEMA_SETTINGS::migrateBomSettings(), GERBVIEW_SETTINGS::MigrateFromLegacy(), APP_SETTINGS_BASE::migrateLibTreeWidth(), BOARD_DESIGN_SETTINGS::migrateSchema0to1(), FOOTPRINT_EDITOR_SETTINGS::migrateSchema0to1(), COLOR_SETTINGS::migrateSchema0to1(), 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(), BOARD_DESIGN_SETTINGS::migrateSchema0to1(), COLOR_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 FOOTPRINT_EDITOR_SETTINGS::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 367 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 PROJECT_FILE::MigrateFromLegacy(), APP_SETTINGS_BASE::MigrateFromLegacy(), BITMAP2CMP_SETTINGS::MigrateFromLegacy(), EESCHEMA_SETTINGS::MigrateFromLegacy(), SYMBOL_EDITOR_SETTINGS::MigrateFromLegacy(), GERBVIEW_SETTINGS::MigrateFromLegacy(), FOOTPRINT_EDITOR_SETTINGS::MigrateFromLegacy(), COMMON_SETTINGS::MigrateFromLegacy(), PCB_CALCULATOR_SETTINGS::MigrateFromLegacy(), 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 773 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 494 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 271 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(), EESCHEMA_SETTINGS::MigrateFromLegacy(), GERBVIEW_SETTINGS::MigrateFromLegacy(), 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_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 474 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 276 of file json_settings.h.

 {
 return wxEmptyString;
 }

Referenced by JSON_SETTINGS::LoadFromFile().

◆ getLegacyFrameName()

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

inlineoverrideprotectedvirtual

Reimplemented from APP_SETTINGS_BASE.

Definition at line 399 of file pcbnew_settings.h.

399{ return "PcbFrame"; }

Referenced by MigrateFromLegacy().

◆ 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:288

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

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, 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 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, 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() ) )
 {
 wxLogTrace( traceSettings,
 wxT( "%s: migrated; not all settings were found in legacy file" ),
 GetFullFilename() );
 }
 else
 {
 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 );
 
 // 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 )
 {
 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( 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().

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

◆ migrateFindReplace()

void APP_SETTINGS_BASE::migrateFindReplace ( wxConfigBase * aCfg )

protectedinherited

! Migrates the find/replace history string lists

Definition at line 232 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 PCBNEW_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 596 of file pcbnew_settings.cpp.

{
 bool ret = APP_SETTINGS_BASE::MigrateFromLegacy( aCfg );
 
 const std::string f = getLegacyFrameName();
 
 //
 // NOTE: there's no value in line-wrapping these; it just makes the table unreadable.
 //
 ret &= fromLegacy<bool>( aCfg, "ShowLayerManagerTools", "aui.show_layer_manager" );
 
 ret &= fromLegacy<int>( aCfg, "FootprintChooserHSashPosition", "footprint_chooser.sash_h" );
 ret &= fromLegacy<int>( aCfg, "FootprintChooserVSashPosition", "footprint_chooser.sash_v" );
 ret &= fromLegacy<int>( aCfg, "FootprintChooserWidth", "footprint_chooser.width" );
 ret &= fromLegacy<int>( aCfg, "FootprintChooserHeight", "footprint_chooser.height" );
 
 ret &= fromLegacy<bool>( aCfg, "FlipLeftRight", "editing.flip_left_right" );
 ret &= fromLegacy<bool>( aCfg, "MagneticGraphics", "editing.magnetic_graphics" );
 ret &= fromLegacy<int>( aCfg, "MagneticPads", "editing.magnetic_pads" );
 ret &= fromLegacy<int>( aCfg, "MagneticTracks", "editing.magnetic_tracks" );
 ret &= fromLegacy<bool>( aCfg, "DisplayPolarCoords", "editing.polar_coords" );
 ret &= fromLegacy<bool>( aCfg, "Use45DegreeGraphicSegments", "editing.use_45_degree_graphic_segments" );
 
 ret &= fromLegacy<bool>( aCfg, "PcbAffT", "pcb_display.graphic_items_fill" );
 ret &= fromLegacy<int>( aCfg, "MaxLnkS", "pcb_display.max_links_shown" );
 ret &= fromLegacy<bool>( aCfg, "ModAffC", "pcb_display.footprint_edge_fill" );
 ret &= fromLegacy<bool>( aCfg, "ModAffT", "pcb_display.footprint_text_fill" );
 ret &= fromLegacy<int>( aCfg, "ShowNetNamesMode", "pcb_display.net_names_mode" );
 ret &= fromLegacy<int>( aCfg, "PcbDisplayOrigin", "pcb_display.origin_mode" );
 ret &= fromLegacy<bool>( aCfg, "PcbInvertXAxis", "pcb_display.origin_invert_x_axis" );
 ret &= fromLegacy<bool>( aCfg, "PcbInvertYAxis", "pcb_display.origin_invert_y_axis" );
 ret &= fromLegacy<bool>( aCfg, "PadAffG", "pcb_display.pad_clearance" );
 ret &= fromLegacy<bool>( aCfg, "PadFill", "pcb_display.pad_fill" );
 ret &= fromLegacy<bool>( aCfg, "PadSNum", "pcb_display.pad_numbers" );
 ret &= fromLegacy<bool>( aCfg, "ShowRatsnestLines", "pcb_display.ratsnest_global" );
 ret &= fromLegacy<bool>( aCfg, "ShowRatsnestModuleLines", "pcb_display.ratsnest_footprint" );
 ret &= fromLegacy<bool>( aCfg, "CurvedRatsnestLines", "pcb_display.ratsnest_curved" );
 ret &= fromLegacy<int>( aCfg, "RotationAngle", "pcb_display.rotation_angle" );
 ret &= fromLegacy<int>( aCfg, "TrackDisplayClearance", "pcb_display.track_clearance_mode" );
 ret &= fromLegacy<bool>( aCfg, "DisplayTrackFilled", "pcb_display.track_fill" );
 ret &= fromLegacy<bool>( aCfg, "ViaFill", "pcb_display.via_fill" );
 ret &= fromLegacy<int>( aCfg, "PcbShowZonesMode", "pcb_display.zone_mode" );
 
 ret &= fromLegacy<double>( aCfg, "PlotLineWidth_mm", "plot.line_width" );
 
 aCfg->SetPath( "/dialogs/cleanup_tracks" );
 ret &= fromLegacy<bool>( aCfg, "DialogCleanupVias", "cleanup.cleanup_vias" );
 ret &= fromLegacy<bool>( aCfg, "DialogCleanupMergeSegments", "cleanup.merge_segments" );
 ret &= fromLegacy<bool>( aCfg, "DialogCleanupUnconnected", "cleanup.cleanup_unconnected" );
 ret &= fromLegacy<bool>( aCfg, "DialogCleanupShortCircuit", "cleanup.cleanup_short_circuits" );
 ret &= fromLegacy<bool>( aCfg, "DialogCleanupTracksInPads", "cleanup.cleanup_tracks_in_pad" );
 aCfg->SetPath( "../.." );
 
 ret &= fromLegacy<bool>( aCfg, "RefillZonesBeforeDrc", "drc_dialog.refill_zones" );
 ret &= fromLegacy<bool>( aCfg, "DrcTestFootprints", "drc_dialog.test_footprints" );
 
 ret &= fromLegacy<bool>( aCfg, "DrillMergePTHNPTH", "gen_drill.merge_pth_npth" );
 ret &= fromLegacy<bool>( aCfg, "DrillMinHeader", "gen_drill.minimal_header" );
 ret &= fromLegacy<bool>( aCfg, "DrillMirrorYOpt", "gen_drill.mirror" );
 ret &= fromLegacy<bool>( aCfg, "DrillUnit", "gen_drill.unit_drill_is_inch" );
 ret &= fromLegacy<bool>( aCfg, "OvalHolesRouteMode", "gen_drill.use_route_for_oval_holes" );
 ret &= fromLegacy<int>( aCfg, "DrillFileType", "gen_drill.drill_file_type" );
 ret &= fromLegacy<int>( aCfg, "DrillMapFileType", "gen_drill.map_file_type" );
 ret &= fromLegacy<int>( aCfg, "DrillZerosFormat", "gen_drill.zeros_format" );
 
 ret &= fromLegacy<bool>( aCfg, "IDFRefAutoAdj", "export_idf.auto_adjust" );
 ret &= fromLegacy<int>( aCfg, "IDFRefUnits", "export_idf.ref_units" );
 ret &= fromLegacy<double>( aCfg, "IDFRefX", "export_idf.ref_x" );
 ret &= fromLegacy<double>( aCfg, "IDFRefY", "export_idf.ref_y" );
 ret &= fromLegacy<bool>( aCfg, "IDFExportThou", "export_idf.units_mils" );
 
 ret &= fromLegacy<int>( aCfg, "STEP_Origin_Opt", "export_step.origin_mode" );
 ret &= fromLegacy<int>( aCfg, "STEP_UserOriginUnits", "export_step.origin_units" );
 ret &= fromLegacy<double>( aCfg, "STEP_UserOriginX", "export_step.origin_x" );
 ret &= fromLegacy<double>( aCfg, "STEP_UserOriginY", "export_step.origin_y" );
 ret &= fromLegacy<bool>( aCfg, "STEP_NoVirtual", "export_step.no_virtual" );
 
 ret &= fromLegacy<bool>( aCfg, "PlotSVGModeColor", "export_svg.black_and_white" );
 ret &= fromLegacy<bool>( aCfg, "PlotSVGModeMirror", "export_svg.mirror" );
 ret &= fromLegacy<bool>( aCfg, "PlotSVGModeOneFile", "export_svg.one_file" );
 ret &= fromLegacy<bool>( aCfg, "PlotSVGBrdEdge", "export_svg.plot_board_edges" );
 ret &= fromLegacy<int>( aCfg, "PlotSVGPageOpt", "export_svg.page_size" );
 ret &= fromLegacyString( aCfg, "PlotSVGDirectory", "export_svg.output_dir" );
 
 {
 nlohmann::json js = nlohmann::json::array();
 wxString key;
 bool val = false;
 
 for( unsigned i = 0; i < PCB_LAYER_ID_COUNT; ++i )
 {
 key.Printf( wxT( "PlotSVGLayer_%d" ), i );
 
 if( aCfg->Read( key, &val ) && val )
 js.push_back( i );
 }
 
 Set( "export_svg.layers", js );
 }
 
 {
 nlohmann::json js = nlohmann::json::array();
 
 wxString packed;
 
 if( aCfg->Read( "ActionPluginButtons", &packed ) )
 {
 wxStringTokenizer pluginSettingsTokenizer = wxStringTokenizer( packed, ";" );
 
 while( pluginSettingsTokenizer.HasMoreTokens() )
 {
 nlohmann::json row;
 wxString plugin = pluginSettingsTokenizer.GetNextToken();
 wxStringTokenizer pluginTokenizer = wxStringTokenizer( plugin, "=" );
 
 if( pluginTokenizer.CountTokens() != 2 )
 {
 // Bad config
 continue;
 }
 
 std::string key( pluginTokenizer.GetNextToken().ToUTF8() );
 bool value( pluginTokenizer.GetNextToken().Cmp( wxT( "Visible" ) ) == 0 );
 
 js.push_back( nlohmann::json( { { key, value } } ) );
 }
 }
 
 Set( "action_plugins", js );
 }
 
 //
 // NOTE: there's no value in line-wrapping these; it just makes the table unreadable.
 //
 ret &= fromLegacy<int>( aCfg, "VrmlExportUnit", "export_vrml.units" );
 ret &= fromLegacy<bool>( aCfg, "VrmlExportCopyFiles", "export_vrml.copy_3d_models" );
 ret &= fromLegacy<bool>( aCfg, "VrmlUseRelativePaths", "export_vrml.use_relative_paths" );
 ret &= fromLegacy<int>( aCfg, "VrmlRefUnits", "export_vrml.ref_units" );
 ret &= fromLegacy<double>( aCfg, "VrmlRefX", "export_vrml.ref_x" );
 ret &= fromLegacy<double>( aCfg, "VrmlRefY", "export_vrml.ref_y" );
 ret &= fromLegacy<int> ( aCfg, "VrmlOriginMode", "export_vrml.origin_mode" );
 
 ret &= fromLegacy<int>( aCfg, "Zone_Ouline_Hatch_Opt", "zones.hatching_style" );
 ret &= fromLegacy<int>( aCfg, "Zone_NetSort_Opt", "zones.net_sort_mode" );
 ret &= fromLegacy<double>( aCfg, "Zone_Clearance", "zones.clearance" );
 ret &= fromLegacy<double>( aCfg, "Zone_Thickness", "zones.min_thickness" );
 ret &= fromLegacy<double>( aCfg, "Zone_TH_Gap", "zones.thermal_relief_gap" );
 ret &= fromLegacy<double>( aCfg, "Zone_TH_Copper_Width", "zones.thermal_relief_copper_width" );
 
 aCfg->SetPath( "ImportGraphics" );
 ret &= fromLegacy<int>( aCfg, "BoardLayer", "import_graphics.layer" );
 ret &= fromLegacy<bool>( aCfg, "InteractivePlacement", "import_graphics.interactive_placement" );
 ret &= fromLegacyString( aCfg, "LastFile", "import_graphics.last_file" );
 ret &= fromLegacy<double>( aCfg, "LineWidth", "import_graphics.line_width" );
 ret &= fromLegacy<int>( aCfg, "LineWidthUnits", "import_graphics.line_width_units" );
 ret &= fromLegacy<int>( aCfg, "PositionUnits", "import_graphics.origin_units" );
 ret &= fromLegacy<double>( aCfg, "PositionX", "import_graphics.origin_x" );
 ret &= fromLegacy<double>( aCfg, "PositionY", "import_graphics.origin_y" );
 aCfg->SetPath( ".." );
 
 ret &= fromLegacy<int>( aCfg, "NetlistReportFilterMsg", "netlist.report_filter" );
 ret &= fromLegacy<bool>( aCfg, "NetlistUpdateFootprints", "netlist.update_footprints" );
 ret &= fromLegacy<bool>( aCfg, "NetlistDeleteShortingTracks", "netlist.delete_shorting_tracks" );
 ret &= fromLegacy<bool>( aCfg, "NetlistDeleteExtraFootprints", "netlist.delete_extra_footprints" );
 
 ret &= fromLegacy<int>( aCfg, "PlaceFileUnits", "place_file.units" );
 ret &= fromLegacy<int>( aCfg, "PlaceFileOpts", "place_file.file_options" );
 ret &= fromLegacy<int>( aCfg, "PlaceFileFormat", "place_file.file_format" );
 ret &= fromLegacy<bool>( aCfg, "PlaceFileIncludeBrdEdge", "place_file.include_board_edge" );
 
 ret &= fromLegacy<int>( aCfg, "PrintSinglePage", "plot.all_layers_on_one_page" );
 ret &= fromLegacy<int>( aCfg, "PrintPadsDrillOpt", "plot.pads_drill_mode" );
 ret &= fromLegacy<double>( aCfg, "PlotXFineScaleAdj", "plot.fine_scale_x" );
 ret &= fromLegacy<double>( aCfg, "PlotYFineScaleAdj", "plot.fine_scale_y" );
 ret &= fromLegacy<double>( aCfg, "PSPlotFineWidthAdj", "plot.ps_fine_width_adjust" );
 ret &= fromLegacy<bool>( aCfg, "CheckZonesBeforePlotting", "plot.check_zones_before_plotting" );
 
 ret &= fromLegacyString( aCfg, "FootprintTextShownColumns", "window.footprint_text_shown_columns" );
 
 ret &= fromLegacy<int>( aCfg, "FpWizardListWidth", "footprint_wizard_list.width" );
 ret &= fromLegacy<int>( aCfg, "FpWizardListHeight", "footprint_wizard_list.height" );
 
 migrateWindowConfig( aCfg, "ModViewFrame", "footprint_viewer" );
 
 ret &= fromLegacy<bool>( aCfg, "ModViewFrameAutoZoom", "footprint_viewer.auto_zoom" );
 ret &= fromLegacy<double>( aCfg, "ModViewFrameZoom", "footprint_viewer.zoom" );
 
 migrateWindowConfig( aCfg, "FootprintWizard", "footprint_wizard" );
 ret &= fromLegacyString( aCfg, "Fpwizard_auiPerspective", "footprint_wizard.perspective" );
 
 
 const std::string p = "pcbnew.InteractiveRouter.";
 
 Set( "tools.pns.meta", nlohmann::json( {
 { "filename", "pns" },
 { "version", 0 }
 } ) );
 
 ret &= fromLegacy<int>( aCfg, p + "Mode", "tools.pns.mode" );
 ret &= fromLegacy<int>( aCfg, p + "OptimizerEffort", "tools.pns.effort" );
 ret &= fromLegacy<bool>( aCfg, p + "RemoveLoops", "tools.pns.remove_loops" );
 ret &= fromLegacy<bool>( aCfg, p + "SmartPads", "tools.pns.smart_pads" );
 ret &= fromLegacy<bool>( aCfg, p + "ShoveVias", "tools.pns.shove_vias" );
 ret &= fromLegacy<bool>( aCfg, p + "StartDiagonal", "tools.pns.start_diagonal" );
 ret &= fromLegacy<int>( aCfg, p + "ShoveTimeLimit", "tools.pns.shove_time_limit" );
 ret &= fromLegacy<int>( aCfg, p + "ShoveIterationLimit", "tools.pns.shove_iteration_limit" );
 ret &= fromLegacy<int>( aCfg, p + "WalkaroundIterationLimit", "tools.pns.walkaround_iteration_limit" );
 ret &= fromLegacy<bool>( aCfg, p + "JumpOverObstacles", "tools.pns.jump_over_obstacles" );
 ret &= fromLegacy<bool>( aCfg, p + "SmoothDraggedSegments", "tools.pns.smooth_dragged_segments" );
 ret &= fromLegacy<bool>( aCfg, p + "CanViolateDRC", "tools.pns.can_violate_drc" );
 ret &= fromLegacy<bool>( aCfg, p + "SuggestFinish", "tools.pns.suggest_finish" );
 ret &= fromLegacy<bool>( aCfg, p + "FreeAngleMode", "tools.pns.free_angle_mode" );
 ret &= fromLegacy<bool>( aCfg, p + "InlineDragEnabled", "editing.track_drag_action" );
 
 // Initialize some new PNS settings to legacy behaviors if coming from legacy
 Set( "tools.pns.fix_all_segments", false );
 
 // Migrate color settings that were stored in the pcbnew config file
 
 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 ) );
 };
 
 for( int i = 0; i < PCB_LAYER_ID_COUNT; ++i )
 {
 wxString layer = LSET::Name( PCB_LAYER_ID( i ) );
 migrateLegacyColor( "Color4DPCBLayer_" + layer.ToStdString(), PCB_LAYER_ID( i ) );
 }
 
 migrateLegacyColor( "Color4DAnchorEx", LAYER_ANCHOR );
 migrateLegacyColor( "Color4DAuxItems", LAYER_AUX_ITEMS );
 migrateLegacyColor( "Color4DGrid", LAYER_GRID );
 migrateLegacyColor( "Color4DNonPlatedEx", LAYER_NON_PLATEDHOLES );
 migrateLegacyColor( "Color4DPadThruHoleEx", LAYER_PADS_TH );
 migrateLegacyColor( "Color4DPCBBackground", LAYER_PCB_BACKGROUND );
 migrateLegacyColor( "Color4DPCBCursor", LAYER_CURSOR );
 migrateLegacyColor( "Color4DRatsEx", LAYER_RATSNEST );
 migrateLegacyColor( "Color4DTxtInvisEx", LAYER_MOD_TEXT_INVISIBLE );
 migrateLegacyColor( "Color4DViaBBlindEx", LAYER_VIA_BBLIND );
 migrateLegacyColor( "Color4DViaMicroEx", LAYER_VIA_MICROVIA );
 migrateLegacyColor( "Color4DViaThruEx", LAYER_VIA_THROUGH );
 migrateLegacyColor( "Color4DWorksheet", LAYER_DRAWINGSHEET );
 migrateLegacyColor( "Color4DGrid", LAYER_PAGE_LIMITS );
 
 Pgm().GetSettingsManager().SaveColorSettings( cs, "board" );
 
 Set( "appearance.color_theme", cs->GetFilename() );
 
 double x, y;
 
 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 = EDA_UNIT_UTILS::UI::FromUserUnit( pcbIUScale, u, x );
 y = EDA_UNIT_UTILS::UI::FromUserUnit( pcbIUScale, u, y );
 
 Set( "window.grid.user_grid_x", EDA_UNIT_UTILS::UI::StringFromValue( pcbIUScale, u, x ) );
 Set( "window.grid.user_grid_y", EDA_UNIT_UTILS::UI::StringFromValue( pcbIUScale, u, y ) );
 }
 
 // Footprint editor settings were stored in pcbnew config file. Migrate them here.
 auto fpedit = Pgm().GetSettingsManager().GetAppSettings<FOOTPRINT_EDITOR_SETTINGS>( false );
 fpedit->MigrateFromLegacy( aCfg );
 fpedit->Load();
 
 // Same with 3D viewer
 auto viewer3d = Pgm().GetSettingsManager().GetAppSettings<EDA_3D_VIEWER_SETTINGS>( false );
 viewer3d->MigrateFromLegacy( aCfg );
 viewer3d->Load();
 
 return ret;
}

References JSON_SETTINGS::fromLegacyString(), EDA_UNIT_UTILS::UI::FromUserUnit(), JSON_SETTINGS::GetFilename(), getLegacyFrameName(), INCHES, LAYER_ANCHOR, LAYER_AUX_ITEMS, LAYER_CURSOR, LAYER_DRAWINGSHEET, LAYER_GRID, LAYER_MOD_TEXT_INVISIBLE, LAYER_NON_PLATEDHOLES, LAYER_PADS_TH, LAYER_PAGE_LIMITS, LAYER_PCB_BACKGROUND, LAYER_RATSNEST, LAYER_VIA_BBLIND, LAYER_VIA_MICROVIA, LAYER_VIA_THROUGH, APP_SETTINGS_BASE::MigrateFromLegacy(), EDA_3D_VIEWER_SETTINGS::MigrateFromLegacy(), FOOTPRINT_EDITOR_SETTINGS::MigrateFromLegacy(), APP_SETTINGS_BASE::migrateWindowConfig(), LSET::Name(), PCB_LAYER_ID_COUNT, pcbIUScale, Pgm(), JSON_SETTINGS::Set(), COLOR_SETTINGS::SetColor(), and EDA_UNIT_UTILS::UI::StringFromValue().

◆ migrateLibTreeWidth()

bool APP_SETTINGS_BASE::migrateLibTreeWidth ( )

protectedinherited

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

Definition at line 394 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::EESCHEMA_SETTINGS(), FOOTPRINT_EDITOR_SETTINGS::FOOTPRINT_EDITOR_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 256 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 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::FOOTPRINT_EDITOR_SETTINGS(), NET_SETTINGS::NET_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 750 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;
 
 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, 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 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

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

◆ 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 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::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 192 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_AllowFreePads

bool PCBNEW_SETTINGS::m_AllowFreePads

Definition at line 378 of file pcbnew_settings.h.

Referenced by EDIT_TOOL::doMoveSelection(), PANEL_EDIT_OPTIONS::loadPCBSettings(), PCBNEW_SETTINGS(), EDIT_TOOL::Remove(), EDIT_TOOL::Rotate(), and PANEL_EDIT_OPTIONS::TransferDataFromWindow().

◆ m_appSettingsSchemaVersion

int APP_SETTINGS_BASE::m_appSettingsSchemaVersion

inherited

! Local schema version for common app settings

Definition at line 190 of file app_settings.h.

◆ m_AuiPanels

AUI_PANELS PCBNEW_SETTINGS::m_AuiPanels

Definition at line 319 of file pcbnew_settings.h.

Referenced by PCB_EDIT_FRAME::LoadSettings(), PCBNEW_SETTINGS(), PCB_EDIT_FRAME::SaveSettings(), and PCB_EDIT_FRAME::ToggleLayersManager().

◆ m_AutoRefillZones

bool PCBNEW_SETTINGS::m_AutoRefillZones

Definition at line 376 of file pcbnew_settings.h.

Referenced by PANEL_EDIT_OPTIONS::loadPCBSettings(), PCBNEW_SETTINGS(), BOARD_COMMIT::Push(), and PANEL_EDIT_OPTIONS::TransferDataFromWindow().

◆ m_Cleanup

DIALOG_CLEANUP PCBNEW_SETTINGS::m_Cleanup

Definition at line 321 of file pcbnew_settings.h.

Referenced by PCBNEW_SETTINGS(), and DIALOG_CLEANUP_TRACKS_AND_VIAS::~DIALOG_CLEANUP_TRACKS_AND_VIAS().

◆ m_ColorPicker

COLOR_PICKER APP_SETTINGS_BASE::m_ColorPicker

inherited

Definition at line 176 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 187 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 303 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 297 of file json_settings.h.

Referenced by JSON_SETTINGS::SaveToFile().

◆ m_CrossProbing

CROSS_PROBING_SETTINGS APP_SETTINGS_BASE::m_CrossProbing

inherited

Definition at line 170 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_CtrlClickHighlight

bool PCBNEW_SETTINGS::m_CtrlClickHighlight

Definition at line 361 of file pcbnew_settings.h.

Referenced by PCB_SELECTION_TOOL::ctrlClickHighlights(), PANEL_EDIT_OPTIONS::loadPCBSettings(), PCBNEW_SETTINGS(), and PANEL_EDIT_OPTIONS::TransferDataFromWindow().

◆ m_deleteLegacyAfterMigration

bool JSON_SETTINGS::m_deleteLegacyAfterMigration

protectedinherited

Whether or not to delete legacy file after migration.

Definition at line 309 of file json_settings.h.

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

◆ m_Display

DISPLAY_OPTIONS PCBNEW_SETTINGS::m_Display

Definition at line 355 of file pcbnew_settings.h.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), BOARD_NETLIST_UPDATER::addNewFootprint(), PCB_TOOL_BASE::displayOptions(), PCB_VIEWER_TOOLS::displayOptions(), BOARD_EDITOR_CONTROL::doCrossProbePcbToSch(), EDIT_TOOL::doMoveSelection(), KIGFX::PCB_PAINTER::draw(), BOARD_INSPECTION_TOOL::HighlightItem(), PCB_ORIGIN_TRANSFORMS::invertXAxis(), PCB_ORIGIN_TRANSFORMS::invertYAxis(), PANEL_DISPLAY_OPTIONS::loadPCBSettings(), PANEL_EDIT_OPTIONS::loadPCBSettings(), PANEL_PCBNEW_DISPLAY_ORIGIN::loadPCBSettings(), DIALOG_DRC::OnDRCItemSelected(), APPEARANCE_CONTROLS::onObjectVisibilityChanged(), APPEARANCE_CONTROLS::onRatsnestMode(), PCBNEW_SETTINGS(), BOARD_EDITOR_CONTROL::PlaceFootprint(), BOARD_COMMIT::Push(), PCB_EDIT_FRAME::redrawNetnames(), PCB_EDIT_FRAME::setupUIConditions(), APPEARANCE_CONTROLS::setVisibleObjects(), PCB_EDIT_FRAME::ShowBoardSetupDialog(), PCB_EDITOR_CONDITIONS::trackFillDisplayFunc(), PANEL_DISPLAY_OPTIONS::TransferDataFromWindow(), PANEL_EDIT_OPTIONS::TransferDataFromWindow(), PANEL_PCBNEW_DISPLAY_ORIGIN::TransferDataFromWindow(), APPEARANCE_CONTROLS::UpdateDisplayOptions(), and PCB_EDITOR_CONDITIONS::viaFillDisplayFunc().

◆ m_DrcDialog

DIALOG_DRC PCBNEW_SETTINGS::m_DrcDialog

Definition at line 323 of file pcbnew_settings.h.

Referenced by DIALOG_DRC::DIALOG_DRC(), PCBNEW_SETTINGS(), and DIALOG_DRC::~DIALOG_DRC().

◆ m_ESCClearsNetHighlight

bool PCBNEW_SETTINGS::m_ESCClearsNetHighlight

Definition at line 367 of file pcbnew_settings.h.

Referenced by PANEL_EDIT_OPTIONS::loadPCBSettings(), PCB_SELECTION_TOOL::Main(), PCBNEW_SETTINGS(), and PANEL_EDIT_OPTIONS::TransferDataFromWindow().

◆ m_ExportIdf

DIALOG_EXPORT_IDF PCBNEW_SETTINGS::m_ExportIdf

Definition at line 325 of file pcbnew_settings.h.

Referenced by PCBNEW_SETTINGS(), and DIALOG_EXPORT_IDF3::~DIALOG_EXPORT_IDF3().

◆ m_ExportStep

DIALOG_EXPORT_STEP PCBNEW_SETTINGS::m_ExportStep

Definition at line 327 of file pcbnew_settings.h.

Referenced by DIALOG_EXPORT_STEP::DIALOG_EXPORT_STEP(), PCBNEW_SETTINGS(), and DIALOG_EXPORT_STEP::~DIALOG_EXPORT_STEP().

◆ m_ExportSvg

DIALOG_EXPORT_SVG PCBNEW_SETTINGS::m_ExportSvg

Definition at line 329 of file pcbnew_settings.h.

Referenced by DIALOG_EXPORT_SVG::initDialog(), DIALOG_EXPORT_SVG::onPagePerLayerClicked(), PCBNEW_SETTINGS(), and DIALOG_EXPORT_SVG::~DIALOG_EXPORT_SVG().

◆ m_ExportVrml

DIALOG_EXPORT_VRML PCBNEW_SETTINGS::m_ExportVrml

Definition at line 331 of file pcbnew_settings.h.

Referenced by DIALOG_EXPORT_3DFILE::DIALOG_EXPORT_3DFILE(), PCBNEW_SETTINGS(), and DIALOG_EXPORT_3DFILE::~DIALOG_EXPORT_3DFILE().

◆ m_filename

wxString JSON_SETTINGS::m_filename

protectedinherited

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

Definition at line 282 of file json_settings.h.

Referenced by APP_SETTINGS_BASE::addParamsForWindow(), 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 172 of file app_settings.h.

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

◆ m_FlipLeftRight

bool PCBNEW_SETTINGS::m_FlipLeftRight

Definition at line 365 of file pcbnew_settings.h.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), EDIT_TOOL::Flip(), PCB_PLUGIN::FootprintSave(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), PANEL_EDIT_OPTIONS::loadPCBSettings(), PCBNEW_SETTINGS(), BOARD_EDITOR_CONTROL::PlaceFootprint(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow(), and PANEL_EDIT_OPTIONS::TransferDataFromWindow().

◆ m_FootprintChooser

FOOTPRINT_CHOOSER PCBNEW_SETTINGS::m_FootprintChooser

Definition at line 347 of file pcbnew_settings.h.

Referenced by DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), PCBNEW_SETTINGS(), and DIALOG_CHOOSE_FOOTPRINT::~DIALOG_CHOOSE_FOOTPRINT().

◆ m_FootprintTextShownColumns

wxString PCBNEW_SETTINGS::m_FootprintTextShownColumns

Definition at line 382 of file pcbnew_settings.h.

Referenced by DIALOG_FOOTPRINT_PROPERTIES::DIALOG_FOOTPRINT_PROPERTIES(), PCBNEW_SETTINGS(), and DIALOG_FOOTPRINT_PROPERTIES::~DIALOG_FOOTPRINT_PROPERTIES().

◆ m_FootprintViewer

WINDOW_SETTINGS PCBNEW_SETTINGS::m_FootprintViewer

Definition at line 351 of file pcbnew_settings.h.

Referenced by FOOTPRINT_VIEWER_FRAME::GetWindowSettings(), FOOTPRINT_VIEWER_FRAME::LoadSettings(), FOOTPRINT_WIZARD_FRAME::LoadSettings(), PCBNEW_SETTINGS(), and FOOTPRINT_WIZARD_FRAME::SaveSettings().

◆ m_FootprintViewerAutoZoomOnSelect

bool PCBNEW_SETTINGS::m_FootprintViewerAutoZoomOnSelect

true to use automatic zoom on fp selection

Definition at line 387 of file pcbnew_settings.h.

Referenced by PCBNEW_SETTINGS(), and FOOTPRINT_VIEWER_FRAME::SaveSettings().

◆ m_FootprintViewerFPListWidth

int PCBNEW_SETTINGS::m_FootprintViewerFPListWidth

Definition at line 389 of file pcbnew_settings.h.

Referenced by FOOTPRINT_VIEWER_FRAME::LoadSettings(), PCBNEW_SETTINGS(), and FOOTPRINT_VIEWER_FRAME::SaveSettings().

◆ m_FootprintViewerLibListWidth

int PCBNEW_SETTINGS::m_FootprintViewerLibListWidth

Definition at line 388 of file pcbnew_settings.h.

Referenced by FOOTPRINT_VIEWER_FRAME::LoadSettings(), PCBNEW_SETTINGS(), and FOOTPRINT_VIEWER_FRAME::SaveSettings().

◆ m_FootprintViewerZoom

double PCBNEW_SETTINGS::m_FootprintViewerZoom

The last zoom level used (0 for auto)

Definition at line 386 of file pcbnew_settings.h.

Referenced by PCBNEW_SETTINGS(), and FOOTPRINT_VIEWER_FRAME::SaveSettings().

◆ m_FootprintWizard

WINDOW_SETTINGS PCBNEW_SETTINGS::m_FootprintWizard

Definition at line 353 of file pcbnew_settings.h.

Referenced by PCBNEW_SETTINGS().

◆ m_FootprintWizardList

DIALOG_FOOTPRINT_WIZARD_LIST PCBNEW_SETTINGS::m_FootprintWizardList

Definition at line 333 of file pcbnew_settings.h.

Referenced by DIALOG_FOOTPRINT_WIZARD_LIST::DIALOG_FOOTPRINT_WIZARD_LIST(), PCBNEW_SETTINGS(), and DIALOG_FOOTPRINT_WIZARD_LIST::~DIALOG_FOOTPRINT_WIZARD_LIST().

◆ m_GenDrill

DIALOG_GENERATE_DRILL PCBNEW_SETTINGS::m_GenDrill

Definition at line 335 of file pcbnew_settings.h.

Referenced by PCBNEW_SETTINGS(), and DIALOG_GENDRILL::UpdateConfig().

◆ m_Graphics

GRAPHICS APP_SETTINGS_BASE::m_Graphics

inherited

Definition at line 174 of file app_settings.h.

Referenced by APP_SETTINGS_BASE::APP_SETTINGS_BASE(), EDA_DRAW_FRAME::CommonSettingsChanged(), 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_ImportGraphics

DIALOG_IMPORT_GRAPHICS PCBNEW_SETTINGS::m_ImportGraphics

Definition at line 337 of file pcbnew_settings.h.

Referenced by DIALOG_IMPORT_GFX::DIALOG_IMPORT_GFX(), PCBNEW_SETTINGS(), and DIALOG_IMPORT_GFX::~DIALOG_IMPORT_GFX().

◆ m_internals

std::unique_ptr<JSON_SETTINGS_INTERNALS> JSON_SETTINGS::m_internals

protectedinherited

◆ m_lastFootprint3dDir

wxString PCBNEW_SETTINGS::m_lastFootprint3dDir

Definition at line 393 of file pcbnew_settings.h.

Referenced by PANEL_FP_PROPERTIES_3D_MODEL::PANEL_FP_PROPERTIES_3D_MODEL(), and PCBNEW_SETTINGS().

◆ m_lastFootprintLibDir

wxString PCBNEW_SETTINGS::m_lastFootprintLibDir

Definition at line 391 of file pcbnew_settings.h.

Referenced by PANEL_FP_LIB_TABLE::browseLibrariesHandler(), PANEL_FP_LIB_TABLE::PANEL_FP_LIB_TABLE(), and PCBNEW_SETTINGS().

◆ 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 285 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 178 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_location

SETTINGS_LOC JSON_SETTINGS::m_location

protectedinherited

The location of this settings file (.

See also: SETTINGS_LOC)

Definition at line 288 of file json_settings.h.

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

◆ m_MagneticItems

MAGNETIC_SETTINGS PCBNEW_SETTINGS::m_MagneticItems

Definition at line 357 of file pcbnew_settings.h.

Referenced by PCB_BASE_FRAME::GetMagneticItemsSettings(), PANEL_EDIT_OPTIONS::loadPCBSettings(), PCBNEW_SETTINGS(), and PANEL_EDIT_OPTIONS::TransferDataFromWindow().

◆ m_manager

SETTINGS_MANAGER* JSON_SETTINGS::m_manager

protectedinherited

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

Definition at line 318 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 321 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 294 of file json_settings.h.

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

◆ m_NetlistDialog

DIALOG_NETLIST PCBNEW_SETTINGS::m_NetlistDialog

Definition at line 339 of file pcbnew_settings.h.

Referenced by PCBNEW_SETTINGS(), DIALOG_NETLIST_IMPORT::~DIALOG_NETLIST_IMPORT(), and DIALOG_UPDATE_PCB::~DIALOG_UPDATE_PCB().

◆ m_params

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

protectedinherited

The list of parameters (owned by this object)

Definition at line 291 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::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(), 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_PlaceFile

DIALOG_PLACE_FILE PCBNEW_SETTINGS::m_PlaceFile

Definition at line 341 of file pcbnew_settings.h.

Referenced by DIALOG_GEN_FOOTPRINT_POSITION::initDialog(), and PCBNEW_SETTINGS().

◆ m_Plot

DIALOG_PLOT PCBNEW_SETTINGS::m_Plot

Definition at line 343 of file pcbnew_settings.h.

Referenced by DIALOG_PLOT::applyPlotSettings(), and PCBNEW_SETTINGS().

◆ m_PnsSettings

std::unique_ptr<PNS::ROUTING_SETTINGS> PCBNEW_SETTINGS::m_PnsSettings

Definition at line 384 of file pcbnew_settings.h.

Referenced by PNS::TOOL_BASE::Reset().

◆ m_PolarCoords

bool PCBNEW_SETTINGS::m_PolarCoords

Definition at line 369 of file pcbnew_settings.h.

Referenced by PCB_BASE_FRAME::LoadSettings(), PCBNEW_SETTINGS(), and PCB_BASE_FRAME::SaveSettings().

◆ m_Printing

PRINTING APP_SETTINGS_BASE::m_Printing

inherited

Definition at line 180 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::OnMonochromeChecked(), 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_Reannotate

DIALOG_REANNOTATE PCBNEW_SETTINGS::m_Reannotate

Definition at line 345 of file pcbnew_settings.h.

Referenced by DIALOG_BOARD_REANNOTATE::InitValues(), PCBNEW_SETTINGS(), and DIALOG_BOARD_REANNOTATE::~DIALOG_BOARD_REANNOTATE().

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

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

◆ m_RotationAngle

EDA_ANGLE PCBNEW_SETTINGS::m_RotationAngle

Definition at line 371 of file pcbnew_settings.h.

Referenced by PCB_EDIT_FRAME::GetRotationAngle(), PANEL_EDIT_OPTIONS::loadPCBSettings(), PCBNEW_SETTINGS(), and PANEL_EDIT_OPTIONS::TransferDataFromWindow().

◆ m_schemaVersion

int JSON_SETTINGS::m_schemaVersion

protectedinherited

Version of this settings schema.

Definition at line 315 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_ShowPageLimits

bool PCBNEW_SETTINGS::m_ShowPageLimits

Todo:: Implement real auto zone filling (not just after zone properties are edited)

Definition at line 373 of file pcbnew_settings.h.

Referenced by KIGFX::PCB_RENDER_SETTINGS::GetShowPageLimits(), PANEL_EDIT_OPTIONS::loadPCBSettings(), PCBNEW_SETTINGS(), and PANEL_EDIT_OPTIONS::TransferDataFromWindow().

◆ m_System

SYSTEM APP_SETTINGS_BASE::m_System

inherited

Definition at line 182 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_TrackDragAction

TRACK_DRAG_ACTION PCBNEW_SETTINGS::m_TrackDragAction

Definition at line 359 of file pcbnew_settings.h.

Referenced by EDIT_TOOL::doMoveSelection(), PANEL_EDIT_OPTIONS::loadPCBSettings(), PCB_SELECTION_TOOL::Main(), PCBNEW_SETTINGS(), and PANEL_EDIT_OPTIONS::TransferDataFromWindow().

◆ m_Use45DegreeLimit

bool PCBNEW_SETTINGS::m_Use45DegreeLimit

Definition at line 363 of file pcbnew_settings.h.

Referenced by PANEL_EDIT_OPTIONS::loadPCBSettings(), PCBNEW_SETTINGS(), PCB_EDIT_FRAME::setupUIConditions(), DRAWING_TOOL::ToggleHV45Mode(), and PANEL_EDIT_OPTIONS::TransferDataFromWindow().

◆ m_ViewersDisplay

VIEWERS_DISPLAY_OPTIONS PCB_VIEWERS_SETTINGS_BASE::m_ViewersDisplay

inherited

Definition at line 106 of file pcbnew_settings.h.

Referenced by CVPCB_SETTINGS::CVPCB_SETTINGS(), KIGFX::PCB_PAINTER::draw(), PCB_VIEWER_TOOLS::GraphicOutlines(), PCB_EDITOR_CONDITIONS::graphicsFillDisplayFunc(), PANEL_DISPLAY_OPTIONS::loadPCBSettings(), PCB_VIEWER_TOOLS::PadDisplayMode(), PCB_EDITOR_CONDITIONS::padFillDisplayFunc(), PCB_EDITOR_CONDITIONS::padNumberDisplayFunc(), PCB_VIEWERS_SETTINGS_BASE::PCB_VIEWERS_SETTINGS_BASE(), PCBNEW_SETTINGS(), PCB_VIEWER_TOOLS::ShowPadNumbers(), PCB_EDITOR_CONDITIONS::textFillDisplayFunc(), PCB_VIEWER_TOOLS::TextOutlines(), and PANEL_DISPLAY_OPTIONS::TransferDataFromWindow().

◆ m_VisibleActionPlugins

ACTION_PLUGIN_SETTINGS_LIST PCBNEW_SETTINGS::m_VisibleActionPlugins

Definition at line 395 of file pcbnew_settings.h.

Referenced by PCB_EDIT_FRAME::GetActionPluginButtonVisible(), PCB_EDIT_FRAME::GetOrderedActionPlugins(), PCBNEW_SETTINGS(), and PANEL_PCBNEW_ACTION_PLUGINS::TransferDataFromWindow().

◆ m_Window

WINDOW_SETTINGS APP_SETTINGS_BASE::m_Window

inherited

Definition at line 184 of file app_settings.h.

Referenced by APP_SETTINGS_BASE::APP_SETTINGS_BASE(), GRID_MENU::BuildChoiceList(), SCH_EDIT_FRAME::CommonSettingsChanged(), SYMBOL_EDIT_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 306 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().

◆ m_Zones

ZONES PCBNEW_SETTINGS::m_Zones

Definition at line 349 of file pcbnew_settings.h.

Referenced by DIALOG_COPPER_ZONE::loadPersistentNetSortConfigurations(), PCBNEW_SETTINGS(), and DIALOG_COPPER_ZONE::storePersistentNetSortConfigurations().

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

Classes

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PCBNEW_SETTINGS()

◆ ~PCBNEW_SETTINGS()

Member Function Documentation

◆ AddNestedSettings()

◆ addParamsForWindow()

◆ At()

◆ Contains()

◆ Count()

◆ DefaultGridSizeList()

◆ fromLegacy()

◆ fromLegacyColor()

◆ fromLegacyString()

◆ Get() [1/2]

◆ Get() [2/2]

◆ getFileExt()

◆ GetFilename()

◆ GetFullFilename()

◆ GetJson()

◆ getLegacyFileExt()

◆ getLegacyFrameName()

◆ GetLocation()

◆ Internals()

◆ IsReadOnly()

◆ Load()

◆ LoadFromFile()

◆ Migrate()

◆ migrateFindReplace()

◆ MigrateFromLegacy()

◆ migrateLibTreeWidth()

◆ migrateWindowConfig()

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

◆ m_appSettingsSchemaVersion

◆ m_AuiPanels

◆ m_AutoRefillZones

◆ m_Cleanup

◆ m_ColorPicker

◆ m_ColorTheme

◆ m_createIfDefault

◆ m_createIfMissing

◆ m_CrossProbing

◆ m_CtrlClickHighlight

◆ m_deleteLegacyAfterMigration

◆ m_Display

◆ m_DrcDialog

◆ m_ESCClearsNetHighlight

◆ m_ExportIdf

◆ m_ExportStep

◆ m_ExportSvg

◆ m_ExportVrml

◆ m_filename

◆ m_FindReplace

◆ m_FlipLeftRight

◆ m_FootprintChooser

◆ m_FootprintTextShownColumns