KiCad PCB EDA Suite
advanced_config.cpp File Reference
#include <advanced_config.h>
#include <common.h>
#include <config_params.h>
#include <settings/settings_manager.h>
#include <wx/config.h>
#include <wx/filename.h>
#include <wx/log.h>

Go to the source code of this file.

Namespaces

 AC_STACK
 Limits and default settings for the coroutine stack size allowed.
 
 AC_KEYS
 List of known keys for advanced configuration options.
 

Functions

wxString dumpParamCfg (const PARAM_CFG &aParam)
 
static void dumpCfg (const std::vector< PARAM_CFG * > &aArray)
 Dump the configs in the given array to trace. More...
 
static wxFileName getAdvancedCfgFilename ()
 Get the filename for the advanced config file. More...
 

Variables

static const wxChar AdvancedConfigMask [] = wxT( "KICAD_ADVANCED_CONFIG" )
 
static constexpr int AC_STACK::min_stack = 32 * 4096
 
static constexpr int AC_STACK::default_stack = 256 * 4096
 
static constexpr int AC_STACK::max_stack = 4096 * 4096
 
static const wxChar AC_KEYS::ExtraFillMargin [] = wxT( "ExtraFillMargin" )
 When filling zones, we add an extra amount of clearance to each zone to ensure that rounding errors do not overrun minimum clearance distances. More...
 
static const wxChar AC_KEYS::RealtimeConnectivity [] = wxT( "RealtimeConnectivity" )
 Testing mode for new connectivity algorithm. More...
 
static const wxChar AC_KEYS::CoroutineStackSize [] = wxT( "CoroutineStackSize" )
 Configure the coroutine stack size in bytes. More...
 
static const wxChar AC_KEYS::ShowRouterDebugGraphics [] = wxT( "ShowRouterDebugGraphics" )
 Show PNS router debug graphics while routing. More...
 
static const wxChar AC_KEYS::CompactFileSave [] = wxT( "CompactSave" )
 When set to true, this will wrap polygon point sets at 4 points per line rather than a single point per line. More...
 

Function Documentation

◆ dumpCfg()

static void dumpCfg ( const std::vector< PARAM_CFG * > &  aArray)
static

Dump the configs in the given array to trace.

Definition at line 140 of file advanced_config.cpp.

141 {
142  // only dump if we need to
143  if( !wxLog::IsAllowedTraceMask( AdvancedConfigMask ) )
144  return;
145 
146  for( const PARAM_CFG* param : aArray )
147  {
148  wxLogTrace( AdvancedConfigMask, dumpParamCfg( *param ) );
149  }
150 }
wxString dumpParamCfg(const PARAM_CFG &aParam)
PARAM_CFG is a base class which establishes the interface functions ReadParam and SaveParam,...
Definition: config_params.h:81
static const wxChar AdvancedConfigMask[]

References AdvancedConfigMask, and dumpParamCfg().

Referenced by ADVANCED_CFG::loadSettings().

◆ dumpParamCfg()

wxString dumpParamCfg ( const PARAM_CFG aParam)

Definition at line 103 of file advanced_config.cpp.

104 {
105  wxString s = aParam.m_Ident + ": ";
106 
107  /*
108  * This implementation is rather simplistic, but it is
109  * effective enough for simple uses. A better implementation would be
110  * some kind of visitor, but that's somewhat more work.
111  */
112  switch( aParam.m_Type )
113  {
116  s << *static_cast<const PARAM_CFG_INT&>( aParam ).m_Pt_param;
117  break;
119  s << *static_cast<const PARAM_CFG_DOUBLE&>( aParam ).m_Pt_param;
120  break;
122  s << *static_cast<const PARAM_CFG_WXSTRING&>( aParam ).m_Pt_param;
123  break;
125  s << *static_cast<const PARAM_CFG_FILENAME&>( aParam ).m_Pt_param;
126  break;
128  s << ( *static_cast<const PARAM_CFG_BOOL&>( aParam ).m_Pt_param ? "true" : "false" );
129  break;
130  default: s << "Unsupported PARAM_CFG variant: " << aParam.m_Type;
131  }
132 
133  return s;
134 }
wxString m_Ident
Keyword in config data.
Definition: config_params.h:84
paramcfg_id m_Type
Type of parameter.
Definition: config_params.h:85

References PARAM_CFG::m_Ident, PARAM_CFG::m_Type, PARAM_BOOL, PARAM_DOUBLE, PARAM_FILENAME, PARAM_INT, PARAM_INT_WITH_SCALE, and PARAM_WXSTRING.

Referenced by dumpCfg().

◆ getAdvancedCfgFilename()

static wxFileName getAdvancedCfgFilename ( )
static

Get the filename for the advanced config file.

The user must check the file exists if they care.

Definition at line 158 of file advanced_config.cpp.

159 {
160  const static wxString cfg_filename{ "kicad_advanced" };
161  return wxFileName( SETTINGS_MANAGER::GetUserSettingsPath(), cfg_filename );
162 }
static wxString GetUserSettingsPath()
Return the user configuration path used to store KiCad's configuration files.

References SETTINGS_MANAGER::GetUserSettingsPath().

Referenced by ADVANCED_CFG::loadFromConfigFile().

Variable Documentation

◆ AdvancedConfigMask

const wxChar AdvancedConfigMask[] = wxT( "KICAD_ADVANCED_CONFIG" )
static