corpus.h File Reference

#include <vector>
#include <wx/string.h>
#include <drc/drc_rule.h>

Go to the source code of this file.

Classes
struct	CORPUS_ENTRY
	One board+rules pairing from the out-of-tree corpus manifest. More...
class	CORPUS
	Read and resolve the corpus manifest pointed at by KICAD_DRC_BENCH_CORPUS. More...

Functions
const char *	ConstraintTypeName (DRC_CONSTRAINT_T aType)
	Human-readable token for a DRC_CONSTRAINT_T, matching the .kicad_dru keyword where one exists.
const std::vector< DRC_CONSTRAINT_T > &	AllConstraintTypes ()
	Every DRC_CONSTRAINT_T the engine can carry rules for, in enum order, excluding NULL_CONSTRAINT.
const std::vector< wxString > &	AllPredicateNames ()
	Every pcbexpr predicate registered in pcbexpr_functions.cpp, used for textual coverage scans.
std::vector< wxString >	ScanPredicatesInRules (const wxString &aRulesText)
	Scan raw .kicad_dru text for occurrences of each registered predicate name.

Function Documentation

AllConstraintTypes()

const std::vector< DRC_CONSTRAINT_T > & AllConstraintTypes

(

)

Every DRC_CONSTRAINT_T the engine can carry rules for, in enum order, excluding NULL_CONSTRAINT.

Definition at line 201 of file corpus.cpp.

References ANNULAR_WIDTH_CONSTRAINT, ASSERTION_CONSTRAINT, BRIDGED_MASK_CONSTRAINT, CLEARANCE_CONSTRAINT, CONNECTION_WIDTH_CONSTRAINT, COURTYARD_CLEARANCE_CONSTRAINT, CREEPAGE_CONSTRAINT, DIFF_PAIR_GAP_CONSTRAINT, DIFF_PAIR_INTRA_SKEW_CONSTRAINT, DISALLOW_CONSTRAINT, EDGE_CLEARANCE_CONSTRAINT, HOLE_CLEARANCE_CONSTRAINT, HOLE_SIZE_CONSTRAINT, HOLE_TO_HOLE_CONSTRAINT, LENGTH_CONSTRAINT, MAX_UNCOUPLED_CONSTRAINT, MIN_RESOLVED_SPOKES_CONSTRAINT, NET_CHAIN_LENGTH_CONSTRAINT, NET_CHAIN_RETURN_PATH_CONSTRAINT, NET_CHAIN_STUB_LENGTH_CONSTRAINT, PHYSICAL_CLEARANCE_CONSTRAINT, PHYSICAL_HOLE_CLEARANCE_CONSTRAINT, SILK_CLEARANCE_CONSTRAINT, SKEW_CONSTRAINT, SOLDER_MASK_EXPANSION_CONSTRAINT, SOLDER_MASK_SLIVER_CONSTRAINT, SOLDER_PASTE_ABS_MARGIN_CONSTRAINT, SOLDER_PASTE_REL_MARGIN_CONSTRAINT, TEXT_HEIGHT_CONSTRAINT, TEXT_THICKNESS_CONSTRAINT, THERMAL_RELIEF_GAP_CONSTRAINT, THERMAL_SPOKE_WIDTH_CONSTRAINT, TRACK_ANGLE_CONSTRAINT, TRACK_SEGMENT_LENGTH_CONSTRAINT, TRACK_WIDTH_CONSTRAINT, VIA_COUNT_CONSTRAINT, VIA_DANGLING_CONSTRAINT, VIA_DIAMETER_CONSTRAINT, and ZONE_CONNECTION_CONSTRAINT.

AllPredicateNames()

const std::vector< wxString > & AllPredicateNames

(

)

Every pcbexpr predicate registered in pcbexpr_functions.cpp, used for textual coverage scans.

Definition at line 230 of file corpus.cpp.

Referenced by ScanPredicatesInRules().

ConstraintTypeName()

const char * ConstraintTypeName

(

DRC_CONSTRAINT_T

aType

)

Human-readable token for a DRC_CONSTRAINT_T, matching the .kicad_dru keyword where one exists.

Definition at line 151 of file corpus.cpp.

References ANNULAR_WIDTH_CONSTRAINT, ASSERTION_CONSTRAINT, BRIDGED_MASK_CONSTRAINT, CLEARANCE_CONSTRAINT, CONNECTION_WIDTH_CONSTRAINT, COURTYARD_CLEARANCE_CONSTRAINT, CREEPAGE_CONSTRAINT, DIFF_PAIR_GAP_CONSTRAINT, DIFF_PAIR_INTRA_SKEW_CONSTRAINT, DISALLOW_CONSTRAINT, EDGE_CLEARANCE_CONSTRAINT, HOLE_CLEARANCE_CONSTRAINT, HOLE_SIZE_CONSTRAINT, HOLE_TO_HOLE_CONSTRAINT, LENGTH_CONSTRAINT, MAX_UNCOUPLED_CONSTRAINT, MIN_RESOLVED_SPOKES_CONSTRAINT, NET_CHAIN_LENGTH_CONSTRAINT, NET_CHAIN_RETURN_PATH_CONSTRAINT, NET_CHAIN_STUB_LENGTH_CONSTRAINT, NULL_CONSTRAINT, PHYSICAL_CLEARANCE_CONSTRAINT, PHYSICAL_HOLE_CLEARANCE_CONSTRAINT, SILK_CLEARANCE_CONSTRAINT, SKEW_CONSTRAINT, SOLDER_MASK_EXPANSION_CONSTRAINT, SOLDER_MASK_SLIVER_CONSTRAINT, SOLDER_PASTE_ABS_MARGIN_CONSTRAINT, SOLDER_PASTE_REL_MARGIN_CONSTRAINT, TEXT_HEIGHT_CONSTRAINT, TEXT_THICKNESS_CONSTRAINT, THERMAL_RELIEF_GAP_CONSTRAINT, THERMAL_SPOKE_WIDTH_CONSTRAINT, TRACK_ANGLE_CONSTRAINT, TRACK_SEGMENT_LENGTH_CONSTRAINT, TRACK_WIDTH_CONSTRAINT, VIA_COUNT_CONSTRAINT, VIA_DANGLING_CONSTRAINT, VIA_DIAMETER_CONSTRAINT, and ZONE_CONNECTION_CONSTRAINT.

ScanPredicatesInRules()

std::vector< wxString > ScanPredicatesInRules

(

const wxString &

aRulesText

)

Scan raw .kicad_dru text for occurrences of each registered predicate name.

A predicate is counted present when its name appears followed by an open paren, which is how the expression grammar invokes it. Returns the set of predicate names found.

Definition at line 257 of file corpus.cpp.

References AllPredicateNames(), and name.