1 /*
2 * Copyright (C) 2015, The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17 #include "options.h"
18 #include "logging.h"
19 #include "os.h"
20
21 #include <getopt.h>
22 #include <stdlib.h>
23 #include <unistd.h>
24 #include <algorithm>
25 #include <iostream>
26 #include <sstream>
27 #include <string>
28
29 #include <android-base/strings.h>
30
31 using android::base::Split;
32 using android::base::Trim;
33 using std::endl;
34 using std::string;
35
36 namespace android {
37 namespace aidl {
38
GetUsage() const39 string Options::GetUsage() const {
40 std::ostringstream sstr;
41 sstr << "usage:" << endl
42 << myname_ << " --lang={java|cpp|ndk} [OPTION]... INPUT..." << endl
43 << " Generate Java or C++ files for AIDL file(s)." << endl
44 << endl
45 << myname_ << " --preprocess OUTPUT INPUT..." << endl
46 << " Create an AIDL file having declarations of AIDL file(s)." << endl
47 << endl
48 #ifndef _WIN32
49 << myname_ << " --dumpapi --out=DIR INPUT..." << endl
50 << " Dump API signature of AIDL file(s) to DIR." << endl
51 << endl
52 << myname_ << " --checkapi OLD_DIR NEW_DIR" << endl
53 << " Checkes whether API dump NEW_DIR is backwards compatible extension " << endl
54 << " of the API dump OLD_DIR." << endl
55 #endif
56 << endl;
57
58 // Legacy option formats
59 if (language_ == Options::Language::JAVA) {
60 sstr << myname_ << " [OPTION]... INPUT [OUTPUT]" << endl
61 << " Generate a Java file for an AIDL file." << endl
62 << endl;
63 } else if (language_ == Options::Language::CPP) {
64 sstr << myname_ << " [OPTION]... INPUT HEADER_DIR OUTPUT" << endl
65 << " Generate C++ headers and source for an AIDL file." << endl
66 << endl;
67 }
68
69 sstr << "OPTION:" << endl
70 << " -I DIR, --include=DIR" << endl
71 << " Use DIR as a search path for import statements." << endl
72 << " -m FILE, --import=FILE" << endl
73 << " Import FILE directly without searching in the search paths." << endl
74 << " -p FILE, --preprocessed=FILE" << endl
75 << " Include FILE which is created by --preprocess." << endl
76 << " -d FILE, --dep=FILE" << endl
77 << " Generate dependency file as FILE. Don't use this when" << endl
78 << " there are multiple input files. Use -a then." << endl
79 << " -o DIR, --out=DIR" << endl
80 << " Use DIR as the base output directory for generated files." << endl
81 << " -h DIR, --header_out=DIR" << endl
82 << " Generate C++ headers under DIR." << endl
83 << " -a" << endl
84 << " Generate dependency file next to the output file with the" << endl
85 << " name based on the input file." << endl
86 << " -b" << endl
87 << " Trigger fail when trying to compile a parcelable." << endl
88 << " --ninja" << endl
89 << " Generate dependency file in a format ninja understands." << endl
90 << " --structured" << endl
91 << " Whether this interface is defined exclusively in AIDL." << endl
92 << " It is therefore a candidate for stabilization." << endl
93 << " --stability=<level>" << endl
94 << " The stability requirement of this interface." << endl
95 << " -t, --trace" << endl
96 << " Include tracing code for systrace. Note that if either" << endl
97 << " the client or service code is not auto-generated by this" << endl
98 << " tool, that part will not be traced." << endl
99 << " --transaction_names" << endl
100 << " Generate transaction names." << endl
101 << " --apimapping" << endl
102 << " Generates a mapping of declared aidl method signatures to" << endl
103 << " the original line number. e.g.: " << endl
104 << " If line 39 of foo/bar/IFoo.aidl contains:"
105 << " void doFoo(int bar, String baz);" << endl
106 << " Then the result would be:" << endl
107 << " foo.bar.Baz|doFoo|int,String,|void" << endl
108 << " foo/bar/IFoo.aidl:39" << endl
109 << " -v VER, --version=VER" << endl
110 << " Set the version of the interface and parcelable to VER." << endl
111 << " VER must be an interger greater than 0." << endl
112 << " --hash=HASH" << endl
113 << " Set the interface hash to HASH." << endl
114 << " --log" << endl
115 << " Information about the transaction, e.g., method name, argument" << endl
116 << " values, execution time, etc., is provided via callback." << endl
117 << " --parcelable-to-string" << endl
118 << " Generates an implementation of toString() for Java parcelables," << endl
119 << " and ostream& operator << for C++ parcelables." << endl
120 << " --help" << endl
121 << " Show this help." << endl
122 << endl
123 << "INPUT:" << endl
124 << " An AIDL file." << endl
125 << endl
126 << "OUTPUT:" << endl
127 << " Path to the generated Java or C++ source file. This is ignored when" << endl
128 << " -o or --out is specified or the number of the input files are" << endl
129 << " more than one." << endl
130 << " For Java, if omitted, Java source file is generated at the same" << endl
131 << " place as the input AIDL file," << endl
132 << endl
133 << "HEADER_DIR:" << endl
134 << " Path to where C++ headers are generated." << endl;
135 return sstr.str();
136 }
137
StabilityFromString(const std::string & stability,Stability * out_stability)138 bool Options::StabilityFromString(const std::string& stability, Stability* out_stability) {
139 if (stability == "vintf") {
140 *out_stability = Stability::VINTF;
141 return true;
142 }
143 return false;
144 }
145
From(const string & cmdline)146 Options Options::From(const string& cmdline) {
147 vector<string> args = Split(cmdline, " ");
148 return From(args);
149 }
150
From(const vector<string> & args)151 Options Options::From(const vector<string>& args) {
152 Options::Language lang = Options::Language::JAVA;
153 int argc = args.size();
154 if (argc >= 1 && args.at(0) == "aidl-cpp") {
155 lang = Options::Language::CPP;
156 }
157 const char* argv[argc + 1];
158 for (int i = 0; i < argc; i++) {
159 argv[i] = args.at(i).c_str();
160 }
161 argv[argc] = nullptr;
162
163 return Options(argc, argv, lang);
164 }
165
Options(int argc,const char * const argv[],Options::Language default_lang)166 Options::Options(int argc, const char* const argv[], Options::Language default_lang)
167 : myname_(argv[0]), language_(default_lang) {
168 bool lang_option_found = false;
169 optind = 0;
170 while (true) {
171 static struct option long_options[] = {
172 {"lang", required_argument, 0, 'l'},
173 {"preprocess", no_argument, 0, 's'},
174 #ifndef _WIN32
175 {"dumpapi", no_argument, 0, 'u'},
176 {"checkapi", no_argument, 0, 'A'},
177 #endif
178 {"apimapping", required_argument, 0, 'i'},
179 {"include", required_argument, 0, 'I'},
180 {"import", required_argument, 0, 'm'},
181 {"preprocessed", required_argument, 0, 'p'},
182 {"dep", required_argument, 0, 'd'},
183 {"out", required_argument, 0, 'o'},
184 {"header_out", required_argument, 0, 'h'},
185 {"ninja", no_argument, 0, 'n'},
186 {"stability", required_argument, 0, 'Y'},
187 {"structured", no_argument, 0, 'S'},
188 {"trace", no_argument, 0, 't'},
189 {"transaction_names", no_argument, 0, 'c'},
190 {"version", required_argument, 0, 'v'},
191 {"log", no_argument, 0, 'L'},
192 {"parcelable-to-string", no_argument, 0, 'P'},
193 {"hash", required_argument, 0, 'H'},
194 {"help", no_argument, 0, 'e'},
195 {0, 0, 0, 0},
196 };
197 const int c = getopt_long(argc, const_cast<char* const*>(argv),
198 "I:m:p:d:o:h:abtv:", long_options, nullptr);
199 if (c == -1) {
200 // no more options
201 break;
202 }
203 switch (c) {
204 case 'l':
205 if (language_ == Options::Language::CPP) {
206 // aidl-cpp can't set language. aidl-cpp exists only for backwards
207 // compatibility.
208 error_message_ << "aidl-cpp does not support --lang." << endl;
209 return;
210 } else {
211 lang_option_found = true;
212 string lang = Trim(optarg);
213 if (lang == "java") {
214 language_ = Options::Language::JAVA;
215 task_ = Options::Task::COMPILE;
216 } else if (lang == "cpp") {
217 language_ = Options::Language::CPP;
218 task_ = Options::Task::COMPILE;
219 } else if (lang == "ndk") {
220 language_ = Options::Language::NDK;
221 task_ = Options::Task::COMPILE;
222 } else {
223 error_message_ << "Unsupported language: '" << lang << "'" << endl;
224 return;
225 }
226 }
227 break;
228 case 's':
229 if (task_ != Options::Task::UNSPECIFIED) {
230 task_ = Options::Task::PREPROCESS;
231 }
232 break;
233 #ifndef _WIN32
234 case 'u':
235 if (task_ != Options::Task::UNSPECIFIED) {
236 task_ = Options::Task::DUMP_API;
237 }
238 break;
239 case 'A':
240 if (task_ != Options::Task::UNSPECIFIED) {
241 task_ = Options::Task::CHECK_API;
242 // to ensure that all parcelables in the api dumpes are structured
243 structured_ = true;
244 }
245 break;
246 #endif
247 case 'I': {
248 import_dirs_.emplace(Trim(optarg));
249 break;
250 }
251 case 'm': {
252 import_files_.emplace(Trim(optarg));
253 break;
254 }
255 case 'p':
256 preprocessed_files_.emplace_back(Trim(optarg));
257 break;
258 case 'd':
259 dependency_file_ = Trim(optarg);
260 break;
261 case 'o':
262 output_dir_ = Trim(optarg);
263 if (output_dir_.back() != OS_PATH_SEPARATOR) {
264 output_dir_.push_back(OS_PATH_SEPARATOR);
265 }
266 break;
267 case 'h':
268 output_header_dir_ = Trim(optarg);
269 if (output_header_dir_.back() != OS_PATH_SEPARATOR) {
270 output_header_dir_.push_back(OS_PATH_SEPARATOR);
271 }
272 break;
273 case 'n':
274 dependency_file_ninja_ = true;
275 break;
276 case 'S':
277 structured_ = true;
278 break;
279 case 'Y': {
280 const string stability_str = Trim(optarg);
281 if (!StabilityFromString(stability_str, &stability_)) {
282 error_message_ << "Unrecognized stability level: '" << stability_str
283 << "'. Must be vintf." << endl;
284 return;
285 }
286 break;
287 }
288 case 't':
289 gen_traces_ = true;
290 break;
291 case 'a':
292 auto_dep_file_ = true;
293 break;
294 case 'b':
295 fail_on_parcelable_ = true;
296 break;
297 case 'c':
298 gen_transaction_names_ = true;
299 break;
300 case 'v': {
301 const string ver_str = Trim(optarg);
302 int ver = atoi(ver_str.c_str());
303 if (ver > 0) {
304 version_ = ver;
305 } else {
306 error_message_ << "Invalid version number: '" << ver_str << "'. "
307 << "Version must be a positive natural number." << endl;
308 return;
309 }
310 break;
311 }
312 case 'H':
313 hash_ = Trim(optarg);
314 break;
315 case 'L':
316 gen_log_ = true;
317 break;
318 case 'e':
319 std::cerr << GetUsage();
320 exit(0);
321 case 'i':
322 output_file_ = Trim(optarg);
323 task_ = Task::DUMP_MAPPINGS;
324 break;
325 case 'P':
326 gen_parcelable_to_string_ = true;
327 break;
328 default:
329 std::cerr << GetUsage();
330 exit(1);
331 }
332 } // while
333
334 // Positional arguments
335 if (!lang_option_found && task_ == Options::Task::COMPILE) {
336 // the legacy arguments format
337 if (argc - optind <= 0) {
338 error_message_ << "No input file" << endl;
339 return;
340 }
341 if (language_ == Options::Language::JAVA) {
342 input_files_.emplace_back(argv[optind++]);
343 if (argc - optind >= 1) {
344 output_file_ = argv[optind++];
345 } else if (output_dir_.empty()) {
346 // when output is omitted and -o option isn't set, the output is by
347 // default set to the input file path with .aidl is replaced to .java.
348 // If -o option is set, the output path is calculated by
349 // generate_outputFileName which returns "<output_dir>/<package/name>/
350 // <typename>.java"
351 output_file_ = input_files_.front();
352 if (android::base::EndsWith(output_file_, ".aidl")) {
353 output_file_ = output_file_.substr(0, output_file_.length() - strlen(".aidl"));
354 }
355 output_file_ += ".java";
356 }
357 } else if (IsCppOutput()) {
358 input_files_.emplace_back(argv[optind++]);
359 if (argc - optind < 2) {
360 error_message_ << "No HEADER_DIR or OUTPUT." << endl;
361 return;
362 }
363 output_header_dir_ = argv[optind++];
364 if (output_header_dir_.back() != OS_PATH_SEPARATOR) {
365 output_header_dir_.push_back(OS_PATH_SEPARATOR);
366 }
367 output_file_ = argv[optind++];
368 }
369 if (argc - optind > 0) {
370 error_message_ << "Too many arguments: ";
371 for (int i = optind; i < argc; i++) {
372 error_message_ << " " << argv[i];
373 }
374 error_message_ << endl;
375 }
376 } else {
377 // the new arguments format
378 if (task_ == Options::Task::COMPILE || task_ == Options::Task::DUMP_API) {
379 if (argc - optind < 1) {
380 error_message_ << "No input file." << endl;
381 return;
382 }
383 } else {
384 if (argc - optind < 2) {
385 error_message_ << "Insufficient arguments. At least 2 required, but "
386 << "got " << (argc - optind) << "." << endl;
387 return;
388 }
389 if (task_ != Options::Task::CHECK_API && task_ != Options::Task::DUMP_MAPPINGS) {
390 output_file_ = argv[optind++];
391 }
392 }
393 while (optind < argc) {
394 input_files_.emplace_back(argv[optind++]);
395 }
396 }
397
398 // filter out invalid combinations
399 if (lang_option_found) {
400 if (IsCppOutput() && task_ == Options::Task::COMPILE) {
401 if (output_dir_.empty()) {
402 error_message_ << "Output directory is not set. Set with --out." << endl;
403 return;
404 }
405 if (output_header_dir_.empty()) {
406 error_message_ << "Header output directory is not set. Set with "
407 << "--header_out." << endl;
408 return;
409 }
410 }
411 if (language_ == Options::Language::JAVA && task_ == Options::Task::COMPILE) {
412 if (output_dir_.empty()) {
413 error_message_ << "Output directory is not set. Set with --out." << endl;
414 return;
415 }
416 if (!output_header_dir_.empty()) {
417 error_message_ << "Header output directory is set, which does not make "
418 << "sense for Java." << endl;
419 return;
420 }
421 }
422 }
423 if (task_ == Options::Task::COMPILE) {
424 for (const string& input : input_files_) {
425 if (!android::base::EndsWith(input, ".aidl")) {
426 error_message_ << "Expected .aidl file for input but got '" << input << "'" << endl;
427 return;
428 }
429 }
430 if (!output_file_.empty() && input_files_.size() > 1) {
431 error_message_ << "Multiple AIDL files can't be compiled to a single "
432 << "output file '" << output_file_ << "'. "
433 << "Use --out=DIR instead for output files." << endl;
434 return;
435 }
436 if (!dependency_file_.empty() && input_files_.size() > 1) {
437 error_message_ << "-d or --dep doesn't work when compiling multiple AIDL "
438 << "files. Use '-a' to generate dependency file next to "
439 << "the output file with the name based on the input "
440 << "file." << endl;
441 return;
442 }
443 if (gen_log_ && (language_ != Options::Language::CPP && language_ != Options::Language::NDK)) {
444 error_message_ << "--log is currently supported for either --lang=cpp or --lang=ndk" << endl;
445 return;
446 }
447 }
448 if (task_ == Options::Task::PREPROCESS) {
449 if (version_ > 0) {
450 error_message_ << "--version should not be used with '--preprocess'." << endl;
451 return;
452 }
453 }
454 if (task_ == Options::Task::CHECK_API) {
455 if (input_files_.size() != 2) {
456 error_message_ << "--checkapi requires two inputs for comparing, "
457 << "but got " << input_files_.size() << "." << endl;
458 return;
459 }
460 }
461 if (task_ == Options::Task::DUMP_API) {
462 if (output_dir_.empty()) {
463 error_message_ << "--dump_api requires output directory. Use --out." << endl;
464 return;
465 }
466 }
467
468 CHECK(output_dir_.empty() || output_dir_.back() == OS_PATH_SEPARATOR);
469 CHECK(output_header_dir_.empty() || output_header_dir_.back() == OS_PATH_SEPARATOR);
470 }
471
472 } // namespace aidl
473 } // namespace android
474