The backing store for a PROJECT, in JSON format. More...

#include <project_file.h>

Inheritance diagram for PROJECT_FILE:

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	SaveToFile (const wxString &aDirectory="", bool aForce=false) override
	Calls Store() and then writes the contents of the JSON document to a file.

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

void	SetProject (PROJECT *aProject)

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

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)

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.

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.

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

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.

std::vector< wxString >	m_EquivalenceFiles
	CvPcb params.

wxString	m_BoardDrawingSheetFile
	PcbNew params.

wxString	m_PcbLastPath [LAST_PATH_SIZE]
	MRU path storage.

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.

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.

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.

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_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 ()
	IPC-2581 BOM settings.

bool	migrateSchema2To3 ()
	Schema version 3: move layer presets to use named render layers.

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

Detailed Description

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 93 of file project_file.h.

Constructor & Destructor Documentation

◆ PROJECT_FILE()

PROJECT_FILE::PROJECT_FILE ( const wxString & aFullPath )

Construct the project file for a project.

Parameters

aFullPath is the full disk path to the project

Definition at line 40 of file project_file.cpp.

References JSON_SETTINGS::JSON_SETTINGS(), LAST_PATH_IDF, LAST_PATH_NETLIST, LAST_PATH_PLOT, LAST_PATH_SPECCTRADSN, LAST_PATH_VRML, m_BoardDrawingSheetFile, m_boards, m_BoardSettings, m_BusAliases, m_ComponentClassSettings, JSON_SETTINGS::m_deleteLegacyAfterMigration, m_EquivalenceFiles, m_ErcSettings, m_IP2581Bom, m_LayerPairInfos, m_LayerPresets, m_LegacyLibDir, m_LegacyLibNames, m_NetSettings, JSON_SETTINGS::m_params, m_PcbLastPath, m_PinnedFootprintLibs, m_PinnedSymbolLibs, m_project, m_SchematicSettings, m_sheets, m_TextVars, m_topLevelSheets, m_tuningProfileParameters, m_Viewports, m_Viewports3D, m_wasMigrated, migrateSchema1To2(), migrateSchema2To3(), projectFileSchemaVersion, and JSON_SETTINGS::registerMigration().

◆ ~PROJECT_FILE()

virtual PROJECT_FILE::~PROJECT_FILE ( )

virtualdefault

References SaveAs().

Member Function Documentation

◆ AddNestedSettings()

void JSON_SETTINGS::AddNestedSettings ( NESTED_SETTINGS * aSettings )

inherited

Transfers ownership of a given NESTED_SETTINGS to this object.

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

Parameters

aSettings	is the settings object to take ownership of
aTarget	is a pointer to update to the passed in settings

Definition at line 907 of file json_settings.cpp.

References GetFilename(), m_nested_settings, NESTED_SETTINGS, and traceSettings.

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

Referenced by BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), EDA_3D_VIEWER_SETTINGS::EDA_3D_VIEWER_SETTINGS(), EESCHEMA_SETTINGS::migrateBomSettings(), GERBVIEW_SETTINGS::MigrateFromLegacy(), APP_SETTINGS_BASE::migrateLibTreeWidth(), BOARD_DESIGN_SETTINGS::migrateSchema0to1(), COLOR_SETTINGS::migrateSchema0to1(), and FOOTPRINT_EDITOR_SETTINGS::migrateSchema0to1().

◆ ComponentClassSettings()

std::shared_ptr< COMPONENT_CLASS_SETTINGS > & PROJECT_FILE::ComponentClassSettings ( )

inline

Definition at line 142 of file project_file.h.

References m_ComponentClassSettings.

Referenced by BOARD::SynchronizeComponentClasses().

◆ Contains()

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

inherited

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

◆ fetchOrDefault()

template<typename ResultType>

template KICOMMON_API 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

ResultType is the type of the retrieved value.

Parameters

aJson	is the object to act on .
aKey	is the object key to retrieve the value for.

Returns: the result, or aDefault if aKey is not found.

Definition at line 955 of file json_settings.cpp.

