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