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       LOCAL_JAVA_LIBRARIES := android_stubs_$(LOCAL_SDK_VERSION) $(LOCAL_JAVA_LIBRARIES)
  24     endif
  25   endif
  26 else
  27   ifneq ($(LOCAL_NO_STANDARD_LIBRARIES),true)
  28     LOCAL_JAVA_LIBRARIES := core ext framework $(LOCAL_JAVA_LIBRARIES)
  29   endif
  30 endif
  31
  32 LOCAL_BUILT_MODULE_STEM := $(strip $(LOCAL_BUILT_MODULE_STEM))
  33 ifeq ($(LOCAL_BUILT_MODULE_STEM),)
  34 $(error $(LOCAL_PATH): Target java template must define LOCAL_BUILT_MODULE_STEM)
  35 endif
  36 ifneq ($(filter classes-compiled.jar classes.jar,$(LOCAL_BUILT_MODULE_STEM)),)
  37 $(error LOCAL_BUILT_MODULE_STEM may not be "$(LOCAL_BUILT_MODULE_STEM)")
  38 endif
  39
  40
  41 ##############################################################################
  42 # Define the intermediate targets before including base_rules so they get
  43 # the correct environment.
  44 ##############################################################################
  45
  46 intermediates := $(call local-intermediates-dir)
  47 intermediates.COMMON := $(call local-intermediates-dir,COMMON)
  48
  49 # This is cleared below, and re-set if we really need it.
  50 full_classes_jar := $(intermediates.COMMON)/classes.jar
  51
  52 # Emma source code coverage
  53 ifneq ($(EMMA_INSTRUMENT),true)
  54 LOCAL_NO_EMMA_INSTRUMENT := true
  55 LOCAL_NO_EMMA_COMPILE := true
  56 endif
  57
  58 # Choose leaf name for the compiled jar file.
  59 ifneq ($(LOCAL_NO_EMMA_COMPILE),true)
  60 full_classes_compiled_jar_leaf := classes-no-debug-var.jar
  61 else
  62 full_classes_compiled_jar_leaf := classes-full-debug.jar
  63 endif
  64 full_classes_compiled_jar := $(intermediates.COMMON)/$(full_classes_compiled_jar_leaf)
  65
  66 emma_intermediates_dir := $(intermediates.COMMON)/emma_out
  67 # the 'lib/$(full_classes_compiled_jar_leaf)' portion of this path is fixed in
  68 # the emma tool
  69 full_classes_emma_jar := $(emma_intermediates_dir)/lib/$(full_classes_compiled_jar_leaf)
  70 full_classes_stubs_jar := $(intermediates.COMMON)/stubs.jar
  71 full_classes_jarjar_jar := $(full_classes_jar)
  72 built_dex := $(intermediates.COMMON)/classes.dex
  73
  74 LOCAL_INTERMEDIATE_TARGETS += \
  75     $(full_classes_jar) \
  76     $(full_classes_compiled_jar) \
  77     $(full_classes_emma_jar) \
  78     $(full_classes_stubs_jar) \
  79     $(full_classes_jarjar_jar) \
  80     $(built_dex)
  81
  82
  83 # TODO: It looks like the only thing we need from base_rules is
  84 # all_java_sources.  See if we can get that by adding a
  85 # common_java.mk, and moving the include of base_rules.mk to
  86 # after all the declarations.
  87
  88 #######################################
  89 include $(BUILD_SYSTEM)/base_rules.mk
  90 #######################################
  91
  92 # We use intermediates.COMMON because the classes.jar/.dex files will be
  93 # common even if LOCAL_BUILT_MODULE isn't.
  94 #
  95 # Override some target variables that base_rules set up for us.
  96 $(LOCAL_INTERMEDIATE_TARGETS): \
  97         PRIVATE_CLASS_INTERMEDIATES_DIR := $(intermediates.COMMON)/classes
  98 $(LOCAL_INTERMEDIATE_TARGETS): \
  99         PRIVATE_SOURCE_INTERMEDIATES_DIR := $(intermediates.COMMON)/src
 100
 101 # Since we're using intermediates.COMMON, make sure that it gets cleaned
 102 # properly.
 103 $(cleantarget): PRIVATE_CLEAN_FILES += $(intermediates.COMMON)
 104
 105 # If the module includes java code (i.e., it's not framework-res), compile it.
 106 full_classes_jar :=
 107 built_dex :=
 108 ifneq (,$(strip $(all_java_sources)))
 109
 110 # If LOCAL_BUILT_MODULE_STEM wasn't overridden by our caller,
 111 # full_classes_jar will be the same module as LOCAL_BUILT_MODULE.
 112 # Otherwise, the caller will define it as a prerequisite of
 113 # LOCAL_BUILT_MODULE, so it will inherit the necessary PRIVATE_*
 114 # variable definitions.
 115 full_classes_jar := $(intermediates.COMMON)/classes.jar
 116 built_dex := $(intermediates.COMMON)/classes.dex
 117
 118 # Droiddoc isn't currently able to generate stubs for modules, so we're just
 119 # allowing it to use the classes.jar as the "stubs" that would be use to link
 120 # against, for the cases where someone needs the jar to link against.
 121 # - Use the classes.jar instead of the handful of other intermediates that
 122 #   we have, because it's the most processed, but still hasn't had dex run on
 123 #   it, so it's closest to what's on the device.
 124 # - This extra copy, with the dependency on LOCAL_BUILT_MODULE allows the
 125 #   PRIVATE_ vars to be preserved.
 126 $(full_classes_stubs_jar): PRIVATE_SOURCE_FILE := $(full_classes_jar)
 127 $(full_classes_stubs_jar) : $(LOCAL_BUILT_MODULE) | $(ACP)
 128         @echo Copying $(PRIVATE_SOURCE_FILE)
 129         $(hide) $(ACP) -fp $(PRIVATE_SOURCE_FILE) $@
 130 ALL_MODULES.$(LOCAL_MODULE).STUBS := $(full_classes_stubs_jar)
 131
 132 # Compile the java files to a .jar file.
 133 # This intentionally depends on java_sources, not all_java_sources.
 134 # Deps for generated source files must be handled separately,
 135 # via deps on the target that generates the sources.
 136 $(full_classes_compiled_jar): $(java_sources) $(full_java_lib_deps)
 137         $(transform-java-to-classes.jar)
 138
 139 # All of the rules after full_classes_compiled_jar are very unlikely
 140 # to fail except for bugs in their respective tools.  If you would
 141 # like to run these rules, add the "all" modifier goal to the make
 142 # command line.
 143 # This overwrites the value defined in base_rules.mk.  That's a little
 144 # dirty.  It's preferable to set LOCAL_CHECKED_MODULE, but this has to
 145 # be done after the inclusion of base_rules.mk.
 146 ALL_MODULES.$(LOCAL_MODULE).CHECKED := $(full_classes_compiled_jar)
 147
 148 ifneq ($(LOCAL_NO_EMMA_COMPILE),true)
 149 # If you instrument class files that have local variable debug information in
 150 # them emma does not correctly maintain the local variable table.
 151 # This will cause an error when you try to convert the class files for Android.
 152 # The workaround for this to compile the java classes with only
 153 # line and source debug information, not local information.
 154 $(full_classes_compiled_jar): PRIVATE_JAVAC_DEBUG_FLAGS := -g:{lines,source}
 155 else
 156 # when emma is off, compile with the default flags, which contain full debug
 157 # info
 158 $(full_classes_compiled_jar): PRIVATE_JAVAC_DEBUG_FLAGS := -g
 159 endif
 160
 161 ifeq ($(LOCAL_IS_STATIC_JAVA_LIBRARY),true)
 162 # Skip adding emma instrumentation to class files if this is a static library,
 163 # since it will be instrumented by the package that includes it
 164 LOCAL_NO_EMMA_INSTRUMENT:= true
 165 endif
 166
 167 ifneq ($(LOCAL_NO_EMMA_INSTRUMENT),true)
 168 $(full_classes_emma_jar): PRIVATE_EMMA_COVERAGE_FILE := $(intermediates.COMMON)/coverage.em
 169 $(full_classes_emma_jar): PRIVATE_EMMA_INTERMEDIATES_DIR := $(emma_intermediates_dir)
 170 # this rule will generate both $(PRIVATE_EMMA_COVERAGE_FILE) and
 171 # $(full_classes_emma_jar)
 172 $(full_classes_emma_jar): $(full_classes_compiled_jar)
 173         $(transform-classes.jar-to-emma)
 174 $(PRIVATE_EMMA_COVERAGE_FILE): $(full_classes_emma_jar)
 175 else
 176 $(full_classes_emma_jar): $(full_classes_compiled_jar) | $(ACP)
 177         @echo Copying $<
 178         $(copy-file-to-target)
 179 endif
 180
 181 # Run jarjar if necessary, otherwise just copy the file.  This is the last
 182 # part of this step, so the output of this command is full_classes_jar.
 183 ifneq ($(strip $(LOCAL_JARJAR_RULES)),)
 184 $(full_classes_jarjar_jar): PRIVATE_JARJAR_RULES := $(LOCAL_JARJAR_RULES)
 185 $(full_classes_jarjar_jar): $(full_classes_emma_jar) | jarjar
 186         @echo JarJar: $@
 187         $(hide) $(JARJAR) process $(PRIVATE_JARJAR_RULES) $< $@
 188 else
 189 $(full_classes_jarjar_jar): $(full_classes_emma_jar) | $(ACP)
 190         @echo Copying: $@
 191         $(hide) $(ACP) $< $@
 192 endif
 193
 194 # Override PRIVATE_INTERMEDIATES_DIR so that install-dex-debug
 195 # will work even when intermediates != intermediates.COMMON.
 196 $(built_dex): PRIVATE_INTERMEDIATES_DIR := $(intermediates.COMMON)
 197 $(built_dex): PRIVATE_DX_FLAGS := $(LOCAL_DX_FLAGS)
 198 $(built_dex): $(full_classes_jar) $(DX)
 199         $(transform-classes.jar-to-dex)
 200 ifneq ($(GENERATE_DEX_DEBUG),)
 201         $(install-dex-debug)
 202 endif
 203
 204 findbugs_xml := $(intermediates.COMMON)/findbugs.xml
 205 $(findbugs_xml) : PRIVATE_JAR_FILE := $(full_classes_jar)
 206 $(findbugs_xml) : PRIVATE_AUXCLASSPATH := $(addprefix -auxclasspath ,$(strip \
 207                                                                 $(call normalize-path-list,$(filter %.jar,\
 208                                                                                 $(full_java_libs)))))
 209 # We can't depend directly on full_classes_jar because the PRIVATE_
 210 # vars won't be set up correctly.
 211 $(findbugs_xml) : $(LOCAL_BUILT_MODULE)
 212         @echo Findbugs: $@
 213         $(hide) $(FINDBUGS) -textui -effort:min -xml:withMessages \
 214                 $(PRIVATE_AUXCLASSPATH) \
 215                 $(PRIVATE_JAR_FILE) \
 216                 > $@
 217
 218 ALL_FINDBUGS_FILES += $(findbugs_xml)
 219
 220 findbugs_html := $(PRODUCT_OUT)/findbugs/$(LOCAL_MODULE).html
 221 $(findbugs_html) : PRIVATE_XML_FILE := $(findbugs_xml)
 222 $(LOCAL_MODULE)-findbugs : $(findbugs_html)
 223 $(findbugs_html) : $(findbugs_xml)
 224         @mkdir -p $(dir $@)
 225         @echo ConvertXmlToText: $@
 226         $(hide) prebuilt/common/findbugs/bin/convertXmlToText -html:fancy.xsl $(PRIVATE_XML_FILE) \
 227         > $@
 228
 229 $(LOCAL_MODULE)-findbugs : $(findbugs_html)
 230
 231 endif