Main.cpp revision a191d0464f1eb5973caa044eee288a5a3e6c4dac
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 " strings Print the contents of the resource table string pool in the APK.\n" 52 " badging Print the label and icon for the app declared in APK.\n" 53 " permissions Print the permissions from the APK.\n" 54 " resources Print the resource table from the APK.\n" 55 " configurations Print the configurations in the APK.\n" 56 " xmltree Print the compiled xmls in the given assets.\n" 57 " xmlstrings Print the strings of the given compiled xml assets.\n\n", gProgName); 58 fprintf(stderr, 59 " %s p[ackage] [-d][-f][-m][-u][-v][-x][-z][-M AndroidManifest.xml] \\\n" 60 " [-0 extension [-0 extension ...]] [-g tolerance] [-j jarfile] \\\n" 61 " [--debug-mode] [--min-sdk-version VAL] [--target-sdk-version VAL] \\\n" 62 " [--app-version VAL] [--app-version-name TEXT] [--custom-package VAL] \\\n" 63 " [--rename-manifest-package PACKAGE] \\\n" 64 " [--rename-instrumentation-target-package PACKAGE] \\\n" 65 " [--utf16] [--auto-add-overlay] \\\n" 66 " [--max-res-version VAL] \\\n" 67 " [-I base-package [-I base-package ...]] \\\n" 68 " [-A asset-source-dir] [-G class-list-file] [-P public-definitions-file] \\\n" 69 " [-S resource-sources [-S resource-sources ...]] \\\n" 70 " [-F apk-file] [-J R-file-dir] \\\n" 71 " [--product product1,product2,...] \\\n" 72 " [-c CONFIGS] [--preferred-configurations CONFIGS] \\\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 on one or several resource folders\n" 90 " and store the results in the output folder.\n\n", gProgName); 91 fprintf(stderr, 92 " %s s[ingleCrunch] [-v] -i input-file -o outputfile\n" 93 " Do PNG preprocessing on a single file.\n\n", gProgName); 94 fprintf(stderr, 95 " %s v[ersion]\n" 96 " Print program version.\n\n", gProgName); 97 fprintf(stderr, 98 " Modifiers:\n" 99 " -a print Android-specific data (resources, manifest) when listing\n" 100 " -c specify which configurations to include. The default is all\n" 101 " configurations. The value of the parameter should be a comma\n" 102 " separated list of configuration values. Locales should be specified\n" 103 " as either a language or language-region pair. Some examples:\n" 104 " en\n" 105 " port,en\n" 106 " port,land,en_US\n" 107 " -d one or more device assets to include, separated by commas\n" 108 " -f force overwrite of existing files\n" 109 " -g specify a pixel tolerance to force images to grayscale, default 0\n" 110 " -j specify a jar or zip file containing classes to include\n" 111 " -k junk path of file(s) added\n" 112 " -m make package directories under location specified by -J\n" 113#if 0 114 " -p pseudolocalize the default configuration\n" 115#endif 116 " -u update existing packages (add new, replace older, remove deleted files)\n" 117 " -v verbose output\n" 118 " -x create extending (non-application) resource IDs\n" 119 " -z require localization of resource attributes marked with\n" 120 " localization=\"suggested\"\n" 121 " -A additional directory in which to find raw asset files\n" 122 " -G A file to output proguard options into.\n" 123 " -F specify the apk file to output\n" 124 " -I add an existing package to base include set\n" 125 " -J specify where to output R.java resource constant definitions\n" 126 " -M specify full path to AndroidManifest.xml to include in zip\n" 127 " -P specify where to output public resource definitions\n" 128 " -S directory in which to find resources. Multiple directories will be scanned\n" 129 " and the first match found (left to right) will take precedence.\n" 130 " -0 specifies an additional extension for which such files will not\n" 131 " be stored compressed in the .apk. An empty string means to not\n" 132 " compress any files at all.\n" 133 " --debug-mode\n" 134 " inserts android:debuggable=\"true\" in to the application node of the\n" 135 " manifest, making the application debuggable even on production devices.\n" 136 " --pseudo-localize\n" 137 " generate resources for pseudo-locales (en-XA and ar-XB).\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 */ 200int 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 case kCommandSingleCrunch: return doSingleCrunch(bundle); 216 default: 217 fprintf(stderr, "%s: requested command not yet supported\n", gProgName); 218 return 1; 219 } 220} 221 222/* 223 * Parse args. 224 */ 225int main(int argc, char* const argv[]) 226{ 227 char *prog = argv[0]; 228 Bundle bundle; 229 bool wantUsage = false; 230 int result = 1; // pessimistically assume an error. 231 int tolerance = 0; 232 233 /* default to compression */ 234 bundle.setCompressionMethod(ZipEntry::kCompressDeflated); 235 236 if (argc < 2) { 237 wantUsage = true; 238 goto bail; 239 } 240 241 if (argv[1][0] == 'v') 242 bundle.setCommand(kCommandVersion); 243 else if (argv[1][0] == 'd') 244 bundle.setCommand(kCommandDump); 245 else if (argv[1][0] == 'l') 246 bundle.setCommand(kCommandList); 247 else if (argv[1][0] == 'a') 248 bundle.setCommand(kCommandAdd); 249 else if (argv[1][0] == 'r') 250 bundle.setCommand(kCommandRemove); 251 else if (argv[1][0] == 'p') 252 bundle.setCommand(kCommandPackage); 253 else if (argv[1][0] == 'c') 254 bundle.setCommand(kCommandCrunch); 255 else if (argv[1][0] == 's') 256 bundle.setCommand(kCommandSingleCrunch); 257 else { 258 fprintf(stderr, "ERROR: Unknown command '%s'\n", argv[1]); 259 wantUsage = true; 260 goto bail; 261 } 262 argc -= 2; 263 argv += 2; 264 265 /* 266 * Pull out flags. We support "-fv" and "-f -v". 267 */ 268 while (argc && argv[0][0] == '-') { 269 /* flag(s) found */ 270 const char* cp = argv[0] +1; 271 272 while (*cp != '\0') { 273 switch (*cp) { 274 case 'v': 275 bundle.setVerbose(true); 276 break; 277 case 'a': 278 bundle.setAndroidList(true); 279 break; 280 case 'c': 281 argc--; 282 argv++; 283 if (!argc) { 284 fprintf(stderr, "ERROR: No argument supplied for '-c' option\n"); 285 wantUsage = true; 286 goto bail; 287 } 288 bundle.addConfigurations(argv[0]); 289 break; 290 case 'f': 291 bundle.setForce(true); 292 break; 293 case 'g': 294 argc--; 295 argv++; 296 if (!argc) { 297 fprintf(stderr, "ERROR: No argument supplied for '-g' option\n"); 298 wantUsage = true; 299 goto bail; 300 } 301 tolerance = atoi(argv[0]); 302 bundle.setGrayscaleTolerance(tolerance); 303 printf("%s: Images with deviation <= %d will be forced to grayscale.\n", prog, tolerance); 304 break; 305 case 'k': 306 bundle.setJunkPath(true); 307 break; 308 case 'm': 309 bundle.setMakePackageDirs(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 'i': 436 argc--; 437 argv++; 438 if (!argc) { 439 fprintf(stderr, "ERROR: No argument supplied for '-i' option\n"); 440 wantUsage = true; 441 goto bail; 442 } 443 convertPath(argv[0]); 444 bundle.setSingleCrunchInputFile(argv[0]); 445 break; 446 case 'o': 447 argc--; 448 argv++; 449 if (!argc) { 450 fprintf(stderr, "ERROR: No argument supplied for '-o' option\n"); 451 wantUsage = true; 452 goto bail; 453 } 454 convertPath(argv[0]); 455 bundle.setSingleCrunchOutputFile(argv[0]); 456 break; 457 case '0': 458 argc--; 459 argv++; 460 if (!argc) { 461 fprintf(stderr, "ERROR: No argument supplied for '-e' option\n"); 462 wantUsage = true; 463 goto bail; 464 } 465 if (argv[0][0] != 0) { 466 bundle.addNoCompressExtension(argv[0]); 467 } else { 468 bundle.setCompressionMethod(ZipEntry::kCompressStored); 469 } 470 break; 471 case '-': 472 if (strcmp(cp, "-debug-mode") == 0) { 473 bundle.setDebugMode(true); 474 } else if (strcmp(cp, "-min-sdk-version") == 0) { 475 argc--; 476 argv++; 477 if (!argc) { 478 fprintf(stderr, "ERROR: No argument supplied for '--min-sdk-version' option\n"); 479 wantUsage = true; 480 goto bail; 481 } 482 bundle.setMinSdkVersion(argv[0]); 483 } else if (strcmp(cp, "-target-sdk-version") == 0) { 484 argc--; 485 argv++; 486 if (!argc) { 487 fprintf(stderr, "ERROR: No argument supplied for '--target-sdk-version' option\n"); 488 wantUsage = true; 489 goto bail; 490 } 491 bundle.setTargetSdkVersion(argv[0]); 492 } else if (strcmp(cp, "-max-sdk-version") == 0) { 493 argc--; 494 argv++; 495 if (!argc) { 496 fprintf(stderr, "ERROR: No argument supplied for '--max-sdk-version' option\n"); 497 wantUsage = true; 498 goto bail; 499 } 500 bundle.setMaxSdkVersion(argv[0]); 501 } else if (strcmp(cp, "-max-res-version") == 0) { 502 argc--; 503 argv++; 504 if (!argc) { 505 fprintf(stderr, "ERROR: No argument supplied for '--max-res-version' option\n"); 506 wantUsage = true; 507 goto bail; 508 } 509 bundle.setMaxResVersion(argv[0]); 510 } else if (strcmp(cp, "-version-code") == 0) { 511 argc--; 512 argv++; 513 if (!argc) { 514 fprintf(stderr, "ERROR: No argument supplied for '--version-code' option\n"); 515 wantUsage = true; 516 goto bail; 517 } 518 bundle.setVersionCode(argv[0]); 519 } else if (strcmp(cp, "-version-name") == 0) { 520 argc--; 521 argv++; 522 if (!argc) { 523 fprintf(stderr, "ERROR: No argument supplied for '--version-name' option\n"); 524 wantUsage = true; 525 goto bail; 526 } 527 bundle.setVersionName(argv[0]); 528 } else if (strcmp(cp, "-values") == 0) { 529 bundle.setValues(true); 530 } else if (strcmp(cp, "-custom-package") == 0) { 531 argc--; 532 argv++; 533 if (!argc) { 534 fprintf(stderr, "ERROR: No argument supplied for '--custom-package' option\n"); 535 wantUsage = true; 536 goto bail; 537 } 538 bundle.setCustomPackage(argv[0]); 539 } else if (strcmp(cp, "-extra-packages") == 0) { 540 argc--; 541 argv++; 542 if (!argc) { 543 fprintf(stderr, "ERROR: No argument supplied for '--extra-packages' option\n"); 544 wantUsage = true; 545 goto bail; 546 } 547 bundle.setExtraPackages(argv[0]); 548 } else if (strcmp(cp, "-generate-dependencies") == 0) { 549 bundle.setGenDependencies(true); 550 } else if (strcmp(cp, "-utf16") == 0) { 551 bundle.setWantUTF16(true); 552 } else if (strcmp(cp, "-preferred-configurations") == 0) { 553 argc--; 554 argv++; 555 if (!argc) { 556 fprintf(stderr, "ERROR: No argument supplied for '--preferred-configurations' option\n"); 557 wantUsage = true; 558 goto bail; 559 } 560 bundle.addPreferredConfigurations(argv[0]); 561 } else if (strcmp(cp, "-rename-manifest-package") == 0) { 562 argc--; 563 argv++; 564 if (!argc) { 565 fprintf(stderr, "ERROR: No argument supplied for '--rename-manifest-package' option\n"); 566 wantUsage = true; 567 goto bail; 568 } 569 bundle.setManifestPackageNameOverride(argv[0]); 570 } else if (strcmp(cp, "-rename-instrumentation-target-package") == 0) { 571 argc--; 572 argv++; 573 if (!argc) { 574 fprintf(stderr, "ERROR: No argument supplied for '--rename-instrumentation-target-package' option\n"); 575 wantUsage = true; 576 goto bail; 577 } 578 bundle.setInstrumentationPackageNameOverride(argv[0]); 579 } else if (strcmp(cp, "-auto-add-overlay") == 0) { 580 bundle.setAutoAddOverlay(true); 581 } else if (strcmp(cp, "-error-on-failed-insert") == 0) { 582 bundle.setErrorOnFailedInsert(true); 583 } else if (strcmp(cp, "-output-text-symbols") == 0) { 584 argc--; 585 argv++; 586 if (!argc) { 587 fprintf(stderr, "ERROR: No argument supplied for '-output-text-symbols' option\n"); 588 wantUsage = true; 589 goto bail; 590 } 591 bundle.setOutputTextSymbols(argv[0]); 592 } else if (strcmp(cp, "-product") == 0) { 593 argc--; 594 argv++; 595 if (!argc) { 596 fprintf(stderr, "ERROR: No argument supplied for '--product' option\n"); 597 wantUsage = true; 598 goto bail; 599 } 600 bundle.setProduct(argv[0]); 601 } else if (strcmp(cp, "-non-constant-id") == 0) { 602 bundle.setNonConstantId(true); 603 } else if (strcmp(cp, "-no-crunch") == 0) { 604 bundle.setUseCrunchCache(true); 605 } else if (strcmp(cp, "-ignore-assets") == 0) { 606 argc--; 607 argv++; 608 if (!argc) { 609 fprintf(stderr, "ERROR: No argument supplied for '--ignore-assets' option\n"); 610 wantUsage = true; 611 goto bail; 612 } 613 gUserIgnoreAssets = argv[0]; 614 } else if (strcmp(cp, "-pseudo-localize") == 0) { 615 bundle.setPseudolocalize(PSEUDO_ACCENTED | PSEUDO_BIDI); 616 } else { 617 fprintf(stderr, "ERROR: Unknown option '-%s'\n", cp); 618 wantUsage = true; 619 goto bail; 620 } 621 cp += strlen(cp) - 1; 622 break; 623 default: 624 fprintf(stderr, "ERROR: Unknown flag '-%c'\n", *cp); 625 wantUsage = true; 626 goto bail; 627 } 628 629 cp++; 630 } 631 argc--; 632 argv++; 633 } 634 635 /* 636 * We're past the flags. The rest all goes straight in. 637 */ 638 bundle.setFileSpec(argv, argc); 639 640 result = handleCommand(&bundle); 641 642bail: 643 if (wantUsage) { 644 usage(); 645 result = 2; 646 } 647 648 //printf("--> returning %d\n", result); 649 return result; 650} 651