![]() |
KiCad PCB EDA Suite
|
PROJECT_FILE is the backing store for a PROJECT, in JSON format. More...
#include <project_file.h>
Public Member Functions | |
PROJECT_FILE (const wxString &aFullPath) | |
Constructs the project file for a project. More... | |
virtual | ~PROJECT_FILE ()=default |
virtual bool | MigrateFromLegacy (wxConfigBase *aCfg) override |
Migrates from wxConfig to JSON-based configuration. More... | |
bool | SaveToFile (const wxString &aDirectory="", bool aForce=false) override |
void | SetProject (PROJECT *aProject) |
std::vector< FILE_INFO_PAIR > & | GetSheets () |
std::vector< FILE_INFO_PAIR > & | GetBoards () |
NET_SETTINGS & | NetSettings () |
wxString | GetFilename () const |
wxString | GetFullFilename () const |
void | SetFilename (const wxString &aFilename) |
SETTINGS_LOC | GetLocation () const |
void | SetLegacyFilename (const wxString &aFilename) |
bool | IsReadOnly () const |
void | SetReadOnly (bool aReadOnly) |
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... | |
bool | IsDefault (const std::string &aParamName) |
Checks if the current state of a parameter matches its default value. More... | |
OPT< nlohmann::json > | GetJson (const std::string &aPath) const |
Fetches a JSON object that is a subset of this JSON_SETTINGS object, using a path of the form "key1.key2.key3" to refer to nested objects. More... | |
template<typename ValueType > | |
OPT< ValueType > | Get (const std::string &aPath) const |
Fetches a value from within the JSON document. More... | |
template<> | |
OPT< wxString > | Get (const std::string &aPath) const |
template<typename ValueType > | |
void | Set (const std::string &aPath, ValueType aVal) |
Stores a value into the JSON document Will throw an exception if ValueType isn't something that the library can handle. More... | |
template<> | |
void | Set (const std::string &aPath, wxString aVal) |
template<> | |
void | Set (const std::string &aPath, wxString aVal) |
bool | Migrate () |
Migrates the schema of this settings from the version in the file to the latest version. More... | |
void | AddNestedSettings (NESTED_SETTINGS *aSettings) |
Transfers ownership of a given NESTED_SETTINGS to this object. More... | |
void | ReleaseNestedSettings (NESTED_SETTINGS *aSettings) |
Saves and frees a nested settings object, if it exists within this one. More... | |
void | SetManager (SETTINGS_MANAGER *aManager) |
Static Public Member Functions | |
static nlohmann::json::json_pointer | PointerFromString (std::string aPath) |
Builds a JSON pointer based on a given string. More... | |
static bool | SetIfPresent (const nlohmann::json &aObj, const std::string &aPath, wxString &aTarget) |
Sets the given string if the given key/path is present. More... | |
static bool | SetIfPresent (const nlohmann::json &aObj, const std::string &aPath, bool &aTarget) |
Sets the given bool if the given key/path is present. More... | |
static bool | SetIfPresent (const nlohmann::json &aObj, const std::string &aPath, int &aTarget) |
Sets the given int if the given key/path is present. More... | |
static bool | SetIfPresent (const nlohmann::json &aObj, const std::string &aPath, unsigned int &aTarget) |
Sets the given unsigned int if the given key/path is present. More... | |
Public Attributes | |
std::vector< wxString > | m_PinnedSymbolLibs |
Below are project-level settings that have not been moved to a dedicated file. More... | |
std::vector< wxString > | m_PinnedFootprintLibs |
The list of pinned footprint libraries. More... | |
std::map< wxString, wxString > | m_TextVars |
ERC_SETTINGS * | m_ErcSettings |
Eeschema params. More... | |
SCHEMATIC_SETTINGS * | m_SchematicSettings |
wxString | m_LegacyLibDir |
wxArrayString | m_LegacyLibNames |
std::vector< wxString > | m_EquivalenceFiles |
CvPcb params. More... | |
wxString | m_BoardPageLayoutDescrFile |
PcbNew params. More... | |
wxString | m_PcbLastPath [LAST_PATH_SIZE] |
MRU path storage. More... | |
BOARD_DESIGN_SETTINGS * | m_BoardSettings |
Board design settings for this project's board. More... | |
std::shared_ptr< NET_SETTINGS > | m_NetSettings |
Net settings for this project (owned here) NOTE: If we go multi-board in the future, we have to decide whether to use a global NET_SETTINGS or have one per board. More... | |
std::vector< LAYER_PRESET > | m_LayerPresets |
List of stored layer presets. More... | |
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... | |
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::vector< nlohmann::json::json_pointer > | m_preserved_paths |
A list of JSON pointers that are preserved during a read-update-write to disk. 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... | |
Private Attributes | |
std::vector< FILE_INFO_PAIR > | m_sheets |
An list of schematic sheets in this project. More... | |
std::vector< FILE_INFO_PAIR > | m_boards |
A list of board files in this project. More... | |
PROJECT * | m_project |
A link to the owning PROJECT. More... | |
PROJECT_FILE is the backing store for a PROJECT, in JSON format.
There is either zero or one PROJECT_FILE for every PROJECT (you can have a dummy PROJECT that has no file)
Definition at line 62 of file project_file.h.
PROJECT_FILE::PROJECT_FILE | ( | const wxString & | aFullPath | ) |
Constructs the project file for a project.
aFullPath | is the full disk path to the project |
Definition at line 36 of file project_file.cpp.
References LAST_PATH_GENCAD, LAST_PATH_IDF, LAST_PATH_NETLIST, LAST_PATH_SPECCTRADSN, LAST_PATH_STEP, LAST_PATH_VRML, m_BoardPageLayoutDescrFile, m_boards, JSON_SETTINGS::m_deleteLegacyAfterMigration, m_EquivalenceFiles, m_LayerPresets, m_LegacyLibDir, m_LegacyLibNames, m_NetSettings, JSON_SETTINGS::m_params, m_PcbLastPath, m_PinnedFootprintLibs, m_PinnedSymbolLibs, m_sheets, and m_TextVars.
|
virtualdefault |
|
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;
aSettings | is the settings object to take ownership of |
aTarget | is a pointer to update to the passed in settings |
Definition at line 675 of file json_settings.cpp.
References JSON_SETTINGS::GetFilename(), JSON_SETTINGS::m_nested_settings, and traceSettings.
Referenced by NESTED_SETTINGS::SetParent().
|
protectedinherited |
Translates a legacy wxConfig value to a given JSON pointer value.
ValueType | is the basic type of the value |
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 587 of file json_settings.cpp.
References JSON_SETTINGS::PointerFromString().
|
protectedinherited |
Translates a legacy COLOR4D stored in a wxConfig string to a given JSON pointer value.
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 647 of file json_settings.cpp.
References color, and JSON_SETTINGS::PointerFromString().
Referenced by APP_SETTINGS_BASE::migrateWindowConfig().
|
protectedinherited |
Translates a legacy wxConfig string value to a given JSON pointer value.
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 623 of file json_settings.cpp.
References JSON_SETTINGS::PointerFromString().
Referenced by BITMAP2CMP_SETTINGS::MigrateFromLegacy(), FOOTPRINT_EDITOR_SETTINGS::MigrateFromLegacy(), GERBVIEW_SETTINGS::MigrateFromLegacy(), SYMBOL_EDITOR_SETTINGS::MigrateFromLegacy(), MigrateFromLegacy(), COMMON_SETTINGS::MigrateFromLegacy(), PCB_CALCULATOR_SETTINGS::MigrateFromLegacy(), APP_SETTINGS_BASE::MigrateFromLegacy(), EESCHEMA_SETTINGS::MigrateFromLegacy(), PCBNEW_SETTINGS::MigrateFromLegacy(), and APP_SETTINGS_BASE::migrateWindowConfig().
|
inlineinherited |
Fetches a value from within the JSON document.
Will return an empty optional if the value is not found or a mismatching type.
ValueType | is the type to cast to |
aPath | is the path within the document to retrieve |
Definition at line 131 of file json_settings.h.
References JSON_SETTINGS::GetJson(), and NULLOPT.
Referenced by PARAM< wxString >::Load(), COLOR_MAP_PARAM::Load(), PARAM_ENUM< EnumType >::Load(), PARAM_LAMBDA< nlohmann::json >::Load(), PARAM_SCALED< ValueType >::Load(), BOARD_DESIGN_SETTINGS::LoadFromFile(), PARAM< wxString >::MatchesFile(), COLOR_MAP_PARAM::MatchesFile(), PARAM_PATH::MatchesFile(), PARAM_ENUM< EnumType >::MatchesFile(), PARAM_LAMBDA< nlohmann::json >::MatchesFile(), and PARAM_SCALED< ValueType >::MatchesFile().
|
inherited |
Definition at line 705 of file json_settings.cpp.
References JSON_SETTINGS::GetJson(), and NULLOPT.
|
inline |
Definition at line 87 of file project_file.h.
References m_boards.
|
overrideprotectedvirtual |
Reimplemented from JSON_SETTINGS.
Definition at line 553 of file project_file.cpp.
References ProjectFileExtension.
|
inlineinherited |
Definition at line 64 of file json_settings.h.
References JSON_SETTINGS::m_filename.
Referenced by JSON_SETTINGS::AddNestedSettings(), NESTED_SETTINGS::LoadFromFile(), GERBVIEW_SETTINGS::MigrateFromLegacy(), EESCHEMA_SETTINGS::MigrateFromLegacy(), PCBNEW_SETTINGS::MigrateFromLegacy(), PANEL_COLOR_SETTINGS::OnThemeChanged(), SETTINGS_MANAGER::SaveColorSettings(), PANEL_COLOR_SETTINGS::saveCurrentTheme(), DIALOG_PRINT_USING_PRINTER::SavePrintOptions(), DIALOG_PRINT_PCBNEW::saveSettings(), NESTED_SETTINGS::SaveToFile(), PANEL_FP_EDITOR_COLOR_SETTINGS::TransferDataFromWindow(), PANEL_PCBNEW_COLOR_SETTINGS::TransferDataFromWindow(), and PANEL_EESCHEMA_COLOR_SETTINGS::TransferDataFromWindow().
|
inherited |
Definition at line 81 of file json_settings.cpp.
References JSON_SETTINGS::getFileExt(), and JSON_SETTINGS::m_filename.
Referenced by JSON_SETTINGS::JSON_SETTINGS(), NESTED_SETTINGS::LoadFromFile(), JSON_SETTINGS::LoadFromFile(), and JSON_SETTINGS::SaveToFile().
|
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.
aPath | is a string containing one or more keys separated by '.' |
Definition at line 436 of file json_settings.cpp.
References alg::contains(), and JSON_SETTINGS::PointerFromString().
Referenced by JSON_SETTINGS::Get(), PARAM_LAMBDA< nlohmann::json >::Load(), PARAM_LIST< wxString >::Load(), PARAM_MAP< Value >::Load(), PARAM_WXSTRING_MAP::Load(), PARAM_LAMBDA< nlohmann::json >::MatchesFile(), PARAM_LIST< wxString >::MatchesFile(), PARAM_PATH_LIST::MatchesFile(), PARAM_MAP< Value >::MatchesFile(), and PARAM_WXSTRING_MAP::MatchesFile().
|
overrideprotectedvirtual |
Reimplemented from JSON_SETTINGS.
Definition at line 559 of file project_file.cpp.
References LegacyProjectFileExtension.
|
inlineinherited |
Definition at line 70 of file json_settings.h.
References JSON_SETTINGS::m_location.
Referenced by SETTINGS_MANAGER::GetPathForSettingsFile().
|
inline |
Definition at line 82 of file project_file.h.
References m_sheets.
Referenced by PROJECT::GetSheetName(), and SCH_EDIT_FRAME::SaveProject().
|
inherited |
Checks if the current state of a parameter matches its default value.
aParamName | is the JSON path to the parameter |
Definition at line 324 of file json_settings.cpp.
References JSON_SETTINGS::m_params.
|
inlineinherited |
Definition at line 74 of file json_settings.h.
References JSON_SETTINGS::m_writeFile.
Referenced by APPEARANCE_CONTROLS::rebuildLayers(), PANEL_COLOR_SETTINGS::ResetPanel(), PANEL_COLOR_SETTINGS::saveCurrentTheme(), PANEL_COLOR_SETTINGS::ShowColorContextMenu(), APPEARANCE_CONTROLS::syncColorsAndVisibility(), and PANEL_COLOR_SETTINGS::updateSwatches().
|
virtualinherited |
Updates the parameters of this object based on the current JSON document contents.
Definition at line 87 of file json_settings.cpp.
References JSON_SETTINGS::m_params, JSON_SETTINGS::m_resetParamsIfMissing, and traceSettings.
Referenced by COLOR_SETTINGS::CreateBuiltinColorSettings(), NESTED_SETTINGS::LoadFromFile(), JSON_SETTINGS::LoadFromFile(), BOARD_DESIGN_SETTINGS::LoadFromFile(), COLOR_SETTINGS::migrateSchema0to1(), and SETTINGS_MANAGER::SaveColorSettings().
|
virtualinherited |
Loads the backing file from disk and then calls Load()
aDirectory | is the path to the file |
Reimplemented in BOARD_DESIGN_SETTINGS, and NESTED_SETTINGS.
Definition at line 104 of file json_settings.cpp.
References JSON_SETTINGS::getFileExt(), JSON_SETTINGS::GetFullFilename(), JSON_SETTINGS::getLegacyFileExt(), JSON_SETTINGS::Load(), JSON_SETTINGS::m_deleteLegacyAfterMigration, JSON_SETTINGS::m_filename, 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(), JSON_SETTINGS::PointerFromString(), JSON_SETTINGS::SaveToFile(), and traceSettings.
Referenced by SETTINGS_MANAGER::SaveColorSettings().
|
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
Definition at line 464 of file json_settings.cpp.
References JSON_SETTINGS::m_migrators, JSON_SETTINGS::m_schemaVersion, JSON_SETTINGS::PointerFromString(), and traceSettings.
Referenced by NESTED_SETTINGS::LoadFromFile(), and JSON_SETTINGS::LoadFromFile().
|
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.
aLegacyConfig | is a wxConfigBase holding a loaded configuration to migrate |
Reimplemented from JSON_SETTINGS.
Definition at line 113 of file project_file.cpp.
References Format(), JSON_SETTINGS::fromLegacyString(), JSON_SETTINGS::PointerFromString(), and traceSettings.
|
inline |
Definition at line 92 of file project_file.h.
References m_NetSettings.
Referenced by SCH_EDITOR_CONTROL::AssignNetclass(), DIALOG_SCHEMATIC_SETUP::DIALOG_SCHEMATIC_SETUP(), SCH_LINE::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), inheritNetclass(), SCH_EDIT_FRAME::KiwayMailIn(), PCB_EDIT_FRAME::LoadProjectSettings(), SCH_ITEM::NetClass(), PCB_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::SaveProjectSettings(), BOARD::SetProject(), PCB_EDIT_FRAME::ShowBoardSetupDialog(), and SCH_EDIT_FRAME::ShowSchematicSetupDialog().
|
staticinherited |
Builds a JSON pointer based on a given string.
aPath | is the path in the form "key1.key2.key3" |
Definition at line 506 of file json_settings.cpp.
Referenced by JSON_SETTINGS::fromLegacy(), JSON_SETTINGS::fromLegacyColor(), JSON_SETTINGS::fromLegacyString(), JSON_SETTINGS::GetJson(), JSON_SETTINGS::JSON_SETTINGS(), NESTED_SETTINGS::LoadFromFile(), JSON_SETTINGS::LoadFromFile(), BOARD_DESIGN_SETTINGS::LoadFromFile(), JSON_SETTINGS::Migrate(), EESCHEMA_SETTINGS::migrateBomSettings(), APP_SETTINGS_BASE::migrateFindReplace(), FOOTPRINT_EDITOR_SETTINGS::MigrateFromLegacy(), GERBVIEW_SETTINGS::MigrateFromLegacy(), SYMBOL_EDITOR_SETTINGS::MigrateFromLegacy(), MigrateFromLegacy(), EDA_3D_VIEWER_SETTINGS::MigrateFromLegacy(), COMMON_SETTINGS::MigrateFromLegacy(), PCB_CALCULATOR_SETTINGS::MigrateFromLegacy(), APP_SETTINGS_BASE::MigrateFromLegacy(), EESCHEMA_SETTINGS::MigrateFromLegacy(), PCBNEW_SETTINGS::MigrateFromLegacy(), SETTINGS_MANAGER::SaveColorSettings(), NESTED_SETTINGS::SaveToFile(), PROJECT_LOCAL_SETTINGS::SaveToFile(), SaveToFile(), JSON_SETTINGS::Set(), and JSON_SETTINGS::SetIfPresent().
|
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.
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 455 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(), COMMON_SETTINGS::COMMON_SETTINGS(), EESCHEMA_SETTINGS::EESCHEMA_SETTINGS(), FOOTPRINT_EDITOR_SETTINGS::FOOTPRINT_EDITOR_SETTINGS(), and PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_SETTINGS().
|
inherited |
Saves and frees a nested settings object, if it exists within this one.
aSettings | is a pointer to a NESTED_SETTINGS that has already been added to this one |
Definition at line 682 of file json_settings.cpp.
References JSON_SETTINGS::m_nested_settings, NESTED_SETTINGS::SetParent(), and traceSettings.
Referenced by BOARD::ClearProject(), BOARD_DESIGN_SETTINGS::~BOARD_DESIGN_SETTINGS(), ERC_SETTINGS::~ERC_SETTINGS(), NESTED_SETTINGS::~NESTED_SETTINGS(), NET_SETTINGS::~NET_SETTINGS(), and SCHEMATIC_SETTINGS::~SCHEMATIC_SETTINGS().
|
inherited |
Resets all parameters to default values.
Does NOT write to file or update underlying JSON.
Definition at line 317 of file json_settings.cpp.
References JSON_SETTINGS::m_params.
Referenced by EDA_3D_VIEWER::Process_Special_Functions(), PANEL_COMMON_SETTINGS::ResetPanel(), and PANEL_MOUSE_SETTINGS::ResetPanel().
|
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 *
Reimplemented from JSON_SETTINGS.
Definition at line 542 of file project_file.cpp.
References PROJECT::GetProjectName(), m_project, JSON_SETTINGS::PointerFromString(), ProjectFileExtension, and JSON_SETTINGS::SaveToFile().
Referenced by SETTINGS_MANAGER::SaveProject(), and SETTINGS_MANAGER::SaveProjectAs().
|
inlineinherited |
Stores a value into the JSON document Will throw an exception if ValueType isn't something that the library can handle.
ValueType | is the type to store |
aPath | is a path to store in the form "key1.key2.key3" |
aVal | is the value to store |
Definition at line 155 of file json_settings.h.
References JSON_SETTINGS::PointerFromString().
Referenced by COLOR_MAP_PARAM::Store(), PARAM< wxString >::Store(), PARAM_PATH::Store(), PARAM_ENUM< EnumType >::Store(), PARAM_LAMBDA< nlohmann::json >::Store(), PARAM_SCALED< ValueType >::Store(), PARAM_LIST< wxString >::Store(), PARAM_PATH_LIST::Store(), PARAM_MAP< Value >::Store(), and PARAM_WXSTRING_MAP::Store().
|
inherited |
|
inherited |
Definition at line 714 of file json_settings.cpp.
References JSON_SETTINGS::PointerFromString().
|
inlineinherited |
Definition at line 68 of file json_settings.h.
References JSON_SETTINGS::m_filename.
Referenced by SETTINGS_MANAGER::SaveProjectAs().
|
staticinherited |
Sets the given string if the given key/path is present.
aObj | is the source object |
aTarget | is the storage destination |
Definition at line 526 of file json_settings.cpp.
References JSON_SETTINGS::PointerFromString().
Referenced by FOOTPRINT_EDITOR_SETTINGS::FOOTPRINT_EDITOR_SETTINGS(), and PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_SETTINGS().
|
staticinherited |
Sets the given bool if the given key/path is present.
aObj | is the source object |
aTarget | is the storage destination |
Definition at line 541 of file json_settings.cpp.
References JSON_SETTINGS::PointerFromString().
|
staticinherited |
Sets the given int if the given key/path is present.
aObj | is the source object |
aTarget | is the storage destination |
Definition at line 556 of file json_settings.cpp.
References JSON_SETTINGS::PointerFromString().
|
staticinherited |
Sets the given unsigned int if the given key/path is present.
aObj | is the source object |
aTarget | is the storage destination |
Definition at line 571 of file json_settings.cpp.
References JSON_SETTINGS::PointerFromString().
|
inlineinherited |
Definition at line 72 of file json_settings.h.
References JSON_SETTINGS::m_legacy_filename.
Referenced by SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS().
|
inlineinherited |
Definition at line 195 of file json_settings.h.
References JSON_SETTINGS::m_manager.
|
inline |
Definition at line 77 of file project_file.h.
References m_project.
|
inlineinherited |
Definition at line 75 of file json_settings.h.
References JSON_SETTINGS::m_writeFile.
Referenced by PANEL_COLOR_SETTINGS::OnThemeChanged().
|
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.
Definition at line 303 of file json_settings.cpp.
References JSON_SETTINGS::m_params.
Referenced by PANEL_FP_EDITOR_COLOR_SETTINGS::PANEL_FP_EDITOR_COLOR_SETTINGS(), SETTINGS_MANAGER::SaveColorSettings(), NESTED_SETTINGS::SaveToFile(), and JSON_SETTINGS::SaveToFile().
wxString PROJECT_FILE::m_BoardPageLayoutDescrFile |
PcbNew params.
Page layout description file
Definition at line 157 of file project_file.h.
Referenced by PCB_EDIT_FRAME::LoadProjectSettings(), PROJECT_FILE(), and PCB_EDIT_FRAME::SaveProjectSettings().
|
private |
A list of board files in this project.
Definition at line 108 of file project_file.h.
Referenced by GetBoards(), and PROJECT_FILE().
BOARD_DESIGN_SETTINGS* PROJECT_FILE::m_BoardSettings |
Board design settings for this project's board.
This will be initialized by PcbNew after loading a board so that BOARD_DESIGN_SETTINGS doesn't need to live in common for now. Owned by the BOARD; may be null if a board isn't loaded: be careful
Definition at line 167 of file project_file.h.
Referenced by BOARD::ClearProject(), and BOARD::SetProject().
|
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 313 of file json_settings.h.
Referenced by JSON_SETTINGS::SaveToFile().
|
protectedinherited |
Whether or not the backing store file should be created it if doesn't exist.
Definition at line 307 of file json_settings.h.
Referenced by JSON_SETTINGS::SaveToFile().
|
protectedinherited |
Whether or not to delete legacy file after migration.
Definition at line 319 of file json_settings.h.
Referenced by JSON_SETTINGS::LoadFromFile(), and PROJECT_FILE().
std::vector<wxString> PROJECT_FILE::m_EquivalenceFiles |
CvPcb params.
List of equivalence (equ) files used in the project
Definition at line 150 of file project_file.h.
Referenced by CVPCB_MAINFRAME::buildEquivalenceList(), DIALOG_CONFIG_EQUFILES::Init(), DIALOG_CONFIG_EQUFILES::OnOkClick(), and PROJECT_FILE().
ERC_SETTINGS* PROJECT_FILE::m_ErcSettings |
Eeschema params.
Definition at line 135 of file project_file.h.
Referenced by SCHEMATIC::ErcSettings(), DIALOG_SCHEMATIC_SETUP::OnAuxiliaryAction(), SCHEMATIC::Reset(), and SCHEMATIC::SetProject().
|
protectedinherited |
The filename (not including path) of this settings file (inicode)
Definition at line 292 of file json_settings.h.
Referenced by JSON_SETTINGS::GetFilename(), JSON_SETTINGS::GetFullFilename(), NESTED_SETTINGS::LoadFromFile(), JSON_SETTINGS::LoadFromFile(), COLOR_SETTINGS::migrateSchema0to1(), COLOR_SETTINGS::operator=(), NESTED_SETTINGS::SaveToFile(), JSON_SETTINGS::SaveToFile(), and JSON_SETTINGS::SetFilename().
std::vector<LAYER_PRESET> PROJECT_FILE::m_LayerPresets |
List of stored layer presets.
Definition at line 178 of file project_file.h.
Referenced by PCB_EDIT_FRAME::LoadProjectSettings(), PROJECT_FILE(), and PCB_EDIT_FRAME::SaveProjectSettings().
|
protectedinherited |
The filename of the wxConfig legacy file (if different from m_filename)
Definition at line 295 of file json_settings.h.
Referenced by JSON_SETTINGS::LoadFromFile(), and JSON_SETTINGS::SetLegacyFilename().
wxString PROJECT_FILE::m_LegacyLibDir |
Definition at line 141 of file project_file.h.
Referenced by PART_LIBS::LibNamesAndPaths(), and PROJECT_FILE().
wxArrayString PROJECT_FILE::m_LegacyLibNames |
Definition at line 143 of file project_file.h.
Referenced by PART_LIBS::LibNamesAndPaths(), and PROJECT_FILE().
|
protectedinherited |
The location of this settings file (.
Definition at line 298 of file json_settings.h.
Referenced by JSON_SETTINGS::GetLocation().
|
protectedinherited |
A pointer to the settings manager managing this file (may be null)
Definition at line 328 of file json_settings.h.
Referenced by FOOTPRINT_EDITOR_SETTINGS::migrateSchema0to1(), COLOR_SETTINGS::migrateSchema0to1(), and JSON_SETTINGS::SetManager().
|
protectedinherited |
A map of starting schema version to a pair of <ending version, migrator function>
Definition at line 334 of file json_settings.h.
Referenced by JSON_SETTINGS::Migrate(), and JSON_SETTINGS::registerMigration().
|
protectedinherited |
Nested settings files that live inside this one, if any.
Definition at line 304 of file json_settings.h.
Referenced by JSON_SETTINGS::AddNestedSettings(), JSON_SETTINGS::LoadFromFile(), JSON_SETTINGS::ReleaseNestedSettings(), and JSON_SETTINGS::SaveToFile().
std::shared_ptr<NET_SETTINGS> PROJECT_FILE::m_NetSettings |
Net settings for this project (owned here) NOTE: If we go multi-board in the future, we have to decide whether to use a global NET_SETTINGS or have one per board.
Right now I think global makes more sense (one set of schematics, one netlist partitioned into multiple boards)
Definition at line 175 of file project_file.h.
Referenced by NetSettings(), DIALOG_SCHEMATIC_SETUP::OnAuxiliaryAction(), PROJECT_FILE(), and BOARD::SynchronizeNetsAndNetClasses().
|
protectedinherited |
The list of parameters (owned by this object)
Definition at line 301 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(), 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::IsDefault(), JSON_SETTINGS::JSON_SETTINGS(), KICAD_SETTINGS::KICAD_SETTINGS(), JSON_SETTINGS::Load(), NET_SETTINGS::NET_SETTINGS(), PCB_CALCULATOR_SETTINGS::PCB_CALCULATOR_SETTINGS(), PCBNEW_SETTINGS::PCBNEW_SETTINGS(), PL_EDITOR_SETTINGS::PL_EDITOR_SETTINGS(), PROJECT_FILE(), PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_SETTINGS(), JSON_SETTINGS::ResetToDefaults(), PNS::ROUTING_SETTINGS::ROUTING_SETTINGS(), SCHEMATIC_SETTINGS::SCHEMATIC_SETTINGS(), JSON_SETTINGS::Store(), SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS(), and JSON_SETTINGS::~JSON_SETTINGS().
wxString PROJECT_FILE::m_PcbLastPath[LAST_PATH_SIZE] |
MRU path storage.
Definition at line 160 of file project_file.h.
Referenced by PCB_EDIT_FRAME::GetLastPath(), PROJECT_FILE(), and PCB_EDIT_FRAME::SetLastPath().
std::vector<wxString> PROJECT_FILE::m_PinnedFootprintLibs |
The list of pinned footprint libraries.
Definition at line 126 of file project_file.h.
Referenced by LIB_TREE_MODEL_ADAPTER::LIB_TREE_MODEL_ADAPTER(), PROJECT_FILE(), and LIB_TREE_MODEL_ADAPTER::SavePinnedItems().
std::vector<wxString> PROJECT_FILE::m_PinnedSymbolLibs |
Below are project-level settings that have not been moved to a dedicated file.
Shared params, used by more than one applicationThe list of pinned symbol libraries
Definition at line 123 of file project_file.h.
Referenced by LIB_TREE_MODEL_ADAPTER::LIB_TREE_MODEL_ADAPTER(), PROJECT_FILE(), and LIB_TREE_MODEL_ADAPTER::SavePinnedItems().
|
protectedinherited |
A list of JSON pointers that are preserved during a read-update-write to disk.
Definition at line 331 of file json_settings.h.
|
private |
Definition at line 111 of file project_file.h.
Referenced by SaveToFile(), and SetProject().
|
protectedinherited |
Whether or not to set parameters to their default value if missing from JSON on Load()
Definition at line 322 of file json_settings.h.
Referenced by BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), and JSON_SETTINGS::Load().
SCHEMATIC_SETTINGS* PROJECT_FILE::m_SchematicSettings |
Definition at line 138 of file project_file.h.
Referenced by DIALOG_SCHEMATIC_SETUP::OnAuxiliaryAction(), SCHEMATIC::Reset(), SCHEMATIC::SetProject(), and SCHEMATIC::Settings().
|
protectedinherited |
Version of this settings schema.
Definition at line 325 of file json_settings.h.
Referenced by JSON_SETTINGS::JSON_SETTINGS(), NESTED_SETTINGS::LoadFromFile(), JSON_SETTINGS::LoadFromFile(), JSON_SETTINGS::Migrate(), JSON_SETTINGS::registerMigration(), and NESTED_SETTINGS::SaveToFile().
|
private |
An list of schematic sheets in this project.
Definition at line 105 of file project_file.h.
Referenced by GetSheets(), and PROJECT_FILE().
std::map<wxString, wxString> PROJECT_FILE::m_TextVars |
Definition at line 128 of file project_file.h.
Referenced by PROJECT::GetTextVars(), and PROJECT_FILE().
|
protectedinherited |
Whether or not the backing store file should be written.
Definition at line 316 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().