Bundle.h revision ad2d07d2d98a46babb2a9472413fe9ce5080ca76 
1//
2// Copyright 2006 The Android Open Source Project
3//
4// State bundle.  Used to pass around stuff like command-line args.
5//
6#ifndef __BUNDLE_H
7#define __BUNDLE_H
8
9#include <stdlib.h>
10#include <utils/Log.h>
11#include <utils/threads.h>
12#include <utils/List.h>
13#include <utils/Errors.h>
14#include <utils/String8.h>
15#include <utils/Vector.h>
16
17enum {
18    SDK_CUPCAKE = 3,
19    SDK_DONUT = 4,
20    SDK_ECLAIR = 5,
21    SDK_ECLAIR_0_1 = 6,
22    SDK_MR1 = 7,
23    SDK_FROYO = 8,
24    SDK_HONEYCOMB_MR2 = 13,
25    SDK_ICE_CREAM_SANDWICH = 14,
26    SDK_ICE_CREAM_SANDWICH_MR1 = 15,
27    SDK_L = 21,
28};
29
30/*
31 * Things we can do.
32 */
33typedef enum Command {
34    kCommandUnknown = 0,
35    kCommandVersion,
36    kCommandList,
37    kCommandDump,
38    kCommandAdd,
39    kCommandRemove,
40    kCommandPackage,
41    kCommandCrunch,
42    kCommandSingleCrunch,
43} Command;
44
45/*
46 * Pseudolocalization methods
47 */
48typedef enum PseudolocalizationMethod {
49    NO_PSEUDOLOCALIZATION = 0,
50    PSEUDO_ACCENTED,
51    PSEUDO_BIDI,
52} PseudolocalizationMethod;
53
54/*
55 * Bundle of goodies, including everything specified on the command line.
56 */
57class Bundle {
58public:
59    Bundle(void)
60        : mCmd(kCommandUnknown), mVerbose(false), mAndroidList(false),
61          mForce(false), mGrayscaleTolerance(0), mMakePackageDirs(false),
62          mUpdate(false), mExtending(false),
63          mRequireLocalization(false), mPseudolocalize(NO_PSEUDOLOCALIZATION),
64          mWantUTF16(false), mValues(false), mIncludeMetaData(false),
65          mCompressionMethod(0), mJunkPath(false), mOutputAPKFile(NULL),
66          mManifestPackageNameOverride(NULL), mInstrumentationPackageNameOverride(NULL),
67          mAutoAddOverlay(false), mGenDependencies(false),
68          mCrunchedOutputDir(NULL), mProguardFile(NULL),
69          mAndroidManifestFile(NULL), mPublicOutputFile(NULL),
70          mRClassDir(NULL), mResourceIntermediatesDir(NULL), mManifestMinSdkVersion(NULL),
71          mMinSdkVersion(NULL), mTargetSdkVersion(NULL), mMaxSdkVersion(NULL),
72          mVersionCode(NULL), mVersionName(NULL), mReplaceVersion(false), mCustomPackage(NULL),
73          mExtraPackages(NULL), mMaxResVersion(NULL), mDebugMode(false), mNonConstantId(false),
74          mProduct(NULL), mUseCrunchCache(false), mErrorOnFailedInsert(false),
75          mErrorOnMissingConfigEntry(false), mOutputTextSymbols(NULL),
76          mSingleCrunchInputFile(NULL), mSingleCrunchOutputFile(NULL),
77          mBuildSharedLibrary(false),
78          mArgc(0), mArgv(NULL)
79        {}
80    ~Bundle(void) {}
81
82    /*
83     * Set the command value.  Returns "false" if it was previously set.
84     */
85    Command getCommand(void) const { return mCmd; }
86    void setCommand(Command cmd) { mCmd = cmd; }
87
88    /*
89     * Command modifiers.  Not all modifiers are appropriate for all
90     * commands.
91     */
92    bool getVerbose(void) const { return mVerbose; }
93    void setVerbose(bool val) { mVerbose = val; }
94    bool getAndroidList(void) const { return mAndroidList; }
95    void setAndroidList(bool val) { mAndroidList = val; }
96    bool getForce(void) const { return mForce; }
97    void setForce(bool val) { mForce = val; }
98    void setGrayscaleTolerance(int val) { mGrayscaleTolerance = val; }
99    int  getGrayscaleTolerance() const { return mGrayscaleTolerance; }
100    bool getMakePackageDirs(void) const { return mMakePackageDirs; }
101    void setMakePackageDirs(bool val) { mMakePackageDirs = val; }
102    bool getUpdate(void) const { return mUpdate; }
103    void setUpdate(bool val) { mUpdate = val; }
104    bool getExtending(void) const { return mExtending; }
105    void setExtending(bool val) { mExtending = val; }
106    bool getRequireLocalization(void) const { return mRequireLocalization; }
107    void setRequireLocalization(bool val) { mRequireLocalization = val; }
108    short getPseudolocalize(void) const { return mPseudolocalize; }
109    void setPseudolocalize(short val) { mPseudolocalize = val; }
110    void setWantUTF16(bool val) { mWantUTF16 = val; }
111    bool getValues(void) const { return mValues; }
112    void setValues(bool val) { mValues = val; }
113    bool getIncludeMetaData(void) const { return mIncludeMetaData; }
114    void setIncludeMetaData(bool val) { mIncludeMetaData = val; }
115    int getCompressionMethod(void) const { return mCompressionMethod; }
116    void setCompressionMethod(int val) { mCompressionMethod = val; }
117    bool getJunkPath(void) const { return mJunkPath; }
118    void setJunkPath(bool val) { mJunkPath = val; }
119    const char* getOutputAPKFile() const { return mOutputAPKFile; }
120    void setOutputAPKFile(const char* val) { mOutputAPKFile = val; }
121    const char* getManifestPackageNameOverride() const { return mManifestPackageNameOverride; }
122    void setManifestPackageNameOverride(const char * val) { mManifestPackageNameOverride = val; }
123    const char* getInstrumentationPackageNameOverride() const { return mInstrumentationPackageNameOverride; }
124    void setInstrumentationPackageNameOverride(const char * val) { mInstrumentationPackageNameOverride = val; }
125    bool getAutoAddOverlay() { return mAutoAddOverlay; }
126    void setAutoAddOverlay(bool val) { mAutoAddOverlay = val; }
127    bool getGenDependencies() { return mGenDependencies; }
128    void setGenDependencies(bool val) { mGenDependencies = val; }
129    bool getErrorOnFailedInsert() { return mErrorOnFailedInsert; }
130    void setErrorOnFailedInsert(bool val) { mErrorOnFailedInsert = val; }
131    bool getErrorOnMissingConfigEntry() { return mErrorOnMissingConfigEntry; }
132    void setErrorOnMissingConfigEntry(bool val) { mErrorOnMissingConfigEntry = val; }
133    const android::String8& getPlatformBuildVersionCode() { return mPlatformVersionCode; }
134    void setPlatformBuildVersionCode(const android::String8& code) { mPlatformVersionCode = code; }
135    const android::String8& getPlatformBuildVersionName() { return mPlatformVersionName; }
136    void setPlatformBuildVersionName(const android::String8& name) { mPlatformVersionName = name; }
137
138    bool getUTF16StringsOption() {
139        return mWantUTF16 || !isMinSdkAtLeast(SDK_FROYO);
140    }
141
142    /*
143     * Input options.
144     */
145    const android::Vector<const char*>& getAssetSourceDirs() const { return mAssetSourceDirs; }
146    void addAssetSourceDir(const char* dir) { mAssetSourceDirs.insertAt(dir,0); }
147    const char* getCrunchedOutputDir() const { return mCrunchedOutputDir; }
148    void setCrunchedOutputDir(const char* dir) { mCrunchedOutputDir = dir; }
149    const char* getProguardFile() const { return mProguardFile; }
150    void setProguardFile(const char* file) { mProguardFile = file; }
151    const android::Vector<const char*>& getResourceSourceDirs() const { return mResourceSourceDirs; }
152    void addResourceSourceDir(const char* dir) { mResourceSourceDirs.insertAt(dir,0); }
153    const char* getAndroidManifestFile() const { return mAndroidManifestFile; }
154    void setAndroidManifestFile(const char* file) { mAndroidManifestFile = file; }
155    const char* getPublicOutputFile() const { return mPublicOutputFile; }
156    void setPublicOutputFile(const char* file) { mPublicOutputFile = file; }
157    const char* getRClassDir() const { return mRClassDir; }
158    void setRClassDir(const char* dir) { mRClassDir = dir; }
159    const android::String8& getConfigurations() const { return mConfigurations; }
160    void addConfigurations(const char* val) { if (mConfigurations.size() > 0) { mConfigurations.append(","); mConfigurations.append(val); } else { mConfigurations = val; } }
161    const android::String8& getPreferredDensity() const { return mPreferredDensity; }
162    void setPreferredDensity(const char* val) { mPreferredDensity = val; }
163    void addSplitConfigurations(const char* val) { mPartialConfigurations.add(android::String8(val)); }
164    const android::Vector<android::String8>& getSplitConfigurations() const { return mPartialConfigurations; }
165    const char* getResourceIntermediatesDir() const { return mResourceIntermediatesDir; }
166    void setResourceIntermediatesDir(const char* dir) { mResourceIntermediatesDir = dir; }
167    const android::Vector<android::String8>& getPackageIncludes() const { return mPackageIncludes; }
168    void addPackageInclude(const char* file) { mPackageIncludes.add(android::String8(file)); }
169    const android::Vector<const char*>& getJarFiles() const { return mJarFiles; }
170    void addJarFile(const char* file) { mJarFiles.add(file); }
171    const android::Vector<const char*>& getNoCompressExtensions() const { return mNoCompressExtensions; }
172    void addNoCompressExtension(const char* ext) { mNoCompressExtensions.add(ext); }
173    void setFeatureOfPackage(const char* str) { mFeatureOfPackage = str; }
174    const android::String8& getFeatureOfPackage() const { return mFeatureOfPackage; }
175    void setFeatureAfterPackage(const char* str) { mFeatureAfterPackage = str; }
176    const android::String8& getFeatureAfterPackage() const { return mFeatureAfterPackage; }
177
178    const char*  getManifestMinSdkVersion() const { return mManifestMinSdkVersion; }
179    void setManifestMinSdkVersion(const char*  val) { mManifestMinSdkVersion = val; }
180    const char*  getMinSdkVersion() const { return mMinSdkVersion; }
181    void setMinSdkVersion(const char*  val) { mMinSdkVersion = val; }
182    const char*  getTargetSdkVersion() const { return mTargetSdkVersion; }
183    void setTargetSdkVersion(const char*  val) { mTargetSdkVersion = val; }
184    const char*  getMaxSdkVersion() const { return mMaxSdkVersion; }
185    void setMaxSdkVersion(const char*  val) { mMaxSdkVersion = val; }
186    const char*  getVersionCode() const { return mVersionCode; }
187    void setVersionCode(const char*  val) { mVersionCode = val; }
188    const char* getVersionName() const { return mVersionName; }
189    void setVersionName(const char* val) { mVersionName = val; }
190    bool getReplaceVersion() { return mReplaceVersion; }
191    void setReplaceVersion(bool val) { mReplaceVersion = val; }
192    const char* getCustomPackage() const { return mCustomPackage; }
193    void setCustomPackage(const char* val) { mCustomPackage = val; }
194    const char* getExtraPackages() const { return mExtraPackages; }
195    void setExtraPackages(const char* val) { mExtraPackages = val; }
196    const char* getMaxResVersion() const { return mMaxResVersion; }
197    void setMaxResVersion(const char * val) { mMaxResVersion = val; }
198    bool getDebugMode() const { return mDebugMode; }
199    void setDebugMode(bool val) { mDebugMode = val; }
200    bool getNonConstantId() const { return mNonConstantId; }
201    void setNonConstantId(bool val) { mNonConstantId = val; }
202    const char* getProduct() const { return mProduct; }
203    void setProduct(const char * val) { mProduct = val; }
204    void setUseCrunchCache(bool val) { mUseCrunchCache = val; }
205    bool getUseCrunchCache() const { return mUseCrunchCache; }
206    const char* getOutputTextSymbols() const { return mOutputTextSymbols; }
207    void setOutputTextSymbols(const char* val) { mOutputTextSymbols = val; }
208    const char* getSingleCrunchInputFile() const { return mSingleCrunchInputFile; }
209    void setSingleCrunchInputFile(const char* val) { mSingleCrunchInputFile = val; }
210    const char* getSingleCrunchOutputFile() const { return mSingleCrunchOutputFile; }
211    void setSingleCrunchOutputFile(const char* val) { mSingleCrunchOutputFile = val; }
212    bool getBuildSharedLibrary() const { return mBuildSharedLibrary; }
213    void setBuildSharedLibrary(bool val) { mBuildSharedLibrary = val; }
214
215    /*
216     * Set and get the file specification.
217     *
218     * Note this does NOT make a copy of argv.
219     */
220    void setFileSpec(char* const argv[], int argc) {
221        mArgc = argc;
222        mArgv = argv;
223    }
224    int getFileSpecCount(void) const { return mArgc; }
225    const char* getFileSpecEntry(int idx) const { return mArgv[idx]; }
226    void eatArgs(int n) {
227        if (n > mArgc) n = mArgc;
228        mArgv += n;
229        mArgc -= n;
230    }
231
232#if 0
233    /*
234     * Package count.  Nothing to do with anything else here; this is
235     * just a convenient place to stuff it so we don't have to pass it
236     * around everywhere.
237     */
238    int getPackageCount(void) const { return mPackageCount; }
239    void setPackageCount(int val) { mPackageCount = val; }
240#endif
241
242    /* Certain features may only be available on a specific SDK level or
243     * above. SDK levels that have a non-numeric identifier are assumed
244     * to be newer than any SDK level that has a number designated.
245     */
246    bool isMinSdkAtLeast(int desired) {
247        /* If the application specifies a minSdkVersion in the manifest
248         * then use that. Otherwise, check what the user specified on
249         * the command line. If neither, it's not available since
250         * the minimum SDK version is assumed to be 1.
251         */
252        const char *minVer;
253        if (mManifestMinSdkVersion != NULL) {
254            minVer = mManifestMinSdkVersion;
255        } else if (mMinSdkVersion != NULL) {
256            minVer = mMinSdkVersion;
257        } else {
258            return false;
259        }
260
261        char *end;
262        int minSdkNum = (int)strtol(minVer, &end, 0);
263        if (*end == '\0') {
264            if (minSdkNum < desired) {
265                return false;
266            }
267        }
268        return true;
269    }
270
271private:
272    /* commands & modifiers */
273    Command     mCmd;
274    bool        mVerbose;
275    bool        mAndroidList;
276    bool        mForce;
277    int         mGrayscaleTolerance;
278    bool        mMakePackageDirs;
279    bool        mUpdate;
280    bool        mExtending;
281    bool        mRequireLocalization;
282    short       mPseudolocalize;
283    bool        mWantUTF16;
284    bool        mValues;
285    bool        mIncludeMetaData;
286    int         mCompressionMethod;
287    bool        mJunkPath;
288    const char* mOutputAPKFile;
289    const char* mManifestPackageNameOverride;
290    const char* mInstrumentationPackageNameOverride;
291    bool        mAutoAddOverlay;
292    bool        mGenDependencies;
293    const char* mCrunchedOutputDir;
294    const char* mProguardFile;
295    const char* mAndroidManifestFile;
296    const char* mPublicOutputFile;
297    const char* mRClassDir;
298    const char* mResourceIntermediatesDir;
299    android::String8 mConfigurations;
300    android::String8 mPreferredDensity;
301    android::Vector<android::String8> mPartialConfigurations;
302    android::Vector<android::String8> mPackageIncludes;
303    android::Vector<const char*> mJarFiles;
304    android::Vector<const char*> mNoCompressExtensions;
305    android::Vector<const char*> mAssetSourceDirs;
306    android::Vector<const char*> mResourceSourceDirs;
307
308    android::String8 mFeatureOfPackage;
309    android::String8 mFeatureAfterPackage;
310    const char* mManifestMinSdkVersion;
311    const char* mMinSdkVersion;
312    const char* mTargetSdkVersion;
313    const char* mMaxSdkVersion;
314    const char* mVersionCode;
315    const char* mVersionName;
316    bool        mReplaceVersion;
317    const char* mCustomPackage;
318    const char* mExtraPackages;
319    const char* mMaxResVersion;
320    bool        mDebugMode;
321    bool        mNonConstantId;
322    const char* mProduct;
323    bool        mUseCrunchCache;
324    bool        mErrorOnFailedInsert;
325    bool        mErrorOnMissingConfigEntry;
326    const char* mOutputTextSymbols;
327    const char* mSingleCrunchInputFile;
328    const char* mSingleCrunchOutputFile;
329    bool        mBuildSharedLibrary;
330    android::String8 mPlatformVersionCode;
331    android::String8 mPlatformVersionName;
332
333    /* file specification */
334    int         mArgc;
335    char* const* mArgv;
336
337#if 0
338    /* misc stuff */
339    int         mPackageCount;
340#endif
341
342};
343
344#endif // __BUNDLE_H
345