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
|
// 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.vfs;
import com.google.common.base.Preconditions;
import com.google.devtools.build.lib.skyframe.serialization.autocodec.AutoCodec;
import java.io.Serializable;
import java.util.Objects;
/**
* A {@link PathFragment} relative to a {@link Root}. Typically the root will be a package path
* entry.
*
* <p>Two {@link RootedPath}s are considered equal iff they have equal roots and equal relative
* paths.
*
* <p>TODO(bazel-team): use an opaque root representation so as to not expose the absolute path to
* clients via #asPath or #getRoot.
*/
@AutoCodec
public class RootedPath implements Serializable {
private final Root root;
private final PathFragment rootRelativePath;
/** Constructs a {@link RootedPath} from a {@link Root} and path fragment relative to the root. */
@AutoCodec.Instantiator
@AutoCodec.VisibleForSerialization
RootedPath(Root root, PathFragment rootRelativePath) {
Preconditions.checkState(
rootRelativePath.isAbsolute() == root.isAbsolute(),
"rootRelativePath: %s root: %s",
rootRelativePath,
root);
this.root = root;
this.rootRelativePath = rootRelativePath;
}
/** Returns a rooted path representing {@code rootRelativePath} relative to {@code root}. */
public static RootedPath toRootedPath(Root root, PathFragment rootRelativePath) {
if (rootRelativePath.isAbsolute()) {
if (root.isAbsolute()) {
return new RootedPath(root, rootRelativePath);
} else {
Preconditions.checkArgument(
root.contains(rootRelativePath),
"rootRelativePath '%s' is absolute, but it's not under root '%s'",
rootRelativePath,
root);
return new RootedPath(root, root.relativize(rootRelativePath));
}
} else {
return new RootedPath(root, rootRelativePath);
}
}
/** Returns a rooted path representing {@code path} under the root {@code root}. */
public static RootedPath toRootedPath(Root root, Path path) {
Preconditions.checkState(root.contains(path), "path: %s root: %s", path, root);
return toRootedPath(root, path.asFragment());
}
/**
* Returns a rooted path representing {@code path} under one of the package roots, or under the
* filesystem root if it's not under any package root.
*/
public static RootedPath toRootedPathMaybeUnderRoot(Path path, Iterable<Root> packagePathRoots) {
for (Root root : packagePathRoots) {
if (root.contains(path)) {
return toRootedPath(root, path);
}
}
return toRootedPath(Root.absoluteRoot(path.getFileSystem()), path);
}
public Path asPath() {
return root.getRelative(rootRelativePath);
}
public Root getRoot() {
return root;
}
/** Returns the path fragment relative to {@code #getRoot}. */
public PathFragment getRootRelativePath() {
return rootRelativePath;
}
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (!(obj instanceof RootedPath)) {
return false;
}
RootedPath other = (RootedPath) obj;
return Objects.equals(root, other.root)
&& Objects.equals(rootRelativePath, other.rootRelativePath);
}
@Override
public int hashCode() {
final int prime = 31;
int result = 1;
result = prime * result + root.hashCode();
result = prime * result + rootRelativePath.hashCode();
return result;
}
@Override
public String toString() {
return "[" + root + "]/[" + rootRelativePath + "]";
}
}
|
