//===------ CodeCompletion.cpp - Code Completion for ClangRepl -------===// // // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. // See https://llvm.org/LICENSE.txt for license information. // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception // //===----------------------------------------------------------------------===// // // This file implements the classes which performs code completion at the REPL. // //===----------------------------------------------------------------------===// #include "clang/Interpreter/CodeCompletion.h" #include "clang/AST/ASTImporter.h" #include "clang/AST/DeclarationName.h" #include "clang/AST/ExternalASTSource.h" #include "clang/Basic/IdentifierTable.h" #include "clang/Frontend/ASTUnit.h" #include "clang/Frontend/CompilerInstance.h" #include "clang/Frontend/FrontendActions.h" #include "clang/Interpreter/Interpreter.h" #include "clang/Lex/PreprocessorOptions.h" #include "clang/Sema/CodeCompleteConsumer.h" #include "clang/Sema/CodeCompleteOptions.h" #include "clang/Sema/Sema.h" namespace clang { const std::string CodeCompletionFileName = "input_line_[Completion]"; clang::CodeCompleteOptions getClangCompleteOpts() { clang::CodeCompleteOptions Opts; Opts.IncludeCodePatterns = true; Opts.IncludeMacros = true; Opts.IncludeGlobals = true; Opts.IncludeBriefComments = true; return Opts; } class ReplCompletionConsumer : public CodeCompleteConsumer { public: ReplCompletionConsumer(std::vector &Results) : CodeCompleteConsumer(getClangCompleteOpts()), CCAllocator(std::make_shared()), CCTUInfo(CCAllocator), Results(Results){}; void ProcessCodeCompleteResults(class Sema &S, CodeCompletionContext Context, CodeCompletionResult *InResults, unsigned NumResults) final; CodeCompletionAllocator &getAllocator() override { return *CCAllocator; } CodeCompletionTUInfo &getCodeCompletionTUInfo() override { return CCTUInfo; } private: std::shared_ptr CCAllocator; CodeCompletionTUInfo CCTUInfo; std::vector &Results; }; void ReplCompletionConsumer::ProcessCodeCompleteResults( class Sema &S, CodeCompletionContext Context, CodeCompletionResult *InResults, unsigned NumResults) { for (unsigned I = 0; I < NumResults; ++I) { auto &Result = InResults[I]; switch (Result.Kind) { case CodeCompletionResult::RK_Declaration: if (auto *ID = Result.Declaration->getIdentifier()) { Results.push_back(ID->getName().str()); } break; case CodeCompletionResult::RK_Keyword: Results.push_back(Result.Keyword); break; default: break; } } } class IncrementalSyntaxOnlyAction : public SyntaxOnlyAction { const CompilerInstance *ParentCI; public: IncrementalSyntaxOnlyAction(const CompilerInstance *ParentCI) : ParentCI(ParentCI) {} protected: void ExecuteAction() override; }; class ExternalSource : public clang::ExternalASTSource { TranslationUnitDecl *ChildTUDeclCtxt; ASTContext &ParentASTCtxt; TranslationUnitDecl *ParentTUDeclCtxt; std::unique_ptr Importer; public: ExternalSource(ASTContext &ChildASTCtxt, FileManager &ChildFM, ASTContext &ParentASTCtxt, FileManager &ParentFM); bool FindExternalVisibleDeclsByName(const DeclContext *DC, DeclarationName Name) override; void completeVisibleDeclsMap(const clang::DeclContext *childDeclContext) override; }; // This method is intended to set up `ExternalASTSource` to the running // compiler instance before the super `ExecuteAction` triggers parsing void IncrementalSyntaxOnlyAction::ExecuteAction() { CompilerInstance &CI = getCompilerInstance(); ExternalSource *myExternalSource = new ExternalSource(CI.getASTContext(), CI.getFileManager(), ParentCI->getASTContext(), ParentCI->getFileManager()); llvm::IntrusiveRefCntPtr astContextExternalSource( myExternalSource); CI.getASTContext().setExternalSource(astContextExternalSource); CI.getASTContext().getTranslationUnitDecl()->setHasExternalVisibleStorage( true); SyntaxOnlyAction::ExecuteAction(); } ExternalSource::ExternalSource(ASTContext &ChildASTCtxt, FileManager &ChildFM, ASTContext &ParentASTCtxt, FileManager &ParentFM) : ChildTUDeclCtxt(ChildASTCtxt.getTranslationUnitDecl()), ParentASTCtxt(ParentASTCtxt), ParentTUDeclCtxt(ParentASTCtxt.getTranslationUnitDecl()) { ASTImporter *importer = new ASTImporter(ChildASTCtxt, ChildFM, ParentASTCtxt, ParentFM, /*MinimalImport : ON*/ true); Importer.reset(importer); } bool ExternalSource::FindExternalVisibleDeclsByName(const DeclContext *DC, DeclarationName Name) { IdentifierTable &ParentIdTable = ParentASTCtxt.Idents; auto ParentDeclName = DeclarationName(&(ParentIdTable.get(Name.getAsString()))); DeclContext::lookup_result lookup_result = ParentTUDeclCtxt->lookup(ParentDeclName); if (!lookup_result.empty()) { return true; } return false; } void ExternalSource::completeVisibleDeclsMap( const DeclContext *ChildDeclContext) { assert(ChildDeclContext && ChildDeclContext == ChildTUDeclCtxt && "No child decl context!"); if (!ChildDeclContext->hasExternalVisibleStorage()) return; for (auto *DeclCtxt = ParentTUDeclCtxt; DeclCtxt != nullptr; DeclCtxt = DeclCtxt->getPreviousDecl()) { for (auto &IDeclContext : DeclCtxt->decls()) { if (NamedDecl *Decl = llvm::dyn_cast(IDeclContext)) { if (auto DeclOrErr = Importer->Import(Decl)) { if (NamedDecl *importedNamedDecl = llvm::dyn_cast(*DeclOrErr)) { SetExternalVisibleDeclsForName(ChildDeclContext, importedNamedDecl->getDeclName(), importedNamedDecl); } } else { llvm::consumeError(DeclOrErr.takeError()); } } } ChildDeclContext->setHasExternalLexicalStorage(false); } } void codeComplete(CompilerInstance *InterpCI, llvm::StringRef Content, unsigned Line, unsigned Col, const CompilerInstance *ParentCI, std::vector &CCResults) { auto DiagOpts = DiagnosticOptions(); auto consumer = ReplCompletionConsumer(CCResults); auto diag = InterpCI->getDiagnosticsPtr(); std::unique_ptr AU(ASTUnit::LoadFromCompilerInvocationAction( InterpCI->getInvocationPtr(), std::make_shared(), diag)); llvm::SmallVector sd = {}; llvm::SmallVector tb = {}; InterpCI->getFrontendOpts().Inputs[0] = FrontendInputFile( CodeCompletionFileName, Language::CXX, InputKind::Source); auto Act = std::unique_ptr( new IncrementalSyntaxOnlyAction(ParentCI)); std::unique_ptr MB = llvm::MemoryBuffer::getMemBufferCopy(Content, CodeCompletionFileName); llvm::SmallVector RemappedFiles; RemappedFiles.push_back(std::make_pair(CodeCompletionFileName, MB.get())); // we don't want the AU destructor to release the memory buffer that MB // owns twice, because MB handles its resource on its own. AU->setOwnsRemappedFileBuffers(false); AU->CodeComplete(CodeCompletionFileName, 1, Col, RemappedFiles, false, false, false, consumer, std::make_shared(), *diag, InterpCI->getLangOpts(), InterpCI->getSourceManager(), InterpCI->getFileManager(), sd, tb, std::move(Act)); } } // namespace clang