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