Class containing "advanced" configuration options. More...

#include <advanced_config.h>

Static Public Member Functions
static const ADVANCED_CFG &	GetCfg ()
	Get the singleton instance's config, which is shared by all consumers. More...

Public Attributes
double	m_DrawArcAccuracy
	Distance from an arc end point and the estimated end point, when rotating from the start point to the end point. More...

double	m_DrawArcCenterMaxAngle
	When drawing an arc, the angle ( center - start ) - ( start - end ) can be limited to avoid extremely high radii. More...

double	m_ExtraClearance
	Extra fill clearance for zone fills. More...

double	m_DRCEpsilon
	Epsilon for DRC tests. More...

double	m_HoleWallThickness
	Hole wall plating thickness. More...

bool	m_RealTimeConnectivity
	Do real-time connectivity. More...

int	m_CoroutineStackSize
	Set the stack size for coroutines. More...

bool	m_ShowRouterDebugGraphics
	Show PNS router debug graphics. More...

bool	m_CompactSave
	Save files in compact display mode When is is not specified, points are written one per line. More...

bool	m_DrawTriangulationOutlines
	When true, strokes the triangulations with visible color. More...

bool	m_PluginAltiumSch
	When true, enable Altium Schematic import (*.SchDoc) the current implementation is highly incomplete. More...

double	m_MinPlotPenWidth
	Sets an absolute minimum pen width for plotting. More...

bool	m_DebugZoneFiller
	A mode that dumps the various stages of a F_Cu fill into In1_Cu through In9_Cu. More...

bool	m_DebugPDFWriter
	A mode that writes PDFs without compression. More...

bool	m_SkipBoundingBoxOnFpLoad
	Skip bounding box calculation when loading footprints. More...

Private Member Functions
	ADVANCED_CFG ()

void	loadFromConfigFile ()
	Load the config from the normal config file. More...

void	loadSettings (wxConfigBase &aCfg)

Detailed Description

Class containing "advanced" configuration options.

Options set here are for developer or advanced users only. If a general user needs to set one of these for normal KiCad use, either:

They are working around some bug that should be fixed, or
The parameter they are setting is of general interest and should be in the main application config, with UI provided.

Options in this class are, in general, preferable to #defines, as they allow more flexible configuration by developers, and don't hide code from the compiler on other configurations, which can result in broken builds.

Never use advanced configs in an untestable way. If a function depends on advanced config such that you cannot test it without changing the config, "lift" the config to a higher level and make pass it as parameter of the code under test. The tests can pass their own values as needed.

This also applies to code that does not depend on "common" - it cannot use this class, so you must pass configuration in as proper parameters.

Sometimes you can just use values directly, and sometimes helper functions might be provided to allow extra logic (for example when a advanced config applies only on certain platforms).

For more information on what config keys set these parameters in the config files, and why you might want to set them, see AC_KEYS

Definition at line 58 of file advanced_config.h.

Constructor & Destructor Documentation

◆ ADVANCED_CFG()

ADVANCED_CFG::ADVANCED_CFG ( )

private

Definition at line 217 of file advanced_config.cpp.

 {
     wxLogTrace( AdvancedConfigMask, "Init advanced config" );
 
     // Init defaults - this is done in case the config doesn't exist,
     // then the values will remain as set here.
     m_RealTimeConnectivity      = true;
     m_CoroutineStackSize        = AC_STACK::default_stack;
     m_ShowRouterDebugGraphics   = false;
     m_DrawArcAccuracy           = 10.0;
     m_DrawArcCenterMaxAngle     = 50.0;
     m_DrawTriangulationOutlines = false;
     m_PluginAltiumSch           = false;
 
     m_ExtraClearance            = 0.0001;
     m_DRCEpsilon                = 0.0001;   // 0.1um is small enough not to materially violate
                                             // any constraints.
 
     m_HoleWallThickness         = 0.020;    // IPC-6012 says 15-18um; Cadence says at least
                                             // 0.020 for a Class 2 board and at least 0.025
                                             // for Class 3.
 
     m_MinPlotPenWidth           = 0.0212;   // 1 pixel at 1200dpi.
 
     m_DebugZoneFiller           = false;
     m_DebugPDFWriter            = false;
 
     m_SkipBoundingBoxOnFpLoad   = false;
 
     loadFromConfigFile();
 }

References AdvancedConfigMask, AC_STACK::default_stack, loadFromConfigFile(), m_CoroutineStackSize, m_DebugPDFWriter, m_DebugZoneFiller, m_DrawArcAccuracy, m_DrawArcCenterMaxAngle, m_DrawTriangulationOutlines, m_DRCEpsilon, m_ExtraClearance, m_HoleWallThickness, m_MinPlotPenWidth, m_PluginAltiumSch, m_RealTimeConnectivity, m_ShowRouterDebugGraphics, and m_SkipBoundingBoxOnFpLoad.

Member Function Documentation

◆ GetCfg()

const ADVANCED_CFG & ADVANCED_CFG::GetCfg ( )

static

Get the singleton instance's config, which is shared by all consumers.

This configuration is read-only - to set options, users should add the parameters to their config files at ~/.config/kicad/advanced, or the platform equivalent.

Definition at line 250 of file advanced_config.cpp.

 {
     static ADVANCED_CFG instance;
     return instance;
 }

