Structure data type. More...

#include <StructType.hpp>

Inheritance diagram for erpcgen::StructType:

Public Types
typedef std::vector< StructMember * >	member_vector_t

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
	StructType (const std::string &name)
	Constructor. More...

	StructType (const Token &tok)
	Constructor. More...

void	addMember (StructMember *newMember)
	This function will add struct member to the struct. More...

SymbolScope &	getScope ()
	This function returns symbol scope. More...

member_vector_t &	getMembers ()
	This function returns struct members vector. More...

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

bool	containListMember ()
	This function return true, when has member, which contains list type. More...

bool	containStringMember ()
	This function return true, when has member, which contains string type. More...

bool	containByrefMember ()
	This function return true, when has member, which contains flag byref. 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...

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

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
SymbolScope	m_scope

member_vector_t	m_members

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

Structure data type.

Member Typedef Documentation

typedef std::vector<StructMember *> erpcgen::StructType::member_vector_t

Vector of Struct members.

Constructor & Destructor Documentation

erpcgen::StructType::StructType ( const std::string & name )

inlineexplicit

Constructor.

This function set name to given name.

Parameters

[in] name Given name.

erpcgen::StructType::StructType ( const Token & tok )

inlineexplicit

Constructor.

This function set symbol token to given token.

Parameters

[in] tok Given token.

Member Function Documentation

void StructType::addMember ( StructMember * newMember )

This function will add struct member to the struct.

The function will add struct member given by pointer newMember to the struct members vector m_members. Also this member will be added as symbol to struct symbol scope m_scope.

Parameters

[in] newMember Struct member pointer, which is added to struct members vector.

bool StructType::containByrefMember ( )

This function return true, when has member, which contains flag byref.

Returns: True if structure contains byref parameter.

bool StructType::containListMember ( )

This function return true, when has member, which contains list type.

Returns: True if structure contains list type.

bool StructType::containStringMember ( )

This function return true, when has member, which contains string type.

Returns: True if structure contains string type.

string StructType::getDescription ( ) const

overridevirtual

This function returns description about the struct.

Returns: String description about struct.

See also: std::string AliasType::getDescription() const; std::string EnumType::getDescription() const; std::string EnumMember::getDescription() const; std::string StructMember::getDescription() const; std::string VoidType::getDescription() const; std::string ArrayType::getDescription() const; std::string ListType::getDescription() const; std::string UnionType::getDescription() const

Reimplemented from erpcgen::Symbol.

member_vector_t& erpcgen::StructType::getMembers ( )

inline

This function returns struct members vector.

Returns: Vector of struct members.

SymbolScope& erpcgen::StructType::getScope ( )

inline

This function returns symbol scope.

Returns: Symbol scope.

Member Data Documentation

member_vector_t erpcgen::StructType::m_members

protected

Vector of structure members.

SymbolScope erpcgen::StructType::m_scope

protected

Symbol scope of current structure.

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

StructType.hpp
Type.cpp

Public Types

Public Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation