pcbexpr_functions.cpp File Reference

#include <cstdio>
#include <memory>
#include <mutex>
#include <wx/log.h>
#include <board.h>
#include <board_design_settings.h>
#include <drc/drc_rtree.h>
#include <drc/drc_engine.h>
#include <pcb_track.h>
#include <pcb_group.h>
#include <geometry/shape_segment.h>
#include <pcbexpr_evaluator.h>
#include <connectivity/connectivity_data.h>
#include <connectivity/connectivity_algo.h>
#include <connectivity/from_to_cache.h>

Go to the source code of this file.

Macros
#define	MISSING_LAYER_ARG(f)   wxString::Format( _( "Missing layer name argument to %s." ), f )
#define	MISSING_FP_ARG(f)    wxString::Format( _( "Missing footprint argument (A, B, or reference designator) to %s." ), f )
#define	MISSING_AREA_ARG(f)    wxString::Format( _( "Missing rule-area argument (A, B, or rule-area name) to %s." ), f )
#define	MISSING_GROUP_ARG(f)    wxString::Format( _( "Missing group name argument to %s." ), f )
#define	MISSING_SHEET_ARG(f)    wxString::Format( _( "Missing sheet name argument to %s." ), f )
#define	MISSING_REF_ARG(f)    wxString::Format( _( "Missing footprint argument (reference designator) to %s." ), f )
#define	MISSING_DP_ARG(f)    wxString::Format( _( "Missing diff-pair name argument to %s." ), f )

Functions
bool	fromToFunc (LIBEVAL::CONTEXT *aCtx, void *self)
static void	existsOnLayerFunc (LIBEVAL::CONTEXT *aCtx, void *self)
static void	isPlatedFunc (LIBEVAL::CONTEXT *aCtx, void *self)
bool	collidesWithCourtyard (BOARD_ITEM *aItem, std::shared_ptr< SHAPE > &aItemShape, PCBEXPR_CONTEXT *aCtx, FOOTPRINT *aFootprint, PCB_LAYER_ID aSide)
static bool	searchFootprints (BOARD *aBoard, const wxString &aArg, PCBEXPR_CONTEXT *aCtx, const std::function< bool(FOOTPRINT *)> &aFunc)
static void	intersectsCourtyardFunc (LIBEVAL::CONTEXT *aCtx, void *self)
static void	intersectsFrontCourtyardFunc (LIBEVAL::CONTEXT *aCtx, void *self)
static void	intersectsBackCourtyardFunc (LIBEVAL::CONTEXT *aCtx, void *self)
bool	collidesWithArea (BOARD_ITEM *aItem, PCBEXPR_CONTEXT *aCtx, ZONE *aArea)
bool	searchAreas (BOARD *aBoard, const wxString &aArg, PCBEXPR_CONTEXT *aCtx, const std::function< bool(ZONE *)> &aFunc)
static void	intersectsAreaFunc (LIBEVAL::CONTEXT *aCtx, void *self)
static void	enclosedByAreaFunc (LIBEVAL::CONTEXT *aCtx, void *self)
static void	memberOfGroupFunc (LIBEVAL::CONTEXT *aCtx, void *self)
static void	memberOfSheetFunc (LIBEVAL::CONTEXT *aCtx, void *self)
static void	memberOfFootprintFunc (LIBEVAL::CONTEXT *aCtx, void *self)
static void	isMicroVia (LIBEVAL::CONTEXT *aCtx, void *self)
static void	isBlindBuriedViaFunc (LIBEVAL::CONTEXT *aCtx, void *self)
static void	isCoupledDiffPairFunc (LIBEVAL::CONTEXT *aCtx, void *self)
static void	inDiffPairFunc (LIBEVAL::CONTEXT *aCtx, void *self)
static void	getFieldFunc (LIBEVAL::CONTEXT *aCtx, void *self)

Macro Definition Documentation

MISSING_AREA_ARG

#define MISSING_AREA_ARG

