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