eRPC Generator (erpcgen)  Rev. 1.7.2
NXP Semiconductors
Generator.h
1 /*
2  * Copyright (c) 2014-2015, Freescale Semiconductor, Inc.
3  * Copyright 2016-2017 NXP
4  * All rights reserved.
5  *
6  *
7  * SPDX-License-Identifier: BSD-3-Clause
8  */
9 
10 #ifndef _EMBEDDED_RPC__GENERATOR_H_
11 #define _EMBEDDED_RPC__GENERATOR_H_
12 
13 #include "InterfaceDefinition.h"
14 #include "cpptempl.h"
15 #include "types/AliasType.h"
16 #include "types/ArrayType.h"
17 #include "types/BuiltinType.h"
18 #include "types/ConstType.h"
19 #include "types/DataType.h"
20 #include "types/EnumMember.h"
21 #include "types/EnumType.h"
22 #include "types/Function.h"
23 #include "types/FunctionType.h"
24 #include "types/Group.h"
25 #include "types/Interface.h"
26 #include "types/ListType.h"
27 #include "types/StructMember.h"
28 #include "types/StructType.h"
29 #include "types/UnionType.h"
30 #include "types/VoidType.h"
31 #include <fstream>
32 #include <string>
33 
35 // Classes
37 
38 namespace erpcgen {
39 
43 class Generator
44 {
45 public:
46  enum generator_type_t
47  {
48  kC,
49  kPython
50  };
59  Generator(InterfaceDefinition *def, generator_type_t generatorType);
60 
64  virtual ~Generator() {}
65 
69  virtual void generate() = 0;
70 
71 protected:
72  uint16_t m_idlCrc16;
76  std::vector<Group *> m_groups;
77  std::set<std::string> reserverdWords;
78  generator_type_t m_generatorType;
79  boost::filesystem::path m_outputDirectory;
89  void openFile(std::ofstream &fileOutputStream, const std::string &fileName);
90 
101  void generateOutputFile(const std::string &fileName, const std::string &templateName,
102  cpptempl::data_map &templateData, const char *const kParseFile);
103 
111  std::string stripExtension(const std::string &filename);
112 
124  const std::string &referenceName, const std::string &annName);
125 
136  const std::string &referenceName);
137 
147  StructMember *findParamReferencedFrom(const StructType::member_vector_t &members, const std::string &referenceName);
148 
154  std::string getTime();
155 
159  void findGroupDataTypes();
160 
171  virtual DataType *findChildDataType(std::set<DataType *> &dataTypes, DataType *dataType);
172 
178  virtual void setBinaryList(StructMember *structMember){};
179 
191 
204  virtual cpptempl::data_map getFunctionTemplateData(Group *group, Function *fn) = 0;
205 
212  virtual void setTemplateComments(Symbol *symbol, cpptempl::data_map &symbolInfo) = 0;
213 
224  cpptempl::data_list makeGroupInterfacesTemplateData(Group *group);
225 
235  virtual void generateOutputFiles(const std::string &fileNameExtension) = 0;
236 
242  void generateGroupOutputFiles(Group *group);
243 
248 
256  cpptempl::data_list makeGroupIncludesTemplateData(Group *group);
257 
265  Group *getGroupByName(std::string name);
266 
276  bool isMemberDataTypeUsingForwardDeclaration(Symbol *topSymbol, Symbol *memberSymbol);
277 
287  std::string getOutputName(Symbol *symbol, bool check = true);
288 
294  Annotation::program_lang_t getAnnotationLang();
295 
304  Annotation *findAnnotation(Symbol *symbol, std::string name);
305 
314  std::vector<Annotation *> getAnnotations(Symbol *symbol, std::string name);
315 
324  Value *getAnnValue(Symbol *symbol, std::string name);
325 
334  std::string getAnnStringValue(Symbol *symbol, std::string name);
335 
336 private:
347  cpptempl::data_list getFunctionsTemplateData(Group *group, Interface *iface);
348 };
349 
350 } // namespace erpcgen
351 
352 #endif // _EMBEDDED_RPC__GENERATOR_H_
Collects all definitions from an IDL.
Definition: InterfaceDefinition.h:30
virtual void setTemplateComments(Symbol *symbol, cpptempl::data_map &symbolInfo)=0
This function will get symbol comments and convert to language specific ones.
std::set< std::string > reserverdWords
Definition: Generator.h:77
Member of a struct.
Definition: StructMember.h:37
Annotation class.
Definition: Annotation.h:27
virtual cpptempl::data_map getFunctionTemplateData(Group *group, Function *fn)=0
This function return interface function template data.
std::vector< Annotation * > getAnnotations(Symbol *symbol, std::string name)
Find annotations matching name in the annotation list.
Definition: Generator.cpp:592
generator_type_t m_generatorType
Definition: Generator.h:78
std::vector< Group * > m_groups
Definition: Generator.h:76
uint16_t m_idlCrc16
Definition: Generator.h:72
virtual cpptempl::data_map makeGroupSymbolsTemplateData(Group *group)=0
This function sets group symbols template data.
StructMember * findParamReferencedFromAnn(const StructType::member_vector_t &members, const std::string &referenceName, const std::string &annName)
This function will return pointer to function parameter/structure member where given reference name i...
Definition: Generator.cpp:224
virtual ~Generator()
Destructor.
Definition: Generator.h:64
cpptempl::data_list makeGroupInterfacesTemplateData(Group *group)
This function sets interfaces template data.
Definition: Generator.cpp:410
Function declaration.
Definition: Function.h:116
StructMember * findParamReferencedFromUnion(const StructType::member_vector_t &members, const std::string &referenceName)
This function will return pointer to function parameter/structure member where given reference name i...
Definition: Generator.cpp:238
Base class for all named declarations in the IDL.
Definition: Symbol.h:27
std::string stripExtension(const std::string &filename)
Definition: Generator.cpp:211
boost::filesystem::path m_outputDirectory
Definition: Generator.h:79
Abstract base class for values of arbitrary types.
Definition: Value.h:21
cpptempl::data_list makeGroupIncludesTemplateData(Group *group)
This function sets template data for group include directives.
Definition: Generator.cpp:493
cpptempl::data_map m_templateData
Definition: Generator.h:73
void makeIncludesTemplateData()
This function sets template data for include directives from an IDL file.
Definition: Generator.cpp:479
std::string getTime()
This function return actual time string representation.
Definition: Generator.cpp:282
A scoped namespace containing symbols.
Definition: SymbolScope.h:27
Abstract code generator base class.
Definition: Generator.h:43
Annotation::program_lang_t getAnnotationLang()
Returns Generator flag used for annotation.
Definition: Generator.cpp:573
void openFile(std::ofstream &fileOutputStream, const std::string &fileName)
This function open file.
Definition: Generator.cpp:165
Generator(InterfaceDefinition *def, generator_type_t generatorType)
Constructor.
Definition: Generator.cpp:28
Base class for data types.
Definition: DataType.h:25
An interface that contains functions.
Definition: Group.h:27
std::string getAnnStringValue(Symbol *symbol, std::string name)
This function search and returns string for given annotation name.
Definition: Generator.cpp:602
StructMember * findParamReferencedFrom(const StructType::member_vector_t &members, const std::string &referenceName)
This function will return pointer to function parameter/structure member where given reference name i...
Definition: Generator.cpp:268
Definition: cpptempl.h:190
std::vector< StructMember * > member_vector_t
Definition: StructType.h:31
bool isMemberDataTypeUsingForwardDeclaration(Symbol *topSymbol, Symbol *memberSymbol)
This function returns information if member data type symbol is using forward declared type...
Definition: Generator.cpp:529
virtual void generateOutputFiles(const std::string &fileNameExtension)=0
This function generates output files.
void findGroupDataTypes()
This function finds all group&#39;s data types.
Definition: Generator.cpp:363
An interface that contains functions.
Definition: Interface.h:28
SymbolScope * m_globals
Definition: Generator.h:75
void generateOutputFile(const std::string &fileName, const std::string &templateName, cpptempl::data_map &templateData, const char *const kParseFile)
This function open file, generate output into this file and close this file.
Definition: Generator.cpp:192
virtual void setBinaryList(StructMember *structMember)
This function transform binary data type to list and set annotation to it.
Definition: Generator.h:178
void generateGroupOutputFiles(Group *group)
This function generates output files for defined interfaces.
Definition: Generator.cpp:451
Annotation * findAnnotation(Symbol *symbol, std::string name)
Find annotation in the annotation list.
Definition: Generator.cpp:587
Group * getGroupByName(std::string name)
This function returns pointer to a group with specified name.
Definition: Generator.cpp:152
virtual void generate()=0
Generate output files.
Definition: AstNode.h:25
InterfaceDefinition * m_def
Definition: Generator.h:74
Value * getAnnValue(Symbol *symbol, std::string name)
This function search and returns Value object for given annotation name.
Definition: Generator.cpp:597
virtual DataType * findChildDataType(std::set< DataType * > &dataTypes, DataType *dataType)
This function finds child data types of specified data type.
Definition: Generator.cpp:290