core/java.mk

   1 # Requires:
   2 # LOCAL_MODULE_SUFFIX
   3 # LOCAL_MODULE_CLASS
   4 # all_res_assets
   5
   6 # Make sure there's something to build.
   7 # It's possible to build a package that doesn't contain any classes.
   8 ifeq (,$(strip $(LOCAL_SRC_FILES)$(all_res_assets)))
   9 $(error $(LOCAL_PATH): Target java module does not define any source or resource files)
  10 endif
  11
  12 LOCAL_NO_STANDARD_LIBRARIES:=$(strip $(LOCAL_NO_STANDARD_LIBRARIES))
  13 LOCAL_SDK_VERSION:=$(strip $(LOCAL_SDK_VERSION))
  14
  15 ifneq ($(LOCAL_SDK_VERSION),)
  16   ifeq ($(LOCAL_NO_STANDARD_LIBRARIES),true)
  17     $(error $(LOCAL_PATH): Must not define both LOCAL_NO_STANDARD_LIBRARIES and LOCAL_SDK_VERSION)
  18   else
  19     ifeq ($(strip $(filter $(LOCAL_SDK_VERSION),$(TARGET_AVAILABLE_SDK_VERSIONS))),)
  20       $(error $(LOCAL_PATH): Invalid LOCAL_SDK_VERSION '$(LOCAL_SDK_VERSION)' \
  21              Choices are: $(TARGET_AVAILABLE_SDK_VERSIONS))
  22     else
  23       ifeq ($(LOCAL_SDK_VERSION),current)
  24         LOCAL_JAVA_LIBRARIES := android_stubs_$(LOCAL_SDK_VERSION) $(LOCAL_JAVA_LIBRARIES)
  25       else
  26         LOCAL_JAVA_LIBRARIES := sdk_v$(LOCAL_SDK_VERSION) $(LOCAL_JAVA_LIBRARIES)
  27       endif
  28     endif
  29   endif
  30 else
  31   ifneq ($(LOCAL_NO_STANDARD_LIBRARIES),true)
  32     LOCAL_JAVA_LIBRARIES := core ext framework $(LOCAL_JAVA_LIBRARIES)
  33   endif
  34 endif
  35 LOCAL_JAVA_LIBRARIES := $(sort $(LOCAL_JAVA_LIBRARIES))
  36
  37 LOCAL_BUILT_MODULE_STEM := $(strip $(LOCAL_BUILT_MODULE_STEM))
  38 ifeq ($(LOCAL_BUILT_MODULE_STEM),)
  39 $(error $(LOCAL_PATH): Target java template must define LOCAL_BUILT_MODULE_STEM)
  40 endif
  41 ifneq ($(filter classes-compiled.jar classes.jar,$(LOCAL_BUILT_MODULE_STEM)),)
  42 $(error LOCAL_BUILT_MODULE_STEM may not be "$(LOCAL_BUILT_MODULE_STEM)")
  43 endif
  44
  45
  46 ##############################################################################
  47 # Define the intermediate targets before including base_rules so they get
  48 # the correct environment.
  49 ##############################################################################
  50
  51 intermediates := $(call local-intermediates-dir)
  52 intermediates.COMMON := $(call local-intermediates-dir,COMMON)
  53
  54 # This is cleared below, and re-set if we really need it.
  55 full_classes_jar := $(intermediates.COMMON)/classes.jar
  56
  57 # Emma source code coverage
  58 ifneq ($(EMMA_INSTRUMENT),true)
  59 LOCAL_NO_EMMA_INSTRUMENT := true
  60 LOCAL_NO_EMMA_COMPILE := true
  61 endif
  62
  63 # Choose leaf name for the compiled jar file.
  64 ifneq ($(LOCAL_NO_EMMA_COMPILE),true)
  65 full_classes_compiled_jar_leaf := classes-no-debug-var.jar
  66 else
  67 full_classes_compiled_jar_leaf := classes-full-debug.jar
  68 endif
  69 full_classes_compiled_jar := $(intermediates.COMMON)/$(full_classes_compiled_jar_leaf)
  70
  71 emma_intermediates_dir := $(intermediates.COMMON)/emma_out
  72 # the 'lib/$(full_classes_compiled_jar_leaf)' portion of this path is fixed in
  73 # the emma tool
  74 full_classes_emma_jar := $(emma_intermediates_dir)/lib/$(full_classes_compiled_jar_leaf)
  75 full_classes_stubs_jar := $(intermediates.COMMON)/stubs.jar
  76 full_classes_jarjar_jar := $(intermediates.COMMON)/classes-jarjar.jar
  77 full_classes_full_names_jar := $(intermediates.COMMON)/classes-full-names.jar
  78 full_classes_proguard_jar := $(full_classes_jar)
  79 built_dex := $(intermediates.COMMON)/classes.dex
  80
  81 LOCAL_INTERMEDIATE_TARGETS += \
  82     $(full_classes_jar) \
  83     $(full_classes_compiled_jar) \
  84     $(full_classes_emma_jar) \
  85     $(full_classes_full_names_jar) \
  86     $(full_classes_stubs_jar) \
  87     $(full_classes_jarjar_jar) \
  88     $(built_dex)
  89
  90
  91 # TODO: It looks like the only thing we need from base_rules is
  92 # all_java_sources.  See if we can get that by adding a
  93 # common_java.mk, and moving the include of base_rules.mk to
  94 # after all the declarations.
  95
  96 #######################################
  97 include $(BUILD_SYSTEM)/base_rules.mk
  98 #######################################
  99
 100 # We use intermediates.COMMON because the classes.jar/.dex files will be
 101 # common even if LOCAL_BUILT_MODULE isn't.
 102 #
 103 # Override some target variables that base_rules set up for us.
 104 $(LOCAL_INTERMEDIATE_TARGETS): \
 105         PRIVATE_CLASS_INTERMEDIATES_DIR := $(intermediates.COMMON)/classes
 106 $(LOCAL_INTERMEDIATE_TARGETS): \
 107         PRIVATE_SOURCE_INTERMEDIATES_DIR := $(intermediates.COMMON)/src
 108
 109 # Since we're using intermediates.COMMON, make sure that it gets cleaned
 110 # properly.
 111 $(cleantarget): PRIVATE_CLEAN_FILES += $(intermediates.COMMON)
 112
 113 # If the module includes java code (i.e., it's not framework-res), compile it.
 114 full_classes_jar :=
 115 built_dex :=
 116 ifneq (,$(strip $(all_java_sources)))
 117
 118 # If LOCAL_BUILT_MODULE_STEM wasn't overridden by our caller,
 119 # full_classes_jar will be the same module as LOCAL_BUILT_MODULE.
 120 # Otherwise, the caller will define it as a prerequisite of
 121 # LOCAL_BUILT_MODULE, so it will inherit the necessary PRIVATE_*
 122 # variable definitions.
 123 full_classes_jar := $(intermediates.COMMON)/classes.jar
 124 built_dex := $(intermediates.COMMON)/classes.dex
 125
 126 # Droiddoc isn't currently able to generate stubs for modules, so we're just
 127 # allowing it to use the classes.jar as the "stubs" that would be use to link
 128 # against, for the cases where someone needs the jar to link against.
 129 # - Use the classes.jar instead of the handful of other intermediates that
 130 #   we have, because it's the most processed, but still hasn't had dex run on
 131 #   it, so it's closest to what's on the device.
 132 # - This extra copy, with the dependency on LOCAL_BUILT_MODULE allows the
 133 #   PRIVATE_ vars to be preserved.
 134 $(full_classes_stubs_jar): PRIVATE_SOURCE_FILE := $(full_classes_jar)
 135 $(full_classes_stubs_jar) : $(LOCAL_BUILT_MODULE) | $(ACP)
 136         @echo Copying $(PRIVATE_SOURCE_FILE)
 137         $(hide) $(ACP) -fp $(PRIVATE_SOURCE_FILE) $@
 138 ALL_MODULES.$(LOCAL_MODULE).STUBS := $(full_classes_stubs_jar)
 139
 140 # Compile the java files to a .jar file.
 141 # This intentionally depends on java_sources, not all_java_sources.
 142 # Deps for generated source files must be handled separately,
 143 # via deps on the target that generates the sources.
 144 $(full_classes_compiled_jar): PRIVATE_JAVACFLAGS := $(LOCAL_JAVACFLAGS)
 145 $(full_classes_compiled_jar): $(java_sources) $(full_java_lib_deps)
 146         $(transform-java-to-classes.jar)
 147
 148 # All of the rules after full_classes_compiled_jar are very unlikely
 149 # to fail except for bugs in their respective tools.  If you would
 150 # like to run these rules, add the "all" modifier goal to the make
 151 # command line.
 152 # This overwrites the value defined in base_rules.mk.  That's a little
 153 # dirty.  It's preferable to set LOCAL_CHECKED_MODULE, but this has to
 154 # be done after the inclusion of base_rules.mk.
 155 ALL_MODULES.$(LOCAL_MODULE).CHECKED := $(full_classes_compiled_jar)
 156
 157 ifneq ($(LOCAL_NO_EMMA_COMPILE),true)
 158 # If you instrument class files that have local variable debug information in
 159 # them emma does not correctly maintain the local variable table.
 160 # This will cause an error when you try to convert the class files for Android.
 161 # The workaround for this to compile the java classes with only
 162 # line and source debug information, not local information.
 163 $(full_classes_compiled_jar): PRIVATE_JAVAC_DEBUG_FLAGS := -g:{lines,source}
 164 else
 165 # when emma is off, compile with the default flags, which contain full debug
 166 # info
 167 $(full_classes_compiled_jar): PRIVATE_JAVAC_DEBUG_FLAGS := -g
 168 endif
 169
 170 ifeq ($(LOCAL_IS_STATIC_JAVA_LIBRARY),true)
 171 # Skip adding emma instrumentation to class files if this is a static library,
 172 # since it will be instrumented by the package that includes it
 173 LOCAL_NO_EMMA_INSTRUMENT:= true
 174 endif
 175
 176 ifneq ($(LOCAL_NO_EMMA_INSTRUMENT),true)
 177 $(full_classes_emma_jar): PRIVATE_EMMA_COVERAGE_FILE := $(intermediates.COMMON)/coverage.em
 178 $(full_classes_emma_jar): PRIVATE_EMMA_INTERMEDIATES_DIR := $(emma_intermediates_dir)
 179 # this rule will generate both $(PRIVATE_EMMA_COVERAGE_FILE) and
 180 # $(full_classes_emma_jar)
 181 $(full_classes_emma_jar): $(full_classes_compiled_jar) | $(EMMA_JAR)
 182         $(transform-classes.jar-to-emma)
 183 $(PRIVATE_EMMA_COVERAGE_FILE): $(full_classes_emma_jar)
 184
 185 # tell proguard to load emma jar
 186 LOCAL_PROGUARD_FLAGS := $(LOCAL_PROGUARD_FLAGS) $(addprefix -libraryjars ,$(EMMA_JAR))
 187 else
 188 $(full_classes_emma_jar): $(full_classes_compiled_jar) | $(ACP)
 189         @echo Copying: $<
 190         $(copy-file-to-target)
 191 endif
 192
 193 # Run jarjar if necessary, otherwise just copy the file.
 194 ifneq ($(strip $(LOCAL_JARJAR_RULES)),)
 195 $(full_classes_jarjar_jar): PRIVATE_JARJAR_RULES := $(LOCAL_JARJAR_RULES)
 196 $(full_classes_jarjar_jar): $(full_classes_emma_jar) | $(JARJAR)
 197         @echo JarJar: $@
 198         $(hide) $(JARJAR) process $(PRIVATE_JARJAR_RULES) $< $@
 199 else
 200 $(full_classes_jarjar_jar): $(full_classes_emma_jar) | $(ACP)
 201         @echo Copying: $@
 202         $(hide) $(ACP) $< $@
 203 endif
 204
 205 # Keep a copy of the jar just before proguard processing.
 206 $(full_classes_full_names_jar): $(full_classes_emma_jar) | $(ACP)
 207         @echo Copying: $@
 208         $(hide) $(ACP) $< $@
 209
 210 # Run proguard if necessary, otherwise just copy the file.  This is the last
 211 # part of this step, so the output of this command is full_classes_jar.
 212 proguard_dictionary := $(intermediates.COMMON)/proguard_dictionary
 213 # Proguard doesn't like a class in both library and the jar to be processed.
 214 proguard_full_java_libs := $(filter-out $(full_static_java_libs),$(full_java_libs))
 215 proguard_flags := $(addprefix -libraryjars ,$(proguard_full_java_libs)) \
 216                   -include $(BUILD_SYSTEM)/proguard.flags \
 217                   -forceprocessing \
 218                   -printmapping $(proguard_dictionary)
 219 # If this is a test package, add proguard keep flags for tests.
 220 ifneq ($(strip $(LOCAL_INSTRUMENTATION_FOR)$(filter tests,$(LOCAL_MODULE_TAGS))$(filter android.test.runner,$(LOCAL_JAVA_LIBRARIES))),)
 221 proguard_flags := $(proguard_flags) -include $(BUILD_SYSTEM)/proguard_tests.flags
 222 endif # test package
 223
 224 LOCAL_PROGUARD_ENABLED:=$(strip $(LOCAL_PROGUARD_ENABLED))
 225 ifeq ($(LOCAL_PROGUARD_ENABLED),disabled)
 226     LOCAL_PROGUARD_ENABLED :=
 227 endif
 228 ifneq ($(LOCAL_PROGUARD_ENABLED),)
 229 ifeq ($(LOCAL_PROGUARD_ENABLED),full)
 230     # full
 231 else
 232 ifeq ($(LOCAL_PROGUARD_ENABLED),optonly)
 233     # optonly
 234     proguard_flags += -dontobfuscate
 235 else
 236 ifeq ($(LOCAL_PROGUARD_ENABLED),custom)
 237     # custom
 238 else
 239     $(warning while processing: $(LOCAL_MODULE))
 240     $(error invalid value for LOCAL_PROGUARD_ENABLED: $(LOCAL_PROGUARD_ENABLED))
 241 endif # custom
 242 endif # optonly
 243 endif # full
 244 endif # LOCAL_PROGUARD_ENABLED
 245
 246 $(full_classes_proguard_jar): PRIVATE_PROGUARD_ENABLED:=$(LOCAL_PROGUARD_ENABLED)
 247 $(full_classes_proguard_jar): PRIVATE_PROGUARD_FLAGS := $(proguard_flags) $(LOCAL_PROGUARD_FLAGS)
 248 $(full_classes_proguard_jar): PRIVATE_INSTRUMENTATION_FOR:=$(strip $(LOCAL_INSTRUMENTATION_FOR))
 249
 250 $(full_classes_proguard_jar): $(full_classes_full_names_jar) | $(ACP) $(PROGUARD)
 251         $(call transform-jar-to-proguard)
 252
 253 ALL_MODULES.$(LOCAL_MODULE).PROGUARD_ENABLED:=$(LOCAL_PROGUARD_ENABLED)
 254
 255 # Override PRIVATE_INTERMEDIATES_DIR so that install-dex-debug
 256 # will work even when intermediates != intermediates.COMMON.
 257 $(built_dex): PRIVATE_INTERMEDIATES_DIR := $(intermediates.COMMON)
 258 $(built_dex): PRIVATE_DX_FLAGS := $(LOCAL_DX_FLAGS)
 259 $(built_dex): $(full_classes_jar) $(DX)
 260         $(transform-classes.jar-to-dex)
 261 ifneq ($(GENERATE_DEX_DEBUG),)
 262         $(install-dex-debug)
 263 endif
 264
 265 findbugs_xml := $(intermediates.COMMON)/findbugs.xml
 266 $(findbugs_xml) : PRIVATE_JAR_FILE := $(full_classes_jar)
 267 $(findbugs_xml) : PRIVATE_AUXCLASSPATH := $(addprefix -auxclasspath ,$(strip \
 268                                                                 $(call normalize-path-list,$(filter %.jar,\
 269                                                                                 $(full_java_libs)))))
 270 # We can't depend directly on full_classes_jar because the PRIVATE_
 271 # vars won't be set up correctly.
 272 $(findbugs_xml) : $(LOCAL_BUILT_MODULE)
 273         @echo Findbugs: $@
 274         $(hide) $(FINDBUGS) -textui -effort:min -xml:withMessages \
 275                 $(PRIVATE_AUXCLASSPATH) \
 276                 $(PRIVATE_JAR_FILE) \
 277                 > $@
 278
 279 ALL_FINDBUGS_FILES += $(findbugs_xml)
 280
 281 findbugs_html := $(PRODUCT_OUT)/findbugs/$(LOCAL_MODULE).html
 282 $(findbugs_html) : PRIVATE_XML_FILE := $(findbugs_xml)
 283 $(LOCAL_MODULE)-findbugs : $(findbugs_html)
 284 $(findbugs_html) : $(findbugs_xml)
 285         @mkdir -p $(dir $@)
 286         @echo ConvertXmlToText: $@
 287         $(hide) prebuilt/common/findbugs/bin/convertXmlToText -html:fancy.xsl $(PRIVATE_XML_FILE) \
 288         > $@
 289
 290 $(LOCAL_MODULE)-findbugs : $(findbugs_html)
 291
 292 endif