typeinfo.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2014 CERN
 * Copyright (C) 2004-2021 KiCad Developers, see change_log.txt for contributors.
 * @author Tomasz Wlostowski <[email protected]>
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, you may find one here:
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 * or you may search the http://www.gnu.org website for the version 2 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
 */

#ifndef __KICAD_TYPEINFO_H
#define __KICAD_TYPEINFO_H


#ifndef SWIG
#include <type_traits>

template <class T, class I>
bool IsA( const I* aObject )
{
 return aObject && std::remove_pointer<T>::type::ClassOf( aObject );
}

template <class T, class I>
bool IsA( const I& aObject )
{
 return std::remove_pointer<T>::type::ClassOf( &aObject );
}

template<class Casted, class From>
Casted dyn_cast( From aObject )
{
 if( std::remove_pointer<Casted>::type::ClassOf ( aObject ) )
 return static_cast<Casted>( aObject );

 return nullptr;
}

class EDA_ITEM;

#endif // SWIG


enum KICAD_T
{
 NOT_USED = -1, 

 EOT = 0, 

 TYPE_NOT_INIT = 0,
 PCB_T,
 SCREEN_T, 

 // Items in pcb
 PCB_FOOTPRINT_T, 
 PCB_PAD_T, 
 PCB_SHAPE_T, 
 PCB_TEXT_T, 
 PCB_FP_TEXT_T, 
 PCB_FP_SHAPE_T, 
 PCB_FP_ZONE_T, 
 PCB_TRACE_T, 
 PCB_VIA_T, 
 PCB_ARC_T, 
 PCB_MARKER_T, 
 PCB_DIMENSION_T, 
 PCB_DIM_ALIGNED_T, 
 PCB_DIM_LEADER_T, 
 PCB_DIM_CENTER_T, 
 PCB_DIM_ORTHOGONAL_T, 
 PCB_TARGET_T, 
 PCB_ZONE_T, 
 PCB_ITEM_LIST_T, 
 PCB_NETINFO_T, 
 PCB_GROUP_T, 

 PCB_LOCATE_STDVIA_T,
 PCB_LOCATE_UVIA_T,
 PCB_LOCATE_BBVIA_T,
 PCB_LOCATE_TEXT_T,
 PCB_LOCATE_GRAPHIC_T,
 PCB_LOCATE_HOLE_T,
 PCB_LOCATE_PTH_T,
 PCB_LOCATE_NPTH_T,
 PCB_LOCATE_BOARD_EDGE_T,

 // Schematic draw Items. The order of these items effects the sort order.
 // It is currently ordered to mimic the old Eeschema locate behavior where
 // the smallest item is the selected item.
 SCH_MARKER_T,
 SCH_JUNCTION_T,
 SCH_NO_CONNECT_T,
 SCH_BUS_WIRE_ENTRY_T,
 SCH_BUS_BUS_ENTRY_T,
 SCH_LINE_T,
 SCH_BITMAP_T,
 SCH_TEXT_T,
 SCH_LABEL_T,
 SCH_GLOBAL_LABEL_T,
 SCH_HIER_LABEL_T,
 SCH_FIELD_T,
 SCH_SYMBOL_T,
 SCH_SHEET_PIN_T,
 SCH_SHEET_T,
 SCH_PIN_T,

 // Be prudent with these types:
 // they should be used only to locate a specific field type among SCH_FIELD_Ts
 // N.B. If you add a type here, be sure to add it below to the BaseType()
 SCH_FIELD_LOCATE_REFERENCE_T,
 SCH_FIELD_LOCATE_VALUE_T,
 SCH_FIELD_LOCATE_FOOTPRINT_T,
 SCH_FIELD_LOCATE_DATASHEET_T,

 // Same for picking wires and buses from SCH_LINE_T items
 SCH_LINE_LOCATE_WIRE_T,
 SCH_LINE_LOCATE_BUS_T,
 SCH_LINE_LOCATE_GRAPHIC_LINE_T,

 // Same for picking labels attached to wires and/or buses
 SCH_LABEL_LOCATE_WIRE_T,
 SCH_LABEL_LOCATE_BUS_T,

 // Same for picking symbols which are power symbols
 SCH_SYMBOL_LOCATE_POWER_T,

 // matches any type
 SCH_LOCATE_ANY_T,

 // General
 SCH_SCREEN_T,

 SCHEMATIC_T,

 /*
 * Draw items in library symbol.
 *
 * The order of these items effects the sort order for items inside the
 * "DRAW/ENDDRAW" section of the symbol definition in a library file.
 * If you add a new draw item, type, please make sure you add it so the
 * sort order is logical.
 */
 LIB_SYMBOL_T,
 LIB_ALIAS_T,
 LIB_SHAPE_T,
 LIB_TEXT_T,
 LIB_PIN_T,

