Argyrios Kyrtzidis | aed123e | 2011-10-06 07:00:54 +0000 | [diff] [blame] | 1 | //===- CIndexHigh.cpp - Higher level API functions ------------------------===// |
| 2 | // |
| 3 | // The LLVM Compiler Infrastructure |
| 4 | // |
| 5 | // This file is distributed under the University of Illinois Open Source |
| 6 | // License. See LICENSE.TXT for details. |
| 7 | // |
| 8 | //===----------------------------------------------------------------------===// |
| 9 | |
Argyrios Kyrtzidis | e2079cf | 2011-11-16 08:58:54 +0000 | [diff] [blame] | 10 | #include "CursorVisitor.h" |
Chandler Carruth | b1ba0ef | 2013-01-19 08:09:44 +0000 | [diff] [blame] | 11 | #include "CLog.h" |
Argyrios Kyrtzidis | aed123e | 2011-10-06 07:00:54 +0000 | [diff] [blame] | 12 | #include "CXCursor.h" |
| 13 | #include "CXSourceLocation.h" |
| 14 | #include "CXTranslationUnit.h" |
Argyrios Kyrtzidis | aed123e | 2011-10-06 07:00:54 +0000 | [diff] [blame] | 15 | #include "clang/AST/DeclObjC.h" |
Chandler Carruth | f59edb9 | 2012-12-04 09:25:21 +0000 | [diff] [blame] | 16 | #include "clang/Frontend/ASTUnit.h" |
Dmitri Gribenko | acbe4ba | 2013-01-11 02:23:13 +0000 | [diff] [blame] | 17 | #include "llvm/Support/Compiler.h" |
Argyrios Kyrtzidis | aed123e | 2011-10-06 07:00:54 +0000 | [diff] [blame] | 18 | |
| 19 | using namespace clang; |
Argyrios Kyrtzidis | e2079cf | 2011-11-16 08:58:54 +0000 | [diff] [blame] | 20 | using namespace cxcursor; |
Argyrios Kyrtzidis | c6f5c6a | 2013-01-10 18:54:52 +0000 | [diff] [blame] | 21 | using namespace cxindex; |
Argyrios Kyrtzidis | aed123e | 2011-10-06 07:00:54 +0000 | [diff] [blame] | 22 | |
| 23 | static void getTopOverriddenMethods(CXTranslationUnit TU, |
Dmitri Gribenko | e22339c | 2013-01-23 17:25:27 +0000 | [diff] [blame] | 24 | const Decl *D, |
| 25 | SmallVectorImpl<const Decl *> &Methods) { |
Argyrios Kyrtzidis | 16ed0e6 | 2011-12-10 02:36:25 +0000 | [diff] [blame] | 26 | if (!D) |
| 27 | return; |
Argyrios Kyrtzidis | aed123e | 2011-10-06 07:00:54 +0000 | [diff] [blame] | 28 | if (!isa<ObjCMethodDecl>(D) && !isa<CXXMethodDecl>(D)) |
| 29 | return; |
| 30 | |
| 31 | SmallVector<CXCursor, 8> Overridden; |
| 32 | cxcursor::getOverriddenCursors(cxcursor::MakeCXCursor(D, TU), Overridden); |
| 33 | |
| 34 | if (Overridden.empty()) { |
| 35 | Methods.push_back(D->getCanonicalDecl()); |
| 36 | return; |
| 37 | } |
| 38 | |
Craig Topper | 09d19ef | 2013-07-04 03:08:24 +0000 | [diff] [blame] | 39 | for (SmallVectorImpl<CXCursor>::iterator |
Argyrios Kyrtzidis | aed123e | 2011-10-06 07:00:54 +0000 | [diff] [blame] | 40 | I = Overridden.begin(), E = Overridden.end(); I != E; ++I) |
| 41 | getTopOverriddenMethods(TU, cxcursor::getCursorDecl(*I), Methods); |
| 42 | } |
| 43 | |
| 44 | namespace { |
| 45 | |
| 46 | struct FindFileIdRefVisitData { |
| 47 | CXTranslationUnit TU; |
| 48 | FileID FID; |
Dmitri Gribenko | e22339c | 2013-01-23 17:25:27 +0000 | [diff] [blame] | 49 | const Decl *Dcl; |
Argyrios Kyrtzidis | aed123e | 2011-10-06 07:00:54 +0000 | [diff] [blame] | 50 | int SelectorIdIdx; |
| 51 | CXCursorAndRangeVisitor visitor; |
| 52 | |
Dmitri Gribenko | e22339c | 2013-01-23 17:25:27 +0000 | [diff] [blame] | 53 | typedef SmallVector<const Decl *, 8> TopMethodsTy; |
Argyrios Kyrtzidis | aed123e | 2011-10-06 07:00:54 +0000 | [diff] [blame] | 54 | TopMethodsTy TopMethods; |
| 55 | |
| 56 | FindFileIdRefVisitData(CXTranslationUnit TU, FileID FID, |
Dmitri Gribenko | e22339c | 2013-01-23 17:25:27 +0000 | [diff] [blame] | 57 | const Decl *D, int selectorIdIdx, |
Argyrios Kyrtzidis | aed123e | 2011-10-06 07:00:54 +0000 | [diff] [blame] | 58 | CXCursorAndRangeVisitor visitor) |
| 59 | : TU(TU), FID(FID), SelectorIdIdx(selectorIdIdx), visitor(visitor) { |
| 60 | Dcl = getCanonical(D); |
| 61 | getTopOverriddenMethods(TU, Dcl, TopMethods); |
| 62 | } |
| 63 | |
| 64 | ASTContext &getASTContext() const { |
Dmitri Gribenko | 5694feb | 2013-01-26 18:53:38 +0000 | [diff] [blame] | 65 | return cxtu::getASTUnit(TU)->getASTContext(); |
Argyrios Kyrtzidis | aed123e | 2011-10-06 07:00:54 +0000 | [diff] [blame] | 66 | } |
| 67 | |
| 68 | /// \brief We are looking to find all semantically relevant identifiers, |
| 69 | /// so the definition of "canonical" here is different than in the AST, e.g. |
| 70 | /// |
| 71 | /// \code |
| 72 | /// class C { |
| 73 | /// C() {} |
| 74 | /// }; |
| 75 | /// \endcode |
| 76 | /// |
| 77 | /// we consider the canonical decl of the constructor decl to be the class |
| 78 | /// itself, so both 'C' can be highlighted. |
Dmitri Gribenko | e22339c | 2013-01-23 17:25:27 +0000 | [diff] [blame] | 79 | const Decl *getCanonical(const Decl *D) const { |
Argyrios Kyrtzidis | e368a64 | 2011-12-08 01:56:07 +0000 | [diff] [blame] | 80 | if (!D) |
| 81 | return 0; |
| 82 | |
Argyrios Kyrtzidis | aed123e | 2011-10-06 07:00:54 +0000 | [diff] [blame] | 83 | D = D->getCanonicalDecl(); |
| 84 | |
Dmitri Gribenko | e22339c | 2013-01-23 17:25:27 +0000 | [diff] [blame] | 85 | if (const ObjCImplDecl *ImplD = dyn_cast<ObjCImplDecl>(D)) { |
Argyrios Kyrtzidis | e368a64 | 2011-12-08 01:56:07 +0000 | [diff] [blame] | 86 | if (ImplD->getClassInterface()) |
| 87 | return getCanonical(ImplD->getClassInterface()); |
| 88 | |
Dmitri Gribenko | e22339c | 2013-01-23 17:25:27 +0000 | [diff] [blame] | 89 | } else if (const CXXConstructorDecl *CXXCtorD = |
| 90 | dyn_cast<CXXConstructorDecl>(D)) { |
Argyrios Kyrtzidis | aed123e | 2011-10-06 07:00:54 +0000 | [diff] [blame] | 91 | return getCanonical(CXXCtorD->getParent()); |
Argyrios Kyrtzidis | e368a64 | 2011-12-08 01:56:07 +0000 | [diff] [blame] | 92 | } |
Argyrios Kyrtzidis | aed123e | 2011-10-06 07:00:54 +0000 | [diff] [blame] | 93 | |
| 94 | return D; |
| 95 | } |
| 96 | |
Dmitri Gribenko | e22339c | 2013-01-23 17:25:27 +0000 | [diff] [blame] | 97 | bool isHit(const Decl *D) const { |
Argyrios Kyrtzidis | e368a64 | 2011-12-08 01:56:07 +0000 | [diff] [blame] | 98 | if (!D) |
| 99 | return false; |
| 100 | |
Argyrios Kyrtzidis | aed123e | 2011-10-06 07:00:54 +0000 | [diff] [blame] | 101 | D = getCanonical(D); |
| 102 | if (D == Dcl) |
| 103 | return true; |
| 104 | |
| 105 | if (isa<ObjCMethodDecl>(D) || isa<CXXMethodDecl>(D)) |
| 106 | return isOverriddingMethod(D); |
| 107 | |
| 108 | return false; |
| 109 | } |
| 110 | |
| 111 | private: |
Dmitri Gribenko | e22339c | 2013-01-23 17:25:27 +0000 | [diff] [blame] | 112 | bool isOverriddingMethod(const Decl *D) const { |
Argyrios Kyrtzidis | aed123e | 2011-10-06 07:00:54 +0000 | [diff] [blame] | 113 | if (std::find(TopMethods.begin(), TopMethods.end(), D) != |
| 114 | TopMethods.end()) |
| 115 | return true; |
| 116 | |
| 117 | TopMethodsTy methods; |
| 118 | getTopOverriddenMethods(TU, D, methods); |
| 119 | for (TopMethodsTy::iterator |
| 120 | I = methods.begin(), E = methods.end(); I != E; ++I) { |
| 121 | if (std::find(TopMethods.begin(), TopMethods.end(), *I) != |
| 122 | TopMethods.end()) |
| 123 | return true; |
| 124 | } |
| 125 | |
| 126 | return false; |
| 127 | } |
| 128 | }; |
| 129 | |
| 130 | } // end anonymous namespace. |
| 131 | |
| 132 | /// \brief For a macro \arg Loc, returns the file spelling location and sets |
| 133 | /// to \arg isMacroArg whether the spelling resides inside a macro definition or |
| 134 | /// a macro argument. |
| 135 | static SourceLocation getFileSpellingLoc(SourceManager &SM, |
| 136 | SourceLocation Loc, |
| 137 | bool &isMacroArg) { |
| 138 | assert(Loc.isMacroID()); |
| 139 | SourceLocation SpellLoc = SM.getImmediateSpellingLoc(Loc); |
| 140 | if (SpellLoc.isMacroID()) |
| 141 | return getFileSpellingLoc(SM, SpellLoc, isMacroArg); |
| 142 | |
| 143 | isMacroArg = SM.isMacroArgExpansion(Loc); |
| 144 | return SpellLoc; |
| 145 | } |
| 146 | |
| 147 | static enum CXChildVisitResult findFileIdRefVisit(CXCursor cursor, |
| 148 | CXCursor parent, |
| 149 | CXClientData client_data) { |
| 150 | CXCursor declCursor = clang_getCursorReferenced(cursor); |
| 151 | if (!clang_isDeclaration(declCursor.kind)) |
| 152 | return CXChildVisit_Recurse; |
| 153 | |
Dmitri Gribenko | e22339c | 2013-01-23 17:25:27 +0000 | [diff] [blame] | 154 | const Decl *D = cxcursor::getCursorDecl(declCursor); |
Argyrios Kyrtzidis | 16ed0e6 | 2011-12-10 02:36:25 +0000 | [diff] [blame] | 155 | if (!D) |
| 156 | return CXChildVisit_Continue; |
| 157 | |
Argyrios Kyrtzidis | aed123e | 2011-10-06 07:00:54 +0000 | [diff] [blame] | 158 | FindFileIdRefVisitData *data = (FindFileIdRefVisitData *)client_data; |
| 159 | if (data->isHit(D)) { |
| 160 | cursor = cxcursor::getSelectorIdentifierCursor(data->SelectorIdIdx, cursor); |
| 161 | |
| 162 | // We are looking for identifiers to highlight so for objc methods (and |
| 163 | // not a parameter) we can only highlight the selector identifiers. |
| 164 | if ((cursor.kind == CXCursor_ObjCClassMethodDecl || |
| 165 | cursor.kind == CXCursor_ObjCInstanceMethodDecl) && |
| 166 | cxcursor::getSelectorIdentifierIndex(cursor) == -1) |
| 167 | return CXChildVisit_Recurse; |
| 168 | |
| 169 | if (clang_isExpression(cursor.kind)) { |
| 170 | if (cursor.kind == CXCursor_DeclRefExpr || |
| 171 | cursor.kind == CXCursor_MemberRefExpr) { |
| 172 | // continue.. |
| 173 | |
| 174 | } else if (cursor.kind == CXCursor_ObjCMessageExpr && |
| 175 | cxcursor::getSelectorIdentifierIndex(cursor) != -1) { |
| 176 | // continue.. |
| 177 | |
| 178 | } else |
| 179 | return CXChildVisit_Recurse; |
| 180 | } |
| 181 | |
| 182 | SourceLocation |
| 183 | Loc = cxloc::translateSourceLocation(clang_getCursorLocation(cursor)); |
| 184 | SourceLocation SelIdLoc = cxcursor::getSelectorIdentifierLoc(cursor); |
| 185 | if (SelIdLoc.isValid()) |
| 186 | Loc = SelIdLoc; |
| 187 | |
Argyrios Kyrtzidis | b49e728 | 2011-11-29 03:14:11 +0000 | [diff] [blame] | 188 | ASTContext &Ctx = data->getASTContext(); |
| 189 | SourceManager &SM = Ctx.getSourceManager(); |
Argyrios Kyrtzidis | aed123e | 2011-10-06 07:00:54 +0000 | [diff] [blame] | 190 | bool isInMacroDef = false; |
| 191 | if (Loc.isMacroID()) { |
| 192 | bool isMacroArg; |
| 193 | Loc = getFileSpellingLoc(SM, Loc, isMacroArg); |
| 194 | isInMacroDef = !isMacroArg; |
| 195 | } |
| 196 | |
| 197 | // We are looking for identifiers in a specific file. |
| 198 | std::pair<FileID, unsigned> LocInfo = SM.getDecomposedLoc(Loc); |
| 199 | if (LocInfo.first != data->FID) |
| 200 | return CXChildVisit_Recurse; |
| 201 | |
| 202 | if (isInMacroDef) { |
| 203 | // FIXME: For a macro definition make sure that all expansions |
| 204 | // of it expand to the same reference before allowing to point to it. |
Argyrios Kyrtzidis | b49e728 | 2011-11-29 03:14:11 +0000 | [diff] [blame] | 205 | return CXChildVisit_Recurse; |
Argyrios Kyrtzidis | aed123e | 2011-10-06 07:00:54 +0000 | [diff] [blame] | 206 | } |
| 207 | |
Argyrios Kyrtzidis | 029c8f3 | 2013-03-08 02:32:29 +0000 | [diff] [blame] | 208 | if (data->visitor.visit(data->visitor.context, cursor, |
| 209 | cxloc::translateSourceRange(Ctx, Loc)) == CXVisit_Break) |
| 210 | return CXChildVisit_Break; |
Argyrios Kyrtzidis | aed123e | 2011-10-06 07:00:54 +0000 | [diff] [blame] | 211 | } |
| 212 | return CXChildVisit_Recurse; |
| 213 | } |
| 214 | |
Argyrios Kyrtzidis | 389dc56 | 2013-03-08 20:42:33 +0000 | [diff] [blame] | 215 | static bool findIdRefsInFile(CXTranslationUnit TU, CXCursor declCursor, |
| 216 | const FileEntry *File, |
| 217 | CXCursorAndRangeVisitor Visitor) { |
Argyrios Kyrtzidis | aed123e | 2011-10-06 07:00:54 +0000 | [diff] [blame] | 218 | assert(clang_isDeclaration(declCursor.kind)); |
Dmitri Gribenko | 5694feb | 2013-01-26 18:53:38 +0000 | [diff] [blame] | 219 | SourceManager &SM = cxtu::getASTUnit(TU)->getSourceManager(); |
Argyrios Kyrtzidis | aed123e | 2011-10-06 07:00:54 +0000 | [diff] [blame] | 220 | |
| 221 | FileID FID = SM.translateFile(File); |
Dmitri Gribenko | e22339c | 2013-01-23 17:25:27 +0000 | [diff] [blame] | 222 | const Decl *Dcl = cxcursor::getCursorDecl(declCursor); |
Argyrios Kyrtzidis | e368a64 | 2011-12-08 01:56:07 +0000 | [diff] [blame] | 223 | if (!Dcl) |
Argyrios Kyrtzidis | 389dc56 | 2013-03-08 20:42:33 +0000 | [diff] [blame] | 224 | return false; |
Argyrios Kyrtzidis | e368a64 | 2011-12-08 01:56:07 +0000 | [diff] [blame] | 225 | |
Argyrios Kyrtzidis | aed123e | 2011-10-06 07:00:54 +0000 | [diff] [blame] | 226 | FindFileIdRefVisitData data(TU, FID, Dcl, |
| 227 | cxcursor::getSelectorIdentifierIndex(declCursor), |
| 228 | Visitor); |
| 229 | |
Dmitri Gribenko | e22339c | 2013-01-23 17:25:27 +0000 | [diff] [blame] | 230 | if (const DeclContext *DC = Dcl->getParentFunctionOrMethod()) { |
Argyrios Kyrtzidis | 389dc56 | 2013-03-08 20:42:33 +0000 | [diff] [blame] | 231 | return clang_visitChildren(cxcursor::MakeCXCursor(cast<Decl>(DC), TU), |
| 232 | findFileIdRefVisit, &data); |
Argyrios Kyrtzidis | aed123e | 2011-10-06 07:00:54 +0000 | [diff] [blame] | 233 | } |
Argyrios Kyrtzidis | aed123e | 2011-10-06 07:00:54 +0000 | [diff] [blame] | 234 | |
Argyrios Kyrtzidis | e2079cf | 2011-11-16 08:58:54 +0000 | [diff] [blame] | 235 | SourceRange Range(SM.getLocForStartOfFile(FID), SM.getLocForEndOfFile(FID)); |
| 236 | CursorVisitor FindIdRefsVisitor(TU, |
| 237 | findFileIdRefVisit, &data, |
| 238 | /*VisitPreprocessorLast=*/true, |
| 239 | /*VisitIncludedEntities=*/false, |
Argyrios Kyrtzidis | b49e728 | 2011-11-29 03:14:11 +0000 | [diff] [blame] | 240 | Range, |
| 241 | /*VisitDeclsOnly=*/true); |
Argyrios Kyrtzidis | 389dc56 | 2013-03-08 20:42:33 +0000 | [diff] [blame] | 242 | return FindIdRefsVisitor.visitFileRegion(); |
Argyrios Kyrtzidis | aed123e | 2011-10-06 07:00:54 +0000 | [diff] [blame] | 243 | } |
| 244 | |
Argyrios Kyrtzidis | b49e728 | 2011-11-29 03:14:11 +0000 | [diff] [blame] | 245 | namespace { |
| 246 | |
| 247 | struct FindFileMacroRefVisitData { |
| 248 | ASTUnit &Unit; |
| 249 | const FileEntry *File; |
| 250 | const IdentifierInfo *Macro; |
| 251 | CXCursorAndRangeVisitor visitor; |
| 252 | |
| 253 | FindFileMacroRefVisitData(ASTUnit &Unit, const FileEntry *File, |
| 254 | const IdentifierInfo *Macro, |
| 255 | CXCursorAndRangeVisitor visitor) |
| 256 | : Unit(Unit), File(File), Macro(Macro), visitor(visitor) { } |
| 257 | |
| 258 | ASTContext &getASTContext() const { |
| 259 | return Unit.getASTContext(); |
| 260 | } |
| 261 | }; |
| 262 | |
| 263 | } // anonymous namespace |
| 264 | |
| 265 | static enum CXChildVisitResult findFileMacroRefVisit(CXCursor cursor, |
| 266 | CXCursor parent, |
| 267 | CXClientData client_data) { |
| 268 | const IdentifierInfo *Macro = 0; |
| 269 | if (cursor.kind == CXCursor_MacroDefinition) |
| 270 | Macro = getCursorMacroDefinition(cursor)->getName(); |
| 271 | else if (cursor.kind == CXCursor_MacroExpansion) |
Argyrios Kyrtzidis | 664b06f | 2013-01-07 19:16:25 +0000 | [diff] [blame] | 272 | Macro = getCursorMacroExpansion(cursor).getName(); |
Argyrios Kyrtzidis | b49e728 | 2011-11-29 03:14:11 +0000 | [diff] [blame] | 273 | if (!Macro) |
| 274 | return CXChildVisit_Continue; |
| 275 | |
| 276 | FindFileMacroRefVisitData *data = (FindFileMacroRefVisitData *)client_data; |
| 277 | if (data->Macro != Macro) |
| 278 | return CXChildVisit_Continue; |
| 279 | |
| 280 | SourceLocation |
| 281 | Loc = cxloc::translateSourceLocation(clang_getCursorLocation(cursor)); |
| 282 | |
| 283 | ASTContext &Ctx = data->getASTContext(); |
| 284 | SourceManager &SM = Ctx.getSourceManager(); |
| 285 | bool isInMacroDef = false; |
| 286 | if (Loc.isMacroID()) { |
| 287 | bool isMacroArg; |
| 288 | Loc = getFileSpellingLoc(SM, Loc, isMacroArg); |
| 289 | isInMacroDef = !isMacroArg; |
| 290 | } |
| 291 | |
| 292 | // We are looking for identifiers in a specific file. |
| 293 | std::pair<FileID, unsigned> LocInfo = SM.getDecomposedLoc(Loc); |
| 294 | if (SM.getFileEntryForID(LocInfo.first) != data->File) |
| 295 | return CXChildVisit_Continue; |
| 296 | |
| 297 | if (isInMacroDef) { |
| 298 | // FIXME: For a macro definition make sure that all expansions |
| 299 | // of it expand to the same reference before allowing to point to it. |
| 300 | return CXChildVisit_Continue; |
| 301 | } |
| 302 | |
Argyrios Kyrtzidis | 029c8f3 | 2013-03-08 02:32:29 +0000 | [diff] [blame] | 303 | if (data->visitor.visit(data->visitor.context, cursor, |
| 304 | cxloc::translateSourceRange(Ctx, Loc)) == CXVisit_Break) |
| 305 | return CXChildVisit_Break; |
Argyrios Kyrtzidis | b49e728 | 2011-11-29 03:14:11 +0000 | [diff] [blame] | 306 | return CXChildVisit_Continue; |
| 307 | } |
| 308 | |
Argyrios Kyrtzidis | 389dc56 | 2013-03-08 20:42:33 +0000 | [diff] [blame] | 309 | static bool findMacroRefsInFile(CXTranslationUnit TU, CXCursor Cursor, |
Argyrios Kyrtzidis | b49e728 | 2011-11-29 03:14:11 +0000 | [diff] [blame] | 310 | const FileEntry *File, |
| 311 | CXCursorAndRangeVisitor Visitor) { |
| 312 | if (Cursor.kind != CXCursor_MacroDefinition && |
| 313 | Cursor.kind != CXCursor_MacroExpansion) |
Argyrios Kyrtzidis | 389dc56 | 2013-03-08 20:42:33 +0000 | [diff] [blame] | 314 | return false; |
Argyrios Kyrtzidis | b49e728 | 2011-11-29 03:14:11 +0000 | [diff] [blame] | 315 | |
Dmitri Gribenko | 5694feb | 2013-01-26 18:53:38 +0000 | [diff] [blame] | 316 | ASTUnit *Unit = cxtu::getASTUnit(TU); |
Argyrios Kyrtzidis | b49e728 | 2011-11-29 03:14:11 +0000 | [diff] [blame] | 317 | SourceManager &SM = Unit->getSourceManager(); |
| 318 | |
| 319 | FileID FID = SM.translateFile(File); |
| 320 | const IdentifierInfo *Macro = 0; |
| 321 | if (Cursor.kind == CXCursor_MacroDefinition) |
| 322 | Macro = getCursorMacroDefinition(Cursor)->getName(); |
| 323 | else |
Argyrios Kyrtzidis | 664b06f | 2013-01-07 19:16:25 +0000 | [diff] [blame] | 324 | Macro = getCursorMacroExpansion(Cursor).getName(); |
Argyrios Kyrtzidis | b49e728 | 2011-11-29 03:14:11 +0000 | [diff] [blame] | 325 | if (!Macro) |
Argyrios Kyrtzidis | 389dc56 | 2013-03-08 20:42:33 +0000 | [diff] [blame] | 326 | return false; |
Argyrios Kyrtzidis | b49e728 | 2011-11-29 03:14:11 +0000 | [diff] [blame] | 327 | |
| 328 | FindFileMacroRefVisitData data(*Unit, File, Macro, Visitor); |
| 329 | |
| 330 | SourceRange Range(SM.getLocForStartOfFile(FID), SM.getLocForEndOfFile(FID)); |
| 331 | CursorVisitor FindMacroRefsVisitor(TU, |
| 332 | findFileMacroRefVisit, &data, |
| 333 | /*VisitPreprocessorLast=*/false, |
| 334 | /*VisitIncludedEntities=*/false, |
| 335 | Range); |
Argyrios Kyrtzidis | 389dc56 | 2013-03-08 20:42:33 +0000 | [diff] [blame] | 336 | return FindMacroRefsVisitor.visitPreprocessedEntitiesInRegion(); |
Argyrios Kyrtzidis | b49e728 | 2011-11-29 03:14:11 +0000 | [diff] [blame] | 337 | } |
| 338 | |
Argyrios Kyrtzidis | ee2d5fd | 2013-03-08 02:32:34 +0000 | [diff] [blame] | 339 | namespace { |
| 340 | |
| 341 | struct FindFileIncludesVisitor { |
| 342 | ASTUnit &Unit; |
| 343 | const FileEntry *File; |
| 344 | CXCursorAndRangeVisitor visitor; |
| 345 | |
| 346 | FindFileIncludesVisitor(ASTUnit &Unit, const FileEntry *File, |
| 347 | CXCursorAndRangeVisitor visitor) |
| 348 | : Unit(Unit), File(File), visitor(visitor) { } |
| 349 | |
| 350 | ASTContext &getASTContext() const { |
| 351 | return Unit.getASTContext(); |
| 352 | } |
| 353 | |
| 354 | enum CXChildVisitResult visit(CXCursor cursor, CXCursor parent) { |
| 355 | if (cursor.kind != CXCursor_InclusionDirective) |
| 356 | return CXChildVisit_Continue; |
| 357 | |
| 358 | SourceLocation |
| 359 | Loc = cxloc::translateSourceLocation(clang_getCursorLocation(cursor)); |
| 360 | |
| 361 | ASTContext &Ctx = getASTContext(); |
| 362 | SourceManager &SM = Ctx.getSourceManager(); |
| 363 | |
| 364 | // We are looking for includes in a specific file. |
| 365 | std::pair<FileID, unsigned> LocInfo = SM.getDecomposedLoc(Loc); |
| 366 | if (SM.getFileEntryForID(LocInfo.first) != File) |
| 367 | return CXChildVisit_Continue; |
| 368 | |
| 369 | if (visitor.visit(visitor.context, cursor, |
| 370 | cxloc::translateSourceRange(Ctx, Loc)) == CXVisit_Break) |
| 371 | return CXChildVisit_Break; |
| 372 | return CXChildVisit_Continue; |
| 373 | } |
| 374 | |
| 375 | static enum CXChildVisitResult visit(CXCursor cursor, CXCursor parent, |
| 376 | CXClientData client_data) { |
| 377 | return static_cast<FindFileIncludesVisitor*>(client_data)-> |
| 378 | visit(cursor, parent); |
| 379 | } |
| 380 | }; |
| 381 | |
| 382 | } // anonymous namespace |
| 383 | |
Argyrios Kyrtzidis | 389dc56 | 2013-03-08 20:42:33 +0000 | [diff] [blame] | 384 | static bool findIncludesInFile(CXTranslationUnit TU, const FileEntry *File, |
Argyrios Kyrtzidis | ee2d5fd | 2013-03-08 02:32:34 +0000 | [diff] [blame] | 385 | CXCursorAndRangeVisitor Visitor) { |
| 386 | assert(TU && File && Visitor.visit); |
| 387 | |
| 388 | ASTUnit *Unit = cxtu::getASTUnit(TU); |
| 389 | SourceManager &SM = Unit->getSourceManager(); |
| 390 | |
| 391 | FileID FID = SM.translateFile(File); |
| 392 | |
| 393 | FindFileIncludesVisitor IncludesVisitor(*Unit, File, Visitor); |
| 394 | |
| 395 | SourceRange Range(SM.getLocForStartOfFile(FID), SM.getLocForEndOfFile(FID)); |
| 396 | CursorVisitor InclusionCursorsVisitor(TU, |
| 397 | FindFileIncludesVisitor::visit, |
| 398 | &IncludesVisitor, |
| 399 | /*VisitPreprocessorLast=*/false, |
| 400 | /*VisitIncludedEntities=*/false, |
| 401 | Range); |
Argyrios Kyrtzidis | 389dc56 | 2013-03-08 20:42:33 +0000 | [diff] [blame] | 402 | return InclusionCursorsVisitor.visitPreprocessedEntitiesInRegion(); |
Argyrios Kyrtzidis | ee2d5fd | 2013-03-08 02:32:34 +0000 | [diff] [blame] | 403 | } |
| 404 | |
Argyrios Kyrtzidis | aed123e | 2011-10-06 07:00:54 +0000 | [diff] [blame] | 405 | |
| 406 | //===----------------------------------------------------------------------===// |
| 407 | // libclang public APIs. |
| 408 | //===----------------------------------------------------------------------===// |
| 409 | |
| 410 | extern "C" { |
| 411 | |
Argyrios Kyrtzidis | 6f09c3d | 2013-03-08 22:47:41 +0000 | [diff] [blame] | 412 | CXResult clang_findReferencesInFile(CXCursor cursor, CXFile file, |
| 413 | CXCursorAndRangeVisitor visitor) { |
Dmitri Gribenko | acbe4ba | 2013-01-11 02:23:13 +0000 | [diff] [blame] | 414 | LogRef Log = Logger::make(LLVM_FUNCTION_NAME); |
Argyrios Kyrtzidis | aed123e | 2011-10-06 07:00:54 +0000 | [diff] [blame] | 415 | |
| 416 | if (clang_Cursor_isNull(cursor)) { |
Argyrios Kyrtzidis | c6f5c6a | 2013-01-10 18:54:52 +0000 | [diff] [blame] | 417 | if (Log) |
| 418 | *Log << "Null cursor"; |
Argyrios Kyrtzidis | 6f09c3d | 2013-03-08 22:47:41 +0000 | [diff] [blame] | 419 | return CXResult_Invalid; |
Argyrios Kyrtzidis | aed123e | 2011-10-06 07:00:54 +0000 | [diff] [blame] | 420 | } |
Argyrios Kyrtzidis | 4451746 | 2011-12-09 00:17:49 +0000 | [diff] [blame] | 421 | if (cursor.kind == CXCursor_NoDeclFound) { |
Argyrios Kyrtzidis | c6f5c6a | 2013-01-10 18:54:52 +0000 | [diff] [blame] | 422 | if (Log) |
| 423 | *Log << "Got CXCursor_NoDeclFound"; |
Argyrios Kyrtzidis | 6f09c3d | 2013-03-08 22:47:41 +0000 | [diff] [blame] | 424 | return CXResult_Invalid; |
Argyrios Kyrtzidis | 4451746 | 2011-12-09 00:17:49 +0000 | [diff] [blame] | 425 | } |
Argyrios Kyrtzidis | aed123e | 2011-10-06 07:00:54 +0000 | [diff] [blame] | 426 | if (!file) { |
Argyrios Kyrtzidis | c6f5c6a | 2013-01-10 18:54:52 +0000 | [diff] [blame] | 427 | if (Log) |
| 428 | *Log << "Null file"; |
Argyrios Kyrtzidis | 6f09c3d | 2013-03-08 22:47:41 +0000 | [diff] [blame] | 429 | return CXResult_Invalid; |
Argyrios Kyrtzidis | aed123e | 2011-10-06 07:00:54 +0000 | [diff] [blame] | 430 | } |
| 431 | if (!visitor.visit) { |
Argyrios Kyrtzidis | c6f5c6a | 2013-01-10 18:54:52 +0000 | [diff] [blame] | 432 | if (Log) |
| 433 | *Log << "Null visitor"; |
Argyrios Kyrtzidis | 6f09c3d | 2013-03-08 22:47:41 +0000 | [diff] [blame] | 434 | return CXResult_Invalid; |
Argyrios Kyrtzidis | aed123e | 2011-10-06 07:00:54 +0000 | [diff] [blame] | 435 | } |
| 436 | |
Argyrios Kyrtzidis | b70e7a8 | 2013-03-08 02:32:26 +0000 | [diff] [blame] | 437 | if (Log) |
| 438 | *Log << cursor << " @" << static_cast<const FileEntry *>(file); |
| 439 | |
Argyrios Kyrtzidis | 5c2a1f7 | 2011-11-29 23:21:50 +0000 | [diff] [blame] | 440 | ASTUnit *CXXUnit = cxcursor::getCursorASTUnit(cursor); |
| 441 | if (!CXXUnit) |
Argyrios Kyrtzidis | 6f09c3d | 2013-03-08 22:47:41 +0000 | [diff] [blame] | 442 | return CXResult_Invalid; |
Argyrios Kyrtzidis | 5c2a1f7 | 2011-11-29 23:21:50 +0000 | [diff] [blame] | 443 | |
| 444 | ASTUnit::ConcurrencyCheck Check(*CXXUnit); |
| 445 | |
Argyrios Kyrtzidis | b49e728 | 2011-11-29 03:14:11 +0000 | [diff] [blame] | 446 | if (cursor.kind == CXCursor_MacroDefinition || |
| 447 | cursor.kind == CXCursor_MacroExpansion) { |
Argyrios Kyrtzidis | 389dc56 | 2013-03-08 20:42:33 +0000 | [diff] [blame] | 448 | if (findMacroRefsInFile(cxcursor::getCursorTU(cursor), |
| 449 | cursor, |
| 450 | static_cast<const FileEntry *>(file), |
| 451 | visitor)) |
Argyrios Kyrtzidis | 6f09c3d | 2013-03-08 22:47:41 +0000 | [diff] [blame] | 452 | return CXResult_VisitBreak; |
| 453 | return CXResult_Success; |
Argyrios Kyrtzidis | b49e728 | 2011-11-29 03:14:11 +0000 | [diff] [blame] | 454 | } |
| 455 | |
Argyrios Kyrtzidis | aed123e | 2011-10-06 07:00:54 +0000 | [diff] [blame] | 456 | // We are interested in semantics of identifiers so for C++ constructor exprs |
| 457 | // prefer type references, e.g.: |
| 458 | // |
| 459 | // return MyStruct(); |
| 460 | // |
| 461 | // for 'MyStruct' we'll have a cursor pointing at the constructor decl but |
| 462 | // we are actually interested in the type declaration. |
| 463 | cursor = cxcursor::getTypeRefCursor(cursor); |
| 464 | |
| 465 | CXCursor refCursor = clang_getCursorReferenced(cursor); |
| 466 | |
| 467 | if (!clang_isDeclaration(refCursor.kind)) { |
Argyrios Kyrtzidis | c6f5c6a | 2013-01-10 18:54:52 +0000 | [diff] [blame] | 468 | if (Log) |
| 469 | *Log << "cursor is not referencing a declaration"; |
Argyrios Kyrtzidis | 6f09c3d | 2013-03-08 22:47:41 +0000 | [diff] [blame] | 470 | return CXResult_Invalid; |
Argyrios Kyrtzidis | aed123e | 2011-10-06 07:00:54 +0000 | [diff] [blame] | 471 | } |
| 472 | |
Argyrios Kyrtzidis | 389dc56 | 2013-03-08 20:42:33 +0000 | [diff] [blame] | 473 | if (findIdRefsInFile(cxcursor::getCursorTU(cursor), |
| 474 | refCursor, |
| 475 | static_cast<const FileEntry *>(file), |
| 476 | visitor)) |
Argyrios Kyrtzidis | 6f09c3d | 2013-03-08 22:47:41 +0000 | [diff] [blame] | 477 | return CXResult_VisitBreak; |
| 478 | return CXResult_Success; |
Argyrios Kyrtzidis | aed123e | 2011-10-06 07:00:54 +0000 | [diff] [blame] | 479 | } |
| 480 | |
Argyrios Kyrtzidis | 6f09c3d | 2013-03-08 22:47:41 +0000 | [diff] [blame] | 481 | CXResult clang_findIncludesInFile(CXTranslationUnit TU, CXFile file, |
Argyrios Kyrtzidis | 389dc56 | 2013-03-08 20:42:33 +0000 | [diff] [blame] | 482 | CXCursorAndRangeVisitor visitor) { |
Argyrios Kyrtzidis | ee2d5fd | 2013-03-08 02:32:34 +0000 | [diff] [blame] | 483 | LogRef Log = Logger::make(LLVM_FUNCTION_NAME); |
| 484 | |
| 485 | if (!TU) { |
| 486 | if (Log) |
| 487 | *Log << "Null CXTranslationUnit"; |
Argyrios Kyrtzidis | 6f09c3d | 2013-03-08 22:47:41 +0000 | [diff] [blame] | 488 | return CXResult_Invalid; |
Argyrios Kyrtzidis | ee2d5fd | 2013-03-08 02:32:34 +0000 | [diff] [blame] | 489 | } |
| 490 | if (!file) { |
| 491 | if (Log) |
| 492 | *Log << "Null file"; |
Argyrios Kyrtzidis | 6f09c3d | 2013-03-08 22:47:41 +0000 | [diff] [blame] | 493 | return CXResult_Invalid; |
Argyrios Kyrtzidis | ee2d5fd | 2013-03-08 02:32:34 +0000 | [diff] [blame] | 494 | } |
| 495 | if (!visitor.visit) { |
| 496 | if (Log) |
| 497 | *Log << "Null visitor"; |
Argyrios Kyrtzidis | 6f09c3d | 2013-03-08 22:47:41 +0000 | [diff] [blame] | 498 | return CXResult_Invalid; |
Argyrios Kyrtzidis | ee2d5fd | 2013-03-08 02:32:34 +0000 | [diff] [blame] | 499 | } |
| 500 | |
| 501 | if (Log) |
| 502 | *Log << TU << " @" << static_cast<const FileEntry *>(file); |
| 503 | |
| 504 | ASTUnit *CXXUnit = cxtu::getASTUnit(TU); |
| 505 | if (!CXXUnit) |
Argyrios Kyrtzidis | 6f09c3d | 2013-03-08 22:47:41 +0000 | [diff] [blame] | 506 | return CXResult_Invalid; |
Argyrios Kyrtzidis | ee2d5fd | 2013-03-08 02:32:34 +0000 | [diff] [blame] | 507 | |
| 508 | ASTUnit::ConcurrencyCheck Check(*CXXUnit); |
| 509 | |
Argyrios Kyrtzidis | 389dc56 | 2013-03-08 20:42:33 +0000 | [diff] [blame] | 510 | if (findIncludesInFile(TU, static_cast<const FileEntry *>(file), visitor)) |
Argyrios Kyrtzidis | 6f09c3d | 2013-03-08 22:47:41 +0000 | [diff] [blame] | 511 | return CXResult_VisitBreak; |
| 512 | return CXResult_Success; |
Argyrios Kyrtzidis | ee2d5fd | 2013-03-08 02:32:34 +0000 | [diff] [blame] | 513 | } |
| 514 | |
Argyrios Kyrtzidis | aed123e | 2011-10-06 07:00:54 +0000 | [diff] [blame] | 515 | static enum CXVisitorResult _visitCursorAndRange(void *context, |
| 516 | CXCursor cursor, |
| 517 | CXSourceRange range) { |
| 518 | CXCursorAndRangeVisitorBlock block = (CXCursorAndRangeVisitorBlock)context; |
| 519 | return INVOKE_BLOCK2(block, cursor, range); |
| 520 | } |
| 521 | |
Argyrios Kyrtzidis | 6f09c3d | 2013-03-08 22:47:41 +0000 | [diff] [blame] | 522 | CXResult clang_findReferencesInFileWithBlock(CXCursor cursor, |
| 523 | CXFile file, |
| 524 | CXCursorAndRangeVisitorBlock block) { |
Argyrios Kyrtzidis | aed123e | 2011-10-06 07:00:54 +0000 | [diff] [blame] | 525 | CXCursorAndRangeVisitor visitor = { block, |
| 526 | block ? _visitCursorAndRange : 0 }; |
| 527 | return clang_findReferencesInFile(cursor, file, visitor); |
| 528 | } |
| 529 | |
Argyrios Kyrtzidis | 6f09c3d | 2013-03-08 22:47:41 +0000 | [diff] [blame] | 530 | CXResult clang_findIncludesInFileWithBlock(CXTranslationUnit TU, |
| 531 | CXFile file, |
| 532 | CXCursorAndRangeVisitorBlock block) { |
Argyrios Kyrtzidis | ee2d5fd | 2013-03-08 02:32:34 +0000 | [diff] [blame] | 533 | CXCursorAndRangeVisitor visitor = { block, |
| 534 | block ? _visitCursorAndRange : 0 }; |
| 535 | return clang_findIncludesInFile(TU, file, visitor); |
| 536 | } |
| 537 | |
Argyrios Kyrtzidis | aed123e | 2011-10-06 07:00:54 +0000 | [diff] [blame] | 538 | } // end: extern "C" |
| 539 | |