board.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2007 Jean-Pierre Charras, [email protected]
 * Copyright The 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, see <https://www.gnu.org/licenses/>.
 */
 
#ifndef CLASS_BOARD_H_
#define CLASS_BOARD_H_
 
#include <atomic>
#include <functional>
#include <board_item_container.h>
#include <board_stackup_manager/board_stackup.h>
#include <core/mirror.h>
#include <drill/drill_chart_model.h>
#include <drill/drill_symbol_assigner.h>
#include <drill/drill_symbol_profile.h>
#include <embedded_files.h>
#include <convert_shape_list_to_polygon.h> // for OUTLINE_ERROR_HANDLER
#include <geometry/shape_poly_set.h>
#include <hash.h>
#include <layer_ids.h>
#include <lset.h>
#include <netinfo.h>
#include <pcb_item_containers.h>
#include <pcb_plot_params.h>
#include <title_block.h>
#include <zone_settings.h>
#include <shared_mutex>
#include <sharded_cache.h>
#include <unordered_set>
#include <project.h>
#include <list>
 
struct HISTORY_FILE_DATA;
class BOARD_DESIGN_SETTINGS;
class BOARD_CONNECTED_ITEM;
class BOARD_COMMIT;
class COMPONENT_CLASS_MANAGER;
class DRC_RTREE;
class PCB_BASE_FRAME;
class PCB_EDIT_FRAME;
class PICKED_ITEMS_LIST;
class LENGTH_DELAY_CALCULATION;
class BOARD;
class FOOTPRINT;
class FOOTPRINT_COURTYARD_INDEX;
class ZONE;
class PCB_TRACK;
class PCB_VIA;
class PAD;
class PCB_DRILL_MAP;
class PCB_GROUP;
class PCB_GENERATOR;
class PCB_MARKER;
class MSG_PANEL_ITEM;
class NETLIST;
class REPORTER;
class CONNECTIVITY_DATA;
class COMPONENT;
class PROJECT;
class PROGRESS_REPORTER;
class PCB_BOARD_OUTLINE;
 
namespace KIGFX
{
class RENDER_SETTINGS;
};
 
 
namespace KIFONT
{
    class OUTLINE_FONT;
}
 
struct ISOLATED_ISLANDS;
 
// The default value for m_outlinesChainingEpsilon to convert a board outlines to polygons
// It is the max dist between 2 end points to see them connected
#define DEFAULT_CHAINING_EPSILON_MM 0.01
 
// Forward declare endpoint from class_track.h
enum ENDPOINT_T : int;
 
 
struct PTR_PTR_CACHE_KEY
{
    BOARD_ITEM*  A;
    BOARD_ITEM*  B;
 
    bool operator==(const PTR_PTR_CACHE_KEY& other) const
    {
        return A == other.A && B == other.B;
    }
};
 
struct PTR_LAYER_CACHE_KEY
{
    BOARD_ITEM*  A;
    PCB_LAYER_ID Layer;
 
    bool operator==(const PTR_LAYER_CACHE_KEY& other) const
    {
        return A == other.A && Layer == other.Layer;
    }
};
 
struct PTR_PTR_LAYER_CACHE_KEY
{
    BOARD_ITEM*  A;
    BOARD_ITEM*  B;
    PCB_LAYER_ID Layer;
 
    bool operator==(const PTR_PTR_LAYER_CACHE_KEY& other) const
    {
        return A == other.A && B == other.B && Layer == other.Layer;
    }
};
 
// Caches the whole-predicate result of a footprint-selector query (e.g. intersectsCourtyard)
// for one item, so a rule set that repeats the same condition does not re-scan every footprint.
struct ITEM_SELECTOR_LAYER_CACHE_KEY
{
    const BOARD_ITEM* A;
    wxString          Selector;     // the selector argument string, compared verbatim
    PCB_LAYER_ID      Layer;
    int               Constraint;   // some predicates (intersectsArea) branch on the constraint
 
    bool operator==( const ITEM_SELECTOR_LAYER_CACHE_KEY& other ) const
    {
        return A == other.A && Selector == other.Selector && Layer == other.Layer
               && Constraint == other.Constraint;
    }
};
 
// Caches getField('x') text per (item, field name)
struct ITEM_FIELD_CACHE_KEY
{
    const BOARD_ITEM* A;
    std::size_t       FieldHash;
 
    bool operator==( const ITEM_FIELD_CACHE_KEY& other ) const
    {
        return A == other.A && FieldHash == other.FieldHash;
    }
};
 
struct LAYERS_CHECKED
{
    LAYERS_CHECKED() :
            layers(),
            has_error( false )
    {}
 
    LAYERS_CHECKED( PCB_LAYER_ID aLayer ) :
            layers( { aLayer } ),
            has_error( false )
    {}
 
    LSET layers;
    bool has_error;
};
 
 
namespace std
{
    template <>
    struct hash<PTR_PTR_CACHE_KEY>
    {
        std::size_t operator()( const PTR_PTR_CACHE_KEY& k ) const
        {
            std::size_t seed = 0xa82de1c0;
            hash_combine( seed, k.A, k.B );
            return seed;
        }
    };
 
    template <>
    struct hash<PTR_LAYER_CACHE_KEY>
    {
        std::size_t operator()( const PTR_LAYER_CACHE_KEY& k ) const
        {
            std::size_t seed = 0xa82de1c0;
            hash_combine( seed, k.A, k.Layer );
            return seed;
        }
    };
 
