PROJECT_FILE is 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)
	Constructs the project file for a project. More...

virtual	~PROJECT_FILE ()=default

virtual bool	MigrateFromLegacy (wxConfigBase *aCfg) override
	Migrates from wxConfig to JSON-based configuration. More...

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

void	SetProject (PROJECT *aProject)

std::vector< FILE_INFO_PAIR > &	GetSheets ()

std::vector< FILE_INFO_PAIR > &	GetBoards ()

NET_SETTINGS &	NetSettings ()

wxString	GetFilename () const

wxString	GetFullFilename () const

void	SetFilename (const wxString &aFilename)

SETTINGS_LOC	GetLocation () const

void	SetLegacyFilename (const wxString &aFilename)

bool	IsReadOnly () const

void	SetReadOnly (bool aReadOnly)

virtual void	Load ()
	Updates the parameters of this object based on the current JSON document contents. More...

virtual bool	Store ()
	Stores the current parameters into the JSON document represented by this object Note: this doesn't do any writing to disk; that's handled by SETTINGS_MANAGER. More...

virtual bool	LoadFromFile (const wxString &aDirectory="")
	Loads the backing file from disk and then calls Load() More...

void	ResetToDefaults ()
	Resets all parameters to default values. More...

bool	IsDefault (const std::string &aParamName)
	Checks if the current state of a parameter matches its default value. More...

OPT< nlohmann::json >	GetJson (const std::string &aPath) const
	Fetches a JSON object that is a subset of this JSON_SETTINGS object, using a path of the form "key1.key2.key3" to refer to nested objects. More...

template<typename ValueType >
OPT< ValueType >	Get (const std::string &aPath) const
	Fetches a value from within the JSON document. More...

template<>
OPT< wxString >	Get (const std::string &aPath) const

template<typename ValueType >
void	Set (const std::string &aPath, ValueType aVal)
	Stores a value into the JSON document Will throw an exception if ValueType isn't something that the library can handle. More...

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

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

bool	Migrate ()
	Migrates the schema of this settings from the version in the file to the latest version. More...

void	AddNestedSettings (NESTED_SETTINGS *aSettings)
	Transfers ownership of a given NESTED_SETTINGS to this object. More...

void	ReleaseNestedSettings (NESTED_SETTINGS *aSettings)
	Saves and frees a nested settings object, if it exists within this one. More...

void	SetManager (SETTINGS_MANAGER *aManager)

Static Public Member Functions
static nlohmann::json::json_pointer	PointerFromString (std::string aPath)
	Builds a JSON pointer based on a given string. More...

static bool	SetIfPresent (const nlohmann::json &aObj, const std::string &aPath, wxString &aTarget)
	Sets the given string if the given key/path is present. More...

static bool	SetIfPresent (const nlohmann::json &aObj, const std::string &aPath, bool &aTarget)
	Sets the given bool if the given key/path is present. More...

static bool	SetIfPresent (const nlohmann::json &aObj, const std::string &aPath, int &aTarget)
	Sets the given int if the given key/path is present. More...

static bool	SetIfPresent (const nlohmann::json &aObj, const std::string &aPath, unsigned int &aTarget)
	Sets the given unsigned int if the given key/path is present. More...

Public Attributes
std::vector< wxString >	m_PinnedSymbolLibs
	Below are project-level settings that have not been moved to a dedicated file. More...

std::vector< wxString >	m_PinnedFootprintLibs
	The list of pinned footprint libraries. More...

std::map< wxString, wxString >	m_TextVars

ERC_SETTINGS *	m_ErcSettings
	Eeschema params. More...

SCHEMATIC_SETTINGS *	m_SchematicSettings

wxString	m_LegacyLibDir

wxArrayString	m_LegacyLibNames

std::vector< wxString >	m_EquivalenceFiles
	CvPcb params. More...

wxString	m_BoardPageLayoutDescrFile
	PcbNew params. More...

wxString	m_PcbLastPath [LAST_PATH_SIZE]
	MRU path storage. More...

BOARD_DESIGN_SETTINGS *	m_BoardSettings
	Board design settings for this project's board. More...

std::shared_ptr< NET_SETTINGS >	m_NetSettings
	Net settings for this project (owned here) NOTE: If we go multi-board in the future, we have to decide whether to use a global NET_SETTINGS or have one per board. More...

std::vector< LAYER_PRESET >	m_LayerPresets
	List of stored layer presets. More...

Protected Member Functions
wxString	getFileExt () const override

wxString	getLegacyFileExt () const override

void	registerMigration (int aOldSchemaVersion, int aNewSchemaVersion, std::function< bool(void)> aMigrator)
	Registers a migration from one schema version to another. More...

template<typename ValueType >
bool	fromLegacy (wxConfigBase *aConfig, const std::string &aKey, const std::string &aDest)
	Translates a legacy wxConfig value to a given JSON pointer value. More...

bool	fromLegacyString (wxConfigBase *aConfig, const std::string &aKey, const std::string &aDest)
	Translates a legacy wxConfig string value to a given JSON pointer value. More...

bool	fromLegacyColor (wxConfigBase *aConfig, const std::string &aKey, const std::string &aDest)
	Translates a legacy COLOR4D stored in a wxConfig string to a given JSON pointer value. More...

Protected Attributes
wxString	m_filename
	The filename (not including path) of this settings file (inicode) More...

wxString	m_legacy_filename
	The filename of the wxConfig legacy file (if different from m_filename) More...

SETTINGS_LOC	m_location
	The location of this settings file (. More...

std::vector< PARAM_BASE * >	m_params
	The list of parameters (owned by this object) More...

std::vector< NESTED_SETTINGS * >	m_nested_settings
	Nested settings files that live inside this one, if any. More...

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

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

bool	m_writeFile
	Whether or not the backing store file should be written. More...

bool	m_deleteLegacyAfterMigration
	Whether or not to delete legacy file after migration. More...

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

int	m_schemaVersion
	Version of this settings schema. More...

SETTINGS_MANAGER *	m_manager
	A pointer to the settings manager managing this file (may be null) More...

std::vector< nlohmann::json::json_pointer >	m_preserved_paths
	A list of JSON pointers that are preserved during a read-update-write to disk. More...

std::map< int, std::pair< int, std::function< bool()> > >	m_migrators
	A map of starting schema version to a pair of <ending version, migrator function> More...

Private Attributes
std::vector< FILE_INFO_PAIR >	m_sheets
	An list of schematic sheets in this project. More...

std::vector< FILE_INFO_PAIR >	m_boards
	A list of board files in this project. More...

PROJECT *	m_project
	A link to the owning PROJECT. More...

Detailed Description

PROJECT_FILE is the backing store for a PROJECT, in JSON format.

There is either zero or one PROJECT_FILE for every PROJECT (you can have a dummy PROJECT that has no file)

Definition at line 62 of file project_file.h.

Constructor & Destructor Documentation

◆ PROJECT_FILE()

PROJECT_FILE::PROJECT_FILE ( const wxString & aFullPath )

Constructs the project file for a project.

Parameters

aFullPath is the full disk path to the project

Definition at line 36 of file project_file.cpp.

                                                       :
         JSON_SETTINGS( aFullPath, SETTINGS_LOC::PROJECT, projectFileSchemaVersion ),
         m_sheets(),
         m_boards(),
         m_project( nullptr ),
         m_ErcSettings( nullptr ),
         m_SchematicSettings( nullptr ),
         m_BoardSettings()
 {
     // Keep old files around
     m_deleteLegacyAfterMigration = false;
 
     m_params.emplace_back( new PARAM_LIST<FILE_INFO_PAIR>( "sheets", &m_sheets, {} ) );
 
     m_params.emplace_back( new PARAM_LIST<FILE_INFO_PAIR>( "boards", &m_boards, {} ) );
 
     m_params.emplace_back( new PARAM_WXSTRING_MAP( "text_variables", &m_TextVars, {} ) );
 
     m_params.emplace_back(
             new PARAM_LIST<wxString>( "libraries.pinned_symbol_libs", &m_PinnedSymbolLibs, {} ) );
 
     m_params.emplace_back( new PARAM_LIST<wxString>(
             "libraries.pinned_footprint_libs", &m_PinnedFootprintLibs, {} ) );
 
     m_params.emplace_back(
             new PARAM_PATH_LIST( "cvpcb.equivalence_files", &m_EquivalenceFiles, {} ) );
 
     m_params.emplace_back(
             new PARAM_PATH( "pcbnew.page_layout_descr_file", &m_BoardPageLayoutDescrFile, "" ) );
 
     m_params.emplace_back(
             new PARAM_PATH( "pcbnew.last_paths.netlist", &m_PcbLastPath[LAST_PATH_NETLIST], "" ) );
 
     m_params.emplace_back(
             new PARAM_PATH( "pcbnew.last_paths.step", &m_PcbLastPath[LAST_PATH_STEP], "" ) );
 
     m_params.emplace_back(
             new PARAM_PATH( "pcbnew.last_paths.idf", &m_PcbLastPath[LAST_PATH_IDF], "" ) );
 
     m_params.emplace_back(
             new PARAM_PATH( "pcbnew.last_paths.vrml", &m_PcbLastPath[LAST_PATH_VRML], "" ) );
 
     m_params.emplace_back( new PARAM_PATH(
             "pcbnew.last_paths.specctra_dsn", &m_PcbLastPath[LAST_PATH_SPECCTRADSN], "" ) );
 
     m_params.emplace_back(
             new PARAM_PATH( "pcbnew.last_paths.gencad", &m_PcbLastPath[LAST_PATH_GENCAD], "" ) );
 
     m_params.emplace_back( new PARAM<wxString>( "schematic.legacy_lib_dir", &m_LegacyLibDir, "" ) );
 
     m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "schematic.legacy_lib_list",
             [&]() -> nlohmann::json
             {
                 nlohmann::json ret = nlohmann::json::array();
 
                 for( const wxString& libName : m_LegacyLibNames )
                     ret.push_back( libName );
 
                 return ret;
             },
             [&]( const nlohmann::json& aJson )
             {
                 if( aJson.empty() || !aJson.is_array() )
                     return;
 
                 m_LegacyLibNames.clear();
 
                 for( const nlohmann::json& entry : aJson )
                     m_LegacyLibNames.push_back( entry.get<wxString>() );
             }, {} ) );
 
     m_NetSettings = std::make_shared<NET_SETTINGS>( this, "net_settings" );
 
     m_params.emplace_back( new PARAM_LAYER_PRESET( "board.layer_presets", &m_LayerPresets ) );
 }

