15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Protocol Buffers - Google's data interchange format
25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Copyright 2008 Google Inc.  All rights reserved.
35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// http://code.google.com/p/protobuf/
45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)//
55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Redistribution and use in source and binary forms, with or without
65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// modification, are permitted provided that the following conditions are
75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// met:
85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)//
95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)//     * Redistributions of source code must retain the above copyright
105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// notice, this list of conditions and the following disclaimer.
115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)//     * Redistributions in binary form must reproduce the above
125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// copyright notice, this list of conditions and the following disclaimer
135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// in the documentation and/or other materials provided with the
145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// distribution.
155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)//     * Neither the name of Google Inc. nor the names of its
165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// contributors may be used to endorse or promote products derived from
175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// this software without specific prior written permission.
185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)//
195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Author: kenton@google.com (Kenton Varda)
325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)//  Based on original Protocol Buffers design by
335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)//  Sanjay Ghemawat, Jeff Dean, and others.
345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <google/protobuf/compiler/cpp/cpp_generator.h>
365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <vector>
385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <utility>
395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <google/protobuf/compiler/cpp/cpp_file.h>
415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <google/protobuf/compiler/cpp/cpp_helpers.h>
425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <google/protobuf/io/printer.h>
435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <google/protobuf/io/zero_copy_stream.h>
445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <google/protobuf/descriptor.pb.h>
455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace google {
475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace protobuf {
485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace compiler {
495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace cpp {
505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)CppGenerator::CppGenerator() {}
525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)CppGenerator::~CppGenerator() {}
535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)bool CppGenerator::Generate(const FileDescriptor* file,
555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)                            const string& parameter,
565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)                            GeneratorContext* generator_context,
575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)                            string* error) const {
585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  vector<pair<string, string> > options;
595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  ParseGeneratorParameter(parameter, &options);
605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // -----------------------------------------------------------------
625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // parse generator options
635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // TODO(kenton):  If we ever have more options, we may want to create a
655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  //   class that encapsulates them which we can pass down to all the
665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  //   generator classes.  Currently we pass dllexport_decl down to all of
675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  //   them via the constructors, but we don't want to have to add another
685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  //   constructor parameter for every option.
695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // If the dllexport_decl option is passed to the compiler, we need to write
715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // it in front of every symbol that should be exported if this .proto is
725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // compiled into a Windows DLL.  E.g., if the user invokes the protocol
735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // compiler as:
745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  //   protoc --cpp_out=dllexport_decl=FOO_EXPORT:outdir foo.proto
755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // then we'll define classes like this:
765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  //   class FOO_EXPORT Foo {
775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  //     ...
785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  //   }
795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // FOO_EXPORT is a macro which should expand to __declspec(dllexport) or
805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // __declspec(dllimport) depending on what is being compiled.
81ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch  Options file_options;
825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  for (int i = 0; i < options.size(); i++) {
845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    if (options[i].first == "dllexport_decl") {
85ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch      file_options.dllexport_decl = options[i].second;
86ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch    } else if (options[i].first == "safe_boundary_check") {
87ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch      file_options.safe_boundary_check = true;
885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    } else {
895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)      *error = "Unknown generator option: " + options[i].first;
905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)      return false;
915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    }
925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  }
935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // -----------------------------------------------------------------
955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  string basename = StripProto(file->name());
985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  basename.append(".pb");
995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
100ba5b9a6411cb1792fd21f0a078d7a25cd1ceec16Ben Murdoch  FileGenerator file_generator(file, file_options);
1015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
1025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // Generate header.
1035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  {
1045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    scoped_ptr<io::ZeroCopyOutputStream> output(
1055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)      generator_context->Open(basename + ".h"));
1065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    io::Printer printer(output.get(), '$');
1075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    file_generator.GenerateHeader(&printer);
1085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  }
1095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
1105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // Generate cc file.
1115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  {
1125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    scoped_ptr<io::ZeroCopyOutputStream> output(
1135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)      generator_context->Open(basename + ".cc"));
1145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    io::Printer printer(output.get(), '$');
1155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    file_generator.GenerateSource(&printer);
1165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  }
1175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
1185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  return true;
1195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
1205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
1215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}  // namespace cpp
1225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}  // namespace compiler
1235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}  // namespace protobuf
1245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}  // namespace google
125