KiCad PCB EDA Suite
Loading...
Searching...
No Matches
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 The KiCad Developers, see AUTHORS.txt for contributors.
6 * @author Tomasz Wlostowski <[email protected]>
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
39template <class T, class I>
40bool IsA( const I* aObject )
41{
42 return aObject && std::remove_pointer<T>::type::ClassOf( aObject );
43}
44
45template <class T, class I>
46bool IsA( const I& aObject )
47{
48 return std::remove_pointer<T>::type::ClassOf( &aObject );
49}
50
60template<class Casted, class From>
61Casted 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
69class EDA_ITEM;
70
71#endif // SWIG
72
73
78{
79 NOT_USED = -1,
80
84
85 // Items in pcb
112
113 // Be prudent with these types:
114 // they should be used only to locate a specific field type among PCB_FIELD_Ts
115 // N.B. If you add a type here, be sure to add it below to the BaseType()
120
121 // Be prudent with these types:
122 // they should be used only to locate specific item sub-types
123 // N.B. If you add a type here, be sure to add it below to the BaseType()
132
133 // Same for locating shapes types from PCB_SHAPE_T items
140
141 /*
142 * Draw items in library symbol.
143 *
144 * The order of these items effects the sort order for items inside the
145 * "DRAW/ENDDRAW" section of the symbol definition in a library file.
146 * If you add a new draw item, type, please make sure you add it so the
147 * sort order is logical.
148 */
155
156 // Schematic draw Items. The order of these items effects the sort order.
157 // It is currently ordered to mimic the old Eeschema locate behavior where
158 // the smallest item is the selected item.
177
178 // Be prudent with these types:
179 // they should be used only to locate a specific field type among SCH_FIELD_Ts
180 // N.B. If you add a type here, be sure to add it below to the BaseType()
185
186 // Same for picking wires, buses and graphics from SCH_ITEM_T items
190
191 // Same for picking labels, or labels attached to wires and/or buses
195
196 // Same for picking symbols which are power symbols
198
199 // matches any type
201
202 // General
204
206
207 /*
208 * For GerbView: item types:
209 */
213
214 /*
215 * For Pl_Editor: item types:
216 */
223
224 // serialized layout used in undo/redo commands
225 WS_PROXY_UNDO_ITEM_T, // serialized layout used in undo/redo commands
226 WS_PROXY_UNDO_ITEM_PLUS_T, // serialized layout plus page and title block settings
227
228 /*
229 * FOR PROJECT::_ELEMs
230 */
237
238 // End value
241
251constexpr KICAD_T BaseType( const KICAD_T aType )
252{
253 switch( aType )
254 {
259 return SCH_FIELD_T;
260
264 return SCH_LINE_T;
265
269 return SCH_LABEL_T;
270
272 return SCH_SYMBOL_T;
273
278 return PCB_FIELD_T;
279
281 case PCB_LOCATE_PTH_T:
283 return PCB_LOCATE_HOLE_T;
284
291 return PCB_SHAPE_T;
292
294 case PCB_DIM_CENTER_T:
295 case PCB_DIM_RADIAL_T:
297 case PCB_DIM_LEADER_T:
298 return PCB_DIMENSION_T;
299
300 default:
301 return aType;
302 }
303}
304
305constexpr bool IsNullType( const KICAD_T aType )
306{
307 return aType <= 0;
308}
309
310constexpr bool IsInstantiableType( const KICAD_T aType )
311{
312 if( IsNullType( aType ) )
313 return false;
314
315 switch( aType )
316 {
317 case SCH_LOCATE_ANY_T:
318
323
327
331
333
338
344 case PCB_LOCATE_PTH_T:
347
354
355 case PCB_DIMENSION_T:
356
357 case SCH_SCREEN_T:
358 case PCB_ITEM_LIST_T:
359 return false;
360
361 default:
362 break;
363 }
364
365 return true;
366
367}
368
369constexpr bool IsEeschemaType( const KICAD_T aType )
370{
371 switch( aType )
372 {
373 case SCH_MARKER_T:
374 case SCH_JUNCTION_T:
375 case SCH_NO_CONNECT_T:
378 case SCH_LINE_T:
379 case SCH_SHAPE_T:
380 case SCH_RULE_AREA_T:
381 case SCH_BITMAP_T:
382 case SCH_TEXT_T:
383 case SCH_TEXTBOX_T:
384 case SCH_TABLE_T:
385 case SCH_TABLECELL_T:
386 case SCH_LABEL_T:
389 case SCH_HIER_LABEL_T:
390 case SCH_FIELD_T:
391 case SCH_SYMBOL_T:
392 case SCH_SHEET_PIN_T:
393 case SCH_GROUP_T:
394 case SCH_SHEET_T:
395 case SCH_PIN_T:
396
401
405
409
411 case SCH_LOCATE_ANY_T:
412
413 case SCH_SCREEN_T:
414 case SCHEMATIC_T:
415
416 case LIB_SYMBOL_T:
417 return true;
418
419 default:
420 return false;
421 }
422}
423
424constexpr bool IsPcbnewType( const KICAD_T aType )
425{
426 switch( aType )
427 {
428 case PCB_T:
429
430 case PCB_FOOTPRINT_T:
431 case PCB_PAD_T:
432 case PCB_SHAPE_T:
434 case PCB_FIELD_T:
435 case PCB_TEXT_T:
436 case PCB_TEXTBOX_T:
437 case PCB_TABLE_T:
438 case PCB_TABLECELL_T:
439 case PCB_TRACE_T:
440 case PCB_VIA_T:
441 case PCB_ARC_T:
442 case PCB_MARKER_T:
443 case PCB_DIMENSION_T:
445 case PCB_DIM_LEADER_T:
446 case PCB_DIM_CENTER_T:
447 case PCB_DIM_RADIAL_T:
449 case PCB_TARGET_T:
450 case PCB_ZONE_T:
451 case PCB_ITEM_LIST_T:
452 case PCB_NETINFO_T:
453 case PCB_GROUP_T:
454 case PCB_GENERATOR_T:
455
465 case PCB_LOCATE_PTH_T:
475 return true;
476
477 default:
478 return false;
479 }
480}
481
482constexpr bool IsGerbviewType( const KICAD_T aType )
483{
484 switch( aType )
485 {
486 case GERBER_LAYOUT_T:
488 case GERBER_IMAGE_T:
489 return true;
490
491 default:
492 return false;
493 }
494}
495
496constexpr bool IsPageLayoutEditorType( const KICAD_T aType )
497{
498 switch( aType )
499 {
500 case WSG_LINE_T:
501 case WSG_RECT_T:
502 case WSG_POLY_T:
503 case WSG_TEXT_T:
504 case WSG_BITMAP_T:
505 case WSG_PAGE_T:
506
509 return true;
510
511 default:
512 return false;
513 }
514}
515
516constexpr bool IsMiscType( const KICAD_T aType )
517{
518 switch( aType )
519 {
520 case SCREEN_T:
521
523 case FP_LIB_TABLE_T:
525 case SYMBOL_LIBS_T:
526 case SEARCH_STACK_T:
527 case S3D_CACHE_T:
528 return true;
529
530 default:
531 return false;
532 }
533}
534
535constexpr bool IsTypeCorrect( KICAD_T aType )
536{
537 return IsNullType( aType )
538 || IsEeschemaType( aType )
539 || IsPcbnewType( aType )
540 || IsGerbviewType( aType )
541 || IsPageLayoutEditorType( aType )
542 || IsMiscType( aType );
543}
544
545#endif // __KICAD_TYPEINFO_H
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:98
#define I(x, y, z)
Definition: md5_hash.cpp:18
constexpr KICAD_T BaseType(const KICAD_T aType)
Return the underlying type of the given type.
Definition: typeinfo.h:251
constexpr bool IsGerbviewType(const KICAD_T aType)
Definition: typeinfo.h:482
KICAD_T
The set of class identification values stored in EDA_ITEM::m_structType.
Definition: typeinfo.h:78
@ FP_LIB_TABLE_T
Definition: typeinfo.h:232
@ SCH_GROUP_T
Definition: typeinfo.h:174
@ SCH_TABLE_T
Definition: typeinfo.h:166
@ PCB_T
Definition: typeinfo.h:82
@ PCB_SHAPE_T
class PCB_SHAPE, a segment not on copper layers
Definition: typeinfo.h:88
@ PCB_DIM_ORTHOGONAL_T
class PCB_DIM_ORTHOGONAL, a linear dimension constrained to x/y
Definition: typeinfo.h:105
@ SCH_LINE_T
Definition: typeinfo.h:164
@ PCB_FIELD_LOCATE_VALUE_T
Definition: typeinfo.h:117
@ LIB_SYMBOL_T
Definition: typeinfo.h:149
@ SCH_NO_CONNECT_T
Definition: typeinfo.h:161
@ PCB_DIM_LEADER_T
class PCB_DIM_LEADER, a leader dimension (graphic item)
Definition: typeinfo.h:102
@ SCH_FIELD_LOCATE_REFERENCE_T
Definition: typeinfo.h:181
@ PCB_GENERATOR_T
class PCB_GENERATOR, generator on a layer
Definition: typeinfo.h:91
@ PCB_LOCATE_BOARD_EDGE_T
Definition: typeinfo.h:131
@ PCB_VIA_T
class PCB_VIA, a via (like a track segment on a copper layer)
Definition: typeinfo.h:97
@ SCH_FIELD_LOCATE_FOOTPRINT_T
Definition: typeinfo.h:183
@ TYPE_NOT_INIT
Definition: typeinfo.h:81
@ MAX_STRUCT_TYPE_ID
Definition: typeinfo.h:239
@ SCH_SYMBOL_T
Definition: typeinfo.h:173
@ PCB_DIM_CENTER_T
class PCB_DIM_CENTER, a center point marking (graphic item)
Definition: typeinfo.h:103
@ PCB_LOCATE_BBVIA_T
Definition: typeinfo.h:126
@ PCB_LOCATE_NPTH_T
Definition: typeinfo.h:130
@ PCB_GROUP_T
class PCB_GROUP, a set of BOARD_ITEMs
Definition: typeinfo.h:110
@ SCH_TABLECELL_T
Definition: typeinfo.h:167
@ PCB_TEXTBOX_T
class PCB_TEXTBOX, wrapped text on a layer
Definition: typeinfo.h:93
@ PCB_ZONE_T
class ZONE, a copper pour area
Definition: typeinfo.h:107
@ SCH_ITEM_LOCATE_WIRE_T
Definition: typeinfo.h:187
@ SCH_FIELD_T
Definition: typeinfo.h:151
@ PCB_TEXT_T
class PCB_TEXT, text on a layer
Definition: typeinfo.h:92
@ PCB_LOCATE_TEXT_T
Definition: typeinfo.h:127
@ SCH_DIRECTIVE_LABEL_T
Definition: typeinfo.h:172
@ SCH_LABEL_T
Definition: typeinfo.h:168
@ SCH_LOCATE_ANY_T
Definition: typeinfo.h:200
@ SCH_FIELD_LOCATE_VALUE_T
Definition: typeinfo.h:182
@ S3D_CACHE_T
Definition: typeinfo.h:236
@ SCH_SHEET_T
Definition: typeinfo.h:176
@ SCH_ITEM_LOCATE_BUS_T
Definition: typeinfo.h:188
@ PCB_REFERENCE_IMAGE_T
class PCB_REFERENCE_IMAGE, bitmap on a layer
Definition: typeinfo.h:89
@ SCH_MARKER_T
Definition: typeinfo.h:159
@ PCB_ITEM_LIST_T
class BOARD_ITEM_LIST, a list of board items
Definition: typeinfo.h:108
@ SCH_SHAPE_T
Definition: typeinfo.h:150
@ WSG_POLY_T
Definition: typeinfo.h:219
@ SCH_RULE_AREA_T
Definition: typeinfo.h:171
@ PCB_FIELD_T
class PCB_FIELD, text associated with a footprint property
Definition: typeinfo.h:90
@ PCB_LOCATE_STDVIA_T
Definition: typeinfo.h:124
@ GERBER_DRAW_ITEM_T
Definition: typeinfo.h:211
@ SCH_HIER_LABEL_T
Definition: typeinfo.h:170
@ NOT_USED
the 3d code uses this value
Definition: typeinfo.h:79
@ PCB_MARKER_T
class PCB_MARKER, a marker used to show something
Definition: typeinfo.h:99
@ WSG_LINE_T
Definition: typeinfo.h:217
@ SCH_BUS_BUS_ENTRY_T
Definition: typeinfo.h:163
@ SCH_SCREEN_T
Definition: typeinfo.h:203
@ PCB_TARGET_T
class PCB_TARGET, a target (graphic item)
Definition: typeinfo.h:106
@ SCH_LABEL_LOCATE_ANY_T
Definition: typeinfo.h:192
@ PCB_SHAPE_LOCATE_CIRCLE_T
Definition: typeinfo.h:136
@ PCB_SHAPE_LOCATE_SEGMENT_T
Definition: typeinfo.h:134
@ SCH_FIELD_LOCATE_DATASHEET_T
Definition: typeinfo.h:184
@ PCB_SHAPE_LOCATE_RECT_T
Definition: typeinfo.h:135
@ SYMBOL_LIB_TABLE_T
Definition: typeinfo.h:231
@ SCH_ITEM_LOCATE_GRAPHIC_LINE_T
Definition: typeinfo.h:189
@ SCHEMATIC_T
Definition: typeinfo.h:205
@ SCH_LABEL_LOCATE_WIRE_T
Definition: typeinfo.h:193
@ WSG_TEXT_T
Definition: typeinfo.h:220
@ PCB_TABLECELL_T
class PCB_TABLECELL, PCB_TEXTBOX for use in tables
Definition: typeinfo.h:95
@ PCB_FOOTPRINT_T
class FOOTPRINT, a footprint
Definition: typeinfo.h:86
@ SCH_SHEET_PIN_T
Definition: typeinfo.h:175
@ PCB_DIM_ALIGNED_T
class PCB_DIM_ALIGNED, a linear dimension (graphic item)
Definition: typeinfo.h:101
@ PCB_FIELD_LOCATE_REFERENCE_T
Definition: typeinfo.h:116
@ SCH_TEXT_T
Definition: typeinfo.h:152
@ PCB_SHAPE_LOCATE_BEZIER_T
Definition: typeinfo.h:139
@ WSG_PAGE_T
Definition: typeinfo.h:222
@ WS_PROXY_UNDO_ITEM_T
Definition: typeinfo.h:225
@ SEARCH_STACK_T
Definition: typeinfo.h:235
@ SYMBOL_LIBS_T
Definition: typeinfo.h:234
@ SCH_LABEL_LOCATE_BUS_T
Definition: typeinfo.h:194
@ PCB_LOCATE_PTH_T
Definition: typeinfo.h:129
@ PCB_PAD_T
class PAD, a pad in a footprint
Definition: typeinfo.h:87
@ WSG_RECT_T
Definition: typeinfo.h:218
@ PCB_SHAPE_LOCATE_POLY_T
Definition: typeinfo.h:138
@ PCB_SHAPE_LOCATE_ARC_T
Definition: typeinfo.h:137
@ SCH_SYMBOL_LOCATE_POWER_T
Definition: typeinfo.h:197
@ DESIGN_BLOCK_LIB_TABLE_T
Definition: typeinfo.h:233
@ GERBER_IMAGE_T
Definition: typeinfo.h:212
@ SCH_BUS_WIRE_ENTRY_T
Definition: typeinfo.h:162
@ GERBER_LAYOUT_T
Definition: typeinfo.h:210
@ SCREEN_T
not really an item, used to identify a screen
Definition: typeinfo.h:83
@ SCH_BITMAP_T
Definition: typeinfo.h:165
@ PCB_BOARD_OUTLINE_T
class PCB_BOARD_OUTLINE_T, a pcb board outline item
Definition: typeinfo.h:111
@ PCB_ARC_T
class PCB_ARC, an arc track segment on a copper layer
Definition: typeinfo.h:98
@ WS_PROXY_UNDO_ITEM_PLUS_T
Definition: typeinfo.h:226
@ PCB_LOCATE_UVIA_T
Definition: typeinfo.h:125
@ PCB_DIMENSION_T
class PCB_DIMENSION_BASE: abstract dimension meta-type
Definition: typeinfo.h:100
@ PCB_TABLE_T
class PCB_TABLE, table of PCB_TABLECELLs
Definition: typeinfo.h:94
@ PCB_NETINFO_T
class NETINFO_ITEM, a description of a net
Definition: typeinfo.h:109
@ SCH_TEXTBOX_T
Definition: typeinfo.h:153
@ WSG_BITMAP_T
Definition: typeinfo.h:221
@ PCB_LOCATE_HOLE_T
Definition: typeinfo.h:128
@ PCB_FIELD_LOCATE_DATASHEET_T
Definition: typeinfo.h:119
@ PCB_TRACE_T
class PCB_TRACK, a track segment (segment on a copper layer)
Definition: typeinfo.h:96
@ PCB_DIM_RADIAL_T
class PCB_DIM_RADIAL, a radius or diameter dimension
Definition: typeinfo.h:104
@ SCH_GLOBAL_LABEL_T
Definition: typeinfo.h:169
@ PCB_FIELD_LOCATE_FOOTPRINT_T
Definition: typeinfo.h:118
@ SCH_JUNCTION_T
Definition: typeinfo.h:160
@ SCH_PIN_T
Definition: typeinfo.h:154
constexpr bool IsTypeCorrect(KICAD_T aType)
Definition: typeinfo.h:535
constexpr bool IsPcbnewType(const KICAD_T aType)
Definition: typeinfo.h:424
constexpr bool IsMiscType(const KICAD_T aType)
Definition: typeinfo.h:516
constexpr bool IsInstantiableType(const KICAD_T aType)
Definition: typeinfo.h:310
Casted dyn_cast(From aObject)
A lightweight dynamic downcast.
Definition: typeinfo.h:61
constexpr bool IsNullType(const KICAD_T aType)
Definition: typeinfo.h:305
bool IsA(const I *aObject)
Check if the type of aObject is T.
Definition: typeinfo.h:40
constexpr bool IsEeschemaType(const KICAD_T aType)
Definition: typeinfo.h:369
constexpr bool IsPageLayoutEditorType(const KICAD_T aType)
Definition: typeinfo.h:496