JSON_SETTINGS Class Reference

#include <json_settings.h>

Inheritance diagram for JSON_SETTINGS:

Public Member Functions
	JSON_SETTINGS (const wxString &aFilename, SETTINGS_LOC aLocation, int aSchemaVersion)
	JSON_SETTINGS (const wxString &aFilename, SETTINGS_LOC aLocation, int aSchemaVersion, bool aCreateIfMissing, bool aCreateIfDefault, bool aWriteFile)
virtual	~JSON_SETTINGS ()
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...
virtual bool	SaveToFile (const wxString &aDirectory="", bool aForce=false)
void	ResetToDefaults ()
	Resets all parameters to default values. 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<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...
bool	Migrate ()
	Migrates the schema of this settings from the version in the file to the latest version. More...
virtual bool	MigrateFromLegacy (wxConfigBase *aLegacyConfig)
	Migrates from wxConfig to JSON-based configuration. 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)
template<>
OPT< wxString >	Get (const std::string &aPath) const
template<>
void	Set (const std::string &aPath, wxString aVal)
template<>
void	Set (const std::string &aPath, wxString aVal)

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

Protected Member Functions
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...
virtual wxString	getFileExt () const
virtual wxString	getLegacyFileExt () const

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

Detailed Description

Definition at line 53 of file json_settings.h.

Constructor & Destructor Documentation

JSON_SETTINGS() [1/2]

JSON_SETTINGS::JSON_SETTINGS ( const wxString &  aFilename, SETTINGS_LOC  aLocation, int  aSchemaVersion  )

inline

Definition at line 56 of file json_settings.h.

                                                                                           :
            JSON_SETTINGS( aFilename, aLocation, aSchemaVersion, true, true, true ) {}

JSON_SETTINGS() [2/2]

JSON_SETTINGS::JSON_SETTINGS	(	const wxString &	aFilename,
		SETTINGS_LOC	aLocation,
		int	aSchemaVersion,
		bool	aCreateIfMissing,
		bool	aCreateIfDefault,
		bool	aWriteFile
	)

Definition at line 41 of file json_settings.cpp.

                                                :
        nlohmann::json(),
        m_filename( aFilename ),
        m_legacy_filename( "" ),
        m_location( aLocation ),
        m_createIfMissing( aCreateIfMissing ),
        m_createIfDefault( aCreateIfDefault ),
        m_writeFile( aWriteFile ),
        m_deleteLegacyAfterMigration( true ),
        m_resetParamsIfMissing( true ),
        m_schemaVersion( aSchemaVersion ),
        m_manager( nullptr )
{
    try
    {
        ( *this )[PointerFromString( "meta.filename" )] = GetFullFilename();
    }
    catch( ... )
    {
        wxLogTrace( traceSettings, "Error: Could not create filename field for %s",
                    GetFullFilename() );
    }


    m_params.emplace_back(
            new PARAM<int>( "meta.version", &m_schemaVersion, m_schemaVersion, true ) );
}

References GetFullFilename(), m_params, m_schemaVersion, PointerFromString(), and traceSettings.

~JSON_SETTINGS()

JSON_SETTINGS::~JSON_SETTINGS ( )

virtual

Definition at line 72 of file json_settings.cpp.

{
    for( auto param: m_params )
        delete param;

    m_params.clear();
}

References m_params.

Member Function Documentation

AddNestedSettings()

void JSON_SETTINGS::AddNestedSettings

(

NESTED_SETTINGS *

aSettings

)

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

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

References GetFilename(), 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  )

protected

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 571 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 PointerFromString().

fromLegacyColor()

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

protected

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 631 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 PointerFromString().

Referenced by APP_SETTINGS_BASE::migrateWindowConfig().

fromLegacyString()

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

protected

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 607 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 PointerFromString().

Referenced by BITMAP2CMP_SETTINGS::MigrateFromLegacy(), FOOTPRINT_EDITOR_SETTINGS::MigrateFromLegacy(), GERBVIEW_SETTINGS::MigrateFromLegacy(), SYMBOL_EDITOR_SETTINGS::MigrateFromLegacy(), PROJECT_FILE::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

inline

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

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

        return NULLOPT;
    }

References 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

Definition at line 689 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 GetJson(), and NULLOPT.

getFileExt()

virtual wxString JSON_SETTINGS::getFileExt ( ) const