    template <>
    struct hash<PTR_PTR_LAYER_CACHE_KEY>
    {
        std::size_t operator()( const PTR_PTR_LAYER_CACHE_KEY& k ) const
        {
            std::size_t seed = 0xa82de1c0;
            hash_combine( seed, k.A, k.B, k.Layer );
            return seed;
        }
    };
 
    template <>
    struct hash<ITEM_SELECTOR_LAYER_CACHE_KEY>
    {
        std::size_t operator()( const ITEM_SELECTOR_LAYER_CACHE_KEY& k ) const
        {
            std::size_t seed = 0xa82de1c0;
            hash_combine( seed, k.A, k.Selector, k.Layer, k.Constraint );
            return seed;
        }
    };
 
    template <>
    struct hash<ITEM_FIELD_CACHE_KEY>
    {
        std::size_t operator()( const ITEM_FIELD_CACHE_KEY& k ) const
        {
            std::size_t seed = 0xa82de1c0;
            hash_combine( seed, k.A, k.FieldHash );
            return seed;
        }
    };
}
 

enum LAYER_T
{
    LT_UNDEFINED = -1,
    LT_SIGNAL,
    LT_POWER,
    LT_MIXED,
    LT_JUMPER,
    LT_AUX,
    LT_FRONT,
    LT_BACK
};
 

struct LAYER
{
    LAYER()
    {
        clear();
    }
 
    void clear()
    {
        m_type    = LT_SIGNAL;
        m_visible = true;
        m_number  = 0;
        m_name.clear();
        m_userName.clear();
        m_opposite = m_number;
    }
 
    /*
    LAYER( const wxString& aName = wxEmptyString,
            LAYER_T aType = LT_SIGNAL, bool aVisible = true, int aNumber = -1 ) :
        m_name( aName ),
        m_type( aType ),
        m_visible( aVisible ),
        m_number( aNumber )
    {
    }
    */
 
    wxString    m_name;      
    wxString    m_userName;  
    LAYER_T     m_type;      
    bool        m_visible;
    int         m_number;    
    int         m_opposite;  

    static const char* ShowType( LAYER_T aType );

    static LAYER_T     ParseType( const char* aType );
};
 
 
// Helper class to handle high light nets
class HIGH_LIGHT_INFO
{
protected:
    std::set<int> m_netCodes;    // net(s) selected for highlight (-1 when no net selected )
    bool          m_highLightOn; // highlight active
 
    void Clear()
    {
        m_netCodes.clear();
        m_highLightOn = false;
    }
 
    HIGH_LIGHT_INFO()
    {
        Clear();
    }
 
private:
    friend class BOARD;
};

class BOARD;

struct DRILL_SYMBOL_CACHE
{
    std::map<std::string, DRILL_SYMBOL_ASSIGNMENT>  m_ByGroup;
    std::map<KIID, std::vector<DRILL_SYMBOL_ENTRY>> m_ByItem;

    DRILL_CHART_TOTALS m_Totals;

    BOX2I m_HoleExtent;
 
    uint64_t m_Generation = 0;
    uint64_t m_Profile = 0;
};
 
 
class BOARD_LISTENER
{
public:
    virtual ~BOARD_LISTENER() { }
    virtual void OnBoardItemAdded( BOARD& aBoard, BOARD_ITEM* aBoardItem ) { }
    virtual void OnBoardItemsAdded( BOARD& aBoard, std::vector<BOARD_ITEM*>& aBoardItems ) { }
    virtual void OnBoardItemRemoved( BOARD& aBoard, BOARD_ITEM* aBoardItem ) { }
    virtual void OnBoardItemsRemoved( BOARD& aBoard, std::vector<BOARD_ITEM*>& aBoardItems ) { }
    virtual void OnBoardNetSettingsChanged( BOARD& aBoard ) { }
    virtual void OnBoardItemChanged( BOARD& aBoard, BOARD_ITEM* aBoardItem ) { }
    virtual void OnBoardItemsChanged( BOARD& aBoard, std::vector<BOARD_ITEM*>& aBoardItems ) { }
    virtual void OnBoardSelectionChanged( BOARD& aBoard ) { }
    virtual void OnBoardHighlightNetChanged( BOARD& aBoard ) { }
    virtual void OnBoardRatsnestChanged( BOARD& aBoard ) { }
    virtual void OnBoardCompositeUpdate( BOARD& aBoard, std::vector<BOARD_ITEM*>& aAddedItems,
                                         std::vector<BOARD_ITEM*>& aRemovedItems,
                                         std::vector<BOARD_ITEM*>& aChangedItems )
    {
    }
};

typedef std::set<BOARD_ITEM*, CompareByUuid> BOARD_ITEM_SET;

enum class BOARD_USE
{
    NORMAL,     // A normal board
    FPHOLDER    // A board that holds a single footprint
};
 

class BOARD : public BOARD_ITEM_CONTAINER, public EMBEDDED_FILES, public PROJECT::_ELEM
{
public:
    static inline bool ClassOf( const EDA_ITEM* aItem )
    {
        return aItem && PCB_T == aItem->Type();
    }

    void SetBoardUse( BOARD_USE aUse ) { m_boardUse = aUse; }

    BOARD_USE GetBoardUse() const { return m_boardUse; }
 
    void IncrementTimeStamp();
 
    int GetTimeStamp() const { return m_timeStamp.load( std::memory_order_acquire ); }

    bool IsFootprintHolder() const
    {
        return m_boardUse == BOARD_USE::FPHOLDER;
    }
 