(

f

)

wxString::Format( _( "Missing rule-area argument (A, B, or rule-area name) to %s." ), f )

Definition at line 620 of file pcbexpr_functions.cpp.

MISSING_DP_ARG

#define MISSING_DP_ARG

(

f

)

wxString::Format( _( "Missing diff-pair name argument to %s." ), f )

Definition at line 1015 of file pcbexpr_functions.cpp.

MISSING_FP_ARG

#define MISSING_FP_ARG

(

f

)

wxString::Format( _( "Missing footprint argument (A, B, or reference designator) to %s." ), f )

Definition at line 243 of file pcbexpr_functions.cpp.

MISSING_GROUP_ARG

#define MISSING_GROUP_ARG

(

f

)

wxString::Format( _( "Missing group name argument to %s." ), f )

Definition at line 802 of file pcbexpr_functions.cpp.

MISSING_LAYER_ARG

#define MISSING_LAYER_ARG

(

f

)

wxString::Format( _( "Missing layer name argument to %s." ), f )

Definition at line 75 of file pcbexpr_functions.cpp.

MISSING_REF_ARG

#define MISSING_REF_ARG

(

f

)

wxString::Format( _( "Missing footprint argument (reference designator) to %s." ), f )

Definition at line 898 of file pcbexpr_functions.cpp.

MISSING_SHEET_ARG

#define MISSING_SHEET_ARG

(

f

)

wxString::Format( _( "Missing sheet name argument to %s." ), f )

Definition at line 848 of file pcbexpr_functions.cpp.

Function Documentation

collidesWithArea()

bool collidesWithArea	(	BOARD_ITEM *	aItem,
		PCBEXPR_CONTEXT *	aCtx,
		ZONE *	aArea
	)

Avoid buried vias that don't overlap the zone's layers

Definition at line 436 of file pcbexpr_functions.cpp.

References _, ALLOW_ACUTE_CORNERS, ARC_LOW_DEF, B_CrtYd, LSET::BackMask(), SHAPE_POLY_SET::ClearArcs(), SHAPE_POLY_SET::CloneDropTriangulation(), SHAPE_POLY_SET::Collide(), LSET::Contains(), SHAPE_POLY_SET::Deflate(), F_CrtYd, LSET::FrontMask(), BOARD_ITEM::GetBoard(), ZONE::GetBoundingBox(), FOOTPRINT::GetCourtyard(), BOARD::GetDesignSettings(), BOARD_DESIGN_SETTINGS::GetDRCEpsilon(), BOARD_ITEM::GetEffectiveHoleShape(), BOARD_ITEM::GetEffectiveShape(), EDA_ITEM::GetFlags(), PCBEXPR_CONTEXT::GetLayer(), BOARD_ITEM::GetLayerSet(), ZONE::GetLayerSet(), LIBEVAL::CONTEXT::HasErrorCallback(), HOLE_PROXY, ZONE::IsFilled(), BOARD::m_CopperZoneRTreeCache, MALFORMED_COURTYARDS, ZONE::Outline(), SHAPE_POLY_SET::Outline(), SHAPE_POLY_SET::OutlineCount(), PCB_FOOTPRINT_T, PCB_PAD_T, PCB_VIA_T, PCB_ZONE_T, DRC_RTREE::QueryColliding(), LIBEVAL::CONTEXT::ReportError(), LSET::Seq(), EDA_ITEM::Type(), and UNDEFINED_LAYER.

collidesWithCourtyard()

bool collidesWithCourtyard	(	BOARD_ITEM *	aItem,
		std::shared_ptr< SHAPE > &	aItemShape,
		PCBEXPR_CONTEXT *	aCtx,
		FOOTPRINT *	aFootprint,
		PCB_LAYER_ID	aSide
	)

Definition at line 192 of file pcbexpr_functions.cpp.

References SHAPE_POLY_SET::Collide(), FOOTPRINT::GetCourtyard(), BOARD_ITEM::GetEffectiveShape(), and PCBEXPR_CONTEXT::GetLayer().

