Base class for data types. More...

#include <DataType.hpp>

Inheritance diagram for erpcgen::DataType:

Public Types
enum	data_type_t { kAliasType, kArrayType, kBuiltinType, kEnumType, kFunctionType, kListType, kStructType, kUnionType, kVoidType }
	Supported data types.

Public Types inherited from erpcgen::Symbol
enum	symbol_type_t { kConstSymbol, kEnumMemberSymbol, kFunctionSymbol, kInterfaceSymbol, kProgramSymbol, kStructMemberSymbol, kTypenameSymbol, kUnionCaseMemberSymbol }
	Supported symbol types.

Public Member Functions
	DataType (data_type_t dataType)
	Constructor. More...

	DataType (const std::string &name, data_type_t dataType)
	Constructor. More...

	DataType (const Token &tok, data_type_t dataType)
	Constructor. More...

data_type_t	getDataType () const
	This function returns data type. More...

DataType *	getTrueDataType ()
	This function returns pointer to true data type instead of alias. More...

DataType *	getTrueContainerDataType ()
	This function returns pointer to true data type (enum, builtin, structs) except lists and arrays. More...

bool	isAlias () const
	This function is testing data type. More...

bool	isArray () const
	This function is testing data type. More...

virtual bool	isBinary () const
	This function return "false" value as default for identify binary type. More...

virtual bool	isBool () const
	This function return "false" value as default for identify bool type. More...

bool	isBuiltin () const
	This function is testing data type. More...

bool	isEnum () const
	This function is testing data type. More...

bool	isFunction () const
	This function is testing data type. More...

bool	isList () const
	This function is testing data type. More...

virtual bool	isScalar () const
	This function return "false" value as default for identify scalar builtin type. More...

virtual bool	isInt () const
	This function return "true" value for identify int type. More...

virtual bool	isFloat () const
	This function return "true" value for identify float type. More...

virtual bool	isString () const
	This function return "false" value as default for identify string type. More...

virtual bool	isUString () const
	This function return "false" value as default for identify ustring type. More...

bool	isStruct () const
	This function is testing data type. More...

bool	isUnion () const
	This function is testing data type. More...

bool	isVoid () const
	This function is testing data type. More...

Public Member Functions inherited from erpcgen::Symbol
	Symbol (symbol_type_t symType)
	Constructor. More...

	Symbol (symbol_type_t symType, const std::string &name)
	Constructor. More...

	Symbol (symbol_type_t symType, const Token &tok)
	Constructor. More...

virtual	~Symbol ()
	Destructor.

symbol_type_t	getSymbolType () const
	This function returns symbol type. More...

const std::string &	getName () const
	This function returns symbol name. More...

void	setName (const std::string &newName)
	This function set symbol name. More...

bool	isConstSymbol () const
	This function is testing symbol type. More...

bool	isEnumMemberSymbol () const
	This function is testing symbol type. More...

bool	isFunctionSymbol () const
	This function is testing symbol type. More...

bool	isInterfaceSymbol () const
	This function is testing symbol type. More...

bool	isProgramSymbol () const
	This function is testing symbol type. More...

bool	isStructMemberSymbol () const
	This function is testing symbol type. More...

bool	isDatatypeSymbol () const
	This function is testing symbol type. More...

bool	isUnionCaseSymbol () const
	This function is testing symbol type. More...

token_loc_t &	getLocation ()
	This function returns location for symbol. More...

void	setLocation (const token_loc_t &loc)
	This function set location for symbol. More...

int	getFirstLine () const
	This function return first line from location of symbol. More...

int	getLastLine () const
	This function return last line from location of symbol. More...

virtual std::string	getDescription () const
	This function returns description about the symbol (symbol name). More...

void	addAnnotation (const Annotation &a)
	This function add annotation to vector of symbol annotations. More...

std::string	printAnnotations ()
	This function returns description about annotation. More...

Annotation *	findAnnotation (const std::string &name, Annotation::program_lang_t lang)
	Find annotation in the annotation list. More...

std::vector< Annotation * >	getAnnotations (const std::string &name, Annotation::program_lang_t lang)
	Find annotations matching name in the annotation list. More...

const std::vector< Annotation > &	getAnnotations () const
	Return all Symbol annotations. More...

Value *	getAnnValue (const std::string &annName, Annotation::program_lang_t lang)
	This function search and returns Value object for given annotation name. More...

std::string	getAnnStringValue (const std::string &annName, Annotation::program_lang_t lang)
	This function search and returns string for given annotation name. More...

std::string	getMlComment ()
	This function returns multiline comment for this symbol declared in IDL file. More...

void	setMlComment (const std::string &comment)
	This function set multiline comment for this symbol declared in IDL file. More...

std::string	getIlComment ()
	This function returns inline comment for this symbol declared in IDL file. More...

void	setIlComment (const std::string &comment)
	This function set inline comment for this symbol declared in IDL file. More...