    PCB_LAYER_ID GetLayer() const override
    {
        wxFAIL_MSG( wxT( "BOARD::GetLayer() desn't have meaning.  Don't call it." ) );
        return UNDEFINED_LAYER;
    }
 
    void SetFileName( const wxString& aFileName ) { m_fileName = aFileName; }
 
    const wxString &GetFileName() const { return m_fileName; }

    wxString GetDesignRulesPath() const;
 
    const TRACKS& Tracks() const { return m_tracks; }
 
    const FOOTPRINTS& Footprints() const { return m_footprints; }
 
    const DRAWINGS& Drawings() const { return m_drawings; }
 
    const ZONES& Zones() const { return m_zones; }

    wxString GetUniqueZoneName( const wxString& aBaseName, const ZONE* aExclude = nullptr ) const;

    static wxString MakeUniqueZoneName( const wxString&                               aBaseName,
                                        const std::function<bool( const wxString& )>& aInUse );
 
    const GENERATORS& Generators() const { return m_generators; }
 
    PCB_BOARD_OUTLINE*       BoardOutline() { return m_boardOutline; }
    const PCB_BOARD_OUTLINE* BoardOutline() const { return m_boardOutline; }
    void                     UpdateBoardOutline();

    uint64_t GetBoardOutlineGeneration() const { return m_boardOutlineGeneration; }
 
    const MARKERS& Markers() const { return m_markers; }
 
    const PCB_POINTS& Points() const { return m_points; }

    const BOARD_ITEM_SET GetItemSet();

    const BOARD_ITEM_SET GetItemSet() const;

    const GROUPS& Groups() const { return m_groups; }

    const CONSTRAINTS& Constraints() const { return m_constraints; }
 
    const std::vector<BOARD_CONNECTED_ITEM*> AllConnectedItems();
 
    const std::map<wxString, wxString>& GetProperties() const { return m_properties; }
    void SetProperties( const std::map<wxString, wxString>& aProps ) { m_properties = aProps; }
 
    // Variant system
    wxString GetCurrentVariant() const { return m_currentVariant; }
    void SetCurrentVariant( const wxString& aVariant );
 
    const std::vector<wxString>& GetVariantNames() const { return m_variantNames; }
    void SetVariantNames( const std::vector<wxString>& aNames ) { m_variantNames = aNames; }
 
    bool HasVariant( const wxString& aVariantName ) const;
    void AddVariant( const wxString& aVariantName );
    void DeleteVariant( const wxString& aVariantName );
    void RenameVariant( const wxString& aOldName, const wxString& aNewName );
    void CopyVariant( const wxString& aOldName, const wxString& aNewName,
                      const wxString& aNewDescription = wxEmptyString );
 
    wxString GetVariantDescription( const wxString& aVariantName ) const;
    void SetVariantDescription( const wxString& aVariantName, const wxString& aDescription );

    wxArrayString GetVariantNamesForUI() const;
 
    void GetContextualTextVars( wxArrayString* aVars ) const;
    bool ResolveTextVar( wxString* token, int aDepth ) const;
    bool ResolveTextVar( wxString* token, const wxString& aVariantName, int aDepth ) const;

    LSET    m_LegacyVisibleLayers;
    GAL_SET m_LegacyVisibleItems;

    bool m_LegacyDesignSettingsLoaded;
    bool m_LegacyCopperEdgeClearanceLoaded;

    bool m_LegacyNetclassesLoaded;
 
    BOARD();
    ~BOARD();
 
    VECTOR2I       GetPosition() const override;
    void           SetPosition( const VECTOR2I& aPos ) override;
    const VECTOR2I GetFocusPosition() const override { return GetBoundingBox().GetCenter(); }
 
    bool IsEmpty() const;
 
    void Move( const VECTOR2I& aMoveVector ) override;
 
    void RunOnChildren( const std::function<void( BOARD_ITEM* )>& aFunction, RECURSE_MODE aMode ) const override;
 
    void SetFileFormatVersionAtLoad( int aVersion ) { m_fileFormatVersionAtLoad = aVersion; }
    int GetFileFormatVersionAtLoad() const { return m_fileFormatVersionAtLoad; }

    void BumpDrillModelGeneration();
 
    uint64_t GetDrillModelGeneration() const { return m_drillModelGeneration; }
 
    void bumpDrillModelFor( const std::vector<BOARD_ITEM*>& aItems );

    void noteDrillModelChange( BOARD_ITEM* aItem );

    const LSET& DrillSymbolLayers() const { return m_drillSymbolLayers; }
 
    void RefreshDrillSymbolLayers();

    std::shared_ptr<const DRILL_SYMBOL_CACHE> DrillSymbolCache() const;

    std::vector<const PCB_DRILL_MAP*> DrillMapsOnLayer( PCB_LAYER_ID aLayer ) const;

    BOX2I ExpandBoundingBoxForDrillSymbols( const BOX2I& aBoundingBox ) const;
 
    void SetGenerator( const wxString& aGenerator ) { m_generator = aGenerator; }
    const wxString& GetGenerator() const { return m_generator; }
 
    void Add( BOARD_ITEM* aItem, ADD_MODE aMode = ADD_MODE::INSERT,
              bool aSkipConnectivity = false ) override;

    void Remove( BOARD_ITEM* aBoardItem, REMOVE_MODE aMode = REMOVE_MODE::NORMAL ) override;

    void RemoveAll( std::initializer_list<KICAD_T> aTypes = { PCB_NETINFO_T, PCB_MARKER_T,
                                                              PCB_GROUP_T, PCB_ZONE_T,
                                                              PCB_GENERATOR_T, PCB_FOOTPRINT_T,
                                                              PCB_TRACE_T, PCB_SHAPE_T } );
 
