eRPC Generator (erpcgen)  Rev. 1.9.0
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 
32 #include <fstream>
33 #include <string>
34 
36 // Classes
38 
39 namespace erpcgen {
40 
44 class Generator
45 {
46 public:
47  enum generator_type_t
48  {
49  kC,
50  kPython
51  };
60  Generator(InterfaceDefinition *def, generator_type_t generatorType);
61 
65  virtual ~Generator() {}
66 
70  virtual void generate() = 0;
71 
72 protected:
73  uint16_t m_idlCrc16;
77  std::vector<Group *> m_groups;
78  std::set<std::string> reserverdWords;
79  generator_type_t m_generatorType;
80  boost::filesystem::path m_outputDirectory;
90  void openFile(std::ofstream &fileOutputStream, const std::string &fileName);
91 
102  void generateOutputFile(const std::string &fileName, const std::string &templateName,
103  cpptempl::data_map &templateData, const char *const kParseFile);
104 
112  std::string stripExtension(const std::string &filename);
113 
125  const std::string &referenceName, const std::string &annName);
126 
137  const std::string &referenceName);
138 
148  StructMember *findParamReferencedFrom(const StructType::member_vector_t &members, const std::string &referenceName);
149 
155  std::string getTime();
156 
160  void findGroupDataTypes();
161 
172  virtual DataType *findChildDataType(std::set<DataType *> &dataTypes, DataType *dataType);
173 
179  virtual void setBinaryList(StructMember *structMember) { (void)structMember; };
180 
192 
205  virtual cpptempl::data_map getFunctionTemplateData(Group *group, Function *fn) = 0;
206 
213  virtual void setTemplateComments(Symbol *symbol, cpptempl::data_map &symbolInfo) = 0;
214 
225  cpptempl::data_list makeGroupInterfacesTemplateData(Group *group);
226 
236  virtual void generateOutputFiles(const std::string &fileNameExtension) = 0;
237 
243  void generateGroupOutputFiles(Group *group);
244 
249 
257  cpptempl::data_list makeGroupIncludesTemplateData(Group *group);
258 
266  Group *getGroupByName(std::string name);
267 
277  bool isMemberDataTypeUsingForwardDeclaration(Symbol *topSymbol, Symbol *memberSymbol);
278 
288  std::string getOutputName(Symbol *symbol, bool check = true);
289 
295  Annotation::program_lang_t getAnnotationLang();
296 
305  Annotation *findAnnotation(Symbol *symbol, std::string name);
306 
315  std::vector<Annotation *> getAnnotations(Symbol *symbol, std::string name);
316 
325  Value *getAnnValue(Symbol *symbol, std::string name);
326 
335  std::string getAnnStringValue(Symbol *symbol, std::string name);
336 
337 private:
348  cpptempl::data_list getFunctionsTemplateData(Group *group, Interface *iface);
349 };
350 
351 } // namespace erpcgen
352 
353 #endif // _EMBEDDED_RPC__GENERATOR_H_
Collects all definitions from an IDL.
Definition: InterfaceDefinition.h:31
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:78
Member of a struct.
Definition: StructMember.h:38
Annotation class.
Definition: Annotation.h:28
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:581
generator_type_t m_generatorType
Definition: Generator.h:79
std::vector< Group * > m_groups
Definition: Generator.h:77
uint16_t m_idlCrc16
Definition: Generator.h:73
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:219
virtual ~Generator()
Destructor.
Definition: Generator.h:65
cpptempl::data_list makeGroupInterfacesTemplateData(Group *group)
This function sets interfaces template data.
Definition: Generator.cpp:399
Function declaration.
Definition: Function.h:117
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:233
Base class for all named declarations in the IDL.
Definition: Symbol.h:28
std::string stripExtension(const std::string &filename)
Definition: Generator.cpp:206
boost::filesystem::path m_outputDirectory
Definition: Generator.h:80
Abstract base class for values of arbitrary types.
Definition: Value.h:27
cpptempl::data_list makeGroupIncludesTemplateData(Group *group)
This function sets template data for group include directives.
Definition: Generator.cpp:482
cpptempl::data_map m_templateData
Definition: Generator.h:74
void makeIncludesTemplateData()
This function sets template data for include directives from an IDL file.
Definition: Generator.cpp:468
std::string getTime()
This function return actual time string representation.
Definition: Generator.cpp:277
A scoped namespace containing symbols.
Definition: SymbolScope.h:28
Abstract code generator base class.
Definition: Generator.h:44
Annotation::program_lang_t getAnnotationLang()
Returns Generator flag used for annotation.
Definition: Generator.cpp:562
void openFile(std::ofstream &fileOutputStream, const std::string &fileName)
This function open file.
Definition: Generator.cpp:160
Generator(InterfaceDefinition *def, generator_type_t generatorType)
Constructor.
Definition: Generator.cpp:31
Base class for data types.
Definition: DataType.h:26
An interface that contains functions.
Definition: Group.h:28
std::string getAnnStringValue(Symbol *symbol, std::string name)
This function search and returns string for given annotation name.
Definition: Generator.cpp:591
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:263
Definition: cpptempl.h:190
std::vector< StructMember * > member_vector_t
Definition: StructType.h:32
bool isMemberDataTypeUsingForwardDeclaration(Symbol *topSymbol, Symbol *memberSymbol)
This function returns information if member data type symbol is using forward declared type...
Definition: Generator.cpp:518
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:352
An interface that contains functions.
Definition: Interface.h:29
SymbolScope * m_globals
Definition: Generator.h:76
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:187
virtual void setBinaryList(StructMember *structMember)
This function transform binary data type to list and set annotation to it.
Definition: Generator.h:179
void generateGroupOutputFiles(Group *group)
This function generates output files for defined interfaces.
Definition: Generator.cpp:440
Annotation * findAnnotation(Symbol *symbol, std::string name)
Find annotation in the annotation list.
Definition: Generator.cpp:576
Group * getGroupByName(std::string name)
This function returns pointer to a group with specified name.
Definition: Generator.cpp:147
virtual void generate()=0
Generate output files.
Definition: AstNode.h:26
InterfaceDefinition * m_def
Definition: Generator.h:75
Value * getAnnValue(Symbol *symbol, std::string name)
This function search and returns Value object for given annotation name.
Definition: Generator.cpp:586
virtual DataType * findChildDataType(std::set< DataType * > &dataTypes, DataType *dataType)
This function finds child data types of specified data type.
Definition: Generator.cpp:285