Provide class metadata.Helper macro to map type hashes to names. More...

#include <property_mgr.h>

Classes
struct	CLASS_DESC
	Returns metadata for a specific type. More...

struct	CLASS_INFO

Public Types
typedef std::vector< CLASS_INFO >	CLASSES_INFO

Public Member Functions
void	RegisterType (TYPE_ID aType, const wxString &aName)
	Associate a name with a type. More...

const wxString &	ResolveType (TYPE_ID aType) const
	Return name of a type. More...

PROPERTY_BASE *	GetProperty (TYPE_ID aType, const wxString &aProperty) const
	Return a property for a specific type. More...

const PROPERTY_LIST &	GetProperties (TYPE_ID aType) const
	Return all properties for a specific type. More...

const void *	TypeCast (const void *aSource, TYPE_ID aBase, TYPE_ID aTarget) const
	Cast a type to another type. More...

void *	TypeCast (void *aSource, TYPE_ID aBase, TYPE_ID aTarget) const

void	AddProperty (PROPERTY_BASE *aProperty)
	Register a property. More...

void	ReplaceProperty (size_t aBase, const wxString &aName, PROPERTY_BASE *aNew)
	Replace an existing property for a specific type. More...

void	AddTypeCast (TYPE_CAST_BASE *aCast)
	Register a type converter. More...

void	InheritsAfter (TYPE_ID aDerived, TYPE_ID aBase)
	Declare an inheritance relationship between types. More...

bool	IsOfType (TYPE_ID aDerived, TYPE_ID aBase) const
	Return true if aDerived is inherited from aBase. More...

EDA_UNITS	GetUnits () const

void	SetUnits (EDA_UNITS aUnits)

void	Rebuild ()
	Rebuild the list of all registered properties. More...

CLASSES_INFO	GetAllClasses ()

std::vector< TYPE_ID >	GetMatchingClasses (PROPERTY_BASE *aProperty)

Static Public Member Functions
static PROPERTY_MANAGER &	Instance ()

Private Member Functions
	PROPERTY_MANAGER ()
	Structure holding type meta-data. More...

CLASS_DESC &	getClass (TYPE_ID aTypeId)

Private Attributes
std::unordered_map< TYPE_ID, wxString >	m_classNames
	Map of all available types. More...

std::unordered_map< TYPE_ID, CLASS_DESC >	m_classes

bool	m_dirty
	Flag indicating that the list of properties needs to be rebuild (RebuildProperties()) More...

EDA_UNITS	m_units

Detailed Description

Provide class metadata.Helper macro to map type hashes to names.

Each class handled by PROPERTY_MANAGER needs to be described using AddProperty(), AddTypeCast() and InheritsAfter() methods.

Enum types use a dedicated property type (PROPERTY_ENUM), define its possible values with ENUM_MAP class, then describe the type using macros:

DECLARE_ENUM_TO_WXANY (in header files)
IMPLEMENT_ENUM_TO_WXANY (in source files)
ENUM_TO_WXANY (most often used; combines DECLARE and IMPLEMENT macros, if there is no need to share the description using header files)

Once all classes are described, the property list must be build using Rebuild() method.

Definition at line 62 of file property_mgr.h.

Member Typedef Documentation

◆ CLASSES_INFO

typedef std::vector<CLASS_INFO> PROPERTY_MANAGER::CLASSES_INFO

Definition at line 186 of file property_mgr.h.

Constructor & Destructor Documentation

◆ PROPERTY_MANAGER()

PROPERTY_MANAGER::PROPERTY_MANAGER ( )

inlineprivate

Structure holding type meta-data.

Definition at line 193 of file property_mgr.h.

Member Function Documentation

◆ AddProperty()

void PROPERTY_MANAGER::AddProperty ( PROPERTY_BASE * aProperty )

Register a property.

Parameters

aProperty is the property to register.

Definition at line 102 of file property_mgr.cpp.

 {
  const wxString& name = aProperty->Name();
  TYPE_ID hash = aProperty->OwnerHash();
  CLASS_DESC& classDesc = getClass( hash );
  classDesc.m_ownProperties.emplace( name, aProperty );
  m_dirty = true;
 }