inlineprotectedvirtual

Reimplemented in PROJECT_FILE, and PROJECT_LOCAL_SETTINGS.

Definition at line 274 of file json_settings.h.

    {
        return wxT( "json" );
    }

Referenced by GetFullFilename(), LoadFromFile(), and SaveToFile().

GetFilename()

wxString JSON_SETTINGS::GetFilename ( ) const

inline

Definition at line 64 of file json_settings.h.

{ return m_filename; }

References m_filename.

Referenced by 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

Definition at line 81 of file json_settings.cpp.

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

References getFileExt(), and m_filename.

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

GetJson()

OPT< nlohmann::json > JSON_SETTINGS::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.

Parameters

aPath

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

Returns

a JSON object from within this one

Definition at line 420 of file json_settings.cpp.

{
    nlohmann::json::json_pointer ptr = PointerFromString( aPath );

    if( this->contains( ptr ) )
    {
        try
        {
            return OPT<nlohmann::json>{ this->at( ptr ) };
        }
        catch( ... )
        {
        }
    }

    return OPT<nlohmann::json>{};
}

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

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

virtual wxString JSON_SETTINGS::getLegacyFileExt ( ) const

inlineprotectedvirtual

Reimplemented in PROJECT_FILE, and PROJECT_LOCAL_SETTINGS.

Definition at line 279 of file json_settings.h.

    {
        return wxEmptyString;
    }

Referenced by LoadFromFile().

GetLocation()

SETTINGS_LOC JSON_SETTINGS::GetLocation ( ) const

inline

Definition at line 70 of file json_settings.h.

{ return m_location; }

References m_location.

Referenced by SETTINGS_MANAGER::GetPathForSettingsFile().

IsReadOnly()

bool JSON_SETTINGS::IsReadOnly ( ) const

inline

Definition at line 74 of file json_settings.h.

{ return !m_writeFile; }

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

virtual

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 m_params, m_resetParamsIfMissing, and traceSettings.

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

LoadFromFile()

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

virtual

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;
        }

        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.
        SaveToFile( aDirectory, true );
    }

    return success;
}

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

Referenced by SETTINGS_MANAGER::SaveColorSettings().

Migrate()

bool JSON_SETTINGS::Migrate

(

)

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 448 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 m_migrators, m_schemaVersion, PointerFromString(), and traceSettings.

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

MigrateFromLegacy()

bool JSON_SETTINGS::MigrateFromLegacy ( wxConfigBase *  aLegacyConfig )

virtual

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 in PCBNEW_SETTINGS, EESCHEMA_SETTINGS, APP_SETTINGS_BASE, PCB_CALCULATOR_SETTINGS, COMMON_SETTINGS, EDA_3D_VIEWER_SETTINGS, PROJECT_FILE, COLOR_SETTINGS, PROJECT_LOCAL_SETTINGS, SYMBOL_EDITOR_SETTINGS, GERBVIEW_SETTINGS, FOOTPRINT_EDITOR_SETTINGS, CVPCB_SETTINGS, BITMAP2CMP_SETTINGS, PL_EDITOR_SETTINGS, and KICAD_SETTINGS.

Definition at line 482 of file json_settings.cpp.

{
    wxLogTrace( traceSettings,
            "MigrateFromLegacy() not implemented for %s", typeid( *this ).name() );
    return false;
}

References traceSettings.

Referenced by LoadFromFile().

PointerFromString()

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

static

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 490 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;
}

Referenced by fromLegacy(), fromLegacyColor(), fromLegacyString(), GetJson(), JSON_SETTINGS(), NESTED_SETTINGS::LoadFromFile(), LoadFromFile(), BOARD_DESIGN_SETTINGS::LoadFromFile(), Migrate(), APP_SETTINGS_BASE::migrateFindReplace(), FOOTPRINT_EDITOR_SETTINGS::MigrateFromLegacy(), GERBVIEW_SETTINGS::MigrateFromLegacy(), SYMBOL_EDITOR_SETTINGS::MigrateFromLegacy(), PROJECT_FILE::MigrateFromLegacy(), EDA_3D_VIEWER_SETTINGS::MigrateFromLegacy(), COMMON_SETTINGS::MigrateFromLegacy(), PCB_CALCULATOR_SETTINGS::MigrateFromLegacy(), APP_SETTINGS_BASE::MigrateFromLegacy(), EESCHEMA_SETTINGS::MigrateFromLegacy(), PCBNEW_SETTINGS::MigrateFromLegacy(), SETTINGS_MANAGER::SaveColorSettings(), NESTED_SETTINGS::SaveToFile(), PROJECT_LOCAL_SETTINGS::SaveToFile(), PROJECT_FILE::SaveToFile(), Set(), and SetIfPresent().

