eRPC Generator (erpcgen)  Rev. 1.7.2
NXP Semiconductors
Symbol.h
1 /*
2  * Copyright (c) 2014, Freescale Semiconductor, Inc.
3  * Copyright 2016 NXP
4  * All rights reserved.
5  *
6  *
7  * SPDX-License-Identifier: BSD-3-Clause
8  */
9 
10 #ifndef _EMBEDDED_RPC__SYMBOL_H_
11 #define _EMBEDDED_RPC__SYMBOL_H_
12 
13 #include "Annotation.h"
14 #include "AstNode.h"
15 #include "Token.h"
16 #include <vector>
17 
19 // Classes
21 
22 namespace erpcgen {
23 
27 class Symbol
28 {
29 public:
34  {
35  kConstSymbol,
36  kEnumMemberSymbol,
37  kFunctionSymbol,
38  kInterfaceSymbol,
39  kProgramSymbol,
40  kStructMemberSymbol,
41  kTypenameSymbol,
42  kUnionCaseMemberSymbol,
43 
44  kAliasTypeSymbol,
45  kArrayTypeSymbol,
46  kBuiltinTypeSymbol,
47  kEnumTypeSymbol,
48  kFunctionTypeSymbol,
49  kListTypeSymbol,
50  kStructTypeSymbol,
51  kUnionTypeSymbol
52  };
53 
62  : m_symbolType(symType)
63  , m_name()
64  , m_location()
65  , m_annotations()
66  , m_mlComment("")
67  , m_ilComment("")
68  {
69  }
70 
79  Symbol(symbol_type_t symType, const std::string &name)
80  : m_symbolType(symType)
81  , m_name(name)
82  , m_location()
83  , m_annotations()
84  , m_mlComment("")
85  , m_ilComment("")
86  {
87  }
88 
97  Symbol(symbol_type_t symType, const Token &tok)
98  : m_symbolType(symType)
99  , m_name(tok.getStringValue())
100  , m_location(tok.getLocation())
101  , m_annotations()
102  , m_mlComment("")
103  , m_ilComment("")
104  {
105  }
106 
110  virtual ~Symbol() {}
111 
118 
124  const std::string &getName() const { return m_name; }
125 
131  void setName(const std::string &newName) { m_name = newName; }
132 
139 
145  void setLocation(const token_loc_t &loc) { m_location = loc; }
146 
152  int getFirstLine() const { return m_location.m_firstLine; }
153 
159  int getLastLine() const { return m_location.m_lastLine; }
160 
166  virtual bool isBuiltin() const { return false; }
167 
173  virtual std::string getDescription() const { return m_name; }
174 
180  void addAnnotation(const Annotation &a) { m_annotations.push_back(a); }
181 
187  std::string printAnnotations();
188 
197  Annotation *findAnnotation(std::string name, Annotation::program_lang_t lang);
198 
207  std::vector<Annotation *> getAnnotations(std::string name, Annotation::program_lang_t lang);
208 
214  const std::vector<Annotation> &getAnnotations() const { return m_annotations; };
215 
224  Value *getAnnValue(const std::string annName, Annotation::program_lang_t lang);
225 
234  std::string getAnnStringValue(const std::string annName, Annotation::program_lang_t lang);
235 
241  std::string getMlComment() { return m_mlComment; }
242 
248  void setMlComment(std::string comment) { m_mlComment = comment; }
249 
255  std::string getIlComment() { return m_ilComment; }
256 
262  void setIlComment(std::string comment) { m_ilComment = comment; }
263 
264 protected:
266  std::string m_name;
268  std::vector<Annotation> m_annotations;
269  std::string m_mlComment;
270  std::string m_ilComment;
271 };
272 
273 } // namespace erpcgen
274 
275 #endif // _EMBEDDED_RPC__SYMBOL_H_
std::string printAnnotations()
This function returns description about annotation.
Definition: Type.cpp:61
Annotation class.
Definition: Annotation.h:27
std::string getMlComment()
This function returns multiline comment for this symbol declared in IDL file.
Definition: Symbol.h:241
Symbol(symbol_type_t symType)
Constructor.
Definition: Symbol.h:61
std::string m_ilComment
Definition: Symbol.h:270
int getFirstLine() const
This function return first line from location of symbol.
Definition: Symbol.h:152
virtual bool isBuiltin() const
This function return "false" value as default for identify builtin type.
Definition: Symbol.h:166
int m_lastLine
Definition: Token.h:29
Value * getAnnValue(const std::string annName, Annotation::program_lang_t lang)
This function search and returns Value object for given annotation name.
Definition: Type.cpp:108
std::string getAnnStringValue(const std::string annName, Annotation::program_lang_t lang)
This function search and returns string for given annotation name.
Definition: Type.cpp:114
const std::vector< Annotation > & getAnnotations() const
Return all Symbol annotations.
Definition: Symbol.h:214
std::string m_name
Definition: Symbol.h:266
Symbol(symbol_type_t symType, const Token &tok)
Constructor.
Definition: Symbol.h:97
int m_firstLine
Definition: Token.h:27
void setLocation(const token_loc_t &loc)
This function set location for symbol.
Definition: Symbol.h:145
Base class for all named declarations in the IDL.
Definition: Symbol.h:27
token_loc_t & getLocation()
This function returns location for symbol.
Definition: Symbol.h:138
symbol_type_t m_symbolType
Definition: Symbol.h:265
Abstract base class for values of arbitrary types.
Definition: Value.h:21
std::vector< Annotation > m_annotations
Definition: Symbol.h:268
std::string getIlComment()
This function returns inline comment for this symbol declared in IDL file.
Definition: Symbol.h:255
token_loc_t m_location
Definition: Symbol.h:267
std::string m_mlComment
Definition: Symbol.h:269
const std::string & getName() const
This function returns symbol name.
Definition: Symbol.h:124
Encapsulates all information about a token.
Definition: Token.h:60
virtual std::string getDescription() const
This function returns description about the symbol (symbol name).
Definition: Symbol.h:173
int getLastLine() const
This function return last line from location of symbol.
Definition: Symbol.h:159
void setIlComment(std::string comment)
This function set inline comment for this symbol declared in IDL file.
Definition: Symbol.h:262
symbol_type_t getSymbolType() const
This function returns symbol type.
Definition: Symbol.h:117
void setMlComment(std::string comment)
This function set multiline comment for this symbol declared in IDL file.
Definition: Symbol.h:248
void setName(const std::string &newName)
This function set symbol name.
Definition: Symbol.h:131
Annotation * findAnnotation(std::string name, Annotation::program_lang_t lang)
Find annotation in the annotation list.
Definition: Type.cpp:81
virtual ~Symbol()
Destructor.
Definition: Symbol.h:110
Token location in the source file.
Definition: Token.h:25
void addAnnotation(const Annotation &a)
This function add annotation to vector of symbol annotations.
Definition: Symbol.h:180
symbol_type_t
Supported symbol types.
Definition: Symbol.h:33
Definition: AstNode.h:25
Symbol(symbol_type_t symType, const std::string &name)
Constructor.
Definition: Symbol.h:79