Represents the builtin atomic types. More...

#include <BuiltinType.hpp>

Inheritance diagram for erpcgen::BuiltinType:

Public Types
enum	builtin_type_t { kBoolType, kInt8Type, kInt16Type, kInt32Type, kInt64Type, kUInt8Type, kUInt16Type, kUInt32Type, kUInt64Type, kFloatType, kDoubleType, kStringType, kUStringType, kBinaryType }
	Atomic builtin types.

Public Types inherited from erpcgen::DataType
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
	BuiltinType (const std::string &name, builtin_type_t builtinType)
	Constructor. More...

builtin_type_t	getBuiltinType () const
	This function returns builtin type. More...

virtual bool	isScalar () const override
	This function return "true" value for identify scalar type. More...

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

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

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

virtual bool	isString () const override
	This function return true/false value for identify string type. More...

virtual bool	isUString () const override
	This function return true/false value for identify ustring type. More...

virtual bool	isBinary () const override
	This function return true/false value for identify binary type. More...

Public Member Functions inherited from erpcgen::DataType
	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...

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...

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
builtin_type_t	m_builtinType

Protected Attributes inherited from erpcgen::DataType
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

Represents the builtin atomic types.

Constructor & Destructor Documentation

erpcgen::BuiltinType::BuiltinType	(	const std::string &	name,
		builtin_type_t	builtinType
	)

inline

Constructor.

This function set builtin type to given builtin type and name to given name.

Parameters

[in]	name	Given name.
[in]	builtinType	Given builtin type.

Member Function Documentation

builtin_type_t erpcgen::BuiltinType::getBuiltinType ( ) const

inline

This function returns builtin type.

Returns: Builtin type of current object.

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

inlineoverridevirtual

This function return true/false value for identify binary type.

Return values

true	When builtin type is binary.
false	When builtin type isn't binary.

Reimplemented from erpcgen::DataType.

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

inlineoverridevirtual

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

Return values

true	When builtin type is bool.
false	When builtin type isn't bool.

Reimplemented from erpcgen::DataType.

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

inlineoverridevirtual

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

Return values

true	When builtin type is float.
false	When builtin type isn't float.

Reimplemented from erpcgen::DataType.

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

inlineoverridevirtual

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

Return values

true	When builtin type is int.
false	When builtin type isn't int.

Reimplemented from erpcgen::DataType.

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

inlineoverridevirtual

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

Return values

true	When builtin type is integer, float or boolean.
false	When builtin type isn't integer, float or boolean.

Reimplemented from erpcgen::DataType.

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

inlineoverridevirtual

This function return true/false value for identify string type.

Return values

true	When builtin type is string or ustring.
false	When builtin type isn't string or ustring.

Reimplemented from erpcgen::DataType.

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

inlineoverridevirtual

This function return true/false value for identify ustring type.

Return values

true	When builtin type is ustring.
false	When builtin type isn't ustring.

Reimplemented from erpcgen::DataType.

Member Data Documentation

builtin_type_t erpcgen::BuiltinType::m_builtinType

protected

Builtin type of current object.

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

BuiltinType.hpp

Public Types

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation