OSDN Git Service

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