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#include <google/protobuf/compiler/cpp/cpp_generator.h>
36
37#include <vector>
38#include <memory>
39#ifndef _SHARED_PTR_H
40#include <google/protobuf/stubs/shared_ptr.h>
41#endif
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>
49
50namespace google {
51namespace protobuf {
52namespace compiler {
53namespace cpp {
54
55CppGenerator::CppGenerator() {}
56CppGenerator::~CppGenerator() {}
57
58bool CppGenerator::Generate(const FileDescriptor* file,
59                            const string& parameter,
60                            GeneratorContext* generator_context,
61                            string* error) const {
62  vector<pair<string, string> > options;
63  ParseGeneratorParameter(parameter, &options);
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.
85  //
86  Options file_options;
87
88  for (int i = 0; i < options.size(); i++) {
89    if (options[i].first == "dllexport_decl") {
90      file_options.dllexport_decl = options[i].second;
91    } else if (options[i].first == "safe_boundary_check") {
92      file_options.safe_boundary_check = true;
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;
99    } else if (options[i].first == "lite") {
100      file_options.enforce_lite = true;
101    } else {
102      *error = "Unknown generator option: " + options[i].first;
103      return false;
104    }
105  }
106
107  // -----------------------------------------------------------------
108
109
110  string basename = StripProto(file->name());
111
112  FileGenerator file_generator(file, file_options);
113
114  // Generate header(s).
115  if (file_options.proto_h) {
116    google::protobuf::scoped_ptr<io::ZeroCopyOutputStream> output(
117        generator_context->Open(basename + ".proto.h"));
118    GeneratedCodeInfo annotations;
119    io::AnnotationProtoCollector<GeneratedCodeInfo> annotation_collector(
120        &annotations);
121    string info_path = basename + ".proto.h.meta";
122    io::Printer printer(output.get(), '$', file_options.annotate_headers
123                                               ? &annotation_collector
124                                               : NULL);
125    file_generator.GenerateProtoHeader(
126        &printer, file_options.annotate_headers ? info_path : "");
127    if (file_options.annotate_headers) {
128      google::protobuf::scoped_ptr<io::ZeroCopyOutputStream> info_output(
129          generator_context->Open(info_path));
130      annotations.SerializeToZeroCopyStream(info_output.get());
131    }
132  }
133
134  basename.append(".pb");
135  {
136    google::protobuf::scoped_ptr<io::ZeroCopyOutputStream> output(
137        generator_context->Open(basename + ".h"));
138    GeneratedCodeInfo annotations;
139    io::AnnotationProtoCollector<GeneratedCodeInfo> annotation_collector(
140        &annotations);
141    string info_path = basename + ".h.meta";
142    io::Printer printer(output.get(), '$', file_options.annotate_headers
143                                               ? &annotation_collector
144                                               : NULL);
145    file_generator.GeneratePBHeader(
146        &printer, file_options.annotate_headers ? info_path : "");
147    if (file_options.annotate_headers) {
148      google::protobuf::scoped_ptr<io::ZeroCopyOutputStream> info_output(
149          generator_context->Open(info_path));
150      annotations.SerializeToZeroCopyStream(info_output.get());
151    }
152  }
153
154  // Generate cc file.
155  {
156    google::protobuf::scoped_ptr<io::ZeroCopyOutputStream> output(
157        generator_context->Open(basename + ".cc"));
158    io::Printer printer(output.get(), '$');
159    file_generator.GenerateSource(&printer);
160  }
161
162  return true;
163}
164
165}  // namespace cpp
166}  // namespace compiler
167}  // namespace protobuf
168}  // namespace google
169