Protected Attributes
data_type_t	m_dataType

Protected Attributes inherited from erpcgen::Symbol
symbol_type_t	m_symbolType

std::string	m_name

token_loc_t	m_location

std::vector< Annotation >	m_annotations

std::string	m_mlComment

std::string	m_ilComment

Detailed Description

Base class for data types.

Constructor & Destructor Documentation

erpcgen::DataType::DataType ( data_type_t dataType )

inlineexplicit

Constructor.

This function set data type to given data type.

Parameters

[in] dataType Given data type.

erpcgen::DataType::DataType	(	const std::string &	name,
		data_type_t	dataType
	)

inline

Constructor.

This function set data type to given data type and symbol name to given name.

Parameters

[in]	dataType	Given data type.
[in]	name	Given name for symbol.

erpcgen::DataType::DataType	(	const Token &	tok,
		data_type_t	dataType
	)

inline

Constructor.

This function set data type to given data type, symbol token to given token and symbol type to given symbol type.

Parameters

[in]	tok	Token, which contains name and location.
[in]	dataType	Given data type.
[in]	symbolType	Given symbol type for symbol.

Member Function Documentation

data_type_t erpcgen::DataType::getDataType ( ) const

inline

This function returns data type.

Returns: Data type of current object.

DataType * DataType::getTrueContainerDataType ( )

This function returns pointer to true data type (enum, builtin, structs) except lists and arrays.

The function returns pointer to true data type (enum, builtin, structs) except lists and arrays. When array or list data type are founded, it will search in their elements data types for last element data type which will be (enum, builtin, structs).

Returns: Pointer to true data type (enum, builtin, structs) of current object.

DataType * DataType::getTrueDataType ( )

This function returns pointer to true data type instead of alias.

The function returns pointer to true data type instead of alias name.

Returns: True data type of current object.

bool erpcgen::DataType::isAlias ( ) const

inline

This function is testing data type.

Return values

true	When data type is AliasType.
false	When data type isn't AliasType.

bool erpcgen::DataType::isArray ( ) const

inline

This function is testing data type.

Return values

true	When data type is ArrayType.
false	When data type isn't ArrayType.

virtual bool erpcgen::DataType::isBinary ( ) const

inlinevirtual

This function return "false" value as default for identify binary type.

Return values

false Always return false.

Reimplemented in erpcgen::BuiltinType.

virtual bool erpcgen::DataType::isBool ( ) const

inlinevirtual

This function return "false" value as default for identify bool type.

Return values

false Always return false.

Reimplemented in erpcgen::BuiltinType.

bool erpcgen::DataType::isBuiltin ( ) const

inline

This function is testing data type.

Return values

true	When data type is BuiltinType.
false	When data type isn't BuiltinType.

bool erpcgen::DataType::isEnum ( ) const

inline

This function is testing data type.

Return values

true	When data type is EnumTyp.
false	When data type isn't EnumTyp.

virtual bool erpcgen::DataType::isFloat ( ) const

inlinevirtual

This function return "true" value for identify float type.

Return values

false Always return false;

Reimplemented in erpcgen::BuiltinType.

bool erpcgen::DataType::isFunction ( ) const

inline

This function is testing data type.

Return values

true	When data type is FunctionType.
false	When data type isn't FunctionType.

virtual bool erpcgen::DataType::isInt ( ) const

inlinevirtual

This function return "true" value for identify int type.

Return values

false Always return false;

Reimplemented in erpcgen::BuiltinType.

bool erpcgen::DataType::isList ( ) const

inline

This function is testing data type.

Return values

true	When data type is ListType.
false	When data type isn't ListType.

virtual bool erpcgen::DataType::isScalar ( ) const

inlinevirtual

This function return "false" value as default for identify scalar builtin type.

Return values

false Always return false;

Reimplemented in erpcgen::BuiltinType.

virtual bool erpcgen::DataType::isString ( ) const

inlinevirtual

This function return "false" value as default for identify string type.

Return values

false Always return false.

Reimplemented in erpcgen::BuiltinType.

bool erpcgen::DataType::isStruct ( ) const

inline

This function is testing data type.

Return values

true	When data type is StructType.
false	When data type isn't StructType.

bool erpcgen::DataType::isUnion ( ) const

inline

This function is testing data type.

Return values

true	When data type is UnionType.
false	When data type isn't UnionType.

virtual bool erpcgen::DataType::isUString ( ) const

inlinevirtual

This function return "false" value as default for identify ustring type.

Return values

false Always return false.

Reimplemented in erpcgen::BuiltinType.

bool erpcgen::DataType::isVoid ( ) const

inline

This function is testing data type.

Return values

true	When data type is VoidType.
false	When data type isn't VoidType.

Member Data Documentation

data_type_t erpcgen::DataType::m_dataType

protected

Data type of current object

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

DataType.hpp
Type.cpp

Public Types

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation