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/javanano/javanano_params.h>
36 #include <google/protobuf/compiler/javanano/javanano_generator.h>
37 #include <google/protobuf/compiler/javanano/javanano_file.h>
38 #include <google/protobuf/compiler/javanano/javanano_helpers.h>
39 #include <google/protobuf/io/printer.h>
40 #include <google/protobuf/io/zero_copy_stream.h>
41 #include <google/protobuf/descriptor.pb.h>
42 #include <google/protobuf/stubs/strutil.h>
43 
44 namespace google {
45 namespace protobuf {
46 namespace compiler {
47 namespace javanano {
48 
49 namespace {
50 
TrimString(const string & s)51 string TrimString(const string& s) {
52   string::size_type start = s.find_first_not_of(" \n\r\t");
53   if (start == string::npos) {
54     return "";
55   }
56   string::size_type end = s.find_last_not_of(" \n\r\t") + 1;
57   return s.substr(start, end - start);
58 }
59 
60 } // namespace
61 
UpdateParamsRecursively(Params & params,const FileDescriptor * file)62 void UpdateParamsRecursively(Params& params,
63     const FileDescriptor* file) {
64   // Add any parameters for this file
65   if (file->options().has_java_outer_classname()) {
66     params.set_java_outer_classname(
67       file->name(), file->options().java_outer_classname());
68   }
69   if (file->options().has_java_package()) {
70     string result = file->options().java_package();
71     if (!result.empty()) {
72       result += ".";
73     }
74     result += "nano";
75     params.set_java_package(
76       file->name(), result);
77   }
78   if (file->options().has_java_multiple_files()) {
79     params.set_java_multiple_files(
80       file->name(), file->options().java_multiple_files());
81   }
82 
83   // Loop through all dependent files recursively
84   // adding dep
85   for (int i = 0; i < file->dependency_count(); i++) {
86     UpdateParamsRecursively(params, file->dependency(i));
87   }
88 }
89 
JavaNanoGenerator()90 JavaNanoGenerator::JavaNanoGenerator() {}
~JavaNanoGenerator()91 JavaNanoGenerator::~JavaNanoGenerator() {}
92 
Generate(const FileDescriptor * file,const string & parameter,GeneratorContext * output_directory,string * error) const93 bool JavaNanoGenerator::Generate(const FileDescriptor* file,
94                              const string& parameter,
95                              GeneratorContext* output_directory,
96                              string* error) const {
97   vector<pair<string, string> > options;
98 
99   ParseGeneratorParameter(parameter, &options);
100 
101   // -----------------------------------------------------------------
102   // parse generator options
103 
104   // Name a file where we will write a list of generated file names, one
105   // per line.
106   string output_list_file;
107   Params params(file->name());
108 
109   // Update per file params
110   UpdateParamsRecursively(params, file);
111 
112   // Replace any existing options with ones from command line
113   for (int i = 0; i < options.size(); i++) {
114     string option_name = TrimString(options[i].first);
115     string option_value = TrimString(options[i].second);
116     if (option_name == "output_list_file") {
117       output_list_file = option_value;
118     } else if (option_name == "java_package") {
119         vector<string> parts;
120         SplitStringUsing(option_value, "|", &parts);
121         if (parts.size() != 2) {
122           *error = "Bad java_package, expecting filename|PackageName found '"
123             + option_value + "'";
124           return false;
125         }
126         params.set_java_package(parts[0], parts[1]);
127     } else if (option_name == "java_outer_classname") {
128         vector<string> parts;
129         SplitStringUsing(option_value, "|", &parts);
130         if (parts.size() != 2) {
131           *error = "Bad java_outer_classname, "
132                    "expecting filename|ClassName found '"
133                    + option_value + "'";
134           return false;
135         }
136         params.set_java_outer_classname(parts[0], parts[1]);
137     } else if (option_name == "store_unknown_fields") {
138       params.set_store_unknown_fields(option_value == "true");
139     } else if (option_name == "java_multiple_files") {
140       params.set_override_java_multiple_files(option_value == "true");
141     } else if (option_name == "java_nano_generate_has") {
142       params.set_generate_has(option_value == "true");
143     } else if (option_name == "enum_style") {
144       params.set_java_enum_style(option_value == "java");
145     } else if (option_name == "optional_field_style") {
146       params.set_optional_field_accessors(option_value == "accessors");
147       params.set_use_reference_types_for_primitives(option_value == "reftypes"
148           || option_value == "reftypes_compat_mode");
149       params.set_reftypes_primitive_enums(
150           option_value == "reftypes_compat_mode");
151       if (option_value == "reftypes_compat_mode") {
152         params.set_generate_clear(false);
153       }
154     } else if (option_name == "generate_equals") {
155       params.set_generate_equals(option_value == "true");
156     } else if (option_name == "ignore_services") {
157       params.set_ignore_services(option_value == "true");
158     } else if (option_name == "parcelable_messages") {
159       params.set_parcelable_messages(option_value == "true");
160     } else if (option_name == "generate_clone") {
161       params.set_generate_clone(option_value == "true");
162     } else if (option_name == "generate_intdefs") {
163       params.set_generate_intdefs(option_value == "true");
164     } else if (option_name == "generate_clear") {
165       params.set_generate_clear(option_value == "true");
166     } else {
167       *error = "Ignore unknown javanano generator option: " + option_name;
168     }
169   }
170 
171   // Check illegal parameter combinations
172   // Note: the enum-like optional_field_style generator param ensures
173   // that we can never have illegal combinations of field styles
174   // (e.g. reftypes and accessors can't be on at the same time).
175   if (params.generate_has()
176       && (params.optional_field_accessors()
177           || params.use_reference_types_for_primitives())) {
178     error->assign("java_nano_generate_has=true cannot be used in conjunction"
179         " with optional_field_style=accessors or optional_field_style=reftypes");
180     return false;
181   }
182 
183   // -----------------------------------------------------------------
184 
185   FileGenerator file_generator(file, params);
186   if (!file_generator.Validate(error)) {
187     return false;
188   }
189 
190   string package_dir =
191     StringReplace(file_generator.java_package(), ".", "/", true);
192   if (!package_dir.empty()) package_dir += "/";
193 
194   vector<string> all_files;
195 
196   if (IsOuterClassNeeded(params, file)) {
197     string java_filename = package_dir;
198     java_filename += file_generator.classname();
199     java_filename += ".java";
200     all_files.push_back(java_filename);
201 
202     // Generate main java file.
203     scoped_ptr<io::ZeroCopyOutputStream> output(
204       output_directory->Open(java_filename));
205     io::Printer printer(output.get(), '$');
206     file_generator.Generate(&printer);
207   }
208 
209   // Generate sibling files.
210   file_generator.GenerateSiblings(package_dir, output_directory, &all_files);
211 
212   // Generate output list if requested.
213   if (!output_list_file.empty()) {
214     // Generate output list.  This is just a simple text file placed in a
215     // deterministic location which lists the .java files being generated.
216     scoped_ptr<io::ZeroCopyOutputStream> srclist_raw_output(
217       output_directory->Open(output_list_file));
218     io::Printer srclist_printer(srclist_raw_output.get(), '$');
219     for (int i = 0; i < all_files.size(); i++) {
220       srclist_printer.Print("$filename$\n", "filename", all_files[i]);
221     }
222   }
223 
224   return true;
225 }
226 
227 }  // namespace java
228 }  // namespace compiler
229 }  // namespace protobuf
230 }  // namespace google
231