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