◆ FormatAsString()

const std::string JSON_SETTINGS::FormatAsString ( )

inherited

Definition at line 538 of file json_settings.cpp.

References dummy, m_internals, and Store().

◆ fromLegacy()

template<typename ValueType>

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

protectedinherited

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

Template Parameters

ValueType is the basic type of the value

Parameters

aConfig	is the legacy config to read from
aKey	is the key (within the current path) to read
aDest	is a string that will form a JSON pointer (key1.key2.key3) to write to

Definition at line 816 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

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

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

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

◆ Get() [1/3]

template<>

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

inherited

Definition at line 938 of file json_settings.cpp.

References GetJson().

◆ Get() [2/3]

template<typename ValueType>

template KICOMMON_API 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

ValueType is the type to cast to

Parameters

aPath is the path within the document to retrieve

Returns: a value from within this document

Definition at line 603 of file json_settings.cpp.

References GetJson().

Referenced by BITMAP2CMP_SETTINGS::BITMAP2CMP_SETTINGS(), BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), 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(), COMMON_SETTINGS::MigrateFromLegacy(), EESCHEMA_SETTINGS::MigrateFromLegacy(), SYMBOL_EDITOR_SETTINGS::MigrateFromLegacy(), APP_SETTINGS_BASE::migrateLibTreeWidth(), BOARD_DESIGN_SETTINGS::migrateSchema0to1(), PROJECT_FILE::SaveAs(), and SCHEMATIC_SETTINGS::SCHEMATIC_SETTINGS().

◆ Get() [3/3]

template<>

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

inherited

References KICOMMON_API.

◆ GetBoards()

std::vector< FILE_INFO_PAIR > & PROJECT_FILE::GetBoards ( )

inline

Definition at line 122 of file project_file.h.

References m_boards.

◆ getFileExt()

wxString PROJECT_FILE::getFileExt ( ) const

overrideprotectedvirtual

Reimplemented from JSON_SETTINGS.

Definition at line 771 of file project_file.cpp.

References FILEEXT::ProjectFileExtension.

◆ GetFileHistories()

std::map< std::string, nlohmann::json > JSON_SETTINGS::GetFileHistories ( )

virtualinherited

Reimplemented in GERBVIEW_SETTINGS.

Definition at line 400 of file json_settings.cpp.

References Contains(), and GetJson().

Referenced by GERBVIEW_SETTINGS::GetFileHistories().

◆ GetFilename()

wxString JSON_SETTINGS::GetFilename ( ) const

inlineinherited

Definition at line 87 of file json_settings.h.

References m_filename.

Referenced by AddNestedSettings(), SETTINGS_MANAGER::loadColorSettingsByName(), NESTED_SETTINGS::LoadFromFile(), EESCHEMA_SETTINGS::MigrateFromLegacy(), GERBVIEW_SETTINGS::MigrateFromLegacy(), PCBNEW_SETTINGS::MigrateFromLegacy(), 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(), PANEL_PL_EDITOR_COLOR_SETTINGS::TransferDataFromWindow(), and PANEL_SYM_COLOR_SETTINGS::TransferDataFromWindow().

◆ GetFullFilename()

wxString JSON_SETTINGS::GetFullFilename ( ) const

inherited

Definition at line 110 of file json_settings.cpp.

References getFileExt(), and m_filename.

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

◆ GetJson()

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

inherited

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

Parameters

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

Returns: a JSON object from within this one

Definition at line 583 of file json_settings.cpp.

References m_internals.

Referenced by Get(), GERBVIEW_SETTINGS::GetFileHistories(), GetFileHistories(), 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(), and SETTINGS_MANAGER::SaveColorSettings().

◆ getLegacyFileExt()

wxString PROJECT_FILE::getLegacyFileExt ( ) const

overrideprotectedvirtual

Reimplemented from JSON_SETTINGS.

Definition at line 777 of file project_file.cpp.

References FILEEXT::LegacyProjectFileExtension.

◆ GetLocation()

SETTINGS_LOC JSON_SETTINGS::GetLocation ( ) const

