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