]>
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 " strings Print the contents of the resource table string pool in the APK.\n"
52 " badging Print the label and icon for the app declared in APK.\n"
53 " permissions Print the permissions from the APK.\n"
54 " resources Print the resource table from the APK.\n"
55 " configurations Print the configurations in the APK.\n"
56 " xmltree Print the compiled xmls in the given assets.\n"
57 " xmlstrings Print the strings of the given compiled xml assets.\n\n", gProgName
);
59 " %s p[ackage] [-d][-f][-m][-u][-v][-x][-z][-M AndroidManifest.xml] \\\n"
60 " [-0 extension [-0 extension ...]] [-g tolerance] [-j jarfile] \\\n"
61 " [--debug-mode] [--min-sdk-version VAL] [--target-sdk-version VAL] \\\n"
62 " [--app-version VAL] [--app-version-name TEXT] [--custom-package VAL] \\\n"
63 " [--rename-manifest-package PACKAGE] \\\n"
64 " [--rename-instrumentation-target-package PACKAGE] \\\n"
65 " [--utf16] [--auto-add-overlay] \\\n"
66 " [--max-res-version VAL] \\\n"
67 " [-I base-package [-I base-package ...]] \\\n"
68 " [-A asset-source-dir] [-G class-list-file] [-P public-definitions-file] \\\n"
69 " [-S resource-sources [-S resource-sources ...]] \\\n"
70 " [-F apk-file] [-J R-file-dir] \\\n"
71 " [--product product1,product2,...] \\\n"
72 " [-c CONFIGS] [--preferred-configurations CONFIGS] \\\n"
73 " [raw-files-dir [raw-files-dir] ...] \\\n"
74 " [--output-text-symbols DIR]\n"
76 " Package the android resources. It will read assets and resources that are\n"
77 " supplied with the -M -A -S or raw-files-dir arguments. The -J -P -F and -R\n"
78 " options control which files are output.\n\n"
81 " %s r[emove] [-v] file.{zip,jar,apk} file1 [file2 ...]\n"
82 " Delete specified files from Zip-compatible archive.\n\n",
85 " %s a[dd] [-v] file.{zip,jar,apk} file1 [file2 ...]\n"
86 " Add specified files to Zip-compatible archive.\n\n", gProgName
);
88 " %s c[runch] [-v] -S resource-sources ... -C output-folder ...\n"
89 " Do PNG preprocessing and store the results in output folder.\n\n", gProgName
);
92 " Print program version.\n\n", gProgName
);
95 " -a print Android-specific data (resources, manifest) when listing\n"
96 " -c specify which configurations to include. The default is all\n"
97 " configurations. The value of the parameter should be a comma\n"
98 " separated list of configuration values. Locales should be specified\n"
99 " as either a language or language-region pair. Some examples:\n"
103 " If you put the special locale, zz_ZZ on the list, it will perform\n"
104 " pseudolocalization on the default locale, modifying all of the\n"
105 " strings so you can look for strings that missed the\n"
106 " internationalization process. For example:\n"
108 " -d one or more device assets to include, separated by commas\n"
109 " -f force overwrite of existing files\n"
110 " -g specify a pixel tolerance to force images to grayscale, default 0\n"
111 " -j specify a jar or zip file containing classes to include\n"
112 " -k junk path of file(s) added\n"
113 " -m make package directories under location specified by -J\n"
115 " -p pseudolocalize the default configuration\n"
117 " -u update existing packages (add new, replace older, remove deleted files)\n"
118 " -v verbose output\n"
119 " -x create extending (non-application) resource IDs\n"
120 " -z require localization of resource attributes marked with\n"
121 " localization=\"suggested\"\n"
122 " -A additional directory in which to find raw asset files\n"
123 " -G A file to output proguard options into.\n"
124 " -F specify the apk file to output\n"
125 " -I add an existing package to base include set\n"
126 " -J specify where to output R.java resource constant definitions\n"
127 " -M specify full path to AndroidManifest.xml to include in zip\n"
128 " -P specify where to output public resource definitions\n"
129 " -S directory in which to find resources. Multiple directories will be scanned\n"
130 " and the first match found (left to right) will take precedence.\n"
131 " -0 specifies an additional extension for which such files will not\n"
132 " be stored compressed in the .apk. An empty string means to not\n"
133 " compress any files at all.\n"
135 " inserts android:debuggable=\"true\" in to the application node of the\n"
136 " manifest, making the application debuggable even on production devices.\n"
137 " --min-sdk-version\n"
138 " inserts android:minSdkVersion in to manifest. If the version is 7 or\n"
139 " higher, the default encoding for resources will be in UTF-8.\n"
140 " --target-sdk-version\n"
141 " inserts android:targetSdkVersion in to manifest.\n"
142 " --max-res-version\n"
143 " ignores versioned resource directories above the given value.\n"
145 " when used with \"dump resources\" also includes resource values.\n"
147 " inserts android:versionCode in to manifest.\n"
149 " inserts android:versionName in to manifest.\n"
150 " --custom-package\n"
151 " generates R.java into a different package.\n"
152 " --extra-packages\n"
153 " generate R.java for libraries. Separate libraries with ':'.\n"
154 " --generate-dependencies\n"
155 " generate dependency files in the same directories for R.java and resource package\n"
156 " --auto-add-overlay\n"
157 " Automatically add resources that are only in overlays.\n"
158 " --preferred-configurations\n"
159 " Like the -c option for filtering out unneeded configurations, but\n"
160 " only expresses a preference. If there is no resource available with\n"
161 " the preferred configuration then it will not be stripped.\n"
162 " --rename-manifest-package\n"
163 " Rewrite the manifest so that its package name is the package name\n"
164 " given here. Relative class names (for example .Foo) will be\n"
165 " changed to absolute names with the old package so that the code\n"
166 " does not need to change.\n"
167 " --rename-instrumentation-target-package\n"
168 " Rewrite the manifest so that all of its instrumentation\n"
169 " components target the given package. Useful when used in\n"
170 " conjunction with --rename-manifest-package to fix tests against\n"
171 " a package that has been renamed.\n"
173 " Specifies which variant to choose for strings that have\n"
174 " product variants\n"
176 " changes default encoding for resources to UTF-16. Only useful when API\n"
177 " level is set to 7 or higher where the default encoding is UTF-8.\n"
178 " --non-constant-id\n"
179 " Make the resources ID non constant. This is required to make an R java class\n"
180 " that does not contain the final value but is used to make reusable compiled\n"
181 " libraries that need to access resources.\n"
182 " --error-on-failed-insert\n"
183 " Forces aapt to return an error if it fails to insert values into the manifest\n"
184 " with --debug-mode, --min-sdk-version, --target-sdk-version --version-code\n"
185 " and --version-name.\n"
186 " Insertion typically fails if the manifest already defines the attribute.\n"
187 " --output-text-symbols\n"
188 " Generates a text file containing the resource symbols of the R class in the\n"
189 " specified folder.\n"
191 " Assets to be ignored. Default pattern is:\n"
193 gDefaultIgnoreAssets
);
197 * Dispatch the command.
199 int handleCommand(Bundle
* bundle
)
201 //printf("--- command %d (verbose=%d force=%d):\n",
202 // bundle->getCommand(), bundle->getVerbose(), bundle->getForce());
203 //for (int i = 0; i < bundle->getFileSpecCount(); i++)
204 // printf(" %d: '%s'\n", i, bundle->getFileSpecEntry(i));
206 switch (bundle
->getCommand()) {
207 case kCommandVersion
: return doVersion(bundle
);
208 case kCommandList
: return doList(bundle
);
209 case kCommandDump
: return doDump(bundle
);
210 case kCommandAdd
: return doAdd(bundle
);
211 case kCommandRemove
: return doRemove(bundle
);
212 case kCommandPackage
: return doPackage(bundle
);
213 case kCommandCrunch
: return doCrunch(bundle
);
215 fprintf(stderr
, "%s: requested command not yet supported\n", gProgName
);
223 int main(int argc
, char* const argv
[])
225 char *prog
= argv
[0];
227 bool wantUsage
= false;
228 int result
= 1; // pessimistically assume an error.
231 /* default to compression */
232 bundle
.setCompressionMethod(ZipEntry::kCompressDeflated
);
239 if (argv
[1][0] == 'v')
240 bundle
.setCommand(kCommandVersion
);
241 else if (argv
[1][0] == 'd')
242 bundle
.setCommand(kCommandDump
);
243 else if (argv
[1][0] == 'l')
244 bundle
.setCommand(kCommandList
);
245 else if (argv
[1][0] == 'a')
246 bundle
.setCommand(kCommandAdd
);
247 else if (argv
[1][0] == 'r')
248 bundle
.setCommand(kCommandRemove
);
249 else if (argv
[1][0] == 'p')
250 bundle
.setCommand(kCommandPackage
);
251 else if (argv
[1][0] == 'c')
252 bundle
.setCommand(kCommandCrunch
);
254 fprintf(stderr
, "ERROR: Unknown command '%s'\n", argv
[1]);
262 * Pull out flags. We support "-fv" and "-f -v".
264 while (argc
&& argv
[0][0] == '-') {
266 const char* cp
= argv
[0] +1;
268 while (*cp
!= '\0') {
271 bundle
.setVerbose(true);
274 bundle
.setAndroidList(true);
280 fprintf(stderr
, "ERROR: No argument supplied for '-c' option\n");
284 bundle
.addConfigurations(argv
[0]);
287 bundle
.setForce(true);
293 fprintf(stderr
, "ERROR: No argument supplied for '-g' option\n");
297 tolerance
= atoi(argv
[0]);
298 bundle
.setGrayscaleTolerance(tolerance
);
299 printf("%s: Images with deviation <= %d will be forced to grayscale.\n", prog
, tolerance
);
302 bundle
.setJunkPath(true);
305 bundle
.setMakePackageDirs(true);
309 bundle
.setPseudolocalize(true);
313 bundle
.setUpdate(true);
316 bundle
.setExtending(true);
319 bundle
.setRequireLocalization(true);
325 fprintf(stderr
, "ERROR: No argument supplied for '-j' option\n");
329 convertPath(argv
[0]);
330 bundle
.addJarFile(argv
[0]);
336 fprintf(stderr
, "ERROR: No argument supplied for '-A' option\n");
340 convertPath(argv
[0]);
341 bundle
.setAssetSourceDir(argv
[0]);
347 fprintf(stderr
, "ERROR: No argument supplied for '-G' option\n");
351 convertPath(argv
[0]);
352 bundle
.setProguardFile(argv
[0]);
358 fprintf(stderr
, "ERROR: No argument supplied for '-I' option\n");
362 convertPath(argv
[0]);
363 bundle
.addPackageInclude(argv
[0]);
369 fprintf(stderr
, "ERROR: No argument supplied for '-F' option\n");
373 convertPath(argv
[0]);
374 bundle
.setOutputAPKFile(argv
[0]);
380 fprintf(stderr
, "ERROR: No argument supplied for '-J' option\n");
384 convertPath(argv
[0]);
385 bundle
.setRClassDir(argv
[0]);
391 fprintf(stderr
, "ERROR: No argument supplied for '-M' option\n");
395 convertPath(argv
[0]);
396 bundle
.setAndroidManifestFile(argv
[0]);
402 fprintf(stderr
, "ERROR: No argument supplied for '-P' option\n");
406 convertPath(argv
[0]);
407 bundle
.setPublicOutputFile(argv
[0]);
413 fprintf(stderr
, "ERROR: No argument supplied for '-S' option\n");
417 convertPath(argv
[0]);
418 bundle
.addResourceSourceDir(argv
[0]);
424 fprintf(stderr
, "ERROR: No argument supplied for '-C' option\n");
428 convertPath(argv
[0]);
429 bundle
.setCrunchedOutputDir(argv
[0]);
435 fprintf(stderr
, "ERROR: No argument supplied for '-e' option\n");
439 if (argv
[0][0] != 0) {
440 bundle
.addNoCompressExtension(argv
[0]);
442 bundle
.setCompressionMethod(ZipEntry::kCompressStored
);
446 if (strcmp(cp
, "-debug-mode") == 0) {
447 bundle
.setDebugMode(true);
448 } else if (strcmp(cp
, "-min-sdk-version") == 0) {
452 fprintf(stderr
, "ERROR: No argument supplied for '--min-sdk-version' option\n");
456 bundle
.setMinSdkVersion(argv
[0]);
457 } else if (strcmp(cp
, "-target-sdk-version") == 0) {
461 fprintf(stderr
, "ERROR: No argument supplied for '--target-sdk-version' option\n");
465 bundle
.setTargetSdkVersion(argv
[0]);
466 } else if (strcmp(cp
, "-max-sdk-version") == 0) {
470 fprintf(stderr
, "ERROR: No argument supplied for '--max-sdk-version' option\n");
474 bundle
.setMaxSdkVersion(argv
[0]);
475 } else if (strcmp(cp
, "-max-res-version") == 0) {
479 fprintf(stderr
, "ERROR: No argument supplied for '--max-res-version' option\n");
483 bundle
.setMaxResVersion(argv
[0]);
484 } else if (strcmp(cp
, "-version-code") == 0) {
488 fprintf(stderr
, "ERROR: No argument supplied for '--version-code' option\n");
492 bundle
.setVersionCode(argv
[0]);
493 } else if (strcmp(cp
, "-version-name") == 0) {
497 fprintf(stderr
, "ERROR: No argument supplied for '--version-name' option\n");
501 bundle
.setVersionName(argv
[0]);
502 } else if (strcmp(cp
, "-values") == 0) {
503 bundle
.setValues(true);
504 } else if (strcmp(cp
, "-custom-package") == 0) {
508 fprintf(stderr
, "ERROR: No argument supplied for '--custom-package' option\n");
512 bundle
.setCustomPackage(argv
[0]);
513 } else if (strcmp(cp
, "-extra-packages") == 0) {
517 fprintf(stderr
, "ERROR: No argument supplied for '--extra-packages' option\n");
521 bundle
.setExtraPackages(argv
[0]);
522 } else if (strcmp(cp
, "-generate-dependencies") == 0) {
523 bundle
.setGenDependencies(true);
524 } else if (strcmp(cp
, "-utf16") == 0) {
525 bundle
.setWantUTF16(true);
526 } else if (strcmp(cp
, "-preferred-configurations") == 0) {
530 fprintf(stderr
, "ERROR: No argument supplied for '--preferred-configurations' option\n");
534 bundle
.addPreferredConfigurations(argv
[0]);
535 } else if (strcmp(cp
, "-rename-manifest-package") == 0) {
539 fprintf(stderr
, "ERROR: No argument supplied for '--rename-manifest-package' option\n");
543 bundle
.setManifestPackageNameOverride(argv
[0]);
544 } else if (strcmp(cp
, "-rename-instrumentation-target-package") == 0) {
548 fprintf(stderr
, "ERROR: No argument supplied for '--rename-instrumentation-target-package' option\n");
552 bundle
.setInstrumentationPackageNameOverride(argv
[0]);
553 } else if (strcmp(cp
, "-auto-add-overlay") == 0) {
554 bundle
.setAutoAddOverlay(true);
555 } else if (strcmp(cp
, "-error-on-failed-insert") == 0) {
556 bundle
.setErrorOnFailedInsert(true);
557 } else if (strcmp(cp
, "-output-text-symbols") == 0) {
561 fprintf(stderr
, "ERROR: No argument supplied for '-output-text-symbols' option\n");
565 bundle
.setOutputTextSymbols(argv
[0]);
566 } else if (strcmp(cp
, "-product") == 0) {
570 fprintf(stderr
, "ERROR: No argument supplied for '--product' option\n");
574 bundle
.setProduct(argv
[0]);
575 } else if (strcmp(cp
, "-non-constant-id") == 0) {
576 bundle
.setNonConstantId(true);
577 } else if (strcmp(cp
, "-no-crunch") == 0) {
578 bundle
.setUseCrunchCache(true);
579 } else if (strcmp(cp
, "-ignore-assets") == 0) {
583 fprintf(stderr
, "ERROR: No argument supplied for '--ignore-assets' option\n");
587 gUserIgnoreAssets
= argv
[0];
589 fprintf(stderr
, "ERROR: Unknown option '-%s'\n", cp
);
593 cp
+= strlen(cp
) - 1;
596 fprintf(stderr
, "ERROR: Unknown flag '-%c'\n", *cp
);
608 * We're past the flags. The rest all goes straight in.
610 bundle
.setFileSpec(argv
, argc
);
612 result
= handleCommand(&bundle
);
620 //printf("--> returning %d\n", result);