]> git.saurik.com Git - android/aapt.git/blob - Main.cpp
am 253f7635: am fb34490f: Merge "Fix writing text version of styleable IDs."
[android/aapt.git] / Main.cpp
1 //
2 // Copyright 2006 The Android Open Source Project
3 //
4 // Android Asset Packaging Tool main entry point.
5 //
6 #include "Main.h"
7 #include "Bundle.h"
8
9 #include <utils/Log.h>
10 #include <utils/threads.h>
11 #include <utils/List.h>
12 #include <utils/Errors.h>
13
14 #include <stdlib.h>
15 #include <getopt.h>
16 #include <assert.h>
17
18 using namespace android;
19
20 static const char* gProgName = "aapt";
21
22 /*
23 * When running under Cygwin on Windows, this will convert slash-based
24 * paths into back-slash-based ones. Otherwise the ApptAssets file comparisons
25 * fail later as they use back-slash separators under Windows.
26 *
27 * This operates in-place on the path string.
28 */
29 void convertPath(char *path) {
30 if (path != NULL && OS_PATH_SEPARATOR != '/') {
31 for (; *path; path++) {
32 if (*path == '/') {
33 *path = OS_PATH_SEPARATOR;
34 }
35 }
36 }
37 }
38
39 /*
40 * Print usage info.
41 */
42 void usage(void)
43 {
44 fprintf(stderr, "Android Asset Packaging Tool\n\n");
45 fprintf(stderr, "Usage:\n");
46 fprintf(stderr,
47 " %s l[ist] [-v] [-a] file.{zip,jar,apk}\n"
48 " List contents of Zip-compatible archive.\n\n", gProgName);
49 fprintf(stderr,
50 " %s d[ump] [--values] WHAT file.{apk} [asset [asset ...]]\n"
51 " badging Print the label and icon for the app declared in APK.\n"
52 " permissions Print the permissions from the APK.\n"
53 " resources Print the resource table from the APK.\n"
54 " configurations Print the configurations in the APK.\n"
55 " xmltree Print the compiled xmls in the given assets.\n"
56 " xmlstrings Print the strings of the given compiled xml assets.\n\n", gProgName);
57 fprintf(stderr,
58 " %s p[ackage] [-d][-f][-m][-u][-v][-x][-z][-M AndroidManifest.xml] \\\n"
59 " [-0 extension [-0 extension ...]] [-g tolerance] [-j jarfile] \\\n"
60 " [--debug-mode] [--min-sdk-version VAL] [--target-sdk-version VAL] \\\n"
61 " [--app-version VAL] [--app-version-name TEXT] [--custom-package VAL] \\\n"
62 " [--rename-manifest-package PACKAGE] \\\n"
63 " [--rename-instrumentation-target-package PACKAGE] \\\n"
64 " [--utf16] [--auto-add-overlay] \\\n"
65 " [--max-res-version VAL] \\\n"
66 " [-I base-package [-I base-package ...]] \\\n"
67 " [-A asset-source-dir] [-G class-list-file] [-P public-definitions-file] \\\n"
68 " [-S resource-sources [-S resource-sources ...]] \\\n"
69 " [-F apk-file] [-J R-file-dir] \\\n"
70 " [--product product1,product2,...] \\\n"
71 " [-c CONFIGS] [--preferred-configurations CONFIGS] \\\n"
72 " [raw-files-dir [raw-files-dir] ...] \\\n"
73 " [--output-text-symbols DIR]\n"
74 "\n"
75 " Package the android resources. It will read assets and resources that are\n"
76 " supplied with the -M -A -S or raw-files-dir arguments. The -J -P -F and -R\n"
77 " options control which files are output.\n\n"
78 , gProgName);
79 fprintf(stderr,
80 " %s r[emove] [-v] file.{zip,jar,apk} file1 [file2 ...]\n"
81 " Delete specified files from Zip-compatible archive.\n\n",
82 gProgName);
83 fprintf(stderr,
84 " %s a[dd] [-v] file.{zip,jar,apk} file1 [file2 ...]\n"
85 " Add specified files to Zip-compatible archive.\n\n", gProgName);
86 fprintf(stderr,
87 " %s c[runch] [-v] -S resource-sources ... -C output-folder ...\n"
88 " Do PNG preprocessing and store the results in output folder.\n\n", gProgName);
89 fprintf(stderr,
90 " %s v[ersion]\n"
91 " Print program version.\n\n", gProgName);
92 fprintf(stderr,
93 " Modifiers:\n"
94 " -a print Android-specific data (resources, manifest) when listing\n"
95 " -c specify which configurations to include. The default is all\n"
96 " configurations. The value of the parameter should be a comma\n"
97 " separated list of configuration values. Locales should be specified\n"
98 " as either a language or language-region pair. Some examples:\n"
99 " en\n"
100 " port,en\n"
101 " port,land,en_US\n"
102 " If you put the special locale, zz_ZZ on the list, it will perform\n"
103 " pseudolocalization on the default locale, modifying all of the\n"
104 " strings so you can look for strings that missed the\n"
105 " internationalization process. For example:\n"
106 " port,land,zz_ZZ\n"
107 " -d one or more device assets to include, separated by commas\n"
108 " -f force overwrite of existing files\n"
109 " -g specify a pixel tolerance to force images to grayscale, default 0\n"
110 " -j specify a jar or zip file containing classes to include\n"
111 " -k junk path of file(s) added\n"
112 " -m make package directories under location specified by -J\n"
113 #if 0
114 " -p pseudolocalize the default configuration\n"
115 #endif
116 " -u update existing packages (add new, replace older, remove deleted files)\n"
117 " -v verbose output\n"
118 " -x create extending (non-application) resource IDs\n"
119 " -z require localization of resource attributes marked with\n"
120 " localization=\"suggested\"\n"
121 " -A additional directory in which to find raw asset files\n"
122 " -G A file to output proguard options into.\n"
123 " -F specify the apk file to output\n"
124 " -I add an existing package to base include set\n"
125 " -J specify where to output R.java resource constant definitions\n"
126 " -M specify full path to AndroidManifest.xml to include in zip\n"
127 " -P specify where to output public resource definitions\n"
128 " -S directory in which to find resources. Multiple directories will be scanned\n"
129 " and the first match found (left to right) will take precedence.\n"
130 " -0 specifies an additional extension for which such files will not\n"
131 " be stored compressed in the .apk. An empty string means to not\n"
132 " compress any files at all.\n"
133 " --debug-mode\n"
134 " inserts android:debuggable=\"true\" in to the application node of the\n"
135 " manifest, making the application debuggable even on production devices.\n"
136 " --min-sdk-version\n"
137 " inserts android:minSdkVersion in to manifest. If the version is 7 or\n"
138 " higher, the default encoding for resources will be in UTF-8.\n"
139 " --target-sdk-version\n"
140 " inserts android:targetSdkVersion in to manifest.\n"
141 " --max-res-version\n"
142 " ignores versioned resource directories above the given value.\n"
143 " --values\n"
144 " when used with \"dump resources\" also includes resource values.\n"
145 " --version-code\n"
146 " inserts android:versionCode in to manifest.\n"
147 " --version-name\n"
148 " inserts android:versionName in to manifest.\n"
149 " --custom-package\n"
150 " generates R.java into a different package.\n"
151 " --extra-packages\n"
152 " generate R.java for libraries. Separate libraries with ':'.\n"
153 " --generate-dependencies\n"
154 " generate dependency files in the same directories for R.java and resource package\n"
155 " --auto-add-overlay\n"
156 " Automatically add resources that are only in overlays.\n"
157 " --preferred-configurations\n"
158 " Like the -c option for filtering out unneeded configurations, but\n"
159 " only expresses a preference. If there is no resource available with\n"
160 " the preferred configuration then it will not be stripped.\n"
161 " --rename-manifest-package\n"
162 " Rewrite the manifest so that its package name is the package name\n"
163 " given here. Relative class names (for example .Foo) will be\n"
164 " changed to absolute names with the old package so that the code\n"
165 " does not need to change.\n"
166 " --rename-instrumentation-target-package\n"
167 " Rewrite the manifest so that all of its instrumentation\n"
168 " components target the given package. Useful when used in\n"
169 " conjunction with --rename-manifest-package to fix tests against\n"
170 " a package that has been renamed.\n"
171 " --product\n"
172 " Specifies which variant to choose for strings that have\n"
173 " product variants\n"
174 " --utf16\n"
175 " changes default encoding for resources to UTF-16. Only useful when API\n"
176 " level is set to 7 or higher where the default encoding is UTF-8.\n"
177 " --non-constant-id\n"
178 " Make the resources ID non constant. This is required to make an R java class\n"
179 " that does not contain the final value but is used to make reusable compiled\n"
180 " libraries that need to access resources.\n"
181 " --error-on-failed-insert\n"
182 " Forces aapt to return an error if it fails to insert values into the manifest\n"
183 " with --debug-mode, --min-sdk-version, --target-sdk-version --version-code\n"
184 " and --version-name.\n"
185 " Insertion typically fails if the manifest already defines the attribute.\n"
186 " --output-text-symbols\n"
187 " Generates a text file containing the resource symbols of the R class in the\n"
188 " specified folder.\n"
189 " --ignore-assets\n"
190 " Assets to be ignored. Default pattern is:\n"
191 " %s\n",
192 gDefaultIgnoreAssets);
193 }
194
195 /*
196 * Dispatch the command.
197 */
198 int handleCommand(Bundle* bundle)
199 {
200 //printf("--- command %d (verbose=%d force=%d):\n",
201 // bundle->getCommand(), bundle->getVerbose(), bundle->getForce());
202 //for (int i = 0; i < bundle->getFileSpecCount(); i++)
203 // printf(" %d: '%s'\n", i, bundle->getFileSpecEntry(i));
204
205 switch (bundle->getCommand()) {
206 case kCommandVersion: return doVersion(bundle);
207 case kCommandList: return doList(bundle);
208 case kCommandDump: return doDump(bundle);
209 case kCommandAdd: return doAdd(bundle);
210 case kCommandRemove: return doRemove(bundle);
211 case kCommandPackage: return doPackage(bundle);
212 case kCommandCrunch: return doCrunch(bundle);
213 default:
214 fprintf(stderr, "%s: requested command not yet supported\n", gProgName);
215 return 1;
216 }
217 }
218
219 /*
220 * Parse args.
221 */
222 int main(int argc, char* const argv[])
223 {
224 char *prog = argv[0];
225 Bundle bundle;
226 bool wantUsage = false;
227 int result = 1; // pessimistically assume an error.
228 int tolerance = 0;
229
230 /* default to compression */
231 bundle.setCompressionMethod(ZipEntry::kCompressDeflated);
232
233 if (argc < 2) {
234 wantUsage = true;
235 goto bail;
236 }
237
238 if (argv[1][0] == 'v')
239 bundle.setCommand(kCommandVersion);
240 else if (argv[1][0] == 'd')
241 bundle.setCommand(kCommandDump);
242 else if (argv[1][0] == 'l')
243 bundle.setCommand(kCommandList);
244 else if (argv[1][0] == 'a')
245 bundle.setCommand(kCommandAdd);
246 else if (argv[1][0] == 'r')
247 bundle.setCommand(kCommandRemove);
248 else if (argv[1][0] == 'p')
249 bundle.setCommand(kCommandPackage);
250 else if (argv[1][0] == 'c')
251 bundle.setCommand(kCommandCrunch);
252 else {
253 fprintf(stderr, "ERROR: Unknown command '%s'\n", argv[1]);
254 wantUsage = true;
255 goto bail;
256 }
257 argc -= 2;
258 argv += 2;
259
260 /*
261 * Pull out flags. We support "-fv" and "-f -v".
262 */
263 while (argc && argv[0][0] == '-') {
264 /* flag(s) found */
265 const char* cp = argv[0] +1;
266
267 while (*cp != '\0') {
268 switch (*cp) {
269 case 'v':
270 bundle.setVerbose(true);
271 break;
272 case 'a':
273 bundle.setAndroidList(true);
274 break;
275 case 'c':
276 argc--;
277 argv++;
278 if (!argc) {
279 fprintf(stderr, "ERROR: No argument supplied for '-c' option\n");
280 wantUsage = true;
281 goto bail;
282 }
283 bundle.addConfigurations(argv[0]);
284 break;
285 case 'f':
286 bundle.setForce(true);
287 break;
288 case 'g':
289 argc--;
290 argv++;
291 if (!argc) {
292 fprintf(stderr, "ERROR: No argument supplied for '-g' option\n");
293 wantUsage = true;
294 goto bail;
295 }
296 tolerance = atoi(argv[0]);
297 bundle.setGrayscaleTolerance(tolerance);
298 printf("%s: Images with deviation <= %d will be forced to grayscale.\n", prog, tolerance);
299 break;
300 case 'k':
301 bundle.setJunkPath(true);
302 break;
303 case 'm':
304 bundle.setMakePackageDirs(true);
305 break;
306 #if 0
307 case 'p':
308 bundle.setPseudolocalize(true);
309 break;
310 #endif
311 case 'u':
312 bundle.setUpdate(true);
313 break;
314 case 'x':
315 bundle.setExtending(true);
316 break;
317 case 'z':
318 bundle.setRequireLocalization(true);
319 break;
320 case 'j':
321 argc--;
322 argv++;
323 if (!argc) {
324 fprintf(stderr, "ERROR: No argument supplied for '-j' option\n");
325 wantUsage = true;
326 goto bail;
327 }
328 convertPath(argv[0]);
329 bundle.addJarFile(argv[0]);
330 break;
331 case 'A':
332 argc--;
333 argv++;
334 if (!argc) {
335 fprintf(stderr, "ERROR: No argument supplied for '-A' option\n");
336 wantUsage = true;
337 goto bail;
338 }
339 convertPath(argv[0]);
340 bundle.setAssetSourceDir(argv[0]);
341 break;
342 case 'G':
343 argc--;
344 argv++;
345 if (!argc) {
346 fprintf(stderr, "ERROR: No argument supplied for '-G' option\n");
347 wantUsage = true;
348 goto bail;
349 }
350 convertPath(argv[0]);
351 bundle.setProguardFile(argv[0]);
352 break;
353 case 'I':
354 argc--;
355 argv++;
356 if (!argc) {
357 fprintf(stderr, "ERROR: No argument supplied for '-I' option\n");
358 wantUsage = true;
359 goto bail;
360 }
361 convertPath(argv[0]);
362 bundle.addPackageInclude(argv[0]);
363 break;
364 case 'F':
365 argc--;
366 argv++;
367 if (!argc) {
368 fprintf(stderr, "ERROR: No argument supplied for '-F' option\n");
369 wantUsage = true;
370 goto bail;
371 }
372 convertPath(argv[0]);
373 bundle.setOutputAPKFile(argv[0]);
374 break;
375 case 'J':
376 argc--;
377 argv++;
378 if (!argc) {
379 fprintf(stderr, "ERROR: No argument supplied for '-J' option\n");
380 wantUsage = true;
381 goto bail;
382 }
383 convertPath(argv[0]);
384 bundle.setRClassDir(argv[0]);
385 break;
386 case 'M':
387 argc--;
388 argv++;
389 if (!argc) {
390 fprintf(stderr, "ERROR: No argument supplied for '-M' option\n");
391 wantUsage = true;
392 goto bail;
393 }
394 convertPath(argv[0]);
395 bundle.setAndroidManifestFile(argv[0]);
396 break;
397 case 'P':
398 argc--;
399 argv++;
400 if (!argc) {
401 fprintf(stderr, "ERROR: No argument supplied for '-P' option\n");
402 wantUsage = true;
403 goto bail;
404 }
405 convertPath(argv[0]);
406 bundle.setPublicOutputFile(argv[0]);
407 break;
408 case 'S':
409 argc--;
410 argv++;
411 if (!argc) {
412 fprintf(stderr, "ERROR: No argument supplied for '-S' option\n");
413 wantUsage = true;
414 goto bail;
415 }
416 convertPath(argv[0]);
417 bundle.addResourceSourceDir(argv[0]);
418 break;
419 case 'C':
420 argc--;
421 argv++;
422 if (!argc) {
423 fprintf(stderr, "ERROR: No argument supplied for '-C' option\n");
424 wantUsage = true;
425 goto bail;
426 }
427 convertPath(argv[0]);
428 bundle.setCrunchedOutputDir(argv[0]);
429 break;
430 case '0':
431 argc--;
432 argv++;
433 if (!argc) {
434 fprintf(stderr, "ERROR: No argument supplied for '-e' option\n");
435 wantUsage = true;
436 goto bail;
437 }
438 if (argv[0][0] != 0) {
439 bundle.addNoCompressExtension(argv[0]);
440 } else {
441 bundle.setCompressionMethod(ZipEntry::kCompressStored);
442 }
443 break;
444 case '-':
445 if (strcmp(cp, "-debug-mode") == 0) {
446 bundle.setDebugMode(true);
447 } else if (strcmp(cp, "-min-sdk-version") == 0) {
448 argc--;
449 argv++;
450 if (!argc) {
451 fprintf(stderr, "ERROR: No argument supplied for '--min-sdk-version' option\n");
452 wantUsage = true;
453 goto bail;
454 }
455 bundle.setMinSdkVersion(argv[0]);
456 } else if (strcmp(cp, "-target-sdk-version") == 0) {
457 argc--;
458 argv++;
459 if (!argc) {
460 fprintf(stderr, "ERROR: No argument supplied for '--target-sdk-version' option\n");
461 wantUsage = true;
462 goto bail;
463 }
464 bundle.setTargetSdkVersion(argv[0]);
465 } else if (strcmp(cp, "-max-sdk-version") == 0) {
466 argc--;
467 argv++;
468 if (!argc) {
469 fprintf(stderr, "ERROR: No argument supplied for '--max-sdk-version' option\n");
470 wantUsage = true;
471 goto bail;
472 }
473 bundle.setMaxSdkVersion(argv[0]);
474 } else if (strcmp(cp, "-max-res-version") == 0) {
475 argc--;
476 argv++;
477 if (!argc) {
478 fprintf(stderr, "ERROR: No argument supplied for '--max-res-version' option\n");
479 wantUsage = true;
480 goto bail;
481 }
482 bundle.setMaxResVersion(argv[0]);
483 } else if (strcmp(cp, "-version-code") == 0) {
484 argc--;
485 argv++;
486 if (!argc) {
487 fprintf(stderr, "ERROR: No argument supplied for '--version-code' option\n");
488 wantUsage = true;
489 goto bail;
490 }
491 bundle.setVersionCode(argv[0]);
492 } else if (strcmp(cp, "-version-name") == 0) {
493 argc--;
494 argv++;
495 if (!argc) {
496 fprintf(stderr, "ERROR: No argument supplied for '--version-name' option\n");
497 wantUsage = true;
498 goto bail;
499 }
500 bundle.setVersionName(argv[0]);
501 } else if (strcmp(cp, "-values") == 0) {
502 bundle.setValues(true);
503 } else if (strcmp(cp, "-custom-package") == 0) {
504 argc--;
505 argv++;
506 if (!argc) {
507 fprintf(stderr, "ERROR: No argument supplied for '--custom-package' option\n");
508 wantUsage = true;
509 goto bail;
510 }
511 bundle.setCustomPackage(argv[0]);
512 } else if (strcmp(cp, "-extra-packages") == 0) {
513 argc--;
514 argv++;
515 if (!argc) {
516 fprintf(stderr, "ERROR: No argument supplied for '--extra-packages' option\n");
517 wantUsage = true;
518 goto bail;
519 }
520 bundle.setExtraPackages(argv[0]);
521 } else if (strcmp(cp, "-generate-dependencies") == 0) {
522 bundle.setGenDependencies(true);
523 } else if (strcmp(cp, "-utf16") == 0) {
524 bundle.setWantUTF16(true);
525 } else if (strcmp(cp, "-preferred-configurations") == 0) {
526 argc--;
527 argv++;
528 if (!argc) {
529 fprintf(stderr, "ERROR: No argument supplied for '--preferred-configurations' option\n");
530 wantUsage = true;
531 goto bail;
532 }
533 bundle.addPreferredConfigurations(argv[0]);
534 } else if (strcmp(cp, "-rename-manifest-package") == 0) {
535 argc--;
536 argv++;
537 if (!argc) {
538 fprintf(stderr, "ERROR: No argument supplied for '--rename-manifest-package' option\n");
539 wantUsage = true;
540 goto bail;
541 }
542 bundle.setManifestPackageNameOverride(argv[0]);
543 } else if (strcmp(cp, "-rename-instrumentation-target-package") == 0) {
544 argc--;
545 argv++;
546 if (!argc) {
547 fprintf(stderr, "ERROR: No argument supplied for '--rename-instrumentation-target-package' option\n");
548 wantUsage = true;
549 goto bail;
550 }
551 bundle.setInstrumentationPackageNameOverride(argv[0]);
552 } else if (strcmp(cp, "-auto-add-overlay") == 0) {
553 bundle.setAutoAddOverlay(true);
554 } else if (strcmp(cp, "-error-on-failed-insert") == 0) {
555 bundle.setErrorOnFailedInsert(true);
556 } else if (strcmp(cp, "-output-text-symbols") == 0) {
557 argc--;
558 argv++;
559 if (!argc) {
560 fprintf(stderr, "ERROR: No argument supplied for '-output-text-symbols' option\n");
561 wantUsage = true;
562 goto bail;
563 }
564 bundle.setOutputTextSymbols(argv[0]);
565 } else if (strcmp(cp, "-product") == 0) {
566 argc--;
567 argv++;
568 if (!argc) {
569 fprintf(stderr, "ERROR: No argument supplied for '--product' option\n");
570 wantUsage = true;
571 goto bail;
572 }
573 bundle.setProduct(argv[0]);
574 } else if (strcmp(cp, "-non-constant-id") == 0) {
575 bundle.setNonConstantId(true);
576 } else if (strcmp(cp, "-no-crunch") == 0) {
577 bundle.setUseCrunchCache(true);
578 } else if (strcmp(cp, "-ignore-assets") == 0) {
579 argc--;
580 argv++;
581 if (!argc) {
582 fprintf(stderr, "ERROR: No argument supplied for '--ignore-assets' option\n");
583 wantUsage = true;
584 goto bail;
585 }
586 gUserIgnoreAssets = argv[0];
587 } else {
588 fprintf(stderr, "ERROR: Unknown option '-%s'\n", cp);
589 wantUsage = true;
590 goto bail;
591 }
592 cp += strlen(cp) - 1;
593 break;
594 default:
595 fprintf(stderr, "ERROR: Unknown flag '-%c'\n", *cp);
596 wantUsage = true;
597 goto bail;
598 }
599
600 cp++;
601 }
602 argc--;
603 argv++;
604 }
605
606 /*
607 * We're past the flags. The rest all goes straight in.
608 */
609 bundle.setFileSpec(argv, argc);
610
611 result = handleCommand(&bundle);
612
613 bail:
614 if (wantUsage) {
615 usage();
616 result = 2;
617 }
618
619 //printf("--> returning %d\n", result);
620 return result;
621 }