head 1.1; branch 1.1.1; access; symbols netbsd-11-0-RC4:1.1.1.6 netbsd-11-0-RC3:1.1.1.6 netbsd-11-0-RC2:1.1.1.6 netbsd-11-0-RC1:1.1.1.6 perseant-exfatfs-base-20250801:1.1.1.6 netbsd-11:1.1.1.6.0.10 netbsd-11-base:1.1.1.6 netbsd-10-1-RELEASE:1.1.1.6 perseant-exfatfs-base-20240630:1.1.1.6 perseant-exfatfs:1.1.1.6.0.8 perseant-exfatfs-base:1.1.1.6 netbsd-8-3-RELEASE:1.1.1.4 netbsd-9-4-RELEASE:1.1.1.5 netbsd-10-0-RELEASE:1.1.1.6 netbsd-10-0-RC6:1.1.1.6 netbsd-10-0-RC5:1.1.1.6 netbsd-10-0-RC4:1.1.1.6 netbsd-10-0-RC3:1.1.1.6 netbsd-10-0-RC2:1.1.1.6 netbsd-10-0-RC1:1.1.1.6 netbsd-10:1.1.1.6.0.6 netbsd-10-base:1.1.1.6 netbsd-9-3-RELEASE:1.1.1.5 cjep_sun2x:1.1.1.6.0.4 cjep_sun2x-base:1.1.1.6 cjep_staticlib_x-base1:1.1.1.6 netbsd-9-2-RELEASE:1.1.1.5 cjep_staticlib_x:1.1.1.6.0.2 cjep_staticlib_x-base:1.1.1.6 netbsd-9-1-RELEASE:1.1.1.5 phil-wifi-20200421:1.1.1.6 phil-wifi-20200411:1.1.1.6 phil-wifi-20200406:1.1.1.6 netbsd-8-2-RELEASE:1.1.1.4 netbsd-9-0-RELEASE:1.1.1.5 netbsd-9-0-RC2:1.1.1.5 netbsd-9-0-RC1:1.1.1.5 netbsd-9:1.1.1.5.0.2 netbsd-9-base:1.1.1.5 phil-wifi-20190609:1.1.1.5 netbsd-8-1-RELEASE:1.1.1.4 netbsd-8-1-RC1:1.1.1.4 pgoyette-compat-merge-20190127:1.1.1.4.12.1 pgoyette-compat-20190127:1.1.1.5 pgoyette-compat-20190118:1.1.1.5 pgoyette-compat-1226:1.1.1.5 pgoyette-compat-1126:1.1.1.5 pgoyette-compat-1020:1.1.1.5 pgoyette-compat-0930:1.1.1.5 pgoyette-compat-0906:1.1.1.5 netbsd-7-2-RELEASE:1.1.1.3 pgoyette-compat-0728:1.1.1.5 clang-337282:1.1.1.5 netbsd-8-0-RELEASE:1.1.1.4 phil-wifi:1.1.1.4.0.14 phil-wifi-base:1.1.1.4 pgoyette-compat-0625:1.1.1.4 netbsd-8-0-RC2:1.1.1.4 pgoyette-compat-0521:1.1.1.4 pgoyette-compat-0502:1.1.1.4 pgoyette-compat-0422:1.1.1.4 netbsd-8-0-RC1:1.1.1.4 pgoyette-compat-0415:1.1.1.4 pgoyette-compat-0407:1.1.1.4 pgoyette-compat-0330:1.1.1.4 pgoyette-compat-0322:1.1.1.4 pgoyette-compat-0315:1.1.1.4 netbsd-7-1-2-RELEASE:1.1.1.3 pgoyette-compat:1.1.1.4.0.12 pgoyette-compat-base:1.1.1.4 netbsd-7-1-1-RELEASE:1.1.1.3 clang-319952:1.1.1.4 matt-nb8-mediatek:1.1.1.4.0.10 matt-nb8-mediatek-base:1.1.1.4 clang-309604:1.1.1.4 perseant-stdc-iso10646:1.1.1.4.0.8 perseant-stdc-iso10646-base:1.1.1.4 netbsd-8:1.1.1.4.0.6 netbsd-8-base:1.1.1.4 prg-localcount2-base3:1.1.1.4 prg-localcount2-base2:1.1.1.4 prg-localcount2-base1:1.1.1.4 prg-localcount2:1.1.1.4.0.4 prg-localcount2-base:1.1.1.4 pgoyette-localcount-20170426:1.1.1.4 bouyer-socketcan-base1:1.1.1.4 pgoyette-localcount-20170320:1.1.1.4 netbsd-7-1:1.1.1.3.0.12 netbsd-7-1-RELEASE:1.1.1.3 netbsd-7-1-RC2:1.1.1.3 clang-294123:1.1.1.4 netbsd-7-nhusb-base-20170116:1.1.1.3 bouyer-socketcan:1.1.1.4.0.2 bouyer-socketcan-base:1.1.1.4 clang-291444:1.1.1.4 pgoyette-localcount-20170107:1.1.1.3 netbsd-7-1-RC1:1.1.1.3 pgoyette-localcount-20161104:1.1.1.3 netbsd-7-0-2-RELEASE:1.1.1.3 localcount-20160914:1.1.1.3 netbsd-7-nhusb:1.1.1.3.0.10 netbsd-7-nhusb-base:1.1.1.3 clang-280599:1.1.1.3 pgoyette-localcount-20160806:1.1.1.3 pgoyette-localcount-20160726:1.1.1.3 pgoyette-localcount:1.1.1.3.0.8 pgoyette-localcount-base:1.1.1.3 netbsd-7-0-1-RELEASE:1.1.1.3 clang-261930:1.1.1.3 netbsd-7-0:1.1.1.3.0.6 netbsd-7-0-RELEASE:1.1.1.3 netbsd-7-0-RC3:1.1.1.3 netbsd-7-0-RC2:1.1.1.3 netbsd-7-0-RC1:1.1.1.3 clang-237755:1.1.1.3 clang-232565:1.1.1.3 clang-227398:1.1.1.3 tls-maxphys-base:1.1.1.3 tls-maxphys:1.1.1.3.0.4 netbsd-7:1.1.1.3.0.2 netbsd-7-base:1.1.1.3 clang-215315:1.1.1.3 clang-209886:1.1.1.2 yamt-pagecache:1.1.1.2.0.4 yamt-pagecache-base9:1.1.1.2 tls-earlyentropy:1.1.1.2.0.2 tls-earlyentropy-base:1.1.1.2 riastradh-xf86-video-intel-2-7-1-pre-2-21-15:1.1.1.2 riastradh-drm2-base3:1.1.1.2 clang-202566:1.1.1.2 clang-201163:1.1.1.2 clang-199312:1.1.1.1 clang-198450:1.1.1.1 clang-196603:1.1.1.1 clang-195771:1.1.1.1 LLVM:1.1.1; locks; strict; comment @// @; 1.1 date 2013.11.28.14.14.48; author joerg; state Exp; branches 1.1.1.1; next ; commitid ow8OybrawrB1f3fx; 1.1.1.1 date 2013.11.28.14.14.48; author joerg; state Exp; branches; next 1.1.1.2; commitid ow8OybrawrB1f3fx; 1.1.1.2 date 2014.02.14.20.07.02; author joerg; state Exp; branches 1.1.1.2.4.1; next 1.1.1.3; commitid annVkZ1sc17rF6px; 1.1.1.3 date 2014.08.10.17.08.24; author joerg; state Exp; branches 1.1.1.3.4.1 1.1.1.3.8.1; next 1.1.1.4; commitid N85tXAN6Ex9VZPLx; 1.1.1.4 date 2017.01.11.10.32.19; author joerg; state Exp; branches 1.1.1.4.12.1 1.1.1.4.14.1; next 1.1.1.5; commitid CNnUNfII1jgNmxBz; 1.1.1.5 date 2018.07.17.18.32.08; author joerg; state Exp; branches; next 1.1.1.6; commitid wDzL46ALjrCZgwKA; 1.1.1.6 date 2019.11.13.22.23.06; author joerg; state dead; branches; next ; commitid QD8YATxuNG34YJKB; 1.1.1.2.4.1 date 2014.02.14.20.07.02; author yamt; state dead; branches; next 1.1.1.2.4.2; commitid WSrDtL5nYAUyiyBx; 1.1.1.2.4.2 date 2014.05.22.16.19.47; author yamt; state Exp; branches; next ; commitid WSrDtL5nYAUyiyBx; 1.1.1.3.4.1 date 2014.08.10.17.08.24; author tls; state dead; branches; next 1.1.1.3.4.2; commitid jTnpym9Qu0o4R1Nx; 1.1.1.3.4.2 date 2014.08.19.23.49.27; author tls; state Exp; branches; next ; commitid jTnpym9Qu0o4R1Nx; 1.1.1.3.8.1 date 2017.03.20.06.53.37; author pgoyette; state Exp; branches; next ; commitid jjw7cAwgyKq7RfKz; 1.1.1.4.12.1 date 2018.07.28.04.34.16; author pgoyette; state Exp; branches; next ; commitid 1UP1xAIUxv1ZgRLA; 1.1.1.4.14.1 date 2019.06.10.21.46.43; author christos; state Exp; branches; next 1.1.1.4.14.2; commitid jtc8rnCzWiEEHGqB; 1.1.1.4.14.2 date 2020.04.13.07.50.33; author martin; state dead; branches; next ; commitid X01YhRUPVUDaec4C; desc @@ 1.1 log @Initial revision @ text @//===- CIndexHigh.cpp - Higher level API functions ------------------------===// // // The LLVM Compiler Infrastructure // // This file is distributed under the University of Illinois Open Source // License. See LICENSE.TXT for details. // //===----------------------------------------------------------------------===// #include "CursorVisitor.h" #include "CLog.h" #include "CXCursor.h" #include "CXSourceLocation.h" #include "CXTranslationUnit.h" #include "clang/AST/DeclObjC.h" #include "clang/Frontend/ASTUnit.h" #include "llvm/Support/Compiler.h" using namespace clang; using namespace cxcursor; using namespace cxindex; static void getTopOverriddenMethods(CXTranslationUnit TU, const Decl *D, SmallVectorImpl &Methods) { if (!D) return; if (!isa(D) && !isa(D)) return; SmallVector Overridden; cxcursor::getOverriddenCursors(cxcursor::MakeCXCursor(D, TU), Overridden); if (Overridden.empty()) { Methods.push_back(D->getCanonicalDecl()); return; } for (SmallVectorImpl::iterator I = Overridden.begin(), E = Overridden.end(); I != E; ++I) getTopOverriddenMethods(TU, cxcursor::getCursorDecl(*I), Methods); } namespace { struct FindFileIdRefVisitData { CXTranslationUnit TU; FileID FID; const Decl *Dcl; int SelectorIdIdx; CXCursorAndRangeVisitor visitor; typedef SmallVector TopMethodsTy; TopMethodsTy TopMethods; FindFileIdRefVisitData(CXTranslationUnit TU, FileID FID, const Decl *D, int selectorIdIdx, CXCursorAndRangeVisitor visitor) : TU(TU), FID(FID), SelectorIdIdx(selectorIdIdx), visitor(visitor) { Dcl = getCanonical(D); getTopOverriddenMethods(TU, Dcl, TopMethods); } ASTContext &getASTContext() const { return cxtu::getASTUnit(TU)->getASTContext(); } /// \brief We are looking to find all semantically relevant identifiers, /// so the definition of "canonical" here is different than in the AST, e.g. /// /// \code /// class C { /// C() {} /// }; /// \endcode /// /// we consider the canonical decl of the constructor decl to be the class /// itself, so both 'C' can be highlighted. const Decl *getCanonical(const Decl *D) const { if (!D) return 0; D = D->getCanonicalDecl(); if (const ObjCImplDecl *ImplD = dyn_cast(D)) { if (ImplD->getClassInterface()) return getCanonical(ImplD->getClassInterface()); } else if (const CXXConstructorDecl *CXXCtorD = dyn_cast(D)) { return getCanonical(CXXCtorD->getParent()); } return D; } bool isHit(const Decl *D) const { if (!D) return false; D = getCanonical(D); if (D == Dcl) return true; if (isa(D) || isa(D)) return isOverriddingMethod(D); return false; } private: bool isOverriddingMethod(const Decl *D) const { if (std::find(TopMethods.begin(), TopMethods.end(), D) != TopMethods.end()) return true; TopMethodsTy methods; getTopOverriddenMethods(TU, D, methods); for (TopMethodsTy::iterator I = methods.begin(), E = methods.end(); I != E; ++I) { if (std::find(TopMethods.begin(), TopMethods.end(), *I) != TopMethods.end()) return true; } return false; } }; } // end anonymous namespace. /// \brief For a macro \arg Loc, returns the file spelling location and sets /// to \arg isMacroArg whether the spelling resides inside a macro definition or /// a macro argument. static SourceLocation getFileSpellingLoc(SourceManager &SM, SourceLocation Loc, bool &isMacroArg) { assert(Loc.isMacroID()); SourceLocation SpellLoc = SM.getImmediateSpellingLoc(Loc); if (SpellLoc.isMacroID()) return getFileSpellingLoc(SM, SpellLoc, isMacroArg); isMacroArg = SM.isMacroArgExpansion(Loc); return SpellLoc; } static enum CXChildVisitResult findFileIdRefVisit(CXCursor cursor, CXCursor parent, CXClientData client_data) { CXCursor declCursor = clang_getCursorReferenced(cursor); if (!clang_isDeclaration(declCursor.kind)) return CXChildVisit_Recurse; const Decl *D = cxcursor::getCursorDecl(declCursor); if (!D) return CXChildVisit_Continue; FindFileIdRefVisitData *data = (FindFileIdRefVisitData *)client_data; if (data->isHit(D)) { cursor = cxcursor::getSelectorIdentifierCursor(data->SelectorIdIdx, cursor); // We are looking for identifiers to highlight so for objc methods (and // not a parameter) we can only highlight the selector identifiers. if ((cursor.kind == CXCursor_ObjCClassMethodDecl || cursor.kind == CXCursor_ObjCInstanceMethodDecl) && cxcursor::getSelectorIdentifierIndex(cursor) == -1) return CXChildVisit_Recurse; if (clang_isExpression(cursor.kind)) { if (cursor.kind == CXCursor_DeclRefExpr || cursor.kind == CXCursor_MemberRefExpr) { // continue.. } else if (cursor.kind == CXCursor_ObjCMessageExpr && cxcursor::getSelectorIdentifierIndex(cursor) != -1) { // continue.. } else return CXChildVisit_Recurse; } SourceLocation Loc = cxloc::translateSourceLocation(clang_getCursorLocation(cursor)); SourceLocation SelIdLoc = cxcursor::getSelectorIdentifierLoc(cursor); if (SelIdLoc.isValid()) Loc = SelIdLoc; ASTContext &Ctx = data->getASTContext(); SourceManager &SM = Ctx.getSourceManager(); bool isInMacroDef = false; if (Loc.isMacroID()) { bool isMacroArg; Loc = getFileSpellingLoc(SM, Loc, isMacroArg); isInMacroDef = !isMacroArg; } // We are looking for identifiers in a specific file. std::pair LocInfo = SM.getDecomposedLoc(Loc); if (LocInfo.first != data->FID) return CXChildVisit_Recurse; if (isInMacroDef) { // FIXME: For a macro definition make sure that all expansions // of it expand to the same reference before allowing to point to it. return CXChildVisit_Recurse; } if (data->visitor.visit(data->visitor.context, cursor, cxloc::translateSourceRange(Ctx, Loc)) == CXVisit_Break) return CXChildVisit_Break; } return CXChildVisit_Recurse; } static bool findIdRefsInFile(CXTranslationUnit TU, CXCursor declCursor, const FileEntry *File, CXCursorAndRangeVisitor Visitor) { assert(clang_isDeclaration(declCursor.kind)); SourceManager &SM = cxtu::getASTUnit(TU)->getSourceManager(); FileID FID = SM.translateFile(File); const Decl *Dcl = cxcursor::getCursorDecl(declCursor); if (!Dcl) return false; FindFileIdRefVisitData data(TU, FID, Dcl, cxcursor::getSelectorIdentifierIndex(declCursor), Visitor); if (const DeclContext *DC = Dcl->getParentFunctionOrMethod()) { return clang_visitChildren(cxcursor::MakeCXCursor(cast(DC), TU), findFileIdRefVisit, &data); } SourceRange Range(SM.getLocForStartOfFile(FID), SM.getLocForEndOfFile(FID)); CursorVisitor FindIdRefsVisitor(TU, findFileIdRefVisit, &data, /*VisitPreprocessorLast=*/true, /*VisitIncludedEntities=*/false, Range, /*VisitDeclsOnly=*/true); return FindIdRefsVisitor.visitFileRegion(); } namespace { struct FindFileMacroRefVisitData { ASTUnit &Unit; const FileEntry *File; const IdentifierInfo *Macro; CXCursorAndRangeVisitor visitor; FindFileMacroRefVisitData(ASTUnit &Unit, const FileEntry *File, const IdentifierInfo *Macro, CXCursorAndRangeVisitor visitor) : Unit(Unit), File(File), Macro(Macro), visitor(visitor) { } ASTContext &getASTContext() const { return Unit.getASTContext(); } }; } // anonymous namespace static enum CXChildVisitResult findFileMacroRefVisit(CXCursor cursor, CXCursor parent, CXClientData client_data) { const IdentifierInfo *Macro = 0; if (cursor.kind == CXCursor_MacroDefinition) Macro = getCursorMacroDefinition(cursor)->getName(); else if (cursor.kind == CXCursor_MacroExpansion) Macro = getCursorMacroExpansion(cursor).getName(); if (!Macro) return CXChildVisit_Continue; FindFileMacroRefVisitData *data = (FindFileMacroRefVisitData *)client_data; if (data->Macro != Macro) return CXChildVisit_Continue; SourceLocation Loc = cxloc::translateSourceLocation(clang_getCursorLocation(cursor)); ASTContext &Ctx = data->getASTContext(); SourceManager &SM = Ctx.getSourceManager(); bool isInMacroDef = false; if (Loc.isMacroID()) { bool isMacroArg; Loc = getFileSpellingLoc(SM, Loc, isMacroArg); isInMacroDef = !isMacroArg; } // We are looking for identifiers in a specific file. std::pair LocInfo = SM.getDecomposedLoc(Loc); if (SM.getFileEntryForID(LocInfo.first) != data->File) return CXChildVisit_Continue; if (isInMacroDef) { // FIXME: For a macro definition make sure that all expansions // of it expand to the same reference before allowing to point to it. return CXChildVisit_Continue; } if (data->visitor.visit(data->visitor.context, cursor, cxloc::translateSourceRange(Ctx, Loc)) == CXVisit_Break) return CXChildVisit_Break; return CXChildVisit_Continue; } static bool findMacroRefsInFile(CXTranslationUnit TU, CXCursor Cursor, const FileEntry *File, CXCursorAndRangeVisitor Visitor) { if (Cursor.kind != CXCursor_MacroDefinition && Cursor.kind != CXCursor_MacroExpansion) return false; ASTUnit *Unit = cxtu::getASTUnit(TU); SourceManager &SM = Unit->getSourceManager(); FileID FID = SM.translateFile(File); const IdentifierInfo *Macro = 0; if (Cursor.kind == CXCursor_MacroDefinition) Macro = getCursorMacroDefinition(Cursor)->getName(); else Macro = getCursorMacroExpansion(Cursor).getName(); if (!Macro) return false; FindFileMacroRefVisitData data(*Unit, File, Macro, Visitor); SourceRange Range(SM.getLocForStartOfFile(FID), SM.getLocForEndOfFile(FID)); CursorVisitor FindMacroRefsVisitor(TU, findFileMacroRefVisit, &data, /*VisitPreprocessorLast=*/false, /*VisitIncludedEntities=*/false, Range); return FindMacroRefsVisitor.visitPreprocessedEntitiesInRegion(); } namespace { struct FindFileIncludesVisitor { ASTUnit &Unit; const FileEntry *File; CXCursorAndRangeVisitor visitor; FindFileIncludesVisitor(ASTUnit &Unit, const FileEntry *File, CXCursorAndRangeVisitor visitor) : Unit(Unit), File(File), visitor(visitor) { } ASTContext &getASTContext() const { return Unit.getASTContext(); } enum CXChildVisitResult visit(CXCursor cursor, CXCursor parent) { if (cursor.kind != CXCursor_InclusionDirective) return CXChildVisit_Continue; SourceLocation Loc = cxloc::translateSourceLocation(clang_getCursorLocation(cursor)); ASTContext &Ctx = getASTContext(); SourceManager &SM = Ctx.getSourceManager(); // We are looking for includes in a specific file. std::pair LocInfo = SM.getDecomposedLoc(Loc); if (SM.getFileEntryForID(LocInfo.first) != File) return CXChildVisit_Continue; if (visitor.visit(visitor.context, cursor, cxloc::translateSourceRange(Ctx, Loc)) == CXVisit_Break) return CXChildVisit_Break; return CXChildVisit_Continue; } static enum CXChildVisitResult visit(CXCursor cursor, CXCursor parent, CXClientData client_data) { return static_cast(client_data)-> visit(cursor, parent); } }; } // anonymous namespace static bool findIncludesInFile(CXTranslationUnit TU, const FileEntry *File, CXCursorAndRangeVisitor Visitor) { assert(TU && File && Visitor.visit); ASTUnit *Unit = cxtu::getASTUnit(TU); SourceManager &SM = Unit->getSourceManager(); FileID FID = SM.translateFile(File); FindFileIncludesVisitor IncludesVisitor(*Unit, File, Visitor); SourceRange Range(SM.getLocForStartOfFile(FID), SM.getLocForEndOfFile(FID)); CursorVisitor InclusionCursorsVisitor(TU, FindFileIncludesVisitor::visit, &IncludesVisitor, /*VisitPreprocessorLast=*/false, /*VisitIncludedEntities=*/false, Range); return InclusionCursorsVisitor.visitPreprocessedEntitiesInRegion(); } //===----------------------------------------------------------------------===// // libclang public APIs. //===----------------------------------------------------------------------===// extern "C" { CXResult clang_findReferencesInFile(CXCursor cursor, CXFile file, CXCursorAndRangeVisitor visitor) { LogRef Log = Logger::make(LLVM_FUNCTION_NAME); if (clang_Cursor_isNull(cursor)) { if (Log) *Log << "Null cursor"; return CXResult_Invalid; } if (cursor.kind == CXCursor_NoDeclFound) { if (Log) *Log << "Got CXCursor_NoDeclFound"; return CXResult_Invalid; } if (!file) { if (Log) *Log << "Null file"; return CXResult_Invalid; } if (!visitor.visit) { if (Log) *Log << "Null visitor"; return CXResult_Invalid; } if (Log) *Log << cursor << " @@" << static_cast(file); ASTUnit *CXXUnit = cxcursor::getCursorASTUnit(cursor); if (!CXXUnit) return CXResult_Invalid; ASTUnit::ConcurrencyCheck Check(*CXXUnit); if (cursor.kind == CXCursor_MacroDefinition || cursor.kind == CXCursor_MacroExpansion) { if (findMacroRefsInFile(cxcursor::getCursorTU(cursor), cursor, static_cast(file), visitor)) return CXResult_VisitBreak; return CXResult_Success; } // We are interested in semantics of identifiers so for C++ constructor exprs // prefer type references, e.g.: // // return MyStruct(); // // for 'MyStruct' we'll have a cursor pointing at the constructor decl but // we are actually interested in the type declaration. cursor = cxcursor::getTypeRefCursor(cursor); CXCursor refCursor = clang_getCursorReferenced(cursor); if (!clang_isDeclaration(refCursor.kind)) { if (Log) *Log << "cursor is not referencing a declaration"; return CXResult_Invalid; } if (findIdRefsInFile(cxcursor::getCursorTU(cursor), refCursor, static_cast(file), visitor)) return CXResult_VisitBreak; return CXResult_Success; } CXResult clang_findIncludesInFile(CXTranslationUnit TU, CXFile file, CXCursorAndRangeVisitor visitor) { LogRef Log = Logger::make(LLVM_FUNCTION_NAME); if (!TU) { if (Log) *Log << "Null CXTranslationUnit"; return CXResult_Invalid; } if (!file) { if (Log) *Log << "Null file"; return CXResult_Invalid; } if (!visitor.visit) { if (Log) *Log << "Null visitor"; return CXResult_Invalid; } if (Log) *Log << TU << " @@" << static_cast(file); ASTUnit *CXXUnit = cxtu::getASTUnit(TU); if (!CXXUnit) return CXResult_Invalid; ASTUnit::ConcurrencyCheck Check(*CXXUnit); if (findIncludesInFile(TU, static_cast(file), visitor)) return CXResult_VisitBreak; return CXResult_Success; } static enum CXVisitorResult _visitCursorAndRange(void *context, CXCursor cursor, CXSourceRange range) { CXCursorAndRangeVisitorBlock block = (CXCursorAndRangeVisitorBlock)context; return INVOKE_BLOCK2(block, cursor, range); } CXResult clang_findReferencesInFileWithBlock(CXCursor cursor, CXFile file, CXCursorAndRangeVisitorBlock block) { CXCursorAndRangeVisitor visitor = { block, block ? _visitCursorAndRange : 0 }; return clang_findReferencesInFile(cursor, file, visitor); } CXResult clang_findIncludesInFileWithBlock(CXTranslationUnit TU, CXFile file, CXCursorAndRangeVisitorBlock block) { CXCursorAndRangeVisitor visitor = { block, block ? _visitCursorAndRange : 0 }; return clang_findIncludesInFile(TU, file, visitor); } } // end: extern "C" @ 1.1.1.1 log @Import Clang 3.4rc1 r195771. @ text @@ 1.1.1.2 log @Import Clang 3.5svn r201163. @ text @d483 5 a487 2 if (cxtu::isNotUsableTU(TU)) { LOG_BAD_TU(TU); a489 2 LogRef Log = Logger::make(LLVM_FUNCTION_NAME); @ 1.1.1.3 log @Import clang 3.6svn r215315. @ text @d81 1 a81 1 return nullptr; d268 1 a268 1 const IdentifierInfo *Macro = nullptr; d320 1 a320 1 const IdentifierInfo *Macro = nullptr; d525 1 a525 1 block ? _visitCursorAndRange : nullptr }; d533 1 a533 1 block ? _visitCursorAndRange : nullptr }; @ 1.1.1.3.8.1 log @Sync with HEAD @ text @d414 1 a414 1 LogRef Log = Logger::make(__func__); d488 1 a488 1 LogRef Log = Logger::make(__func__); d538 1 @ 1.1.1.4 log @Import Clang pre-4.0.0 r291444. @ text @d414 1 a414 1 LogRef Log = Logger::make(__func__); d488 1 a488 1 LogRef Log = Logger::make(__func__); d538 1 @ 1.1.1.4.14.1 log @Sync with HEAD @ text @d68 1 a68 1 /// We are looking to find all semantically relevant identifiers, d132 1 a132 1 /// For a macro \arg Loc, returns the file spelling location and sets @ 1.1.1.4.14.2 log @Mostly merge changes from HEAD upto 20200411 @ text @@ 1.1.1.4.12.1 log @Sync with HEAD @ text @d68 1 a68 1 /// We are looking to find all semantically relevant identifiers, d132 1 a132 1 /// For a macro \arg Loc, returns the file spelling location and sets @ 1.1.1.5 log @Import clang r337282 from trunk @ text @d68 1 a68 1 /// We are looking to find all semantically relevant identifiers, d132 1 a132 1 /// For a macro \arg Loc, returns the file spelling location and sets @ 1.1.1.6 log @Mark old LLVM instance as dead. @ text @@ 1.1.1.3.4.1 log @file CIndexHigh.cpp was added on branch tls-maxphys on 2014-08-19 23:49:27 +0000 @ text @d1 538 @ 1.1.1.3.4.2 log @Rebase to HEAD as of a few days ago. @ text @a0 538 //===- CIndexHigh.cpp - Higher level API functions ------------------------===// // // The LLVM Compiler Infrastructure // // This file is distributed under the University of Illinois Open Source // License. See LICENSE.TXT for details. // //===----------------------------------------------------------------------===// #include "CursorVisitor.h" #include "CLog.h" #include "CXCursor.h" #include "CXSourceLocation.h" #include "CXTranslationUnit.h" #include "clang/AST/DeclObjC.h" #include "clang/Frontend/ASTUnit.h" #include "llvm/Support/Compiler.h" using namespace clang; using namespace cxcursor; using namespace cxindex; static void getTopOverriddenMethods(CXTranslationUnit TU, const Decl *D, SmallVectorImpl &Methods) { if (!D) return; if (!isa(D) && !isa(D)) return; SmallVector Overridden; cxcursor::getOverriddenCursors(cxcursor::MakeCXCursor(D, TU), Overridden); if (Overridden.empty()) { Methods.push_back(D->getCanonicalDecl()); return; } for (SmallVectorImpl::iterator I = Overridden.begin(), E = Overridden.end(); I != E; ++I) getTopOverriddenMethods(TU, cxcursor::getCursorDecl(*I), Methods); } namespace { struct FindFileIdRefVisitData { CXTranslationUnit TU; FileID FID; const Decl *Dcl; int SelectorIdIdx; CXCursorAndRangeVisitor visitor; typedef SmallVector TopMethodsTy; TopMethodsTy TopMethods; FindFileIdRefVisitData(CXTranslationUnit TU, FileID FID, const Decl *D, int selectorIdIdx, CXCursorAndRangeVisitor visitor) : TU(TU), FID(FID), SelectorIdIdx(selectorIdIdx), visitor(visitor) { Dcl = getCanonical(D); getTopOverriddenMethods(TU, Dcl, TopMethods); } ASTContext &getASTContext() const { return cxtu::getASTUnit(TU)->getASTContext(); } /// \brief We are looking to find all semantically relevant identifiers, /// so the definition of "canonical" here is different than in the AST, e.g. /// /// \code /// class C { /// C() {} /// }; /// \endcode /// /// we consider the canonical decl of the constructor decl to be the class /// itself, so both 'C' can be highlighted. const Decl *getCanonical(const Decl *D) const { if (!D) return nullptr; D = D->getCanonicalDecl(); if (const ObjCImplDecl *ImplD = dyn_cast(D)) { if (ImplD->getClassInterface()) return getCanonical(ImplD->getClassInterface()); } else if (const CXXConstructorDecl *CXXCtorD = dyn_cast(D)) { return getCanonical(CXXCtorD->getParent()); } return D; } bool isHit(const Decl *D) const { if (!D) return false; D = getCanonical(D); if (D == Dcl) return true; if (isa(D) || isa(D)) return isOverriddingMethod(D); return false; } private: bool isOverriddingMethod(const Decl *D) const { if (std::find(TopMethods.begin(), TopMethods.end(), D) != TopMethods.end()) return true; TopMethodsTy methods; getTopOverriddenMethods(TU, D, methods); for (TopMethodsTy::iterator I = methods.begin(), E = methods.end(); I != E; ++I) { if (std::find(TopMethods.begin(), TopMethods.end(), *I) != TopMethods.end()) return true; } return false; } }; } // end anonymous namespace. /// \brief For a macro \arg Loc, returns the file spelling location and sets /// to \arg isMacroArg whether the spelling resides inside a macro definition or /// a macro argument. static SourceLocation getFileSpellingLoc(SourceManager &SM, SourceLocation Loc, bool &isMacroArg) { assert(Loc.isMacroID()); SourceLocation SpellLoc = SM.getImmediateSpellingLoc(Loc); if (SpellLoc.isMacroID()) return getFileSpellingLoc(SM, SpellLoc, isMacroArg); isMacroArg = SM.isMacroArgExpansion(Loc); return SpellLoc; } static enum CXChildVisitResult findFileIdRefVisit(CXCursor cursor, CXCursor parent, CXClientData client_data) { CXCursor declCursor = clang_getCursorReferenced(cursor); if (!clang_isDeclaration(declCursor.kind)) return CXChildVisit_Recurse; const Decl *D = cxcursor::getCursorDecl(declCursor); if (!D) return CXChildVisit_Continue; FindFileIdRefVisitData *data = (FindFileIdRefVisitData *)client_data; if (data->isHit(D)) { cursor = cxcursor::getSelectorIdentifierCursor(data->SelectorIdIdx, cursor); // We are looking for identifiers to highlight so for objc methods (and // not a parameter) we can only highlight the selector identifiers. if ((cursor.kind == CXCursor_ObjCClassMethodDecl || cursor.kind == CXCursor_ObjCInstanceMethodDecl) && cxcursor::getSelectorIdentifierIndex(cursor) == -1) return CXChildVisit_Recurse; if (clang_isExpression(cursor.kind)) { if (cursor.kind == CXCursor_DeclRefExpr || cursor.kind == CXCursor_MemberRefExpr) { // continue.. } else if (cursor.kind == CXCursor_ObjCMessageExpr && cxcursor::getSelectorIdentifierIndex(cursor) != -1) { // continue.. } else return CXChildVisit_Recurse; } SourceLocation Loc = cxloc::translateSourceLocation(clang_getCursorLocation(cursor)); SourceLocation SelIdLoc = cxcursor::getSelectorIdentifierLoc(cursor); if (SelIdLoc.isValid()) Loc = SelIdLoc; ASTContext &Ctx = data->getASTContext(); SourceManager &SM = Ctx.getSourceManager(); bool isInMacroDef = false; if (Loc.isMacroID()) { bool isMacroArg; Loc = getFileSpellingLoc(SM, Loc, isMacroArg); isInMacroDef = !isMacroArg; } // We are looking for identifiers in a specific file. std::pair LocInfo = SM.getDecomposedLoc(Loc); if (LocInfo.first != data->FID) return CXChildVisit_Recurse; if (isInMacroDef) { // FIXME: For a macro definition make sure that all expansions // of it expand to the same reference before allowing to point to it. return CXChildVisit_Recurse; } if (data->visitor.visit(data->visitor.context, cursor, cxloc::translateSourceRange(Ctx, Loc)) == CXVisit_Break) return CXChildVisit_Break; } return CXChildVisit_Recurse; } static bool findIdRefsInFile(CXTranslationUnit TU, CXCursor declCursor, const FileEntry *File, CXCursorAndRangeVisitor Visitor) { assert(clang_isDeclaration(declCursor.kind)); SourceManager &SM = cxtu::getASTUnit(TU)->getSourceManager(); FileID FID = SM.translateFile(File); const Decl *Dcl = cxcursor::getCursorDecl(declCursor); if (!Dcl) return false; FindFileIdRefVisitData data(TU, FID, Dcl, cxcursor::getSelectorIdentifierIndex(declCursor), Visitor); if (const DeclContext *DC = Dcl->getParentFunctionOrMethod()) { return clang_visitChildren(cxcursor::MakeCXCursor(cast(DC), TU), findFileIdRefVisit, &data); } SourceRange Range(SM.getLocForStartOfFile(FID), SM.getLocForEndOfFile(FID)); CursorVisitor FindIdRefsVisitor(TU, findFileIdRefVisit, &data, /*VisitPreprocessorLast=*/true, /*VisitIncludedEntities=*/false, Range, /*VisitDeclsOnly=*/true); return FindIdRefsVisitor.visitFileRegion(); } namespace { struct FindFileMacroRefVisitData { ASTUnit &Unit; const FileEntry *File; const IdentifierInfo *Macro; CXCursorAndRangeVisitor visitor; FindFileMacroRefVisitData(ASTUnit &Unit, const FileEntry *File, const IdentifierInfo *Macro, CXCursorAndRangeVisitor visitor) : Unit(Unit), File(File), Macro(Macro), visitor(visitor) { } ASTContext &getASTContext() const { return Unit.getASTContext(); } }; } // anonymous namespace static enum CXChildVisitResult findFileMacroRefVisit(CXCursor cursor, CXCursor parent, CXClientData client_data) { const IdentifierInfo *Macro = nullptr; if (cursor.kind == CXCursor_MacroDefinition) Macro = getCursorMacroDefinition(cursor)->getName(); else if (cursor.kind == CXCursor_MacroExpansion) Macro = getCursorMacroExpansion(cursor).getName(); if (!Macro) return CXChildVisit_Continue; FindFileMacroRefVisitData *data = (FindFileMacroRefVisitData *)client_data; if (data->Macro != Macro) return CXChildVisit_Continue; SourceLocation Loc = cxloc::translateSourceLocation(clang_getCursorLocation(cursor)); ASTContext &Ctx = data->getASTContext(); SourceManager &SM = Ctx.getSourceManager(); bool isInMacroDef = false; if (Loc.isMacroID()) { bool isMacroArg; Loc = getFileSpellingLoc(SM, Loc, isMacroArg); isInMacroDef = !isMacroArg; } // We are looking for identifiers in a specific file. std::pair LocInfo = SM.getDecomposedLoc(Loc); if (SM.getFileEntryForID(LocInfo.first) != data->File) return CXChildVisit_Continue; if (isInMacroDef) { // FIXME: For a macro definition make sure that all expansions // of it expand to the same reference before allowing to point to it. return CXChildVisit_Continue; } if (data->visitor.visit(data->visitor.context, cursor, cxloc::translateSourceRange(Ctx, Loc)) == CXVisit_Break) return CXChildVisit_Break; return CXChildVisit_Continue; } static bool findMacroRefsInFile(CXTranslationUnit TU, CXCursor Cursor, const FileEntry *File, CXCursorAndRangeVisitor Visitor) { if (Cursor.kind != CXCursor_MacroDefinition && Cursor.kind != CXCursor_MacroExpansion) return false; ASTUnit *Unit = cxtu::getASTUnit(TU); SourceManager &SM = Unit->getSourceManager(); FileID FID = SM.translateFile(File); const IdentifierInfo *Macro = nullptr; if (Cursor.kind == CXCursor_MacroDefinition) Macro = getCursorMacroDefinition(Cursor)->getName(); else Macro = getCursorMacroExpansion(Cursor).getName(); if (!Macro) return false; FindFileMacroRefVisitData data(*Unit, File, Macro, Visitor); SourceRange Range(SM.getLocForStartOfFile(FID), SM.getLocForEndOfFile(FID)); CursorVisitor FindMacroRefsVisitor(TU, findFileMacroRefVisit, &data, /*VisitPreprocessorLast=*/false, /*VisitIncludedEntities=*/false, Range); return FindMacroRefsVisitor.visitPreprocessedEntitiesInRegion(); } namespace { struct FindFileIncludesVisitor { ASTUnit &Unit; const FileEntry *File; CXCursorAndRangeVisitor visitor; FindFileIncludesVisitor(ASTUnit &Unit, const FileEntry *File, CXCursorAndRangeVisitor visitor) : Unit(Unit), File(File), visitor(visitor) { } ASTContext &getASTContext() const { return Unit.getASTContext(); } enum CXChildVisitResult visit(CXCursor cursor, CXCursor parent) { if (cursor.kind != CXCursor_InclusionDirective) return CXChildVisit_Continue; SourceLocation Loc = cxloc::translateSourceLocation(clang_getCursorLocation(cursor)); ASTContext &Ctx = getASTContext(); SourceManager &SM = Ctx.getSourceManager(); // We are looking for includes in a specific file. std::pair LocInfo = SM.getDecomposedLoc(Loc); if (SM.getFileEntryForID(LocInfo.first) != File) return CXChildVisit_Continue; if (visitor.visit(visitor.context, cursor, cxloc::translateSourceRange(Ctx, Loc)) == CXVisit_Break) return CXChildVisit_Break; return CXChildVisit_Continue; } static enum CXChildVisitResult visit(CXCursor cursor, CXCursor parent, CXClientData client_data) { return static_cast(client_data)-> visit(cursor, parent); } }; } // anonymous namespace static bool findIncludesInFile(CXTranslationUnit TU, const FileEntry *File, CXCursorAndRangeVisitor Visitor) { assert(TU && File && Visitor.visit); ASTUnit *Unit = cxtu::getASTUnit(TU); SourceManager &SM = Unit->getSourceManager(); FileID FID = SM.translateFile(File); FindFileIncludesVisitor IncludesVisitor(*Unit, File, Visitor); SourceRange Range(SM.getLocForStartOfFile(FID), SM.getLocForEndOfFile(FID)); CursorVisitor InclusionCursorsVisitor(TU, FindFileIncludesVisitor::visit, &IncludesVisitor, /*VisitPreprocessorLast=*/false, /*VisitIncludedEntities=*/false, Range); return InclusionCursorsVisitor.visitPreprocessedEntitiesInRegion(); } //===----------------------------------------------------------------------===// // libclang public APIs. //===----------------------------------------------------------------------===// extern "C" { CXResult clang_findReferencesInFile(CXCursor cursor, CXFile file, CXCursorAndRangeVisitor visitor) { LogRef Log = Logger::make(LLVM_FUNCTION_NAME); if (clang_Cursor_isNull(cursor)) { if (Log) *Log << "Null cursor"; return CXResult_Invalid; } if (cursor.kind == CXCursor_NoDeclFound) { if (Log) *Log << "Got CXCursor_NoDeclFound"; return CXResult_Invalid; } if (!file) { if (Log) *Log << "Null file"; return CXResult_Invalid; } if (!visitor.visit) { if (Log) *Log << "Null visitor"; return CXResult_Invalid; } if (Log) *Log << cursor << " @@" << static_cast(file); ASTUnit *CXXUnit = cxcursor::getCursorASTUnit(cursor); if (!CXXUnit) return CXResult_Invalid; ASTUnit::ConcurrencyCheck Check(*CXXUnit); if (cursor.kind == CXCursor_MacroDefinition || cursor.kind == CXCursor_MacroExpansion) { if (findMacroRefsInFile(cxcursor::getCursorTU(cursor), cursor, static_cast(file), visitor)) return CXResult_VisitBreak; return CXResult_Success; } // We are interested in semantics of identifiers so for C++ constructor exprs // prefer type references, e.g.: // // return MyStruct(); // // for 'MyStruct' we'll have a cursor pointing at the constructor decl but // we are actually interested in the type declaration. cursor = cxcursor::getTypeRefCursor(cursor); CXCursor refCursor = clang_getCursorReferenced(cursor); if (!clang_isDeclaration(refCursor.kind)) { if (Log) *Log << "cursor is not referencing a declaration"; return CXResult_Invalid; } if (findIdRefsInFile(cxcursor::getCursorTU(cursor), refCursor, static_cast(file), visitor)) return CXResult_VisitBreak; return CXResult_Success; } CXResult clang_findIncludesInFile(CXTranslationUnit TU, CXFile file, CXCursorAndRangeVisitor visitor) { if (cxtu::isNotUsableTU(TU)) { LOG_BAD_TU(TU); return CXResult_Invalid; } LogRef Log = Logger::make(LLVM_FUNCTION_NAME); if (!file) { if (Log) *Log << "Null file"; return CXResult_Invalid; } if (!visitor.visit) { if (Log) *Log << "Null visitor"; return CXResult_Invalid; } if (Log) *Log << TU << " @@" << static_cast(file); ASTUnit *CXXUnit = cxtu::getASTUnit(TU); if (!CXXUnit) return CXResult_Invalid; ASTUnit::ConcurrencyCheck Check(*CXXUnit); if (findIncludesInFile(TU, static_cast(file), visitor)) return CXResult_VisitBreak; return CXResult_Success; } static enum CXVisitorResult _visitCursorAndRange(void *context, CXCursor cursor, CXSourceRange range) { CXCursorAndRangeVisitorBlock block = (CXCursorAndRangeVisitorBlock)context; return INVOKE_BLOCK2(block, cursor, range); } CXResult clang_findReferencesInFileWithBlock(CXCursor cursor, CXFile file, CXCursorAndRangeVisitorBlock block) { CXCursorAndRangeVisitor visitor = { block, block ? _visitCursorAndRange : nullptr }; return clang_findReferencesInFile(cursor, file, visitor); } CXResult clang_findIncludesInFileWithBlock(CXTranslationUnit TU, CXFile file, CXCursorAndRangeVisitorBlock block) { CXCursorAndRangeVisitor visitor = { block, block ? _visitCursorAndRange : nullptr }; return clang_findIncludesInFile(TU, file, visitor); } } // end: extern "C" @ 1.1.1.2.4.1 log @file CIndexHigh.cpp was added on branch yamt-pagecache on 2014-05-22 16:19:47 +0000 @ text @d1 538 @ 1.1.1.2.4.2 log @sync with head. for a reference, the tree before this commit was tagged as yamt-pagecache-tag8. this commit was splitted into small chunks to avoid a limitation of cvs. ("Protocol error: too many arguments") @ text @a0 538 //===- CIndexHigh.cpp - Higher level API functions ------------------------===// // // The LLVM Compiler Infrastructure // // This file is distributed under the University of Illinois Open Source // License. See LICENSE.TXT for details. // //===----------------------------------------------------------------------===// #include "CursorVisitor.h" #include "CLog.h" #include "CXCursor.h" #include "CXSourceLocation.h" #include "CXTranslationUnit.h" #include "clang/AST/DeclObjC.h" #include "clang/Frontend/ASTUnit.h" #include "llvm/Support/Compiler.h" using namespace clang; using namespace cxcursor; using namespace cxindex; static void getTopOverriddenMethods(CXTranslationUnit TU, const Decl *D, SmallVectorImpl &Methods) { if (!D) return; if (!isa(D) && !isa(D)) return; SmallVector Overridden; cxcursor::getOverriddenCursors(cxcursor::MakeCXCursor(D, TU), Overridden); if (Overridden.empty()) { Methods.push_back(D->getCanonicalDecl()); return; } for (SmallVectorImpl::iterator I = Overridden.begin(), E = Overridden.end(); I != E; ++I) getTopOverriddenMethods(TU, cxcursor::getCursorDecl(*I), Methods); } namespace { struct FindFileIdRefVisitData { CXTranslationUnit TU; FileID FID; const Decl *Dcl; int SelectorIdIdx; CXCursorAndRangeVisitor visitor; typedef SmallVector TopMethodsTy; TopMethodsTy TopMethods; FindFileIdRefVisitData(CXTranslationUnit TU, FileID FID, const Decl *D, int selectorIdIdx, CXCursorAndRangeVisitor visitor) : TU(TU), FID(FID), SelectorIdIdx(selectorIdIdx), visitor(visitor) { Dcl = getCanonical(D); getTopOverriddenMethods(TU, Dcl, TopMethods); } ASTContext &getASTContext() const { return cxtu::getASTUnit(TU)->getASTContext(); } /// \brief We are looking to find all semantically relevant identifiers, /// so the definition of "canonical" here is different than in the AST, e.g. /// /// \code /// class C { /// C() {} /// }; /// \endcode /// /// we consider the canonical decl of the constructor decl to be the class /// itself, so both 'C' can be highlighted. const Decl *getCanonical(const Decl *D) const { if (!D) return 0; D = D->getCanonicalDecl(); if (const ObjCImplDecl *ImplD = dyn_cast(D)) { if (ImplD->getClassInterface()) return getCanonical(ImplD->getClassInterface()); } else if (const CXXConstructorDecl *CXXCtorD = dyn_cast(D)) { return getCanonical(CXXCtorD->getParent()); } return D; } bool isHit(const Decl *D) const { if (!D) return false; D = getCanonical(D); if (D == Dcl) return true; if (isa(D) || isa(D)) return isOverriddingMethod(D); return false; } private: bool isOverriddingMethod(const Decl *D) const { if (std::find(TopMethods.begin(), TopMethods.end(), D) != TopMethods.end()) return true; TopMethodsTy methods; getTopOverriddenMethods(TU, D, methods); for (TopMethodsTy::iterator I = methods.begin(), E = methods.end(); I != E; ++I) { if (std::find(TopMethods.begin(), TopMethods.end(), *I) != TopMethods.end()) return true; } return false; } }; } // end anonymous namespace. /// \brief For a macro \arg Loc, returns the file spelling location and sets /// to \arg isMacroArg whether the spelling resides inside a macro definition or /// a macro argument. static SourceLocation getFileSpellingLoc(SourceManager &SM, SourceLocation Loc, bool &isMacroArg) { assert(Loc.isMacroID()); SourceLocation SpellLoc = SM.getImmediateSpellingLoc(Loc); if (SpellLoc.isMacroID()) return getFileSpellingLoc(SM, SpellLoc, isMacroArg); isMacroArg = SM.isMacroArgExpansion(Loc); return SpellLoc; } static enum CXChildVisitResult findFileIdRefVisit(CXCursor cursor, CXCursor parent, CXClientData client_data) { CXCursor declCursor = clang_getCursorReferenced(cursor); if (!clang_isDeclaration(declCursor.kind)) return CXChildVisit_Recurse; const Decl *D = cxcursor::getCursorDecl(declCursor); if (!D) return CXChildVisit_Continue; FindFileIdRefVisitData *data = (FindFileIdRefVisitData *)client_data; if (data->isHit(D)) { cursor = cxcursor::getSelectorIdentifierCursor(data->SelectorIdIdx, cursor); // We are looking for identifiers to highlight so for objc methods (and // not a parameter) we can only highlight the selector identifiers. if ((cursor.kind == CXCursor_ObjCClassMethodDecl || cursor.kind == CXCursor_ObjCInstanceMethodDecl) && cxcursor::getSelectorIdentifierIndex(cursor) == -1) return CXChildVisit_Recurse; if (clang_isExpression(cursor.kind)) { if (cursor.kind == CXCursor_DeclRefExpr || cursor.kind == CXCursor_MemberRefExpr) { // continue.. } else if (cursor.kind == CXCursor_ObjCMessageExpr && cxcursor::getSelectorIdentifierIndex(cursor) != -1) { // continue.. } else return CXChildVisit_Recurse; } SourceLocation Loc = cxloc::translateSourceLocation(clang_getCursorLocation(cursor)); SourceLocation SelIdLoc = cxcursor::getSelectorIdentifierLoc(cursor); if (SelIdLoc.isValid()) Loc = SelIdLoc; ASTContext &Ctx = data->getASTContext(); SourceManager &SM = Ctx.getSourceManager(); bool isInMacroDef = false; if (Loc.isMacroID()) { bool isMacroArg; Loc = getFileSpellingLoc(SM, Loc, isMacroArg); isInMacroDef = !isMacroArg; } // We are looking for identifiers in a specific file. std::pair LocInfo = SM.getDecomposedLoc(Loc); if (LocInfo.first != data->FID) return CXChildVisit_Recurse; if (isInMacroDef) { // FIXME: For a macro definition make sure that all expansions // of it expand to the same reference before allowing to point to it. return CXChildVisit_Recurse; } if (data->visitor.visit(data->visitor.context, cursor, cxloc::translateSourceRange(Ctx, Loc)) == CXVisit_Break) return CXChildVisit_Break; } return CXChildVisit_Recurse; } static bool findIdRefsInFile(CXTranslationUnit TU, CXCursor declCursor, const FileEntry *File, CXCursorAndRangeVisitor Visitor) { assert(clang_isDeclaration(declCursor.kind)); SourceManager &SM = cxtu::getASTUnit(TU)->getSourceManager(); FileID FID = SM.translateFile(File); const Decl *Dcl = cxcursor::getCursorDecl(declCursor); if (!Dcl) return false; FindFileIdRefVisitData data(TU, FID, Dcl, cxcursor::getSelectorIdentifierIndex(declCursor), Visitor); if (const DeclContext *DC = Dcl->getParentFunctionOrMethod()) { return clang_visitChildren(cxcursor::MakeCXCursor(cast(DC), TU), findFileIdRefVisit, &data); } SourceRange Range(SM.getLocForStartOfFile(FID), SM.getLocForEndOfFile(FID)); CursorVisitor FindIdRefsVisitor(TU, findFileIdRefVisit, &data, /*VisitPreprocessorLast=*/true, /*VisitIncludedEntities=*/false, Range, /*VisitDeclsOnly=*/true); return FindIdRefsVisitor.visitFileRegion(); } namespace { struct FindFileMacroRefVisitData { ASTUnit &Unit; const FileEntry *File; const IdentifierInfo *Macro; CXCursorAndRangeVisitor visitor; FindFileMacroRefVisitData(ASTUnit &Unit, const FileEntry *File, const IdentifierInfo *Macro, CXCursorAndRangeVisitor visitor) : Unit(Unit), File(File), Macro(Macro), visitor(visitor) { } ASTContext &getASTContext() const { return Unit.getASTContext(); } }; } // anonymous namespace static enum CXChildVisitResult findFileMacroRefVisit(CXCursor cursor, CXCursor parent, CXClientData client_data) { const IdentifierInfo *Macro = 0; if (cursor.kind == CXCursor_MacroDefinition) Macro = getCursorMacroDefinition(cursor)->getName(); else if (cursor.kind == CXCursor_MacroExpansion) Macro = getCursorMacroExpansion(cursor).getName(); if (!Macro) return CXChildVisit_Continue; FindFileMacroRefVisitData *data = (FindFileMacroRefVisitData *)client_data; if (data->Macro != Macro) return CXChildVisit_Continue; SourceLocation Loc = cxloc::translateSourceLocation(clang_getCursorLocation(cursor)); ASTContext &Ctx = data->getASTContext(); SourceManager &SM = Ctx.getSourceManager(); bool isInMacroDef = false; if (Loc.isMacroID()) { bool isMacroArg; Loc = getFileSpellingLoc(SM, Loc, isMacroArg); isInMacroDef = !isMacroArg; } // We are looking for identifiers in a specific file. std::pair LocInfo = SM.getDecomposedLoc(Loc); if (SM.getFileEntryForID(LocInfo.first) != data->File) return CXChildVisit_Continue; if (isInMacroDef) { // FIXME: For a macro definition make sure that all expansions // of it expand to the same reference before allowing to point to it. return CXChildVisit_Continue; } if (data->visitor.visit(data->visitor.context, cursor, cxloc::translateSourceRange(Ctx, Loc)) == CXVisit_Break) return CXChildVisit_Break; return CXChildVisit_Continue; } static bool findMacroRefsInFile(CXTranslationUnit TU, CXCursor Cursor, const FileEntry *File, CXCursorAndRangeVisitor Visitor) { if (Cursor.kind != CXCursor_MacroDefinition && Cursor.kind != CXCursor_MacroExpansion) return false; ASTUnit *Unit = cxtu::getASTUnit(TU); SourceManager &SM = Unit->getSourceManager(); FileID FID = SM.translateFile(File); const IdentifierInfo *Macro = 0; if (Cursor.kind == CXCursor_MacroDefinition) Macro = getCursorMacroDefinition(Cursor)->getName(); else Macro = getCursorMacroExpansion(Cursor).getName(); if (!Macro) return false; FindFileMacroRefVisitData data(*Unit, File, Macro, Visitor); SourceRange Range(SM.getLocForStartOfFile(FID), SM.getLocForEndOfFile(FID)); CursorVisitor FindMacroRefsVisitor(TU, findFileMacroRefVisit, &data, /*VisitPreprocessorLast=*/false, /*VisitIncludedEntities=*/false, Range); return FindMacroRefsVisitor.visitPreprocessedEntitiesInRegion(); } namespace { struct FindFileIncludesVisitor { ASTUnit &Unit; const FileEntry *File; CXCursorAndRangeVisitor visitor; FindFileIncludesVisitor(ASTUnit &Unit, const FileEntry *File, CXCursorAndRangeVisitor visitor) : Unit(Unit), File(File), visitor(visitor) { } ASTContext &getASTContext() const { return Unit.getASTContext(); } enum CXChildVisitResult visit(CXCursor cursor, CXCursor parent) { if (cursor.kind != CXCursor_InclusionDirective) return CXChildVisit_Continue; SourceLocation Loc = cxloc::translateSourceLocation(clang_getCursorLocation(cursor)); ASTContext &Ctx = getASTContext(); SourceManager &SM = Ctx.getSourceManager(); // We are looking for includes in a specific file. std::pair LocInfo = SM.getDecomposedLoc(Loc); if (SM.getFileEntryForID(LocInfo.first) != File) return CXChildVisit_Continue; if (visitor.visit(visitor.context, cursor, cxloc::translateSourceRange(Ctx, Loc)) == CXVisit_Break) return CXChildVisit_Break; return CXChildVisit_Continue; } static enum CXChildVisitResult visit(CXCursor cursor, CXCursor parent, CXClientData client_data) { return static_cast(client_data)-> visit(cursor, parent); } }; } // anonymous namespace static bool findIncludesInFile(CXTranslationUnit TU, const FileEntry *File, CXCursorAndRangeVisitor Visitor) { assert(TU && File && Visitor.visit); ASTUnit *Unit = cxtu::getASTUnit(TU); SourceManager &SM = Unit->getSourceManager(); FileID FID = SM.translateFile(File); FindFileIncludesVisitor IncludesVisitor(*Unit, File, Visitor); SourceRange Range(SM.getLocForStartOfFile(FID), SM.getLocForEndOfFile(FID)); CursorVisitor InclusionCursorsVisitor(TU, FindFileIncludesVisitor::visit, &IncludesVisitor, /*VisitPreprocessorLast=*/false, /*VisitIncludedEntities=*/false, Range); return InclusionCursorsVisitor.visitPreprocessedEntitiesInRegion(); } //===----------------------------------------------------------------------===// // libclang public APIs. //===----------------------------------------------------------------------===// extern "C" { CXResult clang_findReferencesInFile(CXCursor cursor, CXFile file, CXCursorAndRangeVisitor visitor) { LogRef Log = Logger::make(LLVM_FUNCTION_NAME); if (clang_Cursor_isNull(cursor)) { if (Log) *Log << "Null cursor"; return CXResult_Invalid; } if (cursor.kind == CXCursor_NoDeclFound) { if (Log) *Log << "Got CXCursor_NoDeclFound"; return CXResult_Invalid; } if (!file) { if (Log) *Log << "Null file"; return CXResult_Invalid; } if (!visitor.visit) { if (Log) *Log << "Null visitor"; return CXResult_Invalid; } if (Log) *Log << cursor << " @@" << static_cast(file); ASTUnit *CXXUnit = cxcursor::getCursorASTUnit(cursor); if (!CXXUnit) return CXResult_Invalid; ASTUnit::ConcurrencyCheck Check(*CXXUnit); if (cursor.kind == CXCursor_MacroDefinition || cursor.kind == CXCursor_MacroExpansion) { if (findMacroRefsInFile(cxcursor::getCursorTU(cursor), cursor, static_cast(file), visitor)) return CXResult_VisitBreak; return CXResult_Success; } // We are interested in semantics of identifiers so for C++ constructor exprs // prefer type references, e.g.: // // return MyStruct(); // // for 'MyStruct' we'll have a cursor pointing at the constructor decl but // we are actually interested in the type declaration. cursor = cxcursor::getTypeRefCursor(cursor); CXCursor refCursor = clang_getCursorReferenced(cursor); if (!clang_isDeclaration(refCursor.kind)) { if (Log) *Log << "cursor is not referencing a declaration"; return CXResult_Invalid; } if (findIdRefsInFile(cxcursor::getCursorTU(cursor), refCursor, static_cast(file), visitor)) return CXResult_VisitBreak; return CXResult_Success; } CXResult clang_findIncludesInFile(CXTranslationUnit TU, CXFile file, CXCursorAndRangeVisitor visitor) { if (cxtu::isNotUsableTU(TU)) { LOG_BAD_TU(TU); return CXResult_Invalid; } LogRef Log = Logger::make(LLVM_FUNCTION_NAME); if (!file) { if (Log) *Log << "Null file"; return CXResult_Invalid; } if (!visitor.visit) { if (Log) *Log << "Null visitor"; return CXResult_Invalid; } if (Log) *Log << TU << " @@" << static_cast(file); ASTUnit *CXXUnit = cxtu::getASTUnit(TU); if (!CXXUnit) return CXResult_Invalid; ASTUnit::ConcurrencyCheck Check(*CXXUnit); if (findIncludesInFile(TU, static_cast(file), visitor)) return CXResult_VisitBreak; return CXResult_Success; } static enum CXVisitorResult _visitCursorAndRange(void *context, CXCursor cursor, CXSourceRange range) { CXCursorAndRangeVisitorBlock block = (CXCursorAndRangeVisitorBlock)context; return INVOKE_BLOCK2(block, cursor, range); } CXResult clang_findReferencesInFileWithBlock(CXCursor cursor, CXFile file, CXCursorAndRangeVisitorBlock block) { CXCursorAndRangeVisitor visitor = { block, block ? _visitCursorAndRange : 0 }; return clang_findReferencesInFile(cursor, file, visitor); } CXResult clang_findIncludesInFileWithBlock(CXTranslationUnit TU, CXFile file, CXCursorAndRangeVisitorBlock block) { CXCursorAndRangeVisitor visitor = { block, block ? _visitCursorAndRange : 0 }; return clang_findIncludesInFile(TU, file, visitor); } } // end: extern "C" @