References LAST_PATH_GENCAD, LAST_PATH_IDF, LAST_PATH_NETLIST, LAST_PATH_SPECCTRADSN, LAST_PATH_STEP, LAST_PATH_VRML, m_BoardPageLayoutDescrFile, m_boards, JSON_SETTINGS::m_deleteLegacyAfterMigration, m_EquivalenceFiles, m_LayerPresets, m_LegacyLibDir, m_LegacyLibNames, m_NetSettings, JSON_SETTINGS::m_params, m_PcbLastPath, m_PinnedFootprintLibs, m_PinnedSymbolLibs, m_sheets, and m_TextVars.

◆ ~PROJECT_FILE()

virtual PROJECT_FILE::~PROJECT_FILE ( )

virtualdefault

Member Function Documentation

◆ AddNestedSettings()

void JSON_SETTINGS::AddNestedSettings ( NESTED_SETTINGS * aSettings )

inherited

Transfers ownership of a given NESTED_SETTINGS to this object.

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

Parameters

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

Definition at line 675 of file json_settings.cpp.

 {
     wxLogTrace( traceSettings, "AddNestedSettings %s", aSettings->GetFilename() );
     m_nested_settings.push_back( aSettings );
 }

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

Referenced by NESTED_SETTINGS::SetParent().

◆ fromLegacy()

template<typename ValueType >

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

protectedinherited

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

Template Parameters

ValueType is the basic type of the value

Parameters

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

Definition at line 587 of file json_settings.cpp.

 {
     ValueType val;
 
     if( aConfig->Read( aKey, &val ) )
     {
         try
         {
             ( *this )[PointerFromString( aDest )] = val;
         }
         catch( ... )
         {
             wxASSERT_MSG( false, wxT( "Could not write value in fromLegacy!" ) );
             return false;
         }
 
         return true;
     }
 
     return false;
 }

References JSON_SETTINGS::PointerFromString().

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

 {
     wxString str;
 
     if( aConfig->Read( aKey, &str ) )
     {
         KIGFX::COLOR4D color;
         color.SetFromWxString( str );
 
         try
         {
             nlohmann::json js = nlohmann::json::array( { color.r, color.g, color.b, color.a } );
             ( *this )[PointerFromString( aDest )] = js;
         }
         catch( ... )
         {
             wxASSERT_MSG( false, wxT( "Could not write value in fromLegacyColor!" ) );
             return false;
         }
 
         return true;
     }
 
     return false;
 }

References color, and JSON_SETTINGS::PointerFromString().

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

 {
     wxString str;
 
     if( aConfig->Read( aKey, &str ) )
     {
         try
         {
             ( *this )[PointerFromString( aDest )] = str.ToUTF8();
         }
         catch( ... )
         {
             wxASSERT_MSG( false, wxT( "Could not write value in fromLegacyString!" ) );
             return false;
         }
 
         return true;
     }
 
     return false;
 }

References JSON_SETTINGS::PointerFromString().

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

◆ Get() [1/2]

template<typename ValueType >

OPT<ValueType> JSON_SETTINGS::Get ( const std::string & aPath ) const

inlineinherited

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

     {
         if( OPT<nlohmann::json> ret = GetJson( aPath ) )
         {
             try
             {
                 return ret->get<ValueType>();
             }
             catch( ... )
             {
             }
         }
 
         return NULLOPT;
     }

References JSON_SETTINGS::GetJson(), and NULLOPT.

Referenced by PARAM< wxString >::Load(), COLOR_MAP_PARAM::Load(), PARAM_ENUM< EnumType >::Load(), PARAM_LAMBDA< nlohmann::json >::Load(), PARAM_SCALED< ValueType >::Load(), BOARD_DESIGN_SETTINGS::LoadFromFile(), PARAM< wxString >::MatchesFile(), COLOR_MAP_PARAM::MatchesFile(), PARAM_PATH::MatchesFile(), PARAM_ENUM< EnumType >::MatchesFile(), PARAM_LAMBDA< nlohmann::json >::MatchesFile(), and PARAM_SCALED< ValueType >::MatchesFile().

◆ Get() [2/2]

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

inherited

Definition at line 705 of file json_settings.cpp.

 {
     if( OPT<nlohmann::json> opt_json = GetJson( aPath ) )
         return wxString( opt_json->get<std::string>().c_str(), wxConvUTF8 );
 
     return NULLOPT;
 }

References JSON_SETTINGS::GetJson(), and NULLOPT.

◆ GetBoards()

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

inline

Definition at line 87 of file project_file.h.

     {
         return m_boards;
     }

References m_boards.

◆ getFileExt()

wxString PROJECT_FILE::getFileExt ( ) const

overrideprotectedvirtual

Reimplemented from JSON_SETTINGS.

Definition at line 553 of file project_file.cpp.

 {
     return ProjectFileExtension;
 }

References ProjectFileExtension.

◆ GetFilename()

wxString JSON_SETTINGS::GetFilename ( ) const

inlineinherited

Definition at line 64 of file json_settings.h.

64 { return m_filename; }

JSON_SETTINGS::m_filename

wxString m_filename

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

Definition: json_settings.h:292

References JSON_SETTINGS::m_filename.

Referenced by JSON_SETTINGS::AddNestedSettings(), NESTED_SETTINGS::LoadFromFile(), GERBVIEW_SETTINGS::MigrateFromLegacy(), EESCHEMA_SETTINGS::MigrateFromLegacy(), PCBNEW_SETTINGS::MigrateFromLegacy(), PANEL_COLOR_SETTINGS::OnThemeChanged(), SETTINGS_MANAGER::SaveColorSettings(), PANEL_COLOR_SETTINGS::saveCurrentTheme(), DIALOG_PRINT_USING_PRINTER::SavePrintOptions(), DIALOG_PRINT_PCBNEW::saveSettings(), NESTED_SETTINGS::SaveToFile(), PANEL_FP_EDITOR_COLOR_SETTINGS::TransferDataFromWindow(), PANEL_PCBNEW_COLOR_SETTINGS::TransferDataFromWindow(), and PANEL_EESCHEMA_COLOR_SETTINGS::TransferDataFromWindow().

◆ GetFullFilename()

wxString JSON_SETTINGS::GetFullFilename ( ) const

inherited

Definition at line 81 of file json_settings.cpp.

 {
     return wxString( m_filename + "." + getFileExt() );
 }