References getClass(), m_dirty, PROPERTY_MANAGER::CLASS_DESC::m_ownProperties, name, PROPERTY_BASE::Name(), and PROPERTY_BASE::OwnerHash().

Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC(), BOARD_ITEM_DESC::BOARD_ITEM_DESC(), CLASS_A_DESC::CLASS_A_DESC(), CLASS_B_DESC::CLASS_B_DESC(), CLASS_C_DESC::CLASS_C_DESC(), CLASS_D_DESC::CLASS_D_DESC(), EDA_ITEM_DESC::EDA_ITEM_DESC(), EDA_SHAPE_DESC::EDA_SHAPE_DESC(), EDA_TEXT_DESC::EDA_TEXT_DESC(), FOOTPRINT_DESC::FOOTPRINT_DESC(), FP_SHAPE_DESC::FP_SHAPE_DESC(), FP_TEXT_DESC::FP_TEXT_DESC(), PAD_DESC::PAD_DESC(), PCB_SHAPE_DESC::PCB_SHAPE_DESC(), PCB_TARGET_DESC::PCB_TARGET_DESC(), ReplaceProperty(), TRACK_VIA_DESC::TRACK_VIA_DESC(), and ZONE_DESC::ZONE_DESC().

◆ AddTypeCast()

void PROPERTY_MANAGER::AddTypeCast ( TYPE_CAST_BASE * aCast )

Register a type converter.

Required prior TypeCast() usage.

Parameters

aCast is the type converter to register.

Definition at line 121 of file property_mgr.cpp.

 {
  TYPE_ID derivedHash = aCast->DerivedHash();
  CLASS_DESC& classDesc = getClass( aCast->BaseHash() );
  auto& typeCasts = classDesc.m_typeCasts;
  wxASSERT_MSG( typeCasts.count( derivedHash ) == 0, "Such converter already exists" );
  typeCasts.emplace( derivedHash, aCast );
 }

References TYPE_CAST_BASE::BaseHash(), TYPE_CAST_BASE::DerivedHash(), getClass(), and PROPERTY_MANAGER::CLASS_DESC::m_typeCasts.

Referenced by CLASS_D_DESC::CLASS_D_DESC(), FOOTPRINT_DESC::FOOTPRINT_DESC(), FP_SHAPE_DESC::FP_SHAPE_DESC(), FP_TEXT_DESC::FP_TEXT_DESC(), PCB_SHAPE_DESC::PCB_SHAPE_DESC(), and TEXTE_PCB_DESC::TEXTE_PCB_DESC().

◆ GetAllClasses()

PROPERTY_MANAGER::CLASSES_INFO PROPERTY_MANAGER::GetAllClasses ( )

Definition at line 234 of file property_mgr.cpp.

 {
  CLASSES_INFO rv;
 
  for( std::pair<const TYPE_ID, CLASS_DESC>& classEntry : m_classes )
  {
  CLASS_INFO info;
 
  info.type = classEntry.first;
  info.name = m_classNames[classEntry.first];
 
  for( PROPERTY_BASE* prop : classEntry.second.m_allProperties )
  info.properties.push_back( prop );
 
   rv.push_back( info );
  }
 
  return rv;
 }

References info, m_classes, and m_classNames.

Referenced by PCB_EXPR_UCODE::CreateVarRef(), and PANEL_SETUP_RULES::onScintillaCharAdded().

◆ getClass()

PROPERTY_MANAGER::CLASS_DESC & PROPERTY_MANAGER::getClass ( TYPE_ID aTypeId )

private

Definition at line 173 of file property_mgr.cpp.

 {
  auto it = m_classes.find( aTypeId );
 
  if( it == m_classes.end() )
  tie( it, std::ignore ) = m_classes.emplace( aTypeId, CLASS_DESC( aTypeId ) );
 
  return it->second;
 }

References m_classes.

Referenced by AddProperty(), AddTypeCast(), InheritsAfter(), and ReplaceProperty().

◆ GetMatchingClasses()

std::vector< TYPE_ID > PROPERTY_MANAGER::GetMatchingClasses ( PROPERTY_BASE * aProperty )

Definition at line 214 of file property_mgr.cpp.

 {
  std::vector<TYPE_ID> ids;
 
 /*
  for( auto& cls : m_classes )
  {
  CLASS_INFO info;
 
  for( auto prop : cls.second.m_allProperties )
  info.properties.push_back(prop);
 
 
  }
  */
 
  return ids;
 }

◆ GetProperties()

