KiCad PCB EDA Suite
typeinfo.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 (C) 2014 CERN
5  * Copyright (C) 2004-2021 KiCad Developers, see change_log.txt for contributors.
6  * @author Tomasz Wlostowski <tomasz.wlostowski@cern.ch>
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License
10  * as published by the Free Software Foundation; either version 2
11  * of the License, or (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, you may find one here:
20  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
21  * or you may search the http://www.gnu.org website for the version 2 license,
22  * or you may write to the Free Software Foundation, Inc.,
23  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
24  */
25 
26 #ifndef __KICAD_TYPEINFO_H
27 #define __KICAD_TYPEINFO_H
28 
29 
30 #ifndef SWIG
31 #include <type_traits>
32 
39 template <class T, class I>
40 bool IsA( const I* aObject )
41 {
42  return aObject && std::remove_pointer<T>::type::ClassOf( aObject );
43 }
44 
45 template <class T, class I>
46 bool IsA( const I& aObject )
47 {
48  return std::remove_pointer<T>::type::ClassOf( &aObject );
49 }
50 
60 template<class Casted, class From>
61 Casted dyn_cast( From aObject )
62 {
63  if( std::remove_pointer<Casted>::type::ClassOf ( aObject ) )
64  return static_cast<Casted>( aObject );
65 
66  return nullptr;
67 }
68 
69 class EDA_ITEM;
70 
71 #endif // SWIG
72 
73 
77 enum KICAD_T
78 {
79  NOT_USED = -1,
80 
81  EOT = 0,
82 
83  TYPE_NOT_INIT = 0,
84  PCB_T,
85  SCREEN_T,
86 
87  // Items in pcb
88  PCB_FOOTPRINT_T,
89  PCB_PAD_T,
90  PCB_SHAPE_T,
91  PCB_TEXT_T,
92  PCB_FP_TEXT_T,
93  PCB_FP_SHAPE_T,
94  PCB_FP_ZONE_T,
95  PCB_TRACE_T,
96  PCB_VIA_T,
97  PCB_ARC_T,
98  PCB_MARKER_T,
99  PCB_DIMENSION_T,
100  PCB_DIM_ALIGNED_T,
101  PCB_DIM_LEADER_T,
102  PCB_DIM_CENTER_T,
103  PCB_DIM_ORTHOGONAL_T,
104  PCB_TARGET_T,
105  PCB_ZONE_T,
106  PCB_ITEM_LIST_T,
107  PCB_NETINFO_T,
108  PCB_GROUP_T,
109 
110  PCB_LOCATE_STDVIA_T,
111  PCB_LOCATE_UVIA_T,
112  PCB_LOCATE_BBVIA_T,
113  PCB_LOCATE_TEXT_T,
114  PCB_LOCATE_GRAPHIC_T,
115  PCB_LOCATE_HOLE_T,
116  PCB_LOCATE_PTH_T,
117  PCB_LOCATE_NPTH_T,
118  PCB_LOCATE_BOARD_EDGE_T,
119 
120  // Schematic draw Items. The order of these items effects the sort order.
121  // It is currently ordered to mimic the old Eeschema locate behavior where
122  // the smallest item is the selected item.
123  SCH_MARKER_T,
124  SCH_JUNCTION_T,
125  SCH_NO_CONNECT_T,
126  SCH_BUS_WIRE_ENTRY_T,
127  SCH_BUS_BUS_ENTRY_T,
128  SCH_LINE_T,
129  SCH_BITMAP_T,
130  SCH_TEXT_T,
131  SCH_LABEL_T,
132  SCH_GLOBAL_LABEL_T,
133  SCH_HIER_LABEL_T,
134  SCH_FIELD_T,
135  SCH_SYMBOL_T,
136  SCH_SHEET_PIN_T,
137  SCH_SHEET_T,
138  SCH_PIN_T,
139 
140  // Be prudent with these types:
141  // they should be used only to locate a specific field type among SCH_FIELD_Ts
142  // N.B. If you add a type here, be sure to add it below to the BaseType()
143  SCH_FIELD_LOCATE_REFERENCE_T,
144  SCH_FIELD_LOCATE_VALUE_T,
145  SCH_FIELD_LOCATE_FOOTPRINT_T,
146  SCH_FIELD_LOCATE_DATASHEET_T,
147 
148  // Same for picking wires and buses from SCH_LINE_T items
149  SCH_LINE_LOCATE_WIRE_T,
150  SCH_LINE_LOCATE_BUS_T,
151  SCH_LINE_LOCATE_GRAPHIC_LINE_T,
152 
153  // Same for picking labels attached to wires and/or buses
154  SCH_LABEL_LOCATE_WIRE_T,
155  SCH_LABEL_LOCATE_BUS_T,
156 
157  // Same for picking symbols which are power symbols
158  SCH_SYMBOL_LOCATE_POWER_T,
159 
160  // matches any type
161  SCH_LOCATE_ANY_T,
162 
163  // General
164  SCH_SCREEN_T,
165 
166  SCHEMATIC_T,
167 
168  /*
169  * Draw items in library symbol.
170  *
171  * The order of these items effects the sort order for items inside the
172  * "DRAW/ENDDRAW" section of the symbol definition in a library file.
173  * If you add a new draw item, type, please make sure you add it so the
174  * sort order is logical.
175  */
176  LIB_SYMBOL_T,
177  LIB_ALIAS_T,
178  LIB_ARC_T,
179  LIB_CIRCLE_T,
180  LIB_TEXT_T,
181  LIB_RECTANGLE_T,
182  LIB_POLYLINE_T,
183  LIB_BEZIER_T,
184  LIB_PIN_T,
185 
186  /*
187  * Fields are not saved inside the "DRAW/ENDDRAW". Add new draw item
188  * types before this line.
189  */
190  LIB_FIELD_T,
191 
192  /*
193  * For GerbView: item types:
194  */
195  GERBER_LAYOUT_T,
196  GERBER_DRAW_ITEM_T,
197  GERBER_IMAGE_T,
198 
199  /*
200  * For Pl_Editor: item types:
201  */
202  WSG_LINE_T,
203  WSG_RECT_T,
204  WSG_POLY_T,
205  WSG_TEXT_T,
206  WSG_BITMAP_T,
207  WSG_PAGE_T,
208 
209  // serialized layout used in undo/redo commands
210  WS_PROXY_UNDO_ITEM_T, // serialized layout used in undo/redo commands
211  WS_PROXY_UNDO_ITEM_PLUS_T, // serialized layout plus page and title block settings
212 
213  /*
214  * FOR PROJECT::_ELEMs
215  */
216  SYMBOL_LIB_TABLE_T,
217  FP_LIB_TABLE_T,
218  SYMBOL_LIBS_T,
219  SEARCH_STACK_T,
220  S3D_CACHE_T,
221 
222  // End value
223  MAX_STRUCT_TYPE_ID
224 };
225 
235 constexpr KICAD_T BaseType( const KICAD_T aType )
236 {
237  switch( aType )
238  {
239  case SCH_FIELD_LOCATE_REFERENCE_T:
240  case SCH_FIELD_LOCATE_VALUE_T:
241  case SCH_FIELD_LOCATE_FOOTPRINT_T:
242  case SCH_FIELD_LOCATE_DATASHEET_T:
243  return SCH_FIELD_T;
244 
245  case SCH_LINE_LOCATE_WIRE_T:
246  case SCH_LINE_LOCATE_BUS_T:
247  case SCH_LINE_LOCATE_GRAPHIC_LINE_T:
248  return SCH_LINE_T;
249 
250  case SCH_LABEL_LOCATE_WIRE_T:
251  case SCH_LABEL_LOCATE_BUS_T:
252  return SCH_LABEL_T;
253 
254  case SCH_SYMBOL_LOCATE_POWER_T:
255  return SCH_SYMBOL_T;
256 
257  case PCB_LOCATE_HOLE_T:
258  case PCB_LOCATE_PTH_T:
259  case PCB_LOCATE_NPTH_T:
260  return PCB_LOCATE_HOLE_T;
261 
262  case PCB_DIM_ALIGNED_T:
263  case PCB_DIM_CENTER_T:
264  case PCB_DIM_ORTHOGONAL_T:
265  case PCB_DIM_LEADER_T:
266  return PCB_DIMENSION_T;
267 
268  default:
269  return aType;
270  }
271 }
272 
273 #endif // __KICAD_TYPEINFO_H
PCB_DIM_ALIGNED_T
class PCB_DIM_ALIGNED, a linear dimension (graphic item)
Definition: typeinfo.h:100
PCB_DIM_LEADER_T
class PCB_DIM_LEADER, a leader dimension (graphic item)
Definition: typeinfo.h:101
PCB_T
Definition: typeinfo.h:84
PCB_FP_TEXT_T
class FP_TEXT, text in a footprint
Definition: typeinfo.h:92
PCB_GROUP_T
class PCB_GROUP, a set of BOARD_ITEMs
Definition: typeinfo.h:108
BaseType
constexpr KICAD_T BaseType(const KICAD_T aType)
Return the underlying type of the given type.
Definition: typeinfo.h:235
PCB_DIM_CENTER_T
class PCB_DIM_CENTER, a center point marking (graphic item)
Definition: typeinfo.h:102
NOT_USED
the 3d code uses this value
Definition: typeinfo.h:79
PCB_TEXT_T
class PCB_TEXT, text on a layer
Definition: typeinfo.h:91
PCB_ARC_T
class PCB_ARC, an arc track segment on a copper layer
Definition: typeinfo.h:97
PCB_FP_SHAPE_T
class FP_SHAPE, a footprint edge
Definition: typeinfo.h:93
PCB_PAD_T
class PAD, a pad in a footprint
Definition: typeinfo.h:89
dyn_cast
Casted dyn_cast(From aObject)
A lightweight dynamic downcast.
Definition: typeinfo.h:61
EOT
search types array terminator (End Of Types)
Definition: typeinfo.h:81
KICAD_T
KICAD_T
The set of class identification values stored in EDA_ITEM::m_structType.
Definition: typeinfo.h:77
SCREEN_T
not really an item, used to identify a screen
Definition: typeinfo.h:85
PCB_TRACE_T
class PCB_TRACK, a track segment (segment on a copper layer)
Definition: typeinfo.h:95
I
#define I(x, y, z)
Definition: md5_hash.cpp:18
PCB_ITEM_LIST_T
class BOARD_ITEM_LIST, a list of board items
Definition: typeinfo.h:106
PCB_ZONE_T
class ZONE, a copper pour area
Definition: typeinfo.h:105
PCB_DIMENSION_T
class PCB_DIMENSION_BASE: abstract dimension meta-type
Definition: typeinfo.h:99
PCB_TARGET_T
class PCB_TARGET, a target (graphic item)
Definition: typeinfo.h:104
PCB_FOOTPRINT_T
class FOOTPRINT, a footprint
Definition: typeinfo.h:88
PCB_MARKER_T
class PCB_MARKER, a marker used to show something
Definition: typeinfo.h:98
PCB_NETINFO_T
class NETINFO_ITEM, a description of a net
Definition: typeinfo.h:107
PCB_FP_ZONE_T
class ZONE, managed by a footprint
Definition: typeinfo.h:94
EDA_ITEM
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:100
PCB_DIM_ORTHOGONAL_T
class PCB_DIM_ORTHOGONAL, a linear dimension constrained to x/y
Definition: typeinfo.h:103
PCB_VIA_T
class PCB_VIA, a via (like a track segment on a copper layer)
Definition: typeinfo.h:96
PCB_SHAPE_T
class PCB_SHAPE, a segment not on copper layers
Definition: typeinfo.h:90
IsA
bool IsA(const I *aObject)
Check if the type of aObject is T.
Definition: typeinfo.h:40