References JSON_SETTINGS::getFileExt(), and JSON_SETTINGS::m_filename.

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

◆ GetJson()

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

 {
     nlohmann::json::json_pointer ptr = PointerFromString( aPath );
 
     if( contains( ptr ) )
     {
         try
         {
             return OPT<nlohmann::json>{ at( ptr ) };
         }
         catch( ... )
         {
         }
     }
 
     return OPT<nlohmann::json>{};
 }

References alg::contains(), and JSON_SETTINGS::PointerFromString().

Referenced by JSON_SETTINGS::Get(), PARAM_LAMBDA< nlohmann::json >::Load(), PARAM_LIST< wxString >::Load(), PARAM_MAP< Value >::Load(), PARAM_WXSTRING_MAP::Load(), PARAM_LAMBDA< nlohmann::json >::MatchesFile(), PARAM_LIST< wxString >::MatchesFile(), PARAM_PATH_LIST::MatchesFile(), PARAM_MAP< Value >::MatchesFile(), and PARAM_WXSTRING_MAP::MatchesFile().

◆ getLegacyFileExt()

wxString PROJECT_FILE::getLegacyFileExt ( ) const

overrideprotectedvirtual

Reimplemented from JSON_SETTINGS.

Definition at line 559 of file project_file.cpp.

 {
     return LegacyProjectFileExtension;
 }

References LegacyProjectFileExtension.

◆ GetLocation()

SETTINGS_LOC JSON_SETTINGS::GetLocation ( ) const

inlineinherited

Definition at line 70 of file json_settings.h.

70 { return m_location; }

JSON_SETTINGS::m_location

SETTINGS_LOC m_location