registerMigration()

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

protected

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

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

References m_migrators, and m_schemaVersion.

Referenced by BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), COLOR_SETTINGS::COLOR_SETTINGS(), COMMON_SETTINGS::COMMON_SETTINGS(), FOOTPRINT_EDITOR_SETTINGS::FOOTPRINT_EDITOR_SETTINGS(), and PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_SETTINGS().

ReleaseNestedSettings()

void JSON_SETTINGS::ReleaseNestedSettings

(

NESTED_SETTINGS *

aSettings

)

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

(

)

Resets all parameters to default values.

Does NOT write to file or update underlying JSON.

Definition at line 313 of file json_settings.cpp.

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

References m_params.

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

SaveToFile()

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

virtual

   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 in PROJECT_FILE, PROJECT_LOCAL_SETTINGS, and NESTED_SETTINGS.

Definition at line 320 of file json_settings.cpp.

{
    if( !m_writeFile )
        return false;

    // Default PROJECT won't have a filename set
    if( m_filename.IsEmpty() )
        return false;

    wxFileName path;

    if( aDirectory.empty() )
    {
        path.Assign( m_filename );
        path.SetExt( getFileExt() );
    }
    else
    {
        wxString dir( aDirectory );
        path.Assign( dir, m_filename, getFileExt() );
    }

    if( !m_createIfMissing && !path.FileExists() )
    {
        wxLogTrace( traceSettings,
                "File for %s doesn't exist and m_createIfMissing == false; not saving",
                GetFullFilename() );
        return false;
    }

    // Ensure the path exists, and create it if not.
    if( !path.DirExists() && !path.Mkdir() )
    {
        wxLogTrace( traceSettings, "Warning: could not create path %s, can't save %s",
                    path.GetPath(), GetFullFilename() );
        return false;
    }

    if( ( path.FileExists() && !path.IsFileWritable() ) ||
        ( !path.FileExists() && !path.IsDirWritable() ) )
    {
        wxLogTrace( traceSettings, "File for %s is read-only; not saving", GetFullFilename() );
        return false;
    }

    bool modified = false;

    for( auto settings : m_nested_settings )
        modified |= settings->SaveToFile();

    modified |= Store();

    if( !modified && !aForce && path.FileExists() )
    {
        wxLogTrace( traceSettings, "%s contents not modified, skipping save", GetFullFilename() );
        return false;
    }
    else if( !modified && !aForce && !m_createIfDefault )
    {
        wxLogTrace( traceSettings,
                "%s contents still default and m_createIfDefault == false; not saving",
                    GetFullFilename() );
        return false;
    }

    wxLogTrace( traceSettings, "Saving %s", GetFullFilename() );

    LOCALE_IO dummy;
    bool success = true;

    try
    {
        std::stringstream buffer;
        buffer << std::setw( 2 ) << *this << std::endl;

        wxFFileOutputStream fileStream( path.GetFullPath(), "wb" );

        if( !fileStream.IsOk()
                || !fileStream.WriteAll( buffer.str().c_str(), buffer.str().size() ) )
        {
            wxLogTrace( traceSettings, "Warning: could not save %s", GetFullFilename() );
            success = false;
        }
    }
    catch( nlohmann::json::exception& error )
    {
        wxLogTrace( traceSettings, "Catch error: could not save %s. Json error %s",
                    GetFullFilename(), error.what() );
        success = false;
    }
    catch( ... )
    {
        wxLogTrace( traceSettings, "Error: could not save %s." );
        success = false;
    }

    return success;
}

References dummy(), getFileExt(), GetFullFilename(), m_createIfDefault, m_createIfMissing, m_filename, m_nested_settings, m_writeFile, Store(), and traceSettings.