inlineinherited

Definition at line 94 of file json_settings.h.

References m_location.

Referenced by SETTINGS_MANAGER::GetPathForSettingsFile(), and COLOR_SETTINGS::migrateSchema0to1().

◆ GetSheets()

std::vector< FILE_INFO_PAIR > & PROJECT_FILE::GetSheets ( )

inline

Definition at line 117 of file project_file.h.

References m_sheets.

Referenced by SCH_EDIT_FRAME::SaveProject().

◆ GetTopLevelSheets() [1/2]

std::vector< TOP_LEVEL_SHEET_INFO > & PROJECT_FILE::GetTopLevelSheets ( )

inline

Definition at line 127 of file project_file.h.

References m_topLevelSheets.

Referenced by BOOST_AUTO_TEST_CASE(), SCH_EDIT_FRAME::OpenProjectFiles(), and SCH_EDIT_FRAME::saveProjectSettings().

◆ GetTopLevelSheets() [2/2]

const std::vector< TOP_LEVEL_SHEET_INFO > & PROJECT_FILE::GetTopLevelSheets ( ) const

inline

Definition at line 132 of file project_file.h.

References m_topLevelSheets.

◆ Internals()

JSON_SETTINGS_INTERNALS * JSON_SETTINGS::Internals ( )

inherited

Definition at line 131 of file json_settings.cpp.

References m_internals.

Referenced by COLOR_SETTINGS::migrateSchema0to1(), and SETTINGS_MANAGER::SaveColorSettings().

◆ IsReadOnly()

bool JSON_SETTINGS::IsReadOnly ( ) const

inlineinherited

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

◆ Load()

void JSON_SETTINGS::Load ( )

virtualinherited

Updates the parameters of this object based on the current JSON document contents.

Definition at line 137 of file json_settings.cpp.

References m_params, m_resetParamsIfMissing, and traceSettings.

◆ LoadFromFile()

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

overridevirtual

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

Parameters

aDirectory is the path to the file

Returns: true if the file was found on disk and loaded or migrated

Reimplemented from JSON_SETTINGS.

Definition at line 672 of file project_file.cpp.

References TOP_LEVEL_SHEET_INFO::filename, JSON_SETTINGS::LoadFromFile(), m_project, m_topLevelSheets, m_wasMigrated, TOP_LEVEL_SHEET_INFO::name, niluuid, traceSettings, and TOP_LEVEL_SHEET_INFO::uuid.

Referenced by SETTINGS_MANAGER::loadProjectFile(), and PROJECT_TREE_TRAVERSER::OnFile().

◆ LoadFromRawFile()

bool JSON_SETTINGS::LoadFromRawFile ( const wxString & aPath )

inherited

Definition at line 551 of file json_settings.cpp.

References Load(), m_internals, and traceSettings.

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

References m_internals, m_migrators, m_schemaVersion, and traceSettings.

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

◆ MigrateFromLegacy()

bool PROJECT_FILE::MigrateFromLegacy ( wxConfigBase * aLegacyConfig )

overridevirtual

Migrates from wxConfig to JSON-based configuration.

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

Parameters

aLegacyConfig is a wxConfigBase holding a loaded configuration to migrate

Returns: true if migration was successful

Reimplemented from JSON_SETTINGS.

Definition at line 230 of file project_file.cpp.

References JSON_SETTINGS::fromLegacy(), JSON_SETTINGS::fromLegacyString(), group, JSON_SETTINGS::Set(), traceSettings, and via.

◆ migrateSchema1To2()

bool PROJECT_FILE::migrateSchema1To2 ( )

private

IPC-2581 BOM settings.

Schema version 2: Bump for KiCad 9 layer numbering changes.

Migrate layer presets to use new enum values for copper layers.

Definition at line 194 of file project_file.cpp.

References JSON_SETTINGS::m_internals, m_wasMigrated, and PARAM_LAYER_PRESET::MigrateToV9Layers().

Referenced by PROJECT_FILE().

◆ migrateSchema2To3()

bool PROJECT_FILE::migrateSchema2To3 ( )

