haskal
/
kicad
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
kicad/common/advanced_config.cpp

512 lines
23 KiB
C++
Raw Normal View History

Run-time config for advanced options This can be used for "advanced" options which are for developers to use for feature-flags and other configuration. Run time config has some advantages over preprocessor defines: * Can be changed without recompilation * Sensitive to XDG_CONFIG_DIR, so flipping configs is easy * Better compiler coverage (less conditionally compiled code means less chance to break a different configuration). Also better analysis coverage. * Type safe config params * Centralised documentation: it's in doxygen, in one place No advanced config should be required by a general users. If a general user does use one of these configs, it's probably because: * There is a bug and one of these configs is a workaround * A config in here is generally useful and should be moved into the relevant application config and given UI. For now, the config is read-only, and is read from the "kicad_advanced" config file in the normal config dir.
2018-12-10 10:56:28 +00:00
/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
Add a "hyperzoom" mode for debugging "up close".
2023-06-20 13:15:56 +00:00
* Copyright (C) 2019-2023 KiCad Developers, see AUTHORS.txt for contributors.
Run-time config for advanced options This can be used for "advanced" options which are for developers to use for feature-flags and other configuration. Run time config has some advantages over preprocessor defines: * Can be changed without recompilation * Sensitive to XDG_CONFIG_DIR, so flipping configs is easy * Better compiler coverage (less conditionally compiled code means less chance to break a different configuration). Also better analysis coverage. * Type safe config params * Centralised documentation: it's in doxygen, in one place No advanced config should be required by a general users. If a general user does use one of these configs, it's probably because: * There is a bug and one of these configs is a workaround * A config in here is generally useful and should be moved into the relevant application config and given UI. For now, the config is read-only, and is read from the "kicad_advanced" config file in the normal config dir.
2018-12-10 10:56:28 +00:00
*
* 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 2
* 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, you may find one here:
* http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
* or you may search the http://www.gnu.org website for the version 2 license,
* or you may write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/
#include <advanced_config.h>
Add coroutine stack size to trace output
2024-02-02 11:00:08 +00:00
#include <trace_helpers.h>
Run-time config for advanced options This can be used for "advanced" options which are for developers to use for feature-flags and other configuration. Run time config has some advantages over preprocessor defines: * Can be changed without recompilation * Sensitive to XDG_CONFIG_DIR, so flipping configs is easy * Better compiler coverage (less conditionally compiled code means less chance to break a different configuration). Also better analysis coverage. * Type safe config params * Centralised documentation: it's in doxygen, in one place No advanced config should be required by a general users. If a general user does use one of these configs, it's probably because: * There is a bug and one of these configs is a workaround * A config in here is generally useful and should be moved into the relevant application config and given UI. For now, the config is read-only, and is read from the "kicad_advanced" config file in the normal config dir.
2018-12-10 10:56:28 +00:00
#include <config_params.h>
Move the settings path to PATHS to allow shifting other classes into kicommon
2023-09-23 23:53:22 +00:00
#include <paths.h>
Run-time config for advanced options This can be used for "advanced" options which are for developers to use for feature-flags and other configuration. Run time config has some advantages over preprocessor defines: * Can be changed without recompilation * Sensitive to XDG_CONFIG_DIR, so flipping configs is easy * Better compiler coverage (less conditionally compiled code means less chance to break a different configuration). Also better analysis coverage. * Type safe config params * Centralised documentation: it's in doxygen, in one place No advanced config should be required by a general users. If a general user does use one of these configs, it's probably because: * There is a bug and one of these configs is a workaround * A config in here is generally useful and should be moved into the relevant application config and given UI. For now, the config is read-only, and is read from the "kicad_advanced" config file in the normal config dir.
2018-12-10 10:56:28 +00:00
Don't use wxApp-dependent functions in headless When running headless, e.g. from Python script, the wxApp has not be instantiated, so we cannot use wxConfig. In this case, we fall back to the class defaults in ADVANCED_CONFIG()
2021-06-03 19:30:31 +00:00
#include <wx/app.h>
Run-time config for advanced options This can be used for "advanced" options which are for developers to use for feature-flags and other configuration. Run time config has some advantages over preprocessor defines: * Can be changed without recompilation * Sensitive to XDG_CONFIG_DIR, so flipping configs is easy * Better compiler coverage (less conditionally compiled code means less chance to break a different configuration). Also better analysis coverage. * Type safe config params * Centralised documentation: it's in doxygen, in one place No advanced config should be required by a general users. If a general user does use one of these configs, it's probably because: * There is a bug and one of these configs is a workaround * A config in here is generally useful and should be moved into the relevant application config and given UI. For now, the config is read-only, and is read from the "kicad_advanced" config file in the normal config dir.
2018-12-10 10:56:28 +00:00
#include <wx/config.h>
#include <wx/filename.h>
#include <wx/log.h>
Add (optional) trace mask setting as advanced config option Maximize laziness! This does not affect the environment variable usage
2021-10-08 01:04:51 +00:00
#include <wx/tokenzr.h>
Run-time config for advanced options This can be used for "advanced" options which are for developers to use for feature-flags and other configuration. Run time config has some advantages over preprocessor defines: * Can be changed without recompilation * Sensitive to XDG_CONFIG_DIR, so flipping configs is easy * Better compiler coverage (less conditionally compiled code means less chance to break a different configuration). Also better analysis coverage. * Type safe config params * Centralised documentation: it's in doxygen, in one place No advanced config should be required by a general users. If a general user does use one of these configs, it's probably because: * There is a bug and one of these configs is a workaround * A config in here is generally useful and should be moved into the relevant application config and given UI. For now, the config is read-only, and is read from the "kicad_advanced" config file in the normal config dir.
2018-12-10 10:56:28 +00:00
/*
* Flag to enable advanced config debugging
*
* Use "KICAD_ADVANCED_CONFIG" to enable.
*
* @ingroup trace_env_vars
*/
static const wxChar AdvancedConfigMask[] = wxT( "KICAD_ADVANCED_CONFIG" );
Make coroutines stack size configurable This allows rapid debugging of the coroutine memory issues. It moves the default stack size to 256 * 4096 = 2^20, which will utilize full pages on all architectures.
2019-08-15 04:25:05 +00:00
/**
* Limits and default settings for the coroutine stack size allowed.
* Warning! Setting the stack size below the default may lead to unexplained crashes
* This configuration setting is intended for developers only.
*/
namespace AC_STACK
{
static constexpr int min_stack = 32 * 4096;
static constexpr int default_stack = 256 * 4096;
static constexpr int max_stack = 4096 * 4096;
}
Run-time config for advanced options This can be used for "advanced" options which are for developers to use for feature-flags and other configuration. Run time config has some advantages over preprocessor defines: * Can be changed without recompilation * Sensitive to XDG_CONFIG_DIR, so flipping configs is easy * Better compiler coverage (less conditionally compiled code means less chance to break a different configuration). Also better analysis coverage. * Type safe config params * Centralised documentation: it's in doxygen, in one place No advanced config should be required by a general users. If a general user does use one of these configs, it's probably because: * There is a bug and one of these configs is a workaround * A config in here is generally useful and should be moved into the relevant application config and given UI. For now, the config is read-only, and is read from the "kicad_advanced" config file in the normal config dir.
2018-12-10 10:56:28 +00:00
/**
* List of known keys for advanced configuration options.
*
Coding policy and Doxygen comment fixes.
2023-12-18 13:32:41 +00:00
* Set these options in the file `kicad_advanced` in the KiCad configuration directory.
Run-time config for advanced options This can be used for "advanced" options which are for developers to use for feature-flags and other configuration. Run time config has some advantages over preprocessor defines: * Can be changed without recompilation * Sensitive to XDG_CONFIG_DIR, so flipping configs is easy * Better compiler coverage (less conditionally compiled code means less chance to break a different configuration). Also better analysis coverage. * Type safe config params * Centralised documentation: it's in doxygen, in one place No advanced config should be required by a general users. If a general user does use one of these configs, it's probably because: * There is a bug and one of these configs is a workaround * A config in here is generally useful and should be moved into the relevant application config and given UI. For now, the config is read-only, and is read from the "kicad_advanced" config file in the normal config dir.
2018-12-10 10:56:28 +00:00
*/
namespace AC_KEYS
{
Change Zone extra clearance magic number to AC Rather than keeping a magic number in the code, we set the default in the advanced config setting and allow users/developers to modify it.
2020-07-26 14:20:24 +00:00
Add ability to update subgraphs based on changeset Previously, almost all connectivity updates were full updates, meaning that the entire connectivity graph would be rebuilt each time a change was made to the schematic. This update modifies the update to only correct the subgraphs that are directly affected by the change. It uses the existing connection graph to find all affected subgraphs as well as connections to the changes based on the visible schematic. These elements are removed from the existing connectivity graph and marked dirty. They then have a new connectivity graph built only around their changes. The resulting graph is merged into the original. Currently, this ability is behind an advanced config flag `IncrementalConnectivity` while testing. Fixes https://gitlab.com/kicad/code/kicad/issues/10846 Fixes https://gitlab.com/kicad/code/kicad/issues/1794
2023-04-08 15:22:34 +00:00
static const wxChar IncrementalConnectivity[] = wxT( "IncrementalConnectivity" );
Move Spacemouse to advanced config The spacemouse driver, particularly on Mac, is extremely unstable and causes crashes even when not being used. This places the interface behind an advanced config flag to ensure that users can affirmatively opt-in to the potential for crashes
2023-04-07 17:08:43 +00:00
static const wxChar Use3DConnexionDriver[] = wxT( "3DConnexionDriver" );
Change Zone extra clearance magic number to AC Rather than keeping a magic number in the code, we set the default in the advanced config setting and allow users/developers to modify it.
2020-07-26 14:20:24 +00:00
static const wxChar ExtraFillMargin[] = wxT( "ExtraFillMargin" );
Consolidate all DRC epsilon/threshold values to a single advancedCfg setting. Fixes https://gitlab.com/kicad/code/kicad/issues/5464
2020-09-02 22:15:30 +00:00
static const wxChar DRCEpsilon[] = wxT( "DRCEpsilon" );
Copper sliver checking. ADDED DRCE_COPPER_SLIVER DRC error. ADDED ADVANCED_CFG DRCSliverWidthTolerance and DRCSliverAngleTolerance. Fixes https://gitlab.com/kicad/code/kicad/issues/2183
2021-08-11 13:01:30 +00:00
static const wxChar DRCSliverWidthTolerance[] = wxT( "DRCSliverWidthTolerance" );
Add an advanced config value for the minimum sliver The hard coded value was too small for certain calculations. Better to have a configurable value that is initially set to our error level to allow for deviations that don't meet the visibility test for spikes. These have become more apparent with Clipper2
2022-12-04 00:02:07 +00:00
static const wxChar DRCSliverMinimumLength[] = wxT( "DRCSliverMinimumLength" );
Copper sliver checking. ADDED DRCE_COPPER_SLIVER DRC error. ADDED ADVANCED_CFG DRCSliverWidthTolerance and DRCSliverAngleTolerance. Fixes https://gitlab.com/kicad/code/kicad/issues/2183
2021-08-11 13:01:30 +00:00
static const wxChar DRCSliverAngleTolerance[] = wxT( "DRCSliverAngleTolerance" );
ADDED holeWallPlatingThickness to AdvancedCfg. Used for zone filling and DRC hole collision testing. Allows us to calculate the actual hole size from the finish hole size. Fixes https://gitlab.com/kicad/code/kicad/issues/5468
2020-09-03 14:58:49 +00:00
static const wxChar HoleWallThickness[] = wxT( "HoleWallPlatingThickness" );
Make coroutines stack size configurable This allows rapid debugging of the coroutine memory issues. It moves the default stack size to 256 * 4096 = 2^20, which will utilize full pages on all architectures.
2019-08-15 04:25:05 +00:00
static const wxChar CoroutineStackSize[] = wxT( "CoroutineStackSize" );
Hide PNS debug graphics behind an AC key Fixes https://gitlab.com/kicad/code/kicad/-/issues/4061
2020-07-03 23:33:36 +00:00
static const wxChar ShowRouterDebugGraphics[] = wxT( "ShowRouterDebugGraphics" );
PNS: add new "EnableRouterDump" kicad_advanced setting
2023-08-07 15:44:33 +00:00
static const wxChar EnableRouterDump[] = wxT( "EnableRouterDump" );
Add a "hyperzoom" mode for debugging "up close".
2023-06-20 13:15:56 +00:00
static const wxChar HyperZoom[] = wxT( "HyperZoom" );
ADDED: polygon newlines every point By default KiCad will now print each polygon point on its own line. This adds to the vertical distance for large polygons but makes revision control much cleaner as single point addition to a polygon does not propagate to a diff over the full polygon. Users/developers who want to save the files using the 4-points per line have the ADVANCED_CONFIG setting 'CompactSave' which will provide the original save method
2020-07-25 21:53:58 +00:00
static const wxChar CompactFileSave[] = wxT( "CompactSave" );
Pcbnew fix arc edition
2020-08-09 23:03:31 +00:00
static const wxChar DrawArcAccuracy[] = wxT( "DrawArcAccuracy" );
static const wxChar DrawArcCenterStartEndMaxAngle[] = wxT( "DrawArcCenterStartEndMaxAngle" );
Less restrictive Arc Track Dragging tool Use the connecting straight tracks even if not exactly parallel - allow an error margin configurable in ADVANCED_CFG (default 1 degree). Also be less strict about end point matching and use the width of the track as the criteria to determine suitability. Finally, delete any short lengths of track at the end of the operation and amend the arc end points to keep connectivity. Fixes https://gitlab.com/kicad/code/kicad/-/issues/7967
2021-03-31 20:13:08 +00:00
static const wxChar MaxTangentTrackAngleDeviation[] = wxT( "MaxTangentTrackAngleDeviation" );
static const wxChar MaxTrackLengthToKeep[] = wxT( "MaxTrackLengthToKeep" );
Adding triangulation viewing to AC This adds a helper routine to visualize the quality of our triangulation. It also renames an excessively long variable name for the arc editor
2020-08-12 13:16:57 +00:00
static const wxChar StrokeTriangulation[] = wxT( "StrokeTriangulation" );
Move zone fracture display mode to AdvancedCfg, and add triangulation. Fixes https://gitlab.com/kicad/code/kicad/issues/8762
2021-07-26 17:56:11 +00:00
static const wxChar ExtraZoneDisplayModes[] = wxT( "ExtraZoneDisplayModes" );
Add a min pin width advanced config for plotting. Fixes https://gitlab.com/kicad/code/kicad/issues/5546
2020-09-08 19:18:50 +00:00
static const wxChar MinPlotPenWidth[] = wxT( "MinPlotPenWidth" );
Move DebugZoneFiller to advanced config. This will hopefully keep it from accidentally getting checked in again.
2020-09-23 09:35:13 +00:00
static const wxChar DebugZoneFiller[] = wxT( "DebugZoneFiller" );
Add PDFWriter debug mode (ie: uncompressed output). Fixes https://gitlab.com/kicad/code/kicad/issues/5593
2020-11-06 10:32:14 +00:00
static const wxChar DebugPDFWriter[] = wxT( "DebugPDFWriter" );
Make small drill marks size configurable via advanced config for both printing and plotting Fixes https://gitlab.com/kicad/code/kicad/-/issues/1972
2021-01-04 22:26:23 +00:00
static const wxChar SmallDrillMarkSize[] = wxT( "SmallDrillMarkSize" );
Add a helper to generate action documentation
2021-02-20 18:41:42 +00:00
static const wxChar HotkeysDumper[] = wxT( "HotkeysDumper" );
Tighten up schematic label bounding boxes Margins were being added in more places than necessary Fixes https://gitlab.com/kicad/code/kicad/-/issues/7689
2021-02-24 22:14:39 +00:00
static const wxChar DrawBoundingBoxes[] = wxT( "DrawBoundingBoxes" );
Pcbnew: add write board netlist to file support. This is hidden behind an advanced configuration setting and is primarily useful for developers trying to troubleshoot the netlist payload sent from the board editor to the schematic editor. Fixes https://gitlab.com/kicad/code/kicad/issues/8051
2021-03-28 12:37:54 +00:00
static const wxChar ShowPcbnewExportNetlist[] = wxT( "ShowPcbnewExportNetlist" );
Add advanced cfg to force reloading memory cached 3d models
2021-07-11 04:35:38 +00:00
static const wxChar Skip3DModelFileCache[] = wxT( "Skip3DModelFileCache" );
static const wxChar Skip3DModelMemoryCache[] = wxT( "Skip3DModelMemoryCache" );
Allow hiding version from manager title bar with advanced config
2021-07-14 22:24:21 +00:00
static const wxChar HideVersionFromTitle[] = wxT( "HideVersionFromTitle" );
Add (optional) trace mask setting as advanced config option Maximize laziness! This does not affect the environment variable usage
2021-10-08 01:04:51 +00:00
static const wxChar TraceMasks[] = wxT( "TraceMasks" );
Put Repair Schematic behind Advanced Config.
2021-11-25 12:16:42 +00:00
static const wxChar ShowRepairSchematic[] = wxT( "ShowRepairSchematic" );
Add profile counters for PCB mouse and paint events
2021-12-05 20:15:18 +00:00
static const wxChar ShowEventCounters[] = wxT( "ShowEventCounters" );
Remove manual canvas scale from GTK Fixes https://gitlab.com/kicad/code/kicad/-/issues/9912
2021-12-09 23:36:44 +00:00
static const wxChar AllowManualCanvasScale[] = wxT( "AllowManualCanvasScale" );
Add upated UI event throttling to advanced configuration.
2021-12-28 23:17:53 +00:00
static const wxChar UpdateUIEventInterval[] = wxT( "UpdateUIEventInterval" );
3D-Viewer, raytracing: implement bevel edges on item layers
2022-05-15 08:38:46 +00:00
static const wxChar V3DRT_BevelHeight_um[] = wxT( "V3DRT_BevelHeight_um" );
static const wxChar V3DRT_BevelExtentFactor[] = wxT( "V3DRT_BevelExtentFactor" );
Add Clipper2 Currently this lives behind the advanced config flag `UseClipper2`. Enabling this flag will route all Clipper-based calls through the Clipper2 library instead of the older Clipper. The changes should be mostly transparent. Of note, Clipper2 does not utilize the `STRICTLY_SIMPLE` flag because clipper1 did not actually guarantee a strictly simple polygon. Currently we ignore this flag but we may decide to run strictly-simple operations through a second NULL union to simplify the results as much as possible. Additionally, the inflation options are slightly different. We cannot choose the fallback miter. The fallback miter is always square. This only affects the CHAMFER_ACUTE_CORNERS option in inflate, which does not appear to be used. Lastly, we currently utilize the 64-bit integer coordinates for calculations. This appears to still be faster than 32-bit calculations in Clipper1 on a modern x86 system. This may not be the case for older systems, particularly 32-bit systems.
2022-10-19 23:25:45 +00:00
static const wxChar UseClipper2[] = wxT( "UseClipper2" );
Use advanced_config key EnableGenerators to enable menu entries for generators.
2023-10-07 16:18:21 +00:00
static const wxChar EnableGenerators[] = wxT( "EnableGenerators" );
ADDED: Git integration support Adds support for project-based git integration, branch support, commit, revert and updates Fixes https://gitlab.com/kicad/code/kicad/issues/10441
2023-09-14 21:39:42 +00:00
static const wxChar EnableGit[] = wxT( "EnableGit" );
ADDED: library tree context menu option to open sym/fp library files from the defined text editor. Short description: Works for Symbol and Footprint Editor behind an advanced config option. For Symbol Editor it is shown for a single item selection (library or symbol). For Footprint Editor it is shown for a footprint selection. (fp editor allows a single tree item selection only). Option stays hidden if current frame has been modified. Also small fix(?) for similar action to the project manager. (Call for the Execution has moved inside the file loop.) Fixes: https://gitlab.com/kicad/code/kicad/-/issues/15736
2024-02-29 19:01:59 +00:00
static const wxChar EnableLibWithText[] = wxT( "EnableLibWithText" );
Eeschema: Add Cairo printing to the Eeschema print engine. The current print engine (using wxDC draw engine) has frequently issues with each new wxWidgets version. Cairo printing engine, used for Pcbnew and Gerbview has less issues. On Eeschema, the cairo print is enabled only if the advanced config has the option "EnableEeschemaPrintCairo = 1"
2023-11-23 13:29:07 +00:00
static const wxChar EnableEeschemaPrintCairo[] = wxT( "EnableEeschemaPrintCairo" );
Allow disambiguation menu configurability Adds an advanced config flag to all testing different values for different users. Related to https://gitlab.com/kicad/code/kicad/-/issues/15128
2023-09-24 23:33:05 +00:00
static const wxChar DisambiguationTime[] = wxT( "DisambiguationTime" );
Fix obscured object selection issue in board and footprint editors. This selection improvement feature is hidden behind the advanced configuration key "PcbSelectionVisibilityRatio". It is turned off (1.0) by default. Value values are from 0.0 to less that 1.0. From testing, using a value between 0.1 and 0.3 produces the best results. This fix uses normal alpha blending described in the link below. The current design only uses the alpha of the object's color. It could be improved by doing a full color alpha blending but using the color alpha alone seems to result in satisfactory results. https://en.wikipedia.org/wiki/Alpha_compositing Fixes https://gitlab.com/kicad/code/kicad/-/issues/16126
2023-12-17 21:43:35 +00:00
static const wxChar PcbSelectionVisibilityRatio[] = wxT( "PcbSelectionVisibilityRatio" );
Make outline font min segment length configurable This was hard coded at 10IU, which was way too small for pcbnew and still too small for schematic editor. Instead, we set a default of 50 and allow the user to adjust (smaller for less powerful machines) Fixes https://gitlab.com/kicad/code/kicad/-/issues/16568
2024-01-12 02:26:42 +00:00
static const wxChar MinimumSegmentLength[] = wxT( "MinimumSegmentLength" );
kicad_advanced: Make OCE tesselation deflection configurable Fixes https://gitlab.com/kicad/code/kicad/-/issues/17168
2024-02-29 19:04:39 +00:00
static const wxChar OcePluginLinearDeflection[] = wxT( "OcePluginLinearDeflection" );
static const wxChar OcePluginAngularDeflection[] = wxT( "OcePluginAngularDeflection" );
Update triangulation
2024-03-20 22:47:44 +00:00
static const wxChar TriangulateSimplificationLevel[] = wxT( "TriangulateSimplificationLevel" );
Add logging and area check to tesselation Logging is useful when we find an area that cannot be triangulated. This will be used to generated test cases. Skipping minor untesselated areas means that the polygon will still be considered fully tesselated (and not sent back again and again) even if the tesselation misses an area less than the configured limit. Currently, this is 31^2nm.
2024-03-21 01:00:42 +00:00
static const wxChar TriangulateMinimumArea[] = wxT( "TriangulateMinimumArea" );
Improve SHAPE_POLY_SET fracture performance Refactors `SHAPE_POLY_SET::fractureSingle()` to be more efficient, while not changing the actual algorithm: * increase cache locality by using contiguous arrays instead of what was effectively a linked list * reduce latency and jitter by replacing per-edge allocator calls with ahead-of-time std::vector reserves * increase cache efficiency by making the vertex struct smaller * replace O(n^2) leftmost edge search with O(n log n) std::sort * sort the polygons instead of the edges * cut iteration count in half in the remaining O(polygons * edges) part
2024-03-25 23:50:26 +00:00
static const wxChar EnableCacheFriendlyFracture[] = wxT( "EnableCacheFriendlyFracture" );
Run-time config for advanced options This can be used for "advanced" options which are for developers to use for feature-flags and other configuration. Run time config has some advantages over preprocessor defines: * Can be changed without recompilation * Sensitive to XDG_CONFIG_DIR, so flipping configs is easy * Better compiler coverage (less conditionally compiled code means less chance to break a different configuration). Also better analysis coverage. * Type safe config params * Centralised documentation: it's in doxygen, in one place No advanced config should be required by a general users. If a general user does use one of these configs, it's probably because: * There is a bug and one of these configs is a workaround * A config in here is generally useful and should be moved into the relevant application config and given UI. For now, the config is read-only, and is read from the "kicad_advanced" config file in the normal config dir.
2018-12-10 10:56:28 +00:00
} // namespace KEYS
3D-Viewer, raytracing: implement bevel edges on item layers
2022-05-15 08:38:46 +00:00
/**
* List of known groups for advanced configuration options.
*
*/
namespace AC_GROUPS
{
static const wxChar V3D_RayTracing[] = wxT( "G_3DV_RayTracing" );
}
Run-time config for advanced options This can be used for "advanced" options which are for developers to use for feature-flags and other configuration. Run time config has some advantages over preprocessor defines: * Can be changed without recompilation * Sensitive to XDG_CONFIG_DIR, so flipping configs is easy * Better compiler coverage (less conditionally compiled code means less chance to break a different configuration). Also better analysis coverage. * Type safe config params * Centralised documentation: it's in doxygen, in one place No advanced config should be required by a general users. If a general user does use one of these configs, it's probably because: * There is a bug and one of these configs is a workaround * A config in here is generally useful and should be moved into the relevant application config and given UI. For now, the config is read-only, and is read from the "kicad_advanced" config file in the normal config dir.
2018-12-10 10:56:28 +00:00
/*
* Get a simple string for common parameters.
*
* This isn't exhaustive, but it covers most common types that might be
* used in the advance config
*/
Fix a bunch of un-caught boost::bad_pointer exceptions. This also removes vector cover types which do nothing except obfuscate the underlying implementation. Mainly changes SCH_SHEET_PINS and CONFIG_PARAM_ARRAY (which will soon be replaced by Jon's new stuff).
2020-01-12 18:40:50 +00:00
wxString dumpParamCfg( const PARAM_CFG& aParam )
Run-time config for advanced options This can be used for "advanced" options which are for developers to use for feature-flags and other configuration. Run time config has some advantages over preprocessor defines: * Can be changed without recompilation * Sensitive to XDG_CONFIG_DIR, so flipping configs is easy * Better compiler coverage (less conditionally compiled code means less chance to break a different configuration). Also better analysis coverage. * Type safe config params * Centralised documentation: it's in doxygen, in one place No advanced config should be required by a general users. If a general user does use one of these configs, it's probably because: * There is a bug and one of these configs is a workaround * A config in here is generally useful and should be moved into the relevant application config and given UI. For now, the config is read-only, and is read from the "kicad_advanced" config file in the normal config dir.
2018-12-10 10:56:28 +00:00
{
wxS more things
2023-01-22 14:41:33 +00:00
wxString s = aParam.m_Ident + wxS( ": " );
Run-time config for advanced options This can be used for "advanced" options which are for developers to use for feature-flags and other configuration. Run time config has some advantages over preprocessor defines: * Can be changed without recompilation * Sensitive to XDG_CONFIG_DIR, so flipping configs is easy * Better compiler coverage (less conditionally compiled code means less chance to break a different configuration). Also better analysis coverage. * Type safe config params * Centralised documentation: it's in doxygen, in one place No advanced config should be required by a general users. If a general user does use one of these configs, it's probably because: * There is a bug and one of these configs is a workaround * A config in here is generally useful and should be moved into the relevant application config and given UI. For now, the config is read-only, and is read from the "kicad_advanced" config file in the normal config dir.
2018-12-10 10:56:28 +00:00
/*
* This implementation is rather simplistic, but it is
* effective enough for simple uses. A better implementation would be
* some kind of visitor, but that's somewhat more work.
*/
switch( aParam.m_Type )
{
case paramcfg_id::PARAM_INT:
case paramcfg_id::PARAM_INT_WITH_SCALE:
s << *static_cast<const PARAM_CFG_INT&>( aParam ).m_Pt_param;
break;
case paramcfg_id::PARAM_DOUBLE:
s << *static_cast<const PARAM_CFG_DOUBLE&>( aParam ).m_Pt_param;
break;
case paramcfg_id::PARAM_WXSTRING:
s << *static_cast<const PARAM_CFG_WXSTRING&>( aParam ).m_Pt_param;
break;
case paramcfg_id::PARAM_FILENAME:
s << *static_cast<const PARAM_CFG_FILENAME&>( aParam ).m_Pt_param;
break;
case paramcfg_id::PARAM_BOOL:
wxS more things
2023-01-22 14:41:33 +00:00
s << ( *static_cast<const PARAM_CFG_BOOL&>( aParam ).m_Pt_param ? wxS( "true" ) : wxS( "false" ) );
Run-time config for advanced options This can be used for "advanced" options which are for developers to use for feature-flags and other configuration. Run time config has some advantages over preprocessor defines: * Can be changed without recompilation * Sensitive to XDG_CONFIG_DIR, so flipping configs is easy * Better compiler coverage (less conditionally compiled code means less chance to break a different configuration). Also better analysis coverage. * Type safe config params * Centralised documentation: it's in doxygen, in one place No advanced config should be required by a general users. If a general user does use one of these configs, it's probably because: * There is a bug and one of these configs is a workaround * A config in here is generally useful and should be moved into the relevant application config and given UI. For now, the config is read-only, and is read from the "kicad_advanced" config file in the normal config dir.
2018-12-10 10:56:28 +00:00
break;
wxS more things
2023-01-22 14:41:33 +00:00
default: s << wxS( "Unsupported PARAM_CFG variant: " ) << aParam.m_Type;
Run-time config for advanced options This can be used for "advanced" options which are for developers to use for feature-flags and other configuration. Run time config has some advantages over preprocessor defines: * Can be changed without recompilation * Sensitive to XDG_CONFIG_DIR, so flipping configs is easy * Better compiler coverage (less conditionally compiled code means less chance to break a different configuration). Also better analysis coverage. * Type safe config params * Centralised documentation: it's in doxygen, in one place No advanced config should be required by a general users. If a general user does use one of these configs, it's probably because: * There is a bug and one of these configs is a workaround * A config in here is generally useful and should be moved into the relevant application config and given UI. For now, the config is read-only, and is read from the "kicad_advanced" config file in the normal config dir.
2018-12-10 10:56:28 +00:00
}
return s;
}
/**
* Dump the configs in the given array to trace.
*/
Fix a bunch of un-caught boost::bad_pointer exceptions. This also removes vector cover types which do nothing except obfuscate the underlying implementation. Mainly changes SCH_SHEET_PINS and CONFIG_PARAM_ARRAY (which will soon be replaced by Jon's new stuff).
2020-01-12 18:40:50 +00:00
static void dumpCfg( const std::vector<PARAM_CFG*>& aArray )
Run-time config for advanced options This can be used for "advanced" options which are for developers to use for feature-flags and other configuration. Run time config has some advantages over preprocessor defines: * Can be changed without recompilation * Sensitive to XDG_CONFIG_DIR, so flipping configs is easy * Better compiler coverage (less conditionally compiled code means less chance to break a different configuration). Also better analysis coverage. * Type safe config params * Centralised documentation: it's in doxygen, in one place No advanced config should be required by a general users. If a general user does use one of these configs, it's probably because: * There is a bug and one of these configs is a workaround * A config in here is generally useful and should be moved into the relevant application config and given UI. For now, the config is read-only, and is read from the "kicad_advanced" config file in the normal config dir.
2018-12-10 10:56:28 +00:00
{
// only dump if we need to
if( !wxLog::IsAllowedTraceMask( AdvancedConfigMask ) )
return;
Fix a bunch of un-caught boost::bad_pointer exceptions. This also removes vector cover types which do nothing except obfuscate the underlying implementation. Mainly changes SCH_SHEET_PINS and CONFIG_PARAM_ARRAY (which will soon be replaced by Jon's new stuff).
2020-01-12 18:40:50 +00:00
for( const PARAM_CFG* param : aArray )
Run-time config for advanced options This can be used for "advanced" options which are for developers to use for feature-flags and other configuration. Run time config has some advantages over preprocessor defines: * Can be changed without recompilation * Sensitive to XDG_CONFIG_DIR, so flipping configs is easy * Better compiler coverage (less conditionally compiled code means less chance to break a different configuration). Also better analysis coverage. * Type safe config params * Centralised documentation: it's in doxygen, in one place No advanced config should be required by a general users. If a general user does use one of these configs, it's probably because: * There is a bug and one of these configs is a workaround * A config in here is generally useful and should be moved into the relevant application config and given UI. For now, the config is read-only, and is read from the "kicad_advanced" config file in the normal config dir.
2018-12-10 10:56:28 +00:00
{
Fix a bunch of un-caught boost::bad_pointer exceptions. This also removes vector cover types which do nothing except obfuscate the underlying implementation. Mainly changes SCH_SHEET_PINS and CONFIG_PARAM_ARRAY (which will soon be replaced by Jon's new stuff).
2020-01-12 18:40:50 +00:00
wxLogTrace( AdvancedConfigMask, dumpParamCfg( *param ) );
Run-time config for advanced options This can be used for "advanced" options which are for developers to use for feature-flags and other configuration. Run time config has some advantages over preprocessor defines: * Can be changed without recompilation * Sensitive to XDG_CONFIG_DIR, so flipping configs is easy * Better compiler coverage (less conditionally compiled code means less chance to break a different configuration). Also better analysis coverage. * Type safe config params * Centralised documentation: it's in doxygen, in one place No advanced config should be required by a general users. If a general user does use one of these configs, it's probably because: * There is a bug and one of these configs is a workaround * A config in here is generally useful and should be moved into the relevant application config and given UI. For now, the config is read-only, and is read from the "kicad_advanced" config file in the normal config dir.
2018-12-10 10:56:28 +00:00
}
}
/**
* Get the filename for the advanced config file
*
* The user must check the file exists if they care.
*/
static wxFileName getAdvancedCfgFilename()
{
wxS more things
2023-01-22 14:41:33 +00:00
const static wxString cfg_filename{ wxS( "kicad_advanced" ) };
Move the settings path to PATHS to allow shifting other classes into kicommon
2023-09-23 23:53:22 +00:00
return wxFileName( PATHS::GetUserSettingsPath(), cfg_filename );
Run-time config for advanced options This can be used for "advanced" options which are for developers to use for feature-flags and other configuration. Run time config has some advantages over preprocessor defines: * Can be changed without recompilation * Sensitive to XDG_CONFIG_DIR, so flipping configs is easy * Better compiler coverage (less conditionally compiled code means less chance to break a different configuration). Also better analysis coverage. * Type safe config params * Centralised documentation: it's in doxygen, in one place No advanced config should be required by a general users. If a general user does use one of these configs, it's probably because: * There is a bug and one of these configs is a workaround * A config in here is generally useful and should be moved into the relevant application config and given UI. For now, the config is read-only, and is read from the "kicad_advanced" config file in the normal config dir.
2018-12-10 10:56:28 +00:00
}
ADVANCED_CFG::ADVANCED_CFG()
{
wxS more things
2023-01-22 14:41:33 +00:00
wxLogTrace( AdvancedConfigMask, wxS( "Init advanced config" ) );
Make SVG import an advanced config, not a compile option. This demos the advanced config and allows no-recompile switching of the SVG importer. It also allows the import manager to be tested more completely.
2018-12-12 12:26:03 +00:00
// Init defaults - this is done in case the config doesn't exist,
// then the values will remain as set here.
Naming conventions.
2020-11-16 11:16:44 +00:00
m_CoroutineStackSize = AC_STACK::default_stack;
Adding triangulation viewing to AC This adds a helper routine to visualize the quality of our triangulation. It also renames an excessively long variable name for the arc editor
2020-08-12 13:16:57 +00:00
m_ShowRouterDebugGraphics = false;
PNS: add new "EnableRouterDump" kicad_advanced setting
2023-08-07 15:44:33 +00:00
m_EnableRouterDump = false;
Add a "hyperzoom" mode for debugging "up close".
2023-06-20 13:15:56 +00:00
m_HyperZoom = false;
Naming conventions.
2020-11-16 11:16:44 +00:00
m_DrawArcAccuracy = 10.0;
m_DrawArcCenterMaxAngle = 50.0;
Less restrictive Arc Track Dragging tool Use the connecting straight tracks even if not exactly parallel - allow an error margin configurable in ADVANCED_CFG (default 1 degree). Also be less strict about end point matching and use the width of the track as the criteria to determine suitability. Finally, delete any short lengths of track at the end of the operation and amend the arc end points to keep connectivity. Fixes https://gitlab.com/kicad/code/kicad/-/issues/7967
2021-03-31 20:13:08 +00:00
m_MaxTangentAngleDeviation = 1.0;
There is one source of truth in AC Don't store default values in two separate places. Passes the existing by value as the default. Issue identified by @axemagn Fixes https://gitlab.com/kicad/code/kicad/issues/10221
2022-01-28 21:31:16 +00:00
m_MaxTrackLengthToKeep = 0.0005;
Move zone fracture display mode to AdvancedCfg, and add triangulation. Fixes https://gitlab.com/kicad/code/kicad/issues/8762
2021-07-26 17:56:11 +00:00
m_ExtraZoneDisplayModes = false;
Adding triangulation viewing to AC This adds a helper routine to visualize the quality of our triangulation. It also renames an excessively long variable name for the arc editor
2020-08-12 13:16:57 +00:00
m_DrawTriangulationOutlines = false;
Make SVG import an advanced config, not a compile option. This demos the advanced config and allows no-recompile switching of the SVG importer. It also allows the import manager to be tested more completely.
2018-12-12 12:26:03 +00:00
There is one source of truth in AC Don't store default values in two separate places. Passes the existing by value as the default. Issue identified by @axemagn Fixes https://gitlab.com/kicad/code/kicad/issues/10221
2022-01-28 21:31:16 +00:00
m_ExtraClearance = 0.0005;
m_DRCEpsilon = 0.0005; // 0.5um is small enough not to materially violate
Consolidate all DRC epsilon/threshold values to a single advancedCfg setting. Fixes https://gitlab.com/kicad/code/kicad/issues/5464
2020-09-02 22:15:30 +00:00
// any constraints.
Copper sliver checking. ADDED DRCE_COPPER_SLIVER DRC error. ADDED ADVANCED_CFG DRCSliverWidthTolerance and DRCSliverAngleTolerance. Fixes https://gitlab.com/kicad/code/kicad/issues/2183
2021-08-11 13:01:30 +00:00
m_SliverWidthTolerance = 0.08;
Marginally increase sliver width checker's bogus segment tolerance. Fixes https://gitlab.com/kicad/code/kicad/issues/14449
2023-04-02 15:42:57 +00:00
m_SliverMinimumLength = 0.0008;
Copper sliver checking. ADDED DRCE_COPPER_SLIVER DRC error. ADDED ADVANCED_CFG DRCSliverWidthTolerance and DRCSliverAngleTolerance. Fixes https://gitlab.com/kicad/code/kicad/issues/2183
2021-08-11 13:01:30 +00:00
m_SliverAngleTolerance = 20.0;
ADDED holeWallPlatingThickness to AdvancedCfg. Used for zone filling and DRC hole collision testing. Allows us to calculate the actual hole size from the finish hole size. Fixes https://gitlab.com/kicad/code/kicad/issues/5468
2020-09-03 14:58:49 +00:00
Add a min pin width advanced config for plotting. Fixes https://gitlab.com/kicad/code/kicad/issues/5546
2020-09-08 19:18:50 +00:00
m_HoleWallThickness = 0.020; // IPC-6012 says 15-18um; Cadence says at least
ADDED holeWallPlatingThickness to AdvancedCfg. Used for zone filling and DRC hole collision testing. Allows us to calculate the actual hole size from the finish hole size. Fixes https://gitlab.com/kicad/code/kicad/issues/5468
2020-09-03 14:58:49 +00:00
// 0.020 for a Class 2 board and at least 0.025
// for Class 3.
Add a min pin width advanced config for plotting. Fixes https://gitlab.com/kicad/code/kicad/issues/5546
2020-09-08 19:18:50 +00:00
m_MinPlotPenWidth = 0.0212; // 1 pixel at 1200dpi.
Move DebugZoneFiller to advanced config. This will hopefully keep it from accidentally getting checked in again.
2020-09-23 09:35:13 +00:00
m_DebugZoneFiller = false;
Add PDFWriter debug mode (ie: uncompressed output). Fixes https://gitlab.com/kicad/code/kicad/issues/5593
2020-11-06 10:32:14 +00:00
m_DebugPDFWriter = false;
Add a helper to generate action documentation
2021-02-20 18:41:42 +00:00
m_SmallDrillMarkSize = 0.35;
m_HotkeysDumper = false;
Tighten up schematic label bounding boxes Margins were being added in more places than necessary Fixes https://gitlab.com/kicad/code/kicad/-/issues/7689
2021-02-24 22:14:39 +00:00
m_DrawBoundingBoxes = false;
Pcbnew: add write board netlist to file support. This is hidden behind an advanced configuration setting and is primarily useful for developers trying to troubleshoot the netlist payload sent from the board editor to the schematic editor. Fixes https://gitlab.com/kicad/code/kicad/issues/8051
2021-03-28 12:37:54 +00:00
m_ShowPcbnewExportNetlist = false;
Add advanced cfg to force reloading memory cached 3d models
2021-07-11 04:35:38 +00:00
m_Skip3DModelFileCache = false;
m_Skip3DModelMemoryCache = false;
Allow hiding version from manager title bar with advanced config
2021-07-14 22:24:21 +00:00
m_HideVersionFromTitle = false;
Add profile counters for PCB mouse and paint events
2021-12-05 20:15:18 +00:00
m_ShowEventCounters = false;
Remove manual canvas scale from GTK Fixes https://gitlab.com/kicad/code/kicad/-/issues/9912
2021-12-09 23:36:44 +00:00
m_AllowManualCanvasScale = false;
There is one source of truth in AC Don't store default values in two separate places. Passes the existing by value as the default. Issue identified by @axemagn Fixes https://gitlab.com/kicad/code/kicad/issues/10221
2022-01-28 21:31:16 +00:00
m_CompactSave = false;
Add upated UI event throttling to advanced configuration.
2021-12-28 23:17:53 +00:00
m_UpdateUIEventInterval = 0;
There is one source of truth in AC Don't store default values in two separate places. Passes the existing by value as the default. Issue identified by @axemagn Fixes https://gitlab.com/kicad/code/kicad/issues/10221
2022-01-28 21:31:16 +00:00
m_ShowRepairSchematic = false;
Use advanced_config key EnableGenerators to enable menu entries for generators.
2023-10-07 16:18:21 +00:00
m_EnableGenerators = false;
ADDED: Git integration support Adds support for project-based git integration, branch support, commit, revert and updates Fixes https://gitlab.com/kicad/code/kicad/issues/10441
2023-09-14 21:39:42 +00:00
m_EnableGit = false;
ADDED: library tree context menu option to open sym/fp library files from the defined text editor. Short description: Works for Symbol and Footprint Editor behind an advanced config option. For Symbol Editor it is shown for a single item selection (library or symbol). For Footprint Editor it is shown for a footprint selection. (fp editor allows a single tree item selection only). Option stays hidden if current frame has been modified. Also small fix(?) for similar action to the project manager. (Call for the Execution has moved inside the file loop.) Fixes: https://gitlab.com/kicad/code/kicad/-/issues/15736
2024-02-29 19:01:59 +00:00
m_EnableLibWithText = false;
Eeschema printing, advanced config: set EnableEeschemaPrintCairo to true by default.
2024-01-04 14:10:08 +00:00
m_EnableEeschemaPrintCairo = true;
prepare teardrops, round 2
2022-01-08 15:56:41 +00:00
3D-Viewer, raytracing: implement bevel edges on item layers
2022-05-15 08:38:46 +00:00
m_3DRT_BevelHeight_um = 30;
m_3DRT_BevelExtentFactor = 1.0 / 16.0;
Activate Clipper2 by default Fixes https://gitlab.com/kicad/code/kicad/issues/git
2022-12-04 00:04:36 +00:00
m_UseClipper2 = true;
Change the spacemouse driver flag to true for windows by default
2023-05-07 16:12:20 +00:00
Add 3dconnexion driver version check Re-enable 3dconnexion driver by default as we are able to gate the driver versions Fixes https://gitlab.com/kicad/code/kicad/-/issues/13362
2023-06-13 16:44:22 +00:00
m_Use3DConnexionDriver = true;
Change the spacemouse driver flag to true for windows by default
2023-05-07 16:12:20 +00:00
Incremental schematic connectivity fixes.
2024-01-21 16:53:05 +00:00
m_IncrementalConnectivity = true;
Add Clipper2 Currently this lives behind the advanced config flag `UseClipper2`. Enabling this flag will route all Clipper-based calls through the Clipper2 library instead of the older Clipper. The changes should be mostly transparent. Of note, Clipper2 does not utilize the `STRICTLY_SIMPLE` flag because clipper1 did not actually guarantee a strictly simple polygon. Currently we ignore this flag but we may decide to run strictly-simple operations through a second NULL union to simplify the results as much as possible. Additionally, the inflation options are slightly different. We cannot choose the fallback miter. The fallback miter is always square. This only affects the CHAMFER_ACUTE_CORNERS option in inflate, which does not appear to be used. Lastly, we currently utilize the 64-bit integer coordinates for calculations. This appears to still be faster than 32-bit calculations in Clipper1 on a modern x86 system. This may not be the case for older systems, particularly 32-bit systems.
2022-10-19 23:25:45 +00:00
Revert disambiguation menu delay to 0.5s
2024-02-15 17:17:43 +00:00
m_DisambiguationMenuDelay = 500;
Allow disambiguation menu configurability Adds an advanced config flag to all testing different values for different users. Related to https://gitlab.com/kicad/code/kicad/-/issues/15128
2023-09-24 23:33:05 +00:00
Fix obscured object selection issue in board and footprint editors. This selection improvement feature is hidden behind the advanced configuration key "PcbSelectionVisibilityRatio". It is turned off (1.0) by default. Value values are from 0.0 to less that 1.0. From testing, using a value between 0.1 and 0.3 produces the best results. This fix uses normal alpha blending described in the link below. The current design only uses the alpha of the object's color. It could be improved by doing a full color alpha blending but using the color alpha alone seems to result in satisfactory results. https://en.wikipedia.org/wiki/Alpha_compositing Fixes https://gitlab.com/kicad/code/kicad/-/issues/16126
2023-12-17 21:43:35 +00:00
m_PcbSelectionVisibilityRatio = 1.0;
Make outline font min segment length configurable This was hard coded at 10IU, which was way too small for pcbnew and still too small for schematic editor. Instead, we set a default of 50 and allow the user to adjust (smaller for less powerful machines) Fixes https://gitlab.com/kicad/code/kicad/-/issues/16568
2024-01-12 02:26:42 +00:00
m_MinimumSegmentLength = 50;
kicad_advanced: Make OCE tesselation deflection configurable Fixes https://gitlab.com/kicad/code/kicad/-/issues/17168
2024-02-29 19:04:39 +00:00
m_OcePluginLinearDeflection = 0.14;
m_OcePluginAngularDeflection = 30;
Update triangulation
2024-03-20 22:47:44 +00:00
m_TriangulateSimplificationLevel = 50;
Add logging and area check to tesselation Logging is useful when we find an area that cannot be triangulated. This will be used to generated test cases. Skipping minor untesselated areas means that the polygon will still be considered fully tesselated (and not sent back again and again) even if the tesselation misses an area less than the configured limit. Currently, this is 31^2nm.
2024-03-21 01:00:42 +00:00
m_TriangulateMinimumArea = 1000;
Update triangulation
2024-03-20 22:47:44 +00:00
Improve SHAPE_POLY_SET fracture performance Refactors `SHAPE_POLY_SET::fractureSingle()` to be more efficient, while not changing the actual algorithm: * increase cache locality by using contiguous arrays instead of what was effectively a linked list * reduce latency and jitter by replacing per-edge allocator calls with ahead-of-time std::vector reserves * increase cache efficiency by making the vertex struct smaller * replace O(n^2) leftmost edge search with O(n log n) std::sort * sort the polygons instead of the edges * cut iteration count in half in the remaining O(polygons * edges) part
2024-03-25 23:50:26 +00:00
m_EnableCacheFriendlyFracture = true;
Run-time config for advanced options This can be used for "advanced" options which are for developers to use for feature-flags and other configuration. Run time config has some advantages over preprocessor defines: * Can be changed without recompilation * Sensitive to XDG_CONFIG_DIR, so flipping configs is easy * Better compiler coverage (less conditionally compiled code means less chance to break a different configuration). Also better analysis coverage. * Type safe config params * Centralised documentation: it's in doxygen, in one place No advanced config should be required by a general users. If a general user does use one of these configs, it's probably because: * There is a bug and one of these configs is a workaround * A config in here is generally useful and should be moved into the relevant application config and given UI. For now, the config is read-only, and is read from the "kicad_advanced" config file in the normal config dir.
2018-12-10 10:56:28 +00:00
loadFromConfigFile();
}
const ADVANCED_CFG& ADVANCED_CFG::GetCfg()
{
static ADVANCED_CFG instance;
return instance;
}
void ADVANCED_CFG::loadFromConfigFile()
{
Give up on trying to get Clipper's miter strategies to work. Instead, make sure we remove the clearance holes and outline at the end so that copper isn't allowed to "spill" into areas it shouldn't be in. Also fixes a bug where the Advance Cfg defaults weren't getting loaded when the file didn't exist. Fixes https://gitlab.com/kicad/code/kicad/issues/3812 Fixes https://gitlab.com/kicad/code/kicad/issues/5306
2020-08-25 18:03:21 +00:00
const wxFileName k_advanced = getAdvancedCfgFilename();
Run-time config for advanced options This can be used for "advanced" options which are for developers to use for feature-flags and other configuration. Run time config has some advantages over preprocessor defines: * Can be changed without recompilation * Sensitive to XDG_CONFIG_DIR, so flipping configs is easy * Better compiler coverage (less conditionally compiled code means less chance to break a different configuration). Also better analysis coverage. * Type safe config params * Centralised documentation: it's in doxygen, in one place No advanced config should be required by a general users. If a general user does use one of these configs, it's probably because: * There is a bug and one of these configs is a workaround * A config in here is generally useful and should be moved into the relevant application config and given UI. For now, the config is read-only, and is read from the "kicad_advanced" config file in the normal config dir.
2018-12-10 10:56:28 +00:00
Don't use wxApp-dependent functions in headless When running headless, e.g. from Python script, the wxApp has not be instantiated, so we cannot use wxConfig. In this case, we fall back to the class defaults in ADVANCED_CONFIG()
2021-06-03 19:30:31 +00:00
// If we are running headless, use the class defaults because we cannot instantiate wxConfig
if( !wxTheApp )
return;
Run-time config for advanced options This can be used for "advanced" options which are for developers to use for feature-flags and other configuration. Run time config has some advantages over preprocessor defines: * Can be changed without recompilation * Sensitive to XDG_CONFIG_DIR, so flipping configs is easy * Better compiler coverage (less conditionally compiled code means less chance to break a different configuration). Also better analysis coverage. * Type safe config params * Centralised documentation: it's in doxygen, in one place No advanced config should be required by a general users. If a general user does use one of these configs, it's probably because: * There is a bug and one of these configs is a workaround * A config in here is generally useful and should be moved into the relevant application config and given UI. For now, the config is read-only, and is read from the "kicad_advanced" config file in the normal config dir.
2018-12-10 10:56:28 +00:00
if( !k_advanced.FileExists() )
{
wxS more things
2023-01-22 14:41:33 +00:00
wxLogTrace( AdvancedConfigMask, wxS( "File does not exist %s" ), k_advanced.GetFullPath() );
Give up on trying to get Clipper's miter strategies to work. Instead, make sure we remove the clearance holes and outline at the end so that copper isn't allowed to "spill" into areas it shouldn't be in. Also fixes a bug where the Advance Cfg defaults weren't getting loaded when the file didn't exist. Fixes https://gitlab.com/kicad/code/kicad/issues/3812 Fixes https://gitlab.com/kicad/code/kicad/issues/5306
2020-08-25 18:03:21 +00:00
// load the defaults
wxConfig emptyConfig;
loadSettings( emptyConfig );
Run-time config for advanced options This can be used for "advanced" options which are for developers to use for feature-flags and other configuration. Run time config has some advantages over preprocessor defines: * Can be changed without recompilation * Sensitive to XDG_CONFIG_DIR, so flipping configs is easy * Better compiler coverage (less conditionally compiled code means less chance to break a different configuration). Also better analysis coverage. * Type safe config params * Centralised documentation: it's in doxygen, in one place No advanced config should be required by a general users. If a general user does use one of these configs, it's probably because: * There is a bug and one of these configs is a workaround * A config in here is generally useful and should be moved into the relevant application config and given UI. For now, the config is read-only, and is read from the "kicad_advanced" config file in the normal config dir.
2018-12-10 10:56:28 +00:00
return;
}
Coding policy and Doxygen comment fixes.
2023-12-18 13:32:41 +00:00
wxLogTrace( AdvancedConfigMask, wxS( "Loading advanced config from: %s" ),
k_advanced.GetFullPath() );
Run-time config for advanced options This can be used for "advanced" options which are for developers to use for feature-flags and other configuration. Run time config has some advantages over preprocessor defines: * Can be changed without recompilation * Sensitive to XDG_CONFIG_DIR, so flipping configs is easy * Better compiler coverage (less conditionally compiled code means less chance to break a different configuration). Also better analysis coverage. * Type safe config params * Centralised documentation: it's in doxygen, in one place No advanced config should be required by a general users. If a general user does use one of these configs, it's probably because: * There is a bug and one of these configs is a workaround * A config in here is generally useful and should be moved into the relevant application config and given UI. For now, the config is read-only, and is read from the "kicad_advanced" config file in the normal config dir.
2018-12-10 10:56:28 +00:00
wxS more things
2023-01-22 14:41:33 +00:00
wxFileConfig file_cfg( wxS( "" ), wxS( "" ), k_advanced.GetFullPath() );
Run-time config for advanced options This can be used for "advanced" options which are for developers to use for feature-flags and other configuration. Run time config has some advantages over preprocessor defines: * Can be changed without recompilation * Sensitive to XDG_CONFIG_DIR, so flipping configs is easy * Better compiler coverage (less conditionally compiled code means less chance to break a different configuration). Also better analysis coverage. * Type safe config params * Centralised documentation: it's in doxygen, in one place No advanced config should be required by a general users. If a general user does use one of these configs, it's probably because: * There is a bug and one of these configs is a workaround * A config in here is generally useful and should be moved into the relevant application config and given UI. For now, the config is read-only, and is read from the "kicad_advanced" config file in the normal config dir.
2018-12-10 10:56:28 +00:00
loadSettings( file_cfg );
}
void ADVANCED_CFG::loadSettings( wxConfigBase& aCfg )
{
Fix a bunch of un-caught boost::bad_pointer exceptions. This also removes vector cover types which do nothing except obfuscate the underlying implementation. Mainly changes SCH_SHEET_PINS and CONFIG_PARAM_ARRAY (which will soon be replaced by Jon's new stuff).
2020-01-12 18:40:50 +00:00
std::vector<PARAM_CFG*> configParams;
Run-time config for advanced options This can be used for "advanced" options which are for developers to use for feature-flags and other configuration. Run time config has some advantages over preprocessor defines: * Can be changed without recompilation * Sensitive to XDG_CONFIG_DIR, so flipping configs is easy * Better compiler coverage (less conditionally compiled code means less chance to break a different configuration). Also better analysis coverage. * Type safe config params * Centralised documentation: it's in doxygen, in one place No advanced config should be required by a general users. If a general user does use one of these configs, it's probably because: * There is a bug and one of these configs is a workaround * A config in here is generally useful and should be moved into the relevant application config and given UI. For now, the config is read-only, and is read from the "kicad_advanced" config file in the normal config dir.
2018-12-10 10:56:28 +00:00
Change Zone extra clearance magic number to AC Rather than keeping a magic number in the code, we set the default in the advanced config setting and allow users/developers to modify it.
2020-07-26 14:20:24 +00:00
configParams.push_back( new PARAM_CFG_DOUBLE( true, AC_KEYS::ExtraFillMargin,
Coding policy and Doxygen comment fixes.
2023-12-18 13:32:41 +00:00
&m_ExtraClearance,
m_ExtraClearance, 0.0, 1.0 ) );
Consolidate all DRC epsilon/threshold values to a single advancedCfg setting. Fixes https://gitlab.com/kicad/code/kicad/issues/5464
2020-09-02 22:15:30 +00:00
configParams.push_back( new PARAM_CFG_DOUBLE( true, AC_KEYS::DRCEpsilon,
There is one source of truth in AC Don't store default values in two separate places. Passes the existing by value as the default. Issue identified by @axemagn Fixes https://gitlab.com/kicad/code/kicad/issues/10221
2022-01-28 21:31:16 +00:00
&m_DRCEpsilon, m_DRCEpsilon, 0.0, 1.0 ) );
Change Zone extra clearance magic number to AC Rather than keeping a magic number in the code, we set the default in the advanced config setting and allow users/developers to modify it.
2020-07-26 14:20:24 +00:00
Copper sliver checking. ADDED DRCE_COPPER_SLIVER DRC error. ADDED ADVANCED_CFG DRCSliverWidthTolerance and DRCSliverAngleTolerance. Fixes https://gitlab.com/kicad/code/kicad/issues/2183
2021-08-11 13:01:30 +00:00
configParams.push_back( new PARAM_CFG_DOUBLE( true, AC_KEYS::DRCSliverWidthTolerance,
Coding policy and Doxygen comment fixes.
2023-12-18 13:32:41 +00:00
&m_SliverWidthTolerance, m_SliverWidthTolerance,
0.01, 0.25 ) );
Copper sliver checking. ADDED DRCE_COPPER_SLIVER DRC error. ADDED ADVANCED_CFG DRCSliverWidthTolerance and DRCSliverAngleTolerance. Fixes https://gitlab.com/kicad/code/kicad/issues/2183
2021-08-11 13:01:30 +00:00
Add an advanced config value for the minimum sliver The hard coded value was too small for certain calculations. Better to have a configurable value that is initially set to our error level to allow for deviations that don't meet the visibility test for spikes. These have become more apparent with Clipper2
2022-12-04 00:02:07 +00:00
configParams.push_back( new PARAM_CFG_DOUBLE( true, AC_KEYS::DRCSliverMinimumLength,
Coding policy and Doxygen comment fixes.
2023-12-18 13:32:41 +00:00
&m_SliverMinimumLength, m_SliverMinimumLength,
1e-9, 10 ) );
Add an advanced config value for the minimum sliver The hard coded value was too small for certain calculations. Better to have a configurable value that is initially set to our error level to allow for deviations that don't meet the visibility test for spikes. These have become more apparent with Clipper2
2022-12-04 00:02:07 +00:00
Copper sliver checking. ADDED DRCE_COPPER_SLIVER DRC error. ADDED ADVANCED_CFG DRCSliverWidthTolerance and DRCSliverAngleTolerance. Fixes https://gitlab.com/kicad/code/kicad/issues/2183
2021-08-11 13:01:30 +00:00
configParams.push_back( new PARAM_CFG_DOUBLE( true, AC_KEYS::DRCSliverAngleTolerance,
Coding policy and Doxygen comment fixes.
2023-12-18 13:32:41 +00:00
&m_SliverAngleTolerance, m_SliverAngleTolerance,
1.0, 90.0 ) );
Copper sliver checking. ADDED DRCE_COPPER_SLIVER DRC error. ADDED ADVANCED_CFG DRCSliverWidthTolerance and DRCSliverAngleTolerance. Fixes https://gitlab.com/kicad/code/kicad/issues/2183
2021-08-11 13:01:30 +00:00
ADDED holeWallPlatingThickness to AdvancedCfg. Used for zone filling and DRC hole collision testing. Allows us to calculate the actual hole size from the finish hole size. Fixes https://gitlab.com/kicad/code/kicad/issues/5468
2020-09-03 14:58:49 +00:00
configParams.push_back( new PARAM_CFG_DOUBLE( true, AC_KEYS::HoleWallThickness,
Coding policy and Doxygen comment fixes.
2023-12-18 13:32:41 +00:00
&m_HoleWallThickness, m_HoleWallThickness,
0.0, 1.0 ) );
ADDED holeWallPlatingThickness to AdvancedCfg. Used for zone filling and DRC hole collision testing. Allows us to calculate the actual hole size from the finish hole size. Fixes https://gitlab.com/kicad/code/kicad/issues/5468
2020-09-03 14:58:49 +00:00
Fix a bunch of un-caught boost::bad_pointer exceptions. This also removes vector cover types which do nothing except obfuscate the underlying implementation. Mainly changes SCH_SHEET_PINS and CONFIG_PARAM_ARRAY (which will soon be replaced by Jon's new stuff).
2020-01-12 18:40:50 +00:00
configParams.push_back( new PARAM_CFG_INT( true, AC_KEYS::CoroutineStackSize,
Naming conventions.
2020-11-16 11:16:44 +00:00
&m_CoroutineStackSize, AC_STACK::default_stack,
Fix a bunch of un-caught boost::bad_pointer exceptions. This also removes vector cover types which do nothing except obfuscate the underlying implementation. Mainly changes SCH_SHEET_PINS and CONFIG_PARAM_ARRAY (which will soon be replaced by Jon's new stuff).
2020-01-12 18:40:50 +00:00
AC_STACK::min_stack, AC_STACK::max_stack ) );
Make coroutines stack size configurable This allows rapid debugging of the coroutine memory issues. It moves the default stack size to 256 * 4096 = 2^20, which will utilize full pages on all architectures.
2019-08-15 04:25:05 +00:00
Add upated UI event throttling to advanced configuration.
2021-12-28 23:17:53 +00:00
configParams.push_back( new PARAM_CFG_INT( true, AC_KEYS::UpdateUIEventInterval,
Coding policy and Doxygen comment fixes.
2023-12-18 13:32:41 +00:00
&m_UpdateUIEventInterval, m_UpdateUIEventInterval,
-1, 100000 ) );
Add upated UI event throttling to advanced configuration.
2021-12-28 23:17:53 +00:00
Hide PNS debug graphics behind an AC key Fixes https://gitlab.com/kicad/code/kicad/-/issues/4061
2020-07-03 23:33:36 +00:00
configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::ShowRouterDebugGraphics,
Coding policy and Doxygen comment fixes.
2023-12-18 13:32:41 +00:00
&m_ShowRouterDebugGraphics,
m_ShowRouterDebugGraphics ) );
Hide PNS debug graphics behind an AC key Fixes https://gitlab.com/kicad/code/kicad/-/issues/4061
2020-07-03 23:33:36 +00:00
PNS: add new "EnableRouterDump" kicad_advanced setting
2023-08-07 15:44:33 +00:00
configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::EnableRouterDump,
&m_EnableRouterDump, m_EnableRouterDump ) );
Add a "hyperzoom" mode for debugging "up close".
2023-06-20 13:15:56 +00:00
configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::HyperZoom,
&m_HyperZoom, m_HyperZoom ) );
ADDED: polygon newlines every point By default KiCad will now print each polygon point on its own line. This adds to the vertical distance for large polygons but makes revision control much cleaner as single point addition to a polygon does not propagate to a diff over the full polygon. Users/developers who want to save the files using the 4-points per line have the ADVANCED_CONFIG setting 'CompactSave' which will provide the original save method
2020-07-25 21:53:58 +00:00
configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::CompactFileSave,
There is one source of truth in AC Don't store default values in two separate places. Passes the existing by value as the default. Issue identified by @axemagn Fixes https://gitlab.com/kicad/code/kicad/issues/10221
2022-01-28 21:31:16 +00:00
&m_CompactSave, m_CompactSave ) );
ADDED: polygon newlines every point By default KiCad will now print each polygon point on its own line. This adds to the vertical distance for large polygons but makes revision control much cleaner as single point addition to a polygon does not propagate to a diff over the full polygon. Users/developers who want to save the files using the 4-points per line have the ADVANCED_CONFIG setting 'CompactSave' which will provide the original save method
2020-07-25 21:53:58 +00:00
Adding triangulation viewing to AC This adds a helper routine to visualize the quality of our triangulation. It also renames an excessively long variable name for the arc editor
2020-08-12 13:16:57 +00:00
configParams.push_back( new PARAM_CFG_DOUBLE( true, AC_KEYS::DrawArcAccuracy,
Coding policy and Doxygen comment fixes.
2023-12-18 13:32:41 +00:00
&m_DrawArcAccuracy, m_DrawArcAccuracy,
0.0, 100000.0 ) );
Pcbnew fix arc edition
2020-08-09 23:03:31 +00:00
configParams.push_back( new PARAM_CFG_DOUBLE( true, AC_KEYS::DrawArcCenterStartEndMaxAngle,
Coding policy and Doxygen comment fixes.
2023-12-18 13:32:41 +00:00
&m_DrawArcCenterMaxAngle,
m_DrawArcCenterMaxAngle, 0.0, 100000.0 ) );
Adding triangulation viewing to AC This adds a helper routine to visualize the quality of our triangulation. It also renames an excessively long variable name for the arc editor
2020-08-12 13:16:57 +00:00
Less restrictive Arc Track Dragging tool Use the connecting straight tracks even if not exactly parallel - allow an error margin configurable in ADVANCED_CFG (default 1 degree). Also be less strict about end point matching and use the width of the track as the criteria to determine suitability. Finally, delete any short lengths of track at the end of the operation and amend the arc end points to keep connectivity. Fixes https://gitlab.com/kicad/code/kicad/-/issues/7967
2021-03-31 20:13:08 +00:00
configParams.push_back( new PARAM_CFG_DOUBLE( true, AC_KEYS::MaxTangentTrackAngleDeviation,
Coding policy and Doxygen comment fixes.
2023-12-18 13:32:41 +00:00
&m_MaxTangentAngleDeviation,
m_MaxTangentAngleDeviation, 0.0, 90.0 ) );
Less restrictive Arc Track Dragging tool Use the connecting straight tracks even if not exactly parallel - allow an error margin configurable in ADVANCED_CFG (default 1 degree). Also be less strict about end point matching and use the width of the track as the criteria to determine suitability. Finally, delete any short lengths of track at the end of the operation and amend the arc end points to keep connectivity. Fixes https://gitlab.com/kicad/code/kicad/-/issues/7967
2021-03-31 20:13:08 +00:00
configParams.push_back( new PARAM_CFG_DOUBLE( true, AC_KEYS::MaxTrackLengthToKeep,
Coding policy and Doxygen comment fixes.
2023-12-18 13:32:41 +00:00
&m_MaxTrackLengthToKeep, m_MaxTrackLengthToKeep,
0.0, 1.0 ) );
Less restrictive Arc Track Dragging tool Use the connecting straight tracks even if not exactly parallel - allow an error margin configurable in ADVANCED_CFG (default 1 degree). Also be less strict about end point matching and use the width of the track as the criteria to determine suitability. Finally, delete any short lengths of track at the end of the operation and amend the arc end points to keep connectivity. Fixes https://gitlab.com/kicad/code/kicad/-/issues/7967
2021-03-31 20:13:08 +00:00
Move zone fracture display mode to AdvancedCfg, and add triangulation. Fixes https://gitlab.com/kicad/code/kicad/issues/8762
2021-07-26 17:56:11 +00:00
configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::ExtraZoneDisplayModes,
Coding policy and Doxygen comment fixes.
2023-12-18 13:32:41 +00:00
&m_ExtraZoneDisplayModes,
m_ExtraZoneDisplayModes ) );
Move zone fracture display mode to AdvancedCfg, and add triangulation. Fixes https://gitlab.com/kicad/code/kicad/issues/8762
2021-07-26 17:56:11 +00:00
Adding triangulation viewing to AC This adds a helper routine to visualize the quality of our triangulation. It also renames an excessively long variable name for the arc editor
2020-08-12 13:16:57 +00:00
configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::StrokeTriangulation,
Coding policy and Doxygen comment fixes.
2023-12-18 13:32:41 +00:00
&m_DrawTriangulationOutlines,
m_DrawTriangulationOutlines ) );
Pcbnew fix arc edition
2020-08-09 23:03:31 +00:00
Add a min pin width advanced config for plotting. Fixes https://gitlab.com/kicad/code/kicad/issues/5546
2020-09-08 19:18:50 +00:00
configParams.push_back( new PARAM_CFG_DOUBLE( true, AC_KEYS::MinPlotPenWidth,
Coding policy and Doxygen comment fixes.
2023-12-18 13:32:41 +00:00
&m_MinPlotPenWidth, m_MinPlotPenWidth,
0.0, 1.0 ) );
Add a min pin width advanced config for plotting. Fixes https://gitlab.com/kicad/code/kicad/issues/5546
2020-09-08 19:18:50 +00:00
Move DebugZoneFiller to advanced config. This will hopefully keep it from accidentally getting checked in again.
2020-09-23 09:35:13 +00:00
configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::DebugZoneFiller,
There is one source of truth in AC Don't store default values in two separate places. Passes the existing by value as the default. Issue identified by @axemagn Fixes https://gitlab.com/kicad/code/kicad/issues/10221
2022-01-28 21:31:16 +00:00
&m_DebugZoneFiller, m_DebugZoneFiller ) );
Move DebugZoneFiller to advanced config. This will hopefully keep it from accidentally getting checked in again.
2020-09-23 09:35:13 +00:00
Add PDFWriter debug mode (ie: uncompressed output). Fixes https://gitlab.com/kicad/code/kicad/issues/5593
2020-11-06 10:32:14 +00:00
configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::DebugPDFWriter,
There is one source of truth in AC Don't store default values in two separate places. Passes the existing by value as the default. Issue identified by @axemagn Fixes https://gitlab.com/kicad/code/kicad/issues/10221
2022-01-28 21:31:16 +00:00
&m_DebugPDFWriter, m_DebugPDFWriter ) );
Add PDFWriter debug mode (ie: uncompressed output). Fixes https://gitlab.com/kicad/code/kicad/issues/5593
2020-11-06 10:32:14 +00:00
Make small drill marks size configurable via advanced config for both printing and plotting Fixes https://gitlab.com/kicad/code/kicad/-/issues/1972
2021-01-04 22:26:23 +00:00
configParams.push_back( new PARAM_CFG_DOUBLE( true, AC_KEYS::SmallDrillMarkSize,
Coding policy and Doxygen comment fixes.
2023-12-18 13:32:41 +00:00
&m_SmallDrillMarkSize, m_SmallDrillMarkSize,
0.0, 3.0 ) );
Add advance config variable to skip bounding box loading on footprints
2020-10-03 01:58:24 +00:00
Add a helper to generate action documentation
2021-02-20 18:41:42 +00:00
configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::HotkeysDumper,
There is one source of truth in AC Don't store default values in two separate places. Passes the existing by value as the default. Issue identified by @axemagn Fixes https://gitlab.com/kicad/code/kicad/issues/10221
2022-01-28 21:31:16 +00:00
&m_HotkeysDumper, m_HotkeysDumper ) );
Add a helper to generate action documentation
2021-02-20 18:41:42 +00:00
Tighten up schematic label bounding boxes Margins were being added in more places than necessary Fixes https://gitlab.com/kicad/code/kicad/-/issues/7689
2021-02-24 22:14:39 +00:00
configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::DrawBoundingBoxes,
There is one source of truth in AC Don't store default values in two separate places. Passes the existing by value as the default. Issue identified by @axemagn Fixes https://gitlab.com/kicad/code/kicad/issues/10221
2022-01-28 21:31:16 +00:00
&m_DrawBoundingBoxes, m_DrawBoundingBoxes ) );
Tighten up schematic label bounding boxes Margins were being added in more places than necessary Fixes https://gitlab.com/kicad/code/kicad/-/issues/7689
2021-02-24 22:14:39 +00:00
Pcbnew: add write board netlist to file support. This is hidden behind an advanced configuration setting and is primarily useful for developers trying to troubleshoot the netlist payload sent from the board editor to the schematic editor. Fixes https://gitlab.com/kicad/code/kicad/issues/8051
2021-03-28 12:37:54 +00:00
configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::ShowPcbnewExportNetlist,
Coding policy and Doxygen comment fixes.
2023-12-18 13:32:41 +00:00
&m_ShowPcbnewExportNetlist,
m_ShowPcbnewExportNetlist ) );
Pcbnew: add write board netlist to file support. This is hidden behind an advanced configuration setting and is primarily useful for developers trying to troubleshoot the netlist payload sent from the board editor to the schematic editor. Fixes https://gitlab.com/kicad/code/kicad/issues/8051
2021-03-28 12:37:54 +00:00
Add advanced cfg to force reloading memory cached 3d models
2021-07-11 04:35:38 +00:00
configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::Skip3DModelFileCache,
There is one source of truth in AC Don't store default values in two separate places. Passes the existing by value as the default. Issue identified by @axemagn Fixes https://gitlab.com/kicad/code/kicad/issues/10221
2022-01-28 21:31:16 +00:00
&m_Skip3DModelFileCache, m_Skip3DModelFileCache ) );
Add ADVANCED_CFG to skip caching 3d models to file
2021-07-11 03:59:54 +00:00
Add advanced cfg to force reloading memory cached 3d models
2021-07-11 04:35:38 +00:00
configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::Skip3DModelMemoryCache,
There is one source of truth in AC Don't store default values in two separate places. Passes the existing by value as the default. Issue identified by @axemagn Fixes https://gitlab.com/kicad/code/kicad/issues/10221
2022-01-28 21:31:16 +00:00
&m_Skip3DModelMemoryCache, m_Skip3DModelMemoryCache ) );
Add ADVANCED_CFG to always reload cached 3d models in memory
2021-07-11 04:31:06 +00:00
Allow hiding version from manager title bar with advanced config
2021-07-14 22:24:21 +00:00
configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::HideVersionFromTitle,
There is one source of truth in AC Don't store default values in two separate places. Passes the existing by value as the default. Issue identified by @axemagn Fixes https://gitlab.com/kicad/code/kicad/issues/10221
2022-01-28 21:31:16 +00:00
&m_HideVersionFromTitle, m_HideVersionFromTitle ) );
Allow hiding version from manager title bar with advanced config
2021-07-14 22:24:21 +00:00
Put Repair Schematic behind Advanced Config.
2021-11-25 12:16:42 +00:00
configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::ShowRepairSchematic,
There is one source of truth in AC Don't store default values in two separate places. Passes the existing by value as the default. Issue identified by @axemagn Fixes https://gitlab.com/kicad/code/kicad/issues/10221
2022-01-28 21:31:16 +00:00
&m_ShowRepairSchematic, m_ShowRepairSchematic ) );
Put Repair Schematic behind Advanced Config.
2021-11-25 12:16:42 +00:00
Add profile counters for PCB mouse and paint events
2021-12-05 20:15:18 +00:00
configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::ShowEventCounters,
There is one source of truth in AC Don't store default values in two separate places. Passes the existing by value as the default. Issue identified by @axemagn Fixes https://gitlab.com/kicad/code/kicad/issues/10221
2022-01-28 21:31:16 +00:00
&m_ShowEventCounters, m_ShowEventCounters ) );
Add profile counters for PCB mouse and paint events
2021-12-05 20:15:18 +00:00
Remove manual canvas scale from GTK Fixes https://gitlab.com/kicad/code/kicad/-/issues/9912
2021-12-09 23:36:44 +00:00
configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::AllowManualCanvasScale,
Coding policy and Doxygen comment fixes.
2023-12-18 13:32:41 +00:00
&m_AllowManualCanvasScale,
m_AllowManualCanvasScale ) );
Remove manual canvas scale from GTK Fixes https://gitlab.com/kicad/code/kicad/-/issues/9912
2021-12-09 23:36:44 +00:00
3D-Viewer, raytracing: implement bevel edges on item layers
2022-05-15 08:38:46 +00:00
configParams.push_back( new PARAM_CFG_INT( true, AC_KEYS::V3DRT_BevelHeight_um,
&m_3DRT_BevelHeight_um, m_3DRT_BevelHeight_um,
0, std::numeric_limits<int>::max(),
AC_GROUPS::V3D_RayTracing ) );
configParams.push_back( new PARAM_CFG_DOUBLE( true, AC_KEYS::V3DRT_BevelExtentFactor,
Coding policy and Doxygen comment fixes.
2023-12-18 13:32:41 +00:00
&m_3DRT_BevelExtentFactor,
m_3DRT_BevelExtentFactor, 0.0, 100.0,
3D-Viewer, raytracing: implement bevel edges on item layers
2022-05-15 08:38:46 +00:00
AC_GROUPS::V3D_RayTracing ) );
Add Clipper2 Currently this lives behind the advanced config flag `UseClipper2`. Enabling this flag will route all Clipper-based calls through the Clipper2 library instead of the older Clipper. The changes should be mostly transparent. Of note, Clipper2 does not utilize the `STRICTLY_SIMPLE` flag because clipper1 did not actually guarantee a strictly simple polygon. Currently we ignore this flag but we may decide to run strictly-simple operations through a second NULL union to simplify the results as much as possible. Additionally, the inflation options are slightly different. We cannot choose the fallback miter. The fallback miter is always square. This only affects the CHAMFER_ACUTE_CORNERS option in inflate, which does not appear to be used. Lastly, we currently utilize the 64-bit integer coordinates for calculations. This appears to still be faster than 32-bit calculations in Clipper1 on a modern x86 system. This may not be the case for older systems, particularly 32-bit systems.
2022-10-19 23:25:45 +00:00
configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::UseClipper2,
&m_UseClipper2, m_UseClipper2 ) );
Move Spacemouse to advanced config The spacemouse driver, particularly on Mac, is extremely unstable and causes crashes even when not being used. This places the interface behind an advanced config flag to ensure that users can affirmatively opt-in to the potential for crashes
2023-04-07 17:08:43 +00:00
configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::Use3DConnexionDriver,
&m_Use3DConnexionDriver, m_Use3DConnexionDriver ) );
Add ability to update subgraphs based on changeset Previously, almost all connectivity updates were full updates, meaning that the entire connectivity graph would be rebuilt each time a change was made to the schematic. This update modifies the update to only correct the subgraphs that are directly affected by the change. It uses the existing connection graph to find all affected subgraphs as well as connections to the changes based on the visible schematic. These elements are removed from the existing connectivity graph and marked dirty. They then have a new connectivity graph built only around their changes. The resulting graph is merged into the original. Currently, this ability is behind an advanced config flag `IncrementalConnectivity` while testing. Fixes https://gitlab.com/kicad/code/kicad/issues/10846 Fixes https://gitlab.com/kicad/code/kicad/issues/1794
2023-04-08 15:22:34 +00:00
configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::IncrementalConnectivity,
Coding policy and Doxygen comment fixes.
2023-12-18 13:32:41 +00:00
&m_IncrementalConnectivity,
m_IncrementalConnectivity ) );
Add ability to update subgraphs based on changeset Previously, almost all connectivity updates were full updates, meaning that the entire connectivity graph would be rebuilt each time a change was made to the schematic. This update modifies the update to only correct the subgraphs that are directly affected by the change. It uses the existing connection graph to find all affected subgraphs as well as connections to the changes based on the visible schematic. These elements are removed from the existing connectivity graph and marked dirty. They then have a new connectivity graph built only around their changes. The resulting graph is merged into the original. Currently, this ability is behind an advanced config flag `IncrementalConnectivity` while testing. Fixes https://gitlab.com/kicad/code/kicad/issues/10846 Fixes https://gitlab.com/kicad/code/kicad/issues/1794
2023-04-08 15:22:34 +00:00
Allow disambiguation menu configurability Adds an advanced config flag to all testing different values for different users. Related to https://gitlab.com/kicad/code/kicad/-/issues/15128
2023-09-24 23:33:05 +00:00
configParams.push_back( new PARAM_CFG_INT( true, AC_KEYS::DisambiguationTime,
Coding policy and Doxygen comment fixes.
2023-12-18 13:32:41 +00:00
&m_DisambiguationMenuDelay,
m_DisambiguationMenuDelay,
50, 10000 ) );
Allow disambiguation menu configurability Adds an advanced config flag to all testing different values for different users. Related to https://gitlab.com/kicad/code/kicad/-/issues/15128
2023-09-24 23:33:05 +00:00
Use advanced_config key EnableGenerators to enable menu entries for generators.
2023-10-07 16:18:21 +00:00
configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::EnableGenerators,
&m_EnableGenerators, m_EnableGenerators ) );
ADDED: Git integration support Adds support for project-based git integration, branch support, commit, revert and updates Fixes https://gitlab.com/kicad/code/kicad/issues/10441
2023-09-14 21:39:42 +00:00
configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::EnableGit,
&m_EnableGit, m_EnableGit ) );
ADDED: library tree context menu option to open sym/fp library files from the defined text editor. Short description: Works for Symbol and Footprint Editor behind an advanced config option. For Symbol Editor it is shown for a single item selection (library or symbol). For Footprint Editor it is shown for a footprint selection. (fp editor allows a single tree item selection only). Option stays hidden if current frame has been modified. Also small fix(?) for similar action to the project manager. (Call for the Execution has moved inside the file loop.) Fixes: https://gitlab.com/kicad/code/kicad/-/issues/15736
2024-02-29 19:01:59 +00:00
configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::EnableLibWithText,
&m_EnableLibWithText, m_EnableLibWithText ) );
Eeschema: Add Cairo printing to the Eeschema print engine. The current print engine (using wxDC draw engine) has frequently issues with each new wxWidgets version. Cairo printing engine, used for Pcbnew and Gerbview has less issues. On Eeschema, the cairo print is enabled only if the advanced config has the option "EnableEeschemaPrintCairo = 1"
2023-11-23 13:29:07 +00:00
configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::EnableEeschemaPrintCairo,
Coding policy and Doxygen comment fixes.
2023-12-18 13:32:41 +00:00
&m_EnableEeschemaPrintCairo,
m_EnableEeschemaPrintCairo ) );
Added IPC2581 support IPC2581 is a modern production file exchange system. It provides single-file data output for an entire board including BOM and netlist information. Fixes https://gitlab.com/kicad/code/kicad/-/issues/1954
2023-06-12 18:12:39 +00:00
Fix obscured object selection issue in board and footprint editors. This selection improvement feature is hidden behind the advanced configuration key "PcbSelectionVisibilityRatio". It is turned off (1.0) by default. Value values are from 0.0 to less that 1.0. From testing, using a value between 0.1 and 0.3 produces the best results. This fix uses normal alpha blending described in the link below. The current design only uses the alpha of the object's color. It could be improved by doing a full color alpha blending but using the color alpha alone seems to result in satisfactory results. https://en.wikipedia.org/wiki/Alpha_compositing Fixes https://gitlab.com/kicad/code/kicad/-/issues/16126
2023-12-17 21:43:35 +00:00
configParams.push_back( new PARAM_CFG_DOUBLE( true, AC_KEYS::PcbSelectionVisibilityRatio,
&m_PcbSelectionVisibilityRatio,
m_PcbSelectionVisibilityRatio, 0.0, 1.0 ) );
Make outline font min segment length configurable This was hard coded at 10IU, which was way too small for pcbnew and still too small for schematic editor. Instead, we set a default of 50 and allow the user to adjust (smaller for less powerful machines) Fixes https://gitlab.com/kicad/code/kicad/-/issues/16568
2024-01-12 02:26:42 +00:00
configParams.push_back( new PARAM_CFG_INT( true, AC_KEYS::MinimumSegmentLength,
&m_MinimumSegmentLength,
m_MinimumSegmentLength, 10, 1000 ) );
kicad_advanced: Make OCE tesselation deflection configurable Fixes https://gitlab.com/kicad/code/kicad/-/issues/17168
2024-02-29 19:04:39 +00:00
configParams.push_back( new PARAM_CFG_DOUBLE( true, AC_KEYS::OcePluginLinearDeflection,
&m_OcePluginLinearDeflection,
m_OcePluginLinearDeflection, 0.01, 1.0 ) );
configParams.push_back( new PARAM_CFG_DOUBLE( true, AC_KEYS::OcePluginAngularDeflection,
&m_OcePluginAngularDeflection,
m_OcePluginAngularDeflection, 0.01, 360.0 ) );
Update triangulation
2024-03-20 22:47:44 +00:00
configParams.push_back( new PARAM_CFG_INT( true, AC_KEYS::TriangulateSimplificationLevel,
&m_TriangulateSimplificationLevel,
m_TriangulateSimplificationLevel, 0, 1000 ) );
Add logging and area check to tesselation Logging is useful when we find an area that cannot be triangulated. This will be used to generated test cases. Skipping minor untesselated areas means that the polygon will still be considered fully tesselated (and not sent back again and again) even if the tesselation misses an area less than the configured limit. Currently, this is 31^2nm.
2024-03-21 01:00:42 +00:00
configParams.push_back( new PARAM_CFG_INT( true, AC_KEYS::TriangulateMinimumArea,
&m_TriangulateMinimumArea,
m_TriangulateMinimumArea, 0, 100000 ) );
Improve SHAPE_POLY_SET fracture performance Refactors `SHAPE_POLY_SET::fractureSingle()` to be more efficient, while not changing the actual algorithm: * increase cache locality by using contiguous arrays instead of what was effectively a linked list * reduce latency and jitter by replacing per-edge allocator calls with ahead-of-time std::vector reserves * increase cache efficiency by making the vertex struct smaller * replace O(n^2) leftmost edge search with O(n log n) std::sort * sort the polygons instead of the edges * cut iteration count in half in the remaining O(polygons * edges) part
2024-03-25 23:50:26 +00:00
configParams.push_back( new PARAM_CFG_BOOL( true, AC_KEYS::EnableCacheFriendlyFracture,
&m_EnableCacheFriendlyFracture,
m_EnableCacheFriendlyFracture ) );
Add (optional) trace mask setting as advanced config option Maximize laziness! This does not affect the environment variable usage
2021-10-08 01:04:51 +00:00
// Special case for trace mask setting...we just grab them and set them immediately
// Because we even use wxLogTrace inside of advanced config
wxS more things
2023-01-22 14:41:33 +00:00
wxString traceMasks;
Coding policy and Doxygen comment fixes.
2023-12-18 13:32:41 +00:00
configParams.push_back( new PARAM_CFG_WXSTRING( true, AC_KEYS::TraceMasks, &traceMasks,
wxS( "" ) ) );
Add (optional) trace mask setting as advanced config option Maximize laziness! This does not affect the environment variable usage
2021-10-08 01:04:51 +00:00
// Load the config from file
Run-time config for advanced options This can be used for "advanced" options which are for developers to use for feature-flags and other configuration. Run time config has some advantages over preprocessor defines: * Can be changed without recompilation * Sensitive to XDG_CONFIG_DIR, so flipping configs is easy * Better compiler coverage (less conditionally compiled code means less chance to break a different configuration). Also better analysis coverage. * Type safe config params * Centralised documentation: it's in doxygen, in one place No advanced config should be required by a general users. If a general user does use one of these configs, it's probably because: * There is a bug and one of these configs is a workaround * A config in here is generally useful and should be moved into the relevant application config and given UI. For now, the config is read-only, and is read from the "kicad_advanced" config file in the normal config dir.
2018-12-10 10:56:28 +00:00
wxConfigLoadSetups( &aCfg, configParams );
Add (optional) trace mask setting as advanced config option Maximize laziness! This does not affect the environment variable usage
2021-10-08 01:04:51 +00:00
// Now actually set the trace masks
wxS more things
2023-01-22 14:41:33 +00:00
wxStringTokenizer traceMaskTokenizer( traceMasks, wxS( "," ) );
Remove manual canvas scale from GTK Fixes https://gitlab.com/kicad/code/kicad/-/issues/9912
2021-12-09 23:36:44 +00:00
Add (optional) trace mask setting as advanced config option Maximize laziness! This does not affect the environment variable usage
2021-10-08 01:04:51 +00:00
while( traceMaskTokenizer.HasMoreTokens() )
{
wxString mask = traceMaskTokenizer.GetNextToken();
wxLog::AddTraceMask( mask );
}
Pcbnew: add write board netlist to file support. This is hidden behind an advanced configuration setting and is primarily useful for developers trying to troubleshoot the netlist payload sent from the board editor to the schematic editor. Fixes https://gitlab.com/kicad/code/kicad/issues/8051
2021-03-28 12:37:54 +00:00
dumpCfg( configParams );
ADDED holeWallPlatingThickness to AdvancedCfg. Used for zone filling and DRC hole collision testing. Allows us to calculate the actual hole size from the finish hole size. Fixes https://gitlab.com/kicad/code/kicad/issues/5468
2020-09-03 14:58:49 +00:00
for( PARAM_CFG* param : configParams )
Free some memory that asan was complaining about
2020-02-28 03:58:33 +00:00
delete param;
Add coroutine stack size to trace output
2024-02-02 11:00:08 +00:00
wxLogTrace( kicadTraceCoroutineStack, wxT( "Using coroutine stack size %d" ), m_CoroutineStackSize );
Disable legacy canvas on GTK3 This make the use of legacy canvas on GTK3 a default-off advanced config. Legacy is substantially broken on GTK3 and is of basically no use at all to general users on this platform. If the program starts with legacy canvas in the config, it is forced into a GAL mode, as otherwise it could happen that the user is stuck and unable to get into pcbnew to change the setting. Fixes: lp:1803156 * https://bugs.launchpad.net/kicad/+bug/1803156
2018-12-12 14:16:50 +00:00
}