The location of this settings file (.

Definition: json_settings.h:298

References JSON_SETTINGS::m_location.

Referenced by SETTINGS_MANAGER::GetPathForSettingsFile().

◆ GetSheets()

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

inline

Definition at line 82 of file project_file.h.

     {
         return m_sheets;
     }

References m_sheets.

Referenced by PROJECT::GetSheetName(), and SCH_EDIT_FRAME::SaveProject().

◆ IsDefault()

bool JSON_SETTINGS::IsDefault ( const std::string & aParamName )

inherited

Checks if the current state of a parameter matches its default value.

Parameters

aParamName is the JSON path to the parameter

Returns: true if the given parameter is at its default value

Definition at line 324 of file json_settings.cpp.

 {
     for( const PARAM_BASE* param : m_params )
     {
         if( param->GetJsonPath() == aParamName )
             return param->IsDefault();
     }
 
     return false;
 }

References JSON_SETTINGS::m_params.

◆ IsReadOnly()

bool JSON_SETTINGS::IsReadOnly ( ) const

inlineinherited

Definition at line 74 of file json_settings.h.

74 { return !m_writeFile; }

JSON_SETTINGS::m_writeFile

bool m_writeFile

Whether or not the backing store file should be written.

Definition: json_settings.h:316

References JSON_SETTINGS::m_writeFile.

Referenced by APPEARANCE_CONTROLS::rebuildLayers(), PANEL_COLOR_SETTINGS::ResetPanel(), PANEL_COLOR_SETTINGS::saveCurrentTheme(), PANEL_COLOR_SETTINGS::ShowColorContextMenu(), APPEARANCE_CONTROLS::syncColorsAndVisibility(), and PANEL_COLOR_SETTINGS::updateSwatches().

◆ Load()

void JSON_SETTINGS::Load ( )

virtualinherited

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

Definition at line 87 of file json_settings.cpp.

 {
     for( auto param : m_params )
     {
         try
         {
             param->Load( this, m_resetParamsIfMissing );
         }
         catch( ... )
         {
             // Skip unreadable parameters in file
             wxLogTrace( traceSettings, "param '%s' load err", param->GetJsonPath().c_str() );
         }
     }
 }

References JSON_SETTINGS::m_params, JSON_SETTINGS::m_resetParamsIfMissing, and traceSettings.

Referenced by COLOR_SETTINGS::CreateBuiltinColorSettings(), NESTED_SETTINGS::LoadFromFile(), JSON_SETTINGS::LoadFromFile(), BOARD_DESIGN_SETTINGS::LoadFromFile(), COLOR_SETTINGS::migrateSchema0to1(), and SETTINGS_MANAGER::SaveColorSettings().

◆ LoadFromFile()

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

virtualinherited

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

Parameters

aDirectory is the path to the file

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

Reimplemented in BOARD_DESIGN_SETTINGS, and NESTED_SETTINGS.

Definition at line 104 of file json_settings.cpp.

 {
     // First, load all params to default values
     clear();
     Load();
 
     bool success         = true;
     bool migrated        = false;
     bool legacy_migrated = false;
 
     LOCALE_IO locale;
 
     auto migrateFromLegacy = [&] ( wxFileName& aPath ) {
         // Backup and restore during migration so that the original can be mutated if convenient
         bool backed_up = false;
         wxFileName temp;
 
         if( aPath.IsDirWritable() )
         {
             temp.AssignTempFileName( aPath.GetFullPath() );
 
             if( !wxCopyFile( aPath.GetFullPath(), temp.GetFullPath() ) )
             {
                 wxLogTrace( traceSettings, "%s: could not create temp file for migration",
                         GetFullFilename() );
             }
             else
                 backed_up = true;
         }
 
         // Silence popups if legacy file is read-only
         wxLogNull doNotLog;
 
         wxConfigBase::DontCreateOnDemand();
         auto cfg = std::make_unique<wxFileConfig>( wxT( "" ), wxT( "" ), aPath.GetFullPath() );
 
         // If migrate fails or is not implemented, fall back to built-in defaults that were
         // already loaded above
         if( !MigrateFromLegacy( cfg.get() ) )
         {
             wxLogTrace( traceSettings,
                         "%s: migrated; not all settings were found in legacy file",
                         GetFullFilename() );
         }
         else
         {
             wxLogTrace( traceSettings, "%s: migrated from legacy format", GetFullFilename() );
         }
 
         if( backed_up )
         {
             cfg.reset();
 
             if( !wxCopyFile( temp.GetFullPath(), aPath.GetFullPath() ) )
             {
                 wxLogTrace( traceSettings,
                             "migrate; copy temp file %s to %s failed",
                             temp.GetFullPath(), aPath.GetFullPath() );
             }
 
             if( !wxRemoveFile( temp.GetFullPath() ) )
             {
                 wxLogTrace( traceSettings,
                             "migrate; failed to remove temp file %s",
                             temp.GetFullPath() );
             }
          }
 
         // Either way, we want to clean up the old file afterwards
         legacy_migrated = true;
     };
 
     wxFileName path;
 
     if( aDirectory.empty() )
     {
         path.Assign( m_filename );
         path.SetExt( getFileExt() );
     }
     else
     {
         wxString dir( aDirectory );
         path.Assign( dir, m_filename, getFileExt() );
     }
 
     if( !path.Exists() )
     {
         // Case 1: legacy migration, no .json extension yet
         path.SetExt( getLegacyFileExt() );
 
         if( path.Exists() )
         {
             migrateFromLegacy( path );
         }
         // Case 2: legacy filename is different from new one
         else if( !m_legacy_filename.empty() )
         {
             path.SetName( m_legacy_filename );
 
             if( path.Exists() )
                 migrateFromLegacy( path );
         }
         else
         {
             success = false;
         }
     }
     else
     {
         if( !path.IsFileWritable() )
             m_writeFile = false;
 
         try
         {
             FILE* fp = wxFopen( path.GetFullPath(), wxT( "rt" ) );
 
             if( fp )
             {
                 *static_cast<nlohmann::json*>( this ) = nlohmann::json::parse( fp, nullptr,
                                                       /* allow_exceptions = */ true,
                                                       /* ignore_comments  = */ true );
 
                 // If parse succeeds, check if schema migration is required
                 int filever = -1;
 
                 try
                 {
                     filever = at( PointerFromString( "meta.version" ) ).get<int>();
                 }
                 catch( ... )
                 {
                     wxLogTrace( traceSettings, "%s: file version could not be read!",
                                 GetFullFilename() );
                     success = false;
                 }
 
                 if( filever >= 0 && filever < m_schemaVersion )
                 {
                     wxLogTrace( traceSettings, "%s: attempting migration from version %d to %d",
                                 GetFullFilename(), filever, m_schemaVersion );
 
                     if( Migrate() )
                     {
                         migrated = true;
                     }
                     else
                     {
                         wxLogTrace( traceSettings, "%s: migration failed!", GetFullFilename() );
                     }
                 }
                 else if( filever > m_schemaVersion )
                 {
                     wxLogTrace( traceSettings,
                                 "%s: warning: file version %d is newer than latest (%d)",
                                 GetFullFilename(), filever, m_schemaVersion );
                 }
             }
             else
             {
                 wxLogTrace( traceSettings, "%s exists but can't be opened for read",
                             GetFullFilename() );
             }
         }
         catch( nlohmann::json::parse_error& error )
         {
             wxLogTrace( traceSettings, "Json parse error reading %s: %s",
                         path.GetFullPath(), error.what() );
             wxLogTrace( traceSettings, "Attempting migration in case file is in legacy format" );
             migrateFromLegacy( path );
         }
     }
 
     // Now that we have new data in the JSON structure, load the params again
     Load();
 
     // And finally load any nested settings
     for( auto settings : m_nested_settings )
         settings->LoadFromFile();
 
     wxLogTrace( traceSettings, "Loaded <%s> with schema %d", GetFullFilename(), m_schemaVersion );
 
     // If we migrated, clean up the legacy file (with no extension)
     if( legacy_migrated || migrated )
     {
         if( legacy_migrated && m_deleteLegacyAfterMigration && !wxRemoveFile( path.GetFullPath() ) )
         {
             wxLogTrace( traceSettings, "Warning: could not remove legacy file %s",
                         path.GetFullPath() );
         }
 
         // And write-out immediately so that we don't lose data if the program later crashes.
         if( m_deleteLegacyAfterMigration )
             SaveToFile( aDirectory, true );
     }
 
     return success;
 }

References JSON_SETTINGS::getFileExt(), JSON_SETTINGS::GetFullFilename(), JSON_SETTINGS::getLegacyFileExt(), JSON_SETTINGS::Load(), JSON_SETTINGS::m_deleteLegacyAfterMigration, JSON_SETTINGS::m_filename, JSON_SETTINGS::m_legacy_filename, JSON_SETTINGS::m_nested_settings, JSON_SETTINGS::m_schemaVersion, JSON_SETTINGS::m_writeFile, JSON_SETTINGS::Migrate(), JSON_SETTINGS::MigrateFromLegacy(), parse(), JSON_SETTINGS::PointerFromString(), JSON_SETTINGS::SaveToFile(), and traceSettings.

Referenced by SETTINGS_MANAGER::SaveColorSettings().

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

 {
     int filever = at( PointerFromString( "meta.version" ) ).get<int>();
 
     while( filever < m_schemaVersion )
     {
         if( !m_migrators.count( filever ) )
         {
             wxLogTrace( traceSettings, "Migrator missing for %s version %d!",
                         typeid( *this ).name(), filever );
             return false;
         }
 
         std::pair<int, std::function<bool()>> pair = m_migrators.at( filever );
 
         if( pair.second() )
         {
             wxLogTrace( traceSettings, "Migrated %s from %d to %d", typeid( *this ).name(),
                         filever, pair.first );
             filever = pair.first;
             ( *this )[PointerFromString( "meta.version" )] = filever;
         }
         else
         {
             wxLogTrace( traceSettings, "Migration failed for %s from %d to %d",
                         typeid( *this ).name(), filever, pair.first );
             return false;
         }
     }
 
     return true;
 }

References JSON_SETTINGS::m_migrators, JSON_SETTINGS::m_schemaVersion, JSON_SETTINGS::PointerFromString(), and traceSettings.

Referenced by NESTED_SETTINGS::LoadFromFile(), and JSON_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 113 of file project_file.cpp.

 {
     bool     ret = true;
     wxString str;
     long     index = 0;
 
     std::set<wxString> group_blacklist;
 
     // Legacy files don't store board info; they assume board matches project name
     // We will leave m_boards empty here so it can be populated with other code
 
     // First handle migration of data that will be stored locally in this object
 
     auto loadPinnedLibs =
             [&]( const std::string& aDest )
             {
                 int      libIndex = 1;
                 wxString libKey   = wxT( "PinnedItems" );
                 libKey << libIndex;
 
                 nlohmann::json libs = nlohmann::json::array();
 
                 while( aCfg->Read( libKey, &str ) )
                 {
                     libs.push_back( str );
 
                     aCfg->DeleteEntry( libKey, true );
 
                     libKey = wxT( "PinnedItems" );
                     libKey << ++libIndex;
                 }
 
                 ( *this )[PointerFromString( aDest )] = libs;
             };
 
     aCfg->SetPath( wxT( "/LibeditFrame" ) );
     loadPinnedLibs( "libraries.pinned_symbol_libs" );
 
     aCfg->SetPath( wxT( "/ModEditFrame" ) );
     loadPinnedLibs( "libraries.pinned_footprint_libs" );
 
     aCfg->SetPath( wxT( "/cvpcb/equfiles" ) );
 
     {
         int      eqIdx = 1;
         wxString eqKey = wxT( "EquName" );
         eqKey << eqIdx;
 
         nlohmann::json eqs = nlohmann::json::array();
 
         while( aCfg->Read( eqKey, &str ) )
         {
             eqs.push_back( str );
 
             eqKey = wxT( "EquName" );
             eqKey << ++eqIdx;
         }
 
         ( *this )[PointerFromString( "cvpcb.equivalence_files" )] = eqs;
     }
 
     // All CvPcb params that we want to keep have been migrated above
     group_blacklist.insert( wxT( "/cvpcb" ) );
 
     aCfg->SetPath( wxT( "/eeschema" ) );
     fromLegacyString( aCfg, "LibDir", "schematic.legacy_lib_dir" );
 
     aCfg->SetPath( wxT( "/eeschema/libraries" ) );
 
     {
         int      libIdx = 1;
         wxString libKey = wxT( "LibName" );
         libKey << libIdx;
 
         nlohmann::json libs = nlohmann::json::array();
 
         while( aCfg->Read( libKey, &str ) )
         {
             libs.push_back( str );
 
             libKey = wxT( "LibName" );
             libKey << ++libIdx;
         }
 
         ( *this )[PointerFromString( "schematic.legacy_lib_list" )] = libs;
     }
 
     group_blacklist.insert( wxT( "/eeschema" ) );
 
     aCfg->SetPath( wxT( "/text_variables" ) );
 
     {
         int      txtIdx = 1;
         wxString txtKey;
         txtKey << txtIdx;
 
         nlohmann::json vars = nlohmann::json();
 
         while( aCfg->Read( txtKey, &str ) )
         {
             wxArrayString tokens = wxSplit( str, ':' );
 
             if( tokens.size() == 2 )
                 vars[ tokens[0].ToStdString() ] = tokens[1];
 
             txtKey.clear();
             txtKey << ++txtIdx;
         }
 
         ( *this )[PointerFromString( "text_variables" )] = vars;
     }
 
     group_blacklist.insert( wxT( "/text_variables" ) );
 
     aCfg->SetPath( wxT( "/schematic_editor" ) );
 
     fromLegacyString( aCfg, "PageLayoutDescrFile",     "schematic.page_layout_descr_file" );
     fromLegacyString( aCfg, "PlotDirectoryName",       "schematic.plot_directory" );
     fromLegacyString( aCfg, "NetFmtName",              "schematic.net_format_name" );
     fromLegacy<bool>( aCfg, "SpiceAjustPassiveValues", "schematic.spice_adjust_passive_values" );
     fromLegacy<int>(  aCfg, "SubpartIdSeparator",      "schematic.subpart_id_separator" );
     fromLegacy<int>(  aCfg, "SubpartFirstId",          "schematic.subpart_first_id" );
 
     fromLegacy<int>( aCfg, "LineThickness",         "schematic.drawing.default_line_thickness" );
     fromLegacy<int>( aCfg, "WireThickness",         "schematic.drawing.default_wire_thickness" );
     fromLegacy<int>( aCfg, "BusThickness",          "schematic.drawing.default_bus_thickness" );
     fromLegacy<int>( aCfg, "LabSize",               "schematic.drawing.default_text_size" );
     fromLegacy<int>( aCfg, "PinSymbolSize",         "schematic.drawing.pin_symbol_size" );
     fromLegacy<int>( aCfg, "JunctionSize",          "schematic.drawing.default_junction_size" );
 
     fromLegacyString(   aCfg, "FieldNameTemplates", "schematic.drawing.field_names" );
     fromLegacy<double>( aCfg, "TextOffsetRatio",    "schematic.drawing.text_offset_ratio" );
 
     // All schematic_editor keys we keep are migrated above
     group_blacklist.insert( wxT( "/schematic_editor" ) );
 
     aCfg->SetPath( wxT( "/pcbnew" ) );
 
     fromLegacyString( aCfg, "PageLayoutDescrFile",       "pcbnew.page_layout_descr_file" );
     fromLegacyString( aCfg, "LastNetListRead",           "pcbnew.last_paths.netlist" );
     fromLegacyString( aCfg, "LastSTEPExportPath",        "pcbnew.last_paths.step" );
     fromLegacyString( aCfg, "LastIDFExportPath",         "pcbnew.last_paths.idf" );
     fromLegacyString( aCfg, "LastVRMLExportPath",        "pcbnew.last_paths.vmrl" );
     fromLegacyString( aCfg, "LastSpecctraDSNExportPath", "pcbnew.last_paths.specctra_dsn" );
     fromLegacyString( aCfg, "LastGenCADExportPath",      "pcbnew.last_paths.gencad" );
 
     std::string bp = "board.design_settings.";
 
     {
         int      idx = 1;
         wxString key = wxT( "DRCExclusion" );
         key << idx;
 
         nlohmann::json exclusions = nlohmann::json::array();
 
         while( aCfg->Read( key, &str ) )
         {
             exclusions.push_back( str );
 
             key = wxT( "DRCExclusion" );
             key << ++idx;
         }
 
         ( *this )[PointerFromString( bp + "drc_exclusions" )] = exclusions;
     }
 
     fromLegacy<bool>( aCfg,   "AllowMicroVias",  bp + "rules.allow_microvias" );
     fromLegacy<bool>( aCfg,   "AllowBlindVias",  bp + "rules.allow_blind_buried_vias" );
     fromLegacy<double>( aCfg, "MinClearance",    bp + "rules.min_clearance" );
     fromLegacy<double>( aCfg, "MinTrackWidth",   bp + "rules.min_track_width" );
     fromLegacy<double>( aCfg, "MinViaAnnulus",   bp + "rules.min_via_annulus" );
     fromLegacy<double>( aCfg, "MinViaDiameter",  bp + "rules.min_via_diameter" );
 
     if( !fromLegacy<double>( aCfg, "MinThroughDrill", bp + "rules.min_through_hole_diameter" ) )
         fromLegacy<double>( aCfg, "MinViaDrill", bp + "rules.min_through_hole_diameter" );
 
     fromLegacy<double>( aCfg, "MinMicroViaDiameter",  bp + "rules.min_microvia_diameter" );
     fromLegacy<double>( aCfg, "MinMicroViaDrill",     bp + "rules.min_microvia_drill" );
     fromLegacy<double>( aCfg, "MinHoleToHole",        bp + "rules.min_hole_to_hole" );
     fromLegacy<double>( aCfg, "CopperEdgeClearance",  bp + "rules.min_copper_edge_clearance" );
     fromLegacy<double>( aCfg, "SolderMaskClearance",  bp + "rules.solder_mask_clearance" );
     fromLegacy<double>( aCfg, "SolderMaskMinWidth",   bp + "rules.solder_mask_min_width" );
     fromLegacy<double>( aCfg, "SolderPasteClearance", bp + "rules.solder_paste_clearance" );
     fromLegacy<double>( aCfg, "SolderPasteRatio",     bp + "rules.solder_paste_margin_ratio" );
 
     if( !fromLegacy<double>( aCfg, "SilkLineWidth", bp + "defaults.silk_line_width" ) )
         fromLegacy<double>( aCfg, "ModuleOutlineThickness", bp + "defaults.silk_line_width" );
 
     if( !fromLegacy<double>( aCfg, "SilkTextSizeV", bp + "defaults.silk_text_size_v" ) )
         fromLegacy<double>( aCfg, "ModuleTextSizeV", bp + "defaults.silk_text_size_v" );
 
     if( !fromLegacy<double>( aCfg, "SilkTextSizeH", bp + "defaults.silk_text_size_h" ) )
         fromLegacy<double>( aCfg, "ModuleTextSizeH", bp + "defaults.silk_text_size_h" );
 
     if( !fromLegacy<double>( aCfg, "SilkTextSizeThickness", bp + "defaults.silk_text_thickness" ) )
         fromLegacy<double>( aCfg, "ModuleTextSizeThickness", bp + "defaults.silk_text_thickness" );
 
     fromLegacy<bool>( aCfg, "SilkTextItalic",   bp + "defaults.silk_text_italic" );
     fromLegacy<bool>( aCfg, "SilkTextUpright",  bp + "defaults.silk_text_upright" );
 
     if( !fromLegacy<double>( aCfg, "CopperLineWidth", bp + "defaults.copper_line_width" ) )
         fromLegacy<double>( aCfg, "DrawSegmentWidth", bp + "defaults.copper_line_width" );
 
     if( !fromLegacy<double>( aCfg, "CopperTextSizeV", bp + "defaults.copper_text_size_v" ) )
         fromLegacy<double>( aCfg, "PcbTextSizeV", bp + "defaults.copper_text_size_v" );
 
     if( !fromLegacy<double>( aCfg, "CopperTextSizeH", bp + "defaults.copper_text_size_h" ) )
         fromLegacy<double>( aCfg, "PcbTextSizeH", bp + "defaults.copper_text_size_h" );
 
     if( !fromLegacy<double>( aCfg, "CopperTextThickness", bp + "defaults.copper_text_thickness" ) )
         fromLegacy<double>( aCfg, "PcbTextThickness", bp + "defaults.copper_text_thickness" );
 
     fromLegacy<bool>( aCfg, "CopperTextItalic",   bp + "defaults.copper_text_italic" );
     fromLegacy<bool>( aCfg, "CopperTextUpright",  bp + "defaults.copper_text_upright" );
 
     if( !fromLegacy<double>( aCfg, "EdgeCutLineWidth", bp + "defaults.board_outline_line_width" ) )
         fromLegacy<double>( aCfg, "BoardOutlineThickness", bp + "defaults.board_outline_line_width" );
 
     fromLegacy<double>( aCfg, "CourtyardLineWidth",   bp + "defaults.courtyard_line_width" );
 
     fromLegacy<double>( aCfg, "FabLineWidth",         bp + "defaults.fab_line_width" );
     fromLegacy<double>( aCfg, "FabTextSizeV",         bp + "defaults.fab_text_size_v" );
     fromLegacy<double>( aCfg, "FabTextSizeH",         bp + "defaults.fab_text_size_h" );
     fromLegacy<double>( aCfg, "FabTextSizeThickness", bp + "defaults.fab_text_thickness" );
     fromLegacy<bool>(   aCfg, "FabTextItalic",        bp + "defaults.fab_text_italic" );
     fromLegacy<bool>(   aCfg, "FabTextUpright",       bp + "defaults.fab_text_upright" );
 
     if( !fromLegacy<double>( aCfg, "OthersLineWidth", bp + "defaults.other_line_width" ) )
         fromLegacy<double>( aCfg, "ModuleOutlineThickness", bp + "defaults.other_line_width" );
 
     fromLegacy<double>( aCfg, "OthersTextSizeV",         bp + "defaults.other_text_size_v" );
     fromLegacy<double>( aCfg, "OthersTextSizeH",         bp + "defaults.other_text_size_h" );
     fromLegacy<double>( aCfg, "OthersTextSizeThickness", bp + "defaults.other_text_thickness" );
     fromLegacy<bool>(   aCfg, "OthersTextItalic",        bp + "defaults.other_text_italic" );
     fromLegacy<bool>(   aCfg, "OthersTextUpright",       bp + "defaults.other_text_upright" );
 
     fromLegacy<int>( aCfg, "DimensionUnits",     bp + "defaults.dimension_units" );
     fromLegacy<int>( aCfg, "DimensionPrecision", bp + "defaults.dimension_precision" );
 
     std::string sev = bp + "rule_severities";
 
     fromLegacy<bool>( aCfg, "RequireCourtyardDefinitions", sev + "legacy_no_courtyard_defined" );
 
     fromLegacy<bool>( aCfg, "ProhibitOverlappingCourtyards", sev + "legacy_courtyards_overlap" );
 
     {
         int      idx     = 1;
         wxString keyBase = "TrackWidth";
         wxString key     = keyBase;
         double   val;
 
         nlohmann::json widths = nlohmann::json::array();
 
         key << idx;
 
         while( aCfg->Read( key, &val ) )
         {
             widths.push_back( val );
             key = keyBase;
             key << ++idx;
         }
 
         ( *this )[PointerFromString( bp + "track_widths" )] = widths;
     }
 
     {
         int      idx     = 1;
         wxString keyBase = "ViaDiameter";
         wxString key     = keyBase;
         double   diameter;
         double   drill   = 1.0;
 
         nlohmann::json vias = nlohmann::json::array();
 
         key << idx;
 
         while( aCfg->Read( key, &diameter ) )
         {
             key = "ViaDrill";
             aCfg->Read( key << idx, &drill );
 
             nlohmann::json via = { { "diameter", diameter }, { "drill", drill } };
             vias.push_back( via );
 
             key = keyBase;
             key << ++idx;
         }
 
         ( *this )[PointerFromString( bp + "via_dimensions" )] = vias;
     }
 
     {
         int      idx     = 1;
         wxString keyBase = "dPairWidth";
         wxString key     = keyBase;
         double   width;
         double   gap     = 1.0;
         double   via_gap = 1.0;
 
         nlohmann::json pairs = nlohmann::json::array();
 
         key << idx;
 
         while( aCfg->Read( key, &width ) )
         {
             key = "dPairGap";
             aCfg->Read( key << idx, &gap );
 
             key = "dPairViaGap";
             aCfg->Read( key << idx, &via_gap );
 
             nlohmann::json pair = { { "width", width }, { "gap", gap }, { "via_gap", via_gap } };
             pairs.push_back( pair );
 
             key = keyBase;
             key << ++idx;
         }
 
         ( *this )[PointerFromString( bp + "diff_pair_dimensions" )] = pairs;
     }
 
     group_blacklist.insert( wxT( "/pcbnew" ) );
 
     // General group is unused these days, we can throw it away
     group_blacklist.insert( wxT( "/general" ) );
 
     // Next load sheet names and put all other legacy data in the legacy dict
     aCfg->SetPath( wxT( "/" ) );
 
     auto loadSheetNames =
             [&]() -> bool
             {
                 int            sheet = 1;
                 wxString       entry;
                 nlohmann::json arr   = nlohmann::json::array();
 
                 wxLogTrace( traceSettings, "Migrating sheet names" );
 
                 aCfg->SetPath( wxT( "/sheetnames" ) );
 
                 while( aCfg->Read( wxString::Format( "%d", sheet++ ), &entry ) )
                 {
                     wxArrayString tokens = wxSplit( entry, ':' );
 
                     if( tokens.size() == 2 )
                     {
                         wxLogTrace( traceSettings, "%d: %s = %s", sheet, tokens[0], tokens[1] );
                         arr.push_back( nlohmann::json::array( { tokens[0], tokens[1] } ) );
                     }
                 }
 
                 ( *this )[PointerFromString( "sheets" )] = arr;
 
                 aCfg->SetPath( "/" );
 
                 // TODO: any reason we want to fail on this?
                 return true;
             };
 
     std::vector<wxString> groups;
 
     groups.emplace_back( "" );
 
     auto loadLegacyPairs =
             [&]( const std::string& aGroup ) -> bool
             {
                 wxLogTrace( traceSettings, "Migrating group %s", aGroup );
                 bool     success = true;
                 wxString keyStr;
                 wxString val;
 
                 index = 0;
 
                 while( aCfg->GetNextEntry( keyStr, index ) )
                 {
                     if( !aCfg->Read( keyStr, &val ) )
                         continue;
 
                     std::string key( keyStr.ToUTF8() );
 
                     wxLogTrace( traceSettings, "    %s = %s", key, val );
 
                     try
                     {
                         nlohmann::json::json_pointer ptr( "/legacy" + aGroup + "/" + key );
                         ( *this )[ptr] = val;
                     }
                     catch( ... )
                     {
                         success = false;
                     }
                 }
 
                 return success;
             };
 
     for( size_t i = 0; i < groups.size(); i++ )
     {
         aCfg->SetPath( groups[i] );
 
         if( groups[i] == wxT( "/sheetnames" ) )
         {
             ret |= loadSheetNames();
             continue;
         }
 
         aCfg->DeleteEntry( wxT( "last_client" ), true );
         aCfg->DeleteEntry( wxT( "update" ), true );
         aCfg->DeleteEntry( wxT( "version" ), true );
 
         ret &= loadLegacyPairs( groups[i].ToStdString() );
 
         index = 0;
 
         while( aCfg->GetNextGroup( str, index ) )
         {
             wxString group = groups[i] + "/" + str;
 
             if( !group_blacklist.count( group ) )
                 groups.emplace_back( group );
         }
 
         aCfg->SetPath( "/" );
     }
 
     return ret;
 }

References Format(), JSON_SETTINGS::fromLegacyString(), JSON_SETTINGS::PointerFromString(), and traceSettings.

◆ NetSettings()

NET_SETTINGS& PROJECT_FILE::NetSettings ( )

inline

Definition at line 92 of file project_file.h.

     {
         return *m_NetSettings;
     }

References m_NetSettings.

Referenced by SCH_EDITOR_CONTROL::AssignNetclass(), DIALOG_SCHEMATIC_SETUP::DIALOG_SCHEMATIC_SETUP(), SCH_LINE::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), inheritNetclass(), SCH_EDIT_FRAME::KiwayMailIn(), PCB_EDIT_FRAME::LoadProjectSettings(), SCH_ITEM::NetClass(), PCB_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::SaveProjectSettings(), BOARD::SetProject(), PCB_EDIT_FRAME::ShowBoardSetupDialog(), and SCH_EDIT_FRAME::ShowSchematicSetupDialog().

