src/base/android/java/templates/NativeLibraries.template

   1 // Copyright 2014 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 package org.chromium.base.library_loader;
   6
   7 public class NativeLibraries {
   8     /**
   9      * IMPORTANT NOTE: The variables defined here must _not_ be 'final'.
  10      *
  11      * The reason for this is very subtle:
  12      *
  13      * - This template is used to generate several distinct, but similar
  14      *   files used in different contexts:
  15      *
  16      *   o .../gen/templates/org/chromium/base/library_loader/NativeLibraries.java
  17      *
  18      *     This file is used to build base.jar, which is the library
  19      *     jar used by chromium projects. However, the
  20      *     corresponding NativeLibraries.class file will _not_ be part
  21      *     of the final base.jar.
  22      *
  23      *   o .../$PROJECT/native_libraries_java/NativeLibraries.java
  24      *
  25      *     This file is used to build an APK (e.g. $PROJECT
  26      *     could be 'content_shell_apk'). Its content will depend on
  27      *     this target's specific build configuration, and differ from
  28      *     the source file above.
  29      *
  30      * - During the final link, all .jar files are linked together into
  31      *   a single .dex file, and the second version of NativeLibraries.class
  32      *   will be put into the final output file, and used at runtime.
  33      *
  34      * - If the variables were defined as 'final', their value would be
  35      *   optimized out inside of 'base.jar', and could not be specialized
  36      *   for every chromium program. This, however, doesn't apply to arrays of
  37      *   strings, which can be defined as final.
  38      *
  39      * This exotic scheme is used to avoid injecting project-specific, or
  40      * even build-specific, values into the base layer. E.g. this is
  41      * how the component build is supported on Android without modifying
  42      * the sources of each and every Chromium-based target.
  43      */
  44
  45 #if defined(ENABLE_CHROMIUM_LINKER_LIBRARY_IN_ZIP_FILE) && \
  46     !defined(ENABLE_CHROMIUM_LINKER)
  47 #error "Must have ENABLE_CHROMIUM_LINKER to enable library in zip file"
  48 #endif
  49
  50     // Set to true to enable the use of the Chromium Linker.
  51 #if defined(ENABLE_CHROMIUM_LINKER)
  52     public static boolean USE_LINKER = true;
  53 #else
  54     public static boolean USE_LINKER = false;
  55 #endif
  56
  57 #if defined(ENABLE_CHROMIUM_LINKER_LIBRARY_IN_ZIP_FILE)
  58     public static boolean USE_LIBRARY_IN_ZIP_FILE = true;
  59 #else
  60     public static boolean USE_LIBRARY_IN_ZIP_FILE = false;
  61 #endif
  62
  63 #if defined(ENABLE_CHROMIUM_LINKER_TESTS)
  64     public static boolean ENABLE_LINKER_TESTS = true;
  65 #else
  66     public static boolean ENABLE_LINKER_TESTS = false;
  67 #endif
  68
  69     // This is the list of native libraries to be loaded (in the correct order)
  70     // by LibraryLoader.java.  The base java library is compiled with no
  71     // array defined, and then the build system creates a version of the file
  72     // with the real list of libraries required (which changes based upon which
  73     // .apk is being built).
  74     // TODO(cjhopman): This is public since it is referenced by ChromeNativeTestActivity.java
  75     // directly. The two ways of library loading should be refactored into one.
  76     public static final String[] LIBRARIES =
  77 #if defined(NATIVE_LIBRARIES_LIST)
  78       NATIVE_LIBRARIES_LIST;
  79 #else
  80       {};
  81 #endif
  82
  83     // This is the expected version of the 'main' native library, which is the one that
  84     // implements the initial set of base JNI functions including
  85     // base::android::nativeGetVersionName()
  86     static String VERSION_NUMBER =
  87 #if defined(NATIVE_LIBRARIES_VERSION_NUMBER)
  88       NATIVE_LIBRARIES_VERSION_NUMBER;
  89 #else
  90       "";
  91 #endif
  92 }