Referenced by intersectsBackCourtyardFunc(), intersectsCourtyardFunc(), and intersectsFrontCourtyardFunc().

enclosedByAreaFunc()

static void enclosedByAreaFunc ( LIBEVAL::CONTEXT *  aCtx, void *  self  )

static

Definition at line 711 of file pcbexpr_functions.cpp.

References LIBEVAL::CONTEXT::AllocValue(), LIBEVAL::VALUE::AsString(), ERROR_OUTSIDE, BOARD_ITEM::GetBoard(), EDA_ITEM::GetBoundingBox(), BOARD::GetDesignSettings(), EDA_ITEM::GetFlags(), PCBEXPR_CONTEXT::GetLayer(), PCBEXPR_VAR_REF::GetObject(), LIBEVAL::CONTEXT::HasErrorCallback(), BOARD_DESIGN_SETTINGS::m_MaxError, MISSING_AREA_ARG, LIBEVAL::CONTEXT::Pop(), LIBEVAL::CONTEXT::Push(), LIBEVAL::CONTEXT::ReportError(), ROUTER_TRANSIENT, searchAreas(), LIBEVAL::VALUE::Set(), LIBEVAL::VALUE::SetDeferredEval(), and BOARD_ITEM::TransformShapeToPolygon().

Referenced by PCBEXPR_BUILTIN_FUNCTIONS::RegisterAllFunctions().

existsOnLayerFunc()

static void existsOnLayerFunc ( LIBEVAL::CONTEXT *  aCtx, void *  self  )

static

Definition at line 77 of file pcbexpr_functions.cpp.

References _, LIBEVAL::CONTEXT::AllocValue(), LIBEVAL::VALUE::AsString(), BOARD_ITEM::GetBoard(), BOARD_ITEM::GetLayerSet(), PCBEXPR_VAR_REF::GetObject(), LIBEVAL::CONTEXT::HasErrorCallback(), ENUM_MAP< T >::Instance(), BOARD_ITEM::IsOnLayer(), BOARD::m_CachesMutex, BOARD::m_LayerExpressionCache, MISSING_LAYER_ARG, LIBEVAL::CONTEXT::Pop(), LIBEVAL::CONTEXT::Push(), LIBEVAL::CONTEXT::ReportError(), LIBEVAL::VALUE::Set(), LIBEVAL::VALUE::SetDeferredEval(), and ToLAYER_ID().

Referenced by PCBEXPR_BUILTIN_FUNCTIONS::RegisterAllFunctions().

fromToFunc()

bool fromToFunc	(	LIBEVAL::CONTEXT *	aCtx,
		void *	self
	)

Definition at line 42 of file pcbexpr_functions.cpp.

References LIBEVAL::CONTEXT::AllocValue(), LIBEVAL::VALUE::AsString(), BOARD_ITEM::GetBoard(), BOARD::GetConnectivity(), PCBEXPR_VAR_REF::GetObject(), LIBEVAL::CONTEXT::Pop(), LIBEVAL::CONTEXT::Push(), and LIBEVAL::VALUE::Set().

Referenced by PCBEXPR_BUILTIN_FUNCTIONS::RegisterAllFunctions().

getFieldFunc()

static void getFieldFunc ( LIBEVAL::CONTEXT *  aCtx, void *  self  )

static

Definition at line 1069 of file pcbexpr_functions.cpp.

References _, LIBEVAL::CONTEXT::AllocValue(), LIBEVAL::VALUE::AsString(), BOARD_ITEM::GetBoard(), FOOTPRINT::GetFieldByName(), PCBEXPR_VAR_REF::GetObject(), EDA_TEXT::GetText(), LIBEVAL::CONTEXT::HasErrorCallback(), PCB_FOOTPRINT_T, LIBEVAL::CONTEXT::Pop(), LIBEVAL::CONTEXT::Push(), LIBEVAL::CONTEXT::ReportError(), LIBEVAL::VALUE::Set(), LIBEVAL::VALUE::SetDeferredEval(), and EDA_ITEM::Type().