    bool HasItemsOnLayer( PCB_LAYER_ID aLayer );

    bool RemoveAllItemsOnLayer( PCB_LAYER_ID aLayer );

    void BulkRemoveStaleTeardrops( BOARD_COMMIT& aCommit );

    void FinalizeBulkAdd( std::vector<BOARD_ITEM*>& aNewItems );

    void FinalizeBulkRemove( std::vector<BOARD_ITEM*>& aRemovedItems );

    void FixupEmbeddedData();
 
    void RunOnNestedEmbeddedFiles( const std::function<void( EMBEDDED_FILES* )>& aFunction ) override;
 
    void CacheTriangulation( PROGRESS_REPORTER* aReporter = nullptr,
                             const std::vector<ZONE*>& aZones = {} );

    FOOTPRINT* GetFirstFootprint() const
    {
        return m_footprints.empty() ? nullptr : m_footprints.front();
    }

    void DeleteAllFootprints();

    void DetachAllFootprints();

    BOARD_ITEM* ResolveItem( const KIID& aID, bool aAllowNullptrReturn = false ) const;

    void RebindItemUuid( BOARD_ITEM* aItem, const KIID& aNewId );

    int RepairDuplicateItemUuids();
 
    void FillItemMap( std::map<KIID, EDA_ITEM*>& aMap );

    wxString ConvertCrossReferencesToKIIDs( const wxString& aSource ) const;
    wxString ConvertKIIDsToCrossReferences( const wxString& aSource ) const;

    std::shared_ptr<CONNECTIVITY_DATA> GetConnectivity() const { return m_connectivity; }

    bool BuildConnectivity( PROGRESS_REPORTER* aReporter = nullptr );

    void DeleteMARKERs();
 
    void DeleteMARKERs( bool aWarningsAndErrors, bool aExclusions );
 
    PROJECT* GetProject() const { return m_project; }

    void SetProject( PROJECT* aProject, bool aReferenceOnly = false );
 
    void ClearProject();

    std::vector<PCB_MARKER*> ResolveDRCExclusions( bool aCreateMarkers );

    void RecordDRCExclusions();

    void UpdateRatsnestExclusions();

    void CompileRatsnest();

    void ExchangeFootprint( FOOTPRINT* aExisting, FOOTPRINT* aNew, BOARD_COMMIT& aCommit,
                            bool aMatchPadPositions,
                            bool aDeleteExtraTexts = true,
                            bool aResetTextLayers = true,
                            bool aResetTextEffects = true,
                            bool aResetTextPositions = true,
                            bool aResetTextContent = true,
                            bool aResetFabricationAttrs = true,
                            bool aResetClearanceOverrides = true,
                            bool aReset3DModels = true,
                            bool aResetTransform = false,
                            bool* aUpdated = nullptr, bool* aShifted = nullptr );

    void ResetNetHighLight();

    const std::set<int>& GetHighLightNetCodes() const
    {
        return m_highLight.m_netCodes;
    }

    void SetHighLightNet( int aNetCode, bool aMulti = false );

    bool IsHighLightNetON() const { return m_highLight.m_highLightOn; }

    void HighLightON( bool aValue = true );

    void HighLightOFF()
    {
        HighLightON( false );
    }

    int  GetCopperLayerCount() const;
    void SetCopperLayerCount( int aCount );
 
    int GetUserDefinedLayerCount() const;
    void SetUserDefinedLayerCount( int aCount );

    PCB_LAYER_ID  GetCopperLayerStackMaxId() const;
 
    PCB_LAYER_ID FlipLayer( PCB_LAYER_ID aLayer ) const;
 
    int LayerDepth( PCB_LAYER_ID aStartLayer, PCB_LAYER_ID aEndLayer ) const;

    const LSET& GetEnabledLayers() const;
    LSET GetLayerSet() const override { return GetEnabledLayers(); }

    void SetEnabledLayers( const LSET& aLayerMask );
    void SetLayerSet( const LSET& aLayerMask ) override { SetEnabledLayers( aLayerMask ); }

    bool IsLayerEnabled( PCB_LAYER_ID aLayer ) const;

    bool IsLayerVisible( PCB_LAYER_ID aLayer ) const;

    const LSET& GetVisibleLayers() const;

    void SetVisibleLayers( const LSET& aLayerMask );
 
    // these 2 functions are not tidy at this time, since there are PCB_LAYER_IDs that
    // are not stored in the bitmap.

    GAL_SET GetVisibleElements() const;

    void SetVisibleElements( const GAL_SET& aMask );

    void SetVisibleAlls();

    bool IsElementVisible( GAL_LAYER_ID aLayer ) const;

    void SetElementVisibility( GAL_LAYER_ID aLayer, bool aNewState );

    bool IsFootprintLayerVisible( PCB_LAYER_ID aLayer ) const;

    BOARD_DESIGN_SETTINGS& GetDesignSettings() const;
    void                   SetDesignSettings( const BOARD_DESIGN_SETTINGS& aSettings );

    void InvalidateClearanceCache( const KIID& aUuid );

    void InitializeClearanceCache();
 
    BOARD_STACKUP GetStackupOrDefault() const;
 
    const PAGE_INFO& GetPageSettings() const                { return m_paper; }
    void SetPageSettings( const PAGE_INFO& aPageSettings )  { m_paper = aPageSettings; }
 
