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
|
// 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.repository;
import com.google.common.collect.ImmutableList;
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.skylarkinterface.SkylarkValue;
import java.io.IOException;
/**
* A structure representing a file to be used inside a repository.
*/
@SkylarkModule(
name = "path",
category = SkylarkModuleCategory.NONE,
doc = "A structure representing a file to be used inside a repository."
)
public interface RepositoryPathApi<RepositoryPathApiT extends RepositoryPathApi<?>>
extends SkylarkValue {
@SkylarkCallable(
name = "basename",
structField = true,
doc = "A string giving the basename of the file."
)
public String getBasename();
@SkylarkCallable(
name = "readdir",
structField = false,
doc = "The list of entries in the directory denoted by this path."
)
public ImmutableList<RepositoryPathApiT> readdir() throws IOException;
@SkylarkCallable(
name = "dirname",
structField = true,
doc = "The parent directory of this file, or None if this file does not have a parent."
)
public RepositoryPathApi<?> getDirname();
@SkylarkCallable(
name = "get_child",
doc = "Append the given path to this path and return the resulted path."
)
public RepositoryPathApi<?> getChild(String childPath);
@SkylarkCallable(
name = "exists",
structField = true,
doc = "Returns true if the file denoted by this path exists."
)
public boolean exists();
@SkylarkCallable(
name = "realpath",
structField = true,
doc = "Returns the canonical path for this path by repeatedly replacing all symbolic links "
+ "with their referents."
)
public RepositoryPathApi<?> realpath() throws IOException;
}
|
