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