Ulas Kirazci | 2337023 | 2013-03-14 16:44:33 -0700 | [diff] [blame] | 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 | |
Max Cai | bc8eec3 | 2014-01-14 14:54:48 +0000 | [diff] [blame] | 49 | namespace { |
| 50 | |
| 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 | |
Ulas Kirazci | 2337023 | 2013-03-14 16:44:33 -0700 | [diff] [blame] | 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()) { |
Xiao Hang | 801e920 | 2015-07-27 17:46:22 -0700 | [diff] [blame] | 70 | string result = file->options().java_package(); |
| 71 | if (!file->options().javanano_use_deprecated_package()) { |
| 72 | if (!result.empty()) { |
| 73 | result += "."; |
| 74 | } |
| 75 | result += "nano"; |
| 76 | } |
Ulas Kirazci | 2337023 | 2013-03-14 16:44:33 -0700 | [diff] [blame] | 77 | params.set_java_package( |
Xiao Hang | 801e920 | 2015-07-27 17:46:22 -0700 | [diff] [blame] | 78 | file->name(), result); |
Ulas Kirazci | 2337023 | 2013-03-14 16:44:33 -0700 | [diff] [blame] | 79 | } |
Max Cai | 4c4d639 | 2013-07-24 14:16:38 +0100 | [diff] [blame] | 80 | if (file->options().has_java_multiple_files()) { |
| 81 | params.set_java_multiple_files( |
| 82 | file->name(), file->options().java_multiple_files()); |
| 83 | } |
Ulas Kirazci | 2337023 | 2013-03-14 16:44:33 -0700 | [diff] [blame] | 84 | |
| 85 | // Loop through all dependent files recursively |
| 86 | // adding dep |
| 87 | for (int i = 0; i < file->dependency_count(); i++) { |
| 88 | UpdateParamsRecursively(params, file->dependency(i)); |
| 89 | } |
| 90 | } |
| 91 | |
| 92 | JavaNanoGenerator::JavaNanoGenerator() {} |
| 93 | JavaNanoGenerator::~JavaNanoGenerator() {} |
| 94 | |
| 95 | bool JavaNanoGenerator::Generate(const FileDescriptor* file, |
| 96 | const string& parameter, |
Feng Xiao | cd980d1 | 2014-11-19 15:58:54 -0800 | [diff] [blame] | 97 | GeneratorContext* output_directory, |
Ulas Kirazci | 2337023 | 2013-03-14 16:44:33 -0700 | [diff] [blame] | 98 | string* error) const { |
| 99 | vector<pair<string, string> > options; |
| 100 | |
| 101 | ParseGeneratorParameter(parameter, &options); |
| 102 | |
| 103 | // ----------------------------------------------------------------- |
| 104 | // parse generator options |
| 105 | |
| 106 | // Name a file where we will write a list of generated file names, one |
| 107 | // per line. |
| 108 | string output_list_file; |
| 109 | Params params(file->name()); |
| 110 | |
Ulas Kirazci | 2337023 | 2013-03-14 16:44:33 -0700 | [diff] [blame] | 111 | // Update per file params |
| 112 | UpdateParamsRecursively(params, file); |
| 113 | |
| 114 | // Replace any existing options with ones from command line |
| 115 | for (int i = 0; i < options.size(); i++) { |
Max Cai | bc8eec3 | 2014-01-14 14:54:48 +0000 | [diff] [blame] | 116 | string option_name = TrimString(options[i].first); |
| 117 | string option_value = TrimString(options[i].second); |
| 118 | if (option_name == "output_list_file") { |
| 119 | output_list_file = option_value; |
| 120 | } else if (option_name == "java_package") { |
Ulas Kirazci | 2337023 | 2013-03-14 16:44:33 -0700 | [diff] [blame] | 121 | vector<string> parts; |
Max Cai | bc8eec3 | 2014-01-14 14:54:48 +0000 | [diff] [blame] | 122 | SplitStringUsing(option_value, "|", &parts); |
Ulas Kirazci | 2337023 | 2013-03-14 16:44:33 -0700 | [diff] [blame] | 123 | if (parts.size() != 2) { |
| 124 | *error = "Bad java_package, expecting filename|PackageName found '" |
Max Cai | bc8eec3 | 2014-01-14 14:54:48 +0000 | [diff] [blame] | 125 | + option_value + "'"; |
Ulas Kirazci | 2337023 | 2013-03-14 16:44:33 -0700 | [diff] [blame] | 126 | return false; |
| 127 | } |
| 128 | params.set_java_package(parts[0], parts[1]); |
Max Cai | bc8eec3 | 2014-01-14 14:54:48 +0000 | [diff] [blame] | 129 | } else if (option_name == "java_outer_classname") { |
Ulas Kirazci | 2337023 | 2013-03-14 16:44:33 -0700 | [diff] [blame] | 130 | vector<string> parts; |
Max Cai | bc8eec3 | 2014-01-14 14:54:48 +0000 | [diff] [blame] | 131 | SplitStringUsing(option_value, "|", &parts); |
Ulas Kirazci | 2337023 | 2013-03-14 16:44:33 -0700 | [diff] [blame] | 132 | if (parts.size() != 2) { |
| 133 | *error = "Bad java_outer_classname, " |
| 134 | "expecting filename|ClassName found '" |
Max Cai | bc8eec3 | 2014-01-14 14:54:48 +0000 | [diff] [blame] | 135 | + option_value + "'"; |
Ulas Kirazci | 2337023 | 2013-03-14 16:44:33 -0700 | [diff] [blame] | 136 | return false; |
| 137 | } |
| 138 | params.set_java_outer_classname(parts[0], parts[1]); |
Max Cai | bc8eec3 | 2014-01-14 14:54:48 +0000 | [diff] [blame] | 139 | } else if (option_name == "store_unknown_fields") { |
| 140 | params.set_store_unknown_fields(option_value == "true"); |
| 141 | } else if (option_name == "java_multiple_files") { |
| 142 | params.set_override_java_multiple_files(option_value == "true"); |
| 143 | } else if (option_name == "java_nano_generate_has") { |
| 144 | params.set_generate_has(option_value == "true"); |
| 145 | } else if (option_name == "enum_style") { |
| 146 | params.set_java_enum_style(option_value == "java"); |
| 147 | } else if (option_name == "optional_field_style") { |
| 148 | params.set_optional_field_accessors(option_value == "accessors"); |
Brian Duff | a892068 | 2014-09-30 10:57:50 -0700 | [diff] [blame] | 149 | params.set_use_reference_types_for_primitives(option_value == "reftypes" |
Brian Duff | 7fbf654 | 2014-10-01 12:55:00 -0700 | [diff] [blame] | 150 | || option_value == "reftypes_compat_mode"); |
Brian Duff | a892068 | 2014-09-30 10:57:50 -0700 | [diff] [blame] | 151 | params.set_reftypes_primitive_enums( |
Brian Duff | 7fbf654 | 2014-10-01 12:55:00 -0700 | [diff] [blame] | 152 | option_value == "reftypes_compat_mode"); |
| 153 | if (option_value == "reftypes_compat_mode") { |
| 154 | params.set_generate_clear(false); |
| 155 | } |
Max Cai | bc8eec3 | 2014-01-14 14:54:48 +0000 | [diff] [blame] | 156 | } else if (option_name == "generate_equals") { |
| 157 | params.set_generate_equals(option_value == "true"); |
Jie Dai | d9425a6 | 2014-04-21 14:29:03 -0700 | [diff] [blame] | 158 | } else if (option_name == "ignore_services") { |
| 159 | params.set_ignore_services(option_value == "true"); |
Jeff Davidson | ec4b1ce | 2014-04-22 23:25:53 -0700 | [diff] [blame] | 160 | } else if (option_name == "parcelable_messages") { |
| 161 | params.set_parcelable_messages(option_value == "true"); |
Brian Duff | d099a88 | 2014-10-01 13:33:40 -0700 | [diff] [blame] | 162 | } else if (option_name == "generate_clone") { |
| 163 | params.set_generate_clone(option_value == "true"); |
Jeff Davidson | ec19be2 | 2015-02-11 13:12:14 -0800 | [diff] [blame] | 164 | } else if (option_name == "generate_intdefs") { |
| 165 | params.set_generate_intdefs(option_value == "true"); |
Brian Duff | dac7e02 | 2015-02-21 15:22:43 -0800 | [diff] [blame] | 166 | } else if (option_name == "generate_clear") { |
| 167 | params.set_generate_clear(option_value == "true"); |
Ulas Kirazci | 2337023 | 2013-03-14 16:44:33 -0700 | [diff] [blame] | 168 | } else { |
Max Cai | bc8eec3 | 2014-01-14 14:54:48 +0000 | [diff] [blame] | 169 | *error = "Ignore unknown javanano generator option: " + option_name; |
Ulas Kirazci | 2337023 | 2013-03-14 16:44:33 -0700 | [diff] [blame] | 170 | } |
| 171 | } |
| 172 | |
Max Cai | 7176612 | 2013-09-18 17:10:31 +0100 | [diff] [blame] | 173 | // Check illegal parameter combinations |
Brian Duff | 10107cb | 2013-09-30 20:49:13 -0700 | [diff] [blame] | 174 | // Note: the enum-like optional_field_style generator param ensures |
| 175 | // that we can never have illegal combinations of field styles |
| 176 | // (e.g. reftypes and accessors can't be on at the same time). |
| 177 | if (params.generate_has() |
| 178 | && (params.optional_field_accessors() |
| 179 | || params.use_reference_types_for_primitives())) { |
Max Cai | 7176612 | 2013-09-18 17:10:31 +0100 | [diff] [blame] | 180 | error->assign("java_nano_generate_has=true cannot be used in conjunction" |
Brian Duff | 10107cb | 2013-09-30 20:49:13 -0700 | [diff] [blame] | 181 | " with optional_field_style=accessors or optional_field_style=reftypes"); |
Max Cai | 7176612 | 2013-09-18 17:10:31 +0100 | [diff] [blame] | 182 | return false; |
| 183 | } |
| 184 | |
Ulas Kirazci | 2337023 | 2013-03-14 16:44:33 -0700 | [diff] [blame] | 185 | // ----------------------------------------------------------------- |
| 186 | |
| 187 | FileGenerator file_generator(file, params); |
| 188 | if (!file_generator.Validate(error)) { |
| 189 | return false; |
| 190 | } |
| 191 | |
| 192 | string package_dir = |
| 193 | StringReplace(file_generator.java_package(), ".", "/", true); |
| 194 | if (!package_dir.empty()) package_dir += "/"; |
| 195 | |
| 196 | vector<string> all_files; |
| 197 | |
Max Cai | 06eed37 | 2013-07-29 17:20:50 +0100 | [diff] [blame] | 198 | if (IsOuterClassNeeded(params, file)) { |
| 199 | string java_filename = package_dir; |
| 200 | java_filename += file_generator.classname(); |
| 201 | java_filename += ".java"; |
| 202 | all_files.push_back(java_filename); |
Ulas Kirazci | 2337023 | 2013-03-14 16:44:33 -0700 | [diff] [blame] | 203 | |
Max Cai | 06eed37 | 2013-07-29 17:20:50 +0100 | [diff] [blame] | 204 | // Generate main java file. |
| 205 | scoped_ptr<io::ZeroCopyOutputStream> output( |
| 206 | output_directory->Open(java_filename)); |
| 207 | io::Printer printer(output.get(), '$'); |
| 208 | file_generator.Generate(&printer); |
| 209 | } |
Ulas Kirazci | 2337023 | 2013-03-14 16:44:33 -0700 | [diff] [blame] | 210 | |
| 211 | // Generate sibling files. |
| 212 | file_generator.GenerateSiblings(package_dir, output_directory, &all_files); |
| 213 | |
| 214 | // Generate output list if requested. |
| 215 | if (!output_list_file.empty()) { |
| 216 | // Generate output list. This is just a simple text file placed in a |
| 217 | // deterministic location which lists the .java files being generated. |
| 218 | scoped_ptr<io::ZeroCopyOutputStream> srclist_raw_output( |
| 219 | output_directory->Open(output_list_file)); |
| 220 | io::Printer srclist_printer(srclist_raw_output.get(), '$'); |
| 221 | for (int i = 0; i < all_files.size(); i++) { |
| 222 | srclist_printer.Print("$filename$\n", "filename", all_files[i]); |
| 223 | } |
| 224 | } |
| 225 | |
| 226 | return true; |
| 227 | } |
| 228 | |
| 229 | } // namespace java |
| 230 | } // namespace compiler |
| 231 | } // namespace protobuf |
| 232 | } // namespace google |