kicad-source/common/settings/kicad_settings.cpp
Seth Hillbrand 0b2d4d4879 Revise Copyright statement to align with TLF
Recommendation is to avoid using the year nomenclature as this
information is already encoded in the git repo.  Avoids needing to
repeatly update.

Also updates AUTHORS.txt from current repo with contributor names
2025-01-01 14:12:04 -08:00

125 lines
4.6 KiB
C++

/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2020 Jon Evans <jon@craftyjon.com>
* 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 <http://www.gnu.org/licenses/>.
*/
#include <wx/aui/framemanager.h> // ensure class wxAuiPaneInfo is defined for other includes
#include "settings/kicad_settings.h"
#include <nlohmann/json.hpp>
#include <settings/aui_settings.h>
#include <settings/parameters.h>
///! Update the schema version whenever a migration is required
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_params.emplace_back( new PARAM<int>( "appearance.left_frame_width", &m_LeftWinWidth, 200 ) );
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_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<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_" ) ) );
}
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;
}