Referenced by PCBEXPR_BUILTIN_FUNCTIONS::RegisterAllFunctions().

inDiffPairFunc()

static void inDiffPairFunc ( LIBEVAL::CONTEXT *  aCtx, void *  self  )

static

Definition at line 1018 of file pcbexpr_functions.cpp.

References LIBEVAL::CONTEXT::AllocValue(), LIBEVAL::VALUE::AsString(), BOARD::FindNet(), BOARD_ITEM::GetBoard(), NETINFO_ITEM::GetNetname(), PCBEXPR_VAR_REF::GetObject(), LIBEVAL::CONTEXT::HasErrorCallback(), BOARD_ITEM::IsConnected(), DRC_ENGINE::MatchDpSuffix(), MISSING_DP_ARG, LIBEVAL::CONTEXT::Pop(), LIBEVAL::CONTEXT::Push(), LIBEVAL::CONTEXT::ReportError(), LIBEVAL::VALUE::Set(), and LIBEVAL::VALUE::SetDeferredEval().

Referenced by PCBEXPR_BUILTIN_FUNCTIONS::RegisterAllFunctions().

intersectsAreaFunc()

static void intersectsAreaFunc ( LIBEVAL::CONTEXT *  aCtx, void *  self  )

static

Definition at line 623 of file pcbexpr_functions.cpp.

References LIBEVAL::CONTEXT::AllocValue(), LIBEVAL::VALUE::AsString(), BOARD_ITEM::GetBoard(), EDA_ITEM::GetBoundingBox(), PCBEXPR_CONTEXT::GetLayer(), PCBEXPR_VAR_REF::GetObject(), LIBEVAL::CONTEXT::HasErrorCallback(), MISSING_AREA_ARG, LIBEVAL::CONTEXT::Pop(), LIBEVAL::CONTEXT::Push(), LIBEVAL::CONTEXT::ReportError(), searchAreas(), LIBEVAL::VALUE::Set(), and LIBEVAL::VALUE::SetDeferredEval().

Referenced by PCBEXPR_BUILTIN_FUNCTIONS::RegisterAllFunctions().

intersectsBackCourtyardFunc()

static void intersectsBackCourtyardFunc ( LIBEVAL::CONTEXT *  aCtx, void *  self  )

static

Definition at line 373 of file pcbexpr_functions.cpp.

References LIBEVAL::CONTEXT::AllocValue(), LIBEVAL::VALUE::AsString(), B_Cu, collidesWithCourtyard(), BOARD_ITEM::GetBoard(), EDA_ITEM::GetFlags(), PCBEXPR_VAR_REF::GetObject(), LIBEVAL::CONTEXT::HasErrorCallback(), MISSING_FP_ARG, LIBEVAL::CONTEXT::Pop(), LIBEVAL::CONTEXT::Push(), LIBEVAL::CONTEXT::ReportError(), res, ROUTER_TRANSIENT, searchFootprints(), LIBEVAL::VALUE::Set(), and LIBEVAL::VALUE::SetDeferredEval().

Referenced by PCBEXPR_BUILTIN_FUNCTIONS::RegisterAllFunctions().

intersectsCourtyardFunc()

static void intersectsCourtyardFunc ( LIBEVAL::CONTEXT *  aCtx, void *  self  )

static

Definition at line 246 of file pcbexpr_functions.cpp.

References LIBEVAL::CONTEXT::AllocValue(), LIBEVAL::VALUE::AsString(), B_Cu, collidesWithCourtyard(), F_Cu, BOARD_ITEM::GetBoard(), EDA_ITEM::GetFlags(), PCBEXPR_VAR_REF::GetObject(), LIBEVAL::CONTEXT::HasErrorCallback(), MISSING_FP_ARG, LIBEVAL::CONTEXT::Pop(), LIBEVAL::CONTEXT::Push(), LIBEVAL::CONTEXT::ReportError(), res, ROUTER_TRANSIENT, searchFootprints(), LIBEVAL::VALUE::Set(), and LIBEVAL::VALUE::SetDeferredEval().

