Bundle.h

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