KiCad PCB EDA Suite
gerbview_settings.cpp
Go to the documentation of this file.
1/*
2* This program source code file is part of KiCad, a free EDA CAD application.
3*
4* Copyright (C) 2021-2022 KiCad Developers, see AUTHORS.txt for contributors.
5*
6* This program is free software; you can redistribute it and/or
7* modify it under the terms of the GNU General Public License
8* as published by the Free Software Foundation; either version 2
9* of the License, or (at your option) any later version.
10*
11* This program is distributed in the hope that it will be useful,
12* but WITHOUT ANY WARRANTY; without even the implied warranty of
13* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14* GNU General Public License for more details.
15*
16* You should have received a copy of the GNU General Public License
17* along with this program; if not, you may find one here:
18* http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
19* or you may search the http://www.gnu.org website for the version 2 license,
20* or you may write to the Free Software Foundation, Inc.,
21* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
22*/
23
24#include <gerbview_settings.h>
25#include <layer_ids.h>
26#include <pgm_base.h>
29#include <settings/parameters.h>
31#include <wx/config.h>
32
33
36
37
40 m_Appearance(),
41 m_BoardLayersCount( 2 )
42{
43 // Init settings:
44 m_params.emplace_back( new PARAM<bool>( "appearance.show_border_and_titleblock",
46
47 m_params.emplace_back( new PARAM<bool>( "appearance.show_dcodes",
48 &m_Appearance.show_dcodes, false ) );
49
50 m_params.emplace_back( new PARAM<bool>( "appearance.show_negative_objects",
52
53 m_params.emplace_back( new PARAM<wxString>( "appearance.page_type",
54 &m_Appearance.page_type, "GERBER" ) );
55
56 m_params.emplace_back( new PARAM_LIST<wxString>( "system.drill_file_history",
57 &m_DrillFileHistory, {} ) );
58
59 m_params.emplace_back( new PARAM_LIST<wxString>( "system.zip_file_history",
60 &m_ZipFileHistory, {} ) );
61
62 m_params.emplace_back( new PARAM_LIST<wxString>( "system.job_file_history",
63 &m_JobFileHistory, {} ) );
64
65 m_params.emplace_back( new PARAM_LIST<int>( "gerber_to_pcb_layers",
67
68 m_params.emplace_back( new PARAM<int>( "gerber_to_pcb_copperlayers_count",
69 &m_BoardLayersCount, 2 ) );
70
71 m_params.emplace_back( new PARAM<bool>( "excellon_defaults.unit_mm",
72 &m_ExcellonDefaults.m_UnitsMM, false ) );
73
74 m_params.emplace_back( new PARAM<bool>( "excellon_defaults.lz_format",
76
77 m_params.emplace_back( new PARAM<int>( "excellon_defaults.mm_integer_len",
79
80 m_params.emplace_back( new PARAM<int>( "excellon_defaults.mm_mantissa_len",
82
83 m_params.emplace_back( new PARAM<int>( "excellon_defaults.inch_integer_len",
85
86 m_params.emplace_back( new PARAM<int>( "excellon_defaults.inch_mantissa_len",
88}
89
90
91bool GERBVIEW_SETTINGS::MigrateFromLegacy( wxConfigBase* aCfg )
92{
93 bool ret = APP_SETTINGS_BASE::MigrateFromLegacy( aCfg );
94
95 ret &= fromLegacy<bool>( aCfg,
96 "ShowBorderAndTitleBlock", "appearance.show_border_and_titleblock" );
97
98 ret &= fromLegacy<bool>( aCfg, "ShowDCodesOpt", "appearance.show_dcodes" );
99 ret &= fromLegacy<bool>( aCfg, "ShowNegativeObjectsOpt", "appearance.show_negative_objects" );
100 ret &= fromLegacyString( aCfg, "PageSizeOpt", "appearance.page_type" );
101
102 auto migrate_files = [&] ( const std::string& aPath, const std::string& aDest )
103 {
104 int max_history_size = Pgm().GetCommonSettings()->m_System.file_history_size;
105 wxString file, key;
106 nlohmann::json js = nlohmann::json::array();
107
108 aCfg->SetPath( aPath );
109
110 for( int i = 0; i < max_history_size; i++ )
111 {
112 key.Printf( wxT( "file%d" ), i );
113 file = aCfg->Read( key, wxEmptyString );
114
115 if( !file.IsEmpty() )
116 js.emplace_back( file.ToStdString() );
117 }
118
119 aCfg->SetPath( wxT( ".." ) );
120
121 Set( aDest, js );
122 };
123
124 migrate_files( "drl_files", "system.drill_file_history" );
125 migrate_files( "zip_files", "system.zip_file_history" );
126 migrate_files( "job_files", "system.job_file_history" );
127
128 {
129 wxString key;
130 int value = 0;
131
132 Set( "gerber_to_pcb_layers", nlohmann::json::array() );
133
134 for( int i = 0; i < GERBER_DRAWLAYERS_COUNT; i++ )
135 {
136 key.Printf( wxT( "GbrLyr%dToPcb" ), i );
137 aCfg->Read( key, &value, UNSELECTED_LAYER );
138 At( "gerber_to_pcb_layers" ).emplace_back( value );
139 }
140 }
141
142 COLOR_SETTINGS* cs = Pgm().GetSettingsManager().GetMigratedColorSettings();
143
144 auto migrateLegacyColor = [&] ( const std::string& aKey, int aLayerId ) {
145 wxString str;
146
147 if( aCfg->Read( aKey, &str ) )
148 cs->SetColor( aLayerId, COLOR4D( str ) );
149 };
150
151 migrateLegacyColor( "BackgroundColorEx", LAYER_GERBVIEW_BACKGROUND );
152 migrateLegacyColor( "DCodeColorEx", LAYER_DCODES );
153 migrateLegacyColor( "GridColorEx", LAYER_GERBVIEW_GRID );
154 migrateLegacyColor( "NegativeObjectsColorEx", LAYER_NEGATIVE_OBJECTS );
155 migrateLegacyColor( "WorksheetColorEx", LAYER_GERBVIEW_DRAWINGSHEET );
156 migrateLegacyColor( "GridColorEx", LAYER_GERBVIEW_PAGE_LIMITS );
157
158 wxString key;
159
160 for( int i = 0, id = GERBVIEW_LAYER_ID_START;
162 {
163 key.Printf( wxT( "ColorLayer%dEx" ), i );
164 migrateLegacyColor( key.ToStdString(), id );
165 }
166
167 Pgm().GetSettingsManager().SaveColorSettings( cs, "gerbview" );
168
169 Set( "appearance.color_theme", cs->GetFilename() );
170
171 return ret;
172}
APP_SETTINGS_BASE is a settings class that should be derived for each standalone KiCad application.
Definition: app_settings.h:101
virtual bool MigrateFromLegacy(wxConfigBase *aCfg) override
Migrates from wxConfig to JSON-based configuration.
Color settings are a bit different than most of the settings objects in that there can be more than o...
void SetColor(int aLayer, const COLOR4D &aColor)
std::vector< wxString > m_JobFileHistory
std::vector< wxString > m_DrillFileHistory
EXCELLON_DEFAULTS m_ExcellonDefaults
std::vector< int > m_GerberToPcbLayerMapping
A list of GERBER_DRAWLAYERS_COUNT length containing a mapping of gerber layers to PCB layers,...
std::vector< wxString > m_ZipFileHistory
virtual bool MigrateFromLegacy(wxConfigBase *aLegacyConfig) override
Migrates from wxConfig to JSON-based configuration.
bool fromLegacyString(wxConfigBase *aConfig, const std::string &aKey, const std::string &aDest)
Translates a legacy wxConfig string value to a given JSON pointer value.
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)
nlohmann::json & At(const std::string &aPath)
Wrappers for the underlying JSON API so that most consumers don't need json.hpp All of these function...
void Set(const std::string &aPath, ValueType aVal)
Stores a value into the JSON document Will throw an exception if ValueType isn't something that the l...
wxString GetFilename() const
Definition: json_settings.h:73
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:104
#define FMT_MANTISSA_INCH
#define FMT_INTEGER_MM
#define FMT_MANTISSA_MM
#define FMT_INTEGER_INCH
nlohmann::json json
Definition: gerbview.cpp:44
const int gerbviewSchemaVersion
! Update the schema version whenever a migration is required
@ LAYER_GERBVIEW_DRAWINGSHEET
Definition: layer_ids.h:417
@ GERBVIEW_LAYER_ID_START
Definition: layer_ids.h:407
@ LAYER_GERBVIEW_BACKGROUND
Definition: layer_ids.h:416
@ LAYER_DCODES
Definition: layer_ids.h:412
@ LAYER_NEGATIVE_OBJECTS
Definition: layer_ids.h:413
@ LAYER_GERBVIEW_PAGE_LIMITS
Definition: layer_ids.h:418
@ LAYER_GERBVIEW_GRID
Definition: layer_ids.h:414
@ UNSELECTED_LAYER
Definition: layer_ids.h:61
#define GERBER_DRAWLAYERS_COUNT
Definition: layer_ids.h:402
see class PGM_BASE
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:111