const PROPERTY_LIST & PROPERTY_MANAGER::GetProperties ( TYPE_ID aType ) const

Return all properties for a specific type.

Parameters

aType is the type identifier (obtained using TYPE_HASH()).

Returns: Vector storing all properties of the requested type.

Definition at line 67 of file property_mgr.cpp.

 {
  if( m_dirty )
  const_cast<PROPERTY_MANAGER*>( this )->Rebuild();
 
  static const PROPERTY_LIST empty;
  auto it = m_classes.find( aType );
 
  if( it == m_classes.end() )
  return empty;
 
  return it->second.m_allProperties;
 }

References empty(), m_classes, and m_dirty.

Referenced by PANEL_SETUP_RULES::onScintillaCharAdded().

◆ GetProperty()

PROPERTY_BASE * PROPERTY_MANAGER::GetProperty	(	TYPE_ID	aType,
		const wxString &	aProperty
	)		const

Return a property for a specific type.

Parameters

aType	is the type identifier (obtained using TYPE_HASH()).
aProperty	is the property name used during class registration.

Returns: Requested property or null pointer if requested property does not exist.

Definition at line 45 of file property_mgr.cpp.

 {
  if( m_dirty )
  const_cast<PROPERTY_MANAGER*>( this )->Rebuild();
 
  auto it = m_classes.find( aType );
 
  if( it == m_classes.end() )
  return nullptr;
 
  const CLASS_DESC& classDesc = it->second;
 
  for( PROPERTY_BASE* property : classDesc.m_allProperties )
  {
  if( !aProperty.CmpNoCase( property->Name() ) )
  return property;
  }
 
  return nullptr;
 }

References PROPERTY_MANAGER::CLASS_DESC::m_allProperties, m_classes, m_dirty, and PROPERTY_BASE::Name().

Referenced by PCB_EXPR_UCODE::CreateVarRef(), INSPECTABLE::Get(), and INSPECTABLE::Set().

◆ GetUnits()

EDA_UNITS PROPERTY_MANAGER::GetUnits ( ) const

inline

Definition at line 163 of file property_mgr.h.

  {
  return m_units;
  }

References m_units.

◆ InheritsAfter()

void PROPERTY_MANAGER::InheritsAfter	(	TYPE_ID	aDerived,
		TYPE_ID	aBase
	)

Declare an inheritance relationship between types.

Parameters

aBase	is the base type identifier (obtained using TYPE_HASH()).
aDerived	is the derived type identifier (obtained using TYPE_HASH()).

Definition at line 131 of file property_mgr.cpp.

 {
  wxASSERT_MSG( aDerived != aBase, "Class cannot inherit from itself" );
 
  CLASS_DESC& derived = getClass( aDerived );
  CLASS_DESC& base = getClass( aBase );
  derived.m_bases.push_back( base );
  m_dirty = true;
 
  wxASSERT_MSG( derived.m_bases.size() == 1 || derived.m_typeCasts.count( aBase ) == 1,
  "You need to add a TYPE_CAST for classes inheriting from multiple bases" );
 }

References getClass(), PROPERTY_MANAGER::CLASS_DESC::m_bases, m_dirty, and PROPERTY_MANAGER::CLASS_DESC::m_typeCasts.

Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC(), BOARD_ITEM_DESC::BOARD_ITEM_DESC(), CLASS_B_DESC::CLASS_B_DESC(), CLASS_D_DESC::CLASS_D_DESC(), DIMENSION_DESC::DIMENSION_DESC(), FOOTPRINT_DESC::FOOTPRINT_DESC(), FP_SHAPE_DESC::FP_SHAPE_DESC(), FP_TEXT_DESC::FP_TEXT_DESC(), PAD_DESC::PAD_DESC(), PCB_SHAPE_DESC::PCB_SHAPE_DESC(), PCB_TARGET_DESC::PCB_TARGET_DESC(), TEXTE_PCB_DESC::TEXTE_PCB_DESC(), TRACK_VIA_DESC::TRACK_VIA_DESC(), and ZONE_DESC::ZONE_DESC().

◆ Instance()

static PROPERTY_MANAGER& PROPERTY_MANAGER::Instance ( )

inlinestatic

