base/android/apk_assets.h

   1 // Copyright 2015 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_APK_ASSETS_H_
   6 #define BASE_ANDROID_APK_ASSETS_H_
   7
   8 #include <string>
   9
  10 #include "base/android/jni_android.h"
  11 #include "base/files/memory_mapped_file.h"
  12 #include "base/posix/global_descriptors.h"
  13
  14 namespace base {
  15 namespace android {
  16
  17 bool RegisterApkAssets(JNIEnv* env);
  18
  19 // Opens an asset (e.g. a .pak file) from the apk.
  20 // Can be used from renderer process.
  21 // Fails if the asset is not stored uncompressed within the .apk.
  22 // Returns: The File Descriptor of the asset, or -1 upon failure.
  23 // Input arguments:
  24 // - |file_path|: Path to file within .apk. e.g.: assets/foo.pak
  25 // Output arguments:
  26 // - |region|: size & offset (in bytes) within the .apk of the asset.
  27 BASE_EXPORT int OpenApkAsset(
  28     const std::string& file_path,
  29     base::MemoryMappedFile::Region* region);
  30
  31 // Registers an uncompressed asset from within the apk with GlobalDescriptors.
  32 // Returns: true in case of success, false otherwise.
  33 BASE_EXPORT bool RegisterApkAssetWithGlobalDescriptors(
  34     base::GlobalDescriptors::Key key,
  35     const std::string& file_path);
  36
  37 }  // namespace android
  38 }  // namespace base
  39
  40 #endif  // BASE_ANDROID_APK_ASSETS_H_