aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/main/java/com/google/devtools/build/lib/rules/platform/ToolchainInfo.java
blob: 320ee5e9df3d4a94217c0a6978445194aa62b5b2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
// Copyright 2017 The Bazel Authors. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//    http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package com.google.devtools.build.lib.rules.platform;

import com.google.common.base.Function;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.Iterables;
import com.google.devtools.build.lib.analysis.TransitiveInfoCollection;
import com.google.devtools.build.lib.analysis.TransitiveInfoProvider;
import com.google.devtools.build.lib.concurrent.ThreadSafety.Immutable;
import com.google.devtools.build.lib.events.Location;
import com.google.devtools.build.lib.packages.ClassObjectConstructor;
import com.google.devtools.build.lib.packages.NativeClassObjectConstructor;
import com.google.devtools.build.lib.packages.SkylarkClassObject;
import com.google.devtools.build.lib.packages.SkylarkProviderIdentifier;
import com.google.devtools.build.lib.skylarkinterface.SkylarkCallable;
import com.google.devtools.build.lib.skylarkinterface.SkylarkModule;
import com.google.devtools.build.lib.skylarkinterface.SkylarkModuleCategory;
import com.google.devtools.build.lib.util.Preconditions;
import java.util.Map;

/**
 * A provider that supplied information about a specific language toolchain, including what platform
 * constraints are required for execution and for the target platform.
 */
@SkylarkModule(
  name = "ToolchainInfo",
  doc = "Provides access to data about a specific toolchain.",
  category = SkylarkModuleCategory.PROVIDER
)
@Immutable
public class ToolchainInfo extends SkylarkClassObject implements TransitiveInfoProvider {

  /** Name used in Skylark for accessing this provider. */
  static final String SKYLARK_NAME = "ToolchainInfo";

  /** Skylark constructor and identifier for this provider. */
  static final ClassObjectConstructor SKYLARK_CONSTRUCTOR =
      new NativeClassObjectConstructor(SKYLARK_NAME) {};

  /** Identifier used to retrieve this provider from rules which export it. */
  private static final SkylarkProviderIdentifier SKYLARK_IDENTIFIER =
      SkylarkProviderIdentifier.forKey(SKYLARK_CONSTRUCTOR.getKey());

  private final ImmutableList<ConstraintValueInfo> execConstraints;
  private final ImmutableList<ConstraintValueInfo> targetConstraints;

  public ToolchainInfo(
      Iterable<ConstraintValueInfo> execConstraints,
      Iterable<ConstraintValueInfo> targetConstraints,
      Map<String, Object> toolchainData,
      Location loc) {
    this(
        ImmutableList.copyOf(execConstraints),
        ImmutableList.copyOf(targetConstraints),
        toolchainData,
        loc);
  }

  public ToolchainInfo(
      ImmutableList<ConstraintValueInfo> execConstraints,
      ImmutableList<ConstraintValueInfo> targetConstraints,
      Map<String, Object> toolchainData,
      Location loc) {
    super(
        SKYLARK_CONSTRUCTOR,
        ImmutableMap.<String, Object>builder()
            .put("exec_compatible_with", execConstraints)
            .put("target_compatible_with", targetConstraints)
            .putAll(toolchainData)
            .build(),
        loc);

    this.execConstraints = execConstraints;
    this.targetConstraints = targetConstraints;
  }

  @SkylarkCallable(
    name = "exec_compatible_with",
    doc = "The constraints on the execution platforms this toolchain supports.",
    structField = true
  )
  public ImmutableList<ConstraintValueInfo> execConstraints() {
    return execConstraints;
  }

  @SkylarkCallable(
    name = "target_compatible_with",
    doc = "The constraints on the target platforms this toolchain supports.",
    structField = true
  )
  public ImmutableList<ConstraintValueInfo> targetConstraints() {
    return targetConstraints;
  }

  /** Retrieves and casts the provider from the given target. */
  public static ToolchainInfo fromTarget(TransitiveInfoCollection target) {
    Object provider = target.get(SKYLARK_IDENTIFIER);
    if (provider == null) {
      return null;
    }
    Preconditions.checkState(provider instanceof ToolchainInfo);
    return (ToolchainInfo) provider;
  }

  /** Retrieves and casts the providers from the given targets. */
  public static Iterable<ToolchainInfo> fromTargets(
      Iterable<? extends TransitiveInfoCollection> targets) {
    return Iterables.transform(
        targets,
        new Function<TransitiveInfoCollection, ToolchainInfo>() {
          @Override
          public ToolchainInfo apply(TransitiveInfoCollection target) {
            return fromTarget(target);
          }
        });
  }
}