private

Schema version 3: move layer presets to use named render layers.

Definition at line 212 of file project_file.cpp.

References JSON_SETTINGS::m_internals, m_wasMigrated, and PARAM_LAYER_PRESET::MigrateToNamedRenderLayers().

Referenced by PROJECT_FILE().

◆ NetSettings()

std::shared_ptr< NET_SETTINGS > & PROJECT_FILE::NetSettings ( )

inline

Definition at line 137 of file project_file.h.

References m_NetSettings.

Referenced by SCH_EDIT_FRAME::GetSchematicJunctionSize(), and FIELDS_GRID_TABLE::initGrid().

◆ registerMigration()

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

protectedinherited

Registers a migration from one schema version to another.

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

Parameters

aOldSchemaVersion	is the starting schema version for this migration
aNewSchemaVersion	is the ending schema version for this migration
aMigrator	is a function that performs the migration and returns true if successful

Definition at line 697 of file json_settings.cpp.

References m_migrators, and m_schemaVersion.

Referenced by BITMAP2CMP_SETTINGS::BITMAP2CMP_SETTINGS(), BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), COLOR_SETTINGS::COLOR_SETTINGS(), EDA_3D_VIEWER_SETTINGS::EDA_3D_VIEWER_SETTINGS(), EESCHEMA_SETTINGS::EESCHEMA_SETTINGS(), NET_SETTINGS::NET_SETTINGS(), PROJECT_FILE::PROJECT_FILE(), SCHEMATIC_SETTINGS::SCHEMATIC_SETTINGS(), and SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS().

◆ ReleaseNestedSettings()

void JSON_SETTINGS::ReleaseNestedSettings ( NESTED_SETTINGS * aSettings )

inherited

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

Parameters

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

Definition at line 914 of file json_settings.cpp.

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

Referenced by 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 393 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().

◆ SaveAs()

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

Definition at line 719 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 PROJECT_TREE_TRAVERSER::OnFile(), ROUTER_TOOL::saveRouterDebugLog(), and ~PROJECT_FILE().

◆ SaveToFile()

bool PROJECT_FILE::SaveToFile	(	const wxString &	aDirectory = "",
		bool	aForce = false )

overridevirtual

Calls Store() and then writes the contents of the JSON document to a file.

Parameters

aDirectory is the directory to save to, including trailing separator

Returns: true if the file was saved

Reimplemented from JSON_SETTINGS.

Definition at line 702 of file project_file.cpp.

References m_project, m_wasMigrated, FILEEXT::ProjectFileExtension, JSON_SETTINGS::SaveToFile(), and JSON_SETTINGS::Set().

Referenced by KICAD_MANAGER_CONTROL::SaveProjectAs().

◆ Set() [1/3]

template<typename ValueType>

template KICOMMON_API 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

ValueType is the type to store

Parameters

aPath	is a path to store in the form "key1.key2.key3"
aVal	is the value to store

Definition at line 658 of file json_settings.cpp.

References m_internals.

◆ Set() [2/3]

template<>

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

inherited

Definition at line 948 of file json_settings.cpp.

◆ Set() [3/3]

template<>

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

inherited

References KICOMMON_API.

◆ SetFilename()

void JSON_SETTINGS::SetFilename ( const wxString & aFilename )

inlineinherited

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

◆ SetIfPresent() [1/4]

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

staticinherited

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

Parameters

aObj	is the source object
aTarget	is the storage destination

Returns: True if set, false if not

Definition at line 770 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

aObj	is the source object
aTarget	is the storage destination

Returns: True if set, false if not

Definition at line 785 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

aObj	is the source object
aTarget	is the storage destination

Returns: True if set, false if not

Definition at line 800 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

aObj	is the source object
aTarget	is the storage destination

Returns: True if set, false if not

Definition at line 755 of file json_settings.cpp.

References JSON_SETTINGS_INTERNALS::PointerFromString().

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

◆ SetLegacyFilename()

void JSON_SETTINGS::SetLegacyFilename ( const wxString & aFilename )

inlineinherited

