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