QtProtobuf  0.6
Protobuf plugin to generate Qt classes
generatorbase.h
1 /*
2  * MIT License
3  *
4  * Copyright (c) 2019 Alexey Edelev <semlanik@gmail.com>
5  *
6  * This file is part of QtProtobuf project https://git.semlanik.org/semlanik/qtprotobuf
7  *
8  * Permission is hereby granted, free of charge, to any person obtaining a copy of this
9  * software and associated documentation files (the "Software"), to deal in the Software
10  * without restriction, including without limitation the rights to use, copy, modify,
11  * merge, publish, distribute, sublicense, and/or sell copies of the Software, and
12  * to permit persons to whom the Software is furnished to do so, subject to the following
13  * conditions:
14  *
15  * The above copyright notice and this permission notice shall be included in all copies
16  * or substantial portions of the Software.
17  *
18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
19  * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
20  * PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
21  * FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
22  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
23  * DEALINGS IN THE SOFTWARE.
24  */
25 
26 #pragma once
27 
28 #include <google/protobuf/compiler/code_generator.h>
29 #include <google/protobuf/io/zero_copy_stream.h>
30 #include <string>
31 #include <memory>
32 #include <functional>
33 #include <google/protobuf/descriptor.h>
34 
35 namespace google { namespace protobuf {
36 class FileDescriptor;
37 class Descriptor;
38 namespace compiler {
39 class GeneratorContext;
40 }}}
41 
42 namespace QtProtobuf {
43 namespace generator {
44 
129 class GeneratorBase: public ::google::protobuf::compiler::CodeGenerator
130 {
131 public:
132  enum Mode {
133  SingleMode = 0,
134  MultiMode,
135  };
136  GeneratorBase(Mode mode);
137  virtual ~GeneratorBase() = default;
138 
139  virtual bool GenerateAll(const std::vector<const ::google::protobuf::FileDescriptor *> &files,
140  const std::string &parameter,
141  ::google::protobuf::compiler::GeneratorContext *generatorContext,
142  std::string *error) const override;
143  bool HasGenerateAll() const override { return true; }
144 
145  static void printDisclaimer(const std::shared_ptr<::google::protobuf::io::Printer> printer);
146  static void printPreamble(const std::shared_ptr<::google::protobuf::io::Printer> printer);
147  static void printInclude(const std::shared_ptr<::google::protobuf::io::Printer> printer, const google::protobuf::Descriptor *message, const google::protobuf::FieldDescriptor *field, std::set<std::string> &existingIncludes);
148  static void printQtProtobufUsingNamespace(const std::shared_ptr<::google::protobuf::io::Printer> printer);
149  static void printNamespaces(const std::shared_ptr<::google::protobuf::io::Printer> printer, const std::vector<std::string> namespaces);
150 protected:
151  static std::string generateBaseName(const ::google::protobuf::FileDescriptor *file, std::string name);
152 
153 private:
154  Mode m_mode;
155 };
156 
157 }
158 }