◆ PointerFromString()

nlohmann::json::json_pointer JSON_SETTINGS::PointerFromString ( std::string aPath )

staticinherited

Builds a JSON pointer based on a given string.

Parameters

aPath is the path in the form "key1.key2.key3"

Returns: a JSON pointer that can be used to index into a JSON object

Definition at line 506 of file json_settings.cpp.

 {
     std::replace( aPath.begin(), aPath.end(), '.', '/' );
     aPath.insert( 0, "/" );
 
     nlohmann::json::json_pointer p;
 
     try
     {
         p = nlohmann::json::json_pointer( aPath );
     }
     catch( ... )
     {
         wxASSERT_MSG( false, wxT( "Invalid pointer path in PointerFromString!" ) );
     }
 
     return p;
 }

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

 {
     wxASSERT( aNewSchemaVersion > aOldSchemaVersion );
     wxASSERT( aNewSchemaVersion <= m_schemaVersion );
     m_migrators[aOldSchemaVersion] = std::make_pair( aNewSchemaVersion, aMigrator );
 }

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

Referenced by BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), COLOR_SETTINGS::COLOR_SETTINGS(), COMMON_SETTINGS::COMMON_SETTINGS(), EESCHEMA_SETTINGS::EESCHEMA_SETTINGS(), FOOTPRINT_EDITOR_SETTINGS::FOOTPRINT_EDITOR_SETTINGS(), and PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_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 682 of file json_settings.cpp.

 {
     if( !aSettings )
         return;
 
     auto it = std::find_if( m_nested_settings.begin(), m_nested_settings.end(),
                             [&aSettings]( const JSON_SETTINGS* aPtr ) {
                               return aPtr == aSettings;
                             } );
 
     if( it != m_nested_settings.end() )
     {
         wxLogTrace( traceSettings, "Flush and release %s", ( *it )->GetFilename() );
         ( *it )->SaveToFile();
         m_nested_settings.erase( it );
     }
 
     aSettings->SetParent( nullptr );
 }

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