    const PCB_PLOT_PARAMS& GetPlotOptions() const           { return m_plotOptions; }
    void SetPlotOptions( const PCB_PLOT_PARAMS& aOptions )  { m_plotOptions = aOptions; }
 
    TITLE_BLOCK& GetTitleBlock()                            { return m_titles; }
    const TITLE_BLOCK& GetTitleBlock() const                { return m_titles; }
    void SetTitleBlock( const TITLE_BLOCK& aTitleBlock )    { m_titles = aTitleBlock; }
 
    wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider, bool aFull ) const override;
 
    EDA_UNITS GetUserUnits()                                { return m_userUnits; }
    void SetUserUnits( EDA_UNITS aUnits )                   { m_userUnits = aUnits; }

    void UpdateUserUnits( BOARD_ITEM* aItem, KIGFX::VIEW* aView );

    bool GetBoardPolygonOutlines( SHAPE_POLY_SET& aOutlines, bool aInferOutlineIfNecessary,
                                  OUTLINE_ERROR_HANDLER* aErrorHandler = nullptr,
                                  bool aAllowUseArcsInPolygons = false, bool aIncludeNPTHAsOutlines = false );

    int GetOutlinesChainingEpsilon() { return( m_outlinesChainingEpsilon ); }
    void SetOutlinesChainingEpsilon( int aValue) { m_outlinesChainingEpsilon = aValue; }

    void ConvertBrdLayerToPolygonalContours( PCB_LAYER_ID aLayer, SHAPE_POLY_SET& aOutlines,
                                             KIGFX::RENDER_SETTINGS* aRenderSettings = nullptr ) const;

    PCB_LAYER_ID GetLayerID( const wxString& aLayerName ) const;

    const wxString GetLayerName( PCB_LAYER_ID aLayer ) const;

    bool SetLayerName( PCB_LAYER_ID aLayer, const wxString& aLayerName );

    static wxString GetStandardLayerName( PCB_LAYER_ID aLayerId )
    {
        // a BOARD's standard layer name is the PCB_LAYER_ID fixed name
        return LayerName( aLayerId );
    }

    bool SetLayerDescr( PCB_LAYER_ID aIndex, const LAYER& aLayer );

    bool IsFrontLayer( PCB_LAYER_ID aLayer ) const;

    bool IsBackLayer( PCB_LAYER_ID aLayer ) const;

    LAYER_T GetLayerType( PCB_LAYER_ID aLayer ) const;

    bool SetLayerType( PCB_LAYER_ID aLayer, LAYER_T aLayerType );

    unsigned GetNodesCount( int aNet = -1 ) const;

    const std::vector<PAD*> GetPads() const;
 
    void BuildListOfNets()
    {
        m_NetInfo.buildListOfNets();
    }

    NETINFO_ITEM* FindNet( int aNetcode ) const;

    NETINFO_ITEM* FindNet( const wxString& aNetname ) const;

    int MatchDpSuffix( const wxString& aNetName, wxString& aComplementNet );

    NETINFO_ITEM* DpCoupledNet( const NETINFO_ITEM* aNet );
 
    const NETINFO_LIST& GetNetInfo() const
    {
        return m_NetInfo;
    }
 
    void RemoveUnusedNets( BOARD_COMMIT* aCommit )
    {
        m_NetInfo.RemoveUnusedNets( aCommit );
    }

    bool RenameNets( const std::map<wxString, wxString>& aNewNames, REPORTER& aReporter )
    {
        return m_NetInfo.RenameNets( aNewNames, aReporter );
    }

    NETINFO_LIST::iterator BeginNets() const
    {
        return m_NetInfo.begin();
    }

    NETINFO_LIST::iterator EndNets() const
    {
        return m_NetInfo.end();
    }

    unsigned GetNetCount() const
    {
        return m_NetInfo.GetNetCount();
    }

    int GetPadWithPressFitAttrCount();

    int GetPadWithCastellatedAttrCount();

    BOX2I ComputeBoundingBox( bool aBoardEdgesOnly = false, bool aPhysicalLayersOnly = false ) const;
 
    const BOX2I GetBoundingBox() const override
    {
        return ComputeBoundingBox( false, false );
    }

    const BOX2I GetBoardEdgesBoundingBox() const
    {
        return ComputeBoundingBox( true, true );
    }
 
    void GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList ) override;

    INSPECT_RESULT Visit( INSPECTOR inspector, void* testData,
                          const std::vector<KICAD_T>& scanTypes ) override;

    FOOTPRINT* FindFootprintByReference( const wxString& aReference ) const;

    FOOTPRINT* FindFootprintByPath( const KIID_PATH& aPath ) const;
 
    PAD* FindPadByUuid( const KIID& aUuid ) const;
 
    void ReplaceNetChainTerminalPad( const wxString& aNetChain, const KIID& aPrev, const KIID& aNew );

    void SetNetChainColor( const wxString& aChain, const KIGFX::COLOR4D& aColor )
    {
        if( aColor == KIGFX::COLOR4D::UNSPECIFIED )
            m_netChainColors.erase( aChain );
        else
            m_netChainColors[aChain] = aColor;
    }
 
    KIGFX::COLOR4D GetNetChainColor( const wxString& aChain ) const
    {
        auto it = m_netChainColors.find( aChain );
        return it != m_netChainColors.end() ? it->second : KIGFX::COLOR4D::UNSPECIFIED;
    }
 
    const std::map<wxString, KIGFX::COLOR4D>& GetNetChainColors() const
    {
        return m_netChainColors;
    }

    std::set<wxString> GetNetClassAssignmentCandidates() const;

    void SynchronizeNetsAndNetClasses( bool aResetTrackAndViaSizes );

    void ApplyNetChainNetclasses();

    bool SynchronizeComponentClasses( const std::unordered_set<wxString>& aNewSheetPaths ) const;

    void SynchronizeProperties();

    void SynchronizeTuningProfileProperties();

    double Similarity( const BOARD_ITEM& aOther ) const override
    {
        return 1.0;
    }
 
    bool operator==( const BOARD_ITEM& aOther ) const override;
 
    wxString GetClass() const override
    {
        return wxT( "BOARD" );
    }
 
