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