clang-tools-extra/clangd/HeaderSourceSwitch.h

   1 //===--- HeaderSourceSwitch.h - ----------------------------------*- C++-*-===//
   2 //
   3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
   4 // See https://llvm.org/LICENSE.txt for license information.
   5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
   6 //
   7 //===----------------------------------------------------------------------===//
   8
   9 #ifndef LLVM_CLANG_TOOLS_EXTRA_CLANGD_HEADERSOURCESWITCH_H
  10 #define LLVM_CLANG_TOOLS_EXTRA_CLANGD_HEADERSOURCESWITCH_H
  11
  12 #include "ParsedAST.h"
  13 #include <optional>
  14
  15 namespace clang {
  16 namespace clangd {
  17
  18 /// Given a header file, returns the best matching source file, and vice visa.
  19 /// It only uses the filename heuristics to do the inference.
  20 std::optional<Path> getCorrespondingHeaderOrSource(
  21     PathRef OriginalFile, llvm::IntrusiveRefCntPtr<llvm::vfs::FileSystem> VFS);
  22
  23 /// Given a header file, returns the best matching source file, and vice visa.
  24 /// The heuristics incorporate with the AST and the index (if provided).
  25 std::optional<Path> getCorrespondingHeaderOrSource(PathRef OriginalFile,
  26                                                    ParsedAST &AST,
  27                                                    const SymbolIndex *Index);
  28
  29 /// Returns all indexable decls that are present in the main file of the AST.
  30 /// Exposed for unittests.
  31 std::vector<const Decl *> getIndexableLocalDecls(ParsedAST &AST);
  32
  33 } // namespace clangd
  34 } // namespace clang
  35
  36 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANGD_HEADERSOURCESWITCH_H