KiCad PCB EDA Suite
Loading...
Searching...
No Matches
PROJECT_LOCAL_SETTINGS Class Reference

The project local settings are things that are attached to a particular project, but also might be particular to a certain user editing that project, or change quickly, and therefore may not want to be checked in to version control or otherwise distributed with the main project. More...

#include <project_local_settings.h>

Inheritance diagram for PROJECT_LOCAL_SETTINGS:
JSON_SETTINGS

Public Member Functions

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

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

std::vector< PROJECT_FILE_STATEm_files
 Project scope. More...
 
LSET m_VisibleLayers
 Board settings. More...
 
GAL_SET m_VisibleItems
 The GAL layers (aka items) that are turned on for viewing (. More...
 
PCB_LAYER_ID m_ActiveLayer
 The current (active) board layer for editing. More...
 
wxString m_ActiveLayerPreset
 The name of a LAYER_PRESET that is currently activated (or blank if none) More...
 
HIGH_CONTRAST_MODE m_ContrastModeDisplay
 The current contrast mode. More...
 
NET_COLOR_MODE m_NetColorMode
 The current net color mode. More...
 
bool m_AutoTrackWidth
 The current setting for whether to automatically adjust track widths to match. More...
 
ZONE_DISPLAY_MODE m_ZoneDisplayMode
 How zones are drawn. More...
 
double m_TrackOpacity
 Opacity override for all tracks. More...
 
double m_ViaOpacity
 Opacity override for all types of via. More...
 
double m_PadOpacity
 Opacity override for SMD pads and PTH. More...
 
double m_ZoneOpacity
 Opacity override for filled zones. More...
 
double m_ImageOpacity
 Opacity override for user images. More...
 
std::vector< wxString > m_HiddenNets
 A list of netnames that have been manually hidden in the board editor. More...
 
std::set< wxString > m_HiddenNetclasses
 
SELECTION_FILTER_OPTIONS m_SelectionFilter
 State of the selection filter widget. More...
 
wxString m_GitRepoUsername
 
wxString m_GitRepoPassword
 
wxString m_GitRepoType
 
wxString m_GitSSHKey
 

Protected Member Functions

wxString getFileExt () const override
 
wxString getLegacyFileExt () const override
 
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...
 

Static Protected Member Functions

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

Protected Attributes

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

Private Attributes

PROJECTm_project
 A link to the owning project. More...
 

Detailed Description

The project local settings are things that are attached to a particular project, but also might be particular to a certain user editing that project, or change quickly, and therefore may not want to be checked in to version control or otherwise distributed with the main project.

Examples include layer visibility, recently-used design entry settings, and so on.

The backing store is a JSON file named <project>.kicad_prl

This file doesn't need to exist for a project to be loaded. It will be created on-demand if any of the things stored here are modified by the user.

Definition at line 53 of file project_local_settings.h.

Constructor & Destructor Documentation

◆ PROJECT_LOCAL_SETTINGS()

PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_SETTINGS ( PROJECT aProject,
const wxString &  aFilename 
)

Schema version 1 to 2: LAYER_PADS and LAYER_ZONES added to visibility controls

Schema version 2 to 3: Fix issue with object visibility not migrating from legacy, which required remapping of GAL_LAYER_ID to match the legacy bitmask ordering.

Stores a mapping from old to new enum offset

Definition at line 30 of file project_local_settings.cpp.

References LSET::AllLayersMask(), JSON_SETTINGS::At(), JSON_SETTINGS::Contains(), GAL_SET::DefaultVisible(), SELECTION_FILTER_OPTIONS::dimensions, WINDOW_STATE::display, F_Cu, F_Fab, PROJECT_FILE_STATE::fileName, LSET::FmtHex(), SELECTION_FILTER_OPTIONS::footprints, GAL_LAYER_ID_START, SELECTION_FILTER_OPTIONS::graphics, SELECTION_FILTER_OPTIONS::keepouts, LAYER_PADS, LAYER_ZONES, SELECTION_FILTER_OPTIONS::lockedItems, m_ActiveLayer, m_ActiveLayerPreset, m_AutoTrackWidth, m_ContrastModeDisplay, JSON_SETTINGS::m_deleteLegacyAfterMigration, m_files, m_GitRepoPassword, m_GitRepoType, m_GitRepoUsername, m_GitSSHKey, m_HiddenNetclasses, m_HiddenNets, m_ImageOpacity, m_NetColorMode, m_PadOpacity, JSON_SETTINGS::m_params, m_SelectionFilter, m_TrackOpacity, m_ViaOpacity, m_VisibleItems, m_VisibleLayers, m_ZoneDisplayMode, m_ZoneOpacity, WINDOW_STATE::maximized, PROJECT_FILE_STATE::open, SELECTION_FILTER_OPTIONS::otherItems, SELECTION_FILTER_OPTIONS::pads, LSET::ParseHex(), PCBNEW_LAYER_ID_START, WINDOW_STATE::pos_x, WINDOW_STATE::pos_y, JSON_SETTINGS::registerMigration(), GAL_SET::set(), JSON_SETTINGS::SetIfPresent(), WINDOW_STATE::size_x, WINDOW_STATE::size_y, SELECTION_FILTER_OPTIONS::text, SELECTION_FILTER_OPTIONS::tracks, SELECTION_FILTER_OPTIONS::vias, PROJECT_FILE_STATE::window, and SELECTION_FILTER_OPTIONS::zones.

◆ ~PROJECT_LOCAL_SETTINGS()

virtual PROJECT_LOCAL_SETTINGS::~PROJECT_LOCAL_SETTINGS ( )
inlinevirtual

Definition at line 58 of file project_local_settings.h.

Member Function Documentation

◆ AddNestedSettings()

void JSON_SETTINGS::AddNestedSettings ( NESTED_SETTINGS aSettings)
inherited

Transfers ownership of a given NESTED_SETTINGS to this object.

Can be used to construct a NESTED_SETTINGS without the parent object needing to know about the implementation of the nested object;

Parameters
aSettingsis the settings object to take ownership of
aTargetis a pointer to update to the passed in settings

Definition at line 815 of file json_settings.cpp.

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

Referenced by NESTED_SETTINGS::SetParent().

◆ At()

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

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

Definition at line 119 of file json_settings.cpp.

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::PCBNEW_SETTINGS(), and PROJECT_LOCAL_SETTINGS().

◆ ClearFileState()

void PROJECT_LOCAL_SETTINGS::ClearFileState ( )

Definition at line 418 of file project_local_settings.cpp.

References m_files.

Referenced by KICAD_MANAGER_FRAME::OnIdle().

◆ Contains()

◆ fetchOrDefault()

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

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

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

Definition at line 874 of file json_settings.cpp.

◆ FormatAsString()

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

◆ fromLegacy()

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

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

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

Definition at line 727 of file json_settings.cpp.

◆ fromLegacyColor()

bool JSON_SETTINGS::fromLegacyColor ( wxConfigBase *  aConfig,
const std::string &  aKey,
const std::string &  aDest 
)
protectedinherited

Translates a legacy COLOR4D stored in a wxConfig string to a given JSON pointer value.

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

Definition at line 787 of file json_settings.cpp.

References color.

Referenced by APP_SETTINGS_BASE::migrateWindowConfig().

◆ fromLegacyString()

bool JSON_SETTINGS::fromLegacyString ( wxConfigBase *  aConfig,
const std::string &  aKey,
const std::string &  aDest 
)
protectedinherited

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

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

Definition at line 763 of file json_settings.cpp.

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

◆ Get() [1/2]

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

Definition at line 845 of file json_settings.cpp.

References JSON_SETTINGS::GetJson().

◆ Get() [2/2]

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

Fetches a value from within the JSON document.

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

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

Definition at line 551 of file json_settings.cpp.

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

wxString PROJECT_LOCAL_SETTINGS::getFileExt ( ) const
inlineoverrideprotectedvirtual

Reimplemented from JSON_SETTINGS.

Definition at line 75 of file project_local_settings.h.

References ProjectLocalSettingsFileExtension.

◆ GetFilename()

◆ GetFileState()

const PROJECT_FILE_STATE * PROJECT_LOCAL_SETTINGS::GetFileState ( const wxString &  aFileName)

Definition at line 370 of file project_local_settings.cpp.

References m_files.

Referenced by EDA_BASE_FRAME::LoadWindowState().

◆ GetFullFilename()

wxString JSON_SETTINGS::GetFullFilename ( ) const
inherited

◆ GetJson()

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

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

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

Definition at line 531 of file json_settings.cpp.

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_WXSTRING_MAP::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()

wxString PROJECT_LOCAL_SETTINGS::getLegacyFileExt ( ) const
inlineoverrideprotectedvirtual

Reimplemented from JSON_SETTINGS.

Definition at line 80 of file project_local_settings.h.

◆ GetLocation()

SETTINGS_LOC JSON_SETTINGS::GetLocation ( ) const
inlineinherited

◆ Internals()

JSON_SETTINGS_INTERNALS * JSON_SETTINGS::Internals ( )
inherited

◆ IsReadOnly()

◆ Load()

◆ LoadFromFile()

◆ LoadFromRawFile()

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

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

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

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

◆ MigrateFromLegacy()

bool PROJECT_LOCAL_SETTINGS::MigrateFromLegacy ( wxConfigBase *  aLegacyConfig)
overridevirtual

Migrates from wxConfig to JSON-based configuration.

Should be implemented by any subclasses of JSON_SETTINGS that map to a legacy (wxConfig-based) config file.

Parameters
aLegacyConfigis a wxConfigBase holding a loaded configuration to migrate
Returns
true if migration was successful

The normal legacy migration code won't be used for this because the only legacy information stored here was stored in board files, so we do that migration when loading the board.

Reimplemented from JSON_SETTINGS.

Definition at line 340 of file project_local_settings.cpp.

◆ registerMigration()

void JSON_SETTINGS::registerMigration ( int  aOldSchemaVersion,
int  aNewSchemaVersion,
std::function< bool(void)>  aMigrator 
)
protectedinherited

Registers a migration from one schema version to another.

If the schema version in the file loaded from disk is less than the schema version of the JSON_SETTINGS class, migration functions will be called one after the other until the data is up-to-date.

Parameters
aOldSchemaVersionis the starting schema version for this migration
aNewSchemaVersionis the ending schema version for this migration
aMigratoris a function that performs the migration and returns true if successful

Definition at line 615 of file json_settings.cpp.

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

◆ ReleaseNestedSettings()

void JSON_SETTINGS::ReleaseNestedSettings ( NESTED_SETTINGS aSettings)
inherited

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

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

Definition at line 822 of file json_settings.cpp.

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

References JSON_SETTINGS::m_params.

Referenced by EDA_3D_VIEWER_FRAME::Process_Special_Functions(), PANEL_COMMON_SETTINGS::ResetPanel(), and PANEL_MOUSE_SETTINGS::ResetPanel().

◆ SaveAs()

bool PROJECT_LOCAL_SETTINGS::SaveAs ( const wxString &  aDirectory,
const wxString &  aFile 
)

◆ SaveFileState()

◆ SaveToFile()

bool PROJECT_LOCAL_SETTINGS::SaveToFile ( const wxString &  aDirectory = "",
bool  aForce = false 
)
overridevirtual
   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 from JSON_SETTINGS.

Definition at line 351 of file project_local_settings.cpp.

References PROJECT::GetProjectName(), m_project, ProjectLocalSettingsFileExtension, JSON_SETTINGS::SaveToFile(), and JSON_SETTINGS::Set().

Referenced by SETTINGS_MANAGER::SaveProject(), KICAD_MANAGER_CONTROL::SaveProjectAs(), SETTINGS_MANAGER::SaveProjectAs(), SETTINGS_MANAGER::SaveProjectCopy(), and KICAD_MANAGER_CONTROL::ShowPlayer().

◆ Set() [1/3]

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

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

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

Definition at line 588 of file json_settings.cpp.

References JSON_SETTINGS::m_internals.

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

◆ Set() [2/3]

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

Definition at line 854 of file json_settings.cpp.

◆ Set() [3/3]

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

◆ SetFilename()

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

◆ SetIfPresent() [1/4]

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

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

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

Definition at line 681 of file json_settings.cpp.

References JSON_SETTINGS_INTERNALS::PointerFromString().

◆ SetIfPresent() [2/4]

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

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

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

Definition at line 696 of file json_settings.cpp.

References JSON_SETTINGS_INTERNALS::PointerFromString().

◆ SetIfPresent() [3/4]

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

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

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

Definition at line 711 of file json_settings.cpp.

References JSON_SETTINGS_INTERNALS::PointerFromString().

◆ SetIfPresent() [4/4]

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

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

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

Definition at line 666 of file json_settings.cpp.

References JSON_SETTINGS_INTERNALS::PointerFromString().

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

◆ SetLegacyFilename()

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

◆ SetLocation()

void JSON_SETTINGS::SetLocation ( SETTINGS_LOC  aLocation)
inlineinherited

◆ SetManager()

void JSON_SETTINGS::SetManager ( SETTINGS_MANAGER aManager)
inlineinherited

Definition at line 191 of file json_settings.h.

References JSON_SETTINGS::m_manager.

◆ SetProject()

void PROJECT_LOCAL_SETTINGS::SetProject ( PROJECT aProject)
inline

Definition at line 66 of file project_local_settings.h.

References m_project.

◆ SetReadOnly()

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

References JSON_SETTINGS::m_params.

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

Member Data Documentation

◆ m_ActiveLayer

PCB_LAYER_ID PROJECT_LOCAL_SETTINGS::m_ActiveLayer

The current (active) board layer for editing.

Definition at line 105 of file project_local_settings.h.

Referenced by PCB_EDIT_FRAME::onBoardLoaded(), PROJECT_LOCAL_SETTINGS(), and PCB_EDIT_FRAME::saveProjectSettings().

◆ m_ActiveLayerPreset

wxString PROJECT_LOCAL_SETTINGS::m_ActiveLayerPreset

The name of a LAYER_PRESET that is currently activated (or blank if none)

Definition at line 108 of file project_local_settings.h.

Referenced by PCB_EDIT_FRAME::onBoardLoaded(), PROJECT_LOCAL_SETTINGS(), and PCB_EDIT_FRAME::saveProjectSettings().

◆ m_AutoTrackWidth

bool PROJECT_LOCAL_SETTINGS::m_AutoTrackWidth

The current setting for whether to automatically adjust track widths to match.

Definition at line 117 of file project_local_settings.h.

Referenced by PCB_EDIT_FRAME::LoadProjectSettings(), PROJECT_LOCAL_SETTINGS(), and PCB_EDIT_FRAME::saveProjectSettings().

◆ m_ContrastModeDisplay

HIGH_CONTRAST_MODE PROJECT_LOCAL_SETTINGS::m_ContrastModeDisplay

◆ m_createIfDefault

bool JSON_SETTINGS::m_createIfDefault
protectedinherited

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

Ignored if m_createIfMissing is false or m_writeFile is false.

Definition at line 318 of file json_settings.h.

Referenced by JSON_SETTINGS::SaveToFile().

◆ m_createIfMissing

bool JSON_SETTINGS::m_createIfMissing
protectedinherited

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

Definition at line 312 of file json_settings.h.

Referenced by JSON_SETTINGS::SaveToFile().

◆ m_deleteLegacyAfterMigration

bool JSON_SETTINGS::m_deleteLegacyAfterMigration
protectedinherited

Whether or not to delete legacy file after migration.

Definition at line 324 of file json_settings.h.

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

◆ m_filename

◆ m_files

std::vector<PROJECT_FILE_STATE> PROJECT_LOCAL_SETTINGS::m_files

Project scope.

File based state

Definition at line 92 of file project_local_settings.h.

Referenced by ClearFileState(), GetFileState(), PROJECT_LOCAL_SETTINGS(), and SaveFileState().

◆ m_GitRepoPassword

wxString PROJECT_LOCAL_SETTINGS::m_GitRepoPassword

◆ m_GitRepoType

◆ m_GitRepoUsername

wxString PROJECT_LOCAL_SETTINGS::m_GitRepoUsername

◆ m_GitSSHKey

wxString PROJECT_LOCAL_SETTINGS::m_GitSSHKey

◆ m_HiddenNetclasses

std::set<wxString> PROJECT_LOCAL_SETTINGS::m_HiddenNetclasses

◆ m_HiddenNets

std::vector<wxString> PROJECT_LOCAL_SETTINGS::m_HiddenNets

A list of netnames that have been manually hidden in the board editor.

Currently, hiding nets means hiding the ratsnest for those nets.

Definition at line 132 of file project_local_settings.h.

Referenced by PCB_EDIT_FRAME::LoadProjectSettings(), PROJECT_LOCAL_SETTINGS(), and PCB_EDIT_FRAME::saveProjectSettings().

◆ m_ImageOpacity

double PROJECT_LOCAL_SETTINGS::m_ImageOpacity

Opacity override for user images.

Definition at line 126 of file project_local_settings.h.

Referenced by PCB_EDIT_FRAME::LoadProjectSettings(), PROJECT_LOCAL_SETTINGS(), and PCB_EDIT_FRAME::saveProjectSettings().

◆ m_internals

◆ m_legacy_filename

wxString JSON_SETTINGS::m_legacy_filename
protectedinherited

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

Definition at line 300 of file json_settings.h.

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

◆ m_location

SETTINGS_LOC JSON_SETTINGS::m_location
protectedinherited

The location of this settings file (.

See also
SETTINGS_LOC)

Definition at line 303 of file json_settings.h.

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

◆ m_manager

SETTINGS_MANAGER* JSON_SETTINGS::m_manager
protectedinherited

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

Definition at line 333 of file json_settings.h.

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

◆ m_migrators

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

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

Definition at line 336 of file json_settings.h.

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

◆ m_nested_settings

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

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

Definition at line 309 of file json_settings.h.

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

◆ m_NetColorMode

NET_COLOR_MODE PROJECT_LOCAL_SETTINGS::m_NetColorMode

◆ m_PadOpacity

double PROJECT_LOCAL_SETTINGS::m_PadOpacity

Opacity override for SMD pads and PTH.

Definition at line 124 of file project_local_settings.h.

Referenced by PCB_EDIT_FRAME::LoadProjectSettings(), PROJECT_LOCAL_SETTINGS(), and PCB_EDIT_FRAME::saveProjectSettings().

◆ m_params

◆ m_project

PROJECT* PROJECT_LOCAL_SETTINGS::m_project
private

A link to the owning project.

Definition at line 146 of file project_local_settings.h.

Referenced by SaveToFile(), and SetProject().

◆ m_resetParamsIfMissing

bool JSON_SETTINGS::m_resetParamsIfMissing
protectedinherited

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

Definition at line 327 of file json_settings.h.

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

◆ m_schemaVersion

int JSON_SETTINGS::m_schemaVersion
protectedinherited

◆ m_SelectionFilter

SELECTION_FILTER_OPTIONS PROJECT_LOCAL_SETTINGS::m_SelectionFilter

State of the selection filter widget.

Definition at line 136 of file project_local_settings.h.

Referenced by PCB_EDIT_FRAME::LoadProjectSettings(), PROJECT_LOCAL_SETTINGS(), and PCB_EDIT_FRAME::saveProjectSettings().

◆ m_TrackOpacity

double PROJECT_LOCAL_SETTINGS::m_TrackOpacity

Opacity override for all tracks.

Definition at line 122 of file project_local_settings.h.

Referenced by PCB_EDIT_FRAME::LoadProjectSettings(), PROJECT_LOCAL_SETTINGS(), and PCB_EDIT_FRAME::saveProjectSettings().

◆ m_ViaOpacity

double PROJECT_LOCAL_SETTINGS::m_ViaOpacity

Opacity override for all types of via.

Definition at line 123 of file project_local_settings.h.

Referenced by PCB_EDIT_FRAME::LoadProjectSettings(), PROJECT_LOCAL_SETTINGS(), and PCB_EDIT_FRAME::saveProjectSettings().

◆ m_VisibleItems

GAL_SET PROJECT_LOCAL_SETTINGS::m_VisibleItems

The GAL layers (aka items) that are turned on for viewing (.

See also
GAL_LAYER_ID)

Definition at line 102 of file project_local_settings.h.

Referenced by BOARD::GetVisibleElements(), BOARD::IsElementVisible(), PCB_EDIT_FRAME::OpenProjectFiles(), PROJECT_LOCAL_SETTINGS(), and BOARD::SetElementVisibility().

◆ m_VisibleLayers

LSET PROJECT_LOCAL_SETTINGS::m_VisibleLayers

Board settings.

The board layers that are turned on for viewing (

See also
PCB_LAYER_ID)

Definition at line 99 of file project_local_settings.h.

Referenced by BOARD::GetVisibleLayers(), BOARD::IsLayerVisible(), PCB_EDIT_FRAME::OpenProjectFiles(), PROJECT_LOCAL_SETTINGS(), and BOARD::SetVisibleLayers().

◆ m_writeFile

bool JSON_SETTINGS::m_writeFile
protectedinherited

◆ m_ZoneDisplayMode

ZONE_DISPLAY_MODE PROJECT_LOCAL_SETTINGS::m_ZoneDisplayMode

◆ m_ZoneOpacity

double PROJECT_LOCAL_SETTINGS::m_ZoneOpacity

Opacity override for filled zones.

Definition at line 125 of file project_local_settings.h.

Referenced by PCB_EDIT_FRAME::LoadProjectSettings(), PROJECT_LOCAL_SETTINGS(), and PCB_EDIT_FRAME::saveProjectSettings().


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