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   SDK_VERSION_MARSHMALLOW = 23
  29 };
  30
  31 // BuildInfo is a singleton class that stores android build and device
  32 // information. It will be called from Android specific code and gets used
  33 // primarily in crash reporting.
  34
  35 // It is also used to store the last java exception seen during JNI.
  36 // TODO(nileshagrawal): Find a better place to store this info.
  37 class BASE_EXPORT BuildInfo {
  38  public:
  39
  40   ~BuildInfo() {}
  41
  42   // Static factory method for getting the singleton BuildInfo instance.
  43   // Note that ownership is not conferred on the caller and the BuildInfo in
  44   // question isn't actually freed until shutdown. This is ok because there
  45   // should only be one instance of BuildInfo ever created.
  46   static BuildInfo* GetInstance();
  47
  48   // Const char* is used instead of std::strings because these values must be
  49   // available even if the process is in a crash state. Sadly
  50   // std::string.c_str() doesn't guarantee that memory won't be allocated when
  51   // it is called.
  52   const char* device() const {
  53     return device_;
  54   }
  55
  56   const char* manufacturer() const {
  57     return manufacturer_;
  58   }
  59
  60   const char* model() const {
  61     return model_;
  62   }
  63
  64   const char* brand() const {
  65     return brand_;
  66   }
  67
  68   const char* android_build_id() const {
  69     return android_build_id_;
  70   }
  71
  72   const char* android_build_fp() const {
  73     return android_build_fp_;
  74   }
  75
  76   const char* package_version_code() const {
  77     return package_version_code_;
  78   }
  79
  80   const char* package_version_name() const {
  81     return package_version_name_;
  82   }
  83
  84   const char* package_label() const {
  85     return package_label_;
  86   }
  87
  88   const char* package_name() const {
  89     return package_name_;
  90   }
  91
  92   const char* build_type() const {
  93     return build_type_;
  94   }
  95
  96   int sdk_int() const {
  97     return sdk_int_;
  98   }
  99
 100   int has_language_apk_splits() const {
 101     return has_language_apk_splits_;
 102   }
 103
 104   const char* java_exception_info() const {
 105     return java_exception_info_;
 106   }
 107
 108   void SetJavaExceptionInfo(const std::string& info);
 109
 110   void ClearJavaExceptionInfo();
 111
 112   static bool RegisterBindings(JNIEnv* env);
 113
 114  private:
 115   friend struct BuildInfoSingletonTraits;
 116
 117   explicit BuildInfo(JNIEnv* env);
 118
 119   // Const char* is used instead of std::strings because these values must be
 120   // available even if the process is in a crash state. Sadly
 121   // std::string.c_str() doesn't guarantee that memory won't be allocated when
 122   // it is called.
 123   const char* const device_;
 124   const char* const manufacturer_;
 125   const char* const model_;
 126   const char* const brand_;
 127   const char* const android_build_id_;
 128   const char* const android_build_fp_;
 129   const char* const package_version_code_;
 130   const char* const package_version_name_;
 131   const char* const package_label_;
 132   const char* const package_name_;
 133   const char* const build_type_;
 134   const int sdk_int_;
 135   const bool has_language_apk_splits_;
 136   // This is set via set_java_exception_info, not at constructor time.
 137   const char* java_exception_info_;
 138
 139   DISALLOW_COPY_AND_ASSIGN(BuildInfo);
 140 };
 141
 142 }  // namespace android
 143 }  // namespace base
 144
 145 #endif  // BASE_ANDROID_BUILD_INFO_H_