]>
git.saurik.com Git - android/aapt.git/blob - Main.cpp
2 // Copyright 2006 The Android Open Source Project
4 // Android Asset Packaging Tool main entry point.
10 #include <utils/threads.h>
11 #include <utils/List.h>
12 #include <utils/Errors.h>
18 using namespace android
;
20 static const char* gProgName
= "aapt";
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.
27 * This operates in-place on the path string.
29 void convertPath(char *path
) {
30 if (path
!= NULL
&& OS_PATH_SEPARATOR
!= '/') {
31 for (; *path
; path
++) {
33 *path
= OS_PATH_SEPARATOR
;
44 fprintf(stderr
, "Android Asset Packaging Tool\n\n");
45 fprintf(stderr
, "Usage:\n");
47 " %s l[ist] [-v] [-a] file.{zip,jar,apk}\n"
48 " List contents of Zip-compatible archive.\n\n", gProgName
);
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
);
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"
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"
80 " %s r[emove] [-v] file.{zip,jar,apk} file1 [file2 ...]\n"
81 " Delete specified files from Zip-compatible archive.\n\n",
84 " %s a[dd] [-v] file.{zip,jar,apk} file1 [file2 ...]\n"
85 " Add specified files to Zip-compatible archive.\n\n", gProgName
);
87 " %s c[runch] [-v] -S resource-sources ... -C output-folder ...\n"
88 " Do PNG preprocessing and store the results in output folder.\n\n", gProgName
);
91 " Print program version.\n\n", gProgName
);
94 " -a print Android-specific data (resources, manifest) when listing\n"
95 " -c specify which configurations to include. The default is all\n"
96 " configurations. The value of the parameter should be a comma\n"
97 " separated list of configuration values. Locales should be specified\n"
98 " as either a language or language-region pair. Some examples:\n"
102 " If you put the special locale, zz_ZZ on the list, it will perform\n"
103 " pseudolocalization on the default locale, modifying all of the\n"
104 " strings so you can look for strings that missed the\n"
105 " internationalization process. For example:\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"
114 " -p pseudolocalize the default configuration\n"
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"
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 " --min-sdk-version\n"
137 " inserts android:minSdkVersion in to manifest. If the version is 7 or\n"
138 " higher, the default encoding for resources will be in UTF-8.\n"
139 " --target-sdk-version\n"
140 " inserts android:targetSdkVersion in to manifest.\n"
141 " --max-res-version\n"
142 " ignores versioned resource directories above the given value.\n"
144 " when used with \"dump resources\" also includes resource values.\n"
146 " inserts android:versionCode in to manifest.\n"
148 " inserts android:versionName in to manifest.\n"
149 " --custom-package\n"
150 " generates R.java into a different package.\n"
151 " --extra-packages\n"
152 " generate R.java for libraries. Separate libraries with ':'.\n"
153 " --generate-dependencies\n"
154 " generate dependency files in the same directories for R.java and resource package\n"
155 " --auto-add-overlay\n"
156 " Automatically add resources that are only in overlays.\n"
157 " --preferred-configurations\n"
158 " Like the -c option for filtering out unneeded configurations, but\n"
159 " only expresses a preference. If there is no resource available with\n"
160 " the preferred configuration then it will not be stripped.\n"
161 " --rename-manifest-package\n"
162 " Rewrite the manifest so that its package name is the package name\n"
163 " given here. Relative class names (for example .Foo) will be\n"
164 " changed to absolute names with the old package so that the code\n"
165 " does not need to change.\n"
166 " --rename-instrumentation-target-package\n"
167 " Rewrite the manifest so that all of its instrumentation\n"
168 " components target the given package. Useful when used in\n"
169 " conjunction with --rename-manifest-package to fix tests against\n"
170 " a package that has been renamed.\n"
172 " Specifies which variant to choose for strings that have\n"
173 " product variants\n"
175 " changes default encoding for resources to UTF-16. Only useful when API\n"
176 " level is set to 7 or higher where the default encoding is UTF-8.\n"
177 " --non-constant-id\n"
178 " Make the resources ID non constant. This is required to make an R java class\n"
179 " that does not contain the final value but is used to make reusable compiled\n"
180 " libraries that need to access resources.\n"
181 " --error-on-failed-insert\n"
182 " Forces aapt to return an error if it fails to insert values into the manifest\n"
183 " with --debug-mode, --min-sdk-version, --target-sdk-version --version-code\n"
184 " and --version-name.\n"
185 " Insertion typically fails if the manifest already defines the attribute.\n"
186 " --output-text-symbols\n"
187 " Generates a text file containing the resource symbols of the R class in the\n"
188 " specified folder.\n"
190 " Assets to be ignored. Default pattern is:\n"
192 gDefaultIgnoreAssets
);
196 * Dispatch the command.
198 int handleCommand(Bundle
* bundle
)
200 //printf("--- command %d (verbose=%d force=%d):\n",
201 // bundle->getCommand(), bundle->getVerbose(), bundle->getForce());
202 //for (int i = 0; i < bundle->getFileSpecCount(); i++)
203 // printf(" %d: '%s'\n", i, bundle->getFileSpecEntry(i));
205 switch (bundle
->getCommand()) {
206 case kCommandVersion
: return doVersion(bundle
);
207 case kCommandList
: return doList(bundle
);
208 case kCommandDump
: return doDump(bundle
);
209 case kCommandAdd
: return doAdd(bundle
);
210 case kCommandRemove
: return doRemove(bundle
);
211 case kCommandPackage
: return doPackage(bundle
);
212 case kCommandCrunch
: return doCrunch(bundle
);
214 fprintf(stderr
, "%s: requested command not yet supported\n", gProgName
);
222 int main(int argc
, char* const argv
[])
224 char *prog
= argv
[0];
226 bool wantUsage
= false;
227 int result
= 1; // pessimistically assume an error.
230 /* default to compression */
231 bundle
.setCompressionMethod(ZipEntry::kCompressDeflated
);
238 if (argv
[1][0] == 'v')
239 bundle
.setCommand(kCommandVersion
);
240 else if (argv
[1][0] == 'd')
241 bundle
.setCommand(kCommandDump
);
242 else if (argv
[1][0] == 'l')
243 bundle
.setCommand(kCommandList
);
244 else if (argv
[1][0] == 'a')
245 bundle
.setCommand(kCommandAdd
);
246 else if (argv
[1][0] == 'r')
247 bundle
.setCommand(kCommandRemove
);
248 else if (argv
[1][0] == 'p')
249 bundle
.setCommand(kCommandPackage
);
250 else if (argv
[1][0] == 'c')
251 bundle
.setCommand(kCommandCrunch
);
253 fprintf(stderr
, "ERROR: Unknown command '%s'\n", argv
[1]);
261 * Pull out flags. We support "-fv" and "-f -v".
263 while (argc
&& argv
[0][0] == '-') {
265 const char* cp
= argv
[0] +1;
267 while (*cp
!= '\0') {
270 bundle
.setVerbose(true);
273 bundle
.setAndroidList(true);
279 fprintf(stderr
, "ERROR: No argument supplied for '-c' option\n");
283 bundle
.addConfigurations(argv
[0]);
286 bundle
.setForce(true);
292 fprintf(stderr
, "ERROR: No argument supplied for '-g' option\n");
296 tolerance
= atoi(argv
[0]);
297 bundle
.setGrayscaleTolerance(tolerance
);
298 printf("%s: Images with deviation <= %d will be forced to grayscale.\n", prog
, tolerance
);
301 bundle
.setJunkPath(true);
304 bundle
.setMakePackageDirs(true);
308 bundle
.setPseudolocalize(true);
312 bundle
.setUpdate(true);
315 bundle
.setExtending(true);
318 bundle
.setRequireLocalization(true);
324 fprintf(stderr
, "ERROR: No argument supplied for '-j' option\n");
328 convertPath(argv
[0]);
329 bundle
.addJarFile(argv
[0]);
335 fprintf(stderr
, "ERROR: No argument supplied for '-A' option\n");
339 convertPath(argv
[0]);
340 bundle
.setAssetSourceDir(argv
[0]);
346 fprintf(stderr
, "ERROR: No argument supplied for '-G' option\n");
350 convertPath(argv
[0]);
351 bundle
.setProguardFile(argv
[0]);
357 fprintf(stderr
, "ERROR: No argument supplied for '-I' option\n");
361 convertPath(argv
[0]);
362 bundle
.addPackageInclude(argv
[0]);
368 fprintf(stderr
, "ERROR: No argument supplied for '-F' option\n");
372 convertPath(argv
[0]);
373 bundle
.setOutputAPKFile(argv
[0]);
379 fprintf(stderr
, "ERROR: No argument supplied for '-J' option\n");
383 convertPath(argv
[0]);
384 bundle
.setRClassDir(argv
[0]);
390 fprintf(stderr
, "ERROR: No argument supplied for '-M' option\n");
394 convertPath(argv
[0]);
395 bundle
.setAndroidManifestFile(argv
[0]);
401 fprintf(stderr
, "ERROR: No argument supplied for '-P' option\n");
405 convertPath(argv
[0]);
406 bundle
.setPublicOutputFile(argv
[0]);
412 fprintf(stderr
, "ERROR: No argument supplied for '-S' option\n");
416 convertPath(argv
[0]);
417 bundle
.addResourceSourceDir(argv
[0]);
423 fprintf(stderr
, "ERROR: No argument supplied for '-C' option\n");
427 convertPath(argv
[0]);
428 bundle
.setCrunchedOutputDir(argv
[0]);
434 fprintf(stderr
, "ERROR: No argument supplied for '-e' option\n");
438 if (argv
[0][0] != 0) {
439 bundle
.addNoCompressExtension(argv
[0]);
441 bundle
.setCompressionMethod(ZipEntry::kCompressStored
);
445 if (strcmp(cp
, "-debug-mode") == 0) {
446 bundle
.setDebugMode(true);
447 } else if (strcmp(cp
, "-min-sdk-version") == 0) {
451 fprintf(stderr
, "ERROR: No argument supplied for '--min-sdk-version' option\n");
455 bundle
.setMinSdkVersion(argv
[0]);
456 } else if (strcmp(cp
, "-target-sdk-version") == 0) {
460 fprintf(stderr
, "ERROR: No argument supplied for '--target-sdk-version' option\n");
464 bundle
.setTargetSdkVersion(argv
[0]);
465 } else if (strcmp(cp
, "-max-sdk-version") == 0) {
469 fprintf(stderr
, "ERROR: No argument supplied for '--max-sdk-version' option\n");
473 bundle
.setMaxSdkVersion(argv
[0]);
474 } else if (strcmp(cp
, "-max-res-version") == 0) {
478 fprintf(stderr
, "ERROR: No argument supplied for '--max-res-version' option\n");
482 bundle
.setMaxResVersion(argv
[0]);
483 } else if (strcmp(cp
, "-version-code") == 0) {
487 fprintf(stderr
, "ERROR: No argument supplied for '--version-code' option\n");
491 bundle
.setVersionCode(argv
[0]);
492 } else if (strcmp(cp
, "-version-name") == 0) {
496 fprintf(stderr
, "ERROR: No argument supplied for '--version-name' option\n");
500 bundle
.setVersionName(argv
[0]);
501 } else if (strcmp(cp
, "-values") == 0) {
502 bundle
.setValues(true);
503 } else if (strcmp(cp
, "-custom-package") == 0) {
507 fprintf(stderr
, "ERROR: No argument supplied for '--custom-package' option\n");
511 bundle
.setCustomPackage(argv
[0]);
512 } else if (strcmp(cp
, "-extra-packages") == 0) {
516 fprintf(stderr
, "ERROR: No argument supplied for '--extra-packages' option\n");
520 bundle
.setExtraPackages(argv
[0]);
521 } else if (strcmp(cp
, "-generate-dependencies") == 0) {
522 bundle
.setGenDependencies(true);
523 } else if (strcmp(cp
, "-utf16") == 0) {
524 bundle
.setWantUTF16(true);
525 } else if (strcmp(cp
, "-preferred-configurations") == 0) {
529 fprintf(stderr
, "ERROR: No argument supplied for '--preferred-configurations' option\n");
533 bundle
.addPreferredConfigurations(argv
[0]);
534 } else if (strcmp(cp
, "-rename-manifest-package") == 0) {
538 fprintf(stderr
, "ERROR: No argument supplied for '--rename-manifest-package' option\n");
542 bundle
.setManifestPackageNameOverride(argv
[0]);
543 } else if (strcmp(cp
, "-rename-instrumentation-target-package") == 0) {
547 fprintf(stderr
, "ERROR: No argument supplied for '--rename-instrumentation-target-package' option\n");
551 bundle
.setInstrumentationPackageNameOverride(argv
[0]);
552 } else if (strcmp(cp
, "-auto-add-overlay") == 0) {
553 bundle
.setAutoAddOverlay(true);
554 } else if (strcmp(cp
, "-error-on-failed-insert") == 0) {
555 bundle
.setErrorOnFailedInsert(true);
556 } else if (strcmp(cp
, "-output-text-symbols") == 0) {
560 fprintf(stderr
, "ERROR: No argument supplied for '-output-text-symbols' option\n");
564 bundle
.setOutputTextSymbols(argv
[0]);
565 } else if (strcmp(cp
, "-product") == 0) {
569 fprintf(stderr
, "ERROR: No argument supplied for '--product' option\n");
573 bundle
.setProduct(argv
[0]);
574 } else if (strcmp(cp
, "-non-constant-id") == 0) {
575 bundle
.setNonConstantId(true);
576 } else if (strcmp(cp
, "-no-crunch") == 0) {
577 bundle
.setUseCrunchCache(true);
578 } else if (strcmp(cp
, "-ignore-assets") == 0) {
582 fprintf(stderr
, "ERROR: No argument supplied for '--ignore-assets' option\n");
586 gUserIgnoreAssets
= argv
[0];
588 fprintf(stderr
, "ERROR: Unknown option '-%s'\n", cp
);
592 cp
+= strlen(cp
) - 1;
595 fprintf(stderr
, "ERROR: Unknown flag '-%c'\n", *cp
);
607 * We're past the flags. The rest all goes straight in.
609 bundle
.setFileSpec(argv
, argc
);
611 result
= handleCommand(&bundle
);
619 //printf("--> returning %d\n", result);