![]() |
eRPC Generator (erpcgen)
Rev. 1.9.0
NXP Semiconductors
|
An interface that contains functions. More...
#include <Interface.h>
Public Types | |
| typedef std::vector< Function * > | function_vector_t |
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 | |
| Interface (const Token &tok) | |
| Constructor. More... | |
| void | addFunction (Function *func) |
| This function will add function to the interface. More... | |
| SymbolScope & | getScope () |
| This function return symbol scope. More... | |
| function_vector_t & | getFunctions () |
| This function return interface functions vector. More... | |
| uint32_t | getUniqueId () const |
| This function get unique id of interface. More... | |
| void | setUniqueId (uint32_t newId) |
| This function set unique id for interface. More... | |
| virtual std::string | getDescription () const |
| This function returns description about the interface. 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_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 bool | isBuiltin () const |
| This function return "false" value as default for identify builtin type. 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 (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... | |
| 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 (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 | |
| SymbolScope | m_scope |
| function_vector_t | m_functions |
| uint32_t | m_uniqueId |
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 |
Static Protected Attributes | |
| static uint32_t | s_idCounter |
An interface that contains functions.
| typedef std::vector<Function *> erpcgen::Interface::function_vector_t |
Vector of Interface functions.
|
inline |
Constructor.
This function set symbol token to given token.
| [in] | tok | Given token. |
| void Interface::addFunction | ( | Function * | func | ) |
This function will add function to the interface.
The function will add function given by pointer func to the interface members vector m_functions. Also this member will be added as symbol to interface symbol scope m_scope.
| [in] | func | Function pointer, which is added to interface members vector. |
|
virtual |
This function returns description about the interface.
Reimplemented from erpcgen::Symbol.
|
inline |
This function return interface functions vector.
|
inline |
This function return symbol scope.
|
inline |
This function get unique id of interface.
|
inline |
This function set unique id for interface.
| [in] | newId | Unique id for interface. |
|
protected |
Vector of interface functions.
|
protected |
Scope which interface belongs to.
|
protected |
Interface unique id.
|
staticprotected |
Interface id counter. Each interface will increase this.