clang 19.0.0git
USRGeneration.h
Go to the documentation of this file.
1//===- USRGeneration.h - Routines for USR generation ------------*- 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_INDEX_USRGENERATION_H
10#define LLVM_CLANG_INDEX_USRGENERATION_H
11
12#include "clang/Basic/LLVM.h"
13#include "llvm/ADT/StringRef.h"
14
15namespace clang {
16class ASTContext;
17class Decl;
18class MacroDefinitionRecord;
19class Module;
20class SourceLocation;
21class SourceManager;
22class QualType;
23
24namespace index {
25
26static inline StringRef getUSRSpacePrefix() {
27 return "c:";
28}
29
30/// Generate a USR for a Decl, including the USR prefix.
31/// \returns true if the results should be ignored, false otherwise.
33
34/// Generate a USR fragment for an Objective-C class.
35void generateUSRForObjCClass(StringRef Cls, raw_ostream &OS,
36 StringRef ExtSymbolDefinedIn = "",
37 StringRef CategoryContextExtSymbolDefinedIn = "");
38
39/// Generate a USR fragment for an Objective-C class category.
40void generateUSRForObjCCategory(StringRef Cls, StringRef Cat, raw_ostream &OS,
41 StringRef ClsExtSymbolDefinedIn = "",
42 StringRef CatExtSymbolDefinedIn = "");
43
44/// Generate a USR fragment for an Objective-C instance variable. The
45/// complete USR can be created by concatenating the USR for the
46/// encompassing class with this USR fragment.
47void generateUSRForObjCIvar(StringRef Ivar, raw_ostream &OS);
48
49/// Generate a USR fragment for an Objective-C method.
50void generateUSRForObjCMethod(StringRef Sel, bool IsInstanceMethod,
51 raw_ostream &OS);
52
53/// Generate a USR fragment for an Objective-C property.
54void generateUSRForObjCProperty(StringRef Prop, bool isClassProp, raw_ostream &OS);
55
56/// Generate a USR fragment for an Objective-C protocol.
57void generateUSRForObjCProtocol(StringRef Prot, raw_ostream &OS,
58 StringRef ExtSymbolDefinedIn = "");
59
60/// Generate USR fragment for a global (non-nested) enum.
61void generateUSRForGlobalEnum(StringRef EnumName, raw_ostream &OS,
62 StringRef ExtSymbolDefinedIn = "");
63
64/// Generate a USR fragment for an enum constant.
65void generateUSRForEnumConstant(StringRef EnumConstantName, raw_ostream &OS);
66
67/// Generate a USR for a macro, including the USR prefix.
68///
69/// \returns true on error, false on success.
72bool generateUSRForMacro(StringRef MacroName, SourceLocation Loc,
74
75/// Generates a USR for a type.
76///
77/// \return true on error, false on success.
79
80/// Generate a USR for a module, including the USR prefix.
81/// \returns true on error, false on success.
82bool generateFullUSRForModule(const Module *Mod, raw_ostream &OS);
83
84/// Generate a USR for a top-level module name, including the USR prefix.
85/// \returns true on error, false on success.
86bool generateFullUSRForTopLevelModuleName(StringRef ModName, raw_ostream &OS);
87
88/// Generate a USR fragment for a module.
89/// \returns true on error, false on success.
90bool generateUSRFragmentForModule(const Module *Mod, raw_ostream &OS);
91
92/// Generate a USR fragment for a module name.
93/// \returns true on error, false on success.
94bool generateUSRFragmentForModuleName(StringRef ModName, raw_ostream &OS);
95
96
97} // namespace index
98} // namespace clang
99
100#endif // LLVM_CLANG_INDEX_USRGENERATION_H
101
#define SM(sm)
Definition: Cuda.cpp:84
Forward-declares and imports various common LLVM datatypes that clang wants to use unqualified.
SourceLocation Loc
Definition: SemaObjC.cpp:758
Holds long-lived AST nodes (such as types and decls) that can be referred to throughout the semantic ...
Definition: ASTContext.h:185
Decl - This represents one declaration (or definition), e.g.
Definition: DeclBase.h:86
Record the location of a macro definition.
Describes a module or submodule.
Definition: Module.h:105
A (possibly-)qualified type.
Definition: Type.h:940
Encodes a location in the source.
This class handles loading and caching of source files into memory.
@ Decl
The l-value was an access to a declared entity or something equivalently strong, like the address of ...
bool generateFullUSRForTopLevelModuleName(StringRef ModName, raw_ostream &OS)
Generate a USR for a top-level module name, including the USR prefix.
static StringRef getUSRSpacePrefix()
Definition: USRGeneration.h:26
void generateUSRForObjCCategory(StringRef Cls, StringRef Cat, raw_ostream &OS, StringRef ClsExtSymbolDefinedIn="", StringRef CatExtSymbolDefinedIn="")
Generate a USR fragment for an Objective-C class category.
bool generateFullUSRForModule(const Module *Mod, raw_ostream &OS)
Generate a USR for a module, including the USR prefix.
bool generateUSRFragmentForModuleName(StringRef ModName, raw_ostream &OS)
Generate a USR fragment for a module name.
bool generateUSRForMacro(const MacroDefinitionRecord *MD, const SourceManager &SM, SmallVectorImpl< char > &Buf)
Generate a USR for a macro, including the USR prefix.
void generateUSRForObjCProperty(StringRef Prop, bool isClassProp, raw_ostream &OS)
Generate a USR fragment for an Objective-C property.
void generateUSRForEnumConstant(StringRef EnumConstantName, raw_ostream &OS)
Generate a USR fragment for an enum constant.
void generateUSRForObjCIvar(StringRef Ivar, raw_ostream &OS)
Generate a USR fragment for an Objective-C instance variable.
void generateUSRForObjCMethod(StringRef Sel, bool IsInstanceMethod, raw_ostream &OS)
Generate a USR fragment for an Objective-C method.
bool generateUSRForType(QualType T, ASTContext &Ctx, SmallVectorImpl< char > &Buf)
Generates a USR for a type.
void generateUSRForObjCClass(StringRef Cls, raw_ostream &OS, StringRef ExtSymbolDefinedIn="", StringRef CategoryContextExtSymbolDefinedIn="")
Generate a USR fragment for an Objective-C class.
void generateUSRForGlobalEnum(StringRef EnumName, raw_ostream &OS, StringRef ExtSymbolDefinedIn="")
Generate USR fragment for a global (non-nested) enum.
void generateUSRForObjCProtocol(StringRef Prot, raw_ostream &OS, StringRef ExtSymbolDefinedIn="")
Generate a USR fragment for an Objective-C protocol.
bool generateUSRFragmentForModule(const Module *Mod, raw_ostream &OS)
Generate a USR fragment for a module.
bool generateUSRForDecl(const Decl *D, SmallVectorImpl< char > &Buf)
Generate a USR for a Decl, including the USR prefix.
The JSON file list parser is used to communicate input to InstallAPI.
@ Module
Module linkage, which indicates that the entity can be referred to from other translation units withi...
const FunctionProtoType * T