#if defined(DEBUG)
    void Show( int nestLevel, std::ostream& os ) const override { ShowDummy( os ); }
#endif
 
 
    /*************************/
    /* Copper Areas handling */
    /*************************/

    int SetAreasNetCodesFromNetNames();

    ZONE* GetArea( int index ) const
    {
        if( (unsigned) index < m_zones.size() )
            return m_zones[index];
 
        return nullptr;
    }

    std::list<ZONE*> GetZoneList( bool aIncludeZonesInFootprints = false ) const;

    int GetAreaCount() const
    {
        return static_cast<int>( m_zones.size() );
    }
 
    /* Functions used in test, merge and cut outlines */

    ZONE* AddArea( PICKED_ITEMS_LIST* aNewZonesList, int aNetcode, PCB_LAYER_ID aLayer,
                   VECTOR2I aStartPointPosition, ZONE_BORDER_DISPLAY_STYLE aHatch );

    bool TestZoneIntersection( ZONE* aZone1, ZONE* aZone2 );

    PAD* GetPad( const VECTOR2I& aPosition, const LSET& aLayerMask ) const;
    PAD* GetPad( const VECTOR2I& aPosition ) const
    {
        return GetPad( aPosition, LSET().set() );
    }

    PAD* GetPad( const PCB_TRACK* aTrace, ENDPOINT_T aEndPoint ) const;

    PAD* GetPad( std::vector<PAD*>& aPadList, const VECTOR2I& aPosition, const LSET& aLayerMask ) const;

    void GetSortedPadListByXthenYCoord( std::vector<PAD*>& aVector, int aNetCode = -1 ) const;

    std::tuple<int, double, double, double, double> GetTrackLength( const PCB_TRACK& aTrack ) const;

    TRACKS TracksInNet( int aNetCode );

    FOOTPRINT* GetFootprint( const VECTOR2I& aPosition, PCB_LAYER_ID aActiveLayer,
                             bool aVisibleOnly, bool aIgnoreLocked = false ) const;

    int GetMaxClearanceValue() const;

    void MapNets( BOARD* aDestBoard );
 
    void SanitizeNetcodes();

    void AddListener( BOARD_LISTENER* aListener );

    void RemoveListener( BOARD_LISTENER* aListener );

    void RemoveAllListeners();

    void OnItemChanged( BOARD_ITEM* aItem );

    void OnItemsChanged( std::vector<BOARD_ITEM*>& aItems );

    void OnBoardSelectionChanged();

    void OnItemsCompositeUpdate( std::vector<BOARD_ITEM*>& aAddedItems,
                                 std::vector<BOARD_ITEM*>& aRemovedItems,
                                 std::vector<BOARD_ITEM*>& aChangedItems );

    void OnRatsnestChanged();

    void OnZonesFilled( const std::vector<ZONE*>& aZones );

    wxString GroupsSanityCheck( bool repair = false );

    wxString GroupsSanityCheckInternal( bool repair );
 
    bool LegacyTeardrops() const { return m_legacyTeardrops; }
    void SetLegacyTeardrops( bool aFlag ) { m_legacyTeardrops = aFlag; }
 
    EMBEDDED_FILES* GetEmbeddedFiles() override;
    const EMBEDDED_FILES* GetEmbeddedFiles() const;
 
    void SetEmbeddedFilesDelegate( EMBEDDED_FILES* aDelegate ) { m_embeddedFilesDelegate = aDelegate; }

    std::set<KIFONT::OUTLINE_FONT*> GetFonts() const override;

    void EmbedFonts() override;

    LENGTH_DELAY_CALCULATION* GetLengthCalculation() const { return m_lengthDelayCalc.get(); }

    COMPONENT_CLASS_MANAGER& GetComponentClassManager() { return *m_componentClassManager; }
 
    PROJECT::ELEM ProjectElementType() override { return PROJECT::ELEM::BOARD; }

    void SaveToHistory( const wxString& aProjectPath, std::vector<HISTORY_FILE_DATA>& aFileData );

    std::weak_ptr<void> GetHistoryLifetimeToken() const { return m_historyLifetime; }
 
    const std::unordered_map<KIID, BOARD_ITEM*>& GetItemByIdCache() const
    {
        return m_itemByIdCache;
    }
 
    bool IsItemIndexedById( const BOARD_ITEM* aItem ) const
    {
        return m_cachedIdByItem.contains( aItem );
    }

    BOARD_ITEM* GetCachedItemById( const KIID& aId ) const;

    void CacheItemById( BOARD_ITEM* aItem ) const;

    void UncacheItemById( const KIID& aId ) const;
 
    void CacheItemSubtreeById( BOARD_ITEM* aItem )
    {
        wxCHECK( aItem, /* void */ );
 
        CacheItemById( aItem );
 
        aItem->RunOnChildren(
                [this]( BOARD_ITEM* aChild )
                {
                    CacheItemSubtreeById( aChild );
                },
                RECURSE_MODE::NO_RECURSE );
    }
 
    void CacheChildrenById( const BOARD_ITEM* aParent )
    {
        wxCHECK( aParent, /* void */ );
 
        aParent->RunOnChildren(
                [this]( BOARD_ITEM* aChild )
                {
                    CacheItemSubtreeById( aChild );
                },
                RECURSE_MODE::NO_RECURSE );
    }
 
    void UncacheItemSubtreeById( const BOARD_ITEM* aItem )
    {
        wxCHECK( aItem, /* void */ );
 
        // Pointer-keyed eviction: never remove an entry that belongs to a
        // different live item with the same UUID (e.g. a temporary copy).
        UncacheItemByPtr( aItem );
 
        aItem->RunOnChildren(
                [this]( BOARD_ITEM* aChild )
                {
                    UncacheItemSubtreeById( aChild );
                },
                RECURSE_MODE::NO_RECURSE );
    }
 
    void UncacheChildrenById( const BOARD_ITEM* aParent )
    {
        wxCHECK( aParent, /* void */ );
 
        aParent->RunOnChildren(
                [this]( BOARD_ITEM* aChild )
                {
                    UncacheItemSubtreeById( aChild );
                },
                RECURSE_MODE::NO_RECURSE );
    }

    void UncacheItemByPtr( const BOARD_ITEM* aItem );
 
    BOARD_ITEM* CacheAndReturnItemById( const KIID& aId, BOARD_ITEM* aItem ) const;
 
    void ClearItemByIdCache();
 
    // --------- Item order comparators ---------
 
    struct cmp_items
    {
        bool operator() ( const BOARD_ITEM* aFirst, const BOARD_ITEM* aSecond ) const;
    };
 
    struct cmp_drawings
    {
        bool operator()( const BOARD_ITEM* aFirst, const BOARD_ITEM* aSecond ) const;
    };
 