Referenced by LoadFromFile(), PANEL_COLOR_SETTINGS::OnThemeChanged(), SETTINGS_MANAGER::SaveColorSettings(), PROJECT_LOCAL_SETTINGS::SaveToFile(), PROJECT_FILE::SaveToFile(), and PGM_BASE::SetLanguage().

Set() [1/3]

template<typename ValueType >

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

inline

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

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

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

Set() [3/3]

template<>

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

Definition at line 698 of file json_settings.cpp.

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

References PointerFromString().

SetFilename()

void JSON_SETTINGS::SetFilename ( const wxString &  aFilename )

inline

Definition at line 68 of file json_settings.h.

{ m_filename = aFilename; }

References m_filename.

Referenced by SETTINGS_MANAGER::SaveProjectAs().

SetIfPresent() [1/4]

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

static

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

static

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 525 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 PointerFromString().

SetIfPresent() [3/4]

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

static

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 540 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 PointerFromString().

SetIfPresent() [4/4]

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

static

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 555 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 PointerFromString().

SetLegacyFilename()

void JSON_SETTINGS::SetLegacyFilename ( const wxString &  aFilename )

inline

Definition at line 72 of file json_settings.h.

{ m_legacy_filename = aFilename; }

References m_legacy_filename.

Referenced by SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS().

SetManager()

void JSON_SETTINGS::SetManager ( SETTINGS_MANAGER *  aManager )

inline

Definition at line 188 of file json_settings.h.

    {
        m_manager = aManager;
    }

References m_manager.

SetReadOnly()

void JSON_SETTINGS::SetReadOnly ( bool  aReadOnly )

inline

Definition at line 75 of file json_settings.h.

{ m_writeFile = !aReadOnly; }

References m_writeFile.

Referenced by PANEL_COLOR_SETTINGS::OnThemeChanged().

Store()

bool JSON_SETTINGS::Store ( )

virtual

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

{
    bool modified = false;

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

    return modified;
}

References m_params.

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

Member Data Documentation

m_createIfDefault

bool JSON_SETTINGS::m_createIfDefault

protected

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

Referenced by SaveToFile().

m_createIfMissing

bool JSON_SETTINGS::m_createIfMissing

protected

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

Definition at line 300 of file json_settings.h.

Referenced by SaveToFile().

m_deleteLegacyAfterMigration

bool JSON_SETTINGS::m_deleteLegacyAfterMigration

protected

Whether or not to delete legacy file after migration.

Definition at line 312 of file json_settings.h.

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

m_filename

wxString JSON_SETTINGS::m_filename

protected

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

Definition at line 285 of file json_settings.h.

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

m_legacy_filename

wxString JSON_SETTINGS::m_legacy_filename

protected

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

Definition at line 288 of file json_settings.h.

Referenced by LoadFromFile(), and SetLegacyFilename().

m_location

SETTINGS_LOC JSON_SETTINGS::m_location

protected

The location of this settings file (.

See also

SETTINGS_LOC)

Definition at line 291 of file json_settings.h.

Referenced by GetLocation().

m_manager

SETTINGS_MANAGER* JSON_SETTINGS::m_manager

protected

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

Definition at line 321 of file json_settings.h.

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

m_migrators

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

protected

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

Definition at line 327 of file json_settings.h.

Referenced by Migrate(), and registerMigration().

m_nested_settings

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

protected

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

Definition at line 297 of file json_settings.h.

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

m_params

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

protected

The list of parameters (owned by this object)

Definition at line 294 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(), KICAD_SETTINGS::KICAD_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_FILE(), PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_SETTINGS(), ResetToDefaults(), PNS::ROUTING_SETTINGS::ROUTING_SETTINGS(), SCHEMATIC_SETTINGS::SCHEMATIC_SETTINGS(), Store(), SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS(), and ~JSON_SETTINGS().

m_preserved_paths

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

protected

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

Definition at line 324 of file json_settings.h.

m_resetParamsIfMissing

bool JSON_SETTINGS::m_resetParamsIfMissing

protected

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

Definition at line 315 of file json_settings.h.

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

m_schemaVersion

int JSON_SETTINGS::m_schemaVersion

protected

Version of this settings schema.

Definition at line 318 of file json_settings.h.

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

m_writeFile

bool JSON_SETTINGS::m_writeFile

protected

Whether or not the backing store file should be written.

Definition at line 309 of file json_settings.h.

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

---

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

• json_settings.h
• json_settings.cpp