aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/main/java/com/google/devtools/build/lib/skylarkbuildapi/TemplateVariableInfoApi.java
diff options
context:
space:
mode:
Diffstat (limited to 'src/main/java/com/google/devtools/build/lib/skylarkbuildapi/TemplateVariableInfoApi.java')
-rw-r--r--src/main/java/com/google/devtools/build/lib/skylarkbuildapi/TemplateVariableInfoApi.java46
1 files changed, 46 insertions, 0 deletions
diff --git a/src/main/java/com/google/devtools/build/lib/skylarkbuildapi/TemplateVariableInfoApi.java b/src/main/java/com/google/devtools/build/lib/skylarkbuildapi/TemplateVariableInfoApi.java
new file mode 100644
index 0000000000..0af0811075
--- /dev/null
+++ b/src/main/java/com/google/devtools/build/lib/skylarkbuildapi/TemplateVariableInfoApi.java
@@ -0,0 +1,46 @@
+// Copyright 2018 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.skylarkbuildapi;
+
+import com.google.common.collect.ImmutableMap;
+import com.google.devtools.build.lib.skylarkinterface.SkylarkCallable;
+import com.google.devtools.build.lib.skylarkinterface.SkylarkModule;
+
+/** Provides access to make variables from the current fragments. */
+@SkylarkModule(
+ name = "TemplateVariableInfo",
+ doc = "<b>WARNING</b>: The constructor of this provider is experimental and may go away at any "
+ + "time."
+ + "<p>Encapsulates template variables, that is, variables that can be referenced by "
+ + "strings like <code>$(VARIABLE)</code> in BUILD files and expanded by "
+ + "<code>ctx.expand_make_variables</code> and implicitly in certain attributes of "
+ + "built-in rules."
+ + "</p>"
+ + "<p><code>TemplateVariableInfo</code> can be created by calling its eponymous "
+ + "constructor with a string-to-string dict as an argument that specifies the variables "
+ + "provided."
+ + "</p>"
+ + "<p>Example: <code>platform_common.TemplateVariableInfo({'FOO': 'bar'})</code>"
+ + "</p>")
+public interface TemplateVariableInfoApi extends StructApi {
+
+ @SkylarkCallable(
+ name = "variables",
+ doc = "Returns the make variables defined by this target as a dictionary with string keys "
+ + "and string values",
+ structField = true
+ )
+ public ImmutableMap<String, String> getVariables();
+}