project_local_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 CERN
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 * @author Jon Evans <[email protected]>
 *
 * 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 <http://www.gnu.org/licenses/>.
 */
 
#ifndef KICAD_PROJECT_LOCAL_SETTINGS_H
#define KICAD_PROJECT_LOCAL_SETTINGS_H
 
#include <layer_ids.h>
#include <project/board_project_settings.h>
#include <project/sch_project_settings.h>
#include <settings/json_settings.h>
#include <wildcards_and_files_ext.h>
#include <settings/app_settings.h>
 
class PROJECT;
 
struct KICOMMON_API PROJECT_FILE_STATE
{
    wxString fileName;
    bool open;
    struct WINDOW_STATE window;
};
 
 
class KICOMMON_API PROJECT_LOCAL_SETTINGS : public JSON_SETTINGS
{
public:
    PROJECT_LOCAL_SETTINGS( PROJECT* aProject, const wxString& aFilename );
 
    virtual ~PROJECT_LOCAL_SETTINGS() {}
 
    bool MigrateFromLegacy( wxConfigBase* aLegacyConfig ) override;
 
    bool SaveAs( const wxString& aDirectory, const wxString& aFile );
 
    bool SaveToFile( const wxString& aDirectory = "", bool aForce = false ) override;
 
    void SetProject( PROJECT* aProject ) { m_project = aProject; }
 
    void SaveFileState( const wxString& aFileName, const WINDOW_SETTINGS* aWindowCfg, bool aOpen );
 
    const PROJECT_FILE_STATE* GetFileState( const wxString& aFileName );
 
    void ClearFileState();
 
    bool ShouldAutoSave() const { return !m_wasMigrated && !m_isFutureFormat; }
 
protected:
    wxString getFileExt() const override
    {
        return FILEEXT::ProjectLocalSettingsFileExtension;
    }
 
    wxString getLegacyFileExt() const override
    {
        return wxT( "NO_SUCH_FILE_EXTENSION" );
    }
 
public:
 
    std::vector<PROJECT_FILE_STATE> m_files;
 
    std::vector<wxString>           m_OpenJobSets;
 
    LSET m_VisibleLayers;
 
    GAL_SET m_VisibleItems;
 
    PCB_LAYER_ID m_ActiveLayer;
 
    wxString m_ActiveLayerPreset;
 
    HIGH_CONTRAST_MODE m_ContrastModeDisplay;
 
    NET_COLOR_MODE m_NetColorMode;
 
    PANEL_NET_INSPECTOR_SETTINGS m_NetInspectorPanel;
 
    bool m_AutoTrackWidth;
 
    ZONE_DISPLAY_MODE m_ZoneDisplayMode;
 
    bool m_PrototypeZoneFill;
 
    double m_TrackOpacity;     
    double m_ViaOpacity;       
    double m_PadOpacity;       
    double m_ZoneOpacity;      
    double m_ShapeOpacity;     
    double m_ImageOpacity;     
 
    std::vector<wxString> m_HiddenNets;
    std::set<wxString> m_HiddenNetclasses;
 
    PCB_SELECTION_FILTER_OPTIONS m_PcbSelectionFilter;
    SCH_SELECTION_FILTER_OPTIONS m_SchSelectionFilter;
 
    std::vector<wxString> m_SchHierarchyCollapsed;
 
    // Upstream git repo info
    wxString m_GitRepoUsername;
    wxString m_GitRepoType;
    wxString m_GitSSHKey;
 
private:
    PROJECT* m_project;
 
    bool m_wasMigrated;
};
 
#endif