Definition at line 65 of file property_mgr.h.

  {
  static PROPERTY_MANAGER pm;
  return pm;
  }

Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC(), BOARD_ITEM_DESC::BOARD_ITEM_DESC(), BOOST_AUTO_TEST_CASE(), CLASS_A_DESC::CLASS_A_DESC(), CLASS_B_DESC::CLASS_B_DESC(), CLASS_C_DESC::CLASS_C_DESC(), CLASS_D_DESC::CLASS_D_DESC(), CLASS_E_DESC::CLASS_E_DESC(), PCB_EXPR_UCODE::CreateVarRef(), DIMENSION_DESC::DIMENSION_DESC(), EDA_ITEM_DESC::EDA_ITEM_DESC(), EDA_SHAPE_DESC::EDA_SHAPE_DESC(), EDA_TEXT_DESC::EDA_TEXT_DESC(), FOOTPRINT_DESC::FOOTPRINT_DESC(), FP_SHAPE_DESC::FP_SHAPE_DESC(), FP_TEXT_DESC::FP_TEXT_DESC(), INSPECTABLE::Get(), main(), PANEL_SETUP_RULES::onScintillaCharAdded(), PAD_DESC::PAD_DESC(), PCB_SHAPE_DESC::PCB_SHAPE_DESC(), PCB_TARGET_DESC::PCB_TARGET_DESC(), INSPECTABLE::Set(), TEXTE_PCB_DESC::TEXTE_PCB_DESC(), TRACK_VIA_DESC::TRACK_VIA_DESC(), and ZONE_DESC::ZONE_DESC().

◆ IsOfType()

bool PROPERTY_MANAGER::IsOfType	(	TYPE_ID	aDerived,
		TYPE_ID	aBase
	)		const

Return true if aDerived is inherited from aBase.

Definition at line 145 of file property_mgr.cpp.

 {
  if( aDerived == aBase )
  return true;
 
  auto derived = m_classes.find( aDerived );
  wxCHECK( derived != m_classes.end(), false ); // missing class description
 
  // traverse the hierarchy seeking for the base class
  for( auto& base : derived->second.m_bases )
  {
  if( IsOfType( base.get().m_id, aBase ) )
  return true;
  }
 
  return false;
 }

References m_classes.

Referenced by PCB_EXPR_UCODE::CreateVarRef(), and TypeCast().

◆ Rebuild()

void PROPERTY_MANAGER::Rebuild ( )

Rebuild the list of all registered properties.

Needs to be called once before GetProperty()/GetProperties() are used.

Definition at line 164 of file property_mgr.cpp.

 {
  for( std::pair<const TYPE_ID, CLASS_DESC>& classEntry : m_classes )
  classEntry.second.rebuild();
 
  m_dirty = false;
 }

References m_classes, and m_dirty.

Referenced by BOOST_AUTO_TEST_CASE(), and main().

◆ RegisterType()

void PROPERTY_MANAGER::RegisterType	(	TYPE_ID	aType,
		const wxString &	aName
	)

Associate a name with a type.

Build a map to provide faster type look-up.

Parameters

aType	is the type identifier (obtained using TYPE_HASH()).
aName	is the type name.

Definition at line 31 of file property_mgr.cpp.

 {
  wxASSERT( m_classNames.count( aType ) == 0 );
  m_classNames.emplace( aType, aName );
 }

References m_classNames.

◆ ReplaceProperty()

void PROPERTY_MANAGER::ReplaceProperty	(	size_t	aBase,
		const wxString &	aName,
		PROPERTY_BASE *	aNew
	)

Replace an existing property for a specific type.

It is used to modify a property that has been inherited from a base class. This method is used instead of AddProperty().

Parameters

aBase	is the base class type the delivers the original property.
aName	is the name of the replaced property.
aNew	is the property replacing the inherited one.

Definition at line 112 of file property_mgr.cpp.

 {
  wxASSERT( aBase == aNew->BaseHash() );
  CLASS_DESC& classDesc = getClass( aNew->OwnerHash() );
  classDesc.m_replaced.insert( std::make_pair( aBase, aName ) );
  AddProperty( aNew );
 }

References AddProperty(), PROPERTY_BASE::BaseHash(), getClass(), PROPERTY_MANAGER::CLASS_DESC::m_replaced, and PROPERTY_BASE::OwnerHash().

Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC(), CLASS_D_DESC::CLASS_D_DESC(), CLASS_E_DESC::CLASS_E_DESC(), FOOTPRINT_DESC::FOOTPRINT_DESC(), and TRACK_VIA_DESC::TRACK_VIA_DESC().