Definition at line 96 of file json_settings.h.

References m_legacy_filename.

Referenced by SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS().

◆ SetLocation()

void JSON_SETTINGS::SetLocation ( SETTINGS_LOC aLocation )

inlineinherited

Definition at line 93 of file json_settings.h.

References m_location.

Referenced by COLOR_SETTINGS::COLOR_SETTINGS(), and COLOR_SETTINGS::migrateSchema0to1().

◆ SetManager()

void JSON_SETTINGS::SetManager ( SETTINGS_MANAGER * aManager )

inlineinherited

Definition at line 207 of file json_settings.h.

References m_manager.

◆ SetProject()

void PROJECT_FILE::SetProject ( PROJECT * aProject )

inline

Definition at line 112 of file project_file.h.

References m_project.

Referenced by SETTINGS_MANAGER::loadProjectFile().

◆ SetReadOnly()

void JSON_SETTINGS::SetReadOnly ( bool aReadOnly )

inlineinherited

Definition at line 99 of file json_settings.h.

References m_writeFile.

Referenced by SETTINGS_MANAGER::GetColorSettings(), SETTINGS_MANAGER::loadAllColorSettings(), PANEL_COLOR_SETTINGS::OnThemeChanged(), PROJECT_FILE::SaveAs(), and SETTINGS_MANAGER::SaveProjectAs().

◆ ShouldAutoSave()

bool PROJECT_FILE::ShouldAutoSave ( ) const

inline

Returns: true if it should be safe to auto-save this file without user action

Definition at line 152 of file project_file.h.

References JSON_SETTINGS::m_isFutureFormat, and m_wasMigrated.

Referenced by SETTINGS_MANAGER::unloadProjectFile().

◆ 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 has been updated since the last save to disk

Definition at line 381 of file json_settings.cpp.

References m_modified, and m_params.

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

◆ TuningProfileParameters()

std::shared_ptr< TUNING_PROFILES > & PROJECT_FILE::TuningProfileParameters ( )

inline

Definition at line 147 of file project_file.h.

References m_tuningProfileParameters.

Referenced by DIALOG_BOARD_SETUP::onAuxiliaryAction().

Member Data Documentation

◆ m_BoardDrawingSheetFile

wxString PROJECT_FILE::m_BoardDrawingSheetFile

PcbNew params.

Drawing sheet file

Definition at line 208 of file project_file.h.

Referenced by PCBNEW_JOBS_HANDLER::loadOverrideDrawingSheet(), PROJECT_FILE(), and SaveAs().

◆ m_boards

std::vector<FILE_INFO_PAIR> PROJECT_FILE::m_boards

private

A list of board files in this project.

Definition at line 268 of file project_file.h.

Referenced by GetBoards(), and PROJECT_FILE().

◆ m_BoardSettings

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 218 of file project_file.h.

Referenced by PROJECT_FILE().

◆ m_BusAliases

std::map<wxString, std::vector<wxString> > PROJECT_FILE::m_BusAliases

Bus alias definitions for the schematic project.

Definition at line 194 of file project_file.h.

Referenced by DIALOG_SCHEMATIC_SETUP::onAuxiliaryAction(), PROJECT_FILE(), and SCH_EDIT_FRAME::ShowSchematicSetupDialog().

◆ m_ComponentClassSettings

std::shared_ptr<COMPONENT_CLASS_SETTINGS> PROJECT_FILE::m_ComponentClassSettings

Component class settings for the project (owned here)

Definition at line 234 of file project_file.h.

Referenced by ComponentClassSettings(), DIALOG_BOARD_SETUP::onAuxiliaryAction(), and PROJECT_FILE().

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

Referenced by JSON_SETTINGS(), and 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 328 of file json_settings.h.

Referenced by JSON_SETTINGS(), and SaveToFile().

◆ m_deleteLegacyAfterMigration

bool JSON_SETTINGS::m_deleteLegacyAfterMigration

protectedinherited

Whether or not to delete legacy file after migration.

Definition at line 343 of file json_settings.h.

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

