Main.cpp revision c761d8b0086f9e92eb1e4b3a5683ae6afb84036a
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} 181 182/* 183 * Dispatch the command. 184 */ 185int handleCommand(Bundle* bundle) 186{ 187 //printf("--- command %d (verbose=%d force=%d):\n", 188 // bundle->getCommand(), bundle->getVerbose(), bundle->getForce()); 189 //for (int i = 0; i < bundle->getFileSpecCount(); i++) 190 // printf(" %d: '%s'\n", i, bundle->getFileSpecEntry(i)); 191 192 switch (bundle->getCommand()) { 193 case kCommandVersion: return doVersion(bundle); 194 case kCommandList: return doList(bundle); 195 case kCommandDump: return doDump(bundle); 196 case kCommandAdd: return doAdd(bundle); 197 case kCommandRemove: return doRemove(bundle); 198 case kCommandPackage: return doPackage(bundle); 199 case kCommandCrunch: return doCrunch(bundle); 200 default: 201 fprintf(stderr, "%s: requested command not yet supported\n", gProgName); 202 return 1; 203 } 204} 205 206/* 207 * Parse args. 208 */ 209int main(int argc, char* const argv[]) 210{ 211 char *prog = argv[0]; 212 Bundle bundle; 213 bool wantUsage = false; 214 int result = 1; // pessimistically assume an error. 215 int tolerance = 0; 216 217 /* default to compression */ 218 bundle.setCompressionMethod(ZipEntry::kCompressDeflated); 219 220 if (argc < 2) { 221 wantUsage = true; 222 goto bail; 223 } 224 225 if (argv[1][0] == 'v') 226 bundle.setCommand(kCommandVersion); 227 else if (argv[1][0] == 'd') 228 bundle.setCommand(kCommandDump); 229 else if (argv[1][0] == 'l') 230 bundle.setCommand(kCommandList); 231 else if (argv[1][0] == 'a') 232 bundle.setCommand(kCommandAdd); 233 else if (argv[1][0] == 'r') 234 bundle.setCommand(kCommandRemove); 235 else if (argv[1][0] == 'p') 236 bundle.setCommand(kCommandPackage); 237 else if (argv[1][0] == 'c') 238 bundle.setCommand(kCommandCrunch); 239 else { 240 fprintf(stderr, "ERROR: Unknown command '%s'\n", argv[1]); 241 wantUsage = true; 242 goto bail; 243 } 244 argc -= 2; 245 argv += 2; 246 247 /* 248 * Pull out flags. We support "-fv" and "-f -v". 249 */ 250 while (argc && argv[0][0] == '-') { 251 /* flag(s) found */ 252 const char* cp = argv[0] +1; 253 254 while (*cp != '\0') { 255 switch (*cp) { 256 case 'v': 257 bundle.setVerbose(true); 258 break; 259 case 'a': 260 bundle.setAndroidList(true); 261 break; 262 case 'c': 263 argc--; 264 argv++; 265 if (!argc) { 266 fprintf(stderr, "ERROR: No argument supplied for '-c' option\n"); 267 wantUsage = true; 268 goto bail; 269 } 270 bundle.addConfigurations(argv[0]); 271 break; 272 case 'f': 273 bundle.setForce(true); 274 break; 275 case 'g': 276 argc--; 277 argv++; 278 if (!argc) { 279 fprintf(stderr, "ERROR: No argument supplied for '-g' option\n"); 280 wantUsage = true; 281 goto bail; 282 } 283 tolerance = atoi(argv[0]); 284 bundle.setGrayscaleTolerance(tolerance); 285 printf("%s: Images with deviation <= %d will be forced to grayscale.\n", prog, tolerance); 286 break; 287 case 'k': 288 bundle.setJunkPath(true); 289 break; 290 case 'm': 291 bundle.setMakePackageDirs(true); 292 break; 293#if 0 294 case 'p': 295 bundle.setPseudolocalize(true); 296 break; 297#endif 298 case 'u': 299 bundle.setUpdate(true); 300 break; 301 case 'x': 302 bundle.setExtending(true); 303 break; 304 case 'z': 305 bundle.setRequireLocalization(true); 306 break; 307 case 'j': 308 argc--; 309 argv++; 310 if (!argc) { 311 fprintf(stderr, "ERROR: No argument supplied for '-j' option\n"); 312 wantUsage = true; 313 goto bail; 314 } 315 convertPath(argv[0]); 316 bundle.addJarFile(argv[0]); 317 break; 318 case 'A': 319 argc--; 320 argv++; 321 if (!argc) { 322 fprintf(stderr, "ERROR: No argument supplied for '-A' option\n"); 323 wantUsage = true; 324 goto bail; 325 } 326 convertPath(argv[0]); 327 bundle.setAssetSourceDir(argv[0]); 328 break; 329 case 'G': 330 argc--; 331 argv++; 332 if (!argc) { 333 fprintf(stderr, "ERROR: No argument supplied for '-G' option\n"); 334 wantUsage = true; 335 goto bail; 336 } 337 convertPath(argv[0]); 338 bundle.setProguardFile(argv[0]); 339 break; 340 case 'I': 341 argc--; 342 argv++; 343 if (!argc) { 344 fprintf(stderr, "ERROR: No argument supplied for '-I' option\n"); 345 wantUsage = true; 346 goto bail; 347 } 348 convertPath(argv[0]); 349 bundle.addPackageInclude(argv[0]); 350 break; 351 case 'F': 352 argc--; 353 argv++; 354 if (!argc) { 355 fprintf(stderr, "ERROR: No argument supplied for '-F' option\n"); 356 wantUsage = true; 357 goto bail; 358 } 359 convertPath(argv[0]); 360 bundle.setOutputAPKFile(argv[0]); 361 break; 362 case 'J': 363 argc--; 364 argv++; 365 if (!argc) { 366 fprintf(stderr, "ERROR: No argument supplied for '-J' option\n"); 367 wantUsage = true; 368 goto bail; 369 } 370 convertPath(argv[0]); 371 bundle.setRClassDir(argv[0]); 372 break; 373 case 'M': 374 argc--; 375 argv++; 376 if (!argc) { 377 fprintf(stderr, "ERROR: No argument supplied for '-M' option\n"); 378 wantUsage = true; 379 goto bail; 380 } 381 convertPath(argv[0]); 382 bundle.setAndroidManifestFile(argv[0]); 383 break; 384 case 'P': 385 argc--; 386 argv++; 387 if (!argc) { 388 fprintf(stderr, "ERROR: No argument supplied for '-P' option\n"); 389 wantUsage = true; 390 goto bail; 391 } 392 convertPath(argv[0]); 393 bundle.setPublicOutputFile(argv[0]); 394 break; 395 case 'S': 396 argc--; 397 argv++; 398 if (!argc) { 399 fprintf(stderr, "ERROR: No argument supplied for '-S' option\n"); 400 wantUsage = true; 401 goto bail; 402 } 403 convertPath(argv[0]); 404 bundle.addResourceSourceDir(argv[0]); 405 break; 406 case 'C': 407 argc--; 408 argv++; 409 if (!argc) { 410 fprintf(stderr, "ERROR: No argument supplied for '-C' option\n"); 411 wantUsage = true; 412 goto bail; 413 } 414 convertPath(argv[0]); 415 bundle.setCrunchedOutputDir(argv[0]); 416 break; 417 case '0': 418 argc--; 419 argv++; 420 if (!argc) { 421 fprintf(stderr, "ERROR: No argument supplied for '-e' option\n"); 422 wantUsage = true; 423 goto bail; 424 } 425 if (argv[0][0] != 0) { 426 bundle.addNoCompressExtension(argv[0]); 427 } else { 428 bundle.setCompressionMethod(ZipEntry::kCompressStored); 429 } 430 break; 431 case '-': 432 if (strcmp(cp, "-debug-mode") == 0) { 433 bundle.setDebugMode(true); 434 } else if (strcmp(cp, "-min-sdk-version") == 0) { 435 argc--; 436 argv++; 437 if (!argc) { 438 fprintf(stderr, "ERROR: No argument supplied for '--min-sdk-version' option\n"); 439 wantUsage = true; 440 goto bail; 441 } 442 bundle.setMinSdkVersion(argv[0]); 443 } else if (strcmp(cp, "-target-sdk-version") == 0) { 444 argc--; 445 argv++; 446 if (!argc) { 447 fprintf(stderr, "ERROR: No argument supplied for '--target-sdk-version' option\n"); 448 wantUsage = true; 449 goto bail; 450 } 451 bundle.setTargetSdkVersion(argv[0]); 452 } else if (strcmp(cp, "-max-sdk-version") == 0) { 453 argc--; 454 argv++; 455 if (!argc) { 456 fprintf(stderr, "ERROR: No argument supplied for '--max-sdk-version' option\n"); 457 wantUsage = true; 458 goto bail; 459 } 460 bundle.setMaxSdkVersion(argv[0]); 461 } else if (strcmp(cp, "-max-res-version") == 0) { 462 argc--; 463 argv++; 464 if (!argc) { 465 fprintf(stderr, "ERROR: No argument supplied for '--max-res-version' option\n"); 466 wantUsage = true; 467 goto bail; 468 } 469 bundle.setMaxResVersion(argv[0]); 470 } else if (strcmp(cp, "-version-code") == 0) { 471 argc--; 472 argv++; 473 if (!argc) { 474 fprintf(stderr, "ERROR: No argument supplied for '--version-code' option\n"); 475 wantUsage = true; 476 goto bail; 477 } 478 bundle.setVersionCode(argv[0]); 479 } else if (strcmp(cp, "-version-name") == 0) { 480 argc--; 481 argv++; 482 if (!argc) { 483 fprintf(stderr, "ERROR: No argument supplied for '--version-name' option\n"); 484 wantUsage = true; 485 goto bail; 486 } 487 bundle.setVersionName(argv[0]); 488 } else if (strcmp(cp, "-values") == 0) { 489 bundle.setValues(true); 490 } else if (strcmp(cp, "-custom-package") == 0) { 491 argc--; 492 argv++; 493 if (!argc) { 494 fprintf(stderr, "ERROR: No argument supplied for '--custom-package' option\n"); 495 wantUsage = true; 496 goto bail; 497 } 498 bundle.setCustomPackage(argv[0]); 499 } else if (strcmp(cp, "-extra-packages") == 0) { 500 argc--; 501 argv++; 502 if (!argc) { 503 fprintf(stderr, "ERROR: No argument supplied for '--extra-packages' option\n"); 504 wantUsage = true; 505 goto bail; 506 } 507 bundle.setExtraPackages(argv[0]); 508 } else if (strcmp(cp, "-generate-dependencies") == 0) { 509 bundle.setGenDependencies(true); 510 } else if (strcmp(cp, "-utf16") == 0) { 511 bundle.setWantUTF16(true); 512 } else if (strcmp(cp, "-preferred-configurations") == 0) { 513 argc--; 514 argv++; 515 if (!argc) { 516 fprintf(stderr, "ERROR: No argument supplied for '--preferred-configurations' option\n"); 517 wantUsage = true; 518 goto bail; 519 } 520 bundle.addPreferredConfigurations(argv[0]); 521 } else if (strcmp(cp, "-rename-manifest-package") == 0) { 522 argc--; 523 argv++; 524 if (!argc) { 525 fprintf(stderr, "ERROR: No argument supplied for '--rename-manifest-package' option\n"); 526 wantUsage = true; 527 goto bail; 528 } 529 bundle.setManifestPackageNameOverride(argv[0]); 530 } else if (strcmp(cp, "-rename-instrumentation-target-package") == 0) { 531 argc--; 532 argv++; 533 if (!argc) { 534 fprintf(stderr, "ERROR: No argument supplied for '--rename-instrumentation-target-package' option\n"); 535 wantUsage = true; 536 goto bail; 537 } 538 bundle.setInstrumentationPackageNameOverride(argv[0]); 539 } else if (strcmp(cp, "-auto-add-overlay") == 0) { 540 bundle.setAutoAddOverlay(true); 541 } else if (strcmp(cp, "-product") == 0) { 542 argc--; 543 argv++; 544 if (!argc) { 545 fprintf(stderr, "ERROR: No argument supplied for '--product' option\n"); 546 wantUsage = true; 547 goto bail; 548 } 549 bundle.setProduct(argv[0]); 550 } else if (strcmp(cp, "-non-constant-id") == 0) { 551 bundle.setNonConstantId(true); 552 } else if (strcmp(cp, "-no-crunch") == 0) { 553 bundle.setUseCrunchCache(true); 554 }else { 555 fprintf(stderr, "ERROR: Unknown option '-%s'\n", cp); 556 wantUsage = true; 557 goto bail; 558 } 559 cp += strlen(cp) - 1; 560 break; 561 default: 562 fprintf(stderr, "ERROR: Unknown flag '-%c'\n", *cp); 563 wantUsage = true; 564 goto bail; 565 } 566 567 cp++; 568 } 569 argc--; 570 argv++; 571 } 572 573 /* 574 * We're past the flags. The rest all goes straight in. 575 */ 576 bundle.setFileSpec(argv, argc); 577 578 result = handleCommand(&bundle); 579 580bail: 581 if (wantUsage) { 582 usage(); 583 result = 2; 584 } 585 586 //printf("--> returning %d\n", result); 587 return result; 588} 589