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 (C) 2004-2023 KiCad Developers, see change_log.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
111
112 // Be prudent with these types:
113 // they should be used only to locate a specific field type among PCB_FIELD_Ts
114 // N.B. If you add a type here, be sure to add it below to the BaseType()
119
120 // Be prudent with these types:
121 // they should be used only to locate specific item sub-types
122 // N.B. If you add a type here, be sure to add it below to the BaseType()
131
132 // Same for locating shapes types from PCB_SHAPE_T items
139
140 // Schematic draw Items. The order of these items effects the sort order.
141 // It is currently ordered to mimic the old Eeschema locate behavior where
142 // the smallest item is the selected item.
164
165 // Be prudent with these types:
166 // they should be used only to locate a specific field type among SCH_FIELD_Ts
167 // N.B. If you add a type here, be sure to add it below to the BaseType()
172
173 // Same for picking wires, buses and graphics from SCH_ITEM_T items
177
178 // Same for picking labels, or labels attached to wires and/or buses
182
183 // Same for picking symbols which are power symbols
185
186 // matches any type
188
189 // General
191
193
194 /*
195 * Draw items in library symbol.
196 *
197 * The order of these items effects the sort order for items inside the
198 * "DRAW/ENDDRAW" section of the symbol definition in a library file.
199 * If you add a new draw item, type, please make sure you add it so the
200 * sort order is logical.
201 */
207
208 /*
209 * Fields are not saved inside the "DRAW/ENDDRAW". Add new draw item
210 * types before this line.
211 */
213
214 /*
215 * For GerbView: item types:
216 */
220
221 /*
222 * For Pl_Editor: item types:
223 */
230
231 // serialized layout used in undo/redo commands
232 WS_PROXY_UNDO_ITEM_T, // serialized layout used in undo/redo commands
233 WS_PROXY_UNDO_ITEM_PLUS_T, // serialized layout plus page and title block settings
234
235 /*
236 * FOR PROJECT::_ELEMs
237 */
243
244 // End value
247
257constexpr KICAD_T BaseType( const KICAD_T aType )
258{
259 switch( aType )
260 {
265 return SCH_FIELD_T;
266
270 return SCH_LINE_T;
271
275 return SCH_LABEL_T;
276
278 return SCH_SYMBOL_T;
279
284 return PCB_FIELD_T;
285
287 case PCB_LOCATE_PTH_T:
289 return PCB_LOCATE_HOLE_T;
290
297 return PCB_SHAPE_T;
298
300 case PCB_DIM_CENTER_T:
301 case PCB_DIM_RADIAL_T:
303 case PCB_DIM_LEADER_T:
304 return PCB_DIMENSION_T;
305
306 default:
307 return aType;
308 }
309}
310
311constexpr bool IsNullType( const KICAD_T aType )
312{
313 return aType <= 0;
314}
315
316constexpr bool IsInstantiableType( const KICAD_T aType )
317{
318 if( IsNullType( aType ) )
319 return false;
320
321 switch( aType )
322 {
323 case SCH_LOCATE_ANY_T:
324
329
333
337
339
344
350 case PCB_LOCATE_PTH_T:
353
360
361 case PCB_DIMENSION_T:
362
363 case SCH_SCREEN_T:
364 case PCB_ITEM_LIST_T:
365 return false;
366
367 default:
368 break;
369 }
370
371 return true;
372
373}
374
375constexpr bool IsEeschemaType( const KICAD_T aType )
376{
377 switch( aType )
378 {
379 case SCH_MARKER_T:
380 case SCH_JUNCTION_T:
381 case SCH_NO_CONNECT_T:
384 case SCH_LINE_T:
385 case SCH_SHAPE_T:
386 case SCH_BITMAP_T:
387 case SCH_TEXT_T:
388 case SCH_TEXTBOX_T:
389 case SCH_TABLE_T:
390 case SCH_TABLECELL_T:
391 case SCH_LABEL_T:
394 case SCH_HIER_LABEL_T:
395 case SCH_FIELD_T:
396 case SCH_SYMBOL_T:
397 case SCH_SHEET_PIN_T:
398 case SCH_SHEET_T:
399 case SCH_PIN_T:
400
405
409
413
415 case SCH_LOCATE_ANY_T:
416
417 case SCH_SCREEN_T:
418 case SCHEMATIC_T:
419
420 case LIB_SYMBOL_T:
421 case LIB_SHAPE_T:
422 case LIB_TEXT_T:
423 case LIB_TEXTBOX_T:
424 case LIB_PIN_T:
425
426 case LIB_FIELD_T:
427 return true;
428
429 default:
430 return false;
431 }
432}
433
434constexpr bool IsPcbnewType( const KICAD_T aType )
435{
436 switch( aType )
437 {
438 case PCB_T:
439
440 case PCB_FOOTPRINT_T:
441 case PCB_PAD_T:
442 case PCB_SHAPE_T:
444 case PCB_FIELD_T:
445 case PCB_TEXT_T:
446 case PCB_TEXTBOX_T:
447 case PCB_TABLE_T:
448 case PCB_TABLECELL_T:
449 case PCB_TRACE_T:
450 case PCB_VIA_T:
451 case PCB_ARC_T:
452 case PCB_MARKER_T:
453 case PCB_DIMENSION_T:
455 case PCB_DIM_LEADER_T:
456 case PCB_DIM_CENTER_T:
457 case PCB_DIM_RADIAL_T:
459 case PCB_TARGET_T:
460 case PCB_ZONE_T:
461 case PCB_ITEM_LIST_T:
462 case PCB_NETINFO_T:
463 case PCB_GROUP_T:
464 case PCB_GENERATOR_T:
465
475 case PCB_LOCATE_PTH_T:
484 return true;
485
486 default:
487 return false;
488 }
489}
490
491constexpr bool IsGerbviewType( const KICAD_T aType )
492{
493 switch( aType )
494 {
495 case GERBER_LAYOUT_T:
497 case GERBER_IMAGE_T:
498 return true;
499
500 default:
501 return false;
502 }
503}
504
505constexpr bool IsPageLayoutEditorType( const KICAD_T aType )
506{
507 switch( aType )
508 {
509 case WSG_LINE_T:
510 case WSG_RECT_T:
511 case WSG_POLY_T:
512 case WSG_TEXT_T:
513 case WSG_BITMAP_T:
514 case WSG_PAGE_T:
515
518 return true;
519
520 default:
521 return false;
522 }
523}
524
525constexpr bool IsMiscType( const KICAD_T aType )
526{
527 switch( aType )
528 {
529 case SCREEN_T:
530
532 case FP_LIB_TABLE_T:
533 case SYMBOL_LIBS_T:
534 case SEARCH_STACK_T:
535 case S3D_CACHE_T:
536 return true;
537
538 default:
539 return false;
540 }
541}
542
543constexpr bool IsTypeCorrect( KICAD_T aType )
544{
545 return IsNullType( aType )
546 || IsEeschemaType( aType )
547 || IsPcbnewType( aType )
548 || IsGerbviewType( aType )
549 || IsPageLayoutEditorType( aType )
550 || IsMiscType( aType );
551}
552
553constexpr bool IsTypeAvailable( KICAD_T aType )
554{
555 if( !IsInstantiableType( aType ) )
556 return false;
557
558 if( IsEeschemaType( aType ) )
559 {
560#ifdef EESCHEMA
561 return true;
562#endif // EESCHEMA
563 }
564
565 if( IsPcbnewType( aType ) )
566 {
567#ifdef PCBNEW
568 return true;
569#endif // PCBNEW
570 }
571
572 if( IsGerbviewType( aType ) )
573 {
574#ifdef GERBVIEW
575 return true;
576#endif // GERBVIEW
577 }
578
579 if( IsPageLayoutEditorType( aType ) )
580 {
581#ifdef PL_EDITOR
582 return true;
583#endif // PL_EDITOR
584 }
585
586 return false;
587}
588
589#endif // __KICAD_TYPEINFO_H
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:85
#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:257
constexpr bool IsTypeAvailable(KICAD_T aType)
Definition: typeinfo.h:553
constexpr bool IsGerbviewType(const KICAD_T aType)
Definition: typeinfo.h:491
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:239
@ SCH_TABLE_T
Definition: typeinfo.h:153
@ 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:148
@ PCB_FIELD_LOCATE_VALUE_T
Definition: typeinfo.h:116
@ LIB_SYMBOL_T
Definition: typeinfo.h:202
@ SCH_NO_CONNECT_T
Definition: typeinfo.h:145
@ 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:168
@ LIB_TEXT_T
Definition: typeinfo.h:204
@ PCB_GENERATOR_T
class PCB_GENERATOR, generator on a layer
Definition: typeinfo.h:91
@ PCB_LOCATE_BOARD_EDGE_T
Definition: typeinfo.h:130
@ 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:170
@ TYPE_NOT_INIT
Definition: typeinfo.h:81
@ MAX_STRUCT_TYPE_ID
Definition: typeinfo.h:245
@ SCH_SYMBOL_T
Definition: typeinfo.h:160
@ 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:125
@ PCB_LOCATE_NPTH_T
Definition: typeinfo.h:129
@ PCB_GROUP_T
class PCB_GROUP, a set of BOARD_ITEMs
Definition: typeinfo.h:110
@ SCH_TABLECELL_T
Definition: typeinfo.h:154
@ 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
@ LIB_TEXTBOX_T
Definition: typeinfo.h:205
@ SCH_ITEM_LOCATE_WIRE_T
Definition: typeinfo.h:174
@ SCH_FIELD_T
Definition: typeinfo.h:159
@ PCB_TEXT_T
class PCB_TEXT, text on a layer
Definition: typeinfo.h:92
@ PCB_LOCATE_TEXT_T
Definition: typeinfo.h:126
@ SCH_DIRECTIVE_LABEL_T
Definition: typeinfo.h:158
@ SCH_LABEL_T
Definition: typeinfo.h:155
@ SCH_LOCATE_ANY_T
Definition: typeinfo.h:187
@ SCH_FIELD_LOCATE_VALUE_T
Definition: typeinfo.h:169
@ S3D_CACHE_T
Definition: typeinfo.h:242
@ SCH_SHEET_T
Definition: typeinfo.h:162
@ SCH_ITEM_LOCATE_BUS_T
Definition: typeinfo.h:175
@ LIB_SHAPE_T
Definition: typeinfo.h:203
@ PCB_REFERENCE_IMAGE_T
class PCB_REFERENCE_IMAGE, bitmap on a layer
Definition: typeinfo.h:89
@ SCH_MARKER_T
Definition: typeinfo.h:143
@ PCB_ITEM_LIST_T
class BOARD_ITEM_LIST, a list of board items
Definition: typeinfo.h:108
@ SCH_SHAPE_T
Definition: typeinfo.h:149
@ WSG_POLY_T
Definition: typeinfo.h:226
@ PCB_FIELD_T
class PCB_FIELD, text associated with a footprint property
Definition: typeinfo.h:90
@ PCB_LOCATE_STDVIA_T
Definition: typeinfo.h:123
@ GERBER_DRAW_ITEM_T
Definition: typeinfo.h:218
@ SCH_HIER_LABEL_T
Definition: typeinfo.h:157
@ 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:224
@ SCH_BUS_BUS_ENTRY_T
Definition: typeinfo.h:147
@ LIB_PIN_T
Definition: typeinfo.h:206
@ SCH_SCREEN_T
Definition: typeinfo.h:190
@ PCB_TARGET_T
class PCB_TARGET, a target (graphic item)
Definition: typeinfo.h:106
@ SCH_LABEL_LOCATE_ANY_T
Definition: typeinfo.h:179
@ PCB_SHAPE_LOCATE_CIRCLE_T
Definition: typeinfo.h:135
@ PCB_SHAPE_LOCATE_SEGMENT_T
Definition: typeinfo.h:133
@ SCH_FIELD_LOCATE_DATASHEET_T
Definition: typeinfo.h:171
@ PCB_SHAPE_LOCATE_RECT_T
Definition: typeinfo.h:134
@ SYMBOL_LIB_TABLE_T
Definition: typeinfo.h:238
@ SCH_ITEM_LOCATE_GRAPHIC_LINE_T
Definition: typeinfo.h:176
@ SCHEMATIC_T
Definition: typeinfo.h:192
@ SCH_LABEL_LOCATE_WIRE_T
Definition: typeinfo.h:180
@ WSG_TEXT_T
Definition: typeinfo.h:227
@ 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:161
@ 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:115
@ SCH_TEXT_T
Definition: typeinfo.h:152
@ PCB_SHAPE_LOCATE_BEZIER_T
Definition: typeinfo.h:138
@ WSG_PAGE_T
Definition: typeinfo.h:229
@ WS_PROXY_UNDO_ITEM_T
Definition: typeinfo.h:232
@ SEARCH_STACK_T
Definition: typeinfo.h:241
@ SYMBOL_LIBS_T
Definition: typeinfo.h:240
@ LIB_FIELD_T
Definition: typeinfo.h:212
@ SCH_LABEL_LOCATE_BUS_T
Definition: typeinfo.h:181
@ PCB_LOCATE_PTH_T
Definition: typeinfo.h:128
@ PCB_PAD_T
class PAD, a pad in a footprint
Definition: typeinfo.h:87
@ WSG_RECT_T
Definition: typeinfo.h:225
@ PCB_SHAPE_LOCATE_POLY_T
Definition: typeinfo.h:137
@ PCB_SHAPE_LOCATE_ARC_T
Definition: typeinfo.h:136
@ SCH_SYMBOL_LOCATE_POWER_T
Definition: typeinfo.h:184
@ GERBER_IMAGE_T
Definition: typeinfo.h:219
@ SCH_BUS_WIRE_ENTRY_T
Definition: typeinfo.h:146
@ GERBER_LAYOUT_T
Definition: typeinfo.h:217
@ SCREEN_T
not really an item, used to identify a screen
Definition: typeinfo.h:83
@ SCH_BITMAP_T
Definition: typeinfo.h:150
@ 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:233
@ PCB_LOCATE_UVIA_T
Definition: typeinfo.h:124
@ 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:151
@ WSG_BITMAP_T
Definition: typeinfo.h:228
@ PCB_LOCATE_HOLE_T
Definition: typeinfo.h:127
@ PCB_FIELD_LOCATE_DATASHEET_T
Definition: typeinfo.h:118
@ 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:156
@ PCB_FIELD_LOCATE_FOOTPRINT_T
Definition: typeinfo.h:117
@ SCH_JUNCTION_T
Definition: typeinfo.h:144
@ SCH_PIN_T
Definition: typeinfo.h:163
constexpr bool IsTypeCorrect(KICAD_T aType)
Definition: typeinfo.h:543
constexpr bool IsPcbnewType(const KICAD_T aType)
Definition: typeinfo.h:434
constexpr bool IsMiscType(const KICAD_T aType)
Definition: typeinfo.h:525
constexpr bool IsInstantiableType(const KICAD_T aType)
Definition: typeinfo.h:316
Casted dyn_cast(From aObject)
A lightweight dynamic downcast.
Definition: typeinfo.h:61
constexpr bool IsNullType(const KICAD_T aType)
Definition: typeinfo.h:311
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:375
constexpr bool IsPageLayoutEditorType(const KICAD_T aType)
Definition: typeinfo.h:505