Referenced by PCBEXPR_BUILTIN_FUNCTIONS::RegisterAllFunctions().

intersectsFrontCourtyardFunc()

static void intersectsFrontCourtyardFunc ( LIBEVAL::CONTEXT *  aCtx, void *  self  )

static

Definition at line 310 of file pcbexpr_functions.cpp.

References LIBEVAL::CONTEXT::AllocValue(), LIBEVAL::VALUE::AsString(), collidesWithCourtyard(), F_Cu, BOARD_ITEM::GetBoard(), EDA_ITEM::GetFlags(), PCBEXPR_VAR_REF::GetObject(), LIBEVAL::CONTEXT::HasErrorCallback(), MISSING_FP_ARG, LIBEVAL::CONTEXT::Pop(), LIBEVAL::CONTEXT::Push(), LIBEVAL::CONTEXT::ReportError(), res, ROUTER_TRANSIENT, searchFootprints(), LIBEVAL::VALUE::Set(), and LIBEVAL::VALUE::SetDeferredEval().

Referenced by PCBEXPR_BUILTIN_FUNCTIONS::RegisterAllFunctions().

isBlindBuriedViaFunc()

static void isBlindBuriedViaFunc ( LIBEVAL::CONTEXT *  aCtx, void *  self  )

static

Definition at line 962 of file pcbexpr_functions.cpp.

References LIBEVAL::CONTEXT::AllocValue(), BLIND_BURIED, PCBEXPR_VAR_REF::GetObject(), PCB_VIA_T, LIBEVAL::CONTEXT::Push(), LIBEVAL::VALUE::Set(), and EDA_ITEM::Type().

Referenced by PCBEXPR_BUILTIN_FUNCTIONS::RegisterAllFunctions().

isCoupledDiffPairFunc()

static void isCoupledDiffPairFunc ( LIBEVAL::CONTEXT *  aCtx, void *  self  )

static

Definition at line 979 of file pcbexpr_functions.cpp.

References LIBEVAL::CONTEXT::AllocValue(), dummy, PCBEXPR_CONTEXT::GetConstraint(), PCBEXPR_CONTEXT::GetItem(), BOARD_CONNECTED_ITEM::GetNet(), BOARD_CONNECTED_ITEM::GetNetname(), NETINFO_ITEM::GetNetname(), LENGTH_CONSTRAINT, DRC_ENGINE::MatchDpSuffix(), LIBEVAL::CONTEXT::Push(), LIBEVAL::VALUE::Set(), LIBEVAL::VALUE::SetDeferredEval(), and SKEW_CONSTRAINT.

Referenced by PCBEXPR_BUILTIN_FUNCTIONS::RegisterAllFunctions().

isMicroVia()

static void isMicroVia ( LIBEVAL::CONTEXT *  aCtx, void *  self  )

static

Definition at line 945 of file pcbexpr_functions.cpp.

References LIBEVAL::CONTEXT::AllocValue(), PCBEXPR_VAR_REF::GetObject(), MICROVIA, PCB_VIA_T, LIBEVAL::CONTEXT::Push(), LIBEVAL::VALUE::Set(), and EDA_ITEM::Type().

Referenced by PCBEXPR_BUILTIN_FUNCTIONS::RegisterAllFunctions().

isPlatedFunc()

static void isPlatedFunc ( LIBEVAL::CONTEXT *  aCtx, void *  self  )

static

Definition at line 172 of file pcbexpr_functions.cpp.

References LIBEVAL::CONTEXT::AllocValue(), PCBEXPR_VAR_REF::GetObject(), PCB_PAD_T, PCB_VIA_T, PTH, LIBEVAL::CONTEXT::Push(), LIBEVAL::VALUE::Set(), and EDA_ITEM::Type().

