kicad_settings.cpp

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/>.
 */
#include <wx/aui/framemanager.h>    // ensure class wxAuiPaneInfo is defined for other includes
 
#include "settings/kicad_settings.h"
#include <json_common.h>
#include <settings/aui_settings.h>
#include <settings/parameters.h>
 

const int kicadSchemaVersion = 0;
 
 
const nlohmann::json PCM_DEFAULT_REPOSITORIES = nlohmann::json::array( {
    nlohmann::json( {
        { "name", "KiCad official repository" },
        { "url", PCM_DEFAULT_REPOSITORY_URL },
    } )
} );
 
 
KICAD_SETTINGS::KICAD_SETTINGS() :
        APP_SETTINGS_BASE( "kicad", kicadSchemaVersion ),
        m_LeftWinWidth( 200 ),
        m_ShowHistoryPanel( false ),
        m_ShowGitCommitPanel( true )
{
    m_params.emplace_back( new PARAM<int>( "appearance.left_frame_width", &m_LeftWinWidth, 200 ) );
    m_params.emplace_back( new PARAM<bool>( "aui.show_history_panel", &m_ShowHistoryPanel, false ) );
    m_params.emplace_back( new PARAM<bool>( "aui.show_git_commit_panel", &m_ShowGitCommitPanel, true ) );
 
    m_params.emplace_back( new PARAM_LIST<wxString>( "system.open_projects", &m_OpenProjects, {} ) );
 
    m_params.emplace_back( new PARAM<wxString>( "system.last_design_block_lib_dir", &m_lastDesignBlockLibDir, "" ) );
 
    m_params.emplace_back( new PARAM<wxString>( "system.last_update_check_time", &m_lastUpdateCheckTime, "" ) );
    m_params.emplace_back( new PARAM<wxString>( "system.last_received_update", &m_lastReceivedUpdate, "" ) );
    m_params.emplace_back( new PARAM<bool>( "system.check_for_kicad_updates", &m_KiCadUpdateCheck, true ) );
 
    m_params.emplace_back( new PARAM<wxPoint>( "template.window.pos", &m_TemplateWindowPos, wxDefaultPosition ) );
    m_params.emplace_back( new PARAM<wxSize>( "template.window.size", &m_TemplateWindowSize, wxDefaultSize ) );
    m_params.emplace_back( new PARAM<wxString>( "template.last_used", &m_LastUsedTemplate, "" ) );
    m_params.emplace_back( new PARAM_LIST<wxString>( "template.recent_templates", &m_RecentTemplates, {} ) );
 
    m_params.emplace_back( new PARAM<int>( "template.filter", &m_TemplateFilterChoice, 0 ) );
 
    m_params.emplace_back( new PARAM<wxString>( "template.browsed_path", &m_BrowsedTemplatesPath, "" ) );
 
    m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>(
            "pcm.repositories",
            [&]() -> nlohmann::json
            {
                nlohmann::json js = nlohmann::json::array();
 
                for( const auto& pair : m_PcmRepositories )
                {
                    js.push_back( nlohmann::json( { { "name", pair.first.ToUTF8() },
                                                    { "url", pair.second.ToUTF8() } } ) );
                }
 
                return js;
            },
            [&]( const nlohmann::json aObj )
            {
                m_PcmRepositories.clear();
 
                if( !aObj.is_array() )
                    return;
 
                for( const auto& entry : aObj )
                {
                    if( entry.empty() || !entry.is_object() )
                        continue;
 
                    m_PcmRepositories.emplace_back(
                            std::make_pair( wxString( entry["name"].get<std::string>() ),
                                            wxString( entry["url"].get<std::string>() ) ) );
                }
            },
            PCM_DEFAULT_REPOSITORIES ) );
 
    m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>(
            "libraries.overrides",
            [&]() -> nlohmann::json
            {
                nlohmann::json js = nlohmann::json::object();
 
                for( const auto& [tablePath, libs] : m_LibOverrides )
                {
                    nlohmann::json tableJs = nlohmann::json::object();
 
                    for( const auto& [nickname, override_] : libs )
                    {
                        nlohmann::json entry = nlohmann::json::object();
 
                        if( override_.disabled )
                            entry["disabled"] = true;
 
                        if( override_.hidden )
                            entry["hidden"] = true;
 
                        if( !entry.empty() )
                            tableJs[std::string( nickname.ToUTF8() )] = entry;
                    }
 
                    if( !tableJs.empty() )
                        js[std::string( tablePath.ToUTF8() )] = tableJs;
                }
 
                return js;
            },
            [&]( const nlohmann::json& aObj )
            {
                m_LibOverrides.clear();
 
                if( !aObj.is_object() )
                    return;
 
                for( const auto& [tablePath, tableObj] : aObj.items() )
                {
                    if( !tableObj.is_object() )
                        continue;
 
                    std::map<wxString, LIB_OVERRIDE>& libs =
                            m_LibOverrides[wxString::FromUTF8( tablePath )];
 
                    for( const auto& [nickname, entry] : tableObj.items() )
                    {
                        if( !entry.is_object() )
                            continue;
 
                        LIB_OVERRIDE override_;
 
                        if( entry.contains( "disabled" ) && entry["disabled"].is_boolean() )
                            override_.disabled = entry["disabled"].get<bool>();
 
                        if( entry.contains( "hidden" ) && entry["hidden"].is_boolean() )
                            override_.hidden = entry["hidden"].get<bool>();
 
                        libs[wxString::FromUTF8( nickname )] = override_;
                    }
                }
            },
            nlohmann::json::object() ) );
 
    // The getter omits an override once both flags clear, so the save has to delete the key
    m_params.back()->SetClearUnknownKeys();
 
    m_params.emplace_back(
            new PARAM<wxString>( "pcm.last_download_dir", &m_PcmLastDownloadDir, "" ) );
 
    m_params.emplace_back( new PARAM<bool>( "pcm.check_for_updates", &m_PcmUpdateCheck, true ) );
 
    m_params.emplace_back( new PARAM<bool>( "pcm.lib_auto_add", &m_PcmLibAutoAdd, true ) );
 
    m_params.emplace_back( new PARAM<bool>( "pcm.lib_auto_remove", &m_PcmLibAutoRemove, true ) );
 
    m_params.emplace_back( new PARAM<wxString>( "pcm.lib_prefix", &m_PcmLibPrefix,
                                                wxS( "PCM_" ) ) );
 
    m_params.emplace_back( new PARAM<wxString>( "pcm.last_selected_repo_id", &m_PcmLastSelectedRepoId, "" ) );
}
 
 
bool KICAD_SETTINGS::MigrateFromLegacy( wxConfigBase* aCfg )
{
    bool ret = APP_SETTINGS_BASE::MigrateFromLegacy( aCfg );
 
    ret &= fromLegacy<int>( aCfg, "LeftWinWidth", "appearance.left_frame_width" );
 
    // Override the size parameters to ensure the new PCM button is always shown.
    // This will make the window take the default size instead of the migrated one.
    Set( "window.size_x", 0 );
    Set( "window.size_y", 0 );
 
    return ret;
}