Main.cpp revision 37c4157d7cdad71dc9abc93d652e81c33e346d93
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]\\\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"
120        "       and the first match found (left to right) will take precedence."
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}
137
138/*
139 * Dispatch the command.
140 */
141int handleCommand(Bundle* bundle)
142{
143    //printf("--- command %d (verbose=%d force=%d):\n",
144    //    bundle->getCommand(), bundle->getVerbose(), bundle->getForce());
145    //for (int i = 0; i < bundle->getFileSpecCount(); i++)
146    //    printf("  %d: '%s'\n", i, bundle->getFileSpecEntry(i));
147
148    switch (bundle->getCommand()) {
149    case kCommandVersion:   return doVersion(bundle);
150    case kCommandList:      return doList(bundle);
151    case kCommandDump:      return doDump(bundle);
152    case kCommandAdd:       return doAdd(bundle);
153    case kCommandRemove:    return doRemove(bundle);
154    case kCommandPackage:   return doPackage(bundle);
155    default:
156        fprintf(stderr, "%s: requested command not yet supported\n", gProgName);
157        return 1;
158    }
159}
160
161/*
162 * Parse args.
163 */
164int main(int argc, char* const argv[])
165{
166    char *prog = argv[0];
167    Bundle bundle;
168    bool wantUsage = false;
169    int result = 1;    // pessimistically assume an error.
170    int tolerance = 0;
171
172    /* default to compression */
173    bundle.setCompressionMethod(ZipEntry::kCompressDeflated);
174
175    if (argc < 2) {
176        wantUsage = true;
177        goto bail;
178    }
179
180    if (argv[1][0] == 'v')
181        bundle.setCommand(kCommandVersion);
182    else if (argv[1][0] == 'd')
183        bundle.setCommand(kCommandDump);
184    else if (argv[1][0] == 'l')
185        bundle.setCommand(kCommandList);
186    else if (argv[1][0] == 'a')
187        bundle.setCommand(kCommandAdd);
188    else if (argv[1][0] == 'r')
189        bundle.setCommand(kCommandRemove);
190    else if (argv[1][0] == 'p')
191        bundle.setCommand(kCommandPackage);
192    else {
193        fprintf(stderr, "ERROR: Unknown command '%s'\n", argv[1]);
194        wantUsage = true;
195        goto bail;
196    }
197    argc -= 2;
198    argv += 2;
199
200    /*
201     * Pull out flags.  We support "-fv" and "-f -v".
202     */
203    while (argc && argv[0][0] == '-') {
204        /* flag(s) found */
205        const char* cp = argv[0] +1;
206
207        while (*cp != '\0') {
208            switch (*cp) {
209            case 'v':
210                bundle.setVerbose(true);
211                break;
212            case 'a':
213                bundle.setAndroidList(true);
214                break;
215            case 'c':
216                argc--;
217                argv++;
218                if (!argc) {
219                    fprintf(stderr, "ERROR: No argument supplied for '-c' option\n");
220                    wantUsage = true;
221                    goto bail;
222                }
223                bundle.addConfigurations(argv[0]);
224                break;
225            case 'f':
226                bundle.setForce(true);
227                break;
228            case 'g':
229                argc--;
230                argv++;
231                if (!argc) {
232                    fprintf(stderr, "ERROR: No argument supplied for '-g' option\n");
233                    wantUsage = true;
234                    goto bail;
235                }
236                tolerance = atoi(argv[0]);
237                bundle.setGrayscaleTolerance(tolerance);
238                printf("%s: Images with deviation <= %d will be forced to grayscale.\n", prog, tolerance);
239                break;
240            case 'k':
241                bundle.setJunkPath(true);
242                break;
243            case 'm':
244                bundle.setMakePackageDirs(true);
245                break;
246#if 0
247            case 'p':
248                bundle.setPseudolocalize(true);
249                break;
250#endif
251            case 'u':
252                bundle.setUpdate(true);
253                break;
254            case 'x':
255                bundle.setExtending(true);
256                break;
257            case 'z':
258                bundle.setRequireLocalization(true);
259                break;
260            case 'j':
261                argc--;
262                argv++;
263                if (!argc) {
264                    fprintf(stderr, "ERROR: No argument supplied for '-j' option\n");
265                    wantUsage = true;
266                    goto bail;
267                }
268                convertPath(argv[0]);
269                bundle.addJarFile(argv[0]);
270                break;
271            case 'A':
272                argc--;
273                argv++;
274                if (!argc) {
275                    fprintf(stderr, "ERROR: No argument supplied for '-A' option\n");
276                    wantUsage = true;
277                    goto bail;
278                }
279                convertPath(argv[0]);
280                bundle.setAssetSourceDir(argv[0]);
281                break;
282            case 'G':
283                argc--;
284                argv++;
285                if (!argc) {
286                    fprintf(stderr, "ERROR: No argument supplied for '-G' option\n");
287                    wantUsage = true;
288                    goto bail;
289                }
290                convertPath(argv[0]);
291                bundle.setProguardFile(argv[0]);
292                break;
293            case 'I':
294                argc--;
295                argv++;
296                if (!argc) {
297                    fprintf(stderr, "ERROR: No argument supplied for '-I' option\n");
298                    wantUsage = true;
299                    goto bail;
300                }
301                convertPath(argv[0]);
302                bundle.addPackageInclude(argv[0]);
303                break;
304            case 'F':
305                argc--;
306                argv++;
307                if (!argc) {
308                    fprintf(stderr, "ERROR: No argument supplied for '-F' option\n");
309                    wantUsage = true;
310                    goto bail;
311                }
312                convertPath(argv[0]);
313                bundle.setOutputAPKFile(argv[0]);
314                break;
315            case 'J':
316                argc--;
317                argv++;
318                if (!argc) {
319                    fprintf(stderr, "ERROR: No argument supplied for '-J' option\n");
320                    wantUsage = true;
321                    goto bail;
322                }
323                convertPath(argv[0]);
324                bundle.setRClassDir(argv[0]);
325                break;
326            case 'M':
327                argc--;
328                argv++;
329                if (!argc) {
330                    fprintf(stderr, "ERROR: No argument supplied for '-M' option\n");
331                    wantUsage = true;
332                    goto bail;
333                }
334                convertPath(argv[0]);
335                bundle.setAndroidManifestFile(argv[0]);
336                break;
337            case 'P':
338                argc--;
339                argv++;
340                if (!argc) {
341                    fprintf(stderr, "ERROR: No argument supplied for '-P' option\n");
342                    wantUsage = true;
343                    goto bail;
344                }
345                convertPath(argv[0]);
346                bundle.setPublicOutputFile(argv[0]);
347                break;
348            case 'S':
349                argc--;
350                argv++;
351                if (!argc) {
352                    fprintf(stderr, "ERROR: No argument supplied for '-S' option\n");
353                    wantUsage = true;
354                    goto bail;
355                }
356                convertPath(argv[0]);
357                bundle.addResourceSourceDir(argv[0]);
358                break;
359            case '0':
360                argc--;
361                argv++;
362                if (!argc) {
363                    fprintf(stderr, "ERROR: No argument supplied for '-e' option\n");
364                    wantUsage = true;
365                    goto bail;
366                }
367                if (argv[0][0] != 0) {
368                    bundle.addNoCompressExtension(argv[0]);
369                } else {
370                    bundle.setCompressionMethod(ZipEntry::kCompressStored);
371                }
372                break;
373            case '-':
374                if (strcmp(cp, "-min-sdk-version") == 0) {
375                    argc--;
376                    argv++;
377                    if (!argc) {
378                        fprintf(stderr, "ERROR: No argument supplied for '--min-sdk-version' option\n");
379                        wantUsage = true;
380                        goto bail;
381                    }
382                    bundle.setMinSdkVersion(argv[0]);
383                } else if (strcmp(cp, "-target-sdk-version") == 0) {
384                    argc--;
385                    argv++;
386                    if (!argc) {
387                        fprintf(stderr, "ERROR: No argument supplied for '--target-sdk-version' option\n");
388                        wantUsage = true;
389                        goto bail;
390                    }
391                    bundle.setTargetSdkVersion(argv[0]);
392                } else if (strcmp(cp, "-max-sdk-version") == 0) {
393                    argc--;
394                    argv++;
395                    if (!argc) {
396                        fprintf(stderr, "ERROR: No argument supplied for '--max-sdk-version' option\n");
397                        wantUsage = true;
398                        goto bail;
399                    }
400                    bundle.setMaxSdkVersion(argv[0]);
401                } else if (strcmp(cp, "-version-code") == 0) {
402                    argc--;
403                    argv++;
404                    if (!argc) {
405                        fprintf(stderr, "ERROR: No argument supplied for '--version-code' option\n");
406                        wantUsage = true;
407                        goto bail;
408                    }
409                    bundle.setVersionCode(argv[0]);
410                } else if (strcmp(cp, "-version-name") == 0) {
411                    argc--;
412                    argv++;
413                    if (!argc) {
414                        fprintf(stderr, "ERROR: No argument supplied for '--version-name' option\n");
415                        wantUsage = true;
416                        goto bail;
417                    }
418                    bundle.setVersionName(argv[0]);
419                } else if (strcmp(cp, "-values") == 0) {
420                    bundle.setValues(true);
421                } else {
422                    fprintf(stderr, "ERROR: Unknown option '-%s'\n", cp);
423                    wantUsage = true;
424                    goto bail;
425                }
426                cp += strlen(cp) - 1;
427                break;
428            default:
429                fprintf(stderr, "ERROR: Unknown flag '-%c'\n", *cp);
430                wantUsage = true;
431                goto bail;
432            }
433
434            cp++;
435        }
436        argc--;
437        argv++;
438    }
439
440    /*
441     * We're past the flags.  The rest all goes straight in.
442     */
443    bundle.setFileSpec(argv, argc);
444
445    result = handleCommand(&bundle);
446
447bail:
448    if (wantUsage) {
449        usage();
450        result = 2;
451    }
452
453    //printf("--> returning %d\n", result);
454    return result;
455}
456