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/java/java_generator.h>
36#include <google/protobuf/compiler/java/java_file.h>
37#include <google/protobuf/compiler/java/java_helpers.h>
38#include <google/protobuf/io/printer.h>
39#include <google/protobuf/io/zero_copy_stream.h>
40#include <google/protobuf/descriptor.pb.h>
41#include <google/protobuf/stubs/strutil.h>
42
43namespace google {
44namespace protobuf {
45namespace compiler {
46namespace java {
47
48
49JavaGenerator::JavaGenerator() {}
50JavaGenerator::~JavaGenerator() {}
51
52bool JavaGenerator::Generate(const FileDescriptor* file,
53                             const string& parameter,
54                             GeneratorContext* context,
55                             string* error) const {
56  // -----------------------------------------------------------------
57  // parse generator options
58
59  // Name a file where we will write a list of generated file names, one
60  // per line.
61  string output_list_file;
62
63
64  vector<pair<string, string> > options;
65  ParseGeneratorParameter(parameter, &options);
66
67  for (int i = 0; i < options.size(); i++) {
68    if (options[i].first == "output_list_file") {
69      output_list_file = options[i].second;
70    } else {
71      *error = "Unknown generator option: " + options[i].first;
72      return false;
73    }
74  }
75
76  // -----------------------------------------------------------------
77
78
79  if (file->options().optimize_for() == FileOptions::LITE_RUNTIME &&
80      file->options().java_generate_equals_and_hash()) {
81    *error = "The \"java_generate_equals_and_hash\" option is incompatible "
82             "with \"optimize_for = LITE_RUNTIME\".  You must optimize for "
83             "SPEED or CODE_SIZE if you want to use this option.";
84    return false;
85  }
86
87  FileGenerator file_generator(file);
88  if (!file_generator.Validate(error)) {
89    return false;
90  }
91
92  string package_dir = JavaPackageToDir(file_generator.java_package());
93
94  vector<string> all_files;
95
96  string java_filename = package_dir;
97  java_filename += file_generator.classname();
98  java_filename += ".java";
99  all_files.push_back(java_filename);
100
101  // Generate main java file.
102  scoped_ptr<io::ZeroCopyOutputStream> output(
103    context->Open(java_filename));
104  io::Printer printer(output.get(), '$');
105  file_generator.Generate(&printer);
106
107  // Generate sibling files.
108  file_generator.GenerateSiblings(package_dir, context, &all_files);
109
110  // Generate output list if requested.
111  if (!output_list_file.empty()) {
112    // Generate output list.  This is just a simple text file placed in a
113    // deterministic location which lists the .java files being generated.
114    scoped_ptr<io::ZeroCopyOutputStream> srclist_raw_output(
115      context->Open(output_list_file));
116    io::Printer srclist_printer(srclist_raw_output.get(), '$');
117    for (int i = 0; i < all_files.size(); i++) {
118      srclist_printer.Print("$filename$\n", "filename", all_files[i]);
119    }
120  }
121
122  return true;
123}
124
125}  // namespace java
126}  // namespace compiler
127}  // namespace protobuf
128}  // namespace google
129