Referenced by BOARD::ClearProject(), BOARD_DESIGN_SETTINGS::~BOARD_DESIGN_SETTINGS(), ERC_SETTINGS::~ERC_SETTINGS(), NESTED_SETTINGS::~NESTED_SETTINGS(), NET_SETTINGS::~NET_SETTINGS(), and SCHEMATIC_SETTINGS::~SCHEMATIC_SETTINGS().

◆ ResetToDefaults()

void JSON_SETTINGS::ResetToDefaults ( )

inherited

Resets all parameters to default values.

Does NOT write to file or update underlying JSON.

Definition at line 317 of file json_settings.cpp.

 {
     for( auto param : m_params )
         param->SetDefault();
 }

References JSON_SETTINGS::m_params.

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

◆ 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
   @param aDirectory is the directory to save to, including trailing separator

c *

Returns: true if the file was saved

Reimplemented from JSON_SETTINGS.

Definition at line 542 of file project_file.cpp.

 {
     wxASSERT( m_project );
 
     ( *this )[PointerFromString( "meta.filename" )] =
             m_project->GetProjectName() + "." + ProjectFileExtension;
 
     return JSON_SETTINGS::SaveToFile( aDirectory, aForce );
 }

References PROJECT::GetProjectName(), m_project, JSON_SETTINGS::PointerFromString(), ProjectFileExtension, and JSON_SETTINGS::SaveToFile().

