eRPC Generator (erpcgen)  Rev. 1.7.2
NXP Semiconductors
erpcgen::BuiltinType Class Reference

Represents the builtin atomic types. More...

#include <BuiltinType.h>

Inheritance diagram for erpcgen::BuiltinType:
erpcgen::DataType erpcgen::Symbol

Public Types

enum  _builtin_type {
  kBoolType,
  kInt8Type,
  kInt16Type,
  kInt32Type,
  kInt64Type,
  kUInt8Type,
  kUInt16Type,
  kUInt32Type,
  kUInt64Type,
  kFloatType,
  kDoubleType,
  kStringType,
  kBinaryType
}
 Atomic builtin types.
 
- Public Types inherited from erpcgen::DataType
enum  _data_type {
  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,
  kAliasTypeSymbol,
  kArrayTypeSymbol,
  kBuiltinTypeSymbol,
  kEnumTypeSymbol,
  kFunctionTypeSymbol,
  kListTypeSymbol,
  kStructTypeSymbol,
  kUnionTypeSymbol
}
 Supported symbol types.
 

Public Member Functions

 BuiltinType (const std::string &name, _builtin_type builtinType)
 Constructor. More...
 
_builtin_type getBuiltinType () const
 This function returns builtin type. More...
 
virtual bool isBuiltin () const
 This function return "true" value for identify builtin type. More...
 
virtual bool isScalar () const
 This function return "true" value for identify scalar 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 isBool () const
 This function return "true" value for identify bool type. More...
 
virtual bool isString () const
 This function return true/false value for identify string type. More...
 
virtual bool isBinary () const
 This function return true/false value for identify binary type. More...
 
- Public Member Functions inherited from erpcgen::DataType
 DataType (_data_type dataType)
 Constructor. More...
 
 DataType (const std::string &name, _data_type dataType)
 Constructor. More...
 
 DataType (const std::string &name, _data_type dataType, symbol_type_t symbolType)
 Constructor. More...
 
 DataType (const Token &tok, _data_type dataType, symbol_type_t symbolType)
 Constructor. More...
 
_data_type getDataType () const
 This function returns data type. More...
 
DataTypegetTrueDataType ()
 This function returns pointer to true data type instead of alias. More...
 
DataTypegetTrueContainerDataType ()
 This function returns pointer to true data type (enum, builtin, structs) except lists and arrays. More...
 
virtual bool isAlias () const
 This function return "false" value as default for identify alias type. More...
 
virtual bool isArray () const
 This function return "false" value as default for identify array type. More...
 
virtual bool isEnum () const
 This function return "false" value as default for identify enum type. More...
 
virtual bool isFunction () const
 This function return "false" value as default for identify function type. More...
 
virtual bool isList () const
 This function return "false" value as default for identify list type. More...
 
virtual bool isStruct () const
 This function return "false" value as default for identify struct type. More...
 
virtual bool isUnion () const
 This function return "false" value as default for identify union type. More...
 
virtual bool isVoid () const
 This function return "false" value as default for identify void 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...
 
token_loc_tgetLocation ()
 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...
 
AnnotationfindAnnotation (std::string name, Annotation::program_lang_t lang)
 Find annotation in the annotation list. More...
 
std::vector< Annotation * > getAnnotations (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...
 
ValuegetAnnValue (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 (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 (std::string comment)
 This function set inline comment for this symbol declared in IDL file. More...
 

Protected Attributes

_builtin_type m_builtinType
 
- Protected Attributes inherited from erpcgen::DataType
_data_type m_dataType
 
- Protected Attributes inherited from erpcgen::Symbol
symbol_type_t m_symbolType
 
std::string m_name
 
token_loc_t m_location
 
std::vector< Annotationm_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  builtinType 
)
inline

Constructor.

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

Parameters
[in]nameGiven name.
[in]builtinTypeGiven builtin type.

Member Function Documentation

_builtin_type erpcgen::BuiltinType::getBuiltinType ( ) const
inline

This function returns builtin type.

Returns
Builtin type of current object.
virtual bool erpcgen::BuiltinType::isBinary ( ) const
inlinevirtual

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

Return values
trueWhen builtin type is binary.
falseWhen builtin type isn't binary.

Reimplemented from erpcgen::DataType.

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

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

Return values
trueWhen builtin type is bool.
falseWhen builtin type isn't bool.

Reimplemented from erpcgen::DataType.

virtual bool erpcgen::BuiltinType::isBuiltin ( ) const
inlinevirtual

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

Return values
trueAlways return true.

Reimplemented from erpcgen::DataType.

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

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

Return values
trueWhen builtin type is float.
falseWhen builtin type isn't float.
virtual bool erpcgen::BuiltinType::isInt ( ) const
inlinevirtual

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

Return values
trueWhen builtin type is int.
falseWhen builtin type isn't int.
virtual bool erpcgen::BuiltinType::isScalar ( ) const
inlinevirtual

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

Return values
trueWhen builtin type is integer, float or boolean.
falseWhen builtin type isn't integer, float or boolean.

Reimplemented from erpcgen::DataType.

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

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

Return values
trueWhen builtin type is string.
falseWhen builtin type isn't string.

Reimplemented from erpcgen::DataType.

Member Data Documentation

_builtin_type erpcgen::BuiltinType::m_builtinType
protected

Builtin type of current object.


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