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
|
// Copyright 2014 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.analysis.actions;
import com.google.devtools.build.lib.actions.ActionAnalysisMetadata;
import com.google.devtools.build.lib.actions.ActionOwner;
import com.google.devtools.build.lib.actions.Artifact;
import com.google.devtools.build.lib.actions.ArtifactRoot;
import com.google.devtools.build.lib.analysis.AnalysisEnvironment;
import com.google.devtools.build.lib.analysis.config.BuildConfiguration;
import com.google.devtools.build.lib.analysis.platform.PlatformInfo;
import com.google.devtools.build.lib.packages.ImplicitOutputsFunction;
import com.google.devtools.build.lib.vfs.PathFragment;
import javax.annotation.Nullable;
/**
* A temporary interface to allow migration from RuleConfiguredTarget to RuleContext. It bundles
* the items commonly needed to construct action instances.
*/
public interface ActionConstructionContext {
/** Returns the bin directory for constructed actions. */
ArtifactRoot getBinDirectory();
/** Returns the internal directory (used for middlemen) for constructed actions. */
ArtifactRoot getMiddlemanDirectory();
/** Returns the action owner that should be used for actions. */
ActionOwner getActionOwner();
/** Returns the {@link BuildConfiguration} for which the given rule is analyzed. */
BuildConfiguration getConfiguration();
/** The current analysis environment. */
AnalysisEnvironment getAnalysisEnvironment();
void registerAction(ActionAnalysisMetadata... actions);
/**
* Creates an artifact under a given root with the given root-relative path.
*
* <p>Verifies that it is in the root-relative directory corresponding to the package of the rule,
* thus ensuring that it doesn't clash with other artifacts generated by other rules using this
* method.
*/
Artifact getDerivedArtifact(PathFragment rootRelativePath, ArtifactRoot root);
/**
* Returns the implicit output artifact for a given template function. If multiple or no artifacts
* can be found as a result of the template, an exception is thrown.
*/
Artifact getImplicitOutputArtifact(ImplicitOutputsFunction function) throws InterruptedException;
/**
* Creates an artifact in a directory that is unique to the rule, thus guaranteeing that it never
* clashes with artifacts created by other rules.
*
* @param uniqueDirectorySuffix suffix of the directory - it will be prepended
*/
Artifact getUniqueDirectoryArtifact(String uniqueDirectorySuffix, String relative);
/**
* Returns the root-relative path fragment under which output artifacts of this rule should go.
*
* <p>Note that:
*
* <ul>
* <li>This doesn't guarantee that there are no clashes with rules in the same package.
* <li>If possible, {@link #getPackageRelativeArtifact(PathFragment, ArtifactRoot)} should be
* used instead of this method.
* </ul>
*
* Ideally, user-visible artifacts should all have corresponding output file targets, all others
* should go into a rule-specific directory. {@link #getUniqueDirectoryArtifact(String, String)})
* ensures that this is the case.
*/
PathFragment getPackageDirectory();
/**
* Creates an artifact in a directory that is unique to the package that contains the rule, thus
* guaranteeing that it never clashes with artifacts created by rules in other packages.
*/
Artifact getPackageRelativeArtifact(PathFragment relative, ArtifactRoot root);
/** Returns the {@link PlatformInfo} describing the execution platform this action should use. */
@Nullable
PlatformInfo getExecutionPlatform();
}
|