public:
    std::shared_ptr<const FOOTPRINT_COURTYARD_INDEX> GetFootprintCourtyardIndex();
 
    // ------------ Run-time caches -------------
    mutable std::shared_mutex                             m_CachesMutex;
    // These predicate caches are written per item-pair from every DRC worker thread, so they
    // carry their own internal sharded locks and are NOT covered by m_CachesMutex.
    SHARDED_CACHE<PTR_PTR_CACHE_KEY, bool>                m_IntersectsCourtyardCache;
    SHARDED_CACHE<PTR_PTR_CACHE_KEY, bool>                m_IntersectsFCourtyardCache;
    SHARDED_CACHE<PTR_PTR_CACHE_KEY, bool>                m_IntersectsBCourtyardCache;
    SHARDED_CACHE<PTR_PTR_LAYER_CACHE_KEY, bool>          m_IntersectsAreaCache;
    SHARDED_CACHE<PTR_PTR_LAYER_CACHE_KEY, bool>          m_IntersectsKeepoutCache;
    SHARDED_CACHE<PTR_PTR_LAYER_CACHE_KEY, bool>          m_EnclosedByAreaCache;
    SHARDED_CACHE<ITEM_SELECTOR_LAYER_CACHE_KEY, bool>    m_IntersectsCourtyardResultCache;
    SHARDED_CACHE<ITEM_SELECTOR_LAYER_CACHE_KEY, bool>    m_IntersectsFCourtyardResultCache;
    SHARDED_CACHE<ITEM_SELECTOR_LAYER_CACHE_KEY, bool>    m_IntersectsBCourtyardResultCache;
    SHARDED_CACHE<ITEM_SELECTOR_LAYER_CACHE_KEY, bool>    m_IntersectsAreaResultCache;
    SHARDED_CACHE<ITEM_SELECTOR_LAYER_CACHE_KEY, bool>    m_IntersectsKeepoutResultCache;
    SHARDED_CACHE<ITEM_SELECTOR_LAYER_CACHE_KEY, bool>    m_EnclosedByAreaResultCache;
    SHARDED_CACHE<ITEM_FIELD_CACHE_KEY, wxString>         m_ItemFieldCache;
    std::unordered_map< wxString, LSET >                  m_LayerExpressionCache;
    std::unordered_map<ZONE*, std::unique_ptr<DRC_RTREE>> m_CopperZoneRTreeCache;
    std::shared_ptr<DRC_RTREE>                            m_CopperItemRTreeCache;
    mutable std::unordered_map<const ZONE*, BOX2I>        m_ZoneBBoxCache;
    mutable std::optional<int>                            m_maxClearanceValue;
 
    // Microvias that land on another microvia, for isStackedVia(). Whole-board relation, so it
    // is built in one pass rather than per via.
    mutable std::optional<std::set<const PCB_VIA*>> m_StackedMicroviaCache;
 
    // Zone name lookup cache for DRC rule area functions like enclosedByArea/intersectsArea.
    // Maps zone names to vectors of matching zones to avoid O(n) zone iteration per lookup.
    mutable std::unordered_map<wxString, std::vector<ZONE*>> m_ZonesByNameCache;
 
    // Deflated zone outline cache for DRC area checks. Caches the deflated outline for each zone
    // to avoid repeated expensive deflation operations during collidesWithArea calls.
    mutable std::unordered_map<const ZONE*, SHAPE_POLY_SET> m_DeflatedZoneOutlineCache;
 
    // Spatial index of footprint courtyards, built lazily by GetFootprintCourtyardIndex().
    std::shared_ptr<const FOOTPRINT_COURTYARD_INDEX>     m_footprintCourtyardIndex;
 
    // ------------ DRC caches -------------
    std::vector<ZONE*>                       m_DRCZones;
    std::vector<ZONE*>                       m_DRCCopperZones;
    std::map<PCB_LAYER_ID, std::vector<ZONE*>> m_DRCCopperZonesByLayer;
    int                                      m_DRCMaxClearance;
    int                   m_DRCMaxPhysicalClearance;
    ZONE*                 m_SolderMaskBridges;  // A container to build bridges on solder mask layers
    std::map<ZONE*, std::map<PCB_LAYER_ID, ISOLATED_ISLANDS>> m_ZoneIsolatedIslandsMap;

    DRC_RTREE* GetCopperZoneRTree( ZONE* aZone ) const
    {
        auto it = m_CopperZoneRTreeCache.find( aZone );
 
        return it != m_CopperZoneRTreeCache.end() ? it->second.get() : nullptr;
    }
 
