blob: 7a6cc4ffc9b131e2b45d44f219aadd2bb67f5864 [file] [log] [blame]
Colin Cross068e0fe2016-12-13 15:23:47 -08001// Copyright 2016 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
Pirama Arumuga Nainar955dc492018-04-17 14:58:42 -070015package android
Colin Cross068e0fe2016-12-13 15:23:47 -080016
17import (
Jingwen Chen30f5aaa2020-11-19 05:38:02 -050018 "android/soong/bazel"
Colin Crossd91d7ac2017-09-12 22:52:12 -070019 "strings"
Jingwen Chen32b4ece2021-01-21 03:20:18 -050020
21 "github.com/google/blueprint/proptools"
Colin Cross068e0fe2016-12-13 15:23:47 -080022)
23
24func init() {
Pirama Arumuga Nainar955dc492018-04-17 14:58:42 -070025 RegisterModuleType("filegroup", FileGroupFactory)
Jingwen Chena42d6412021-01-26 21:57:27 -050026 RegisterBp2BuildMutator("filegroup", FilegroupBp2Build)
Jingwen Chen32b4ece2021-01-21 03:20:18 -050027}
28
29// https://docs.bazel.build/versions/master/be/general.html#filegroup
30type bazelFilegroupAttributes struct {
31 Name *string
Liz Kammer356f7d42021-01-26 09:18:53 -050032 Srcs bazel.LabelList
Jingwen Chen32b4ece2021-01-21 03:20:18 -050033}
34
35type bazelFilegroup struct {
36 BazelTargetModuleBase
37 bazelFilegroupAttributes
38}
39
40func BazelFileGroupFactory() Module {
41 module := &bazelFilegroup{}
42 module.AddProperties(&module.bazelFilegroupAttributes)
43 InitBazelTargetModule(module)
44 return module
45}
46
47func (bfg *bazelFilegroup) Name() string {
48 return bfg.BaseModuleName()
49}
50
51func (bfg *bazelFilegroup) GenerateAndroidBuildActions(ctx ModuleContext) {}
52
53// TODO: Create helper functions to avoid this boilerplate.
Jingwen Chena42d6412021-01-26 21:57:27 -050054func FilegroupBp2Build(ctx TopDownMutatorContext) {
Liz Kammer356f7d42021-01-26 09:18:53 -050055 fg, ok := ctx.Module().(*fileGroup)
56 if !ok {
57 return
Jingwen Chen32b4ece2021-01-21 03:20:18 -050058 }
Liz Kammer356f7d42021-01-26 09:18:53 -050059
60 name := "__bp2build__" + fg.base().BaseModuleName()
61 ctx.CreateModule(BazelFileGroupFactory, &bazelFilegroupAttributes{
62 Name: proptools.StringPtr(name),
63 Srcs: BazelLabelForModuleSrcExcludes(ctx, fg.properties.Srcs, fg.properties.Exclude_srcs),
64 }, &bazel.BazelTargetModuleProperties{
65 Rule_class: "filegroup",
66 })
Colin Cross068e0fe2016-12-13 15:23:47 -080067}
68
69type fileGroupProperties struct {
70 // srcs lists files that will be included in this filegroup
Colin Cross27b922f2019-03-04 22:35:41 -080071 Srcs []string `android:"path"`
Colin Cross068e0fe2016-12-13 15:23:47 -080072
Colin Cross27b922f2019-03-04 22:35:41 -080073 Exclude_srcs []string `android:"path"`
Colin Crossfaeb7aa2017-02-01 14:12:44 -080074
75 // The base path to the files. May be used by other modules to determine which portion
76 // of the path to use. For example, when a filegroup is used as data in a cc_test rule,
77 // the base path is stripped off the path and the remaining path is used as the
78 // installation directory.
Nan Zhangea568a42017-11-08 21:20:04 -080079 Path *string
Colin Crossd91d7ac2017-09-12 22:52:12 -070080
81 // Create a make variable with the specified name that contains the list of files in the
82 // filegroup, relative to the root of the source tree.
Nan Zhangea568a42017-11-08 21:20:04 -080083 Export_to_make_var *string
Jingwen Chen30f5aaa2020-11-19 05:38:02 -050084
85 // Properties for Bazel migration purposes.
86 bazel.Properties
Colin Cross068e0fe2016-12-13 15:23:47 -080087}
88
89type fileGroup struct {
Pirama Arumuga Nainar955dc492018-04-17 14:58:42 -070090 ModuleBase
Colin Cross068e0fe2016-12-13 15:23:47 -080091 properties fileGroupProperties
Pirama Arumuga Nainar955dc492018-04-17 14:58:42 -070092 srcs Paths
Colin Cross068e0fe2016-12-13 15:23:47 -080093}
94
Pirama Arumuga Nainar955dc492018-04-17 14:58:42 -070095var _ SourceFileProducer = (*fileGroup)(nil)
Colin Cross068e0fe2016-12-13 15:23:47 -080096
Patrice Arruda8958a942019-03-12 10:06:00 -070097// filegroup contains a list of files that are referenced by other modules
98// properties (such as "srcs") using the syntax ":<name>". filegroup are
99// also be used to export files across package boundaries.
Pirama Arumuga Nainar955dc492018-04-17 14:58:42 -0700100func FileGroupFactory() Module {
Colin Cross068e0fe2016-12-13 15:23:47 -0800101 module := &fileGroup{}
Colin Cross36242852017-06-23 15:06:31 -0700102 module.AddProperties(&module.properties)
Pirama Arumuga Nainar955dc492018-04-17 14:58:42 -0700103 InitAndroidModule(module)
Colin Cross36242852017-06-23 15:06:31 -0700104 return module
Colin Cross068e0fe2016-12-13 15:23:47 -0800105}
106
Pirama Arumuga Nainar955dc492018-04-17 14:58:42 -0700107func (fg *fileGroup) GenerateAndroidBuildActions(ctx ModuleContext) {
Colin Cross8a497952019-03-05 22:25:09 -0800108 fg.srcs = PathsForModuleSrcExcludes(ctx, fg.properties.Srcs, fg.properties.Exclude_srcs)
Colin Cross2fafa3e2019-03-05 12:39:51 -0800109
110 if fg.properties.Path != nil {
111 fg.srcs = PathsWithModuleSrcSubDir(ctx, fg.srcs, String(fg.properties.Path))
112 }
Colin Cross068e0fe2016-12-13 15:23:47 -0800113}
114
Pirama Arumuga Nainar955dc492018-04-17 14:58:42 -0700115func (fg *fileGroup) Srcs() Paths {
116 return append(Paths{}, fg.srcs...)
Colin Cross068e0fe2016-12-13 15:23:47 -0800117}
Colin Crossd91d7ac2017-09-12 22:52:12 -0700118
Dan Willemsen6a6478d2020-07-17 19:28:53 -0700119func (fg *fileGroup) MakeVars(ctx MakeVarsModuleContext) {
120 if makeVar := String(fg.properties.Export_to_make_var); makeVar != "" {
121 ctx.StrictRaw(makeVar, strings.Join(fg.srcs.Strings(), " "))
Colin Crossd91d7ac2017-09-12 22:52:12 -0700122 }
123}