blob: f75076f0298e36af8c9c4bd6c7220e39fdb74802 [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"
Colin Cross068e0fe2016-12-13 15:23:47 -080020)
21
22func init() {
Pirama Arumuga Nainar955dc492018-04-17 14:58:42 -070023 RegisterModuleType("filegroup", FileGroupFactory)
Jingwen Chena42d6412021-01-26 21:57:27 -050024 RegisterBp2BuildMutator("filegroup", FilegroupBp2Build)
Jingwen Chen32b4ece2021-01-21 03:20:18 -050025}
26
27// https://docs.bazel.build/versions/master/be/general.html#filegroup
28type bazelFilegroupAttributes struct {
Liz Kammer356f7d42021-01-26 09:18:53 -050029 Srcs bazel.LabelList
Jingwen Chen32b4ece2021-01-21 03:20:18 -050030}
31
32type bazelFilegroup struct {
33 BazelTargetModuleBase
34 bazelFilegroupAttributes
35}
36
37func BazelFileGroupFactory() Module {
38 module := &bazelFilegroup{}
39 module.AddProperties(&module.bazelFilegroupAttributes)
40 InitBazelTargetModule(module)
41 return module
42}
43
44func (bfg *bazelFilegroup) Name() string {
45 return bfg.BaseModuleName()
46}
47
48func (bfg *bazelFilegroup) GenerateAndroidBuildActions(ctx ModuleContext) {}
49
Jingwen Chena42d6412021-01-26 21:57:27 -050050func FilegroupBp2Build(ctx TopDownMutatorContext) {
Liz Kammer356f7d42021-01-26 09:18:53 -050051 fg, ok := ctx.Module().(*fileGroup)
Liz Kammerea6666f2021-02-17 10:17:28 -050052 if !ok || !fg.ConvertWithBp2build() {
Liz Kammer356f7d42021-01-26 09:18:53 -050053 return
Jingwen Chen32b4ece2021-01-21 03:20:18 -050054 }
Jingwen Chen77e8b7b2021-02-05 03:03:24 -050055
Jingwen Chen1fd14692021-02-05 03:01:50 -050056 attrs := &bazelFilegroupAttributes{
Liz Kammer356f7d42021-01-26 09:18:53 -050057 Srcs: BazelLabelForModuleSrcExcludes(ctx, fg.properties.Srcs, fg.properties.Exclude_srcs),
Jingwen Chen1fd14692021-02-05 03:01:50 -050058 }
59
Jingwen Chenfb4692a2021-02-07 10:05:16 -050060 props := bazel.NewBazelTargetModuleProperties(fg.Name(), "filegroup", "")
Jingwen Chen1fd14692021-02-05 03:01:50 -050061
62 ctx.CreateBazelTargetModule(BazelFileGroupFactory, props, attrs)
Colin Cross068e0fe2016-12-13 15:23:47 -080063}
64
65type fileGroupProperties struct {
66 // srcs lists files that will be included in this filegroup
Colin Cross27b922f2019-03-04 22:35:41 -080067 Srcs []string `android:"path"`
Colin Cross068e0fe2016-12-13 15:23:47 -080068
Colin Cross27b922f2019-03-04 22:35:41 -080069 Exclude_srcs []string `android:"path"`
Colin Crossfaeb7aa2017-02-01 14:12:44 -080070
71 // The base path to the files. May be used by other modules to determine which portion
72 // of the path to use. For example, when a filegroup is used as data in a cc_test rule,
73 // the base path is stripped off the path and the remaining path is used as the
74 // installation directory.
Nan Zhangea568a42017-11-08 21:20:04 -080075 Path *string
Colin Crossd91d7ac2017-09-12 22:52:12 -070076
77 // Create a make variable with the specified name that contains the list of files in the
78 // filegroup, relative to the root of the source tree.
Nan Zhangea568a42017-11-08 21:20:04 -080079 Export_to_make_var *string
Colin Cross068e0fe2016-12-13 15:23:47 -080080}
81
82type fileGroup struct {
Pirama Arumuga Nainar955dc492018-04-17 14:58:42 -070083 ModuleBase
Liz Kammerea6666f2021-02-17 10:17:28 -050084 BazelModuleBase
Colin Cross068e0fe2016-12-13 15:23:47 -080085 properties fileGroupProperties
Pirama Arumuga Nainar955dc492018-04-17 14:58:42 -070086 srcs Paths
Colin Cross068e0fe2016-12-13 15:23:47 -080087}
88
Pirama Arumuga Nainar955dc492018-04-17 14:58:42 -070089var _ SourceFileProducer = (*fileGroup)(nil)
Colin Cross068e0fe2016-12-13 15:23:47 -080090
Patrice Arruda8958a942019-03-12 10:06:00 -070091// filegroup contains a list of files that are referenced by other modules
92// properties (such as "srcs") using the syntax ":<name>". filegroup are
93// also be used to export files across package boundaries.
Pirama Arumuga Nainar955dc492018-04-17 14:58:42 -070094func FileGroupFactory() Module {
Colin Cross068e0fe2016-12-13 15:23:47 -080095 module := &fileGroup{}
Colin Cross36242852017-06-23 15:06:31 -070096 module.AddProperties(&module.properties)
Pirama Arumuga Nainar955dc492018-04-17 14:58:42 -070097 InitAndroidModule(module)
Liz Kammerea6666f2021-02-17 10:17:28 -050098 InitBazelModule(module)
Colin Cross36242852017-06-23 15:06:31 -070099 return module
Colin Cross068e0fe2016-12-13 15:23:47 -0800100}
101
Pirama Arumuga Nainar955dc492018-04-17 14:58:42 -0700102func (fg *fileGroup) GenerateAndroidBuildActions(ctx ModuleContext) {
Colin Cross8a497952019-03-05 22:25:09 -0800103 fg.srcs = PathsForModuleSrcExcludes(ctx, fg.properties.Srcs, fg.properties.Exclude_srcs)
Colin Cross2fafa3e2019-03-05 12:39:51 -0800104
105 if fg.properties.Path != nil {
106 fg.srcs = PathsWithModuleSrcSubDir(ctx, fg.srcs, String(fg.properties.Path))
107 }
Colin Cross068e0fe2016-12-13 15:23:47 -0800108}
109
Pirama Arumuga Nainar955dc492018-04-17 14:58:42 -0700110func (fg *fileGroup) Srcs() Paths {
111 return append(Paths{}, fg.srcs...)
Colin Cross068e0fe2016-12-13 15:23:47 -0800112}
Colin Crossd91d7ac2017-09-12 22:52:12 -0700113
Dan Willemsen6a6478d2020-07-17 19:28:53 -0700114func (fg *fileGroup) MakeVars(ctx MakeVarsModuleContext) {
115 if makeVar := String(fg.properties.Export_to_make_var); makeVar != "" {
116 ctx.StrictRaw(makeVar, strings.Join(fg.srcs.Strings(), " "))
Colin Crossd91d7ac2017-09-12 22:52:12 -0700117 }
118}