temporal | 40ee551 | 2008-07-10 02:12:20 +0000 | [diff] [blame] | 1 | // Protocol Buffers - Google's data interchange format |
kenton@google.com | 24bf56f | 2008-09-24 20:31:01 +0000 | [diff] [blame] | 2 | // Copyright 2008 Google Inc. All rights reserved. |
Feng Xiao | e428862 | 2014-10-01 16:26:23 -0700 | [diff] [blame] | 3 | // https://developers.google.com/protocol-buffers/ |
temporal | 40ee551 | 2008-07-10 02:12:20 +0000 | [diff] [blame] | 4 | // |
kenton@google.com | 24bf56f | 2008-09-24 20:31:01 +0000 | [diff] [blame] | 5 | // Redistribution and use in source and binary forms, with or without |
| 6 | // modification, are permitted provided that the following conditions are |
| 7 | // met: |
temporal | 40ee551 | 2008-07-10 02:12:20 +0000 | [diff] [blame] | 8 | // |
kenton@google.com | 24bf56f | 2008-09-24 20:31:01 +0000 | [diff] [blame] | 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. |
temporal | 40ee551 | 2008-07-10 02:12:20 +0000 | [diff] [blame] | 18 | // |
kenton@google.com | 24bf56f | 2008-09-24 20:31:01 +0000 | [diff] [blame] | 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. |
temporal | 40ee551 | 2008-07-10 02:12:20 +0000 | [diff] [blame] | 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 | #include <google/protobuf/compiler/cpp/cpp_generator.h> |
| 36 | |
| 37 | #include <vector> |
jieluo@google.com | 4de8f55 | 2014-07-18 00:47:59 +0000 | [diff] [blame] | 38 | #include <memory> |
Feng Xiao | 6ef984a | 2014-11-10 17:34:54 -0800 | [diff] [blame] | 39 | #ifndef _SHARED_PTR_H |
| 40 | #include <google/protobuf/stubs/shared_ptr.h> |
| 41 | #endif |
temporal | 40ee551 | 2008-07-10 02:12:20 +0000 | [diff] [blame] | 42 | #include <utility> |
| 43 | |
| 44 | #include <google/protobuf/compiler/cpp/cpp_file.h> |
| 45 | #include <google/protobuf/compiler/cpp/cpp_helpers.h> |
| 46 | #include <google/protobuf/io/printer.h> |
| 47 | #include <google/protobuf/io/zero_copy_stream.h> |
| 48 | #include <google/protobuf/descriptor.pb.h> |
temporal | 40ee551 | 2008-07-10 02:12:20 +0000 | [diff] [blame] | 49 | |
| 50 | namespace google { |
| 51 | namespace protobuf { |
| 52 | namespace compiler { |
| 53 | namespace cpp { |
| 54 | |
temporal | 40ee551 | 2008-07-10 02:12:20 +0000 | [diff] [blame] | 55 | CppGenerator::CppGenerator() {} |
| 56 | CppGenerator::~CppGenerator() {} |
| 57 | |
| 58 | bool CppGenerator::Generate(const FileDescriptor* file, |
| 59 | const string& parameter, |
liujisi@google.com | 33165fe | 2010-11-02 13:14:58 +0000 | [diff] [blame] | 60 | GeneratorContext* generator_context, |
temporal | 40ee551 | 2008-07-10 02:12:20 +0000 | [diff] [blame] | 61 | string* error) const { |
| 62 | vector<pair<string, string> > options; |
kenton@google.com | 80b1d62 | 2009-07-29 01:13:20 +0000 | [diff] [blame] | 63 | ParseGeneratorParameter(parameter, &options); |
temporal | 40ee551 | 2008-07-10 02:12:20 +0000 | [diff] [blame] | 64 | |
| 65 | // ----------------------------------------------------------------- |
| 66 | // parse generator options |
| 67 | |
| 68 | // TODO(kenton): If we ever have more options, we may want to create a |
| 69 | // class that encapsulates them which we can pass down to all the |
| 70 | // generator classes. Currently we pass dllexport_decl down to all of |
| 71 | // them via the constructors, but we don't want to have to add another |
| 72 | // constructor parameter for every option. |
| 73 | |
| 74 | // If the dllexport_decl option is passed to the compiler, we need to write |
| 75 | // it in front of every symbol that should be exported if this .proto is |
| 76 | // compiled into a Windows DLL. E.g., if the user invokes the protocol |
| 77 | // compiler as: |
| 78 | // protoc --cpp_out=dllexport_decl=FOO_EXPORT:outdir foo.proto |
| 79 | // then we'll define classes like this: |
| 80 | // class FOO_EXPORT Foo { |
| 81 | // ... |
| 82 | // } |
| 83 | // FOO_EXPORT is a macro which should expand to __declspec(dllexport) or |
| 84 | // __declspec(dllimport) depending on what is being compiled. |
Bo Yang | 5db2173 | 2015-05-21 14:28:59 -0700 | [diff] [blame] | 85 | // |
xiaofeng@google.com | b55a20f | 2012-09-22 02:40:50 +0000 | [diff] [blame] | 86 | Options file_options; |
temporal | 40ee551 | 2008-07-10 02:12:20 +0000 | [diff] [blame] | 87 | |
| 88 | for (int i = 0; i < options.size(); i++) { |
| 89 | if (options[i].first == "dllexport_decl") { |
xiaofeng@google.com | b55a20f | 2012-09-22 02:40:50 +0000 | [diff] [blame] | 90 | file_options.dllexport_decl = options[i].second; |
| 91 | } else if (options[i].first == "safe_boundary_check") { |
| 92 | file_options.safe_boundary_check = true; |
Jisi Liu | 3b3c8ab | 2016-03-30 11:39:59 -0700 | [diff] [blame] | 93 | } else if (options[i].first == "annotate_headers") { |
| 94 | file_options.annotate_headers = true; |
| 95 | } else if (options[i].first == "annotation_pragma_name") { |
| 96 | file_options.annotation_pragma_name = options[i].second; |
| 97 | } else if (options[i].first == "annotation_guard_name") { |
| 98 | file_options.annotation_guard_name = options[i].second; |
temporal | 40ee551 | 2008-07-10 02:12:20 +0000 | [diff] [blame] | 99 | } else { |
| 100 | *error = "Unknown generator option: " + options[i].first; |
| 101 | return false; |
| 102 | } |
| 103 | } |
| 104 | |
| 105 | // ----------------------------------------------------------------- |
| 106 | |
| 107 | |
| 108 | string basename = StripProto(file->name()); |
temporal | 40ee551 | 2008-07-10 02:12:20 +0000 | [diff] [blame] | 109 | |
xiaofeng@google.com | b55a20f | 2012-09-22 02:40:50 +0000 | [diff] [blame] | 110 | FileGenerator file_generator(file, file_options); |
temporal | 40ee551 | 2008-07-10 02:12:20 +0000 | [diff] [blame] | 111 | |
Feng Xiao | eee38b0 | 2015-08-22 18:25:48 -0700 | [diff] [blame] | 112 | // Generate header(s). |
| 113 | if (file_options.proto_h) { |
| 114 | google::protobuf::scoped_ptr<io::ZeroCopyOutputStream> output( |
| 115 | generator_context->Open(basename + ".proto.h")); |
Jisi Liu | 3b3c8ab | 2016-03-30 11:39:59 -0700 | [diff] [blame] | 116 | GeneratedCodeInfo annotations; |
| 117 | io::AnnotationProtoCollector<GeneratedCodeInfo> annotation_collector( |
| 118 | &annotations); |
| 119 | string info_path = basename + ".proto.h.meta"; |
| 120 | io::Printer printer(output.get(), '$', file_options.annotate_headers |
| 121 | ? &annotation_collector |
| 122 | : NULL); |
| 123 | file_generator.GenerateProtoHeader( |
| 124 | &printer, file_options.annotate_headers ? info_path : ""); |
| 125 | if (file_options.annotate_headers) { |
| 126 | scoped_ptr<io::ZeroCopyOutputStream> info_output( |
| 127 | generator_context->Open(info_path)); |
| 128 | annotations.SerializeToZeroCopyStream(info_output.get()); |
| 129 | } |
Feng Xiao | eee38b0 | 2015-08-22 18:25:48 -0700 | [diff] [blame] | 130 | } |
| 131 | |
| 132 | basename.append(".pb"); |
temporal | 40ee551 | 2008-07-10 02:12:20 +0000 | [diff] [blame] | 133 | { |
Feng Xiao | f157a56 | 2014-11-14 11:50:31 -0800 | [diff] [blame] | 134 | google::protobuf::scoped_ptr<io::ZeroCopyOutputStream> output( |
jieluo@google.com | 4de8f55 | 2014-07-18 00:47:59 +0000 | [diff] [blame] | 135 | generator_context->Open(basename + ".h")); |
Jisi Liu | 3b3c8ab | 2016-03-30 11:39:59 -0700 | [diff] [blame] | 136 | GeneratedCodeInfo annotations; |
| 137 | io::AnnotationProtoCollector<GeneratedCodeInfo> annotation_collector( |
| 138 | &annotations); |
| 139 | string info_path = basename + ".h.meta"; |
| 140 | io::Printer printer(output.get(), '$', file_options.annotate_headers |
| 141 | ? &annotation_collector |
| 142 | : NULL); |
| 143 | file_generator.GeneratePBHeader( |
| 144 | &printer, file_options.annotate_headers ? info_path : ""); |
| 145 | if (file_options.annotate_headers) { |
| 146 | scoped_ptr<io::ZeroCopyOutputStream> info_output( |
| 147 | generator_context->Open(info_path)); |
| 148 | annotations.SerializeToZeroCopyStream(info_output.get()); |
| 149 | } |
temporal | 40ee551 | 2008-07-10 02:12:20 +0000 | [diff] [blame] | 150 | } |
| 151 | |
| 152 | // Generate cc file. |
| 153 | { |
Feng Xiao | f157a56 | 2014-11-14 11:50:31 -0800 | [diff] [blame] | 154 | google::protobuf::scoped_ptr<io::ZeroCopyOutputStream> output( |
jieluo@google.com | 4de8f55 | 2014-07-18 00:47:59 +0000 | [diff] [blame] | 155 | generator_context->Open(basename + ".cc")); |
temporal | 40ee551 | 2008-07-10 02:12:20 +0000 | [diff] [blame] | 156 | io::Printer printer(output.get(), '$'); |
| 157 | file_generator.GenerateSource(&printer); |
| 158 | } |
| 159 | |
| 160 | return true; |
| 161 | } |
| 162 | |
| 163 | } // namespace cpp |
| 164 | } // namespace compiler |
| 165 | } // namespace protobuf |
| 166 | } // namespace google |