Referenced by SETTINGS_MANAGER::SaveProject(), and SETTINGS_MANAGER::SaveProjectAs().

◆ Set() [1/3]

template<typename ValueType >

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

inlineinherited

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

     {
         ( *this )[PointerFromString( aPath ) ] = aVal;
     }

References JSON_SETTINGS::PointerFromString().

Referenced by COLOR_MAP_PARAM::Store(), PARAM< wxString >::Store(), PARAM_PATH::Store(), PARAM_ENUM< EnumType >::Store(), PARAM_LAMBDA< nlohmann::json >::Store(), PARAM_SCALED< ValueType >::Store(), PARAM_LIST< wxString >::Store(), PARAM_PATH_LIST::Store(), PARAM_MAP< Value >::Store(), and PARAM_WXSTRING_MAP::Store().

◆ Set() [2/3]

template<>

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

inherited

◆ Set() [3/3]

template<>

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

inherited

Definition at line 714 of file json_settings.cpp.

 {
     ( *this )[PointerFromString( std::move( aPath ) ) ] = aVal.ToUTF8();
 }

References JSON_SETTINGS::PointerFromString().

◆ SetFilename()

void JSON_SETTINGS::SetFilename ( const wxString & aFilename )

inlineinherited

Definition at line 68 of file json_settings.h.

68 { m_filename = aFilename; }

JSON_SETTINGS::m_filename

wxString m_filename

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

Definition: json_settings.h:292

References JSON_SETTINGS::m_filename.

Referenced by SETTINGS_MANAGER::SaveProjectAs().