 /*
 * Fields are not saved inside the "DRAW/ENDDRAW". Add new draw item
 * types before this line.
 */
 LIB_FIELD_T,

 /*
 * For GerbView: item types:
 */
 GERBER_LAYOUT_T,
 GERBER_DRAW_ITEM_T,
 GERBER_IMAGE_T,

 /*
 * For Pl_Editor: item types:
 */
 WSG_LINE_T,
 WSG_RECT_T,
 WSG_POLY_T,
 WSG_TEXT_T,
 WSG_BITMAP_T,
 WSG_PAGE_T,

 // serialized layout used in undo/redo commands
 WS_PROXY_UNDO_ITEM_T, // serialized layout used in undo/redo commands
 WS_PROXY_UNDO_ITEM_PLUS_T, // serialized layout plus page and title block settings

 /*
 * FOR PROJECT::_ELEMs
 */
 SYMBOL_LIB_TABLE_T,
 FP_LIB_TABLE_T,
 SYMBOL_LIBS_T,
 SEARCH_STACK_T,
 S3D_CACHE_T,

 // End value
 MAX_STRUCT_TYPE_ID
};

constexpr KICAD_T BaseType( const KICAD_T aType )
{
 switch( aType )
 {
 case SCH_FIELD_LOCATE_REFERENCE_T:
 case SCH_FIELD_LOCATE_VALUE_T:
 case SCH_FIELD_LOCATE_FOOTPRINT_T:
 case SCH_FIELD_LOCATE_DATASHEET_T:
 return SCH_FIELD_T;

 case SCH_LINE_LOCATE_WIRE_T:
 case SCH_LINE_LOCATE_BUS_T:
 case SCH_LINE_LOCATE_GRAPHIC_LINE_T:
 return SCH_LINE_T;

 case SCH_LABEL_LOCATE_WIRE_T:
 case SCH_LABEL_LOCATE_BUS_T:
 return SCH_LABEL_T;

 case SCH_SYMBOL_LOCATE_POWER_T:
 return SCH_SYMBOL_T;

 case PCB_LOCATE_HOLE_T:
 case PCB_LOCATE_PTH_T:
 case PCB_LOCATE_NPTH_T:
 return PCB_LOCATE_HOLE_T;

 case PCB_DIM_ALIGNED_T:
 case PCB_DIM_CENTER_T:
 case PCB_DIM_ORTHOGONAL_T:
 case PCB_DIM_LEADER_T:
 return PCB_DIMENSION_T;

 default:
 return aType;
 }
}

constexpr bool IsNullType( const KICAD_T aType )
{
 return aType <= 0;
}

constexpr bool IsInstantiableType( const KICAD_T aType )
{
 if( IsNullType( aType ) )
 return false;

 switch( aType )
 {
 case SCH_LOCATE_ANY_T:

 case SCH_FIELD_LOCATE_REFERENCE_T:
 case SCH_FIELD_LOCATE_VALUE_T:
 case SCH_FIELD_LOCATE_FOOTPRINT_T:
 case SCH_FIELD_LOCATE_DATASHEET_T:

 case SCH_LINE_LOCATE_WIRE_T:
 case SCH_LINE_LOCATE_BUS_T:
 case SCH_LINE_LOCATE_GRAPHIC_LINE_T:

 case SCH_LABEL_LOCATE_WIRE_T:
 case SCH_LABEL_LOCATE_BUS_T:

 case SCH_SYMBOL_LOCATE_POWER_T:

 case PCB_LOCATE_STDVIA_T:
 case PCB_LOCATE_UVIA_T:
 case PCB_LOCATE_BBVIA_T:
 case PCB_LOCATE_TEXT_T:
 case PCB_LOCATE_GRAPHIC_T:
 case PCB_LOCATE_HOLE_T:
 case PCB_LOCATE_PTH_T:
 case PCB_LOCATE_NPTH_T:
 case PCB_LOCATE_BOARD_EDGE_T:

 case PCB_DIMENSION_T:

 case SCH_SCREEN_T:
 case PCB_ITEM_LIST_T:
 return false;

 default:
 break;
 }

 return true;

}

