blob: 3827b874062deb0082431cd228a37f09e9518f31 (
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
|
// Copyright 2016 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.
#ifndef BAZEL_SRC_MAIN_CPP_WORKSPACE_LAYOUT_H_
#define BAZEL_SRC_MAIN_CPP_WORKSPACE_LAYOUT_H_
#include <string>
#include <vector>
namespace blaze {
// Provides methods to compute paths related to the workspace.
class WorkspaceLayout {
public:
virtual ~WorkspaceLayout() = default;
// Returns the directory to use for storing outputs.
virtual std::string GetOutputRoot() const;
// Given the working directory, returns the nearest enclosing directory with a
// WORKSPACE file in it. If there is no such enclosing directory, returns "".
//
// E.g., if there was a WORKSPACE file in foo/bar/build_root:
// GetWorkspace('foo/bar') --> ''
// GetWorkspace('foo/bar/build_root') --> 'foo/bar/build_root'
// GetWorkspace('foo/bar/build_root/biz') --> 'foo/bar/build_root'
//
// The returned path is relative or absolute depending on whether cwd was
// relative or absolute.
virtual std::string GetWorkspace(const std::string& cwd) const;
// Given a result returned from GetWorkspace, returns a pretty workspace name
// than can e.g. be used in the process title of the Bazel server.
virtual std::string GetPrettyWorkspaceName(
const std::string& workspace) const;
// Returns if workspace is a valid build workspace.
virtual bool InWorkspace(const std::string& workspace) const;
// Returns the path of the workspace rc file.
virtual std::string GetWorkspaceRcPath(
const std::string& workspace,
const std::vector<std::string>& startup_args) const;
// Turn a %workspace%-relative import into its true name in the filesystem.
// path_fragment is modified in place.
// Unlike FindCandidateBlazercPaths, it is an error if no import file
// exists.
virtual bool WorkspaceRelativizeRcFilePath(const std::string& workspace,
std::string* path_fragment) const;
static constexpr const char WorkspacePrefix[] = "%workspace%/";
static const int WorkspacePrefixLength = sizeof WorkspacePrefix - 1;
};
} // namespace blaze
#endif // BAZEL_SRC_MAIN_CPP_WORKSPACE_LAYOUT_H_
|