◆ m_EquivalenceFiles

std::vector<wxString> PROJECT_FILE::m_EquivalenceFiles

CvPcb params.

List of equivalence (equ) files used in the project

Definition at line 201 of file project_file.h.

Referenced by PROJECT_FILE().

◆ m_ErcSettings

ERC_SETTINGS* PROJECT_FILE::m_ErcSettings

Eeschema params.

Definition at line 183 of file project_file.h.

Referenced by DIALOG_SCHEMATIC_SETUP::onAuxiliaryAction(), and PROJECT_FILE().

◆ m_filename

wxString JSON_SETTINGS::m_filename

protectedinherited

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

Definition at line 313 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(), JSON_SETTINGS(), LoadFromFile(), NESTED_SETTINGS::LoadFromFile(), COLOR_SETTINGS::migrateSchema0to1(), COLOR_SETTINGS::operator=(), SaveToFile(), NESTED_SETTINGS::SaveToFile(), and SetFilename().

◆ m_internals

std::unique_ptr<JSON_SETTINGS_INTERNALS> JSON_SETTINGS::m_internals

protectedinherited

Definition at line 360 of file json_settings.h.

◆ m_IP2581Bom

struct IP2581_BOM PROJECT_FILE::m_IP2581Bom

Layer pair list for the board.

Definition at line 246 of file project_file.h.

Referenced by PROJECT_FILE(), DIALOG_EXPORT_2581::TransferDataFromWindow(), and DIALOG_EXPORT_2581::TransferDataToWindow().

◆ m_isFutureFormat

bool JSON_SETTINGS::m_isFutureFormat

protectedinherited

Set to true if this settings is loaded from a file with a newer schema version than is known.

Definition at line 352 of file json_settings.h.

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

◆ m_LayerPairInfos

std::vector<LAYER_PAIR_INFO> PROJECT_FILE::m_LayerPairInfos

List of stored 3D viewports (view matrixes)

Definition at line 244 of file project_file.h.

Referenced by EVT_UPDATE_UI_RANGE(), PCB_EDIT_FRAME::OnBoardLoaded(), and PROJECT_FILE().

◆ m_LayerPresets

std::vector<LAYER_PRESET> PROJECT_FILE::m_LayerPresets

Definition at line 241 of file project_file.h.

Referenced by PROJECT_FILE().

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

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

◆ m_LegacyLibDir

wxString PROJECT_FILE::m_LegacyLibDir

Definition at line 189 of file project_file.h.

Referenced by PROJECT_FILE().

◆ m_LegacyLibNames

wxArrayString PROJECT_FILE::m_LegacyLibNames

Definition at line 191 of file project_file.h.

Referenced by PROJECT_FILE().

◆ m_location

SETTINGS_LOC JSON_SETTINGS::m_location

protectedinherited

The location of this settings file (.

See also: SETTINGS_LOC)

Definition at line 319 of file json_settings.h.

Referenced by GetLocation(), JSON_SETTINGS(), and 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 355 of file json_settings.h.

Referenced by JSON_SETTINGS(), COLOR_SETTINGS::migrateSchema0to1(), FOOTPRINT_EDITOR_SETTINGS::migrateSchema0to1(), ReleaseNestedSettings(), and 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 358 of file json_settings.h.

Referenced by Migrate(), and registerMigration().

◆ m_modified

bool JSON_SETTINGS::m_modified

protectedinherited

True if the JSON data store has been written to since the last file write.

Definition at line 340 of file json_settings.h.

Referenced by JSON_SETTINGS(), LoadFromFile(), ReleaseNestedSettings(), SaveToFile(), and Store().

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

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

◆ m_NetSettings

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 227 of file project_file.h.

Referenced by SCH_ITEM::GetEffectiveNetClass(), API_HANDLER_COMMON::handleGetNetClasses(), API_HANDLER_COMMON::handleSetNetClasses(), NetSettings(), DIALOG_BOARD_SETUP::onAuxiliaryAction(), DIALOG_SCHEMATIC_SETUP::onAuxiliaryAction(), and PROJECT_FILE().

