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