1// Protocol Buffers - Google's data interchange format
2// Copyright 2008 Google Inc.  All rights reserved.
3// http://code.google.com/p/protobuf/
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 <utility>
39
40#include <google/protobuf/compiler/cpp/cpp_file.h>
41#include <google/protobuf/compiler/cpp/cpp_helpers.h>
42#include <google/protobuf/io/printer.h>
43#include <google/protobuf/io/zero_copy_stream.h>
44#include <google/protobuf/descriptor.pb.h>
45
46namespace google {
47namespace protobuf {
48namespace compiler {
49namespace cpp {
50
51CppGenerator::CppGenerator() {}
52CppGenerator::~CppGenerator() {}
53
54bool CppGenerator::Generate(const FileDescriptor* file,
55                            const string& parameter,
56                            GeneratorContext* generator_context,
57                            string* error) const {
58  vector<pair<string, string> > options;
59  ParseGeneratorParameter(parameter, &options);
60
61  // -----------------------------------------------------------------
62  // parse generator options
63
64  // TODO(kenton):  If we ever have more options, we may want to create a
65  //   class that encapsulates them which we can pass down to all the
66  //   generator classes.  Currently we pass dllexport_decl down to all of
67  //   them via the constructors, but we don't want to have to add another
68  //   constructor parameter for every option.
69
70  // If the dllexport_decl option is passed to the compiler, we need to write
71  // it in front of every symbol that should be exported if this .proto is
72  // compiled into a Windows DLL.  E.g., if the user invokes the protocol
73  // compiler as:
74  //   protoc --cpp_out=dllexport_decl=FOO_EXPORT:outdir foo.proto
75  // then we'll define classes like this:
76  //   class FOO_EXPORT Foo {
77  //     ...
78  //   }
79  // FOO_EXPORT is a macro which should expand to __declspec(dllexport) or
80  // __declspec(dllimport) depending on what is being compiled.
81  Options file_options;
82
83  for (int i = 0; i < options.size(); i++) {
84    if (options[i].first == "dllexport_decl") {
85      file_options.dllexport_decl = options[i].second;
86    } else if (options[i].first == "safe_boundary_check") {
87      file_options.safe_boundary_check = true;
88    } else {
89      *error = "Unknown generator option: " + options[i].first;
90      return false;
91    }
92  }
93
94  // -----------------------------------------------------------------
95
96
97  string basename = StripProto(file->name());
98  basename.append(".pb");
99
100  FileGenerator file_generator(file, file_options);
101
102  // Generate header.
103  {
104    scoped_ptr<io::ZeroCopyOutputStream> output(
105      generator_context->Open(basename + ".h"));
106    io::Printer printer(output.get(), '$');
107    file_generator.GenerateHeader(&printer);
108  }
109
110  // Generate cc file.
111  {
112    scoped_ptr<io::ZeroCopyOutputStream> output(
113      generator_context->Open(basename + ".cc"));
114    io::Printer printer(output.get(), '$');
115    file_generator.GenerateSource(&printer);
116  }
117
118  return true;
119}
120
121}  // namespace cpp
122}  // namespace compiler
123}  // namespace protobuf
124}  // namespace google
125