◆ m_params

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

protectedinherited

The list of parameters (owned by this object)

Definition at line 322 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(), COMPONENT_CLASS_SETTINGS::COMPONENT_CLASS_SETTINGS(), COLOR_SETTINGS::CreateBuiltinColorSettings(), CVPCB_SETTINGS::CVPCB_SETTINGS(), DATABASE_LIB_SETTINGS::DATABASE_LIB_SETTINGS(), EDA_3D_VIEWER_SETTINGS::EDA_3D_VIEWER_SETTINGS(), EESCHEMA_SETTINGS::EESCHEMA_SETTINGS(), ERC_SETTINGS::ERC_SETTINGS(), FOOTPRINT_EDITOR_SETTINGS::FOOTPRINT_EDITOR_SETTINGS(), GERBVIEW_SETTINGS::GERBVIEW_SETTINGS(), COLOR_SETTINGS::GetDefaultColor(), 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(), SaveToFile(), SCHEMATIC_SETTINGS::SCHEMATIC_SETTINGS(), SPICE_SETTINGS::SPICE_SETTINGS(), Store(), SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS(), TOOLBAR_SETTINGS::TOOLBAR_SETTINGS(), TUNING_PROFILES::TUNING_PROFILES(), and ~JSON_SETTINGS().

◆ m_PcbLastPath

wxString PROJECT_FILE::m_PcbLastPath[LAST_PATH_SIZE]

MRU path storage.

Definition at line 211 of file project_file.h.

Referenced by PROJECT_FILE(), SaveAs(), and DIALOG_PLOT::TransferDataToWindow().

◆ m_PinnedDesignBlockLibs

std::vector<wxString> PROJECT_FILE::m_PinnedDesignBlockLibs

The list of pinned design block libraries.

Definition at line 174 of file project_file.h.

◆ m_PinnedFootprintLibs

std::vector<wxString> PROJECT_FILE::m_PinnedFootprintLibs

The list of pinned footprint libraries.

Definition at line 171 of file project_file.h.

Referenced by PROJECT_FILE().

◆ m_PinnedSymbolLibs

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 168 of file project_file.h.

Referenced by PROJECT_FILE().

◆ m_project

PROJECT* PROJECT_FILE::m_project

private

A link to the owning PROJECT.

Definition at line 271 of file project_file.h.

Referenced by LoadFromFile(), PROJECT_FILE(), 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 346 of file json_settings.h.

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

◆ m_SchematicSettings

SCHEMATIC_SETTINGS* PROJECT_FILE::m_SchematicSettings

Definition at line 186 of file project_file.h.

Referenced by SCH_EDIT_FRAME::GetSchematicHopOverScale(), SCH_EDIT_FRAME::GetSchematicJunctionSize(), SIMULATOR_FRAME::LoadSettings(), DIALOG_SCHEMATIC_SETUP::onAuxiliaryAction(), PROJECT_FILE(), SCH_EDIT_FRAME::saveProjectSettings(), SIMULATOR_FRAME::SaveSettings(), SIMULATOR_FRAME::SIMULATOR_FRAME(), and SIMULATOR_FRAME::UpdateTitle().

◆ m_schemaVersion

int JSON_SETTINGS::m_schemaVersion

protectedinherited

Version of this settings schema.

Definition at line 349 of file json_settings.h.

Referenced by JSON_SETTINGS(), LoadFromFile(), NESTED_SETTINGS::LoadFromFile(), Migrate(), registerMigration(), and NESTED_SETTINGS::SaveToFile().

◆ m_sheets

std::vector<FILE_INFO_PAIR> PROJECT_FILE::m_sheets

private

An list of schematic sheets in this project.

Definition at line 262 of file project_file.h.

Referenced by GetSheets(), and PROJECT_FILE().

◆ m_TextVars

std::map<wxString, wxString> PROJECT_FILE::m_TextVars

Definition at line 176 of file project_file.h.

Referenced by PROJECT::GetTextVars(), and PROJECT_FILE().

◆ m_topLevelSheets

