Droiddoc Support in Soong
Support Droiddoc to Soong based on core/droiddoc.mk. The non-std doclet based droiddoc compilation output is a "real" stubs.jar instead of a directory of java files and a timestamp file. The std doclet based javadoc compilation output is a "empty" stubs.jar instead of a timestamp file. The stubs.jar will be exported to out/target/common/obj/JAVA_LIBRARIES/$(LOCAL_MODULE)_intermediates/classes.jar and out/target/common/docs/$(LOCAL_MODULE)-stubs.jar A $(LOCAL_MODULE).zip file will be generated also, and is exported to out/target/common/docs/$(LOCAL_MODULE)-docs.zip if property: installable is not set to false. Bug: b/70351683 Test: unittest + convert libcore docs Android.mk to Soong manually. Change-Id: I1cffddd138a5d9d445f86a3d4a3fd4de88a2bc0f (cherry picked from commit 78188ec622cb1ee24171455867fc58ffab91562e)
This commit is contained in:
parent
50b8682dca
commit
581fd21e91
|
@ -220,6 +220,7 @@ bootstrap_go_package {
|
|||
"java/app.go",
|
||||
"java/builder.go",
|
||||
"java/dex.go",
|
||||
"java/droiddoc.go",
|
||||
"java/gen.go",
|
||||
"java/genrule.go",
|
||||
"java/jacoco.go",
|
||||
|
|
|
@ -425,6 +425,14 @@ func (c *config) EmbeddedInMake() bool {
|
|||
return c.inMake
|
||||
}
|
||||
|
||||
func (c *config) BuildId() string {
|
||||
return String(c.ProductVariables.BuildId)
|
||||
}
|
||||
|
||||
func (c *config) BuildNumberFromFile() string {
|
||||
return String(c.ProductVariables.BuildNumberFromFile)
|
||||
}
|
||||
|
||||
// DeviceName returns the name of the current device target
|
||||
// TODO: take an AndroidModuleContext to select the device name for multi-device builds
|
||||
func (c *config) DeviceName() string {
|
||||
|
|
|
@ -113,6 +113,7 @@ type ModuleContext interface {
|
|||
ExpandOptionalSource(srcFile *string, prop string) OptionalPath
|
||||
ExpandSourcesSubDir(srcFiles, excludes []string, subDir string) Paths
|
||||
Glob(globPattern string, excludes []string) Paths
|
||||
GlobFiles(globPattern string, excludes []string) Paths
|
||||
|
||||
InstallExecutable(installPath OutputPath, name string, srcPath Path, deps ...Path) OutputPath
|
||||
InstallFile(installPath OutputPath, name string, srcPath Path, deps ...Path) OutputPath
|
||||
|
@ -1245,6 +1246,24 @@ func (ctx *androidModuleContext) Glob(globPattern string, excludes []string) Pat
|
|||
return pathsForModuleSrcFromFullPath(ctx, ret)
|
||||
}
|
||||
|
||||
// glob only "files" under the directory relative to top of the source tree.
|
||||
func (ctx *androidModuleContext) GlobFiles(globPattern string, excludes []string) Paths {
|
||||
paths, err := ctx.GlobWithDeps(globPattern, excludes)
|
||||
if err != nil {
|
||||
ctx.ModuleErrorf("glob: %s", err.Error())
|
||||
}
|
||||
var ret []Path
|
||||
for _, p := range paths {
|
||||
if isDir, err := ctx.Fs().IsDir(p); err != nil {
|
||||
ctx.ModuleErrorf("error in IsDir(%s): %s", p, err.Error())
|
||||
return nil
|
||||
} else if !isDir {
|
||||
ret = append(ret, PathForSource(ctx, p))
|
||||
}
|
||||
}
|
||||
return ret
|
||||
}
|
||||
|
||||
func init() {
|
||||
RegisterSingletonType("buildtarget", BuildTargetSingleton)
|
||||
}
|
||||
|
|
|
@ -110,6 +110,10 @@ type productVariables struct {
|
|||
// Suffix to add to generated Makefiles
|
||||
Make_suffix *string `json:",omitempty"`
|
||||
|
||||
BuildId *string `json:",omitempty"`
|
||||
BuildNumberFromFile *string `json:",omitempty"`
|
||||
DateFromFile *string `json:",omitempty"`
|
||||
|
||||
Platform_sdk_version *int `json:",omitempty"`
|
||||
Platform_sdk_final *bool `json:",omitempty"`
|
||||
Platform_version_active_codenames []string `json:",omitempty"`
|
||||
|
|
|
@ -196,3 +196,39 @@ func (app *AndroidApp) AndroidMk() android.AndroidMkData {
|
|||
}
|
||||
|
||||
}
|
||||
|
||||
func (jd *Javadoc) AndroidMk() android.AndroidMkData {
|
||||
return android.AndroidMkData{
|
||||
Class: "JAVA_LIBRARIES",
|
||||
OutputFile: android.OptionalPathForPath(jd.stubsJar),
|
||||
Include: "$(BUILD_SYSTEM)/soong_java_prebuilt.mk",
|
||||
Extra: []android.AndroidMkExtraFunc{
|
||||
func(w io.Writer, outputFile android.Path) {
|
||||
if jd.properties.Installable == nil || *jd.properties.Installable == true {
|
||||
fmt.Fprintln(w, "LOCAL_DROIDDOC_DOC_ZIP := ", jd.docZip.String())
|
||||
}
|
||||
if jd.stubsJar != nil {
|
||||
fmt.Fprintln(w, "LOCAL_DROIDDOC_STUBS_JAR := ", jd.stubsJar.String())
|
||||
}
|
||||
},
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
func (ddoc *Droiddoc) AndroidMk() android.AndroidMkData {
|
||||
return android.AndroidMkData{
|
||||
Class: "JAVA_LIBRARIES",
|
||||
OutputFile: android.OptionalPathForPath(ddoc.stubsJar),
|
||||
Include: "$(BUILD_SYSTEM)/soong_java_prebuilt.mk",
|
||||
Extra: []android.AndroidMkExtraFunc{
|
||||
func(w io.Writer, outputFile android.Path) {
|
||||
if ddoc.Javadoc.properties.Installable == nil || *ddoc.Javadoc.properties.Installable == true {
|
||||
fmt.Fprintln(w, "LOCAL_DROIDDOC_DOC_ZIP := ", ddoc.Javadoc.docZip.String())
|
||||
}
|
||||
if ddoc.Javadoc.stubsJar != nil {
|
||||
fmt.Fprintln(w, "LOCAL_DROIDDOC_STUBS_JAR := ", ddoc.Javadoc.stubsJar.String())
|
||||
}
|
||||
},
|
||||
},
|
||||
}
|
||||
}
|
||||
|
|
|
@ -428,13 +428,6 @@ func (x *classpath) FormDesugarClasspath(optName string) []string {
|
|||
return flags
|
||||
}
|
||||
|
||||
// Append an android.Paths to the end of the classpath list
|
||||
func (x *classpath) AddPaths(paths android.Paths) {
|
||||
for _, path := range paths {
|
||||
*x = append(*x, path)
|
||||
}
|
||||
}
|
||||
|
||||
// Convert a classpath to an android.Paths
|
||||
func (x *classpath) Paths() android.Paths {
|
||||
return append(android.Paths(nil), (*x)...)
|
||||
|
|
|
@ -126,6 +126,8 @@ func init() {
|
|||
|
||||
pctx.HostJavaToolVariable("JarjarCmd", "jarjar.jar")
|
||||
pctx.HostJavaToolVariable("DesugarJar", "desugar.jar")
|
||||
pctx.HostJavaToolVariable("JsilverJar", "jsilver.jar")
|
||||
pctx.HostJavaToolVariable("DoclavaJar", "doclava.jar")
|
||||
|
||||
pctx.HostBinToolVariable("SoongJavacWrapper", "soong_javac_wrapper")
|
||||
|
||||
|
|
|
@ -0,0 +1,455 @@
|
|||
// Copyright 2018 Google Inc. All rights reserved.
|
||||
//
|
||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||
// you may not use this file except in compliance with the License.
|
||||
// You may obtain a copy of the License at
|
||||
//
|
||||
// http://www.apache.org/licenses/LICENSE-2.0
|
||||
//
|
||||
// Unless required by applicable law or agreed to in writing, software
|
||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
// See the License for the specific language governing permissions and
|
||||
// limitations under the License.
|
||||
|
||||
package java
|
||||
|
||||
import (
|
||||
"android/soong/android"
|
||||
"android/soong/java/config"
|
||||
"fmt"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
|
||||
"github.com/google/blueprint"
|
||||
)
|
||||
|
||||
var (
|
||||
javadoc = pctx.AndroidStaticRule("javadoc",
|
||||
blueprint.RuleParams{
|
||||
Command: `rm -rf "$outDir" "$srcJarDir" "$stubsDir" && mkdir -p "$outDir" "$srcJarDir" "$stubsDir" && ` +
|
||||
`${config.ExtractSrcJarsCmd} $srcJarDir $srcJarDir/list $srcJars && ` +
|
||||
`${config.JavadocCmd} -encoding UTF-8 @$out.rsp @$srcJarDir/list ` +
|
||||
`$opts $bootclasspathArgs $classpathArgs -sourcepath $sourcepath ` +
|
||||
`-d $outDir -quiet && ` +
|
||||
`${config.SoongZipCmd} -write_if_changed -d -o $docZip -C $outDir -D $outDir && ` +
|
||||
`${config.SoongZipCmd} -write_if_changed -jar -o $out -C $stubsDir -D $stubsDir`,
|
||||
CommandDeps: []string{
|
||||
"${config.ExtractSrcJarsCmd}",
|
||||
"${config.JavadocCmd}",
|
||||
"${config.SoongZipCmd}",
|
||||
"$JsilverJar",
|
||||
"$DoclavaJar",
|
||||
},
|
||||
Rspfile: "$out.rsp",
|
||||
RspfileContent: "$in",
|
||||
Restat: true,
|
||||
},
|
||||
"outDir", "srcJarDir", "stubsDir", "srcJars", "opts",
|
||||
"bootclasspathArgs", "classpathArgs", "sourcepath", "docZip", "JsilverJar", "DoclavaJar")
|
||||
)
|
||||
|
||||
func init() {
|
||||
android.RegisterModuleType("droiddoc", DroiddocFactory)
|
||||
android.RegisterModuleType("droiddoc_host", DroiddocHostFactory)
|
||||
android.RegisterModuleType("javadoc", JavadocFactory)
|
||||
android.RegisterModuleType("javadoc_host", JavadocHostFactory)
|
||||
}
|
||||
|
||||
type JavadocProperties struct {
|
||||
// list of source files used to compile the Java module. May be .java, .logtags, .proto,
|
||||
// or .aidl files.
|
||||
Srcs []string `android:"arch_variant"`
|
||||
|
||||
// list of directories rooted at the Android.bp file that will
|
||||
// be added to the search paths for finding source files when passing package names.
|
||||
Local_sourcepaths []string `android:"arch_variant"`
|
||||
|
||||
// list of source files that should not be used to build the Java module.
|
||||
// This is most useful in the arch/multilib variants to remove non-common files
|
||||
// filegroup or genrule can be included within this property.
|
||||
Exclude_srcs []string `android:"arch_variant"`
|
||||
|
||||
// list of of java libraries that will be in the classpath.
|
||||
Libs []string `android:"arch_variant"`
|
||||
|
||||
// If set to false, don't allow this module(-docs.zip) to be exported. Defaults to true.
|
||||
Installable *bool `android:"arch_variant"`
|
||||
|
||||
// if not blank, set to the version of the sdk to compile against
|
||||
Sdk_version *string `android:"arch_variant"`
|
||||
}
|
||||
|
||||
type DroiddocProperties struct {
|
||||
// directory relative to top of the source tree that contains doc templates files.
|
||||
Custom_template_dir *string `android:"arch_variant"`
|
||||
|
||||
// directories relative to top of the source tree which contains html/jd files.
|
||||
Html_dirs []string `android:"arch_variant"`
|
||||
|
||||
// set a value in the Clearsilver hdf namespace.
|
||||
Hdf []string `android:"arch_variant"`
|
||||
|
||||
// proofread file contains all of the text content of the javadocs concatenated into one file,
|
||||
// suitable for spell-checking and other goodness.
|
||||
Proofread_file *string `android:"arch_variant"`
|
||||
|
||||
// a todo file lists the program elements that are missing documentation.
|
||||
// At some point, this might be improved to show more warnings.
|
||||
Todo_file *string `android:"arch_variant"`
|
||||
|
||||
// local files that are used within user customized droiddoc options.
|
||||
Arg_files []string `android:"arch_variant"`
|
||||
|
||||
// user customized droiddoc args.
|
||||
// Available variables for substitution:
|
||||
//
|
||||
// $(location <label>): the path to the arg_files with name <label>
|
||||
Args *string `android:"arch_variant"`
|
||||
|
||||
// names of the output files used in args that will be generated
|
||||
Out []string `android:"arch_variant"`
|
||||
|
||||
// a list of files under current module source dir which contains known tags in Java sources.
|
||||
// filegroup or genrule can be included within this property.
|
||||
Knowntags []string `android:"arch_variant"`
|
||||
}
|
||||
|
||||
type Javadoc struct {
|
||||
android.ModuleBase
|
||||
android.DefaultableModuleBase
|
||||
|
||||
properties JavadocProperties
|
||||
|
||||
srcJars android.Paths
|
||||
srcFiles android.Paths
|
||||
sourcepaths android.Paths
|
||||
|
||||
docZip android.WritablePath
|
||||
stubsJar android.WritablePath
|
||||
}
|
||||
|
||||
type Droiddoc struct {
|
||||
Javadoc
|
||||
|
||||
properties DroiddocProperties
|
||||
}
|
||||
|
||||
func InitDroiddocModule(module android.DefaultableModule, hod android.HostOrDeviceSupported) {
|
||||
android.InitAndroidArchModule(module, hod, android.MultilibCommon)
|
||||
android.InitDefaultableModule(module)
|
||||
}
|
||||
|
||||
func JavadocFactory() android.Module {
|
||||
module := &Javadoc{}
|
||||
|
||||
module.AddProperties(&module.properties)
|
||||
|
||||
InitDroiddocModule(module, android.HostAndDeviceSupported)
|
||||
return module
|
||||
}
|
||||
|
||||
func JavadocHostFactory() android.Module {
|
||||
module := &Javadoc{}
|
||||
|
||||
module.AddProperties(&module.properties)
|
||||
|
||||
InitDroiddocModule(module, android.HostSupported)
|
||||
return module
|
||||
}
|
||||
|
||||
func DroiddocFactory() android.Module {
|
||||
module := &Droiddoc{}
|
||||
|
||||
module.AddProperties(&module.properties,
|
||||
&module.Javadoc.properties)
|
||||
|
||||
InitDroiddocModule(module, android.HostAndDeviceSupported)
|
||||
return module
|
||||
}
|
||||
|
||||
func DroiddocHostFactory() android.Module {
|
||||
module := &Droiddoc{}
|
||||
|
||||
module.AddProperties(&module.properties,
|
||||
&module.Javadoc.properties)
|
||||
|
||||
InitDroiddocModule(module, android.HostSupported)
|
||||
return module
|
||||
}
|
||||
|
||||
func (j *Javadoc) addDeps(ctx android.BottomUpMutatorContext) {
|
||||
if ctx.Device() {
|
||||
sdkDep := decodeSdkDep(ctx, String(j.properties.Sdk_version))
|
||||
if sdkDep.useDefaultLibs {
|
||||
ctx.AddDependency(ctx.Module(), bootClasspathTag, config.DefaultBootclasspathLibraries...)
|
||||
ctx.AddDependency(ctx.Module(), libTag, []string{"ext", "framework"}...)
|
||||
} else if sdkDep.useModule {
|
||||
ctx.AddDependency(ctx.Module(), bootClasspathTag, sdkDep.module)
|
||||
}
|
||||
}
|
||||
|
||||
ctx.AddDependency(ctx.Module(), libTag, j.properties.Libs...)
|
||||
|
||||
android.ExtractSourcesDeps(ctx, j.properties.Srcs)
|
||||
|
||||
// exclude_srcs may contain filegroup or genrule.
|
||||
android.ExtractSourcesDeps(ctx, j.properties.Exclude_srcs)
|
||||
}
|
||||
|
||||
func (j *Javadoc) collectDeps(ctx android.ModuleContext) deps {
|
||||
var deps deps
|
||||
|
||||
sdkDep := decodeSdkDep(ctx, String(j.properties.Sdk_version))
|
||||
if sdkDep.invalidVersion {
|
||||
ctx.AddMissingDependencies([]string{sdkDep.module})
|
||||
} else if sdkDep.useFiles {
|
||||
deps.bootClasspath = append(deps.bootClasspath, sdkDep.jar)
|
||||
}
|
||||
|
||||
ctx.VisitDirectDeps(func(module android.Module) {
|
||||
otherName := ctx.OtherModuleName(module)
|
||||
tag := ctx.OtherModuleDependencyTag(module)
|
||||
|
||||
switch dep := module.(type) {
|
||||
case Dependency:
|
||||
switch tag {
|
||||
case bootClasspathTag:
|
||||
deps.bootClasspath = append(deps.bootClasspath, dep.ImplementationJars()...)
|
||||
case libTag:
|
||||
deps.classpath = append(deps.classpath, dep.ImplementationJars()...)
|
||||
default:
|
||||
panic(fmt.Errorf("unknown dependency %q for %q", otherName, ctx.ModuleName()))
|
||||
}
|
||||
case android.SourceFileProducer:
|
||||
switch tag {
|
||||
case libTag:
|
||||
checkProducesJars(ctx, dep)
|
||||
deps.classpath = append(deps.classpath, dep.Srcs()...)
|
||||
case android.DefaultsDepTag, android.SourceDepTag:
|
||||
// Nothing to do
|
||||
default:
|
||||
ctx.ModuleErrorf("dependency on genrule %q may only be in srcs, libs", otherName)
|
||||
}
|
||||
default:
|
||||
switch tag {
|
||||
case android.DefaultsDepTag, android.SourceDepTag:
|
||||
// Nothing to do
|
||||
default:
|
||||
ctx.ModuleErrorf("depends on non-java module %q", otherName)
|
||||
}
|
||||
}
|
||||
})
|
||||
// do not pass exclude_srcs directly when expanding srcFiles since exclude_srcs
|
||||
// may contain filegroup or genrule.
|
||||
srcFiles := ctx.ExpandSources(j.properties.Srcs, j.properties.Exclude_srcs)
|
||||
|
||||
// srcs may depend on some genrule output.
|
||||
j.srcJars = srcFiles.FilterByExt(".srcjar")
|
||||
j.srcFiles = srcFiles.FilterOutByExt(".srcjar")
|
||||
|
||||
j.docZip = android.PathForModuleOut(ctx, ctx.ModuleName()+"-"+"docs.zip")
|
||||
j.stubsJar = android.PathForModuleOut(ctx, ctx.ModuleName()+"-"+"stubs.jar")
|
||||
|
||||
if j.properties.Local_sourcepaths == nil {
|
||||
j.properties.Local_sourcepaths = append(j.properties.Local_sourcepaths, ".")
|
||||
}
|
||||
j.sourcepaths = android.PathsForModuleSrc(ctx, j.properties.Local_sourcepaths)
|
||||
j.sourcepaths = append(j.sourcepaths, deps.bootClasspath...)
|
||||
j.sourcepaths = append(j.sourcepaths, deps.classpath...)
|
||||
|
||||
return deps
|
||||
}
|
||||
|
||||
func (j *Javadoc) DepsMutator(ctx android.BottomUpMutatorContext) {
|
||||
j.addDeps(ctx)
|
||||
}
|
||||
|
||||
func (j *Javadoc) GenerateAndroidBuildActions(ctx android.ModuleContext) {
|
||||
deps := j.collectDeps(ctx)
|
||||
|
||||
var implicits android.Paths
|
||||
implicits = append(implicits, deps.bootClasspath...)
|
||||
implicits = append(implicits, deps.classpath...)
|
||||
|
||||
var bootClasspathArgs, classpathArgs string
|
||||
if ctx.Config().UseOpenJDK9() {
|
||||
if len(deps.bootClasspath) > 0 {
|
||||
// For OpenJDK 9 we use --patch-module to define the core libraries code.
|
||||
// TODO(tobiast): Reorganize this when adding proper support for OpenJDK 9
|
||||
// modules. Here we treat all code in core libraries as being in java.base
|
||||
// to work around the OpenJDK 9 module system. http://b/62049770
|
||||
bootClasspathArgs = "--patch-module=java.base=" + strings.Join(deps.bootClasspath.Strings(), ":")
|
||||
}
|
||||
} else {
|
||||
if len(deps.bootClasspath.Strings()) > 0 {
|
||||
// For OpenJDK 8 we can use -bootclasspath to define the core libraries code.
|
||||
bootClasspathArgs = deps.bootClasspath.FormJavaClassPath("-bootclasspath")
|
||||
}
|
||||
}
|
||||
if len(deps.classpath.Strings()) > 0 {
|
||||
classpathArgs = "-classpath " + strings.Join(deps.classpath.Strings(), ":")
|
||||
}
|
||||
|
||||
implicits = append(implicits, j.srcJars...)
|
||||
|
||||
opts := "-J-Xmx1024m -XDignore.symbol.file -Xdoclint:none"
|
||||
|
||||
ctx.Build(pctx, android.BuildParams{
|
||||
Rule: javadoc,
|
||||
Description: "Javadoc",
|
||||
Output: j.stubsJar,
|
||||
ImplicitOutput: j.docZip,
|
||||
Inputs: j.srcFiles,
|
||||
Implicits: implicits,
|
||||
Args: map[string]string{
|
||||
"outDir": android.PathForModuleOut(ctx, "docs", "out").String(),
|
||||
"srcJarDir": android.PathForModuleOut(ctx, "docs", "srcjars").String(),
|
||||
"stubsDir": android.PathForModuleOut(ctx, "docs", "stubsDir").String(),
|
||||
"srcJars": strings.Join(j.srcJars.Strings(), " "),
|
||||
"opts": opts,
|
||||
"bootClasspathArgs": bootClasspathArgs,
|
||||
"classpathArgs": classpathArgs,
|
||||
"sourcepath": strings.Join(j.sourcepaths.Strings(), ":"),
|
||||
"docZip": j.docZip.String(),
|
||||
},
|
||||
})
|
||||
}
|
||||
|
||||
func (d *Droiddoc) DepsMutator(ctx android.BottomUpMutatorContext) {
|
||||
d.Javadoc.addDeps(ctx)
|
||||
|
||||
// extra_arg_files may contains filegroup or genrule.
|
||||
android.ExtractSourcesDeps(ctx, d.properties.Arg_files)
|
||||
|
||||
// knowntags may contain filegroup or genrule.
|
||||
android.ExtractSourcesDeps(ctx, d.properties.Knowntags)
|
||||
}
|
||||
|
||||
func (d *Droiddoc) GenerateAndroidBuildActions(ctx android.ModuleContext) {
|
||||
deps := d.Javadoc.collectDeps(ctx)
|
||||
|
||||
var implicits android.Paths
|
||||
implicits = append(implicits, deps.bootClasspath...)
|
||||
implicits = append(implicits, deps.classpath...)
|
||||
|
||||
argFiles := ctx.ExpandSources(d.properties.Arg_files, nil)
|
||||
argFilesMap := map[string]android.Path{}
|
||||
|
||||
for _, f := range argFiles {
|
||||
implicits = append(implicits, f)
|
||||
if _, exists := argFilesMap[f.Rel()]; !exists {
|
||||
argFilesMap[f.Rel()] = f
|
||||
} else {
|
||||
ctx.ModuleErrorf("multiple arg_files for %q, %q and %q",
|
||||
f, argFilesMap[f.Rel()], f.Rel())
|
||||
}
|
||||
}
|
||||
|
||||
args, err := android.Expand(String(d.properties.Args), func(name string) (string, error) {
|
||||
if strings.HasPrefix(name, "location ") {
|
||||
label := strings.TrimSpace(strings.TrimPrefix(name, "location "))
|
||||
if f, ok := argFilesMap[label]; ok {
|
||||
return f.String(), nil
|
||||
} else {
|
||||
return "", fmt.Errorf("unknown location label %q", label)
|
||||
}
|
||||
} else if name == "genDir" {
|
||||
return android.PathForModuleGen(ctx).String(), nil
|
||||
}
|
||||
return "", fmt.Errorf("unknown variable '$(%s)'", name)
|
||||
})
|
||||
|
||||
if err != nil {
|
||||
ctx.PropertyErrorf("extra_args", "%s", err.Error())
|
||||
return
|
||||
}
|
||||
|
||||
var bootClasspathArgs, classpathArgs string
|
||||
if len(deps.bootClasspath.Strings()) > 0 {
|
||||
bootClasspathArgs = "-bootclasspath " + strings.Join(deps.bootClasspath.Strings(), ":")
|
||||
}
|
||||
if len(deps.classpath.Strings()) > 0 {
|
||||
classpathArgs = "-classpath " + strings.Join(deps.classpath.Strings(), ":")
|
||||
}
|
||||
|
||||
// templateDir (maybe missing) is relative to top of the source tree instead of current module.
|
||||
templateDir := android.PathsForSource(ctx, []string{String(d.properties.Custom_template_dir)})
|
||||
if len(templateDir) > 0 {
|
||||
implicits = append(implicits, ctx.GlobFiles(filepath.Join(templateDir[0].String(), "**/*"), nil)...)
|
||||
}
|
||||
|
||||
var htmlDirArgs string
|
||||
if len(d.properties.Html_dirs) > 0 {
|
||||
// htmlDir is relative to top of the source tree instead of current module.
|
||||
htmlDir := android.PathForSource(ctx, d.properties.Html_dirs[0]).String()
|
||||
implicits = append(implicits, ctx.GlobFiles(filepath.Join(htmlDir, "**/*"), nil)...)
|
||||
htmlDirArgs = "-htmldir " + htmlDir
|
||||
}
|
||||
|
||||
var htmlDir2Args string
|
||||
if len(d.properties.Html_dirs) > 1 {
|
||||
// htmlDir2 is relative to top of the source tree instead of current module.
|
||||
htmlDir2 := android.PathForSource(ctx, d.properties.Html_dirs[1]).String()
|
||||
implicits = append(implicits, ctx.GlobFiles(filepath.Join(htmlDir2, "**/*"), nil)...)
|
||||
htmlDirArgs = "-htmldir2 " + htmlDir2
|
||||
}
|
||||
|
||||
knownTags := ctx.ExpandSources(d.properties.Knowntags, nil)
|
||||
implicits = append(implicits, knownTags...)
|
||||
|
||||
for _, kt := range knownTags {
|
||||
args = args + " -knowntags " + kt.String()
|
||||
}
|
||||
for _, hdf := range d.properties.Hdf {
|
||||
args = args + " -hdf " + hdf
|
||||
}
|
||||
|
||||
if String(d.properties.Proofread_file) != "" {
|
||||
proofreadFile := android.PathForModuleOut(ctx, String(d.properties.Proofread_file))
|
||||
args = args + " -proofread " + proofreadFile.String()
|
||||
}
|
||||
if String(d.properties.Todo_file) != "" {
|
||||
// tricky part:
|
||||
// we should not compute full path for todo_file through PathForModuleOut().
|
||||
// the non-standard doclet will get the full path relative to "-o".
|
||||
args = args + " -todo " + String(d.properties.Todo_file)
|
||||
}
|
||||
|
||||
implicits = append(implicits, d.Javadoc.srcJars...)
|
||||
|
||||
opts := "-source 1.8 -J-Xmx1600m -J-XX:-OmitStackTraceInFastThrow -XDignore.symbol.file " +
|
||||
"-doclet com.google.doclava.Doclava -docletpath ${config.JsilverJar}:${config.DoclavaJar} " +
|
||||
"-templatedir " + String(d.properties.Custom_template_dir) + " " + htmlDirArgs + " " + htmlDir2Args + " " +
|
||||
"-hdf page.build " + ctx.Config().BuildId() + "-" + ctx.Config().BuildNumberFromFile() + " " +
|
||||
"-hdf page.now " + `"$$(date -d @$$(cat ` + ctx.Config().Getenv("BUILD_DATETIME_FILE") + `) "+%d %b %Y %k:%M")"` + " " +
|
||||
args + " -stubs " + android.PathForModuleOut(ctx, "docs", "stubsDir").String()
|
||||
|
||||
var implicitOutputs android.WritablePaths
|
||||
implicitOutputs = append(implicitOutputs, d.Javadoc.docZip)
|
||||
for _, o := range d.properties.Out {
|
||||
implicitOutputs = append(implicitOutputs, android.PathForModuleGen(ctx, o))
|
||||
}
|
||||
|
||||
ctx.Build(pctx, android.BuildParams{
|
||||
Rule: javadoc,
|
||||
Description: "Droiddoc",
|
||||
Output: d.Javadoc.stubsJar,
|
||||
Inputs: d.Javadoc.srcFiles,
|
||||
Implicits: implicits,
|
||||
ImplicitOutputs: implicitOutputs,
|
||||
Args: map[string]string{
|
||||
"outDir": android.PathForModuleOut(ctx, "docs", "out").String(),
|
||||
"srcJarDir": android.PathForModuleOut(ctx, "docs", "srcjars").String(),
|
||||
"stubsDir": android.PathForModuleOut(ctx, "docs", "stubsDir").String(),
|
||||
"srcJars": strings.Join(d.Javadoc.srcJars.Strings(), " "),
|
||||
"opts": opts,
|
||||
"bootclasspathArgs": bootClasspathArgs,
|
||||
"classpathArgs": classpathArgs,
|
||||
"sourcepath": strings.Join(d.Javadoc.sourcepaths.Strings(), ":"),
|
||||
"docZip": d.Javadoc.docZip.String(),
|
||||
"JsilverJar": "${config.JsilverJar}",
|
||||
"DoclavaJar": "${config.DoclavaJar}",
|
||||
},
|
||||
})
|
||||
}
|
10
java/java.go
10
java/java.go
|
@ -538,8 +538,8 @@ func (j *Module) aidlFlags(ctx android.ModuleContext, aidlPreprocess android.Opt
|
|||
}
|
||||
|
||||
type deps struct {
|
||||
classpath android.Paths
|
||||
bootClasspath android.Paths
|
||||
classpath classpath
|
||||
bootClasspath classpath
|
||||
staticJars android.Paths
|
||||
staticHeaderJars android.Paths
|
||||
staticJarResources android.Paths
|
||||
|
@ -688,8 +688,8 @@ func (j *Module) collectBuilderFlags(ctx android.ModuleContext, deps deps) javaB
|
|||
}
|
||||
|
||||
// classpath
|
||||
flags.bootClasspath.AddPaths(deps.bootClasspath)
|
||||
flags.classpath.AddPaths(deps.classpath)
|
||||
flags.bootClasspath = append(flags.bootClasspath, deps.bootClasspath...)
|
||||
flags.classpath = append(flags.classpath, deps.classpath...)
|
||||
|
||||
if len(flags.bootClasspath) == 0 && ctx.Host() && !ctx.Config().TargetOpenJDK9() &&
|
||||
!Bool(j.properties.No_standard_libs) &&
|
||||
|
@ -836,7 +836,7 @@ func (j *Module) compile(ctx android.ModuleContext, extraSrcJars ...android.Path
|
|||
}
|
||||
|
||||
if enable_sharding {
|
||||
flags.classpath.AddPaths([]android.Path{j.headerJarFile})
|
||||
flags.classpath = append(flags.classpath, j.headerJarFile)
|
||||
shardSize := int(*(j.properties.Javac_shard_size))
|
||||
var shardSrcs []android.Paths
|
||||
if len(uniqueSrcFiles) > 0 {
|
||||
|
|
|
@ -79,6 +79,8 @@ func testContext(config android.Config, bp string,
|
|||
ctx.RegisterModuleType("java_genrule", android.ModuleFactoryAdaptor(genRuleFactory))
|
||||
ctx.RegisterModuleType("filegroup", android.ModuleFactoryAdaptor(genrule.FileGroupFactory))
|
||||
ctx.RegisterModuleType("genrule", android.ModuleFactoryAdaptor(genrule.GenRuleFactory))
|
||||
ctx.RegisterModuleType("droiddoc", android.ModuleFactoryAdaptor(DroiddocFactory))
|
||||
ctx.RegisterModuleType("droiddoc_host", android.ModuleFactoryAdaptor(DroiddocHostFactory))
|
||||
ctx.PreArchMutators(android.RegisterPrebuiltsPreArchMutators)
|
||||
ctx.PreArchMutators(android.RegisterPrebuiltsPostDepsMutators)
|
||||
ctx.PreArchMutators(android.RegisterDefaultsPreArchMutators)
|
||||
|
@ -168,6 +170,11 @@ func testContext(config android.Config, bp string,
|
|||
|
||||
"jdk8/jre/lib/jce.jar": nil,
|
||||
"jdk8/jre/lib/rt.jar": nil,
|
||||
|
||||
"bar-doc/a.java": nil,
|
||||
"bar-doc/b.java": nil,
|
||||
"bar-doc/known_oj_tags.txt": nil,
|
||||
"external/doclava/templates-sdk": nil,
|
||||
}
|
||||
|
||||
for k, v := range fs {
|
||||
|
@ -856,6 +863,36 @@ func TestSharding(t *testing.T) {
|
|||
}
|
||||
}
|
||||
|
||||
func TestDroiddoc(t *testing.T) {
|
||||
ctx := testJava(t, `
|
||||
droiddoc {
|
||||
name: "bar-doc",
|
||||
srcs: [
|
||||
"bar-doc/*.java",
|
||||
],
|
||||
exclude_srcs: [
|
||||
"bar-doc/b.java"
|
||||
],
|
||||
custom_template_dir: "external/doclava/templates-sdk",
|
||||
hdf: [
|
||||
"android.whichdoc offline",
|
||||
],
|
||||
knowntags: [
|
||||
"bar-doc/known_oj_tags.txt",
|
||||
],
|
||||
proofread_file: "libcore-proofread.txt",
|
||||
todo_file: "libcore-docs-todo.html",
|
||||
args: "-offlinemode -title \"libcore\"",
|
||||
}
|
||||
`)
|
||||
|
||||
stubsJar := filepath.Join(buildDir, ".intermediates", "bar-doc", "android_common", "bar-doc-stubs.jar")
|
||||
barDoc := ctx.ModuleForTests("bar-doc", "android_common").Output("bar-doc-stubs.jar")
|
||||
if stubsJar != barDoc.Output.String() {
|
||||
t.Errorf("expected stubs Jar [%q], got %q", stubsJar, barDoc.Output.String())
|
||||
}
|
||||
}
|
||||
|
||||
func TestJarGenrules(t *testing.T) {
|
||||
ctx := testJava(t, `
|
||||
java_library {
|
||||
|
|
Loading…
Reference in New Issue