1// Copyright 2018 Google Inc. All rights reserved.
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15package java
16
17import (
18	"encoding/json"
19	"fmt"
20
21	"android/soong/android"
22)
23
24// This singleton generates android java dependency into to a json file. It does so for each
25// blueprint Android.bp resulting in a java.Module when either make, mm, mma, mmm or mmma is
26// called. Dependency info file is generated in $OUT/module_bp_java_depend.json.
27
28func init() {
29	android.RegisterSingletonType("jdeps_generator", jDepsGeneratorSingleton)
30}
31
32func jDepsGeneratorSingleton() android.Singleton {
33	return &jdepsGeneratorSingleton{}
34}
35
36type jdepsGeneratorSingleton struct {
37	outputPath android.Path
38}
39
40var _ android.SingletonMakeVarsProvider = (*jdepsGeneratorSingleton)(nil)
41
42const (
43	// Environment variables used to modify behavior of this singleton.
44	envVariableCollectJavaDeps = "SOONG_COLLECT_JAVA_DEPS"
45	jdepsJsonFileName          = "module_bp_java_deps.json"
46)
47
48func (j *jdepsGeneratorSingleton) GenerateBuildActions(ctx android.SingletonContext) {
49	if !ctx.Config().IsEnvTrue(envVariableCollectJavaDeps) {
50		return
51	}
52
53	moduleInfos := make(map[string]android.IdeInfo)
54
55	ctx.VisitAllModules(func(module android.Module) {
56		if !module.Enabled() {
57			return
58		}
59
60		ideInfoProvider, ok := module.(android.IDEInfo)
61		if !ok {
62			return
63		}
64		name := ideInfoProvider.BaseModuleName()
65		ideModuleNameProvider, ok := module.(android.IDECustomizedModuleName)
66		if ok {
67			name = ideModuleNameProvider.IDECustomizedModuleName()
68		}
69
70		dpInfo := moduleInfos[name]
71		ideInfoProvider.IDEInfo(&dpInfo)
72		dpInfo.Deps = android.FirstUniqueStrings(dpInfo.Deps)
73		dpInfo.Srcs = android.FirstUniqueStrings(dpInfo.Srcs)
74		dpInfo.Aidl_include_dirs = android.FirstUniqueStrings(dpInfo.Aidl_include_dirs)
75		dpInfo.Jarjar_rules = android.FirstUniqueStrings(dpInfo.Jarjar_rules)
76		dpInfo.Jars = android.FirstUniqueStrings(dpInfo.Jars)
77		dpInfo.SrcJars = android.FirstUniqueStrings(dpInfo.SrcJars)
78		dpInfo.Paths = android.FirstUniqueStrings(dpInfo.Paths)
79		moduleInfos[name] = dpInfo
80
81		mkProvider, ok := module.(android.AndroidMkDataProvider)
82		if !ok {
83			return
84		}
85		data := mkProvider.AndroidMk()
86		if data.Class != "" {
87			dpInfo.Classes = append(dpInfo.Classes, data.Class)
88		}
89
90		if ctx.ModuleHasProvider(module, JavaInfoProvider) {
91			dep := ctx.ModuleProvider(module, JavaInfoProvider).(JavaInfo)
92			dpInfo.Installed_paths = append(dpInfo.Installed_paths, dep.ImplementationJars.Strings()...)
93		}
94		dpInfo.Classes = android.FirstUniqueStrings(dpInfo.Classes)
95		dpInfo.Installed_paths = android.FirstUniqueStrings(dpInfo.Installed_paths)
96		moduleInfos[name] = dpInfo
97	})
98
99	jfpath := android.PathForOutput(ctx, jdepsJsonFileName)
100	err := createJsonFile(moduleInfos, jfpath)
101	if err != nil {
102		ctx.Errorf(err.Error())
103	}
104	j.outputPath = jfpath
105
106	// This is necessary to satisfy the dangling rules check as this file is written by Soong rather than a rule.
107	ctx.Build(pctx, android.BuildParams{
108		Rule:   android.Touch,
109		Output: jfpath,
110	})
111}
112
113func (j *jdepsGeneratorSingleton) MakeVars(ctx android.MakeVarsContext) {
114	if j.outputPath == nil {
115		return
116	}
117
118	ctx.DistForGoal("general-tests", j.outputPath)
119}
120
121func createJsonFile(moduleInfos map[string]android.IdeInfo, jfpath android.WritablePath) error {
122	buf, err := json.MarshalIndent(moduleInfos, "", "\t")
123	if err != nil {
124		return fmt.Errorf("JSON marshal of java deps failed: %s", err)
125	}
126	err = android.WriteFileToOutputDir(jfpath, buf, 0666)
127	if err != nil {
128		return fmt.Errorf("Writing java deps to %s failed: %s", jfpath.String(), err)
129	}
130	return nil
131}
132