◆ SetIfPresent() [1/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 526 of file json_settings.cpp.

 {
     nlohmann::json::json_pointer ptr = PointerFromString( aPath );
 
     if( aObj.contains( ptr ) && aObj.at( ptr ).is_string() )
     {
         aTarget = aObj.at( ptr ).get<wxString>();
         return true;
     }
 
     return false;
 }

References JSON_SETTINGS::PointerFromString().

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

◆ SetIfPresent() [2/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 541 of file json_settings.cpp.

 {
     nlohmann::json::json_pointer ptr = PointerFromString( aPath );
 
     if( aObj.contains( ptr ) && aObj.at( ptr ).is_boolean() )
     {
         aTarget = aObj.at( ptr ).get<bool>();
         return true;
     }
 
     return false;
 }

References JSON_SETTINGS::PointerFromString().

◆ SetIfPresent() [3/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 556 of file json_settings.cpp.

 {
     nlohmann::json::json_pointer ptr = PointerFromString( aPath );
 
     if( aObj.contains( ptr ) && aObj.at( ptr ).is_number_integer() )
     {
         aTarget = aObj.at( ptr ).get<int>();
         return true;
     }
 
     return false;
 }

References JSON_SETTINGS::PointerFromString().

◆ SetIfPresent() [4/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 571 of file json_settings.cpp.

 {
     nlohmann::json::json_pointer ptr = PointerFromString( aPath );
 
     if( aObj.contains( ptr ) && aObj.at( ptr ).is_number_unsigned() )
     {
         aTarget = aObj.at( ptr ).get<unsigned int>();
         return true;
     }
 
     return false;
 }

References JSON_SETTINGS::PointerFromString().

◆ SetLegacyFilename()

void JSON_SETTINGS::SetLegacyFilename ( const wxString & aFilename )

inlineinherited

Definition at line 72 of file json_settings.h.

72 { m_legacy_filename = aFilename; }

JSON_SETTINGS::m_legacy_filename

wxString m_legacy_filename

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

Definition: json_settings.h:295

References JSON_SETTINGS::m_legacy_filename.

Referenced by SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS().

◆ SetManager()

void JSON_SETTINGS::SetManager ( SETTINGS_MANAGER * aManager )

inlineinherited

Definition at line 195 of file json_settings.h.

     {
         m_manager = aManager;
     }

References JSON_SETTINGS::m_manager.

◆ SetProject()

void PROJECT_FILE::SetProject ( PROJECT * aProject )

inline

Definition at line 77 of file project_file.h.

     {
         m_project = aProject;
     }

References m_project.

◆ SetReadOnly()

void JSON_SETTINGS::SetReadOnly ( bool aReadOnly )

inlineinherited

Definition at line 75 of file json_settings.h.

75 { m_writeFile = !aReadOnly; }

JSON_SETTINGS::m_writeFile

bool m_writeFile

Whether or not the backing store file should be written.

Definition: json_settings.h:316

References JSON_SETTINGS::m_writeFile.

Referenced by PANEL_COLOR_SETTINGS::OnThemeChanged().

◆ Store()

bool JSON_SETTINGS::Store ( )

virtualinherited

Stores the current parameters into the JSON document represented by this object Note: this doesn't do any writing to disk; that's handled by SETTINGS_MANAGER.

Returns: true if any part of the JSON document was updated

Definition at line 303 of file json_settings.cpp.

 {
     bool modified = false;
 
     for( auto param : m_params )
     {
         modified |= !param->MatchesFile( this );
         param->Store( this );
     }
 
     return modified;
 }

References JSON_SETTINGS::m_params.

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

Member Data Documentation

◆ m_BoardPageLayoutDescrFile

wxString PROJECT_FILE::m_BoardPageLayoutDescrFile

PcbNew params.

Page layout description file

Definition at line 157 of file project_file.h.

Referenced by PCB_EDIT_FRAME::LoadProjectSettings(), PROJECT_FILE(), and PCB_EDIT_FRAME::SaveProjectSettings().

◆ m_boards

std::vector<FILE_INFO_PAIR> PROJECT_FILE::m_boards

private

A list of board files in this project.

Definition at line 108 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 167 of file project_file.h.

Referenced by BOARD::ClearProject(), and BOARD::SetProject().

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

Referenced by JSON_SETTINGS::SaveToFile().

◆ m_createIfMissing

bool JSON_SETTINGS::m_createIfMissing

protectedinherited

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

Definition at line 307 of file json_settings.h.

Referenced by JSON_SETTINGS::SaveToFile().

◆ m_deleteLegacyAfterMigration

bool JSON_SETTINGS::m_deleteLegacyAfterMigration

protectedinherited

Whether or not to delete legacy file after migration.

Definition at line 319 of file json_settings.h.

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

◆ m_EquivalenceFiles

std::vector<wxString> PROJECT_FILE::m_EquivalenceFiles

CvPcb params.

List of equivalence (equ) files used in the project

Definition at line 150 of file project_file.h.

Referenced by CVPCB_MAINFRAME::buildEquivalenceList(), DIALOG_CONFIG_EQUFILES::Init(), DIALOG_CONFIG_EQUFILES::OnOkClick(), and PROJECT_FILE().

◆ m_ErcSettings

ERC_SETTINGS* PROJECT_FILE::m_ErcSettings

Eeschema params.

Definition at line 135 of file project_file.h.

Referenced by SCHEMATIC::ErcSettings(), DIALOG_SCHEMATIC_SETUP::OnAuxiliaryAction(), SCHEMATIC::Reset(), and SCHEMATIC::SetProject().

◆ m_filename

wxString JSON_SETTINGS::m_filename

protectedinherited

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

Definition at line 292 of file json_settings.h.

Referenced by JSON_SETTINGS::GetFilename(), JSON_SETTINGS::GetFullFilename(), NESTED_SETTINGS::LoadFromFile(), JSON_SETTINGS::LoadFromFile(), COLOR_SETTINGS::migrateSchema0to1(), COLOR_SETTINGS::operator=(), NESTED_SETTINGS::SaveToFile(), JSON_SETTINGS::SaveToFile(), and JSON_SETTINGS::SetFilename().

◆ m_LayerPresets

std::vector<LAYER_PRESET> PROJECT_FILE::m_LayerPresets

List of stored layer presets.

Definition at line 178 of file project_file.h.

Referenced by PCB_EDIT_FRAME::LoadProjectSettings(), PROJECT_FILE(), and PCB_EDIT_FRAME::SaveProjectSettings().

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

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

◆ m_LegacyLibDir

wxString PROJECT_FILE::m_LegacyLibDir

Definition at line 141 of file project_file.h.

Referenced by PART_LIBS::LibNamesAndPaths(), and PROJECT_FILE().

◆ m_LegacyLibNames

wxArrayString PROJECT_FILE::m_LegacyLibNames

Definition at line 143 of file project_file.h.

Referenced by PART_LIBS::LibNamesAndPaths(), and PROJECT_FILE().

◆ m_location

SETTINGS_LOC JSON_SETTINGS::m_location

protectedinherited

The location of this settings file (.

See also: SETTINGS_LOC)

Definition at line 298 of file json_settings.h.

Referenced by JSON_SETTINGS::GetLocation().

◆ m_manager

SETTINGS_MANAGER* JSON_SETTINGS::m_manager

protectedinherited

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

Definition at line 328 of file json_settings.h.

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

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

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

◆ m_nested_settings

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

protectedinherited

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

Definition at line 304 of file json_settings.h.

Referenced by JSON_SETTINGS::AddNestedSettings(), JSON_SETTINGS::LoadFromFile(), JSON_SETTINGS::ReleaseNestedSettings(), and JSON_SETTINGS::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 175 of file project_file.h.

Referenced by NetSettings(), DIALOG_SCHEMATIC_SETUP::OnAuxiliaryAction(), PROJECT_FILE(), and BOARD::SynchronizeNetsAndNetClasses().

◆ m_params

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

protectedinherited

The list of parameters (owned by this object)

Definition at line 301 of file json_settings.h.

Referenced by APP_SETTINGS_BASE::addParamsForWindow(), APP_SETTINGS_BASE::APP_SETTINGS_BASE(), BITMAP2CMP_SETTINGS::BITMAP2CMP_SETTINGS(), BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), COLOR_SETTINGS::COLOR_SETTINGS(), COMMON_SETTINGS::COMMON_SETTINGS(), COLOR_SETTINGS::CreateBuiltinColorSettings(), CVPCB_SETTINGS::CVPCB_SETTINGS(), EDA_3D_VIEWER_SETTINGS::EDA_3D_VIEWER_SETTINGS(), EESCHEMA_SETTINGS::EESCHEMA_SETTINGS(), ERC_SETTINGS::ERC_SETTINGS(), FOOTPRINT_EDITOR_SETTINGS::FOOTPRINT_EDITOR_SETTINGS(), GERBVIEW_SETTINGS::GERBVIEW_SETTINGS(), COLOR_SETTINGS::GetDefaultColor(), COLOR_SETTINGS::initFromOther(), JSON_SETTINGS::IsDefault(), JSON_SETTINGS::JSON_SETTINGS(), KICAD_SETTINGS::KICAD_SETTINGS(), JSON_SETTINGS::Load(), NET_SETTINGS::NET_SETTINGS(), PCB_CALCULATOR_SETTINGS::PCB_CALCULATOR_SETTINGS(), PCBNEW_SETTINGS::PCBNEW_SETTINGS(), PL_EDITOR_SETTINGS::PL_EDITOR_SETTINGS(), PROJECT_FILE(), PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_SETTINGS(), JSON_SETTINGS::ResetToDefaults(), PNS::ROUTING_SETTINGS::ROUTING_SETTINGS(), SCHEMATIC_SETTINGS::SCHEMATIC_SETTINGS(), JSON_SETTINGS::Store(), SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS(), and JSON_SETTINGS::~JSON_SETTINGS().

◆ m_PcbLastPath

wxString PROJECT_FILE::m_PcbLastPath[LAST_PATH_SIZE]

MRU path storage.

Definition at line 160 of file project_file.h.

Referenced by PCB_EDIT_FRAME::GetLastPath(), PROJECT_FILE(), and PCB_EDIT_FRAME::SetLastPath().

◆ m_PinnedFootprintLibs

std::vector<wxString> PROJECT_FILE::m_PinnedFootprintLibs

The list of pinned footprint libraries.

Definition at line 126 of file project_file.h.

Referenced by LIB_TREE_MODEL_ADAPTER::LIB_TREE_MODEL_ADAPTER(), PROJECT_FILE(), and LIB_TREE_MODEL_ADAPTER::SavePinnedItems().

◆ 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 applicationThe list of pinned symbol libraries

Definition at line 123 of file project_file.h.

Referenced by LIB_TREE_MODEL_ADAPTER::LIB_TREE_MODEL_ADAPTER(), PROJECT_FILE(), and LIB_TREE_MODEL_ADAPTER::SavePinnedItems().

◆ m_preserved_paths

std::vector<nlohmann::json::json_pointer> JSON_SETTINGS::m_preserved_paths

protectedinherited

A list of JSON pointers that are preserved during a read-update-write to disk.

Definition at line 331 of file json_settings.h.

◆ m_project

PROJECT* PROJECT_FILE::m_project

private

A link to the owning PROJECT.

Definition at line 111 of file project_file.h.

Referenced by SaveToFile(), and SetProject().

◆ m_resetParamsIfMissing

bool JSON_SETTINGS::m_resetParamsIfMissing

protectedinherited

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

Definition at line 322 of file json_settings.h.

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

◆ m_SchematicSettings

SCHEMATIC_SETTINGS* PROJECT_FILE::m_SchematicSettings

Definition at line 138 of file project_file.h.

Referenced by DIALOG_SCHEMATIC_SETUP::OnAuxiliaryAction(), SCHEMATIC::Reset(), SCHEMATIC::SetProject(), and SCHEMATIC::Settings().

◆ m_schemaVersion

int JSON_SETTINGS::m_schemaVersion

protectedinherited

Version of this settings schema.

Definition at line 325 of file json_settings.h.

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

◆ m_sheets

std::vector<FILE_INFO_PAIR> PROJECT_FILE::m_sheets

private

An list of schematic sheets in this project.

Definition at line 105 of file project_file.h.

Referenced by GetSheets(), and PROJECT_FILE().

◆ m_TextVars

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

Definition at line 128 of file project_file.h.

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

◆ m_writeFile

bool JSON_SETTINGS::m_writeFile

protectedinherited

Whether or not the backing store file should be written.

Definition at line 316 of file json_settings.h.

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

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

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PROJECT_FILE()

◆ ~PROJECT_FILE()

Member Function Documentation

◆ AddNestedSettings()

◆ fromLegacy()

◆ fromLegacyColor()

◆ fromLegacyString()

◆ Get() [1/2]

◆ Get() [2/2]

◆ GetBoards()

◆ getFileExt()

◆ GetFilename()

◆ GetFullFilename()

◆ GetJson()

◆ getLegacyFileExt()

◆ GetLocation()

◆ GetSheets()

◆ IsDefault()

◆ IsReadOnly()

◆ Load()

◆ LoadFromFile()

◆ Migrate()

◆ MigrateFromLegacy()

◆ NetSettings()

◆ PointerFromString()

◆ registerMigration()

◆ ReleaseNestedSettings()

◆ ResetToDefaults()

◆ SaveToFile()

◆ Set() [1/3]

◆ Set() [2/3]

◆ Set() [3/3]

◆ SetFilename()

◆ SetIfPresent() [1/4]

◆ SetIfPresent() [2/4]

◆ SetIfPresent() [3/4]

◆ SetIfPresent() [4/4]

◆ SetLegacyFilename()

◆ SetManager()

◆ SetProject()

◆ SetReadOnly()

◆ Store()

Member Data Documentation

◆ m_BoardPageLayoutDescrFile

◆ m_boards

◆ m_BoardSettings

◆ m_createIfDefault

◆ m_createIfMissing

◆ m_deleteLegacyAfterMigration

◆ m_EquivalenceFiles

◆ m_ErcSettings

◆ m_filename

◆ m_LayerPresets

◆ m_legacy_filename

◆ m_LegacyLibDir

◆ m_LegacyLibNames

◆ m_location

◆ m_manager

◆ m_migrators

◆ m_nested_settings

◆ m_NetSettings

◆ m_params

◆ m_PcbLastPath

◆ m_PinnedFootprintLibs

◆ m_PinnedSymbolLibs

◆ m_preserved_paths

◆ m_project

◆ m_resetParamsIfMissing

◆ m_SchematicSettings

◆ m_schemaVersion

◆ m_sheets

◆ m_TextVars