1 //===- USRGeneration.h - Routines for USR generation ----------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 #ifndef LLVM_CLANG_INDEX_USRGENERATION_H
11 #define LLVM_CLANG_INDEX_USRGENERATION_H
13 #include "clang/Basic/LLVM.h"
14 #include "llvm/ADT/StringRef.h"
18 class MacroDefinitionRecord;
24 static inline StringRef getUSRSpacePrefix() {
28 /// \brief Generate a USR for a Decl, including the USR prefix.
29 /// \returns true if the results should be ignored, false otherwise.
30 bool generateUSRForDecl(const Decl *D, SmallVectorImpl<char> &Buf);
32 /// \brief Generate a USR fragment for an Objective-C class.
33 void generateUSRForObjCClass(StringRef Cls, raw_ostream &OS,
34 StringRef ExtSymbolDefinedIn = "",
35 StringRef CategoryContextExtSymbolDefinedIn = "");
37 /// \brief Generate a USR fragment for an Objective-C class category.
38 void generateUSRForObjCCategory(StringRef Cls, StringRef Cat, raw_ostream &OS,
39 StringRef ClsExtSymbolDefinedIn = "",
40 StringRef CatExtSymbolDefinedIn = "");
42 /// \brief Generate a USR fragment for an Objective-C instance variable. The
43 /// complete USR can be created by concatenating the USR for the
44 /// encompassing class with this USR fragment.
45 void generateUSRForObjCIvar(StringRef Ivar, raw_ostream &OS);
47 /// \brief Generate a USR fragment for an Objective-C method.
48 void generateUSRForObjCMethod(StringRef Sel, bool IsInstanceMethod,
51 /// \brief Generate a USR fragment for an Objective-C property.
52 void generateUSRForObjCProperty(StringRef Prop, bool isClassProp, raw_ostream &OS);
54 /// \brief Generate a USR fragment for an Objective-C protocol.
55 void generateUSRForObjCProtocol(StringRef Prot, raw_ostream &OS,
56 StringRef ExtSymbolDefinedIn = "");
58 /// Generate USR fragment for a global (non-nested) enum.
59 void generateUSRForGlobalEnum(StringRef EnumName, raw_ostream &OS,
60 StringRef ExtSymbolDefinedIn = "");
62 /// Generate a USR fragment for an enum constant.
63 void generateUSRForEnumConstant(StringRef EnumConstantName, raw_ostream &OS);
65 /// \brief Generate a USR for a macro, including the USR prefix.
67 /// \returns true on error, false on success.
68 bool generateUSRForMacro(const MacroDefinitionRecord *MD,
69 const SourceManager &SM, SmallVectorImpl<char> &Buf);
70 bool generateUSRForMacro(StringRef MacroName, SourceLocation Loc,
71 const SourceManager &SM, SmallVectorImpl<char> &Buf);
76 #endif // LLVM_CLANG_IDE_USRGENERATION_H