Referenced by PCBEXPR_BUILTIN_FUNCTIONS::RegisterAllFunctions().

memberOfFootprintFunc()

static void memberOfFootprintFunc ( LIBEVAL::CONTEXT *  aCtx, void *  self  )

static

Definition at line 901 of file pcbexpr_functions.cpp.

References LIBEVAL::CONTEXT::AllocValue(), LIBEVAL::VALUE::AsString(), PCBEXPR_VAR_REF::GetObject(), BOARD_ITEM::GetParentFootprint(), LIBEVAL::CONTEXT::HasErrorCallback(), MISSING_REF_ARG, LIBEVAL::CONTEXT::Pop(), LIBEVAL::CONTEXT::Push(), LIBEVAL::CONTEXT::ReportError(), LIBEVAL::VALUE::Set(), and LIBEVAL::VALUE::SetDeferredEval().

Referenced by PCBEXPR_BUILTIN_FUNCTIONS::RegisterAllFunctions().

memberOfGroupFunc()

static void memberOfGroupFunc ( LIBEVAL::CONTEXT *  aCtx, void *  self  )

static

Definition at line 805 of file pcbexpr_functions.cpp.

References LIBEVAL::CONTEXT::AllocValue(), LIBEVAL::VALUE::AsString(), PCBEXPR_VAR_REF::GetObject(), BOARD_ITEM::GetParent(), BOARD_ITEM::GetParentGroup(), group, LIBEVAL::CONTEXT::HasErrorCallback(), MISSING_GROUP_ARG, PCB_FOOTPRINT_T, LIBEVAL::CONTEXT::Pop(), LIBEVAL::CONTEXT::Push(), LIBEVAL::CONTEXT::ReportError(), LIBEVAL::VALUE::Set(), LIBEVAL::VALUE::SetDeferredEval(), and EDA_ITEM::Type().

Referenced by PCBEXPR_BUILTIN_FUNCTIONS::RegisterAllFunctions().

memberOfSheetFunc()

static void memberOfSheetFunc ( LIBEVAL::CONTEXT *  aCtx, void *  self  )

static

Definition at line 851 of file pcbexpr_functions.cpp.

References LIBEVAL::CONTEXT::AllocValue(), LIBEVAL::VALUE::AsString(), PCBEXPR_VAR_REF::GetObject(), BOARD_ITEM::GetParentFootprint(), FOOTPRINT::GetSheetname(), LIBEVAL::CONTEXT::HasErrorCallback(), MISSING_SHEET_ARG, LIBEVAL::CONTEXT::Pop(), LIBEVAL::CONTEXT::Push(), LIBEVAL::CONTEXT::ReportError(), LIBEVAL::VALUE::Set(), and LIBEVAL::VALUE::SetDeferredEval().

Referenced by PCBEXPR_BUILTIN_FUNCTIONS::RegisterAllFunctions().

searchAreas()

bool searchAreas	(	BOARD *	aBoard,
		const wxString &	aArg,
		PCBEXPR_CONTEXT *	aCtx,
		const std::function< bool(ZONE *)> &	aFunc
	)

Definition at line 554 of file pcbexpr_functions.cpp.

References BOARD::Footprints(), PCBEXPR_CONTEXT::GetItem(), KIID::SniffTest(), and BOARD::Zones().

Referenced by enclosedByAreaFunc(), and intersectsAreaFunc().

searchFootprints()

static bool searchFootprints ( BOARD *  aBoard, const wxString &  aArg, PCBEXPR_CONTEXT *  aCtx, const std::function< bool(FOOTPRINT *)> &  aFunc  )

static

Definition at line 213 of file pcbexpr_functions.cpp.

References BOARD::Footprints(), and PCBEXPR_CONTEXT::GetItem().

Referenced by intersectsBackCourtyardFunc(), intersectsCourtyardFunc(), and intersectsFrontCourtyardFunc().