|
KiCad PCB EDA Suite
|
The backing store for a PROJECT, in JSON format. More...
#include <project_file.h>
Public Member Functions | |
| PROJECT_FILE (const wxString &aFullPath) | |
| Construct the project file for a project. | |
| virtual | ~PROJECT_FILE ()=default |
| virtual bool | MigrateFromLegacy (wxConfigBase *aCfg) override |
| Migrates from wxConfig to JSON-based configuration. | |
| bool | LoadFromFile (const wxString &aDirectory="") override |
| Loads the backing file from disk and then calls Load() | |
| bool | Store () override |
| 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. | |
| bool | SaveToFile (const wxString &aDirectory="", bool aForce=false) override |
| Calls Store() and then writes the contents of the JSON document to a file. | |
| std::string | SerializeToString () |
| Serialize to the bytes SaveToFile would write, without touching the file. | |
| bool | SaveAs (const wxString &aDirectory, const wxString &aFile) |
| void | SetProject (PROJECT *aProject) |
| const PROJECT * | GetOwningProject () const override |
| Project-located settings override this to report the project they belong to so their save path is resolved against that project rather than the active one. | |
| std::vector< FILE_INFO_PAIR > & | GetSheets () |
| std::vector< FILE_INFO_PAIR > & | GetBoards () |
| std::vector< TOP_LEVEL_SHEET_INFO > & | GetTopLevelSheets () |
| const std::vector< TOP_LEVEL_SHEET_INFO > & | GetTopLevelSheets () const |
| bool | TopLevelSheetsChangedOnLoad () const |
| True when the last read of the file replaced a top-level sheet list held from before it. | |
| void | AcknowledgeTopLevelSheetChange () |
| Settle a changed list once the schematic has been loaded from it. | |
| std::shared_ptr< NET_SETTINGS > & | NetSettings () |
| std::shared_ptr< COMPONENT_CLASS_SETTINGS > & | ComponentClassSettings () |
| std::shared_ptr< TUNING_PROFILES > & | TuningProfileParameters () |
| bool | ShouldAutoSave () const |
| wxString | GetFilename () const |
| wxString | GetFullFilename () const |
| void | SetFilename (const wxString &aFilename) |
| void | SetLocation (SETTINGS_LOC aLocation) |
| SETTINGS_LOC | GetLocation () const |
| void | SetLegacyFilename (const wxString &aFilename) |
| bool | IsReadOnly () const |
| void | SetReadOnly (bool aReadOnly) |
| bool | ResetsParamsIfMissing () const |
| 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. | |
| bool | Contains (const std::string &aPath) const |
| JSON_SETTINGS_INTERNALS * | Internals () |
| virtual void | Load () |
| Updates the parameters of this object based on the current JSON document contents. | |
| bool | LoadFromBuffer (const std::string &aContents) |
| Loads the document from file contents already in memory, so the caller can bound the read of the file. | |
| bool | IsFileSynced () const |
| bool | LastSaveFailed () const |
| SaveToFile() also returns false when it had nothing to write, so its result cannot tell a skipped save from a lost one. | |
| bool | IsFutureFormat () const |
| void | ResetToDefaults () |
| Resets all parameters to default values. | |
| 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. | |
| template<typename ValueType> | |
| std::optional< ValueType > | Get (const std::string &aPath) const |
| Fetches a value from within the JSON document. | |
| template<> | |
| std::optional< wxString > | Get (const std::string &aPath) const |
| template<> | |
| KICOMMON_API 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. | |
| template<> | |
| void | Set (const std::string &aPath, wxString aVal) |
| template<> | |
| KICOMMON_API void | Set (const std::string &aPath, wxString aVal) |
| virtual std::map< std::string, nlohmann::json > | GetFileHistories () |
| bool | Migrate () |
| Migrates the schema of this settings from the version in the file to the latest version. | |
| void | AddNestedSettings (NESTED_SETTINGS *aSettings) |
| Transfers ownership of a given NESTED_SETTINGS to this object. | |
| void | ReleaseNestedSettings (NESTED_SETTINGS *aSettings) |
| Saves and frees a nested settings object, if it exists within this one. | |
| 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. | |
| static bool | SetIfPresent (const nlohmann::json &aObj, const std::string &aPath, bool &aTarget) |
| Sets the given bool if the given key/path is present. | |
| static bool | SetIfPresent (const nlohmann::json &aObj, const std::string &aPath, int &aTarget) |
| Sets the given int if the given key/path is present. | |
| 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. | |
Public Attributes | |
| std::vector< wxString > | m_PinnedSymbolLibs |
| Below are project-level settings that have not been moved to a dedicated file. | |
| std::vector< wxString > | m_PinnedFootprintLibs |
| The list of pinned footprint libraries. | |
| std::vector< wxString > | m_PinnedDesignBlockLibs |
| The list of pinned design block libraries. | |
| std::map< wxString, wxString > | m_TextVars |
| TEMPLATES | m_TemplateFieldNames |
| Project and global field name templates shared by project editors. | |
| ERC_SETTINGS * | m_ErcSettings |
| Eeschema params. | |
| SCHEMATIC_SETTINGS * | m_SchematicSettings |
| wxString | m_LegacyLibDir |
| wxArrayString | m_LegacyLibNames |
| std::map< wxString, std::vector< wxString > > | m_BusAliases |
| Bus alias definitions for the schematic project. | |
| bool | m_BusAliasesDefined = false |
| An explicit alias table was loaded or set, including a deliberately empty table. | |
| std::vector< wxString > | m_EquivalenceFiles |
| CvPcb params. | |
| wxString | m_BoardDrawingSheetFile |
| PcbNew params. | |
| std::vector< wxString > | m_FindByPropertiesQueries |
| Recent queries for Find by Properties dialog. | |
| wxString | m_PcbLastPath [LAST_PATH_SIZE] |
| MRU path storage. | |
| std::shared_ptr< BOARD_DESIGN_SETTINGS > | m_BoardSettings |
| Board design settings for this project's board. | |
| std::shared_ptr< NET_SETTINGS > | m_NetSettings |
| Net settings for this project (owned here) | |
| std::shared_ptr< COMPONENT_CLASS_SETTINGS > | m_ComponentClassSettings |
| Component class settings for the project (owned here) | |
| std::shared_ptr< TUNING_PROFILES > | m_tuningProfileParameters |
| Tuning profile parameters for this project. | |
| std::vector< LAYER_PRESET > | m_LayerPresets |
| std::vector< VIEWPORT > | m_Viewports |
| List of stored layer presets. | |
| std::vector< VIEWPORT3D > | m_Viewports3D |
| List of stored viewports (pos + zoom) | |
| std::vector< LAYER_PAIR_INFO > | m_LayerPairInfos |
| List of stored 3D viewports (view matrixes) | |
| struct IP2581_BOM | m_IP2581Bom |
| Layer pair list for the board. | |
| IDF_EXPORT_SETTINGS | m_IdfExportSettings |
| IPC-2581 BOM settings. | |
Protected Member Functions | |
| wxString | getFileExt () const override |
| wxString | getLegacyFileExt () const override |
| const nlohmann::json & | originalJson () const |
| void | registerMigration (int aOldSchemaVersion, int aNewSchemaVersion, std::function< bool(void)> aMigrator) |
| Registers a migration from one schema version to another. | |
| 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. | |
| bool | fromLegacyString (wxConfigBase *aConfig, const std::string &aKey, const std::string &aDest) |
| Translates a legacy wxConfig string value to a given JSON pointer value. | |
| 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. | |
| bool | flushToStore () |
| Flushes nested settings and parameters into the JSON store. | |
| std::string | formatFileContents () |
| Overlays the current store on the original file contents. | |
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. | |
Protected Attributes | |
| wxString | m_filename |
| The filename (not including path) of this settings file (inicode) | |
| wxString | m_legacy_filename |
| The filename of the wxConfig legacy file (if different from m_filename) | |
| SETTINGS_LOC | m_location |
| The location of this settings file (. | |
| std::vector< PARAM_BASE * > | m_params |
| The list of parameters (owned by this object) | |
| std::vector< NESTED_SETTINGS * > | m_nested_settings |
| Nested settings files that live inside this one, if any. | |
| bool | m_createIfMissing |
| Whether or not the backing store file should be created it if doesn't exist. | |
| bool | m_createIfDefault |
| Whether or not the backing store file should be created if all parameters are still at their default values. | |
| bool | m_writeFile |
| Whether or not the backing store file should be written. | |
| bool | m_modified |
| True if the JSON data store has been written to since the last file write. | |
| bool | m_fileSynced |
| True once the store has been synchronized with an on-disk file (loaded or saved) | |
| bool | m_lastSaveFailed |
| True if the most recent SaveToFile() had changes to write and could not write them. | |
| bool | m_deleteLegacyAfterMigration |
| Whether or not to delete legacy file after migration. | |
| bool | m_resetParamsIfMissing |
| Whether or not to set parameters to their default value if missing from JSON on Load() | |
| int | m_schemaVersion |
| Version of this settings schema. | |
| bool | m_isFutureFormat |
| Set to true if this settings is loaded from a file with a newer schema version than is known. | |
| SETTINGS_MANAGER * | m_manager |
| A pointer to the settings manager managing this file (may be null) | |
| 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> | |
| std::unique_ptr< JSON_SETTINGS_INTERNALS > | m_internals |
Private Member Functions | |
| bool | migrateSchema1To2 () |
| Schema version 2: Bump for KiCad 9 layer numbering changes. | |
| bool | migrateSchema2To3 () |
| Schema version 3: move layer presets to use named render layers. | |
| bool | migrateSchema3To4 () |
| Schema version 4 distinguishes explicit empty alias tables from older default writes. | |
| bool | parseAndMigrate (const std::function< bool(nlohmann::json &)> &aParse, bool &aMigrated, bool &aParseError) |
| Parses a document into the store through aParse, then checks the schema version and migrates. | |
Private Attributes | |
| std::vector< FILE_INFO_PAIR > | m_sheets |
| An list of schematic sheets in this project. | |
| std::vector< TOP_LEVEL_SHEET_INFO > | m_topLevelSheets |
| A list of top-level schematic sheets in this project. | |
| std::vector< FILE_INFO_PAIR > | m_boards |
| A list of board files in this project. | |
| PROJECT * | m_project |
| A link to the owning PROJECT. | |
| bool | m_wasMigrated |
| bool | m_topLevelSheetsChanged |
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 94 of file project_file.h.
| PROJECT_FILE::PROJECT_FILE | ( | const wxString & | aFullPath | ) |
Construct the project file for a project.
| aFullPath | is the full disk path to the project |
Definition at line 43 of file project_file.cpp.
References IDF_SETTINGS::CENTER, IDF_SETTINGS::DRILL, JSON_SETTINGS::JSON_SETTINGS(), LAST_PATH_IDF, LAST_PATH_NETLIST, LAST_PATH_PLOT, LAST_PATH_SPECCTRADSN, LAST_PATH_STEP, LAST_PATH_VRML, m_BoardDrawingSheetFile, m_boards, m_BoardSettings, m_BusAliases, m_BusAliasesDefined, m_ComponentClassSettings, JSON_SETTINGS::m_deleteLegacyAfterMigration, m_EquivalenceFiles, m_ErcSettings, m_FindByPropertiesQueries, m_IdfExportSettings, m_IP2581Bom, m_LayerPairInfos, m_LayerPresets, m_LegacyLibDir, m_LegacyLibNames, m_NetSettings, JSON_SETTINGS::m_params, m_PcbLastPath, m_PinnedDesignBlockLibs, m_PinnedFootprintLibs, m_PinnedSymbolLibs, m_project, m_SchematicSettings, m_sheets, m_TemplateFieldNames, m_TextVars, m_topLevelSheets, m_topLevelSheetsChanged, m_tuningProfileParameters, TEMPLATE_FIELDNAME::m_URL, m_Viewports, m_Viewports3D, TEMPLATE_FIELDNAME::m_Visible, m_wasMigrated, migrateSchema1To2(), migrateSchema2To3(), migrateSchema3To4(), IDF_SETTINGS::MILS, IDF_SETTINGS::MM, name, projectFileSchemaVersion, JSON_SETTINGS::registerMigration(), and IDF_SETTINGS::USER.
|
virtualdefault |
References SaveAs(), and SerializeToString().
|
inline |
Settle a changed list once the schematic has been loaded from it.
Definition at line 155 of file project_file.h.
References m_topLevelSheetsChanged.
Referenced by SCH_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::OpenProjectFiles(), and SCH_EDIT_FRAME::TopLevelSheetsChangedOnDisk().
|
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 |
Definition at line 998 of file json_settings.cpp.
References GetFilename(), m_nested_settings, NESTED_SETTINGS, and traceSettings.
|
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 127 of file json_settings.cpp.
References m_internals.
Referenced by BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), EDA_3D_VIEWER_SETTINGS::EDA_3D_VIEWER_SETTINGS(), EESCHEMA_SETTINGS::migrateBomSettings(), EESCHEMA_SETTINGS::migrateFieldNameTemplates(), GERBVIEW_SETTINGS::MigrateFromLegacy(), APP_SETTINGS_BASE::migrateLibTreeWidth(), BOARD_DESIGN_SETTINGS::migrateSchema0to1(), COLOR_SETTINGS::migrateSchema0to1(), FOOTPRINT_EDITOR_SETTINGS::migrateSchema0to1(), BOARD_DESIGN_SETTINGS::migrateSchema3to4(), and PCBNEW_SETTINGS::PCBNEW_SETTINGS().
|
inline |
Definition at line 162 of file project_file.h.
References m_ComponentClassSettings.
Referenced by BOARD::SynchronizeComponentClasses().
|
inherited |
Definition at line 133 of file json_settings.cpp.
References m_internals, and JSON_SETTINGS_INTERNALS::PointerFromString().
Referenced by EDA_3D_VIEWER_SETTINGS::EDA_3D_VIEWER_SETTINGS(), GERBVIEW_SETTINGS::GetFileHistories(), GetFileHistories(), BOARD_DESIGN_SETTINGS::LoadFromFile(), EESCHEMA_SETTINGS::migrateBomSettings(), EESCHEMA_SETTINGS::migrateFieldNameTemplates(), BOARD_DESIGN_SETTINGS::migrateSchema0to1(), COLOR_SETTINGS::migrateSchema0to1(), FOOTPRINT_EDITOR_SETTINGS::migrateSchema0to1(), BOARD_DESIGN_SETTINGS::migrateSchema3to4(), COMMON_SETTINGS::migrateSchema5to6(), COMMON_SETTINGS::migrateSchema6to7(), and SETTINGS_MANAGER::SaveColorSettings().
|
staticprotectedinherited |
Helper to retrieve a value from a JSON object (dictionary) as a certain result type.
| ResultType | is the type of the retrieved value. |
| aJson | is the object to act on . |
| aKey | is the object key to retrieve the value for. |
| aDefault | is the default result type. |
Definition at line 1051 of file json_settings.cpp.
Referenced by DATABASE_LIB_SETTINGS::fieldFromJson(), and DATABASE_LIB_SETTINGS::tableFromJson().
|
protectedinherited |
Flushes nested settings and parameters into the JSON store.
Definition at line 600 of file json_settings.cpp.
References m_nested_settings, NESTED_SETTINGS, and Store().
Referenced by SaveToFile(), and PROJECT_FILE::SerializeToString().
|
inherited |
Definition at line 645 of file json_settings.cpp.
References dummy, m_internals, and Store().
|
protectedinherited |
Overlays the current store on the original file contents.
May throw a JSON exception.
Definition at line 623 of file json_settings.cpp.
References dummy, m_internals, m_params, and JSON_SETTINGS_INTERNALS::PointerFromString().
Referenced by SaveToFile(), and PROJECT_FILE::SerializeToString().
|
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 913 of file json_settings.cpp.
Referenced by APP_SETTINGS_BASE::MigrateFromLegacy(), COMMON_SETTINGS::MigrateFromLegacy(), CVPCB_SETTINGS::MigrateFromLegacy(), EDA_3D_VIEWER_SETTINGS::MigrateFromLegacy(), EESCHEMA_SETTINGS::MigrateFromLegacy(), FOOTPRINT_EDITOR_SETTINGS::MigrateFromLegacy(), GERBVIEW_SETTINGS::MigrateFromLegacy(), KICAD_SETTINGS::MigrateFromLegacy(), PCB_CALCULATOR_SETTINGS::MigrateFromLegacy(), PCBNEW_SETTINGS::MigrateFromLegacy(), PL_EDITOR_SETTINGS::MigrateFromLegacy(), PROJECT_FILE::MigrateFromLegacy(), SYMBOL_EDITOR_SETTINGS::MigrateFromLegacy(), and APP_SETTINGS_BASE::migrateWindowConfig().
|
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 971 of file json_settings.cpp.
References KIGFX::COLOR4D::a, KIGFX::COLOR4D::b, KIGFX::COLOR4D::g, KIGFX::COLOR4D::r, and KIGFX::COLOR4D::SetFromWxString().
|
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 948 of file json_settings.cpp.
Referenced by APP_SETTINGS_BASE::MigrateFromLegacy(), COMMON_SETTINGS::MigrateFromLegacy(), EESCHEMA_SETTINGS::MigrateFromLegacy(), FOOTPRINT_EDITOR_SETTINGS::MigrateFromLegacy(), GERBVIEW_SETTINGS::MigrateFromLegacy(), PCB_CALCULATOR_SETTINGS::MigrateFromLegacy(), PCBNEW_SETTINGS::MigrateFromLegacy(), PROJECT_FILE::MigrateFromLegacy(), and APP_SETTINGS_BASE::migrateWindowConfig().
|
inherited |
Definition at line 1034 of file json_settings.cpp.
References GetJson().
|
inherited |
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 710 of file json_settings.cpp.
References GetJson().
Referenced by BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), COLOR_SETTINGS::COLOR_SETTINGS(), EDA_3D_VIEWER_SETTINGS::EDA_3D_VIEWER_SETTINGS(), EESCHEMA_SETTINGS::EESCHEMA_SETTINGS(), JSON_SETTINGS::Get< KIGFX::COLOR4D >(), JSON_SETTINGS::Get< KIGFX::CROSS_HAIR_MODE >(), JSON_SETTINGS::Get< nlohmann::json >(), JSON_SETTINGS::Get< std::string >(), 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_ENUM< EnumType >::MatchesFile(), PARAM_LAMBDA< ValueType >::MatchesFile(), PARAM_PATH::MatchesFile(), PARAM_SCALED< ValueType >::MatchesFile(), EESCHEMA_SETTINGS::migrateBomSettings(), EESCHEMA_SETTINGS::migrateFieldNameTemplates(), COMMON_SETTINGS::MigrateFromLegacy(), EESCHEMA_SETTINGS::MigrateFromLegacy(), SYMBOL_EDITOR_SETTINGS::MigrateFromLegacy(), APP_SETTINGS_BASE::migrateLibTreeWidth(), BOARD_DESIGN_SETTINGS::migrateSchema0to1(), PCBNEW_SETTINGS::PCBNEW_SETTINGS(), PROJECT_FILE::SaveAs(), and SCHEMATIC_SETTINGS::SCHEMATIC_SETTINGS().
|
inherited |
References KICOMMON_API.
|
inline |
Definition at line 136 of file project_file.h.
References m_boards.
|
overrideprotectedvirtual |
Reimplemented from JSON_SETTINGS.
Definition at line 1005 of file project_file.cpp.
References FILEEXT::ProjectFileExtension.
|
virtualinherited |
Reimplemented in GERBVIEW_SETTINGS.
Definition at line 459 of file json_settings.cpp.
References Contains(), and GetJson().
Referenced by GERBVIEW_SETTINGS::GetFileHistories().
|
inlineinherited |
Definition at line 88 of file json_settings.h.
References m_filename.
Referenced by AddNestedSettings(), cwdDirFor(), DATABASE_LIB_SETTINGS::ExpandedSource(), SETTINGS_MANAGER::loadAllColorSettings(), SETTINGS_MANAGER::loadColorSettingsByName(), NESTED_SETTINGS::LoadFromFile(), COLOR_SETTINGS::migrateSchema0to1(), PANEL_COLOR_SETTINGS::OnThemeChanged(), PANEL_EESCHEMA_COLOR_SETTINGS::PANEL_EESCHEMA_COLOR_SETTINGS(), PANEL_GERBVIEW_COLOR_SETTINGS::PANEL_GERBVIEW_COLOR_SETTINGS(), PANEL_PCBNEW_COLOR_SETTINGS::PANEL_PCBNEW_COLOR_SETTINGS(), PCB_PLOTTER::PlotJobToPlotOpts(), DIALOG_PLOT_SCHEMATIC::plotSchematic(), PROJECT_FILE::SaveAs(), SETTINGS_MANAGER::SaveColorSettings(), DIALOG_PRINT::SavePrintOptions(), DIALOG_PRINT_PCBNEW::saveSettings(), NESTED_SETTINGS::SaveToFile(), DIALOG_PLOT::setColorThemeSelection(), PANEL_PL_EDITOR_COLOR_SETTINGS::TransferDataFromWindow(), PANEL_SYM_COLOR_SETTINGS::TransferDataFromWindow(), and DIALOG_PLOT::transferPlotParamsToJob().
|
inherited |
Definition at line 118 of file json_settings.cpp.
References getFileExt(), and m_filename.
Referenced by JSON_SETTINGS(), LoadFromFile(), NESTED_SETTINGS::LoadFromFile(), parseAndMigrate(), SaveToFile(), and PROJECT_FILE::SerializeToString().
|
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 690 of file json_settings.cpp.
References m_internals.
Referenced by BOOST_AUTO_TEST_CASE(), Get(), GERBVIEW_SETTINGS::GetFileHistories(), GetFileHistories(), EESCHEMA_JOBS_HANDLER::JobDowngrade(), PARAM_LAMBDA< ValueType >::Load(), PARAM_LIST< Type >::Load(), PARAM_MAP< Value >::Load(), PARAM_SET< Type >::Load(), PARAM_WXSTRING_MAP::Load(), PARAM_LAMBDA< ValueType >::MatchesFile(), PARAM_LIST< Type >::MatchesFile(), PARAM_MAP< Value >::MatchesFile(), PARAM_PATH_LIST::MatchesFile(), PARAM_SET< Type >::MatchesFile(), PARAM_WXSTRING_MAP::MatchesFile(), PROJECT_FILE::migrateSchema3To4(), SETTINGS_MANAGER::SaveColorSettings(), and PROJECT_FILE::Store().
|
overrideprotectedvirtual |
Reimplemented from JSON_SETTINGS.
Definition at line 1011 of file project_file.cpp.
References FILEEXT::LegacyProjectFileExtension.
|
inlineinherited |
Definition at line 95 of file json_settings.h.
References m_location.
Referenced by SETTINGS_MANAGER::GetPathForSettingsFile(), and COLOR_SETTINGS::migrateSchema0to1().
|
inlineoverridevirtual |
Project-located settings override this to report the project they belong to so their save path is resolved against that project rather than the active one.
Reimplemented from JSON_SETTINGS.
Definition at line 126 of file project_file.h.
References m_project.
|
inline |
Definition at line 131 of file project_file.h.
References m_sheets.
Referenced by SCH_EDIT_FRAME::SaveProject().
|
inline |
Definition at line 141 of file project_file.h.
References m_topLevelSheets.
Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), EESCHEMA_JOBS_HANDLER::JobDowngrade(), SCH_EDIT_FRAME::OpenProjectFiles(), projectSchematic(), SCH_EDIT_FRAME::saveProjectSettings(), and SCH_EDIT_FRAME::TopLevelSheetsChangedOnDisk().
|
inline |
Definition at line 146 of file project_file.h.
References m_topLevelSheets.
|
inherited |
Definition at line 139 of file json_settings.cpp.
References m_internals.
Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), NET_SETTINGS::CopyFrom(), COLOR_SETTINGS::migrateSchema0to1(), PCBNEW_JOBS_HANDLER::runPcbMerge(), EESCHEMA_JOBS_HANDLER::runSchMerge(), SETTINGS_MANAGER::SaveColorSettings(), and DATABASE_LIB_SETTINGS::Store().
|
inlineinherited |
Definition at line 166 of file json_settings.h.
References m_fileSynced.
Referenced by reloadFromFile().
|
inlineinherited |
Definition at line 177 of file json_settings.h.
References m_isFutureFormat.
|
inlineinherited |
Definition at line 105 of file json_settings.h.
References m_writeFile.
Referenced by PANEL_COLOR_SETTINGS::GetSettingsDropdownName(), PANEL_COLOR_SETTINGS::OnThemeChanged(), APPEARANCE_CONTROLS::rebuildLayers(), SETTINGS_MANAGER::SaveColorSettings(), and APPEARANCE_CONTROLS::syncColorsAndVisibility().
|
inlineinherited |
SaveToFile() also returns false when it had nothing to write, so its result cannot tell a skipped save from a lost one.
Definition at line 174 of file json_settings.h.
References m_lastSaveFailed.
|
virtualinherited |
Updates the parameters of this object based on the current JSON document contents.
Reimplemented in DATABASE_LIB_SETTINGS.
Definition at line 145 of file json_settings.cpp.
References m_params, m_resetParamsIfMissing, and traceSettings.
Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), NET_SETTINGS::CopyFrom(), COLOR_SETTINGS::CreateBuiltinColorSettings(), DATABASE_LIB_SETTINGS::Load(), LoadFromBuffer(), BOARD_DESIGN_SETTINGS::LoadFromFile(), LoadFromFile(), NESTED_SETTINGS::LoadFromFile(), LoadFromRawFile(), PCB_TEST_FRAME_BASE::LoadSettings(), PCBNEW_SETTINGS::MigrateFromLegacy(), COLOR_SETTINGS::migrateSchema0to1(), PANEL_3D_DISPLAY_OPTIONS::ResetPanel(), PANEL_3D_OPENGL_OPTIONS::ResetPanel(), PANEL_3D_RAYTRACING_OPTIONS::ResetPanel(), PANEL_DISPLAY_OPTIONS::ResetPanel(), PANEL_EDIT_OPTIONS::ResetPanel(), PANEL_EESCHEMA_DISPLAY_OPTIONS::ResetPanel(), PANEL_EESCHEMA_EDITING_OPTIONS::ResetPanel(), PANEL_FP_EDITOR_FIELD_DEFAULTS::ResetPanel(), PANEL_FP_EDITOR_GRAPHICS_DEFAULTS::ResetPanel(), PANEL_FP_USER_LAYER_NAMES::ResetPanel(), PANEL_GERBVIEW_DISPLAY_OPTIONS::ResetPanel(), PANEL_PCBNEW_DISPLAY_ORIGIN::ResetPanel(), PANEL_PL_EDITOR_DISPLAY_OPTIONS::ResetPanel(), PANEL_SYM_DISPLAY_OPTIONS::ResetPanel(), PANEL_SYM_EDITING_OPTIONS::ResetPanel(), and SETTINGS_MANAGER::SaveColorSettings().
|
inherited |
Loads the document from file contents already in memory, so the caller can bound the read of the file.
Migrates the schema as LoadFromFile() does, but never writes the migrated result back and does not load nested settings.
| aContents | is the raw text of the backing file |
Definition at line 407 of file json_settings.cpp.
References ALLOW_EXCEPTIONS, IGNORE_COMMENTS, Load(), m_fileSynced, m_internals, m_modified, and parseAndMigrate().
|
overridevirtual |
Loads the backing file from disk and then calls Load()
| aDirectory | is the path to the file |
Reimplemented from JSON_SETTINGS.
Definition at line 823 of file project_file.cpp.
References TOP_LEVEL_SHEET_INFO::filename, FILEEXT::KiCadSchematicFileExtension, JSON_SETTINGS::LoadFromFile(), m_project, m_topLevelSheets, m_topLevelSheetsChanged, m_wasMigrated, TOP_LEVEL_SHEET_INFO::name, niluuid, traceSettings, and TOP_LEVEL_SHEET_INFO::uuid.
Referenced by SETTINGS_MANAGER::loadProjectFile(), PROJECT_TREE_TRAVERSER::OnFile(), ReloadOpenEditors(), and KICAD_MANAGER_FRAME::reloadProjectSettings().
|
inherited |
Definition at line 658 of file json_settings.cpp.
References ALLOW_EXCEPTIONS, IGNORE_COMMENTS, Load(), m_internals, and traceSettings.
|
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 813 of file json_settings.cpp.
References m_internals, m_migrators, m_schemaVersion, and traceSettings.
Referenced by NESTED_SETTINGS::LoadFromFile(), and parseAndMigrate().
|
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 380 of file project_file.cpp.
References JSON_SETTINGS::fromLegacy(), JSON_SETTINGS::fromLegacyString(), group, index, JSON_SETTINGS::Set(), ToStdString(), traceSettings, and via.
|
private |
Schema version 2: Bump for KiCad 9 layer numbering changes.
Migrate layer presets to use new enum values for copper layers.
Definition at line 329 of file project_file.cpp.
References JSON_SETTINGS::m_internals, m_wasMigrated, and PARAM_LAYER_PRESET::MigrateToV9Layers().
Referenced by PROJECT_FILE().
|
private |
Schema version 3: move layer presets to use named render layers.
Definition at line 347 of file project_file.cpp.
References JSON_SETTINGS::m_internals, m_wasMigrated, and PARAM_LAYER_PRESET::MigrateToNamedRenderLayers().
Referenced by PROJECT_FILE().
|
private |
Schema version 4 distinguishes explicit empty alias tables from older default writes.
Definition at line 365 of file project_file.cpp.
References JSON_SETTINGS::GetJson(), m_wasMigrated, and JSON_SETTINGS::Set().
Referenced by PROJECT_FILE().
|
inline |
Definition at line 157 of file project_file.h.
References m_NetSettings.
Referenced by BOOST_AUTO_TEST_CASE(), SCH_CONNECTIVITY::CaptureRows(), SCH_CONNECTIVITY::CaptureRows(), SCHEMATIC_SETTINGS::GetJunctionSize(), FIELDS_GRID_TABLE::initGrid(), NETLIST_EXPORTER_XML::makeNetChains(), SCH_CONNECTIVITY::FACADE::Recalculate(), and SCH_EDIT_FRAME::RefreshProjectSettings().
|
protectedinherited |
Definition at line 617 of file json_settings.cpp.
References m_internals.
Referenced by DATABASE_LIB_SETTINGS::Store().
|
privateinherited |
Parses a document into the store through aParse, then checks the schema version and migrates.
| aParse | fills the store, and returns false if there was nothing to parse |
| aMigrated | is set when a migration ran and succeeded |
| aParseError | is set when the document is not valid JSON |
Definition at line 348 of file json_settings.cpp.
References GetFullFilename(), m_internals, m_isFutureFormat, m_schemaVersion, Migrate(), and traceSettings.
Referenced by LoadFromBuffer(), and LoadFromFile().
|
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 804 of file json_settings.cpp.
References m_migrators, and 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(), ERC_SETTINGS::ERC_SETTINGS(), FOOTPRINT_EDITOR_SETTINGS::FOOTPRINT_EDITOR_SETTINGS(), MIGRATING_NESTED_SETTINGS::MIGRATING_NESTED_SETTINGS(), NET_SETTINGS::NET_SETTINGS(), PCBNEW_SETTINGS::PCBNEW_SETTINGS(), PROJECT_FILE::PROJECT_FILE(), SCHEMATIC_SETTINGS::SCHEMATIC_SETTINGS(), SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS(), and TUNING_PROFILES::TUNING_PROFILES().
|
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 1005 of file json_settings.cpp.
References JSON_SETTINGS(), m_manager, m_modified, m_nested_settings, NESTED_SETTINGS, NESTED_SETTINGS::SetParent(), and traceSettings.
Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), ~JSON_SETTINGS(), and SCHEMATIC_SETTINGS::~SCHEMATIC_SETTINGS().
|
inlineinherited |
Definition at line 114 of file json_settings.h.
References m_resetParamsIfMissing.
Referenced by COLOR_MAP_PARAM::MatchesFile(), PARAM< ValueType >::MatchesFile(), PARAM_ENUM< EnumType >::MatchesFile(), PARAM_LAMBDA< ValueType >::MatchesFile(), PARAM_LIST< Type >::MatchesFile(), PARAM_MAP< Value >::MatchesFile(), PARAM_PATH::MatchesFile(), PARAM_PATH_LIST::MatchesFile(), PARAM_SCALED< ValueType >::MatchesFile(), PARAM_SET< Type >::MatchesFile(), and PARAM_WXSTRING_MAP::MatchesFile().
|
inherited |
Resets all parameters to default values.
Does NOT write to file or update underlying JSON.
Definition at line 452 of file json_settings.cpp.
References m_params.
Referenced by PANEL_COMMON_SETTINGS::ResetPanel(), PANEL_MAINTENANCE::ResetPanel(), PANEL_MOUSE_SETTINGS::ResetPanel(), and PANEL_SPACEMOUSE::ResetPanel().
| bool PROJECT_FILE::SaveAs | ( | const wxString & | aDirectory, |
| const wxString & | aFile ) |
Definition at line 947 of file project_file.cpp.
References JSON_SETTINGS::Get(), JSON_SETTINGS::GetFilename(), LAST_PATH_FIRST, LAST_PATH_SIZE, m_BoardDrawingSheetFile, m_PcbLastPath, m_topLevelSheets, m_wasMigrated, path, FILEEXT::ProjectFileExtension, JSON_SETTINGS::SaveToFile(), JSON_SETTINGS::Set(), JSON_SETTINGS::SetFilename(), and JSON_SETTINGS::SetReadOnly().
Referenced by BOOST_AUTO_TEST_CASE(), PROJECT_TREE_TRAVERSER::OnFile(), ROUTER_TOOL::saveRouterDebugLog(), and ~PROJECT_FILE().
|
overridevirtual |
Calls Store() and then writes the contents of the JSON document to a file.
| aDirectory | is the directory to save to, including trailing separator. |
| aForce | is a flag to force a save to file. |
Reimplemented from JSON_SETTINGS.
Definition at line 904 of file project_file.cpp.
References m_project, m_topLevelSheetsChanged, m_wasMigrated, FILEEXT::ProjectFileExtension, JSON_SETTINGS::SaveToFile(), and JSON_SETTINGS::Set().
Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), and KICAD_MANAGER_CONTROL::SaveProjectAs().
| std::string PROJECT_FILE::SerializeToString | ( | ) |
Serialize to the bytes SaveToFile would write, without touching the file.
Definition at line 927 of file project_file.cpp.
References JSON_SETTINGS::flushToStore(), JSON_SETTINGS::formatFileContents(), JSON_SETTINGS::GetFullFilename(), JSON_SETTINGS::m_modified, m_project, FILEEXT::ProjectFileExtension, JSON_SETTINGS::Set(), and traceSettings.
Referenced by ~PROJECT_FILE().
|
inherited |
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 765 of file json_settings.cpp.
References m_internals.
Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), COLOR_SETTINGS::COLOR_SETTINGS(), EDA_3D_VIEWER_SETTINGS::EDA_3D_VIEWER_SETTINGS(), EESCHEMA_SETTINGS::EESCHEMA_SETTINGS(), JSON_SETTINGS::Set< KIGFX::COLOR4D >(), JSON_SETTINGS::Set< KIGFX::CROSS_HAIR_MODE >(), JSON_SETTINGS::Set< nlohmann::json >(), JSON_SETTINGS::Set< std::string >(), BOARD_DESIGN_SETTINGS::LoadFromFile(), APP_SETTINGS_BASE::migrateFindReplace(), APP_SETTINGS_BASE::MigrateFromLegacy(), COMMON_SETTINGS::MigrateFromLegacy(), EDA_3D_VIEWER_SETTINGS::MigrateFromLegacy(), EESCHEMA_SETTINGS::MigrateFromLegacy(), FOOTPRINT_EDITOR_SETTINGS::MigrateFromLegacy(), GERBVIEW_SETTINGS::MigrateFromLegacy(), KICAD_SETTINGS::MigrateFromLegacy(), PCBNEW_SETTINGS::MigrateFromLegacy(), PROJECT_FILE::MigrateFromLegacy(), SYMBOL_EDITOR_SETTINGS::MigrateFromLegacy(), BOARD_DESIGN_SETTINGS::migrateSchema0to1(), COLOR_SETTINGS::migrateSchema0to1(), ERC_SETTINGS::migrateSchema0to1(), FOOTPRINT_EDITOR_SETTINGS::migrateSchema0to1(), BOARD_DESIGN_SETTINGS::migrateSchema2to3(), PROJECT_FILE::migrateSchema3To4(), COMMON_SETTINGS::migrateSchema5to6(), MIGRATING_NESTED_SETTINGS::MIGRATING_NESTED_SETTINGS(), PCBNEW_SETTINGS::PCBNEW_SETTINGS(), PROJECT_FILE::SaveAs(), PROJECT_LOCAL_SETTINGS::SaveAs(), PROJECT_FILE::SaveToFile(), PROJECT_LOCAL_SETTINGS::SaveToFile(), SCHEMATIC_SETTINGS::SCHEMATIC_SETTINGS(), PROJECT_FILE::SerializeToString(), COLOR_MAP_PARAM::Store(), PARAM< ValueType >::Store(), PARAM_ENUM< EnumType >::Store(), PARAM_LAMBDA< ValueType >::Store(), PARAM_LIST< Type >::Store(), PARAM_MAP< Value >::Store(), PARAM_PATH::Store(), PARAM_PATH_LIST::Store(), PARAM_SCALED< ValueType >::Store(), PARAM_SET< Type >::Store(), and PARAM_WXSTRING_MAP::Store().
|
inherited |
Definition at line 1044 of file json_settings.cpp.
|
inherited |
References KICOMMON_API.
|
inlineinherited |
Definition at line 92 of file json_settings.h.
References m_filename.
Referenced by SETTINGS_MANAGER::GetColorSettings(), PROJECT_FILE::SaveAs(), PROJECT_LOCAL_SETTINGS::SaveAs(), SETTINGS_MANAGER::SaveProjectAs(), and SETTINGS_MANAGER::SaveProjectCopy().
|
staticinherited |
Sets the given bool if the given key/path is present.
| aObj | is the source object. |
| aPath | is the path of aObj. |
| aTarget | is the storage destination. |
Definition at line 870 of file json_settings.cpp.
References JSON_SETTINGS_INTERNALS::PointerFromString().
|
staticinherited |
Sets the given int if the given key/path is present.
| aObj | is the source object. |
| aPath | is the path of aObj. |
| aTarget | is the storage destination. |
Definition at line 884 of file json_settings.cpp.
References JSON_SETTINGS_INTERNALS::PointerFromString().
|
staticinherited |
Sets the given unsigned int if the given key/path is present.
| aObj | is the source object. |
| aPath | is the path of aObj. |
| aTarget | is the storage destination. |
Definition at line 898 of file json_settings.cpp.
References JSON_SETTINGS_INTERNALS::PointerFromString().
|
staticinherited |
Sets the given string if the given key/path is present.
| aObj | is the source object |
| aPath | is the path of aObj. |
| aTarget | is the storage destination |
Definition at line 856 of file json_settings.cpp.
References JSON_SETTINGS_INTERNALS::PointerFromString().
Referenced by FOOTPRINT_EDITOR_SETTINGS::FOOTPRINT_EDITOR_SETTINGS(), PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_SETTINGS(), and SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS().
|
inlineinherited |
Definition at line 103 of file json_settings.h.
References m_legacy_filename.
Referenced by SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS().
|
inlineinherited |
Definition at line 94 of file json_settings.h.
References m_location.
Referenced by COLOR_SETTINGS::COLOR_SETTINGS(), and COLOR_SETTINGS::migrateSchema0to1().
|
inlineinherited |
Definition at line 248 of file json_settings.h.
References m_manager.
Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), and BOOST_AUTO_TEST_CASE().
|
inline |
Definition at line 121 of file project_file.h.
References m_project.
Referenced by SETTINGS_MANAGER::loadProjectFile().
|
inlineinherited |
Definition at line 106 of file json_settings.h.
References m_writeFile.
Referenced by BOOST_AUTO_TEST_CASE(), SETTINGS_MANAGER::GetColorSettings(), SETTINGS_MANAGER::loadAllColorSettings(), PANEL_COLOR_SETTINGS::OnThemeChanged(), PROJECT_FILE::SaveAs(), PROJECT_LOCAL_SETTINGS::SaveAs(), and SETTINGS_MANAGER::SaveProjectAs().
|
inline |
Definition at line 172 of file project_file.h.
References JSON_SETTINGS::m_isFutureFormat, and m_wasMigrated.
Referenced by SETTINGS_MANAGER::unloadProjectFile().
|
overridevirtual |
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.
Reimplemented from JSON_SETTINGS.
Definition at line 894 of file project_file.cpp.
References JSON_SETTINGS::GetJson(), m_BusAliasesDefined, JSON_SETTINGS::m_modified, and JSON_SETTINGS::Store().
Referenced by PCBNEW_JOBS_HANDLER::runPcbMerge(), and EESCHEMA_JOBS_HANDLER::runSchMerge().
|
inline |
True when the last read of the file replaced a top-level sheet list held from before it.
Definition at line 152 of file project_file.h.
References m_topLevelSheetsChanged.
Referenced by SCH_EDIT_FRAME::TopLevelSheetsChangedOnDisk().
|
inline |
Definition at line 167 of file project_file.h.
References m_tuningProfileParameters.
Referenced by ChainBridgingDelayPerMm(), PCB_TUNING_PATTERN::CreateNew(), PCB_TUNING_PATTERN::EditStart(), and DIALOG_BOARD_SETUP::onAuxiliaryAction().
| wxString PROJECT_FILE::m_BoardDrawingSheetFile |
PcbNew params.
Drawing sheet file
Definition at line 234 of file project_file.h.
Referenced by KICAD_DIFF::PCB_MERGE_APPLIER::Apply(), KICAD_DIFF::PCB_DIFFER::Diff(), BOARD_LOADER::Load(), PCBNEW_JOBS_HANDLER::loadOverrideDrawingSheet(), PROJECT_FILE(), PCBNEW_JOBS_HANDLER::runPcbMerge(), SaveAs(), and API_HANDLER_PCB::setDrawingSheetFileName().
|
private |
A list of board files in this project.
Definition at line 302 of file project_file.h.
Referenced by GetBoards(), and PROJECT_FILE().
| std::shared_ptr<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. May be null if a board isn't loaded: be careful.
Definition at line 247 of file project_file.h.
Referenced by PROJECT_FILE().
| std::map<wxString, std::vector<wxString> > PROJECT_FILE::m_BusAliases |
Bus alias definitions for the schematic project.
Definition at line 217 of file project_file.h.
Referenced by DIALOG_SCHEMATIC_SETUP::onAuxiliaryAction(), PROJECT_FILE(), and SCH_EDIT_FRAME::ShowSchematicSetupDialog().
| bool PROJECT_FILE::m_BusAliasesDefined = false |
An explicit alias table was loaded or set, including a deliberately empty table.
Definition at line 220 of file project_file.h.
Referenced by BOOST_AUTO_TEST_CASE(), PROJECT_FILE(), and Store().
| std::shared_ptr<COMPONENT_CLASS_SETTINGS> PROJECT_FILE::m_ComponentClassSettings |
Component class settings for the project (owned here)
Definition at line 263 of file project_file.h.
Referenced by ComponentClassSettings(), DIALOG_BOARD_SETUP::onAuxiliaryAction(), and PROJECT_FILE().
|
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 392 of file json_settings.h.
Referenced by JSON_SETTINGS(), and SaveToFile().
|
protectedinherited |
Whether or not the backing store file should be created it if doesn't exist.
Definition at line 386 of file json_settings.h.
Referenced by JSON_SETTINGS(), and SaveToFile().
|
protectedinherited |
Whether or not to delete legacy file after migration.
Definition at line 407 of file json_settings.h.
Referenced by JSON_SETTINGS(), LoadFromFile(), PROJECT_FILE::PROJECT_FILE(), and PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_SETTINGS().
| std::vector<wxString> PROJECT_FILE::m_EquivalenceFiles |
CvPcb params.
List of equivalence (equ) files used in the project
Definition at line 227 of file project_file.h.
Referenced by PROJECT_FILE().
| ERC_SETTINGS* PROJECT_FILE::m_ErcSettings |
Eeschema params.
Definition at line 206 of file project_file.h.
Referenced by BOOST_AUTO_TEST_CASE(), EESCHEMA_JOBS_HANDLER::JobDowngrade(), and PROJECT_FILE().
|
protectedinherited |
The filename (not including path) of this settings file (inicode)
Definition at line 371 of file json_settings.h.
Referenced by APP_SETTINGS_BASE::addParamsForWindow(), COLOR_SETTINGS::COLOR_SETTINGS(), APP_SETTINGS_BASE::DefaultGridSizeList(), APP_SETTINGS_BASE::DefaultZoomList(), GetFilename(), GetFullFilename(), DATABASE_LIB_SETTINGS::GetLoadPath(), JSON_SETTINGS(), LoadFromFile(), NESTED_SETTINGS::LoadFromFile(), COLOR_SETTINGS::migrateSchema0to1(), COLOR_SETTINGS::operator=(), SaveToFile(), NESTED_SETTINGS::SaveToFile(), and SetFilename().
|
protectedinherited |
True once the store has been synchronized with an on-disk file (loaded or saved)
Definition at line 401 of file json_settings.h.
Referenced by IsFileSynced(), JSON_SETTINGS(), LoadFromBuffer(), LoadFromFile(), and SaveToFile().
| std::vector<wxString> PROJECT_FILE::m_FindByPropertiesQueries |
Recent queries for Find by Properties dialog.
Definition at line 237 of file project_file.h.
Referenced by DIALOG_FIND_BY_PROPERTIES::loadRecentQueries(), PROJECT_FILE(), and DIALOG_FIND_BY_PROPERTIES::saveRecentQuery().
| IDF_EXPORT_SETTINGS PROJECT_FILE::m_IdfExportSettings |
|
protectedinherited |
Definition at line 424 of file json_settings.h.
Referenced by At(), Contains(), FormatAsString(), formatFileContents(), GetJson(), Internals(), JSON_SETTINGS(), LoadFromBuffer(), LoadFromFile(), NESTED_SETTINGS::LoadFromFile(), LoadFromRawFile(), Migrate(), COMMON_SETTINGS::MigrateFromLegacy(), FOOTPRINT_EDITOR_SETTINGS::MigrateFromLegacy(), COLOR_SETTINGS::migrateSchema0to1(), COMMON_SETTINGS::migrateSchema0to1(), EDA_3D_VIEWER_SETTINGS::migrateSchema0to1(), NET_SETTINGS::migrateSchema0to1(), TUNING_PROFILES::migrateSchema0to1(), PROJECT_FILE::migrateSchema1To2(), COMMON_SETTINGS::migrateSchema1to2(), TUNING_PROFILES::migrateSchema1to2(), FOOTPRINT_EDITOR_SETTINGS::migrateSchema2To3(), PROJECT_FILE::migrateSchema2To3(), NET_SETTINGS::migrateSchema2to3(), FOOTPRINT_EDITOR_SETTINGS::migrateSchema3To4(), COMMON_SETTINGS::migrateSchema3to4(), NET_SETTINGS::migrateSchema3to4(), FOOTPRINT_EDITOR_SETTINGS::migrateSchema4To5(), COMMON_SETTINGS::migrateSchema4to5(), NET_SETTINGS::migrateSchema4to5(), originalJson(), parseAndMigrate(), NESTED_SETTINGS::SaveToFile(), and Set().
| struct IP2581_BOM PROJECT_FILE::m_IP2581Bom |
Layer pair list for the board.
Definition at line 275 of file project_file.h.
Referenced by BOOST_AUTO_TEST_CASE(), GenerateIpc2581File(), PROJECT_FILE(), SCH_EDIT_FRAME::saveProjectSettings(), DIALOG_EXPORT_2581::saveToProject(), and DIALOG_EXPORT_2581::TransferDataToWindow().
|
protectedinherited |
Set to true if this settings is loaded from a file with a newer schema version than is known.
Definition at line 416 of file json_settings.h.
Referenced by IsFutureFormat(), JSON_SETTINGS(), parseAndMigrate(), PROJECT_FILE::ShouldAutoSave(), and PROJECT_LOCAL_SETTINGS::ShouldAutoSave().
|
protectedinherited |
True if the most recent SaveToFile() had changes to write and could not write them.
Definition at line 404 of file json_settings.h.
Referenced by JSON_SETTINGS(), LastSaveFailed(), and SaveToFile().
| std::vector<LAYER_PAIR_INFO> PROJECT_FILE::m_LayerPairInfos |
List of stored 3D viewports (view matrixes)
Definition at line 273 of file project_file.h.
Referenced by EVT_UPDATE_UI_RANGE(), PCB_EDIT_FRAME::OnBoardLoaded(), and PROJECT_FILE().
| std::vector<LAYER_PRESET> PROJECT_FILE::m_LayerPresets |
Definition at line 270 of file project_file.h.
Referenced by PROJECT_FILE().
|
protectedinherited |
The filename of the wxConfig legacy file (if different from m_filename)
Definition at line 374 of file json_settings.h.
Referenced by JSON_SETTINGS(), LoadFromFile(), and SetLegacyFilename().
| wxString PROJECT_FILE::m_LegacyLibDir |
Definition at line 212 of file project_file.h.
Referenced by PROJECT_FILE().
| wxArrayString PROJECT_FILE::m_LegacyLibNames |
Definition at line 214 of file project_file.h.
Referenced by PROJECT_FILE().
|
protectedinherited |
The location of this settings file (.
Definition at line 377 of file json_settings.h.
Referenced by GetLocation(), JSON_SETTINGS(), and SetLocation().
|
protectedinherited |
A pointer to the settings manager managing this file (may be null)
Definition at line 419 of file json_settings.h.
Referenced by JSON_SETTINGS(), COLOR_SETTINGS::migrateSchema0to1(), FOOTPRINT_EDITOR_SETTINGS::migrateSchema0to1(), ReleaseNestedSettings(), and SetManager().
|
protectedinherited |
A map of starting schema version to a pair of <ending version, migrator function>
Definition at line 422 of file json_settings.h.
Referenced by Migrate(), and registerMigration().
|
protectedinherited |
True if the JSON data store has been written to since the last file write.
Definition at line 398 of file json_settings.h.
Referenced by TEST_JSON_SETTINGS::ClearModified(), DISK_SETTINGS::ForceModified(), TEST_JSON_SETTINGS::IsModified(), JSON_SETTINGS(), LoadFromBuffer(), LoadFromFile(), ReleaseNestedSettings(), SaveToFile(), PROJECT_FILE::SerializeToString(), Store(), and PROJECT_FILE::Store().
|
protectedinherited |
Nested settings files that live inside this one, if any.
Definition at line 383 of file json_settings.h.
Referenced by AddNestedSettings(), flushToStore(), LoadFromFile(), NESTED_SETTINGS::LoadFromFile(), ReleaseNestedSettings(), and ~JSON_SETTINGS().
| std::shared_ptr<NET_SETTINGS> PROJECT_FILE::m_NetSettings |
Net settings for this project (owned here)
Definition at line 256 of file project_file.h.
Referenced by SCH_ITEM::GetEffectiveNetClass(), API_HANDLER_COMMON::handleGetNetClassAssignments(), API_HANDLER_COMMON::handleGetNetClasses(), API_HANDLER_COMMON::handleSetNetClassAssignments(), API_HANDLER_COMMON::handleSetNetClasses(), NetSettings(), DIALOG_BOARD_SETUP::onAuxiliaryAction(), DIALOG_SCHEMATIC_SETUP::onAuxiliaryAction(), and PROJECT_FILE().
|
protectedinherited |
The list of parameters (owned by this object)
Definition at line 380 of file json_settings.h.
Referenced by PCB_VIEWERS_SETTINGS_BASE::addMatchPropertiesParam(), APP_SETTINGS_BASE::addParamsForWindow(), APP_SETTINGS_BASE::APP_SETTINGS_BASE(), BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), COLOR_SETTINGS::COLOR_SETTINGS(), COMMON_SETTINGS::COMMON_SETTINGS(), COMPONENT_CLASS_SETTINGS::COMPONENT_CLASS_SETTINGS(), COLOR_SETTINGS::CreateBuiltinColorSettings(), CVPCB_SETTINGS::CVPCB_SETTINGS(), DATABASE_LIB_SETTINGS::DATABASE_LIB_SETTINGS(), DISK_PARENT_SETTINGS::DISK_PARENT_SETTINGS(), DISK_SETTINGS::DISK_SETTINGS(), EDA_3D_VIEWER_SETTINGS::EDA_3D_VIEWER_SETTINGS(), EESCHEMA_SETTINGS::EESCHEMA_SETTINGS(), ERC_SETTINGS::ERC_SETTINGS(), FLUSH_TEST_SETTINGS::FLUSH_TEST_SETTINGS(), FOOTPRINT_EDITOR_SETTINGS::FOOTPRINT_EDITOR_SETTINGS(), formatFileContents(), GERBVIEW_SETTINGS::GERBVIEW_SETTINGS(), COLOR_SETTINGS::GetDefaultColor(), HTTP_LIB_SETTINGS::HTTP_LIB_SETTINGS(), COLOR_SETTINGS::initFromOther(), JOBSET::JOBSET(), JSON_SETTINGS(), KICAD_SETTINGS::KICAD_SETTINGS(), Load(), NET_SETTINGS::NET_SETTINGS(), NGSPICE_SETTINGS::NGSPICE_SETTINGS(), PCB_CALCULATOR_SETTINGS::PCB_CALCULATOR_SETTINGS(), PCBNEW_SETTINGS::PCBNEW_SETTINGS(), PL_EDITOR_SETTINGS::PL_EDITOR_SETTINGS(), PROJECT_FILE::PROJECT_FILE(), PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_SETTINGS(), ResetToDefaults(), PNS::ROUTING_SETTINGS::ROUTING_SETTINGS(), NESTED_SETTINGS::SaveToFile(), SCHEMATIC_SETTINGS::SCHEMATIC_SETTINGS(), SPICE_SETTINGS::SPICE_SETTINGS(), Store(), SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS(), TEST_NESTED_SETTINGS::TEST_NESTED_SETTINGS(), TOOLBAR_SETTINGS::TOOLBAR_SETTINGS(), TUNING_PROFILES::TUNING_PROFILES(), and ~JSON_SETTINGS().
| wxString PROJECT_FILE::m_PcbLastPath[LAST_PATH_SIZE] |
MRU path storage.
Definition at line 240 of file project_file.h.
Referenced by PROJECT_FILE(), SaveAs(), and DIALOG_PLOT::TransferDataToWindow().
| std::vector<wxString> PROJECT_FILE::m_PinnedDesignBlockLibs |
The list of pinned design block libraries.
Definition at line 194 of file project_file.h.
Referenced by PROJECT_FILE().
| std::vector<wxString> PROJECT_FILE::m_PinnedFootprintLibs |
The list of pinned footprint libraries.
Definition at line 191 of file project_file.h.
Referenced by PROJECT_FILE().
| 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 application The list of pinned symbol libraries
Definition at line 188 of file project_file.h.
Referenced by PROJECT_FILE().
|
private |
Definition at line 305 of file project_file.h.
Referenced by GetOwningProject(), LoadFromFile(), PROJECT_FILE(), SaveToFile(), SerializeToString(), and SetProject().
|
protectedinherited |
Whether or not to set parameters to their default value if missing from JSON on Load()
Definition at line 410 of file json_settings.h.
Referenced by BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), JSON_SETTINGS(), Load(), ResetsParamsIfMissing(), and TEST_NESTED_SETTINGS::TEST_NESTED_SETTINGS().
| SCHEMATIC_SETTINGS* PROJECT_FILE::m_SchematicSettings |
Definition at line 209 of file project_file.h.
Referenced by BOOST_AUTO_TEST_CASE(), EESCHEMA_JOBS_HANDLER::JobDowngrade(), SIMULATOR_FRAME::LoadSettings(), PROJECT_FILE(), SCH_EDIT_FRAME::saveProjectSettings(), SIMULATOR_FRAME::SaveSettings(), SIMULATOR_FRAME::SIMULATOR_FRAME(), and SIMULATOR_FRAME::UpdateTitle().
|
protectedinherited |
Version of this settings schema.
Definition at line 413 of file json_settings.h.
Referenced by JSON_SETTINGS(), LoadFromFile(), NESTED_SETTINGS::LoadFromFile(), Migrate(), parseAndMigrate(), registerMigration(), and NESTED_SETTINGS::SaveToFile().
|
private |
An list of schematic sheets in this project.
Definition at line 296 of file project_file.h.
Referenced by GetSheets(), and PROJECT_FILE().
| TEMPLATES PROJECT_FILE::m_TemplateFieldNames |
Project and global field name templates shared by project editors.
Definition at line 199 of file project_file.h.
Referenced by EESCHEMA_JOBS_HANDLER::JobExportBom(), DIALOG_SCHEMATIC_SETUP::onAuxiliaryAction(), PROJECT_FILE(), SETTINGS_MANAGER::SyncGlobalFieldNameTemplatesToProjects(), and DIALOG_SYMBOL_PROPERTIES::TransferDataToWindow().
| std::map<wxString, wxString> PROJECT_FILE::m_TextVars |
Definition at line 196 of file project_file.h.
Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), PROJECT::GetTextVars(), and PROJECT_FILE().
|
private |
A list of top-level schematic sheets in this project.
Definition at line 299 of file project_file.h.
Referenced by GetTopLevelSheets(), GetTopLevelSheets(), LoadFromFile(), PROJECT_FILE(), and SaveAs().
|
private |
Definition at line 308 of file project_file.h.
Referenced by AcknowledgeTopLevelSheetChange(), LoadFromFile(), PROJECT_FILE(), SaveToFile(), and TopLevelSheetsChangedOnLoad().
| std::shared_ptr<TUNING_PROFILES> PROJECT_FILE::m_tuningProfileParameters |
Tuning profile parameters for this project.
Definition at line 268 of file project_file.h.
Referenced by PROJECT_FILE(), and TuningProfileParameters().
| std::vector<VIEWPORT> PROJECT_FILE::m_Viewports |
List of stored layer presets.
Definition at line 271 of file project_file.h.
Referenced by PROJECT_FILE().
| std::vector<VIEWPORT3D> PROJECT_FILE::m_Viewports3D |
List of stored viewports (pos + zoom)
Definition at line 272 of file project_file.h.
Referenced by PROJECT_FILE(), and EDA_3D_VIEWER_FRAME::~EDA_3D_VIEWER_FRAME().
|
private |
Definition at line 307 of file project_file.h.
Referenced by LoadFromFile(), migrateSchema1To2(), migrateSchema2To3(), migrateSchema3To4(), PROJECT_FILE(), SaveAs(), SaveToFile(), and ShouldAutoSave().
|
protectedinherited |
Whether or not the backing store file should be written.
Definition at line 395 of file json_settings.h.
Referenced by COLOR_SETTINGS::CreateBuiltinColorSettings(), COLOR_SETTINGS::initFromOther(), IsReadOnly(), JSON_SETTINGS(), LoadFromFile(), SaveToFile(), and SetReadOnly().