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