settings_manager.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2020 Jon Evans <[email protected]>
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation, either version 3 of the License, or (at your
 * option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
 
#ifndef _SETTINGS_MANAGER_H
#define _SETTINGS_MANAGER_H
 
#include <algorithm>
#include <mutex>
#include <typeinfo>
#include <core/wx_stl_compat.h> // for wxString hash
#include <settings/json_settings.h>
#include <pgm_base.h>
 
class COLOR_SETTINGS;
class COMMON_SETTINGS;
class KIWAY;
class PROJECT;
class PROJECT_FILE;
class REPORTER;
class wxFileName;
class LOCKFILE;
 

#define PROJECT_BACKUPS_DIR_SUFFIX wxT( "-backups" )
 
#define DEFAULT_THEME wxString( wxT( "user" ) )
 
 
class KICOMMON_API SETTINGS_MANAGER
{
public:
    SETTINGS_MANAGER();
 
    ~SETTINGS_MANAGER();

    bool SettingsDirectoryValid() const;

    bool IsOK() { return m_ok; }

    void SetKiway( KIWAY* aKiway ) { m_kiway = aKiway; }

    template<typename T>
    T* RegisterSettings( T* aSettings, bool aLoadNow = true )
    {
        return static_cast<T*>( registerSettings( aSettings, aLoadNow ) );
    }
 
    void Load();
 
    void Load( JSON_SETTINGS* aSettings );
 
    void Save();
 
    void Save( JSON_SETTINGS* aSettings );

    void FlushAndRelease( JSON_SETTINGS* aSettings, bool aSave = true );

    void ResetToDefaults();

    void ClearFileHistory();

    template<typename T>
    T* GetAppSettings( const char* aFilename )
    {
        std::lock_guard lock( m_app_settings_mutex );
 
        T*     ret      = nullptr;
        size_t typeHash = typeid( T ).hash_code();
 
         if( m_app_settings_cache.count( typeHash ) )
            ret = static_cast<T*>( m_app_settings_cache.at( typeHash ) );
 
        if( ret )
            return ret;
 
#if defined(__clang__)
        auto it = std::find_if( m_settings.begin(), m_settings.end(),
                                [&]( const std::unique_ptr<JSON_SETTINGS>& aSettings )
                                {
                                    return aSettings->GetFilename() == aFilename;
                                } );
#else
        auto it = std::find_if( m_settings.begin(), m_settings.end(),
                                []( const std::unique_ptr<JSON_SETTINGS>& aSettings )
                                {
                                    return dynamic_cast<T*>( aSettings.get() );
                                } );
#endif
 
        if( it != m_settings.end() )
        {
            // Do NOT use dynamic_cast here.  CLang will think it's the wrong class across
            // compile boundaries and return nullptr.
            ret = static_cast<T*>( it->get() );
        }
        else
        {
            wxFAIL_MSG( wxString::Format( "Tried to GetAppSettings before registering: %s", aFilename ) );
        }
 
        m_app_settings_cache[typeHash] = ret;
 
        return ret;
    }

    template<typename T>
    T* GetToolbarSettings( const wxString& aFilename )
    {
        T* ret = nullptr;
 
#if defined(__clang__)
        auto it = std::find_if( m_settings.begin(), m_settings.end(),
                                [&]( const std::unique_ptr<JSON_SETTINGS>& aSettings )
                                {
                                    return aSettings->GetFilename() == aFilename;
                                } );
#else
        auto it = std::find_if( m_settings.begin(), m_settings.end(),
                                []( const std::unique_ptr<JSON_SETTINGS>& aSettings )
                                {
                                    return dynamic_cast<T*>( aSettings.get() );
                                } );
#endif
 
        if( it != m_settings.end() )
        {
            // Do NOT use dynamic_cast here.  CLang will think it's the wrong class across
            // compile boundaries and return nullptr.
            ret = static_cast<T*>( it->get() );
        }
        else
        {
            ret = RegisterSettings( new T );
        }
 
        return ret;
    }

    COLOR_SETTINGS* GetColorSettings( const wxString& aName );
 
    std::vector<COLOR_SETTINGS*> GetColorSettingsList();

    void SaveColorSettings( COLOR_SETTINGS* aSettings, const std::string& aNamespace = "" );

    COLOR_SETTINGS* AddNewColorSettings( const wxString& aFilename );

    COLOR_SETTINGS* GetMigratedColorSettings();

    COMMON_SETTINGS* GetCommonSettings() const { return m_common_settings; }

    wxString GetPathForSettingsFile( JSON_SETTINGS* aSettings );

    bool MigrateFromPreviousVersion( const wxString& aSourcePath );

    bool GetPreviousVersionPaths( std::vector<wxString>* aName = nullptr );

    void ReloadColorSettings();

    bool LoadProject( const wxString& aFullPath, bool aSetActive = true );

    bool UnloadProject( PROJECT* aProject, bool aSave = true );

    bool IsProjectOpen() const;

    bool IsProjectOpenNotDummy() const;

    PROJECT& Prj() const;

    PROJECT* GetProject( const wxString& aFullPath ) const;

    bool IsProjectLoaded( PROJECT* aProject ) const;

    PROJECT* GetProjectForPath( const wxString& aProjectPath ) const;

    std::vector<wxString> GetOpenProjects() const;

    void SyncGlobalFieldNameTemplatesToProjects();

    bool SaveProject( const wxString& aFullPath = wxEmptyString, PROJECT* aProject = nullptr );

    void SaveProjectAs( const wxString& aFullPath, PROJECT* aProject = nullptr );

    bool SaveProjectCopy( const wxString& aFullPath, PROJECT* aProject = nullptr );

    wxString GetProjectBackupsPath() const;

    wxString GetBackupRootForProject( const PROJECT* aProject = nullptr ) const;

    wxString GetLocalHistoryDirForProject( const PROJECT* aProject = nullptr ) const;

    wxString GetLocalHistoryDirForPath( const wxString& aProjectPath ) const;

    wxString GetAutosaveRootForProject( const PROJECT* aProject = nullptr ) const;

    bool BackupProject( REPORTER& aReporter, wxFileName& aTarget ) const;

    bool TriggerBackupIfNeeded( REPORTER& aReporter ) const;

    static bool IsSettingsPathValid( const wxString& aPath );

    static wxString GetColorSettingsPath();

    static wxString GetToolbarSettingsPath();

    static std::string GetSettingsVersion();

    static wxString GetUserSettingsPath();
 
private:
    JSON_SETTINGS* registerSettings( JSON_SETTINGS* aSettings, bool aLoadNow = true );

    static int compareVersions( const std::string& aFirst, const std::string& aSecond );

    static bool extractVersion( const std::string& aVersionString, int* aMajor = nullptr,
                                int* aMinor = nullptr );

    COLOR_SETTINGS* loadColorSettingsByName( const wxString& aName );
 
    COLOR_SETTINGS* registerColorSettings( const wxString& aFilename, bool aAbsolutePath = false );
 
    void loadAllColorSettings();

    static wxString projectKeySuffix( const PROJECT* aProject );

    const PROJECT& resolveProject( const PROJECT* aProject ) const;

    bool loadProjectFile( PROJECT& aProject );

    bool unloadProjectFile( PROJECT* aProject, bool aSave );

    void registerBuiltinColorSettings();
 
private:

    KIWAY* m_kiway;
 
    std::vector<std::unique_ptr<JSON_SETTINGS>> m_settings;
 
    std::unordered_map<wxString, COLOR_SETTINGS*> m_color_settings;

    std::unordered_map<size_t, JSON_SETTINGS*> m_app_settings_cache;
    std::mutex m_app_settings_mutex;
 
    // Convenience shortcut
    COMMON_SETTINGS* m_common_settings;

    bool m_migrateLibraryTables;

    bool m_ok;

    std::vector<std::unique_ptr<PROJECT>> m_projects_list;

    std::map<wxString, PROJECT*> m_projects;

    std::map<wxString, PROJECT_FILE*> m_project_files;
 
    static wxString backupDateTimeFormat;
};
 
 
template<typename T>
T* GetAppSettings( const char* aFilename )
{
    if( PGM_BASE* pgm = PgmOrNull() )
        return pgm->GetSettingsManager().GetAppSettings<T>( aFilename );
 
    return nullptr;
}
 
 
template<typename T>
T* GetToolbarSettings( const wxString& aFilename )
{
    if( PGM_BASE* pgm = PgmOrNull() )
        return pgm->GetSettingsManager().GetToolbarSettings<T>( aFilename );
 
    return nullptr;
}
 
 
inline COLOR_SETTINGS* GetColorSettings( const wxString& aName )
{
    return Pgm().GetSettingsManager().GetColorSettings( aName );
}
 
#endif