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