common_settings.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/>.
 */
 
#pragma once
 
#include <memory>
#include <vector>
#include <mouse_drag_action.h>
#include <settings/environment.h>
#include <settings/json_settings.h>
#include <template_fieldnames.h>
 
struct COMMON_SETTINGS_INTERNALS;
 
enum class ICON_THEME
{
    LIGHT,
    DARK,
    AUTO
};
 
enum class APP_THEME
{
    LIGHT,
    DARK,
    AUTO
};
 
enum class BACKUP_FORMAT
{
    INCREMENTAL = 0,    
    ZIP         = 1     
};
 
enum class BACKUP_LOCATION
{
    PROJECT_DIR = 0,    
    USER_DIR    = 1     
};
 
enum class TOUCHPAD_MODE
{
    NATIVE_GESTURES = 0,
    SCROLL_GESTURES = 1
};
 
class KICOMMON_API COMMON_SETTINGS : public JSON_SETTINGS
{
public:
    struct APPEARANCE
    {
        bool       show_scrollbars;
        double     canvas_scale;
        ICON_THEME icon_theme;
        APP_THEME app_theme;
        bool       use_icons_in_menus;
        bool       apply_icon_scale_to_fonts;
        double     hicontrast_dimming_factor;
        int        text_editor_zoom;
        int        toolbar_icon_size;
        bool       grid_striping;
        bool       use_custom_cursors;
        double     zoom_correction_factor;
    };
 
    struct AUTO_BACKUP
    {
        bool            enabled;            
        BACKUP_FORMAT   format;             
        BACKUP_LOCATION location;           
        bool            backup_on_autosave; 
        int             limit_total_files;  
        int             limit_daily_files;  
        int             min_interval;       

        unsigned long long limit_total_size;
 
        constexpr static unsigned long long UNLIMITED_SIZE = 0; 
    };
 
    struct ENVIRONMENT
    {
        ENV_VAR_MAP vars;
    };
 
    struct INPUT
    {
        bool focus_follow_sch_pcb;
        bool auto_pan;
        int  auto_pan_acceleration;
        bool center_on_zoom;
        bool immediate_actions;
        bool warp_mouse_on_move;
        bool horizontal_pan;
        bool hotkey_feedback;
 
        bool zoom_acceleration;
        int  zoom_speed;
        bool zoom_speed_auto;
 
        TOUCHPAD_MODE touchpad_mode;
 
        int scroll_modifier_zoom;
        int scroll_modifier_pan_h;
        int scroll_modifier_pan_v;
 
        int motion_pan_modifier;
 
        MOUSE_DRAG_ACTION drag_left;
        MOUSE_DRAG_ACTION drag_middle;
        MOUSE_DRAG_ACTION drag_right;
 
        bool reverse_scroll_zoom;
        bool reverse_scroll_pan_h;
    };
 
    struct SPACEMOUSE
    {
        int  rotate_speed;
        int  pan_speed;
        bool reverse_rotate;
        bool reverse_pan_x;
        bool reverse_pan_y;
        bool reverse_zoom;
    };
 
    struct GRAPHICS
    {
        int canvas_type; 
        int aa_mode;
    };
 
    struct SESSION
    {
        bool remember_open_files;
        std::vector<wxString> pinned_symbol_libs;
        std::vector<wxString> pinned_fp_libs;
        std::vector<wxString> pinned_design_block_libs;
    };
 
    struct SYSTEM
    {
        int local_history_debounce;
        wxString text_editor;
        wxString file_explorer;
        int file_history_size;
        wxString language;
        wxString pdf_viewer_name;
        bool use_system_pdf_viewer;
        wxString working_dir;
        int clear_3d_cache_interval;
    };
 
    struct DO_NOT_SHOW_AGAIN
    {
        bool zone_fill_warning;
        bool env_var_overwrite_warning;
        bool scaled_3d_models_warning;
        bool data_collection_prompt;
        bool update_check_prompt;
        bool migrate_wrl_prompt;
    };
 
    // Sticky "Embed file" choice, remembered per file-picker context.
    struct EMBED_FILE_DEFAULTS
    {
        bool datasheet;
        bool drawing_sheet;
        bool model_3d;
        bool sim_model;
    };
 
    // Sticky "Use relative path" choice, remembered per file-picker context.
    struct RELATIVE_PATH_DEFAULTS
    {
        bool drawing_sheet;
        bool jobset_destination;
    };
 
    struct PACKAGE_MANAGER
    {
        int sash_pos;
    };
 
    struct GIT_REPOSITORY
    {
        wxString name;
        wxString path;
        wxString authType;
        wxString username;
        wxString ssh_path;
        bool     active;
        bool     checkValid;
    };
 
    struct GIT
    {
        std::vector<GIT_REPOSITORY> repositories;
        bool                        enableGit;
        int                         updatInterval;
        bool                        useDefaultAuthor;
        wxString                    authorName;
        wxString                    authorEmail;
        bool                        showContributorAvatars;
    };
 
    struct API
    {
        wxString python_interpreter;
        bool enable_server;
    };
 
    COMMON_SETTINGS();
 
    virtual ~COMMON_SETTINGS();
 
    COMMON_SETTINGS_INTERNALS& CsInternals()             { return *m_csInternals; }
    const COMMON_SETTINGS_INTERNALS& CsInternals() const { return *m_csInternals; }
 
    virtual bool MigrateFromLegacy( wxConfigBase* aLegacyConfig ) override;

    void InitializeEnvironment();

    bool AutosaveUsesLocalHistory() const
    {
        return m_Backup.enabled && m_Backup.format == BACKUP_FORMAT::INCREMENTAL;
    }
 
private:
    bool migrateSchema0to1();
    bool migrateSchema1to2();
    bool migrateSchema2to3();
    bool migrateSchema3to4();
    bool migrateSchema4to5();
    bool migrateSchema5to6();
    bool migrateSchema6to7();
 
    struct LEGACY_3D_SEARCH_PATH
    {
        wxString m_Alias;       // alias to the base path
        wxString m_Pathvar;     // base path as stored in the config file
        wxString m_Pathexp;     // expanded base path
        wxString m_Description; // description of the aliased path
    };
 
    static bool getLegacy3DHollerith( const std::string& aString, size_t& aIndex,
                                      wxString& aResult );
    bool readLegacy3DResolverCfg( const wxString& aPath,
                                  std::vector<LEGACY_3D_SEARCH_PATH>& aSearchPaths );
 
public:
    APPEARANCE          m_Appearance;
    AUTO_BACKUP         m_Backup;
    ENVIRONMENT         m_Env;
    INPUT               m_Input;
    SPACEMOUSE          m_SpaceMouse;
    GRAPHICS            m_Graphics;
    SESSION             m_Session;
    SYSTEM              m_System;
    DO_NOT_SHOW_AGAIN   m_DoNotShowAgain;
    EMBED_FILE_DEFAULTS m_EmbedFileDefaults;
    RELATIVE_PATH_DEFAULTS m_RelativePathDefaults;
    PACKAGE_MANAGER     m_PackageManager;
    GIT                 m_Git;
    API                 m_Api;

    TEMPLATES           m_FieldNameTemplates;

    std::vector<wxString> m_Extra3DSearchDirs;

    std::vector<wxString> m_DeclinedModelPreviewRequirements;
 
    std::unique_ptr<COMMON_SETTINGS_INTERNALS> m_csInternals;
};