1// Protocol Buffers - Google's data interchange format
2// Copyright 2008 Google Inc. All rights reserved.
3// https://developers.google.com/protocol-buffers/
4//
5// Redistribution and use in source and binary forms, with or without
6// modification, are permitted provided that the following conditions are
7// met:
8//
9// * Redistributions of source code must retain the above copyright
10// notice, this list of conditions and the following disclaimer.
11// * Redistributions in binary form must reproduce the above
12// copyright notice, this list of conditions and the following disclaimer
13// in the documentation and/or other materials provided with the
14// distribution.
15// * Neither the name of Google Inc. nor the names of its
16// contributors may be used to endorse or promote products derived from
17// this software without specific prior written permission.
18//
19// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30
31// Author: kenton@google.com (Kenton Varda)
32// Based on original Protocol Buffers design by
33// Sanjay Ghemawat, Jeff Dean, and others.
34//
35// Generates C++ code for a given .proto file.
36
37#ifndef GOOGLE_PROTOBUF_COMPILER_CPP_GENERATOR_H__
38#define GOOGLE_PROTOBUF_COMPILER_CPP_GENERATOR_H__
39
40#include <string>
41#include <google/protobuf/compiler/code_generator.h>
42
43// Must be included last.
44#include <google/protobuf/port_def.inc>
45
46namespace google {
47namespace protobuf {
48namespace compiler {
49namespace cpp {
50
51// CodeGenerator implementation which generates a C++ source file and
52// header. If you create your own protocol compiler binary and you want
53// it to support C++ output, you can do so by registering an instance of this
54// CodeGenerator with the CommandLineInterface in your main() function.
55class PROTOC_EXPORT CppGenerator : public CodeGenerator {
56 public:
57 CppGenerator();
58 ~CppGenerator() override;
59
60 enum class Runtime {
61 kGoogle3, // Use the internal google3 runtime.
62 kOpensource, // Use the open-source runtime.
63
64 // Use the open-source runtime with google3 #include paths. We make these
65 // absolute to avoid ambiguity, so the runtime will be #included like:
66 // #include "third_party/protobuf/.../google/protobuf/message.h"
67 kOpensourceGoogle3
68 };
69
70 void set_opensource_runtime(bool opensource) {
71 opensource_runtime_ = opensource;
72 }
73
74 // If set to a non-empty string, generated code will do:
75 // #include "<BASE>/google/protobuf/message.h"
76 // instead of:
77 // #include <google/protobuf/message.h>
78 // This has no effect if opensource_runtime = false.
79 void set_runtime_include_base(const std::string& base) {
80 runtime_include_base_ = base;
81 }
82
83 // implements CodeGenerator ----------------------------------------
84 bool Generate(const FileDescriptor* file, const std::string& parameter,
85 GeneratorContext* generator_context,
86 std::string* error) const override;
87
88 uint64_t GetSupportedFeatures() const override {
89 // We don't fully support this yet, but this is needed to unblock the tests,
90 // and we will have full support before the experimental flag is removed.
91 return FEATURE_PROTO3_OPTIONAL;
92 }
93
94 private:
95 bool opensource_runtime_ = true;
96 std::string runtime_include_base_;
97 GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(CppGenerator);
98};
99
100} // namespace cpp
101} // namespace compiler
102} // namespace protobuf
103} // namespace google
104
105#include <google/protobuf/port_undef.inc>
106
107#endif // GOOGLE_PROTOBUF_COMPILER_CPP_GENERATOR_H__
108