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