kicad/include/advanced_config.h

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2019-2022 KiCad Developers, see AUTHORS.txt for contributors.
 *
 * 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
 */

#ifndef ADVANCED_CFG__H
#define ADVANCED_CFG__H

class wxConfigBase;

/**
 * Class containing "advanced" configuration options.
 *
 * Options set here are for developer or advanced users only. If a general user
 * needs to set one of these for normal KiCad use, either:
 * * They are working around some bug that should be fixed, or
 * * The parameter they are setting is of general interest and should be in the
 *   main application config, with UI provided.
 *
 * Options in this class are, in general, preferable to #defines, as they
 * allow more flexible configuration by developers, and don't hide code from
 * the compiler on other configurations, which can result in broken builds.
 *
 * Never use advanced configs in an untestable way. If a function depends on
 * advanced config such that you cannot test it without changing the config,
 * "lift" the config to a higher level and make pass it as parameter of the code
 * under test. The tests can pass their own values as needed.
 *
 * This also applies to code that does not depend on "common" - it cannot
 * use this class, so you must pass configuration in as proper parameters.
 *
 * Sometimes you can just use values directly, and sometimes helper functions
 * might be provided to allow extra logic (for example when a advanced config
 * applies only on certain platforms).
 *
 * For more information on what config keys set these parameters in the
 * config files, and why you might want to set them, see #AC_KEYS
 *
 */
class ADVANCED_CFG
{
public:
    /**
     * Get the singleton instance's config, which is shared by all consumers.
     *
     * This configuration is read-only - to set options, users should add the parameters to
     * their config files at ~/.config/kicad/advanced, or the platform equivalent.
     */
    static const ADVANCED_CFG& GetCfg();

    /**
     * Distance from an arc end point and the estimated end point, when rotating from the
     * start point to the end point.
     */
    double m_DrawArcAccuracy;

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

    /**
     * Maximum angle between the tangent line of an arc track and a connected straight track
     * in order to commence arc dragging. Units are degrees.
     */
    double m_MaxTangentAngleDeviation;

    /**
     * Maximum track length to keep after doing an arc track resizing operation. Units are mm.
     */
    double m_MaxTrackLengthToKeep;

    /**
     * Extra fill clearance for zone fills.  Note that for zone tests this is essentially
     * additive with m_DRCEpsilon.  Units are mm.
     */
    double m_ExtraClearance;

    /**
     * Epsilon for DRC tests.  Note that for zone tests this is essentially additive with
     * m_ExtraClearance.  Units are mm.
     */
    double m_DRCEpsilon;

    /**
     * Sliver tolerances for DRC.  Units are mm and deg.
     */
    double m_SliverWidthTolerance;
    double m_SliverAngleTolerance;

    /**
     * Hole wall plating thickness.  Used to determine actual hole size from finish hole size.
     * Units are mm.
     */
    double m_HoleWallThickness;

    /**
     * Do real-time connectivity
     */
    bool m_RealTimeConnectivity;

    /**
     * Set the stack size for coroutines
     */
    int m_CoroutineStackSize;

    /**
     * The update interval the wxWidgets sends wxUpdateUIEvents to windows.
     *
     * The default is 0.  Setting this to -1 will disable all automatic UI events.  Any other
     * value is the number of milliseconds between events.
     *
     * @see https://docs.wxwidgets.org/3.0/classwx_update_u_i_event.html#a24daac56f682b866baac592e761ccede.
     */
    int m_UpdateUIEventInterval;

    /**
     * Show PNS router debug graphics
     */
    bool m_ShowRouterDebugGraphics;

    /**
     * Save files in compact display mode
     * When is is not specified, points are written one per line
     */
    bool m_CompactSave;

    /**
     * When true, strokes the triangulations with visible color
     */
    bool m_DrawTriangulationOutlines;

    /**
     * When true, adds zone-diaplay-modes for stroking the zone fracture boundaries and the zone
     * triangulation.
     */
    bool m_ExtraZoneDisplayModes;

    /**
     * Sets an absolute minimum pen width for plotting.  Some formats (PDF, for example) don't
     * like ultra-thin lines.  Units are mm.
     */
    double m_MinPlotPenWidth;

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

    /**
     * A mode that writes PDFs without compression.
     */
    bool m_DebugPDFWriter;

    /**
     * The diameter of the drill marks on print and plot outputs (in mm),
     * when the "Drill marks" option is set to "Small mark"
     */
    double m_SmallDrillMarkSize;

    /**
     * Enable the hotkeys dumper feature, used for generating documentation
     */
    bool m_HotkeysDumper;

    /**
     * Draw GAL bounding boxes in painters
     */
    bool m_DrawBoundingBoxes;

    /**
     * Enable exporting board editor netlist to a file for troubleshooting purposes.
     */
    bool m_ShowPcbnewExportNetlist;

    /**
     * Skip reading/writing 3d model file caches
     * This does not prevent the models from being cached in memory meaning reopening the 3d viewer
     * in the same project session will not reload model data from disk again.
     */
    bool m_Skip3DModelFileCache;

    /**
     * Skip reading/writing 3d model memory caches
     * This ensures 3d models are always reloaded from disk even if we previously opened the 3d viewer.
     */
    bool m_Skip3DModelMemoryCache;

    /**
     * Hides the build version from the KiCad manager frame title.
     * Useful for making screenshots/videos of KiCad without pinning to a specific version.
     */
    bool m_HideVersionFromTitle;

    bool m_ShowRepairSchematic;

    /**
     * Shows debugging event counters in various places.
     */
    bool m_ShowEventCounters;

    bool m_AllowManualCanvasScale;

    /**
     * Show the properties panel in PcbNew
     */
    bool m_ShowPropertiesPanel;

    /**
     * 3D-Viewer, Raytracing
     * Bevel height of layer items. Controls the start of curvature normal on the edge.
     * Value is in micrometre. Good values should be arround or less than the copper thickness.
     */
    int m_3DRT_BevelHeight_um;

    /**
     * 3D-Viewer, Raytracing
     * Factor applied to Extent.z of the item layer, used on calculation of the bevel's height.
     */
    double m_3DRT_BevelExtentFactor;

    /**
     * User Clipper2 instead of Clipper1
     */
    bool m_UseClipper2;


private:
    ADVANCED_CFG();

    /**
     * Load the config from the normal config file
     */
    void loadFromConfigFile();

    /*
     * Load config from the given config base
     */
    void loadSettings( wxConfigBase& aCfg );
};

#endif // ADVANCED_CFG__H