std::vector<TOP_LEVEL_SHEET_INFO> PROJECT_FILE::m_topLevelSheets

private

A list of top-level schematic sheets in this project.

Definition at line 265 of file project_file.h.

Referenced by GetTopLevelSheets(), GetTopLevelSheets(), LoadFromFile(), PROJECT_FILE(), and SaveAs().

◆ m_tuningProfileParameters

std::shared_ptr<TUNING_PROFILES> PROJECT_FILE::m_tuningProfileParameters

Tuning profile parameters for this project.

Definition at line 239 of file project_file.h.

Referenced by PROJECT_FILE(), and TuningProfileParameters().

◆ m_Viewports

std::vector<VIEWPORT> PROJECT_FILE::m_Viewports

List of stored layer presets.

Definition at line 242 of file project_file.h.

Referenced by PROJECT_FILE().

◆ m_Viewports3D

std::vector<VIEWPORT3D> PROJECT_FILE::m_Viewports3D

List of stored viewports (pos + zoom)

Definition at line 243 of file project_file.h.

Referenced by PROJECT_FILE(), and EDA_3D_VIEWER_FRAME::~EDA_3D_VIEWER_FRAME().

◆ m_wasMigrated

bool PROJECT_FILE::m_wasMigrated

private

Definition at line 273 of file project_file.h.

Referenced by LoadFromFile(), migrateSchema1To2(), migrateSchema2To3(), PROJECT_FILE(), SaveAs(), SaveToFile(), and ShouldAutoSave().

◆ m_writeFile

bool JSON_SETTINGS::m_writeFile

protectedinherited

Whether or not the backing store file should be written.

Definition at line 337 of file json_settings.h.

Referenced by COLOR_SETTINGS::CreateBuiltinColorSettings(), COLOR_SETTINGS::initFromOther(), IsReadOnly(), JSON_SETTINGS(), LoadFromFile(), SaveToFile(), and SetReadOnly().

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

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PROJECT_FILE()

◆ ~PROJECT_FILE()

Member Function Documentation

◆ AddNestedSettings()

◆ At()

◆ ComponentClassSettings()

◆ Contains()

◆ fetchOrDefault()

◆ FormatAsString()

◆ fromLegacy()

◆ fromLegacyColor()

◆ fromLegacyString()

◆ Get() [1/3]

◆ Get() [2/3]

◆ Get() [3/3]

◆ GetBoards()

◆ getFileExt()

◆ GetFileHistories()

◆ GetFilename()

◆ GetFullFilename()

◆ GetJson()

◆ getLegacyFileExt()

◆ GetLocation()

◆ GetSheets()

◆ GetTopLevelSheets() [1/2]

◆ GetTopLevelSheets() [2/2]

◆ Internals()

◆ IsReadOnly()

◆ Load()

◆ LoadFromFile()

◆ LoadFromRawFile()

◆ Migrate()

◆ MigrateFromLegacy()

◆ migrateSchema1To2()

◆ migrateSchema2To3()

◆ NetSettings()

◆ registerMigration()

◆ ReleaseNestedSettings()

◆ ResetToDefaults()

◆ SaveAs()

◆ SaveToFile()

◆ Set() [1/3]

◆ Set() [2/3]

◆ Set() [3/3]

◆ SetFilename()

◆ SetIfPresent() [1/4]

◆ SetIfPresent() [2/4]

◆ SetIfPresent() [3/4]

◆ SetIfPresent() [4/4]

◆ SetLegacyFilename()

◆ SetLocation()

◆ SetManager()

◆ SetProject()

◆ SetReadOnly()

◆ ShouldAutoSave()

◆ Store()

◆ TuningProfileParameters()

Member Data Documentation

◆ m_BoardDrawingSheetFile

◆ m_boards

◆ m_BoardSettings

◆ m_BusAliases

◆ m_ComponentClassSettings

◆ m_createIfDefault

◆ m_createIfMissing

◆ m_deleteLegacyAfterMigration

◆ m_EquivalenceFiles

◆ m_ErcSettings

◆ m_filename

◆ m_internals