62 wxLogWarning( wxT(
"Attempting to call fromTo() with non-existent from-to cache." ) );
76#define MISSING_LAYER_ARG( f ) wxString::Format( _( "Missing layer name argument to %s." ), f )
91 if( !arg || arg->
AsString().IsEmpty() )
100 [item, arg, aCtx]() ->
double
102 const wxString& layerName = arg->
AsString();
111 bool anyMatch =
false;
113 for(
unsigned ii = 0; ii < layerMap.GetCount(); ++ii )
115 wxPGChoiceEntry& entry = layerMap[ ii ];
117 if( entry.GetText().Matches( layerName ))
128 aCtx->
ReportError( wxString::Format(
_(
"Unrecognized layer '%s'" ),
143 std::shared_lock<std::shared_mutex> readLock( board->
m_CachesMutex );
148 return ( item->
GetLayerSet() & i->second ).any() ? 1.0 : 0.0;
153 for(
unsigned ii = 0; ii < layerMap.GetCount(); ++ii )
155 wxPGChoiceEntry& entry = layerMap[ ii ];
157 if( entry.GetText().Matches( layerName ) )
162 std::unique_lock<std::shared_mutex> writeLock( board->
m_CachesMutex );
166 return ( item->
GetLayerSet() & mask ).any() ? 1.0 : 0.0;
177 aCtx->
Push( result );
203 if(
ZONE* zone =
dynamic_cast<ZONE*
>( aItem ) )
204 aItemShape.reset( zone->Outline()->Clone() );
209 return footprintCourtyard.
Collide( aItemShape.get() );
223 if( aSelector.Upper().StartsWith( wxT(
"${CLASS:" ) ) && aSelector.EndsWith(
'}' ) )
225 wxString
name = aSelector.Mid( 8, aSelector.Length() - 9 );
236 else if( aSelector.Contains(
':' ) && aFp->
GetFPIDAsString().Matches( aSelector ) )
246 const std::function<
bool(
FOOTPRINT* )>& aFunc )
248 if( aArg == wxT(
"A" ) )
252 if( fp && aFunc( fp ) )
255 else if( aArg == wxT(
"B" ) )
259 if( fp && aFunc( fp ) )
272#define MISSING_FP_ARG( f ) \
273 wxString::Format( _( "Missing footprint argument (A, B, or reference designator) to %s." ), f )
282 context->
Push( result );
284 if( !arg || arg->
AsString().IsEmpty() )
299 [item, arg, context]() ->
double
302 std::shared_ptr<SHAPE> itemShape;
307 PTR_PTR_CACHE_KEY key = { fp, item };
311 std::shared_lock<std::shared_mutex> readLock( board->m_CachesMutex );
313 auto i = board->m_IntersectsCourtyardCache.find( key );
315 if( i != board->m_IntersectsCourtyardCache.end() )
324 std::unique_lock<std::shared_mutex> cacheLock( board->m_CachesMutex );
325 board->m_IntersectsCourtyardCache[ key ] = res;
346 context->
Push( result );
348 if( !arg || arg->
AsString().IsEmpty() )
363 [item, arg, context]() ->
double
366 std::shared_ptr<SHAPE> itemShape;
371 PTR_PTR_CACHE_KEY key = { fp, item };
375 std::shared_lock<std::shared_mutex> readLock( board->m_CachesMutex );
377 auto i = board->m_IntersectsFCourtyardCache.find( key );
379 if( i != board->m_IntersectsFCourtyardCache.end() )
387 std::unique_lock<std::shared_mutex> writeLock( board->m_CachesMutex );
388 board->m_IntersectsFCourtyardCache[ key ] = res;
409 context->
Push( result );
411 if( !arg || arg->
AsString().IsEmpty() )
426 [item, arg, context]() ->
double
429 std::shared_ptr<SHAPE> itemShape;
434 PTR_PTR_CACHE_KEY key = { fp, item };
438 std::shared_lock<std::shared_mutex> readLock( board->m_CachesMutex );
440 auto i = board->m_IntersectsBCourtyardCache.find( key );
442 if( i != board->m_IntersectsBCourtyardCache.end() )
450 std::unique_lock<std::shared_mutex> writeLock( board->m_CachesMutex );
451 board->m_IntersectsBCourtyardCache[ key ] = res;
506 aCtx->
ReportError(
_(
"Footprint's courtyard is not a single, closed shape." ) );
518 aCtx->
ReportError(
_(
"Footprint has no front courtyard." ) );
533 aCtx->
ReportError(
_(
"Footprint has no back courtyard." ) );
546 ZONE* zone =
static_cast<ZONE*
>( aItem );
572 const std::function<
bool(
ZONE* )>& aFunc )
574 if( aArg == wxT(
"A" ) )
576 return aFunc(
dynamic_cast<ZONE*
>( aCtx->
GetItem( 0 ) ) );
578 else if( aArg == wxT(
"B" ) )
580 return aFunc(
dynamic_cast<ZONE*
>( aCtx->
GetItem( 1 ) ) );
590 if( area->m_Uuid == target )
591 return aFunc( area );
596 for(
ZONE* area : footprint->Zones() )
600 if( area->m_Uuid == target )
601 return aFunc( area );
611 if( area->GetZoneName().Matches( aArg ) )
621 for(
ZONE* area : footprint->Zones() )
624 if( area->GetZoneName().Matches( aArg ) )
662#define MISSING_AREA_ARG( f ) \
663 wxString::Format( _( "Missing rule-area argument (A, B, or rule-area name) to %s." ), f )
672 aCtx->
Push( result );
674 if( !arg || arg->
AsString().IsEmpty() )
689 [item, arg, context]() ->
double
698 if( !aArea || aArea == item || aArea->GetParent() == item )
701 SCOPED_LAYERSET scopedLayerSet( aArea );
703 if( context->GetConstraint() == SILK_CLEARANCE_CONSTRAINT )
706 if( ( aArea->IsOnLayer( F_SilkS ) && IsFrontLayer( aLayer ) )
707 || ( aArea->IsOnLayer( B_SilkS ) && IsBackLayer( aLayer ) ) )
709 scopedLayerSet.Add( aLayer );
715 if( !commonLayers.any() )
724 testLayers.
set( aLayer );
726 testLayers = commonLayers;
730 PTR_PTR_LAYER_CACHE_KEY key = { aArea, item, layer };
734 std::shared_lock<std::shared_mutex> readLock( board->m_CachesMutex );
736 auto i = board->m_IntersectsAreaCache.find( key );
738 if( i != board->m_IntersectsAreaCache.end() && i->second )
746 std::unique_lock<std::shared_mutex> writeLock( board->m_CachesMutex );
747 board->m_IntersectsAreaCache[ key ] = collides;
772 aCtx->
Push( result );
774 if( !arg || arg->
AsString().IsEmpty() )
789 [item, arg, context]() ->
double
799 if( !aArea || aArea == item || aArea->GetParent() == item )
802 if( item->Type() != PCB_FOOTPRINT_T )
804 if( !( aArea->GetLayerSet() & item->GetLayerSet() ).any() )
815 std::shared_lock<std::shared_mutex> readLock( board->m_CachesMutex );
817 auto i = board->m_EnclosedByAreaCache.find( key );
819 if( i != board->m_EnclosedByAreaCache.end() )
828 itemShape = *static_cast<ZONE*>( item )->Outline();
832 FOOTPRINT* fp = static_cast<FOOTPRINT*>( item );
834 for( PCB_LAYER_ID testLayer : aArea->GetLayerSet() )
836 fp->TransformPadsToPolySet( itemShape, testLayer, 0,
837 maxError, ERROR_OUTSIDE );
838 fp->TransformFPShapesToPolySet( itemShape, testLayer, 0,
839 maxError, ERROR_OUTSIDE );
848 if( itemShape.IsEmpty() )
851 enclosedByArea = false;
855 itemShape.BooleanSubtract( *aArea->Outline() );
857 enclosedByArea = itemShape.IsEmpty();
862 std::unique_lock<std::shared_mutex> writeLock( board->m_CachesMutex );
863 board->m_EnclosedByAreaCache[ key ] = enclosedByArea;
866 return enclosedByArea;
877#define MISSING_GROUP_ARG( f ) \
878 wxString::Format( _( "Missing group name argument to %s." ), f )
886 aCtx->
Push( result );
888 if( !arg || arg->
AsString().IsEmpty() )
903 [item, arg]() ->
double
923#define MISSING_SHEET_ARG( f ) \
924 wxString::Format( _( "Missing sheet name argument to %s." ), f )
932 aCtx->
Push( result );
934 if( !arg || arg->
AsString().IsEmpty() )
949 [item, arg]() ->
double
962 if( sheetName.EndsWith( wxT(
"/") ) )
963 sheetName.RemoveLast();
964 if( refName.EndsWith( wxT(
"/") ) )
965 refName.RemoveLast();
967 if( sheetName.Matches( refName ) )
970 if( ( refName.Matches( wxT(
"/" ) ) || refName.IsEmpty() )
971 && sheetName.IsEmpty() )
987 aCtx->
Push( result );
989 if( !arg || arg->
AsString().IsEmpty() )
1004 [item, arg]() ->
double
1015 wxString refName = arg->
AsString();
1017 if( sheetName.EndsWith( wxT(
"/" ) ) )
1018 sheetName.RemoveLast();
1019 if( refName.EndsWith( wxT(
"/" ) ) )
1020 refName.RemoveLast();
1022 wxArrayString sheetPath = wxSplit( sheetName,
'/' );
1023 wxArrayString refPath = wxSplit( refName,
'/' );
1025 if( refPath.size() > sheetPath.size() )
1028 if( ( refName.Matches( wxT(
"/" ) ) || refName.IsEmpty() ) && sheetName.IsEmpty() )
1033 for(
size_t i = 0; i < refPath.size(); i++ )
1035 if( !sheetPath[i].Matches( refPath[i] ) )
1044#define MISSING_REF_ARG( f ) \
1045 wxString::Format( _( "Missing footprint argument (reference designator) to %s." ), f )
1053 aCtx->
Push( result );
1055 if( !arg || arg->
AsString().IsEmpty() )
1070 [item, arg]() ->
double
1090 aCtx->
Push( result );
1095 result->
Set ( 1.0 );
1107 aCtx->
Push( result );
1112 result->
Set ( 1.0 );
1125 aCtx->
Push( result );
1128 [a, b, context]() ->
double
1135 wxString coupledNet;
1149 if( board->FindNet( coupledNet ) )
1162#define MISSING_DP_ARG( f ) \
1163 wxString::Format( _( "Missing diff-pair name argument to %s." ), f )
1173 aCtx->
Push( result );
1175 if( !argv || argv->
AsString().IsEmpty() )
1187 [item, argv]() ->
double
1198 wxString baseName, coupledNet;
1203 if( baseName.Matches( arg ) )
1206 if( baseName.EndsWith(
"_" ) && baseName.BeforeLast(
'_' ).Matches( arg ) )
1224 aCtx->
Push( result );
1230 aCtx->
ReportError( wxString::Format(
_(
"Missing field name argument to %s." ),
1231 wxT(
"getField()" ) ) );
1241 [item, arg]() -> wxString
1264 aCtx->
Push( result );
1266 if( !arg || arg->
AsString().IsEmpty() )
1269 aCtx->
ReportError(
_(
"Missing netclass name argument to hasNetclass()" ) );
1281 [item, arg]() ->
double
1303 aCtx->
Push( result );
1305 if( !arg || arg->
AsString().IsEmpty() )
1308 aCtx->
ReportError(
_(
"Missing netclass name argument to hasExactNetclass()" ) );
1320 [item, arg]() ->
double
1342 aCtx->
Push( result );
1344 if( !arg || arg->
AsString().IsEmpty() )
1348 _(
"Missing component class name argument to hasComponentClass()" ) );
1360 [item, arg]() ->
double
1365 footprint =
static_cast<FOOTPRINT*
>( item );
constexpr int ARC_LOW_DEF
BASE_SET & set(size_t pos)
A base class derived from BOARD_ITEM for items that can be connected and have a net,...
virtual NETCLASS * GetEffectiveNetClass() const
Return the NETCLASS for this item.
wxString GetNetname() const
NETINFO_ITEM * GetNet() const
Return #NET_INFO object for a given item.
int GetDRCEpsilon() const
Return an epsilon which accounts for rounding errors, etc.
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
virtual bool IsConnected() const
Returns information if the object is derived from BOARD_CONNECTED_ITEM.
virtual void SetLayerSet(const LSET &aLayers)
virtual void TransformShapeToPolygon(SHAPE_POLY_SET &aBuffer, PCB_LAYER_ID aLayer, int aClearance, int aError, ERROR_LOC aErrorLoc, bool ignoreLineWidth=false) const
Convert the item shape to a closed polygon.
virtual bool IsOnLayer(PCB_LAYER_ID aLayer) const
Test to see if this object is on the given layer.
virtual std::shared_ptr< SHAPE > GetEffectiveShape(PCB_LAYER_ID aLayer=UNDEFINED_LAYER, FLASHING aFlash=FLASHING::DEFAULT) const
Some pad shapes can be complex (rounded/chamfered rectangle), even without considering custom shapes.
virtual const BOARD * GetBoard() const
Return the BOARD in which this BOARD_ITEM resides, or NULL if none.
FOOTPRINT * GetParentFootprint() const
virtual LSET GetLayerSet() const
Return a std::bitset of all layers on which the item physically resides.
BOARD_ITEM_CONTAINER * GetParent() const
virtual std::shared_ptr< SHAPE_SEGMENT > GetEffectiveHoleShape() const
Information pertinent to a Pcbnew printed circuit board.
NETINFO_ITEM * FindNet(int aNetcode) const
Search for a net with the given netcode.
const ZONES & Zones() const
const FOOTPRINTS & Footprints() const
std::unordered_map< wxString, LSET > m_LayerExpressionCache
std::unordered_map< ZONE *, std::unique_ptr< DRC_RTREE > > m_CopperZoneRTreeCache
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
std::shared_mutex m_CachesMutex
std::shared_ptr< CONNECTIVITY_DATA > GetConnectivity() const
Return a list of missing connections between components/tracks.
constexpr bool Intersects(const BOX2< Vec > &aRect) const
A lightweight representation of a component class.
bool ContainsClassName(const wxString &className) const
Determines if this (effective) component class contains a specific constituent class.
static int MatchDpSuffix(const wxString &aNetName, wxString &aComplementNet, wxString &aBaseDpName)
Check if the given net is a diff pair, returning its polarity and complement if so.
Implement an R-tree for fast spatial and layer indexing of connectable items.
int QueryColliding(BOARD_ITEM *aRefItem, PCB_LAYER_ID aRefLayer, PCB_LAYER_ID aTargetLayer, std::function< bool(BOARD_ITEM *)> aFilter=nullptr, std::function< bool(BOARD_ITEM *)> aVisitor=nullptr, int aClearance=0) const
This is a fast test which essentially does bounding-box overlap given a worst-case clearance.
A set of EDA_ITEMs (i.e., without duplicates).
virtual const BOX2I GetBoundingBox() const
Return the orthogonal bounding box of this object for display purposes.
virtual EDA_GROUP * GetParentGroup() const
KICAD_T Type() const
Returns the type of object.
EDA_ITEM_FLAGS GetFlags() const
virtual const wxString & GetText() const
Return the string associated with the text object.
static ENUM_MAP< T > & Instance()
static bool SniffTest(const wxString &aCandidate)
Returns true if a string has the correct formatting to be a KIID.
void ReportError(const wxString &aErrorMsg)
virtual const wxString & AsString() const
void SetDeferredEval(std::function< double()> aLambda)
LSET is a set of PCB_LAYER_IDs.
static const LSET & FrontMask()
Return a mask holding all technical layers and the external CU layer on front side.
static const LSET & BackMask()
Return a mask holding all technical layers and the external CU layer on back side.
bool Contains(PCB_LAYER_ID aLayer) const
See if the layer set contains a PCB layer.
A collection of nets and the parameters used to route or test these nets.
bool ContainsNetclassWithName(const wxString &netclass) const
Determines if the given netclass name is a constituent of this (maybe aggregate) netclass.
const wxString GetName() const
Gets the name of this (maybe aggregate) netclass in a format for internal usage or for export to exte...
Handle the data for a net.
const wxString & GetNetname() const
PCBEXPR_BUILTIN_FUNCTIONS()
void RegisterFunc(const wxString &funcSignature, LIBEVAL::FUNC_CALL_REF funcPtr)
void RegisterAllFunctions()
std::map< wxString, LIBEVAL::FUNC_CALL_REF > m_funcs
int GetConstraint() const
PCB_LAYER_ID GetLayer() const
BOARD_ITEM * GetItem(int index) const
BOARD_ITEM * GetObject(const LIBEVAL::CONTEXT *aCtx) const
void Add(PCB_LAYER_ID aLayer)
SCOPED_LAYERSET(BOARD_ITEM *aItem)
Represent a set of closed polygons.
void ClearArcs()
Removes all arc references from all the outlines and holes in the polyset.
bool Collide(const SHAPE *aShape, int aClearance=0, int *aActual=nullptr, VECTOR2I *aLocation=nullptr) const override
Check if the boundary of shape (this) lies closer to the shape aShape than aClearance,...
SHAPE_LINE_CHAIN & Outline(int aIndex)
Return the reference to aIndex-th outline in the set.
void Deflate(int aAmount, CORNER_STRATEGY aCornerStrategy, int aMaxError)
int OutlineCount() const
Return the number of outlines in the set.
SHAPE_POLY_SET CloneDropTriangulation() const
Handle a list of polygons defining a copper zone.
const BOX2I GetBoundingBox() const override
SHAPE_POLY_SET * Outline()
virtual LSET GetLayerSet() const override
Return a std::bitset of all layers on which the item physically resides.
@ ALLOW_ACUTE_CORNERS
just inflate the polygon. Acute angles create spikes
@ DIFF_PAIR_GAP_CONSTRAINT
#define ROUTER_TRANSIENT
transient items that should NOT be cached
#define HOLE_PROXY
Indicates the BOARD_ITEM is a proxy for its hole.
#define MALFORMED_COURTYARDS
PCB_LAYER_ID
A quick note on layer IDs:
PCB_LAYER_ID ToLAYER_ID(int aLayer)
@ PTH
Plated through hole pad.
Class to handle a set of BOARD_ITEMs.
static void intersectsFrontCourtyardFunc(LIBEVAL::CONTEXT *aCtx, void *self)
#define MISSING_SHEET_ARG(f)
bool collidesWithCourtyard(BOARD_ITEM *aItem, std::shared_ptr< SHAPE > &aItemShape, PCBEXPR_CONTEXT *aCtx, FOOTPRINT *aFootprint, PCB_LAYER_ID aSide)
#define MISSING_LAYER_ARG(f)
static void intersectsBackCourtyardFunc(LIBEVAL::CONTEXT *aCtx, void *self)
static void memberOfGroupFunc(LIBEVAL::CONTEXT *aCtx, void *self)
#define MISSING_AREA_ARG(f)
static void isCoupledDiffPairFunc(LIBEVAL::CONTEXT *aCtx, void *self)
static void isPlatedFunc(LIBEVAL::CONTEXT *aCtx, void *self)
bool searchAreas(BOARD *aBoard, const wxString &aArg, PCBEXPR_CONTEXT *aCtx, const std::function< bool(ZONE *)> &aFunc)
static void existsOnLayerFunc(LIBEVAL::CONTEXT *aCtx, void *self)
#define MISSING_GROUP_ARG(f)
static bool testFootprintSelector(FOOTPRINT *aFp, const wxString &aSelector)
static void isBlindBuriedViaFunc(LIBEVAL::CONTEXT *aCtx, void *self)
static void memberOfSheetFunc(LIBEVAL::CONTEXT *aCtx, void *self)
static void hasComponentClassFunc(LIBEVAL::CONTEXT *aCtx, void *self)
static void hasExactNetclassFunc(LIBEVAL::CONTEXT *aCtx, void *self)
#define MISSING_REF_ARG(f)
#define MISSING_DP_ARG(f)
static void enclosedByAreaFunc(LIBEVAL::CONTEXT *aCtx, void *self)
static void memberOfSheetOrChildrenFunc(LIBEVAL::CONTEXT *aCtx, void *self)
static void memberOfFootprintFunc(LIBEVAL::CONTEXT *aCtx, void *self)
static void isMicroVia(LIBEVAL::CONTEXT *aCtx, void *self)
static void getFieldFunc(LIBEVAL::CONTEXT *aCtx, void *self)
bool collidesWithArea(BOARD_ITEM *aItem, PCB_LAYER_ID aLayer, PCBEXPR_CONTEXT *aCtx, ZONE *aArea)
static void hasNetclassFunc(LIBEVAL::CONTEXT *aCtx, void *self)
bool fromToFunc(LIBEVAL::CONTEXT *aCtx, void *self)
static void intersectsCourtyardFunc(LIBEVAL::CONTEXT *aCtx, void *self)
static bool searchFootprints(BOARD *aBoard, const wxString &aArg, PCBEXPR_CONTEXT *aCtx, const std::function< bool(FOOTPRINT *)> &aFunc)
static void inDiffPairFunc(LIBEVAL::CONTEXT *aCtx, void *self)
static void intersectsAreaFunc(LIBEVAL::CONTEXT *aCtx, void *self)
#define MISSING_FP_ARG(f)
std::vector< FAB_LAYER_COLOR > dummy
@ PCB_VIA_T
class PCB_VIA, a via (like a track segment on a copper layer)
@ PCB_ZONE_T
class ZONE, a copper pour area
@ PCB_FOOTPRINT_T
class FOOTPRINT, a footprint
@ PCB_PAD_T
class PAD, a pad in a footprint