KiCad PCB EDA Suite
Loading...
Searching...
No Matches
drc_rule.h
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version 2
9 * of the License, or (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, you may find one here:
18 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
19 * or you may search the http://www.gnu.org website for the version 2 license,
20 * or you may write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
22 */
23
24#ifndef DRC_RULE_H
25#define DRC_RULE_H
26
27#include <bitset>
28#include <kiid.h>
29#include <core/typeinfo.h>
30#include <optional>
31#include <core/minoptmax.h>
32#include <layer_ids.h>
33#include <lset.h>
34#include <netclass.h>
35#include <zones.h>
37#include <wx/intl.h>
39
40class BOARD_ITEM;
41class PCBEXPR_UCODE;
42class DRC_CONSTRAINT;
44
45
85
86
100
101
103{
104public:
105 DRC_RULE();
106 DRC_RULE( const wxString& aName );
107
108 virtual ~DRC_RULE();
109
110 virtual bool AppliesTo( const BOARD_ITEM* a, const BOARD_ITEM* b = nullptr ) const
111 {
112 return true;
113 };
114
115 void AddConstraint( DRC_CONSTRAINT& aConstraint );
116 std::optional<DRC_CONSTRAINT> FindConstraint( DRC_CONSTRAINT_T aType );
117
118public:
122 wxString m_Name;
126 std::vector<DRC_CONSTRAINT> m_Constraints;
128};
129
130
132{
133public:
135 const wxString& aName = wxEmptyString ) :
136 m_Type( aType ),
137 m_Value(),
138 m_DisallowFlags( 0 ),
140 m_Test( nullptr ),
141 m_ImplicitMin( false ),
142 m_name( aName ),
143 m_parentRule( nullptr )
144 {
145 }
146
147 enum class OPTIONS : std::size_t
148 {
152
153 // Keep this last value - used to statically size the options bitset
155 };
156
157 bool IsNull() const
158 {
159 return m_Type == NULL_CONSTRAINT;
160 }
161
162 const MINOPTMAX<int>& GetValue() const { return m_Value; }
164
165 void SetParentRule( DRC_RULE *aParentRule ) { m_parentRule = aParentRule; }
167
168 void SetName( const wxString& aName ) { m_name = aName; }
169
170 wxString GetName() const
171 {
172 if( m_parentRule )
173 {
174 if( m_parentRule->m_Implicit )
175 return m_parentRule->m_Name;
176 else
177 return wxString::Format( _( "rule '%s'" ), m_parentRule->m_Name );
178 }
179
180 return m_name;
181 }
182
184 {
185 if( m_parentRule )
186 return m_parentRule->m_Severity;
187 else
189 }
190
191 void SetOption( OPTIONS option ) { m_options.set( static_cast<std::size_t>( option ), true ); }
192
193 void ClearOption( OPTIONS option ) { m_options.set( static_cast<std::size_t>( option ), false ); }
194
195 bool GetOption( OPTIONS option ) const
196 {
197 return m_options.test( static_cast<std::size_t>( option ) );
198 }
199
200 void SetOptionsFromOther( const DRC_CONSTRAINT& aOther ) { m_options = aOther.m_options; }
201
202public:
209
210private:
211 wxString m_name; // For just-in-time constraints
212 DRC_RULE* m_parentRule; // For constraints found in rules
213 std::bitset<static_cast<int>( OPTIONS::NUM_OPTIONS )> m_options; // Constraint-specific option bits
214 // (indexed from DRC_CONSTRAINT::OPTIONS)
215};
216
217
218const DRC_CONSTRAINT* GetConstraint( const BOARD_ITEM* aItem, const BOARD_ITEM* bItem,
219 int aConstraint, PCB_LAYER_ID aLayer,
220 wxString* aRuleName = nullptr );
221
222
223#endif // DRC_RULE_H
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition board_item.h:79
DRC_RULE_CONDITION * m_Test
Definition drc_rule.h:207
wxString GetName() const
Definition drc_rule.h:170
int m_DisallowFlags
Definition drc_rule.h:205
SEVERITY GetSeverity() const
Definition drc_rule.h:183
void SetOption(OPTIONS option)
Definition drc_rule.h:191
DRC_RULE * m_parentRule
Definition drc_rule.h:212
void SetParentRule(DRC_RULE *aParentRule)
Definition drc_rule.h:165
MINOPTMAX< int > & Value()
Definition drc_rule.h:163
const MINOPTMAX< int > & GetValue() const
Definition drc_rule.h:162
ZONE_CONNECTION m_ZoneConnection
Definition drc_rule.h:206
void SetName(const wxString &aName)
Definition drc_rule.h:168
MINOPTMAX< int > m_Value
Definition drc_rule.h:204
DRC_CONSTRAINT_T m_Type
Definition drc_rule.h:203
void SetOptionsFromOther(const DRC_CONSTRAINT &aOther)
Definition drc_rule.h:200
wxString m_name
Definition drc_rule.h:211
bool GetOption(OPTIONS option) const
Definition drc_rule.h:195
DRC_RULE * GetParentRule() const
Definition drc_rule.h:166
void ClearOption(OPTIONS option)
Definition drc_rule.h:193
DRC_CONSTRAINT(DRC_CONSTRAINT_T aType=NULL_CONSTRAINT, const wxString &aName=wxEmptyString)
Definition drc_rule.h:134
bool m_ImplicitMin
Definition drc_rule.h:208
std::bitset< static_cast< int >(OPTIONS::NUM_OPTIONS)> m_options
Definition drc_rule.h:213
bool IsNull() const
Definition drc_rule.h:157
SEVERITY m_Severity
Definition drc_rule.h:127
bool m_Unary
Definition drc_rule.h:119
DRC_RULE_CONDITION * m_Condition
Definition drc_rule.h:125
LSET m_LayerCondition
Definition drc_rule.h:124
virtual bool AppliesTo(const BOARD_ITEM *a, const BOARD_ITEM *b=nullptr) const
Definition drc_rule.h:110
KIID m_ImplicitItemId
Definition drc_rule.h:121
std::vector< DRC_CONSTRAINT > m_Constraints
Definition drc_rule.h:126
bool m_Implicit
Definition drc_rule.h:120
wxString m_Name
Definition drc_rule.h:122
void AddConstraint(DRC_CONSTRAINT &aConstraint)
Definition drc_rule.cpp:60
wxString m_LayerSource
Definition drc_rule.h:123
virtual ~DRC_RULE()
Definition drc_rule.cpp:54
std::optional< DRC_CONSTRAINT > FindConstraint(DRC_CONSTRAINT_T aType)
Definition drc_rule.cpp:67
Definition kiid.h:49
LSET is a set of PCB_LAYER_IDs.
Definition lset.h:37
const DRC_CONSTRAINT * GetConstraint(const BOARD_ITEM *aItem, const BOARD_ITEM *bItem, int aConstraint, PCB_LAYER_ID aLayer, wxString *aRuleName=nullptr)
DRC_DISALLOW_T
Definition drc_rule.h:88
@ DRC_DISALLOW_PADS
Definition drc_rule.h:93
@ DRC_DISALLOW_VIAS
Definition drc_rule.h:89
@ DRC_DISALLOW_TEXTS
Definition drc_rule.h:95
@ DRC_DISALLOW_ZONES
Definition drc_rule.h:94
@ DRC_DISALLOW_HOLES
Definition drc_rule.h:97
@ DRC_DISALLOW_GRAPHICS
Definition drc_rule.h:96
@ DRC_DISALLOW_FOOTPRINTS
Definition drc_rule.h:98
@ DRC_DISALLOW_TRACKS
Definition drc_rule.h:92
@ DRC_DISALLOW_MICRO_VIAS
Definition drc_rule.h:90
@ DRC_DISALLOW_BB_VIAS
Definition drc_rule.h:91
DRC_CONSTRAINT_T
Definition drc_rule.h:47
@ ANNULAR_WIDTH_CONSTRAINT
Definition drc_rule.h:61
@ BRIDGED_MASK_CONSTRAINT
Definition drc_rule.h:83
@ COURTYARD_CLEARANCE_CONSTRAINT
Definition drc_rule.h:55
@ VIA_DIAMETER_CONSTRAINT
Definition drc_rule.h:70
@ ZONE_CONNECTION_CONSTRAINT
Definition drc_rule.h:62
@ DIFF_PAIR_GAP_CONSTRAINT
Definition drc_rule.h:73
@ VIA_DANGLING_CONSTRAINT
Definition drc_rule.h:82
@ DISALLOW_CONSTRAINT
Definition drc_rule.h:69
@ TRACK_WIDTH_CONSTRAINT
Definition drc_rule.h:59
@ SILK_CLEARANCE_CONSTRAINT
Definition drc_rule.h:56
@ EDGE_CLEARANCE_CONSTRAINT
Definition drc_rule.h:53
@ MIN_RESOLVED_SPOKES_CONSTRAINT
Definition drc_rule.h:65
@ TRACK_SEGMENT_LENGTH_CONSTRAINT
Definition drc_rule.h:60
@ TEXT_THICKNESS_CONSTRAINT
Definition drc_rule.h:58
@ LENGTH_CONSTRAINT
Definition drc_rule.h:71
@ VIA_COUNT_CONSTRAINT
Definition drc_rule.h:76
@ PHYSICAL_HOLE_CLEARANCE_CONSTRAINT
Definition drc_rule.h:78
@ CLEARANCE_CONSTRAINT
Definition drc_rule.h:49
@ NULL_CONSTRAINT
Definition drc_rule.h:48
@ THERMAL_SPOKE_WIDTH_CONSTRAINT
Definition drc_rule.h:64
@ CONNECTION_WIDTH_CONSTRAINT
Definition drc_rule.h:80
@ THERMAL_RELIEF_GAP_CONSTRAINT
Definition drc_rule.h:63
@ MAX_UNCOUPLED_CONSTRAINT
Definition drc_rule.h:74
@ ASSERTION_CONSTRAINT
Definition drc_rule.h:79
@ SKEW_CONSTRAINT
Definition drc_rule.h:72
@ HOLE_CLEARANCE_CONSTRAINT
Definition drc_rule.h:51
@ SOLDER_PASTE_ABS_MARGIN_CONSTRAINT
Definition drc_rule.h:67
@ SOLDER_MASK_EXPANSION_CONSTRAINT
Definition drc_rule.h:66
@ TRACK_ANGLE_CONSTRAINT
Definition drc_rule.h:81
@ HOLE_SIZE_CONSTRAINT
Definition drc_rule.h:54
@ TEXT_HEIGHT_CONSTRAINT
Definition drc_rule.h:57
@ CREEPAGE_CONSTRAINT
Definition drc_rule.h:50
@ DIFF_PAIR_INTRA_SKEW_CONSTRAINT
Definition drc_rule.h:75
@ PHYSICAL_CLEARANCE_CONSTRAINT
Definition drc_rule.h:77
@ SOLDER_PASTE_REL_MARGIN_CONSTRAINT
Definition drc_rule.h:68
@ HOLE_TO_HOLE_CONSTRAINT
Definition drc_rule.h:52
#define _(s)
PCB_LAYER_ID
A quick note on layer IDs:
Definition layer_ids.h:60
SEVERITY
@ RPT_SEVERITY_UNDEFINED
ZONE_CONNECTION
How pads are covered by copper in zone.
Definition zones.h:47