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