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