private:
    // The default copy constructor & operator= are inadequate,
    // either write one or do not use it at all
    BOARD( const BOARD& aOther ) = delete;
 
    BOARD& operator=( const BOARD& aOther ) = delete;
 
    template <typename Func, typename... Args>
    void InvokeListeners( Func&& aFunc, Args&&... args )
    {
        for( auto&& l : m_listeners )
            ( l->*aFunc )( std::forward<Args>( args )... );
    }
 
    // Refresh user layer opposites.
    void recalcOpposites();

    std::vector<BOARD_ITEM*> collectOwnedItems() const;
 
    friend class PCB_EDIT_FRAME;
 
private:
    int                 m_outlinesChainingEpsilon;

    BOARD_USE           m_boardUse;
    std::atomic<int>    m_timeStamp;                // actually a modification counter
 
    wxString            m_fileName;
 
    std::map<wxString, KIGFX::COLOR4D> m_netChainColors;
 
    // These containers only have const accessors and must only be modified by Add()/Remove()
    MARKERS             m_markers;
    DRAWINGS            m_drawings;
    FOOTPRINTS          m_footprints;
    TRACKS              m_tracks;
    GROUPS              m_groups;
    CONSTRAINTS         m_constraints;
    ZONES               m_zones;
    GENERATORS          m_generators;
    PCB_BOARD_OUTLINE*  m_boardOutline;
    PCB_POINTS          m_points;
 
    // Cache for fast access to items in the containers above by KIID, including children.
    // Mutable because it's a performance cache that can be populated during const lookups.
    // NOT protected by m_CachesMutex. Only safe for single-threaded access (UI, serialization).
    mutable std::unordered_map<KIID, BOARD_ITEM*>        m_itemByIdCache;
    mutable std::unordered_map<const BOARD_ITEM*, KIID>  m_cachedIdByItem;
 
    std::map<int, LAYER> m_layers;                  // layer data
 
    HIGH_LIGHT_INFO     m_highLight;                // current high light data
    HIGH_LIGHT_INFO     m_highLightPrevious;        // a previously stored high light data
 
    int                 m_fileFormatVersionAtLoad;  // the version loaded from the file
    uint64_t            m_drillModelGeneration;
    uint64_t            m_boardOutlineGeneration;
    LSET                m_drillSymbolLayers;

    std::vector<std::pair<VECTOR2I, int>> m_drillSymbolPlacements;
 
    mutable std::shared_ptr<const DRILL_SYMBOL_CACHE> m_drillSymbolCache;
    mutable std::mutex                                m_drillSymbolCacheMutex;
    wxString            m_generator;                // the generator tag from the file
 
    std::map<wxString, wxString>        m_properties;
    std::shared_ptr<CONNECTIVITY_DATA>  m_connectivity;
 
    // Sentinel whose expiry signals to LOCAL_HISTORY that this board has been destroyed.
    std::shared_ptr<void>               m_historyLifetime = std::make_shared<char>();
 
    PAGE_INFO           m_paper;
    TITLE_BLOCK         m_titles;                   // text in lower right of screen and plots
    PCB_PLOT_PARAMS     m_plotOptions;
    PROJECT*            m_project;                  // project this board is a part of
    EDA_UNITS           m_userUnits;
 
    // Variant system
    wxString                        m_currentVariant;        // Currently active variant (empty = default)
    std::vector<wxString>           m_variantNames;          // All variant names in the board
    std::map<wxString, wxString>    m_variantDescriptions;   // Descriptions for each variant

    std::unique_ptr<BOARD_DESIGN_SETTINGS> m_designSettings;

    bool                         m_legacyTeardrops = false;
 
    NETINFO_LIST                 m_NetInfo;         // net info list (name, design constraints...
 
    std::vector<BOARD_LISTENER*> m_listeners;
 
    bool                         m_embedFonts;
 
    // Used for dummy boards, such as a footprint holder, where we don't want to make a copy
    // of all the parent's embedded data.
    EMBEDDED_FILES*              m_embeddedFilesDelegate;
 
    std::unique_ptr<COMPONENT_CLASS_MANAGER>  m_componentClassManager;
    std::unique_ptr<LENGTH_DELAY_CALCULATION> m_lengthDelayCalc;
 
    // Reactive text-variable dependency adapter. Installed as a listener
    // during BOARD construction; destructor order ensures it outlives no
    // listener calls.
    std::unique_ptr<class BOARD_TEXT_VAR_ADAPTER> m_textVarAdapter;
 
public:
    BOARD_TEXT_VAR_ADAPTER* GetTextVarAdapter() const { return m_textVarAdapter.get(); }
};
 
 
#endif      // CLASS_BOARD_H_