KiCad PCB EDA Suite
Loading...
Searching...
No Matches
advanced_config.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 The 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 <advanced_config.h>
25#include <trace_helpers.h>
26#include <config_params.h>
27#include <paths.h>
28
29#include <wx/app.h>
30#include <wx/config.h>
31#include <wx/filename.h>
32#include <wx/log.h>
33#include <wx/tokenzr.h>
34
35/*
36 * Flag to enable advanced config debugging
37 *
38 * Use "KICAD_ADVANCED_CONFIG" to enable.
39 *
40 * @ingroup trace_env_vars
41 */
42static const wxChar AdvancedConfigMask[] = wxT( "KICAD_ADVANCED_CONFIG" );
43
49namespace AC_STACK
50{
51static constexpr int min_stack = 32 * 4096;
52static constexpr int default_stack = 256 * 4096;
53static constexpr int max_stack = 4096 * 4096;
54} // namespace AC_STACK
55
61namespace AC_KEYS
62{
63
64static const wxChar IncrementalConnectivity[] = wxT( "IncrementalConnectivity" );
65static const wxChar Use3DConnexionDriver[] = wxT( "3DConnexionDriver" );
66static const wxChar ExtraFillMargin[] = wxT( "ExtraFillMargin" );
67static const wxChar EnableCreepageSlot[] = wxT( "EnableCreepageSlot" );
68static const wxChar DRCEpsilon[] = wxT( "DRCEpsilon" );
69static const wxChar DRCSliverWidthTolerance[] = wxT( "DRCSliverWidthTolerance" );
70static const wxChar DRCSliverMinimumLength[] = wxT( "DRCSliverMinimumLength" );
71static const wxChar DRCSliverAngleTolerance[] = wxT( "DRCSliverAngleTolerance" );
72static const wxChar HoleWallThickness[] = wxT( "HoleWallPlatingThickness" );
73static const wxChar CoroutineStackSize[] = wxT( "CoroutineStackSize" );
74static const wxChar ShowRouterDebugGraphics[] = wxT( "ShowRouterDebugGraphics" );
75static const wxChar EnableRouterDump[] = wxT( "EnableRouterDump" );
76static const wxChar HyperZoom[] = wxT( "HyperZoom" );
77static const wxChar CompactFileSave[] = wxT( "CompactSave" );
78static const wxChar DrawArcAccuracy[] = wxT( "DrawArcAccuracy" );
79static const wxChar DrawArcCenterStartEndMaxAngle[] = wxT( "DrawArcCenterStartEndMaxAngle" );
80static const wxChar MaxTangentTrackAngleDeviation[] = wxT( "MaxTangentTrackAngleDeviation" );
81static const wxChar MaxTrackLengthToKeep[] = wxT( "MaxTrackLengthToKeep" );
82static const wxChar StrokeTriangulation[] = wxT( "StrokeTriangulation" );
83static const wxChar ExtraZoneDisplayModes[] = wxT( "ExtraZoneDisplayModes" );
84static const wxChar MinPlotPenWidth[] = wxT( "MinPlotPenWidth" );
85static const wxChar DebugZoneFiller[] = wxT( "DebugZoneFiller" );
86static const wxChar DebugPDFWriter[] = wxT( "DebugPDFWriter" );
87static const wxChar PDFStrokeFontWidthFactor[] = wxT( "PDFStrokeFontWidthFactor" );
88static const wxChar PDFStrokeFontXOffset[] = wxT( "PDFStrokeFontXOffset" );
89static const wxChar PDFStrokeFontYOffset[] = wxT( "PDFStrokeFontYOffset" );
90static const wxChar PDFStrokeFontBoldMultiplier[] = wxT( "PDFStrokeFontBoldMultiplier" );
91static const wxChar PDFStrokeFontKerningFactor[] = wxT( "PDFStrokeFontKerningFactor" );
92static const wxChar UsePdfPrint[] = wxT( "UsePdfPrint" );
93static const wxChar SmallDrillMarkSize[] = wxT( "SmallDrillMarkSize" );
94static const wxChar HotkeysDumper[] = wxT( "HotkeysDumper" );
95static const wxChar DrawBoundingBoxes[] = wxT( "DrawBoundingBoxes" );
96static const wxChar ShowPcbnewExportNetlist[] = wxT( "ShowPcbnewExportNetlist" );
97static const wxChar Skip3DModelFileCache[] = wxT( "Skip3DModelFileCache" );
98static const wxChar Skip3DModelMemoryCache[] = wxT( "Skip3DModelMemoryCache" );
99static const wxChar HideVersionFromTitle[] = wxT( "HideVersionFromTitle" );
100static const wxChar TraceMasks[] = wxT( "TraceMasks" );
101static const wxChar ShowEventCounters[] = wxT( "ShowEventCounters" );
102static const wxChar AllowManualCanvasScale[] = wxT( "AllowManualCanvasScale" );
103static const wxChar UpdateUIEventInterval[] = wxT( "UpdateUIEventInterval" );
104static const wxChar V3DRT_BevelHeight_um[] = wxT( "V3DRT_BevelHeight_um" );
105static const wxChar V3DRT_BevelExtentFactor[] = wxT( "V3DRT_BevelExtentFactor" );
106static const wxChar EnablePcbDesignBlocks[] = wxT( "EnablePcbDesignBlocks" );
107static const wxChar EnableGenerators[] = wxT( "EnableGenerators" );
108static const wxChar EnableDrcRuleEditor[] = wxT( "EnableDrcRuleEditor" );
109static const wxChar EnableLibWithText[] = wxT( "EnableLibWithText" );
110static const wxChar EnableLibDir[] = wxT( "EnableLibDir" );
111static const wxChar DisambiguationTime[] = wxT( "DisambiguationTime" );
112static const wxChar PcbSelectionVisibilityRatio[] = wxT( "PcbSelectionVisibilityRatio" );
113static const wxChar FontErrorSize[] = wxT( "FontErrorSize" );
114static const wxChar OcePluginLinearDeflection[] = wxT( "OcePluginLinearDeflection" );
115static const wxChar OcePluginAngularDeflection[] = wxT( "OcePluginAngularDeflection" );
116static const wxChar TriangulateSimplificationLevel[] = wxT( "TriangulateSimplificationLevel" );
117static const wxChar TriangulateMinimumArea[] = wxT( "TriangulateMinimumArea" );
118static const wxChar EnableCacheFriendlyFracture[] = wxT( "EnableCacheFriendlyFracture" );
119static const wxChar EnableAPILogging[] = wxT( "EnableAPILogging" );
120static const wxChar MaxFileSystemWatchers[] = wxT( "MaxFileSystemWatchers" );
121static const wxChar MinorSchematicGraphSize[] = wxT( "MinorSchematicGraphSize" );
122static const wxChar ResolveTextRecursionDepth[] = wxT( "ResolveTextRecursionDepth" );
123static const wxChar EnableExtensionSnaps[] = wxT( "EnableExtensionSnaps" );
124static const wxChar ExtensionSnapTimeoutMs[] = wxT( "ExtensionSnapTimeoutMs" );
125static const wxChar ExtensionSnapActivateOnHover[] = wxT( "ExtensionSnapActivateOnHover" );
126static const wxChar EnableSnapAnchorsDebug[] = wxT( "EnableSnapAnchorsDebug" );
127static const wxChar SnapHysteresis[] = wxT( "SnapHysteresis" );
128static const wxChar SnapToAnchorMargin[] = wxT( "SnapToAnchorMargin" );
129static const wxChar MinParallelAngle[] = wxT( "MinParallelAngle" );
130static const wxChar HoleWallPaintingMultiplier[] = wxT( "HoleWallPaintingMultiplier" );
131static const wxChar MsgPanelShowUuids[] = wxT( "MsgPanelShowUuids" );
132static const wxChar MaximumThreads[] = wxT( "MaximumThreads" );
134 wxT( "NetInspectorBulkUpdateOptimisationThreshold" );
135static const wxChar ExcludeFromSimulationLineWidth[] = wxT( "ExcludeFromSimulationLineWidth" );
136static const wxChar SimulatorMultiRunCombinationLimit[] = wxT( "SimulatorMultiRunCombinationLimit" );
137static const wxChar GitIconRefreshInterval[] = wxT( "GitIconRefreshInterval" );
138static const wxChar MaxPastedTextLength[] = wxT( "MaxPastedTextLength" );
139static const wxChar PNSProcessClusterTimeout[] = wxT( "PNSProcessClusterTimeout" );
140static const wxChar FollowBranchTimeout[] = wxT( "FollowBranchTimeoutMs" );
141static const wxChar ImportSkipComponentBodies[] = wxT( "ImportSkipComponentBodies" );
142static const wxChar ScreenDPI[] = wxT( "ScreenDPI" );
143static const wxChar EnableUseAuiPerspective[] = wxT( "EnableUseAuiPerspective" );
144static const wxChar HistoryLockStaleTimeout[] = wxT( "HistoryLockStaleTimeout" );
145static const wxChar ZoneFillIterativeRefill[] = wxT( "ZoneFillIterativeRefill" );
146static const wxChar PadsPcbTextHeightScale[] = wxT( "PadsPcbTextHeightScale" );
147static const wxChar PadsPcbTextWidthScale[] = wxT( "PadsPcbTextWidthScale" );
148static const wxChar PadsSchTextHeightScale[] = wxT( "PadsSchTextHeightScale" );
149static const wxChar PadsSchTextWidthScale[] = wxT( "PadsSchTextWidthScale" );
150static const wxChar PadsTextAnchorOffsetNm[] = wxT( "PadsTextAnchorOffsetNm" );
151static const wxChar PcbImportMinObjectSizeNm[] = wxT( "PcbImportMinObjectSizeNm" );
152
153} // namespace AC_KEYS
154
155
160namespace AC_GROUPS
161{
162static const wxChar V3D_RayTracing[] = wxT( "G_3DV_RayTracing" );
163}
164
165/*
166 * Get a simple string for common parameters.
167 *
168 * This isn't exhaustive, but it covers most common types that might be
169 * used in the advance config
170 */
171wxString dumpParamCfg( const PARAM_CFG& aParam )
172{
173 wxString s = aParam.m_Ident + wxS( ": " );
174
175 /*
176 * This implementation is rather simplistic, but it is
177 * effective enough for simple uses. A better implementation would be
178 * some kind of visitor, but that's somewhat more work.
179 */
180 switch( aParam.m_Type )
181 {
183 case paramcfg_id::PARAM_INT_WITH_SCALE: s << *static_cast<const PARAM_CFG_INT&>( aParam ).m_Pt_param; break;
184 case paramcfg_id::PARAM_DOUBLE: s << *static_cast<const PARAM_CFG_DOUBLE&>( aParam ).m_Pt_param; break;
185 case paramcfg_id::PARAM_WXSTRING: s << *static_cast<const PARAM_CFG_WXSTRING&>( aParam ).m_Pt_param; break;
186 case paramcfg_id::PARAM_FILENAME: s << *static_cast<const PARAM_CFG_FILENAME&>( aParam ).m_Pt_param; break;
188 s << ( *static_cast<const PARAM_CFG_BOOL&>( aParam ).m_Pt_param ? wxS( "true" ) : wxS( "false" ) );
189 break;
190 default: s << wxS( "Unsupported PARAM_CFG variant: " ) << aParam.m_Type;
191 }
192
193 return s;
194}
195
196
200static void dumpCfg( const std::vector<std::unique_ptr<PARAM_CFG>>& aArray )
201{
202 // only dump if we need to
203 if( !wxLog::IsAllowedTraceMask( AdvancedConfigMask ) )
204 return;
205
206 for( const auto& param : aArray )
207 {
208 wxLogTrace( AdvancedConfigMask, dumpParamCfg( *param ) );
209 }
210}
211
212
218static wxFileName getAdvancedCfgFilename()
219{
220 const static wxString cfg_filename{ wxS( "kicad_advanced" ) };
221 return wxFileName( PATHS::GetUserSettingsPath(), cfg_filename );
222}
223
224
226{
227 wxLogTrace( AdvancedConfigMask, wxS( "Init advanced config" ) );
228
229 // Init defaults - this is done in case the config doesn't exist,
230 // then the values will remain as set here.
233 m_EnableRouterDump = false;
234 m_HyperZoom = false;
235 m_DrawArcAccuracy = 10.0;
238 m_MaxTrackLengthToKeep = 0.0005;
241
242 m_ExtraClearance = 0.0005;
243 m_EnableCreepageSlot = false;
244 m_DRCEpsilon = 0.0005; // 0.5um is small enough not to materially violate
245 // any constraints.
247 m_SliverMinimumLength = 0.0008;
249
250 m_HoleWallThickness = 0.020; // IPC-6012 says 15-18um; Cadence says at least
251 // 0.020 for a Class 2 board and at least 0.025
252 // for Class 3.
253
254 m_MinPlotPenWidth = 0.0212; // 1 pixel at 1200dpi.
255
256 m_DebugZoneFiller = false;
257 m_DebugPDFWriter = false;
258 m_PDFStrokeFontWidthFactor = .12; // default 12% of EM
263 m_UsePdfPrint = false;
265 m_HotkeysDumper = false;
266 m_DrawBoundingBoxes = false;
272 m_ShowEventCounters = false;
274 m_CompactSave = false;
277 m_EnableGenerators = false;
278 m_EnableDrcRuleEditor = false;
279 m_EnableLibWithText = false;
280 m_EnableLibDir = false;
281
283 m_3DRT_BevelExtentFactor = 1.0 / 16.0;
284
285 m_EnableAPILogging = false;
286
288
290
292
294
295 m_FontErrorSize = 2;
296
299
302
304
306
308
310
317
318 m_MinParallelAngle = 0.001;
320
322
324
327
329
331
332 m_PNSProcessClusterTimeout = 100; // Default: 100 ms
333 m_FollowBranchTimeout = 500; // Default: 500 ms
334
336
337 m_ScreenDPI = 91;
338
340 m_HistoryLockStaleTimeout = 300; // 5 minutes default
342
349
351}
352
353
355{
356 static ADVANCED_CFG instance;
357 return instance;
358}
359
360
365
366
368{
369 wxFileName k_advanced = getAdvancedCfgFilename();
370 wxFileConfig file_cfg( wxS( "" ), wxS( "" ), k_advanced.GetFullPath() );
371
372 wxConfigSaveSetups( &file_cfg, m_entries );
373}
374
375
377{
378 const wxFileName k_advanced = getAdvancedCfgFilename();
379
380 // If we are running headless, use the class defaults because we cannot instantiate wxConfig
381 if( !wxTheApp )
382 return;
383
384 if( !k_advanced.FileExists() )
385 {
386 wxLogTrace( AdvancedConfigMask, wxS( "File does not exist %s" ), k_advanced.GetFullPath() );
387
388 // load the defaults
389 wxConfig emptyConfig;
390 loadSettings( emptyConfig );
391
392 return;
393 }
394
395 wxLogTrace( AdvancedConfigMask, wxS( "Loading advanced config from: %s" ), k_advanced.GetFullPath() );
396
397 wxFileConfig file_cfg( wxS( "" ), wxS( "" ), k_advanced.GetFullPath() );
398 loadSettings( file_cfg );
399}
400
401
402void ADVANCED_CFG::loadSettings( wxConfigBase& aCfg )
403{
404 m_entries.clear();
405
406 m_entries.push_back( std::make_unique<PARAM_CFG_DOUBLE>( true, AC_KEYS::ExtraFillMargin, &m_ExtraClearance,
407 m_ExtraClearance, 0.0, 1.0 ) );
408
409 m_entries.push_back( std::make_unique<PARAM_CFG_BOOL>( true, AC_KEYS::EnableCreepageSlot, &m_EnableCreepageSlot,
411
412 m_entries.push_back(
413 std::make_unique<PARAM_CFG_DOUBLE>( true, AC_KEYS::DRCEpsilon, &m_DRCEpsilon, m_DRCEpsilon, 0.0, 1.0 ) );
414
415 m_entries.push_back( std::make_unique<PARAM_CFG_DOUBLE>(
417
418 m_entries.push_back( std::make_unique<PARAM_CFG_DOUBLE>(
420
421 m_entries.push_back( std::make_unique<PARAM_CFG_DOUBLE>(
423
424 m_entries.push_back( std::make_unique<PARAM_CFG_DOUBLE>( true, AC_KEYS::HoleWallThickness, &m_HoleWallThickness,
425 m_HoleWallThickness, 0.0, 1.0 ) );
426
427 m_entries.push_back( std::make_unique<PARAM_CFG_INT>( true, AC_KEYS::CoroutineStackSize, &m_CoroutineStackSize,
430
431 m_entries.push_back( std::make_unique<PARAM_CFG_INT>(
433
434 m_entries.push_back( std::make_unique<PARAM_CFG_BOOL>( true, AC_KEYS::ShowRouterDebugGraphics,
436
437 m_entries.push_back( std::make_unique<PARAM_CFG_BOOL>( true, AC_KEYS::EnableRouterDump, &m_EnableRouterDump,
439
440 m_entries.push_back( std::make_unique<PARAM_CFG_BOOL>( true, AC_KEYS::HyperZoom, &m_HyperZoom, m_HyperZoom ) );
441
442 m_entries.push_back(
443 std::make_unique<PARAM_CFG_BOOL>( true, AC_KEYS::CompactFileSave, &m_CompactSave, m_CompactSave ) );
444
445 m_entries.push_back( std::make_unique<PARAM_CFG_DOUBLE>( true, AC_KEYS::DrawArcAccuracy, &m_DrawArcAccuracy,
446 m_DrawArcAccuracy, 0.0, 100000.0 ) );
447
448 m_entries.push_back( std::make_unique<PARAM_CFG_DOUBLE>( true, AC_KEYS::DrawArcCenterStartEndMaxAngle,
450 100000.0 ) );
451
452 m_entries.push_back( std::make_unique<PARAM_CFG_DOUBLE>( true, AC_KEYS::MaxTangentTrackAngleDeviation,
454 0.0, 90.0 ) );
455
456 m_entries.push_back( std::make_unique<PARAM_CFG_DOUBLE>(
458
459 m_entries.push_back( std::make_unique<PARAM_CFG_BOOL>( true, AC_KEYS::ExtraZoneDisplayModes,
461
462 m_entries.push_back( std::make_unique<PARAM_CFG_BOOL>(
464
465 m_entries.push_back( std::make_unique<PARAM_CFG_DOUBLE>( true, AC_KEYS::MinPlotPenWidth, &m_MinPlotPenWidth,
466 m_MinPlotPenWidth, 0.0, 1.0 ) );
467
468 m_entries.push_back(
469 std::make_unique<PARAM_CFG_BOOL>( true, AC_KEYS::DebugZoneFiller, &m_DebugZoneFiller, m_DebugZoneFiller ) );
470
471 m_entries.push_back(
472 std::make_unique<PARAM_CFG_BOOL>( true, AC_KEYS::DebugPDFWriter, &m_DebugPDFWriter, m_DebugPDFWriter ) );
473
474 m_entries.push_back( std::make_unique<PARAM_CFG_DOUBLE>(
476
477 m_entries.push_back( std::make_unique<PARAM_CFG_DOUBLE>( true, AC_KEYS::PDFStrokeFontXOffset,
479
480 m_entries.push_back( std::make_unique<PARAM_CFG_DOUBLE>( true, AC_KEYS::PDFStrokeFontYOffset,
482
483 m_entries.push_back( std::make_unique<PARAM_CFG_DOUBLE>( true, AC_KEYS::PDFStrokeFontBoldMultiplier,
486
487 m_entries.push_back( std::make_unique<PARAM_CFG_DOUBLE>(
489
490 m_entries.push_back(
491 std::make_unique<PARAM_CFG_BOOL>( true, AC_KEYS::UsePdfPrint, &m_UsePdfPrint, m_UsePdfPrint ) );
492
493 m_entries.push_back( std::make_unique<PARAM_CFG_DOUBLE>( true, AC_KEYS::SmallDrillMarkSize, &m_SmallDrillMarkSize,
494 m_SmallDrillMarkSize, 0.0, 3.0 ) );
495
496 m_entries.push_back(
497 std::make_unique<PARAM_CFG_BOOL>( true, AC_KEYS::HotkeysDumper, &m_HotkeysDumper, m_HotkeysDumper ) );
498
499 m_entries.push_back( std::make_unique<PARAM_CFG_BOOL>( true, AC_KEYS::DrawBoundingBoxes, &m_DrawBoundingBoxes,
501
502 m_entries.push_back( std::make_unique<PARAM_CFG_BOOL>( true, AC_KEYS::ShowPcbnewExportNetlist,
504
505 m_entries.push_back( std::make_unique<PARAM_CFG_BOOL>( true, AC_KEYS::Skip3DModelFileCache, &m_Skip3DModelFileCache,
507
508 m_entries.push_back( std::make_unique<PARAM_CFG_BOOL>( true, AC_KEYS::Skip3DModelMemoryCache,
510
511 m_entries.push_back( std::make_unique<PARAM_CFG_BOOL>( true, AC_KEYS::HideVersionFromTitle, &m_HideVersionFromTitle,
513
514 m_entries.push_back( std::make_unique<PARAM_CFG_BOOL>( true, AC_KEYS::ShowEventCounters, &m_ShowEventCounters,
516
517 m_entries.push_back( std::make_unique<PARAM_CFG_BOOL>( true, AC_KEYS::AllowManualCanvasScale,
519
520 m_entries.push_back( std::make_unique<PARAM_CFG_INT>( true, AC_KEYS::V3DRT_BevelHeight_um, &m_3DRT_BevelHeight_um,
521 m_3DRT_BevelHeight_um, 0, std::numeric_limits<int>::max(),
523
524 m_entries.push_back( std::make_unique<PARAM_CFG_DOUBLE>( true, AC_KEYS::V3DRT_BevelExtentFactor,
526 100.0, AC_GROUPS::V3D_RayTracing ) );
527
528 m_entries.push_back( std::make_unique<PARAM_CFG_BOOL>( true, AC_KEYS::Use3DConnexionDriver, &m_Use3DConnexionDriver,
530
531 m_entries.push_back( std::make_unique<PARAM_CFG_BOOL>( true, AC_KEYS::IncrementalConnectivity,
533
534 m_entries.push_back( std::make_unique<PARAM_CFG_INT>( true, AC_KEYS::DisambiguationTime, &m_DisambiguationMenuDelay,
535 m_DisambiguationMenuDelay, 50, 10000 ) );
536
537 m_entries.push_back( std::make_unique<PARAM_CFG_BOOL>( true, AC_KEYS::EnablePcbDesignBlocks,
539
540 m_entries.push_back( std::make_unique<PARAM_CFG_BOOL>( true, AC_KEYS::EnableGenerators, &m_EnableGenerators,
542
543 m_entries.push_back( std::make_unique<PARAM_CFG_BOOL>( true, AC_KEYS::EnableDrcRuleEditor, &m_EnableDrcRuleEditor,
545
546 m_entries.push_back( std::make_unique<PARAM_CFG_BOOL>( true, AC_KEYS::EnableAPILogging, &m_EnableAPILogging,
548
549 m_entries.push_back( std::make_unique<PARAM_CFG_BOOL>( true, AC_KEYS::EnableLibWithText, &m_EnableLibWithText,
551
552 m_entries.push_back(
553 std::make_unique<PARAM_CFG_BOOL>( true, AC_KEYS::EnableLibDir, &m_EnableLibDir, m_EnableLibDir ) );
554
555 m_entries.push_back( std::make_unique<PARAM_CFG_DOUBLE>( true, AC_KEYS::PcbSelectionVisibilityRatio,
557 m_PcbSelectionVisibilityRatio, 0.0, 1.0 ) );
558
559 m_entries.push_back( std::make_unique<PARAM_CFG_DOUBLE>( true, AC_KEYS::FontErrorSize, &m_FontErrorSize,
560 m_FontErrorSize, 0.01, 100 ) );
561
562 m_entries.push_back( std::make_unique<PARAM_CFG_DOUBLE>( true, AC_KEYS::OcePluginLinearDeflection,
564 0.01, 1.0 ) );
565
566 m_entries.push_back( std::make_unique<PARAM_CFG_DOUBLE>( true, AC_KEYS::OcePluginAngularDeflection,
568 m_OcePluginAngularDeflection, 0.01, 360.0 ) );
569
570 m_entries.push_back( std::make_unique<PARAM_CFG_INT>( true, AC_KEYS::TriangulateSimplificationLevel,
573
574 m_entries.push_back( std::make_unique<PARAM_CFG_INT>(
576
577 m_entries.push_back( std::make_unique<PARAM_CFG_BOOL>( true, AC_KEYS::EnableCacheFriendlyFracture,
580
581 m_entries.push_back( std::make_unique<PARAM_CFG_INT>(
583
584 m_entries.push_back( std::make_unique<PARAM_CFG_INT>( true, AC_KEYS::MinorSchematicGraphSize,
586 2147483647 ) );
587
588 m_entries.push_back( std::make_unique<PARAM_CFG_INT>( true, AC_KEYS::ResolveTextRecursionDepth,
590 10 ) );
591
592 m_entries.push_back( std::make_unique<PARAM_CFG_BOOL>( true, AC_KEYS::EnableExtensionSnaps, &m_EnableExtensionSnaps,
594
595 m_entries.push_back( std::make_unique<PARAM_CFG_INT>( true, AC_KEYS::ExtensionSnapTimeoutMs,
597
598 m_entries.push_back( std::make_unique<PARAM_CFG_BOOL>( true, AC_KEYS::ExtensionSnapActivateOnHover,
601
602 m_entries.push_back( std::make_unique<PARAM_CFG_BOOL>( true, AC_KEYS::EnableSnapAnchorsDebug,
604
605 m_entries.push_back( std::make_unique<PARAM_CFG_INT>( true, AC_KEYS::SnapHysteresis, &m_SnapHysteresis,
606 m_SnapHysteresis, 0, 100 ) );
607
608 m_entries.push_back( std::make_unique<PARAM_CFG_DOUBLE>( true, AC_KEYS::SnapToAnchorMargin, &m_SnapToAnchorMargin,
609 m_SnapToAnchorMargin, 1.0, 2.0 ) );
610
611 m_entries.push_back( std::make_unique<PARAM_CFG_DOUBLE>( true, AC_KEYS::MinParallelAngle, &m_MinParallelAngle,
612 m_MinParallelAngle, 0.0, 45.0 ) );
613
614 m_entries.push_back( std::make_unique<PARAM_CFG_DOUBLE>( true, AC_KEYS::HoleWallPaintingMultiplier,
616 m_HoleWallPaintingMultiplier, 0.1, 100.0 ) );
617
618 m_entries.push_back( std::make_unique<PARAM_CFG_INT>( true, AC_KEYS::MsgPanelShowUuids, &m_MsgPanelShowUuids,
620
621 m_entries.push_back( std::make_unique<PARAM_CFG_INT>( true, AC_KEYS::MaximumThreads, &m_MaximumThreads,
622 m_MaximumThreads, 0, 500 ) );
623
624 m_entries.push_back( std::make_unique<PARAM_CFG_INT>( true, AC_KEYS::NetInspectorBulkUpdateOptimisationThreshold,
627
628 m_entries.push_back( std::make_unique<PARAM_CFG_INT>( true, AC_KEYS::ExcludeFromSimulationLineWidth,
631
632 m_entries.push_back( std::make_unique<PARAM_CFG_INT>( true, AC_KEYS::SimulatorMultiRunCombinationLimit,
635
636 m_entries.push_back( std::make_unique<PARAM_CFG_INT>( true, AC_KEYS::GitIconRefreshInterval,
638
639 m_entries.push_back( std::make_unique<PARAM_CFG_INT>( true, AC_KEYS::MaxPastedTextLength, &m_MaxPastedTextLength,
640 m_MaxPastedTextLength, 0, 100000 ) );
641
642 m_entries.push_back( std::make_unique<PARAM_CFG_INT>( true, AC_KEYS::PNSProcessClusterTimeout,
643 &m_PNSProcessClusterTimeout, 100, 10, 10000 ) );
644
645 m_entries.push_back( std::make_unique<PARAM_CFG_INT>( true, AC_KEYS::FollowBranchTimeout,
646 &m_FollowBranchTimeout, 500, 50, 5000 ) );
647
648 m_entries.push_back( std::make_unique<PARAM_CFG_BOOL>( true, AC_KEYS::ImportSkipComponentBodies,
650
651 m_entries.push_back( std::make_unique<PARAM_CFG_INT>( true, AC_KEYS::ScreenDPI, &m_ScreenDPI, m_ScreenDPI, 50, 500 ) );
652
653 m_entries.push_back( std::make_unique<PARAM_CFG_BOOL>( true, AC_KEYS::EnableUseAuiPerspective,
655
656 m_entries.push_back( std::make_unique<PARAM_CFG_INT>( true, AC_KEYS::HistoryLockStaleTimeout,
658 86400 ) ); // 10 seconds to 24 hours
659
660 m_entries.push_back( std::make_unique<PARAM_CFG_BOOL>( true, AC_KEYS::ZoneFillIterativeRefill,
662
663 m_entries.push_back( std::make_unique<PARAM_CFG_DOUBLE>( true, AC_KEYS::PadsPcbTextHeightScale,
665 m_PadsPcbTextHeightScale, 0.1, 1.0 ) );
666
667 m_entries.push_back( std::make_unique<PARAM_CFG_DOUBLE>( true, AC_KEYS::PadsPcbTextWidthScale,
669 m_PadsPcbTextWidthScale, 0.1, 1.0 ) );
670
671 m_entries.push_back( std::make_unique<PARAM_CFG_DOUBLE>( true, AC_KEYS::PadsSchTextHeightScale,
673 m_PadsSchTextHeightScale, 0.1, 1.0 ) );
674
675 m_entries.push_back( std::make_unique<PARAM_CFG_DOUBLE>( true, AC_KEYS::PadsSchTextWidthScale,
677 m_PadsSchTextWidthScale, 0.1, 1.0 ) );
678
679 m_entries.push_back( std::make_unique<PARAM_CFG_INT>( true, AC_KEYS::PadsTextAnchorOffsetNm,
681 m_PadsTextAnchorOffsetNm, 0, 1000000 ) );
682
683 m_entries.push_back( std::make_unique<PARAM_CFG_INT>( true, AC_KEYS::PcbImportMinObjectSizeNm,
686 1000000 ) );
687
688 // Special case for trace mask setting...we just grab them and set them immediately
689 // Because we even use wxLogTrace inside of advanced config
690 m_entries.push_back( std::make_unique<PARAM_CFG_WXSTRING>( true, AC_KEYS::TraceMasks, &m_traceMasks, wxS( "" ) ) );
691
692 // Load the config from file
694
695 // Now actually set the trace masks
696 wxStringTokenizer traceMaskTokenizer( m_traceMasks, ", ", wxTOKEN_STRTOK );
697
698 while( traceMaskTokenizer.HasMoreTokens() )
699 {
700 wxString mask = traceMaskTokenizer.GetNextToken();
701 wxLog::AddTraceMask( mask );
702 }
703
705
706 wxLogTrace( kicadTraceCoroutineStack, wxT( "Using coroutine stack size %d" ), m_CoroutineStackSize );
707}
wxString dumpParamCfg(const PARAM_CFG &aParam)
static const wxChar AdvancedConfigMask[]
static void dumpCfg(const std::vector< std::unique_ptr< PARAM_CFG > > &aArray)
Dump the configs in the given array to trace.
static wxFileName getAdvancedCfgFilename()
Get the filename for the advanced config file.
void loadFromConfigFile()
Load the config from the normal configuration file.
void Save()
Save the configuration to the configuration file.
std::vector< std::unique_ptr< PARAM_CFG > > m_entries
void Reload()
Reload the configuration from the configuration file.
void loadSettings(wxConfigBase &aCfg)
Load config from the given configuration base.
static const ADVANCED_CFG & GetCfg()
Get the singleton instance's config, which is shared by all consumers.
A base class which establishes the interface functions ReadParam and SaveParam, which are implemented...
paramcfg_id m_Type
Type of parameter.
wxString m_Ident
Keyword in config data.
static wxString GetUserSettingsPath()
Return the user configuration path used to store KiCad's configuration files.
Definition paths.cpp:624
void wxConfigLoadSetups(wxConfigBase *aCfg, const std::vector< std::unique_ptr< PARAM_CFG > > &aList)
Use aList of PARAM_CFG object to load configuration values from aCfg.
void wxConfigSaveSetups(wxConfigBase *aCfg, const std::vector< std::unique_ptr< PARAM_CFG > > &aList)
Writes aList of PARAM_CFG objects to aCfg.
@ PARAM_WXSTRING
@ PARAM_INT_WITH_SCALE
@ PARAM_INT
@ PARAM_FILENAME
@ PARAM_DOUBLE
@ PARAM_BOOL
bool m_Skip3DModelFileCache
Skip reading/writing 3D model file caches.
bool m_EnableUseAuiPerspective
Enable use Aui Perspective to store/load geometry of main editor frames.
double m_DrawArcCenterMaxAngle
When drawing an arc, the angle ( center - start ) - ( start - end ) can be limited to avoid extremely...
int m_DisambiguationMenuDelay
The number of milliseconds to wait in a click before showing a disambiguation menu.
int m_ScreenDPI
Screen DPI setting for display calculations.
bool m_EnableLibDir
Enable option to open lib file directory.
double m_MaxTangentAngleDeviation
Maximum angle between the tangent line of an arc track and a connected straight track in order to com...
bool m_Use3DConnexionDriver
Use the 3DConnexion Driver.
int m_TriangulateSimplificationLevel
The number of internal units that will be allowed to deflect from the base segment when creating a ne...
bool m_EnableCacheFriendlyFracture
Enable the use of a cache-friendlier and therefore faster version of the polygon fracture algorithm.
double m_PadsSchTextWidthScale
PADS text width scale factor for schematic imports.
bool m_ShowRouterDebugGraphics
Show PNS router debug graphics while routing.
bool m_Skip3DModelMemoryCache
Skip reading/writing 3D model memory caches.
double m_HoleWallPaintingMultiplier
What factor to use when painting via and PTH pad hole walls, so that the painted hole wall can be ove...
bool m_EnableLibWithText
Enable option to load lib files with text editor.
double m_PDFStrokeFontKerningFactor
Kerning (spacing) factor applied to glyph advance (width).
int m_MaximumThreads
Default value for the maximum number of threads to use for parallel processing.
double m_HoleWallThickness
Dimension used to calculate the actual hole size from the finish hole size.
double m_PDFStrokeFontXOffset
Horizontal offset factor applied to stroke font glyph coordinates (in EM units) after to compensate m...
int m_CoroutineStackSize
Configure the coroutine stack size in bytes.
double m_PDFStrokeFontYOffset
Vertical offset factor applied to stroke font glyph coordinates (in EM units) after Y inversion to co...
double m_SmallDrillMarkSize
The diameter of the drill marks on print and plot outputs (in mm) when the "Drill marks" option is se...
wxString m_traceMasks
Trace masks for wxLogTrace, loaded from the config file.
double m_PadsPcbTextWidthScale
PADS text width scale factor for PCB imports.
bool m_EnableGenerators
Enable support for generators.
double m_PadsPcbTextHeightScale
PADS text height scale factor for PCB imports.
bool m_IncrementalConnectivity
Use the new incremental netlister for realtime jobs.
double m_ExtraClearance
When filling zones, we add an extra amount of clearance to each zone to ensure that rounding errors d...
int m_TriangulateMinimumArea
The minimum area of a polygon that can be left over after triangulation and still consider the triang...
bool m_DrawBoundingBoxes
Draw GAL bounding boxes in painters.
bool m_EnableRouterDump
Enable PNS router to dump state information for debug purpose (press 0 while routing)
double m_PDFStrokeFontBoldMultiplier
Multiplier applied to stroke width factor when rendering bold stroke font subsets.
double m_DRCEpsilon
Epsilon for DRC tests.
double m_PDFStrokeFontWidthFactor
Stroke font line width factor relative to EM size for PDF stroke fonts.
int m_PcbImportMinObjectSizeNm
Minimum object size in nanometers for PCB imports.
int m_GitIconRefreshInterval
The interval in milliseconds to refresh the git icons in the project tree.
double m_SliverAngleTolerance
Sliver angle to tolerance for DRC.
bool m_AllowManualCanvasScale
Allow manual scaling of canvas.
double m_SliverWidthTolerance
Sliver width tolerance for DRC.
double m_OcePluginLinearDeflection
OCE (STEP/IGES) 3D Plugin Tesselation Linear Deflection.
bool m_EnablePcbDesignBlocks
Enable the new PCB Design Blocks feature.
double m_MinParallelAngle
Minimum overlapping angle for which an arc is considered to be parallel to its paired arc.
int m_ExcludeFromSimulationLineWidth
The line width in mils for the exclude from simulation outline.
int m_MinorSchematicGraphSize
Set the number of items in a schematic graph for it to be considered "minor".
int m_NetInspectorBulkUpdateOptimisationThreshold
When updating the net inspector, it either recalculates all nets or iterates through items one-by-one...
bool m_ExtraZoneDisplayModes
When true, adds zone-display-modes for stroking the zone fracture boundaries and the zone triangulati...
double m_MinPlotPenWidth
Absolute minimum pen width for plotting.
double m_SliverMinimumLength
Sliver length tolerance for DRC.
double m_MaxTrackLengthToKeep
Maximum track length to keep after doing an arc track resizing operation.
double m_DrawArcAccuracy
Distance from an arc end point and the estimated end point, when rotating from the start point to the...
bool m_HotkeysDumper
Enable the hotkeys dumper feature for generating documentation.
double m_FontErrorSize
Deviation between font's bezier curve ideal and the poligonized curve.
int m_UpdateUIEventInterval
The update interval the wxWidgets sends wxUpdateUIEvents to windows.
int m_PadsTextAnchorOffsetNm
PADS text anchor offset in nanometers for PCB imports.
double m_3DRT_BevelExtentFactor
3D-Viewer raytracing factor applied to Extent.z of the item layer.
double m_OcePluginAngularDeflection
OCE (STEP/IGES) 3D Plugin Tesselation Angular Deflection.
bool m_EnableSnapAnchorsDebug
Enable snap anchors debug visualization.
bool m_ShowPcbnewExportNetlist
Enable exporting board editor netlist to a file for troubleshooting purposes.
int m_ResolveTextRecursionDepth
The number of recursions to resolve text variables.
bool m_ZoneFillIterativeRefill
Enable iterative zone filling to handle isolated islands in higher priority zones.
int m_MaxFilesystemWatchers
Maximum number of filesystem watchers to use.
int m_SnapHysteresis
Hysteresis in pixels used for snap activation and deactivation.
bool m_DebugPDFWriter
A mode that writes PDFs without compression.
int m_SimulatorMultiRunCombinationLimit
Maximum number of tuner combinations simulated when using multi-run mode.
int m_MsgPanelShowUuids
Show UUIDs of items in the message panel.
int m_PNSProcessClusterTimeout
Timeout for the PNS router's processCluster wallclock timeout, in milliseconds.
int m_FollowBranchTimeout
Timeout for the PNS router's followBranch path search, in milliseconds.
bool m_EnableCreepageSlot
Enable the minimum slot width check for creepage.
bool m_EnableAPILogging
Log IPC API requests and responses.
bool m_ShowEventCounters
Shows debugging event counters in various places.
int m_HistoryLockStaleTimeout
Stale lock timeout for local history repository locks, in seconds.
int m_MaxPastedTextLength
Set the maximum number of characters that can be pasted without warning.
bool m_HyperZoom
Slide the zoom steps over for debugging things "up close".
double m_SnapToAnchorMargin
Margin multiplier for preferring anchors over construction line snaps.
double m_PadsSchTextHeightScale
PADS text height scale factor for schematic imports.
bool m_DrawTriangulationOutlines
Enable drawing the triangulation outlines with a visible color.
bool m_ExtensionSnapActivateOnHover
If extension snaps are enabled, 'activate' items on hover, even if not near a snap point.
bool m_EnableDrcRuleEditor
Enable the graphical DRC rule editor.
double m_PcbSelectionVisibilityRatio
Board object selection visibility limit.
int m_3DRT_BevelHeight_um
Set the bevel height of layer items in 3D viewer when ray tracing.
bool m_EnableExtensionSnaps
Enable snap anchors based on item line extensions.
bool m_UsePdfPrint
Use legacy wxWidgets-based printing.
bool m_CompactSave
Save files in compact display mode.
bool m_ImportSkipComponentBodies
Skip importing component bodies when importing some format files, such as Altium.
bool m_HideVersionFromTitle
Hide the build version from the KiCad manager frame title.
int m_ExtensionSnapTimeoutMs
If extension snaps are enabled, this is the timeout in milliseconds before a hovered item gets extens...
bool m_DebugZoneFiller
A mode that dumps the various stages of a F_Cu fill into In1_Cu through In9_Cu.
const wxChar *const kicadTraceCoroutineStack
Flag to enable tracing of the coroutine call stack.
List of known groups for advanced configuration options.
static const wxChar V3D_RayTracing[]
List of known keys for advanced configuration options.
static const wxChar DebugPDFWriter[]
static const wxChar SimulatorMultiRunCombinationLimit[]
static const wxChar HotkeysDumper[]
static const wxChar EnableAPILogging[]
static const wxChar ExtensionSnapActivateOnHover[]
static const wxChar HideVersionFromTitle[]
static const wxChar PNSProcessClusterTimeout[]
static const wxChar AllowManualCanvasScale[]
static const wxChar SnapHysteresis[]
static const wxChar NetInspectorBulkUpdateOptimisationThreshold[]
static const wxChar PadsSchTextWidthScale[]
static const wxChar PadsPcbTextWidthScale[]
static const wxChar MaxTangentTrackAngleDeviation[]
static const wxChar MaxTrackLengthToKeep[]
static const wxChar EnableLibDir[]
static const wxChar ShowPcbnewExportNetlist[]
static const wxChar PcbImportMinObjectSizeNm[]
static const wxChar PDFStrokeFontWidthFactor[]
static const wxChar PadsSchTextHeightScale[]
static const wxChar EnablePcbDesignBlocks[]
static const wxChar EnableLibWithText[]
static const wxChar DrawBoundingBoxes[]
static const wxChar MaxPastedTextLength[]
static const wxChar EnableGenerators[]
static const wxChar MinPlotPenWidth[]
static const wxChar CoroutineStackSize[]
static const wxChar SnapToAnchorMargin[]
static const wxChar HoleWallThickness[]
static const wxChar DRCSliverWidthTolerance[]
static const wxChar DisambiguationTime[]
static const wxChar HyperZoom[]
static const wxChar IncrementalConnectivity[]
static const wxChar MinParallelAngle[]
static const wxChar DebugZoneFiller[]
static const wxChar OcePluginLinearDeflection[]
static const wxChar StrokeTriangulation[]
static const wxChar CompactFileSave[]
static const wxChar EnableExtensionSnaps[]
static const wxChar DRCSliverAngleTolerance[]
static const wxChar UpdateUIEventInterval[]
static const wxChar V3DRT_BevelHeight_um[]
static const wxChar MinorSchematicGraphSize[]
static const wxChar ShowRouterDebugGraphics[]
static const wxChar PadsTextAnchorOffsetNm[]
static const wxChar FontErrorSize[]
static const wxChar DRCEpsilon[]
static const wxChar HistoryLockStaleTimeout[]
static const wxChar EnableSnapAnchorsDebug[]
static const wxChar V3DRT_BevelExtentFactor[]
static const wxChar EnableDrcRuleEditor[]
static const wxChar EnableRouterDump[]
static const wxChar DrawArcAccuracy[]
static const wxChar Skip3DModelMemoryCache[]
static const wxChar TriangulateSimplificationLevel[]
static const wxChar ExtraZoneDisplayModes[]
static const wxChar MaxFileSystemWatchers[]
static const wxChar ExcludeFromSimulationLineWidth[]
static const wxChar Skip3DModelFileCache[]
static const wxChar ImportSkipComponentBodies[]
static const wxChar EnableCacheFriendlyFracture[]
static const wxChar HoleWallPaintingMultiplier[]
static const wxChar ZoneFillIterativeRefill[]
static const wxChar ResolveTextRecursionDepth[]
static const wxChar SmallDrillMarkSize[]
static const wxChar EnableCreepageSlot[]
static const wxChar EnableUseAuiPerspective[]
static const wxChar PDFStrokeFontYOffset[]
static const wxChar DrawArcCenterStartEndMaxAngle[]
static const wxChar ExtraFillMargin[]
static const wxChar PcbSelectionVisibilityRatio[]
static const wxChar TriangulateMinimumArea[]
static const wxChar PDFStrokeFontKerningFactor[]
static const wxChar OcePluginAngularDeflection[]
static const wxChar ExtensionSnapTimeoutMs[]
static const wxChar PadsPcbTextHeightScale[]
static const wxChar DRCSliverMinimumLength[]
static const wxChar ShowEventCounters[]
static const wxChar UsePdfPrint[]
static const wxChar ScreenDPI[]
static const wxChar PDFStrokeFontXOffset[]
static const wxChar PDFStrokeFontBoldMultiplier[]
static const wxChar MaximumThreads[]
static const wxChar FollowBranchTimeout[]
static const wxChar GitIconRefreshInterval[]
static const wxChar TraceMasks[]
static const wxChar Use3DConnexionDriver[]
static const wxChar MsgPanelShowUuids[]
Limits and default settings for the coroutine stack size allowed.
static constexpr int min_stack
static constexpr int max_stack
static constexpr int default_stack
wxLogTrace helper definitions.