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.RegisterParallelSingletonType("jdeps_generator", jDepsGeneratorSingleton) 30} 31 32func jDepsGeneratorSingleton() android.Singleton { 33 return &jdepsGeneratorSingleton{} 34} 35 36type jdepsGeneratorSingleton struct { 37 outputPath android.Path 38} 39 40const ( 41 jdepsJsonFileName = "module_bp_java_deps.json" 42) 43 44func (j *jdepsGeneratorSingleton) GenerateBuildActions(ctx android.SingletonContext) { 45 // (b/204397180) Generate module_bp_java_deps.json by default. 46 moduleInfos := make(map[string]android.IdeInfo) 47 48 ctx.VisitAllModuleProxies(func(module android.ModuleProxy) { 49 if !android.OtherModulePointerProviderOrDefault(ctx, module, android.CommonModuleInfoProvider).Enabled { 50 return 51 } 52 53 // Prevent including both prebuilts and matching source modules when one replaces the other. 54 if !android.IsModulePreferredProxy(ctx, module) { 55 return 56 } 57 58 ideInfoProvider, ok := android.OtherModuleProvider(ctx, module, android.IdeInfoProviderKey) 59 if !ok { 60 return 61 } 62 name := ideInfoProvider.BaseModuleName 63 if info, ok := android.OtherModuleProvider(ctx, module, JavaLibraryInfoProvider); ok && info.Prebuilt { 64 // TODO(b/113562217): Extract the base module name from the Import name, often the Import name 65 // has a prefix "prebuilt_". Remove the prefix explicitly if needed until we find a better 66 // solution to get the Import name. 67 name = android.RemoveOptionalPrebuiltPrefix(module.Name()) 68 } 69 70 dpInfo := moduleInfos[name] 71 dpInfo = dpInfo.Merge(ideInfoProvider) 72 dpInfo.Paths = []string{ctx.ModuleDir(module)} 73 moduleInfos[name] = dpInfo 74 75 mkProvider, ok := android.OtherModuleProvider(ctx, module, android.AndroidMkDataInfoProvider) 76 if !ok { 77 return 78 } 79 if mkProvider.Class != "" { 80 dpInfo.Classes = append(dpInfo.Classes, mkProvider.Class) 81 } 82 83 if dep, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider); ok { 84 dpInfo.Installed_paths = append(dpInfo.Installed_paths, dep.ImplementationJars.Strings()...) 85 } 86 dpInfo.Classes = android.FirstUniqueStrings(dpInfo.Classes) 87 dpInfo.Installed_paths = android.FirstUniqueStrings(dpInfo.Installed_paths) 88 moduleInfos[name] = dpInfo 89 }) 90 91 jfpath := android.PathForOutput(ctx, jdepsJsonFileName) 92 err := createJsonFile(moduleInfos, jfpath) 93 if err != nil { 94 ctx.Errorf(err.Error()) 95 } 96 j.outputPath = jfpath 97 98 // This is necessary to satisfy the dangling rules check as this file is written by Soong rather than a rule. 99 ctx.Build(pctx, android.BuildParams{ 100 Rule: android.Touch, 101 Output: jfpath, 102 }) 103 ctx.DistForGoals([]string{"general-tests", "dist_files"}, j.outputPath) 104} 105 106func createJsonFile(moduleInfos map[string]android.IdeInfo, jfpath android.WritablePath) error { 107 buf, err := json.MarshalIndent(moduleInfos, "", "\t") 108 if err != nil { 109 return fmt.Errorf("JSON marshal of java deps failed: %s", err) 110 } 111 err = android.WriteFileToOutputDir(jfpath, buf, 0666) 112 if err != nil { 113 return fmt.Errorf("Writing java deps to %s failed: %s", jfpath.String(), err) 114 } 115 return nil 116} 117