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 /*
141 * Draw items in library symbol.
142 *
143 * The order of these items effects the sort order for items inside the
144 * "DRAW/ENDDRAW" section of the symbol definition in a library file.
145 * If you add a new draw item, type, please make sure you add it so the
146 * sort order is logical.
147 */
154
155 // Schematic draw Items. The order of these items effects the sort order.
156 // It is currently ordered to mimic the old Eeschema locate behavior where
157 // the smallest item is the selected item.
175
176 // Be prudent with these types:
177 // they should be used only to locate a specific field type among SCH_FIELD_Ts
178 // N.B. If you add a type here, be sure to add it below to the BaseType()
183
184 // Same for picking wires, buses and graphics from SCH_ITEM_T items
188
189 // Same for picking labels, or labels attached to wires and/or buses
193
194 // Same for picking symbols which are power symbols
196
197 // matches any type
199
200 // General
202
204
205 /*
206 * For GerbView: item types:
207 */
211
212 /*
213 * For Pl_Editor: item types:
214 */
221
222 // serialized layout used in undo/redo commands
223 WS_PROXY_UNDO_ITEM_T, // serialized layout used in undo/redo commands
224 WS_PROXY_UNDO_ITEM_PLUS_T, // serialized layout plus page and title block settings
225
226 /*
227 * FOR PROJECT::_ELEMs
228 */
234
235 // End value
238
248constexpr KICAD_T BaseType( const KICAD_T aType )
249{
250 switch( aType )
251 {
256 return SCH_FIELD_T;
257
261 return SCH_LINE_T;
262
266 return SCH_LABEL_T;
267
269 return SCH_SYMBOL_T;
270
275 return PCB_FIELD_T;
276
278 case PCB_LOCATE_PTH_T:
280 return PCB_LOCATE_HOLE_T;
281
288 return PCB_SHAPE_T;
289
291 case PCB_DIM_CENTER_T:
292 case PCB_DIM_RADIAL_T:
294 case PCB_DIM_LEADER_T:
295 return PCB_DIMENSION_T;
296
297 default:
298 return aType;
299 }
300}
301
302constexpr bool IsNullType( const KICAD_T aType )
303{
304 return aType <= 0;
305}
306
307constexpr bool IsInstantiableType( const KICAD_T aType )
308{
309 if( IsNullType( aType ) )
310 return false;
311
312 switch( aType )
313 {
314 case SCH_LOCATE_ANY_T:
315
320
324
328
330
335
341 case PCB_LOCATE_PTH_T:
344
351
352 case PCB_DIMENSION_T:
353
354 case SCH_SCREEN_T:
355 case PCB_ITEM_LIST_T:
356 return false;
357
358 default:
359 break;
360 }
361
362 return true;
363
364}
365
366constexpr bool IsEeschemaType( const KICAD_T aType )
367{
368 switch( aType )
369 {
370 case SCH_MARKER_T:
371 case SCH_JUNCTION_T:
372 case SCH_NO_CONNECT_T:
375 case SCH_LINE_T:
376 case SCH_SHAPE_T:
377 case SCH_BITMAP_T:
378 case SCH_TEXT_T:
379 case SCH_TEXTBOX_T:
380 case SCH_TABLE_T:
381 case SCH_TABLECELL_T:
382 case SCH_LABEL_T:
385 case SCH_HIER_LABEL_T:
386 case SCH_FIELD_T:
387 case SCH_SYMBOL_T:
388 case SCH_SHEET_PIN_T:
389 case SCH_SHEET_T:
390 case SCH_PIN_T:
391
396
400
404
406 case SCH_LOCATE_ANY_T:
407
408 case SCH_SCREEN_T:
409 case SCHEMATIC_T:
410
411 case LIB_SYMBOL_T:
412 case LIB_PIN_T:
413 return true;
414
415 default:
416 return false;
417 }
418}
419
420constexpr bool IsPcbnewType( const KICAD_T aType )
421{
422 switch( aType )
423 {
424 case PCB_T:
425
426 case PCB_FOOTPRINT_T:
427 case PCB_PAD_T:
428 case PCB_SHAPE_T:
430 case PCB_FIELD_T:
431 case PCB_TEXT_T:
432 case PCB_TEXTBOX_T:
433 case PCB_TABLE_T:
434 case PCB_TABLECELL_T:
435 case PCB_TRACE_T:
436 case PCB_VIA_T:
437 case PCB_ARC_T:
438 case PCB_MARKER_T:
439 case PCB_DIMENSION_T:
441 case PCB_DIM_LEADER_T:
442 case PCB_DIM_CENTER_T:
443 case PCB_DIM_RADIAL_T:
445 case PCB_TARGET_T:
446 case PCB_ZONE_T:
447 case PCB_ITEM_LIST_T:
448 case PCB_NETINFO_T:
449 case PCB_GROUP_T:
450 case PCB_GENERATOR_T:
451
461 case PCB_LOCATE_PTH_T:
470 return true;
471
472 default:
473 return false;
474 }
475}
476
477constexpr bool IsGerbviewType( const KICAD_T aType )
478{
479 switch( aType )
480 {
481 case GERBER_LAYOUT_T:
483 case GERBER_IMAGE_T:
484 return true;
485
486 default:
487 return false;
488 }
489}
490
491constexpr bool IsPageLayoutEditorType( const KICAD_T aType )
492{
493 switch( aType )
494 {
495 case WSG_LINE_T:
496 case WSG_RECT_T:
497 case WSG_POLY_T:
498 case WSG_TEXT_T:
499 case WSG_BITMAP_T:
500 case WSG_PAGE_T:
501
504 return true;
505
506 default:
507 return false;
508 }
509}
510
511constexpr bool IsMiscType( const KICAD_T aType )
512{
513 switch( aType )
514 {
515 case SCREEN_T:
516
518 case FP_LIB_TABLE_T:
519 case SYMBOL_LIBS_T:
520 case SEARCH_STACK_T:
521 case S3D_CACHE_T:
522 return true;
523
524 default:
525 return false;
526 }
527}
528
529constexpr bool IsTypeCorrect( KICAD_T aType )
530{
531 return IsNullType( aType )
532 || IsEeschemaType( aType )
533 || IsPcbnewType( aType )
534 || IsGerbviewType( aType )
535 || IsPageLayoutEditorType( aType )
536 || IsMiscType( aType );
537}
538
539constexpr bool IsTypeAvailable( KICAD_T aType )
540{
541 if( !IsInstantiableType( aType ) )
542 return false;
543
544 if( IsEeschemaType( aType ) )
545 {
546#ifdef EESCHEMA
547 return true;
548#endif // EESCHEMA
549 }
550
551 if( IsPcbnewType( aType ) )
552 {
553#ifdef PCBNEW
554 return true;
555#endif // PCBNEW
556 }
557
558 if( IsGerbviewType( aType ) )
559 {
560#ifdef GERBVIEW
561 return true;
562#endif // GERBVIEW
563 }
564
565 if( IsPageLayoutEditorType( aType ) )
566 {
567#ifdef PL_EDITOR
568 return true;
569#endif // PL_EDITOR
570 }
571
572 return false;
573}
574
575#endif // __KICAD_TYPEINFO_H
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:88
#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:248
constexpr bool IsTypeAvailable(KICAD_T aType)
Definition: typeinfo.h:539
constexpr bool IsGerbviewType(const KICAD_T aType)
Definition: typeinfo.h:477
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:230
@ SCH_TABLE_T
Definition: typeinfo.h:165
@ 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:163
@ PCB_FIELD_LOCATE_VALUE_T
Definition: typeinfo.h:116
@ LIB_SYMBOL_T
Definition: typeinfo.h:148
@ SCH_NO_CONNECT_T
Definition: typeinfo.h:160
@ 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:179
@ 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:181
@ TYPE_NOT_INIT
Definition: typeinfo.h:81
@ MAX_STRUCT_TYPE_ID
Definition: typeinfo.h:236
@ SCH_SYMBOL_T
Definition: typeinfo.h:171
@ 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:166
@ 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:185
@ SCH_FIELD_T
Definition: typeinfo.h:150
@ 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:170
@ SCH_LABEL_T
Definition: typeinfo.h:167
@ SCH_LOCATE_ANY_T
Definition: typeinfo.h:198
@ SCH_FIELD_LOCATE_VALUE_T
Definition: typeinfo.h:180
@ S3D_CACHE_T
Definition: typeinfo.h:233
@ SCH_SHEET_T
Definition: typeinfo.h:173
@ SCH_ITEM_LOCATE_BUS_T
Definition: typeinfo.h:186
@ PCB_REFERENCE_IMAGE_T
class PCB_REFERENCE_IMAGE, bitmap on a layer
Definition: typeinfo.h:89
@ SCH_MARKER_T
Definition: typeinfo.h:158
@ 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:217
@ 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:209
@ SCH_HIER_LABEL_T
Definition: typeinfo.h:169
@ 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:215
@ SCH_BUS_BUS_ENTRY_T
Definition: typeinfo.h:162
@ LIB_PIN_T
Definition: typeinfo.h:153
@ SCH_SCREEN_T
Definition: typeinfo.h:201
@ PCB_TARGET_T
class PCB_TARGET, a target (graphic item)
Definition: typeinfo.h:106
@ SCH_LABEL_LOCATE_ANY_T
Definition: typeinfo.h:190
@ 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:182
@ PCB_SHAPE_LOCATE_RECT_T
Definition: typeinfo.h:134
@ SYMBOL_LIB_TABLE_T
Definition: typeinfo.h:229
@ SCH_ITEM_LOCATE_GRAPHIC_LINE_T
Definition: typeinfo.h:187
@ SCHEMATIC_T
Definition: typeinfo.h:203
@ SCH_LABEL_LOCATE_WIRE_T
Definition: typeinfo.h:191
@ WSG_TEXT_T
Definition: typeinfo.h:218
@ 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:172
@ 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:151
@ PCB_SHAPE_LOCATE_BEZIER_T
Definition: typeinfo.h:138
@ WSG_PAGE_T
Definition: typeinfo.h:220
@ WS_PROXY_UNDO_ITEM_T
Definition: typeinfo.h:223
@ SEARCH_STACK_T
Definition: typeinfo.h:232
@ SYMBOL_LIBS_T
Definition: typeinfo.h:231
@ SCH_LABEL_LOCATE_BUS_T
Definition: typeinfo.h:192
@ 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:216
@ 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:195
@ GERBER_IMAGE_T
Definition: typeinfo.h:210
@ SCH_BUS_WIRE_ENTRY_T
Definition: typeinfo.h:161
@ GERBER_LAYOUT_T
Definition: typeinfo.h:208
@ SCREEN_T
not really an item, used to identify a screen
Definition: typeinfo.h:83
@ SCH_BITMAP_T
Definition: typeinfo.h:164
@ 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:224
@ 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:152
@ WSG_BITMAP_T
Definition: typeinfo.h:219
@ 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:168
@ PCB_FIELD_LOCATE_FOOTPRINT_T
Definition: typeinfo.h:117
@ SCH_JUNCTION_T
Definition: typeinfo.h:159
@ SCH_PIN_T
Definition: typeinfo.h:174
constexpr bool IsTypeCorrect(KICAD_T aType)
Definition: typeinfo.h:529
constexpr bool IsPcbnewType(const KICAD_T aType)
Definition: typeinfo.h:420
constexpr bool IsMiscType(const KICAD_T aType)
Definition: typeinfo.h:511
constexpr bool IsInstantiableType(const KICAD_T aType)
Definition: typeinfo.h:307
Casted dyn_cast(From aObject)
A lightweight dynamic downcast.
Definition: typeinfo.h:61
constexpr bool IsNullType(const KICAD_T aType)
Definition: typeinfo.h:302
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:366
constexpr bool IsPageLayoutEditorType(const KICAD_T aType)
Definition: typeinfo.h:491