base/android/build_info.h

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef BASE_ANDROID_BUILD_INFO_H_
   6 #define BASE_ANDROID_BUILD_INFO_H_
   7
   8 #include <jni.h>
   9
  10 #include <string>
  11
  12 #include "base/base_export.h"
  13 #include "base/memory/singleton.h"
  14
  15 namespace base {
  16 namespace android {
  17
  18 // This enumeration maps to the values returned by BuildInfo::sdk_int(),
  19 // indicating the Android release associated with a given SDK version.
  20 enum SdkVersion {
  21   SDK_VERSION_JELLY_BEAN = 16,
  22   SDK_VERSION_JELLY_BEAN_MR1 = 17,
  23   SDK_VERSION_JELLY_BEAN_MR2 = 18,
  24   SDK_VERSION_KITKAT = 19,
  25   SDK_VERSION_KITKAT_WEAR = 20,
  26   SDK_VERSION_LOLLIPOP = 21,
  27   SDK_VERSION_LOLLIPOP_MR1 = 22
  28 };
  29
  30 // BuildInfo is a singleton class that stores android build and device
  31 // information. It will be called from Android specific code and gets used
  32 // primarily in crash reporting.
  33
  34 // It is also used to store the last java exception seen during JNI.
  35 // TODO(nileshagrawal): Find a better place to store this info.
  36 class BASE_EXPORT BuildInfo {
  37  public:
  38
  39   ~BuildInfo() {}
  40
  41   // Static factory method for getting the singleton BuildInfo instance.
  42   // Note that ownership is not conferred on the caller and the BuildInfo in
  43   // question isn't actually freed until shutdown. This is ok because there
  44   // should only be one instance of BuildInfo ever created.
  45   static BuildInfo* GetInstance();
  46
  47   // Const char* is used instead of std::strings because these values must be
  48   // available even if the process is in a crash state. Sadly
  49   // std::string.c_str() doesn't guarantee that memory won't be allocated when
  50   // it is called.
  51   const char* device() const {
  52     return device_;
  53   }
  54
  55   const char* manufacturer() const {
  56     return manufacturer_;
  57   }
  58
  59   const char* model() const {
  60     return model_;
  61   }
  62
  63   const char* brand() const {
  64     return brand_;
  65   }
  66
  67   const char* android_build_id() const {
  68     return android_build_id_;
  69   }
  70
  71   const char* android_build_fp() const {
  72     return android_build_fp_;
  73   }
  74
  75   const char* package_version_code() const {
  76     return package_version_code_;
  77   }
  78
  79   const char* package_version_name() const {
  80     return package_version_name_;
  81   }
  82
  83   const char* package_label() const {
  84     return package_label_;
  85   }
  86
  87   const char* package_name() const {
  88     return package_name_;
  89   }
  90
  91   const char* build_type() const {
  92     return build_type_;
  93   }
  94
  95   int sdk_int() const {
  96     return sdk_int_;
  97   }
  98
  99   int has_apk_splits() const {
 100     return has_apk_splits_;
 101   }
 102
 103   const char* java_exception_info() const {
 104     return java_exception_info_;
 105   }
 106
 107   void SetJavaExceptionInfo(const std::string& info);
 108
 109   void ClearJavaExceptionInfo();
 110
 111   static bool RegisterBindings(JNIEnv* env);
 112
 113  private:
 114   friend struct BuildInfoSingletonTraits;
 115
 116   explicit BuildInfo(JNIEnv* env);
 117
 118   // Const char* is used instead of std::strings because these values must be
 119   // available even if the process is in a crash state. Sadly
 120   // std::string.c_str() doesn't guarantee that memory won't be allocated when
 121   // it is called.
 122   const char* const device_;
 123   const char* const manufacturer_;
 124   const char* const model_;
 125   const char* const brand_;
 126   const char* const android_build_id_;
 127   const char* const android_build_fp_;
 128   const char* const package_version_code_;
 129   const char* const package_version_name_;
 130   const char* const package_label_;
 131   const char* const package_name_;
 132   const char* const build_type_;
 133   const int sdk_int_;
 134   const bool has_apk_splits_;
 135   // This is set via set_java_exception_info, not at constructor time.
 136   const char* java_exception_info_;
 137
 138   DISALLOW_COPY_AND_ASSIGN(BuildInfo);
 139 };
 140
 141 }  // namespace android
 142 }  // namespace base
 143
 144 #endif  // BASE_ANDROID_BUILD_INFO_H_