constexpr bool IsEeschemaType( const KICAD_T aType )
{
 switch( aType )
 {
 case SCH_MARKER_T:
 case SCH_JUNCTION_T:
 case SCH_NO_CONNECT_T:
 case SCH_BUS_WIRE_ENTRY_T:
 case SCH_BUS_BUS_ENTRY_T:
 case SCH_LINE_T:
 case SCH_BITMAP_T:
 case SCH_TEXT_T:
 case SCH_LABEL_T:
 case SCH_GLOBAL_LABEL_T:
 case SCH_HIER_LABEL_T:
 case SCH_FIELD_T:
 case SCH_SYMBOL_T:
 case SCH_SHEET_PIN_T:
 case SCH_SHEET_T:
 case SCH_PIN_T:

 case SCH_FIELD_LOCATE_REFERENCE_T:
 case SCH_FIELD_LOCATE_VALUE_T:
 case SCH_FIELD_LOCATE_FOOTPRINT_T:
 case SCH_FIELD_LOCATE_DATASHEET_T:

 case SCH_LINE_LOCATE_WIRE_T:
 case SCH_LINE_LOCATE_BUS_T:
 case SCH_LINE_LOCATE_GRAPHIC_LINE_T:

 case SCH_LABEL_LOCATE_WIRE_T:
 case SCH_LABEL_LOCATE_BUS_T:

 case SCH_SYMBOL_LOCATE_POWER_T:
 case SCH_LOCATE_ANY_T:

 case SCH_SCREEN_T:
 case SCHEMATIC_T:

 case LIB_SYMBOL_T:
 case LIB_ALIAS_T:
 case LIB_SHAPE_T:
 case LIB_TEXT_T:
 case LIB_PIN_T:

 case LIB_FIELD_T:
 return true;

 default:
 return false;
 }
}

constexpr bool IsPcbnewType( const KICAD_T aType )
{
 switch( aType )
 {
 case PCB_T:

 case PCB_FOOTPRINT_T:
 case PCB_PAD_T:
 case PCB_SHAPE_T:
 case PCB_TEXT_T:
 case PCB_FP_TEXT_T:
 case PCB_FP_SHAPE_T:
 case PCB_FP_ZONE_T:
 case PCB_TRACE_T:
 case PCB_VIA_T:
 case PCB_ARC_T:
 case PCB_MARKER_T:
 case PCB_DIMENSION_T:
 case PCB_DIM_ALIGNED_T:
 case PCB_DIM_LEADER_T:
 case PCB_DIM_CENTER_T:
 case PCB_DIM_ORTHOGONAL_T:
 case PCB_TARGET_T:
 case PCB_ZONE_T:
 case PCB_ITEM_LIST_T:
 case PCB_NETINFO_T:
 case PCB_GROUP_T:

 case PCB_LOCATE_STDVIA_T:
 case PCB_LOCATE_UVIA_T:
 case PCB_LOCATE_BBVIA_T:
 case PCB_LOCATE_TEXT_T:
 case PCB_LOCATE_GRAPHIC_T:
 case PCB_LOCATE_HOLE_T:
 case PCB_LOCATE_PTH_T:
 case PCB_LOCATE_NPTH_T:
 case PCB_LOCATE_BOARD_EDGE_T:
 return true;

 default:
 return false;
 }
}

constexpr bool IsGerbviewType( const KICAD_T aType )
{
 switch( aType )
 {
 case GERBER_LAYOUT_T:
 case GERBER_DRAW_ITEM_T:
 case GERBER_IMAGE_T:
 return true;

 default:
 return false;
 }
}

constexpr bool IsPageLayoutEditorType( const KICAD_T aType )
{
 switch( aType )
 {
 case WSG_LINE_T:
 case WSG_RECT_T:
 case WSG_POLY_T:
 case WSG_TEXT_T:
 case WSG_BITMAP_T:
 case WSG_PAGE_T:

 case WS_PROXY_UNDO_ITEM_T:
 case WS_PROXY_UNDO_ITEM_PLUS_T:
 return true;

 default:
 return false;
 }
}

constexpr bool IsMiscType( const KICAD_T aType )
{
 switch( aType )
 {
 case SCREEN_T:

 case SYMBOL_LIB_TABLE_T:
 case FP_LIB_TABLE_T:
 case SYMBOL_LIBS_T:
 case SEARCH_STACK_T:
 case S3D_CACHE_T:
 return true;

 default:
 return false;
 }
}

constexpr bool IsTypeCorrect( KICAD_T aType )
{
 return IsNullType( aType )
 || IsEeschemaType( aType )
 || IsPcbnewType( aType )
 || IsGerbviewType( aType )
 || IsPageLayoutEditorType( aType )
 || IsMiscType( aType );
}

constexpr bool IsTypeAvailable( KICAD_T aType )
{
 if( !IsInstantiableType( aType ) )
 return false;

 if( IsEeschemaType( aType ) )
 {
#ifdef EESCHEMA
 return true;
#endif // EESCHEMA
 }

 if( IsPcbnewType( aType ) )
 {
#ifdef PCBNEW
 return true;
#endif // PCBNEW
 }

 if( IsGerbviewType( aType ) )
 {
#ifdef GERBVIEW
 return true;
#endif // GERBVIEW
 }

 if( IsPageLayoutEditorType( aType ) )
 {
#ifdef PL_EDITOR
 return true;
#endif // PL_EDITOR
 }

 return false;
}

#endif // __KICAD_TYPEINFO_H