clang-tools 18.0.0git
TestIndex.h
Go to the documentation of this file.
1//===-- IndexHelpers.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_UNITTESTS_TESTINDEX_H
10#define LLVM_CLANG_TOOLS_EXTRA_CLANGD_UNITTESTS_TESTINDEX_H
11
12#include "index/Index.h"
13
14namespace clang {
15namespace clangd {
16
17// Creates Symbol instance and sets SymbolID to given QualifiedName.
18Symbol symbol(llvm::StringRef QName);
19
20// Helpers to produce fake index symbols with proper SymbolID.
21// USRFormat is a regex replacement string for the unqualified part of the USR.
22Symbol sym(llvm::StringRef QName, index::SymbolKind Kind,
23 llvm::StringRef USRFormat);
24// Creats a function symbol assuming no function arg.
25Symbol func(llvm::StringRef Name);
26// Creates a class symbol.
27Symbol cls(llvm::StringRef Name);
28// Creates an enum symbol.
29Symbol enm(llvm::StringRef Name);
30// Creates an enum constant symbol.
31Symbol enmConstant(llvm::StringRef Name);
32// Creates a variable symbol.
33Symbol var(llvm::StringRef Name);
34// Creates a namespace symbol.
35Symbol ns(llvm::StringRef Name);
36// Create a C++20 concept symbol.
37Symbol conceptSym(llvm::StringRef Name);
38
39// Create an Objective-C symbol.
40Symbol objcSym(llvm::StringRef Name, index::SymbolKind Kind,
41 llvm::StringRef USRPrefix);
42// Create an @interface or @implementation.
43Symbol objcClass(llvm::StringRef Name);
44// Create an @interface or @implementation category.
45Symbol objcCategory(llvm::StringRef Name, llvm::StringRef CategoryName);
46// Create an @protocol.
47Symbol objcProtocol(llvm::StringRef Name);
48
49// Create a slab of symbols with the given qualified names as IDs and names.
50SymbolSlab generateSymbols(std::vector<std::string> QualifiedNames);
51
52// Create a slab of symbols with IDs and names [Begin, End].
53SymbolSlab generateNumSymbols(int Begin, int End);
54
55// Returns fully-qualified name out of given symbol.
56std::string getQualifiedName(const Symbol &Sym);
57
58// Performs fuzzy matching-based symbol lookup given a query and an index.
59// Incomplete is set true if more items than requested can be retrieved, false
60// otherwise.
61std::vector<std::string> match(const SymbolIndex &I,
62 const FuzzyFindRequest &Req,
63 bool *Incomplete = nullptr);
64
65// Returns qualified names of symbols with any of IDs in the index.
66std::vector<std::string> lookup(const SymbolIndex &I,
67 llvm::ArrayRef<SymbolID> IDs);
68
69} // namespace clangd
70} // namespace clang
71
72#endif
BindArgumentKind Kind
llvm::StringRef Name
Symbol objcProtocol(llvm::StringRef Name)
Definition: TestIndex.cpp:112
Symbol objcClass(llvm::StringRef Name)
Definition: TestIndex.cpp:103
Symbol func(llvm::StringRef Name)
Definition: TestIndex.cpp:61
Symbol cls(llvm::StringRef Name)
Definition: TestIndex.cpp:65
Symbol objcCategory(llvm::StringRef Name, llvm::StringRef CategoryName)
Definition: TestIndex.cpp:107
Symbol conceptSym(llvm::StringRef Name)
Definition: TestIndex.cpp:85
Symbol ns(llvm::StringRef Name)
Definition: TestIndex.cpp:81
Symbol sym(llvm::StringRef QName, index::SymbolKind Kind, llvm::StringRef USRFormat)
Definition: TestIndex.cpp:40
Symbol objcSym(llvm::StringRef Name, index::SymbolKind Kind, llvm::StringRef USRPrefix)
Definition: TestIndex.cpp:89
std::vector< std::string > match(const SymbolIndex &I, const FuzzyFindRequest &Req, bool *Incomplete)
Definition: TestIndex.cpp:134
Symbol symbol(llvm::StringRef QName)
Definition: TestIndex.cpp:17
Symbol enm(llvm::StringRef Name)
Definition: TestIndex.cpp:69
SymbolSlab generateSymbols(std::vector< std::string > QualifiedNames)
Definition: TestIndex.cpp:116
std::string getQualifiedName(const Symbol &Sym)
Definition: TestIndex.cpp:130
std::vector< std::string > lookup(const SymbolIndex &I, llvm::ArrayRef< SymbolID > IDs)
Definition: TestIndex.cpp:146
Symbol enmConstant(llvm::StringRef Name)
Definition: TestIndex.cpp:73
SymbolSlab generateNumSymbols(int Begin, int End)
Definition: TestIndex.cpp:123
Symbol var(llvm::StringRef Name)
Definition: TestIndex.cpp:77
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//