File: Path.h

package info (click to toggle)
llvm-toolchain-21 1%3A21.1.6-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,245,028 kB
  • sloc: cpp: 7,619,726; ansic: 1,434,018; asm: 1,058,748; python: 252,740; f90: 94,671; objc: 70,685; lisp: 42,813; pascal: 18,401; sh: 8,601; ml: 5,111; perl: 4,720; makefile: 3,675; awk: 3,523; javascript: 2,409; xml: 892; fortran: 770
file content (50 lines) | stat: -rw-r--r-- 1,825 bytes parent folder | download | duplicates (22)
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
//===--- Path.h - Helper typedefs --------------------------------*- C++-*-===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//

#ifndef LLVM_CLANG_TOOLS_EXTRA_CLANGD_SUPPORT_PATH_H
#define LLVM_CLANG_TOOLS_EXTRA_CLANGD_SUPPORT_PATH_H

#include "llvm/ADT/StringRef.h"
#include "llvm/Support/Path.h"
#include <string>

/// Whether current platform treats paths case insensitively.
#if defined(_WIN32) || defined(__APPLE__)
#define CLANGD_PATH_CASE_INSENSITIVE
#endif

namespace clang {
namespace clangd {

/// A typedef to represent a file path. Used solely for more descriptive
/// signatures.
using Path = std::string;
/// A typedef to represent a ref to file path. Used solely for more descriptive
/// signatures.
using PathRef = llvm::StringRef;

// For platforms where paths are case-insensitive (but case-preserving),
// we need to do case-insensitive comparisons and use lowercase keys.
// FIXME: Make Path a real class with desired semantics instead.
std::string maybeCaseFoldPath(PathRef Path);
bool pathEqual(PathRef, PathRef);

/// Checks if \p Ancestor is a proper ancestor of \p Path. This is just a
/// smarter lexical prefix match, e.g: foo/bar/baz doesn't start with foo/./bar.
/// Both \p Ancestor and \p Path must be absolute.
bool pathStartsWith(
    PathRef Ancestor, PathRef Path,
    llvm::sys::path::Style Style = llvm::sys::path::Style::native);

/// Variant of parent_path that operates only on absolute paths.
/// Unlike parent_path doesn't consider C: a parent of C:\.
PathRef absoluteParent(PathRef Path);
} // namespace clangd
} // namespace clang

#endif