Bundle.h revision dcdfe9fef4b07ee53d312c3fbecc74cb215ace6f 
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
17#include "SdkConstants.h"
18
19/*
20 * Things we can do.
21 */
22typedef enum Command {
23    kCommandUnknown = 0,
24    kCommandVersion,
25    kCommandList,
26    kCommandDump,
27    kCommandAdd,
28    kCommandRemove,
29    kCommandPackage,
30    kCommandCrunch,
31    kCommandSingleCrunch,
32    kCommandDaemon
33} Command;
34
35/*
36 * Pseudolocalization methods
37 */
38typedef enum PseudolocalizationMethod {
39    NO_PSEUDOLOCALIZATION = 0,
40    PSEUDO_ACCENTED,
41    PSEUDO_BIDI,
42} PseudolocalizationMethod;
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(NO_PSEUDOLOCALIZATION),
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          mCrunchedOutputDir(NULL), mProguardFile(NULL),
59          mAndroidManifestFile(NULL), mPublicOutputFile(NULL),
60          mRClassDir(NULL), mResourceIntermediatesDir(NULL), mManifestMinSdkVersion(NULL),
61          mMinSdkVersion(NULL), mTargetSdkVersion(NULL), mMaxSdkVersion(NULL),
62          mVersionCode(NULL), mVersionName(NULL), mReplaceVersion(false), mCustomPackage(NULL),
63          mExtraPackages(NULL), mMaxResVersion(NULL), mDebugMode(false), mNonConstantId(false),
64          mProduct(NULL), mUseCrunchCache(false), mErrorOnFailedInsert(false),
65          mErrorOnMissingConfigEntry(false), mOutputTextSymbols(NULL),
66          mSingleCrunchInputFile(NULL), mSingleCrunchOutputFile(NULL),
67          mBuildSharedLibrary(false),
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    short getPseudolocalize(void) const { return mPseudolocalize; }
99    void setPseudolocalize(short 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    const android::String8& getPlatformBuildVersionCode() { return mPlatformVersionCode; }
124    void setPlatformBuildVersionCode(const android::String8& code) { mPlatformVersionCode = code; }
125    const android::String8& getPlatformBuildVersionName() { return mPlatformVersionName; }
126    void setPlatformBuildVersionName(const android::String8& name) { mPlatformVersionName = name; }
127
128    bool getUTF16StringsOption() {
129        return mWantUTF16 || !isMinSdkAtLeast(SDK_FROYO);
130    }
131
132    /*
133     * Input options.
134     */
135    const android::Vector<const char*>& getAssetSourceDirs() const { return mAssetSourceDirs; }
136    void addAssetSourceDir(const char* dir) { mAssetSourceDirs.insertAt(dir,0); }
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 android::String8& getConfigurations() const { return mConfigurations; }
150    void addConfigurations(const char* val) { if (mConfigurations.size() > 0) { mConfigurations.append(","); mConfigurations.append(val); } else { mConfigurations = val; } }
151    const android::String8& getPreferredDensity() const { return mPreferredDensity; }
152    void setPreferredDensity(const char* val) { mPreferredDensity = val; }
153    void addSplitConfigurations(const char* val) { mPartialConfigurations.add(android::String8(val)); }
154    const android::Vector<android::String8>& getSplitConfigurations() const { return mPartialConfigurations; }
155    const char* getResourceIntermediatesDir() const { return mResourceIntermediatesDir; }
156    void setResourceIntermediatesDir(const char* dir) { mResourceIntermediatesDir = dir; }
157    const android::Vector<android::String8>& getPackageIncludes() const { return mPackageIncludes; }
158    void addPackageInclude(const char* file) { mPackageIncludes.add(android::String8(file)); }
159    const android::Vector<const char*>& getJarFiles() const { return mJarFiles; }
160    void addJarFile(const char* file) { mJarFiles.add(file); }
161    const android::Vector<const char*>& getNoCompressExtensions() const { return mNoCompressExtensions; }
162    void addNoCompressExtension(const char* ext) { mNoCompressExtensions.add(ext); }
163    void setFeatureOfPackage(const char* str) { mFeatureOfPackage = str; }
164    const android::String8& getFeatureOfPackage() const { return mFeatureOfPackage; }
165    void setFeatureAfterPackage(const char* str) { mFeatureAfterPackage = str; }
166    const android::String8& getFeatureAfterPackage() const { return mFeatureAfterPackage; }
167
168    const char*  getManifestMinSdkVersion() const { return mManifestMinSdkVersion; }
169    void setManifestMinSdkVersion(const char*  val) { mManifestMinSdkVersion = val; }
170    const char*  getMinSdkVersion() const { return mMinSdkVersion; }
171    void setMinSdkVersion(const char*  val) { mMinSdkVersion = val; }
172    const char*  getTargetSdkVersion() const { return mTargetSdkVersion; }
173    void setTargetSdkVersion(const char*  val) { mTargetSdkVersion = val; }
174    const char*  getMaxSdkVersion() const { return mMaxSdkVersion; }
175    void setMaxSdkVersion(const char*  val) { mMaxSdkVersion = val; }
176    const char*  getVersionCode() const { return mVersionCode; }
177    void setVersionCode(const char*  val) { mVersionCode = val; }
178    const char* getVersionName() const { return mVersionName; }
179    void setVersionName(const char* val) { mVersionName = val; }
180    bool getReplaceVersion() { return mReplaceVersion; }
181    void setReplaceVersion(bool val) { mReplaceVersion = val; }
182    const char* getCustomPackage() const { return mCustomPackage; }
183    void setCustomPackage(const char* val) { mCustomPackage = val; }
184    const char* getExtraPackages() const { return mExtraPackages; }
185    void setExtraPackages(const char* val) { mExtraPackages = val; }
186    const char* getMaxResVersion() const { return mMaxResVersion; }
187    void setMaxResVersion(const char * val) { mMaxResVersion = val; }
188    bool getDebugMode() const { return mDebugMode; }
189    void setDebugMode(bool val) { mDebugMode = val; }
190    bool getNonConstantId() const { return mNonConstantId; }
191    void setNonConstantId(bool val) { mNonConstantId = val; }
192    const char* getProduct() const { return mProduct; }
193    void setProduct(const char * val) { mProduct = val; }
194    void setUseCrunchCache(bool val) { mUseCrunchCache = val; }
195    bool getUseCrunchCache() const { return mUseCrunchCache; }
196    const char* getOutputTextSymbols() const { return mOutputTextSymbols; }
197    void setOutputTextSymbols(const char* val) { mOutputTextSymbols = val; }
198    const char* getSingleCrunchInputFile() const { return mSingleCrunchInputFile; }
199    void setSingleCrunchInputFile(const char* val) { mSingleCrunchInputFile = val; }
200    const char* getSingleCrunchOutputFile() const { return mSingleCrunchOutputFile; }
201    void setSingleCrunchOutputFile(const char* val) { mSingleCrunchOutputFile = val; }
202    bool getBuildSharedLibrary() const { return mBuildSharedLibrary; }
203    void setBuildSharedLibrary(bool val) { mBuildSharedLibrary = val; }
204
205    /*
206     * Set and get the file specification.
207     *
208     * Note this does NOT make a copy of argv.
209     */
210    void setFileSpec(char* const argv[], int argc) {
211        mArgc = argc;
212        mArgv = argv;
213    }
214    int getFileSpecCount(void) const { return mArgc; }
215    const char* getFileSpecEntry(int idx) const { return mArgv[idx]; }
216    void eatArgs(int n) {
217        if (n > mArgc) n = mArgc;
218        mArgv += n;
219        mArgc -= n;
220    }
221
222#if 0
223    /*
224     * Package count.  Nothing to do with anything else here; this is
225     * just a convenient place to stuff it so we don't have to pass it
226     * around everywhere.
227     */
228    int getPackageCount(void) const { return mPackageCount; }
229    void setPackageCount(int val) { mPackageCount = val; }
230#endif
231
232    /* Certain features may only be available on a specific SDK level or
233     * above. SDK levels that have a non-numeric identifier are assumed
234     * to be newer than any SDK level that has a number designated.
235     */
236    bool isMinSdkAtLeast(int desired) {
237        /* If the application specifies a minSdkVersion in the manifest
238         * then use that. Otherwise, check what the user specified on
239         * the command line. If neither, it's not available since
240         * the minimum SDK version is assumed to be 1.
241         */
242        const char *minVer;
243        if (mManifestMinSdkVersion != NULL) {
244            minVer = mManifestMinSdkVersion;
245        } else if (mMinSdkVersion != NULL) {
246            minVer = mMinSdkVersion;
247        } else {
248            return false;
249        }
250
251        char *end;
252        int minSdkNum = (int)strtol(minVer, &end, 0);
253        if (*end == '\0') {
254            if (minSdkNum < desired) {
255                return false;
256            }
257        }
258        return true;
259    }
260
261private:
262    /* commands & modifiers */
263    Command     mCmd;
264    bool        mVerbose;
265    bool        mAndroidList;
266    bool        mForce;
267    int         mGrayscaleTolerance;
268    bool        mMakePackageDirs;
269    bool        mUpdate;
270    bool        mExtending;
271    bool        mRequireLocalization;
272    short       mPseudolocalize;
273    bool        mWantUTF16;
274    bool        mValues;
275    bool        mIncludeMetaData;
276    int         mCompressionMethod;
277    bool        mJunkPath;
278    const char* mOutputAPKFile;
279    const char* mManifestPackageNameOverride;
280    const char* mInstrumentationPackageNameOverride;
281    bool        mAutoAddOverlay;
282    bool        mGenDependencies;
283    const char* mCrunchedOutputDir;
284    const char* mProguardFile;
285    const char* mAndroidManifestFile;
286    const char* mPublicOutputFile;
287    const char* mRClassDir;
288    const char* mResourceIntermediatesDir;
289    android::String8 mConfigurations;
290    android::String8 mPreferredDensity;
291    android::Vector<android::String8> mPartialConfigurations;
292    android::Vector<android::String8> mPackageIncludes;
293    android::Vector<const char*> mJarFiles;
294    android::Vector<const char*> mNoCompressExtensions;
295    android::Vector<const char*> mAssetSourceDirs;
296    android::Vector<const char*> mResourceSourceDirs;
297
298    android::String8 mFeatureOfPackage;
299    android::String8 mFeatureAfterPackage;
300    const char* mManifestMinSdkVersion;
301    const char* mMinSdkVersion;
302    const char* mTargetSdkVersion;
303    const char* mMaxSdkVersion;
304    const char* mVersionCode;
305    const char* mVersionName;
306    bool        mReplaceVersion;
307    const char* mCustomPackage;
308    const char* mExtraPackages;
309    const char* mMaxResVersion;
310    bool        mDebugMode;
311    bool        mNonConstantId;
312    const char* mProduct;
313    bool        mUseCrunchCache;
314    bool        mErrorOnFailedInsert;
315    bool        mErrorOnMissingConfigEntry;
316    const char* mOutputTextSymbols;
317    const char* mSingleCrunchInputFile;
318    const char* mSingleCrunchOutputFile;
319    bool        mBuildSharedLibrary;
320    android::String8 mPlatformVersionCode;
321    android::String8 mPlatformVersionName;
322
323    /* file specification */
324    int         mArgc;
325    char* const* mArgv;
326
327#if 0
328    /* misc stuff */
329    int         mPackageCount;
330#endif
331
332};
333
334#endif // __BUNDLE_H
335