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
113
114 // Be prudent with these types:
115 // they should be used only to locate a specific field type among PCB_FIELD_Ts
116 // N.B. If you add a type here, be sure to add it below to the BaseType()
121
122 // Be prudent with these types:
123 // they should be used only to locate specific item sub-types
124 // N.B. If you add a type here, be sure to add it below to the BaseType()
133
134 // Same for locating shapes types from PCB_SHAPE_T items
141
142 /*
143 * Draw items in library symbol.
144 *
145 * The order of these items effects the sort order for items inside the
146 * "DRAW/ENDDRAW" section of the symbol definition in a library file.
147 * If you add a new draw item, type, please make sure you add it so the
148 * sort order is logical.
149 */
156
157 // Schematic draw Items. The order of these items effects the sort order.
158 // It is currently ordered to mimic the old Eeschema locate behavior where
159 // the smallest item is the selected item.
178
179 // Be prudent with these types:
180 // they should be used only to locate a specific field type among SCH_FIELD_Ts
181 // N.B. If you add a type here, be sure to add it below to the BaseType()
186
187 // Same for picking wires, buses and graphics from SCH_ITEM_T items
191
192 // Same for picking labels, or labels attached to wires and/or buses
196
197 // Same for picking symbols which are power symbols
199
200 // matches any type
202
203 // General
205
207
208 /*
209 * For GerbView: item types:
210 */
214
215 /*
216 * For Pl_Editor: item types:
217 */
224
225 // serialized layout used in undo/redo commands
226 WS_PROXY_UNDO_ITEM_T, // serialized layout used in undo/redo commands
227 WS_PROXY_UNDO_ITEM_PLUS_T, // serialized layout plus page and title block settings
228
229 /*
230 * FOR PROJECT::_ELEMs
231 */
238
239 // End value
241};
242
252constexpr KICAD_T BaseType( const KICAD_T aType )
253{
254 switch( aType )
255 {
260 return SCH_FIELD_T;
261
265 return SCH_LINE_T;
266
270 return SCH_LABEL_T;
271
273 return SCH_SYMBOL_T;
274
279 return PCB_FIELD_T;
280
282 case PCB_LOCATE_PTH_T:
284 return PCB_LOCATE_HOLE_T;
285
292 return PCB_SHAPE_T;
293
295 case PCB_DIM_CENTER_T:
296 case PCB_DIM_RADIAL_T:
298 case PCB_DIM_LEADER_T:
299 return PCB_DIMENSION_T;
300
301 default:
302 return aType;
303 }
304}
305
306constexpr bool IsNullType( const KICAD_T aType )
307{
308 return aType <= 0;
309}
310
311constexpr bool IsInstantiableType( const KICAD_T aType )
312{
313 if( IsNullType( aType ) )
314 return false;
315
316 switch( aType )
317 {
318 case SCH_LOCATE_ANY_T:
319
324
328
332
334
339
345 case PCB_LOCATE_PTH_T:
348
355
356 case PCB_DIMENSION_T:
357
358 case SCH_SCREEN_T:
359 case PCB_ITEM_LIST_T:
360 return false;
361
362 default:
363 break;
364 }
365
366 return true;
367
368}
369
370constexpr bool IsEeschemaType( const KICAD_T aType )
371{
372 switch( aType )
373 {
374 case SCH_MARKER_T:
375 case SCH_JUNCTION_T:
376 case SCH_NO_CONNECT_T:
379 case SCH_LINE_T:
380 case SCH_SHAPE_T:
381 case SCH_RULE_AREA_T:
382 case SCH_BITMAP_T:
383 case SCH_TEXT_T:
384 case SCH_TEXTBOX_T:
385 case SCH_TABLE_T:
386 case SCH_TABLECELL_T:
387 case SCH_LABEL_T:
390 case SCH_HIER_LABEL_T:
391 case SCH_FIELD_T:
392 case SCH_SYMBOL_T:
393 case SCH_SHEET_PIN_T:
394 case SCH_GROUP_T:
395 case SCH_SHEET_T:
396 case SCH_PIN_T:
397
402
406
410
412 case SCH_LOCATE_ANY_T:
413
414 case SCH_SCREEN_T:
415 case SCHEMATIC_T:
416
417 case LIB_SYMBOL_T:
418 return true;
419
420 default:
421 return false;
422 }
423}
424
425constexpr bool IsPcbnewType( const KICAD_T aType )
426{
427 switch( aType )
428 {
429 case PCB_T:
430
431 case PCB_FOOTPRINT_T:
432 case PCB_PAD_T:
433 case PCB_SHAPE_T:
435 case PCB_FIELD_T:
436 case PCB_TEXT_T:
437 case PCB_TEXTBOX_T:
438 case PCB_TABLE_T:
439 case PCB_TABLECELL_T:
440 case PCB_TRACE_T:
441 case PCB_VIA_T:
442 case PCB_ARC_T:
443 case PCB_MARKER_T:
444 case PCB_DIMENSION_T:
446 case PCB_DIM_LEADER_T:
447 case PCB_DIM_CENTER_T:
448 case PCB_DIM_RADIAL_T:
450 case PCB_TARGET_T:
451 case PCB_POINT_T:
452 case PCB_ZONE_T:
453 case PCB_ITEM_LIST_T:
454 case PCB_NETINFO_T:
455 case PCB_GROUP_T:
456 case PCB_GENERATOR_T:
457
467 case PCB_LOCATE_PTH_T:
477 return true;
478
479 default:
480 return false;
481 }
482}
483
484constexpr bool IsGerbviewType( const KICAD_T aType )
485{
486 switch( aType )
487 {
488 case GERBER_LAYOUT_T:
490 case GERBER_IMAGE_T:
491 return true;
492
493 default:
494 return false;
495 }
496}
497
498constexpr bool IsPageLayoutEditorType( const KICAD_T aType )
499{
500 switch( aType )
501 {
502 case WSG_LINE_T:
503 case WSG_RECT_T:
504 case WSG_POLY_T:
505 case WSG_TEXT_T:
506 case WSG_BITMAP_T:
507 case WSG_PAGE_T:
508
511 return true;
512
513 default:
514 return false;
515 }
516}
517
518constexpr bool IsMiscType( const KICAD_T aType )
519{
520 switch( aType )
521 {
522 case SCREEN_T:
523
525 case FP_LIB_TABLE_T:
527 case SYMBOL_LIBS_T:
528 case SEARCH_STACK_T:
529 case S3D_CACHE_T:
530 return true;
531
532 default:
533 return false;
534 }
535}
536
537constexpr bool IsTypeCorrect( KICAD_T aType )
538{
539 return IsNullType( aType )
540 || IsEeschemaType( aType )
541 || IsPcbnewType( aType )
542 || IsGerbviewType( aType )
543 || IsPageLayoutEditorType( aType )
544 || IsMiscType( aType );
545}
546
547#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:252
constexpr bool IsGerbviewType(const KICAD_T aType)
Definition typeinfo.h:484
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:233
@ SCH_GROUP_T
Definition typeinfo.h:175
@ SCH_TABLE_T
Definition typeinfo.h:167
@ 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:165
@ PCB_FIELD_LOCATE_VALUE_T
Definition typeinfo.h:118
@ LIB_SYMBOL_T
Definition typeinfo.h:150
@ SCH_NO_CONNECT_T
Definition typeinfo.h:162
@ 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:182
@ PCB_GENERATOR_T
class PCB_GENERATOR, generator on a layer
Definition typeinfo.h:91
@ PCB_LOCATE_BOARD_EDGE_T
Definition typeinfo.h:132
@ 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:184
@ TYPE_NOT_INIT
Definition typeinfo.h:81
@ MAX_STRUCT_TYPE_ID
Definition typeinfo.h:240
@ SCH_SYMBOL_T
Definition typeinfo.h:174
@ 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:127
@ PCB_LOCATE_NPTH_T
Definition typeinfo.h:131
@ PCB_GROUP_T
class PCB_GROUP, a set of BOARD_ITEMs
Definition typeinfo.h:110
@ SCH_TABLECELL_T
Definition typeinfo.h:168
@ 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:188
@ SCH_FIELD_T
Definition typeinfo.h:152
@ PCB_TEXT_T
class PCB_TEXT, text on a layer
Definition typeinfo.h:92
@ PCB_LOCATE_TEXT_T
Definition typeinfo.h:128
@ SCH_DIRECTIVE_LABEL_T
Definition typeinfo.h:173
@ SCH_LABEL_T
Definition typeinfo.h:169
@ SCH_LOCATE_ANY_T
Definition typeinfo.h:201
@ SCH_FIELD_LOCATE_VALUE_T
Definition typeinfo.h:183
@ S3D_CACHE_T
Definition typeinfo.h:237
@ SCH_SHEET_T
Definition typeinfo.h:177
@ SCH_ITEM_LOCATE_BUS_T
Definition typeinfo.h:189
@ PCB_REFERENCE_IMAGE_T
class PCB_REFERENCE_IMAGE, bitmap on a layer
Definition typeinfo.h:89
@ SCH_MARKER_T
Definition typeinfo.h:160
@ PCB_ITEM_LIST_T
class BOARD_ITEM_LIST, a list of board items
Definition typeinfo.h:108
@ SCH_SHAPE_T
Definition typeinfo.h:151
@ WSG_POLY_T
Definition typeinfo.h:220
@ SCH_RULE_AREA_T
Definition typeinfo.h:172
@ PCB_FIELD_T
class PCB_FIELD, text associated with a footprint property
Definition typeinfo.h:90
@ PCB_LOCATE_STDVIA_T
Definition typeinfo.h:125
@ GERBER_DRAW_ITEM_T
Definition typeinfo.h:212
@ SCH_HIER_LABEL_T
Definition typeinfo.h:171
@ 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:218
@ SCH_BUS_BUS_ENTRY_T
Definition typeinfo.h:164
@ SCH_SCREEN_T
Definition typeinfo.h:204
@ PCB_TARGET_T
class PCB_TARGET, a target (graphic item)
Definition typeinfo.h:106
@ SCH_LABEL_LOCATE_ANY_T
Definition typeinfo.h:193
@ PCB_SHAPE_LOCATE_CIRCLE_T
Definition typeinfo.h:137
@ PCB_SHAPE_LOCATE_SEGMENT_T
Definition typeinfo.h:135
@ SCH_FIELD_LOCATE_DATASHEET_T
Definition typeinfo.h:185
@ PCB_SHAPE_LOCATE_RECT_T
Definition typeinfo.h:136
@ SYMBOL_LIB_TABLE_T
Definition typeinfo.h:232
@ SCH_ITEM_LOCATE_GRAPHIC_LINE_T
Definition typeinfo.h:190
@ SCHEMATIC_T
Definition typeinfo.h:206
@ SCH_LABEL_LOCATE_WIRE_T
Definition typeinfo.h:194
@ WSG_TEXT_T
Definition typeinfo.h:221
@ 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:176
@ 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:117
@ SCH_TEXT_T
Definition typeinfo.h:153
@ PCB_SHAPE_LOCATE_BEZIER_T
Definition typeinfo.h:140
@ WSG_PAGE_T
Definition typeinfo.h:223
@ WS_PROXY_UNDO_ITEM_T
Definition typeinfo.h:226
@ SEARCH_STACK_T
Definition typeinfo.h:236
@ SYMBOL_LIBS_T
Definition typeinfo.h:235
@ SCH_LABEL_LOCATE_BUS_T
Definition typeinfo.h:195
@ PCB_LOCATE_PTH_T
Definition typeinfo.h:130
@ PCB_PAD_T
class PAD, a pad in a footprint
Definition typeinfo.h:87
@ WSG_RECT_T
Definition typeinfo.h:219
@ PCB_SHAPE_LOCATE_POLY_T
Definition typeinfo.h:139
@ PCB_SHAPE_LOCATE_ARC_T
Definition typeinfo.h:138
@ SCH_SYMBOL_LOCATE_POWER_T
Definition typeinfo.h:198
@ DESIGN_BLOCK_LIB_TABLE_T
Definition typeinfo.h:234
@ GERBER_IMAGE_T
Definition typeinfo.h:213
@ SCH_BUS_WIRE_ENTRY_T
Definition typeinfo.h:163
@ GERBER_LAYOUT_T
Definition typeinfo.h:211
@ SCREEN_T
not really an item, used to identify a screen
Definition typeinfo.h:83
@ SCH_BITMAP_T
Definition typeinfo.h:166
@ 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:227
@ PCB_LOCATE_UVIA_T
Definition typeinfo.h:126
@ 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:154
@ WSG_BITMAP_T
Definition typeinfo.h:222
@ PCB_LOCATE_HOLE_T
Definition typeinfo.h:129
@ PCB_FIELD_LOCATE_DATASHEET_T
Definition typeinfo.h:120
@ PCB_POINT_T
class PCB_POINT, a 0-dimensional point
Definition typeinfo.h:112
@ 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:170
@ PCB_FIELD_LOCATE_FOOTPRINT_T
Definition typeinfo.h:119
@ SCH_JUNCTION_T
Definition typeinfo.h:161
@ SCH_PIN_T
Definition typeinfo.h:155
constexpr bool IsTypeCorrect(KICAD_T aType)
Definition typeinfo.h:537
constexpr bool IsPcbnewType(const KICAD_T aType)
Definition typeinfo.h:425
constexpr bool IsMiscType(const KICAD_T aType)
Definition typeinfo.h:518
constexpr bool IsInstantiableType(const KICAD_T aType)
Definition typeinfo.h:311
Casted dyn_cast(From aObject)
A lightweight dynamic downcast.
Definition typeinfo.h:61
constexpr bool IsNullType(const KICAD_T aType)
Definition typeinfo.h:306
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:370
constexpr bool IsPageLayoutEditorType(const KICAD_T aType)
Definition typeinfo.h:498