Referenced by SCH_CONNECTION::AppendInfoToMsgPanel(), SCH_EDITOR_CONTROL::AssignNetclass(), ZONE_FILLER::buildCopperItemClearances(), PDF_PLOTTER::closePdfStream(), COROUTINE< int, const TOOL_EVENT & >::COROUTINE(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS(), KIGFX::OPENGL_GAL::drawTriangulatedPolyset(), POINT_EDITOR::editArcEndpointKeepTangent(), POINT_EDITOR::editArcMidKeepEnpoints(), PCB_IO::format(), BOARD_DESIGN_SETTINGS::GetDRCEpsilon(), ZONE::GetFilledPolysUseThickness(), BOARD_DESIGN_SETTINGS::GetHolePlatingThickness(), SCH_EDITOR_CONTROL::HighlightNetCursor(), SCH_EDIT_FRAME::KiwayMailIn(), SCH_EDIT_FRAME::OnImportProject(), SCH_EDIT_FRAME::OnModify(), PCB_PARSER::parseFOOTPRINT_unchecked(), CONNECTION_GRAPH::Recalculate(), SCH_SEXPR_PLUGIN_CACHE::savePolyLine(), KIGFX::SCH_RENDER_SETTINGS::SCH_RENDER_SETTINGS(), PNS_KICAD_IFACE::SetView(), PDF_PLOTTER::startPdfStream(), BUS_UNFOLD_MENU::update(), and ZONE_FILLER::ZONE_FILLER().

◆ loadFromConfigFile()

void ADVANCED_CFG::loadFromConfigFile ( )

private

Load the config from the normal config file.

Definition at line 257 of file advanced_config.cpp.

 {
     const wxFileName k_advanced = getAdvancedCfgFilename();
 
     if( !k_advanced.FileExists() )
     {
         wxLogTrace( AdvancedConfigMask, "File does not exist %s", k_advanced.GetFullPath() );
 
         // load the defaults
         wxConfig emptyConfig;
         loadSettings( emptyConfig );
 
         return;
     }
 
     wxLogTrace( AdvancedConfigMask, "Loading advanced config from: %s", k_advanced.GetFullPath() );
 
     wxFileConfig file_cfg( "", "", k_advanced.GetFullPath() );
     loadSettings( file_cfg );
 }

References AdvancedConfigMask, getAdvancedCfgFilename(), and loadSettings().

Referenced by ADVANCED_CFG().

◆ loadSettings()

void ADVANCED_CFG::loadSettings ( wxConfigBase & aCfg )

private

Definition at line 279 of file advanced_config.cpp.

 {
     std::vector<PARAM_CFG*> configParams;
 
     configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::RealtimeConnectivity,
                                                 &m_RealTimeConnectivity, true ) );
 
     configParams.push_back( new PARAM_CFG_DOUBLE( true, AC_KEYS::ExtraFillMargin,
                                                   &m_ExtraClearance, 0.0005, 0.0, 1.0 ) );
 
     configParams.push_back( new PARAM_CFG_DOUBLE( true, AC_KEYS::DRCEpsilon,
                                                   &m_DRCEpsilon, 0.0005, 0.0, 1.0 ) );
 
     configParams.push_back( new PARAM_CFG_DOUBLE( true, AC_KEYS::HoleWallThickness,
                                                   &m_HoleWallThickness, 0.020, 0.0, 1.0 ) );
 
     configParams.push_back( new PARAM_CFG_INT( true, AC_KEYS::CoroutineStackSize,
                                                &m_CoroutineStackSize, AC_STACK::default_stack,
                                                AC_STACK::min_stack, AC_STACK::max_stack ) );
 
     configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::ShowRouterDebugGraphics,
                                                 &m_ShowRouterDebugGraphics, false ) );
 
     configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::CompactFileSave,
                                                 &m_CompactSave, false ) );
 
     configParams.push_back( new PARAM_CFG_DOUBLE( true, AC_KEYS::DrawArcAccuracy,
                                                   &m_DrawArcAccuracy, 10.0, 0.0, 100000.0 ) );
 
     configParams.push_back( new PARAM_CFG_DOUBLE( true, AC_KEYS::DrawArcCenterStartEndMaxAngle,
                                                   &m_DrawArcCenterMaxAngle, 50.0, 0.0, 100000.0 ) );
 
     configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::StrokeTriangulation,
                                                 &m_DrawTriangulationOutlines, false ) );
 
     configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::PluginAltiumSch,
                                                 &m_PluginAltiumSch, false ) );
 
     configParams.push_back( new PARAM_CFG_DOUBLE( true, AC_KEYS::MinPlotPenWidth,
                                                   &m_MinPlotPenWidth, 0.0212, 0.0, 1.0 ) );
 
     configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::DebugZoneFiller,
                                                 &m_DebugZoneFiller, false ) );
 
     configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::DebugPDFWriter,
                                                 &m_DebugPDFWriter, false ) );
 
     configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::SkipBoundingBoxFpLoad,
                                                 &m_SkipBoundingBoxOnFpLoad, false ) );
 
     wxConfigLoadSetups( &aCfg, configParams );
 
     for( PARAM_CFG* param : configParams )
         delete param;
 
     dumpCfg( configParams );
 }