◆ ResolveType()

const wxString & PROPERTY_MANAGER::ResolveType ( TYPE_ID aType ) const

Return name of a type.

Parameters

aType is the type identifier (obtained using TYPE_HASH()).

Returns: Name of the type or empty string, if not available.

Definition at line 38 of file property_mgr.cpp.

 {
  auto it = m_classNames.find( aType );
  return it != m_classNames.end() ? it->second : EMPTY_STRING;
 }

References EMPTY_STRING(), and m_classNames.

◆ SetUnits()

void PROPERTY_MANAGER::SetUnits ( EDA_UNITS aUnits )

inline

Definition at line 168 of file property_mgr.h.

  {
  m_units = aUnits;
  }

References m_units.

◆ TypeCast() [1/2]

const void * PROPERTY_MANAGER::TypeCast	(	const void *	aSource,
		TYPE_ID	aBase,
		TYPE_ID	aTarget
	)		const

Cast a type to another type.

Used for correct type-casting of types with multi-inheritance. Requires registration of an appropriate converter (AddTypeCast).

Parameters

aSource	is a pointer to the casted object.
aBase	is aSource type identifier (obtained using TYPE_HASH()).
aTarget	is the desired type identifier (obtained using TYPE_HASH()).

Returns: Properly casted pointer of aTarget type. *

See also: AddTypeCast

Definition at line 82 of file property_mgr.cpp.

 {
  if( aBase == aTarget )
  return aSource;
 
  auto classDesc = m_classes.find( aBase );
 
  if( classDesc == m_classes.end() )
  return aSource;
 
  auto& converters = classDesc->second.m_typeCasts;
  auto converter = converters.find( aTarget );
 
  if( converter == converters.end() ) // explicit type cast not found
  return IsOfType( aBase, aTarget ) ? aSource : nullptr;
 
  return (*converter->second)( aSource );
 }

References IsOfType(), and m_classes.

Referenced by INSPECTABLE::Get(), INSPECTABLE::Set(), and TypeCast().

◆ TypeCast() [2/2]

void* PROPERTY_MANAGER::TypeCast	(	void *	aSource,
		TYPE_ID	aBase,
		TYPE_ID	aTarget
	)		const

inline

Definition at line 119 of file property_mgr.h.

  {
  return const_cast<void*>( TypeCast( (const void*) aSource, aBase, aTarget ) );
  }

References TypeCast().

Member Data Documentation

◆ m_classes

std::unordered_map<TYPE_ID, CLASS_DESC> PROPERTY_MANAGER::m_classes

private

Definition at line 238 of file property_mgr.h.

Referenced by GetAllClasses(), getClass(), GetProperties(), GetProperty(), IsOfType(), Rebuild(), and TypeCast().

◆ m_classNames

std::unordered_map<TYPE_ID, wxString> PROPERTY_MANAGER::m_classNames

private

Map of all available types.

Definition at line 235 of file property_mgr.h.

Referenced by GetAllClasses(), RegisterType(), and ResolveType().

◆ m_dirty

bool PROPERTY_MANAGER::m_dirty

private

Flag indicating that the list of properties needs to be rebuild (RebuildProperties())

Definition at line 241 of file property_mgr.h.

Referenced by AddProperty(), GetProperties(), GetProperty(), InheritsAfter(), and Rebuild().

◆ m_units

EDA_UNITS PROPERTY_MANAGER::m_units

private

Definition at line 243 of file property_mgr.h.

Referenced by GetUnits(), and SetUnits().

The documentation for this class was generated from the following files:

Classes

Public Types

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ CLASSES_INFO

Constructor & Destructor Documentation

◆ PROPERTY_MANAGER()

Member Function Documentation

◆ AddProperty()

◆ AddTypeCast()

◆ GetAllClasses()

◆ getClass()

◆ GetMatchingClasses()

◆ GetProperties()

◆ GetProperty()

◆ GetUnits()

◆ InheritsAfter()

◆ Instance()

◆ IsOfType()

◆ Rebuild()

◆ RegisterType()

◆ ReplaceProperty()

◆ ResolveType()

◆ SetUnits()

◆ TypeCast() [1/2]

◆ TypeCast() [2/2]

Member Data Documentation

◆ m_classes

◆ m_classNames

◆ m_dirty

◆ m_units