clang-tools-extra/clangd/support/Path.h

//===--- 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