xref: /aosp_15_r20/external/bazel-skylib/rules/directory/subdirectory.bzl (revision bcb5dc7965af6ee42bf2f21341a2ec00233a8c8a)
1*bcb5dc79SHONG Yifan# Copyright 2024 The Bazel Authors. All rights reserved.
2*bcb5dc79SHONG Yifan#
3*bcb5dc79SHONG Yifan# Licensed under the Apache License, Version 2.0 (the "License");
4*bcb5dc79SHONG Yifan# you may not use this file except in compliance with the License.
5*bcb5dc79SHONG Yifan# You may obtain a copy of the License at
6*bcb5dc79SHONG Yifan#
7*bcb5dc79SHONG Yifan#    http://www.apache.org/licenses/LICENSE-2.0
8*bcb5dc79SHONG Yifan#
9*bcb5dc79SHONG Yifan# Unless required by applicable law or agreed to in writing, software
10*bcb5dc79SHONG Yifan# distributed under the License is distributed on an "AS IS" BASIS,
11*bcb5dc79SHONG Yifan# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12*bcb5dc79SHONG Yifan# See the License for the specific language governing permissions and
13*bcb5dc79SHONG Yifan# limitations under the License.
14*bcb5dc79SHONG Yifan
15*bcb5dc79SHONG Yifan"""Skylib module containing rules to create metadata about subdirectories."""
16*bcb5dc79SHONG Yifan
17*bcb5dc79SHONG Yifanload(":providers.bzl", "DirectoryInfo")
18*bcb5dc79SHONG Yifan
19*bcb5dc79SHONG Yifandef _subdirectory_impl(ctx):
20*bcb5dc79SHONG Yifan    dir = ctx.attr.parent[DirectoryInfo].get_subdirectory(ctx.attr.path)
21*bcb5dc79SHONG Yifan    return [
22*bcb5dc79SHONG Yifan        dir,
23*bcb5dc79SHONG Yifan        DefaultInfo(files = dir.transitive_files),
24*bcb5dc79SHONG Yifan    ]
25*bcb5dc79SHONG Yifan
26*bcb5dc79SHONG Yifansubdirectory = rule(
27*bcb5dc79SHONG Yifan    implementation = _subdirectory_impl,
28*bcb5dc79SHONG Yifan    attrs = {
29*bcb5dc79SHONG Yifan        "parent": attr.label(
30*bcb5dc79SHONG Yifan            providers = [DirectoryInfo],
31*bcb5dc79SHONG Yifan            mandatory = True,
32*bcb5dc79SHONG Yifan            doc = "A label corresponding to the parent directory (or subdirectory).",
33*bcb5dc79SHONG Yifan        ),
34*bcb5dc79SHONG Yifan        "path": attr.string(
35*bcb5dc79SHONG Yifan            mandatory = True,
36*bcb5dc79SHONG Yifan            doc = "A path within the parent directory (eg. \"path/to/subdir\")",
37*bcb5dc79SHONG Yifan        ),
38*bcb5dc79SHONG Yifan    },
39*bcb5dc79SHONG Yifan    provides = [DirectoryInfo],
40*bcb5dc79SHONG Yifan)
41