// Copyright 2017-2018 ccls Authors // SPDX-License-Identifier: Apache-2.0 #pragma once #include "clang_tu.hh" #include "lru_cache.h" #include "lsp_completion.h" #include "lsp_diagnostic.h" #include "project.h" #include "threaded_queue.h" #include "working_files.h" #include #include #include #include #include #include #include namespace ccls { struct DiagBase { Range range; std::string message; std::string file; clang::DiagnosticsEngine::Level level = clang::DiagnosticsEngine::Note; unsigned category; bool concerned = false; }; struct Note : DiagBase {}; struct Diag : DiagBase { std::vector notes; std::vector edits; }; struct PreambleData { PreambleData(clang::PrecompiledPreamble P, std::vector diags) : Preamble(std::move(P)), diags(std::move(diags)) {} clang::PrecompiledPreamble Preamble; std::vector diags; }; struct CompletionSession : public std::enable_shared_from_this { std::mutex mutex; std::shared_ptr preamble; Project::Entry file; WorkingFiles *wfiles; bool inferred = false; // TODO share llvm::IntrusiveRefCntPtr FS = clang::vfs::getRealFileSystem(); std::shared_ptr PCH; CompletionSession(const Project::Entry &file, WorkingFiles *wfiles, std::shared_ptr PCH) : file(file), wfiles(wfiles), PCH(PCH) {} std::shared_ptr GetPreamble(); void BuildPreamble(clang::CompilerInvocation &CI, const std::string &main); }; } struct CompletionManager { using OnDiagnostic = std::function diagnostics)>; // If OptConsumer is nullptr, the request has been cancelled. using OnComplete = std::function; using OnDropped = std::function; struct PreloadRequest { std::string path; }; struct CompletionRequest { CompletionRequest(const lsRequestId &id, const lsTextDocumentIdentifier &document, const lsPosition &position, std::unique_ptr Consumer, clang::CodeCompleteOptions CCOpts, const OnComplete &on_complete) : id(id), document(document), position(position), Consumer(std::move(Consumer)), CCOpts(CCOpts), on_complete(on_complete) {} lsRequestId id; lsTextDocumentIdentifier document; lsPosition position; std::unique_ptr Consumer; clang::CodeCompleteOptions CCOpts; OnComplete on_complete; }; struct DiagnosticRequest { std::string path; int64_t wait_until; int64_t debounce; }; CompletionManager(Project *project, WorkingFiles *working_files, OnDiagnostic on_diagnostic, OnDropped on_dropped); // Request a diagnostics update. void DiagnosticsUpdate(const std::string &path, int debounce); // Notify the completion manager that |filename| has been viewed and we // should begin preloading completion data. void NotifyView(const std::string &path); // Notify the completion manager that |filename| has been saved. This // triggers a reparse. void NotifySave(const std::string &path); // Notify the completion manager that |filename| has been closed. Any existing // completion session will be dropped. void OnClose(const std::string &path); // Ensures there is a completion or preloaded session. Returns true if a new // session was created. bool EnsureCompletionOrCreatePreloadSession(const std::string &path); // Tries to find an edit session for |filename|. This will move the session // from view to edit. std::shared_ptr TryGetSession(const std::string &path, bool preload, bool *is_open = nullptr); // Flushes all saved sessions void FlushAllSessions(void); // TODO: make these configurable. const int kMaxPreloadedSessions = 10; const int kMaxCompletionSessions = 5; // Global state. Project *project_; WorkingFiles *working_files_; OnDiagnostic on_diagnostic_; OnDropped on_dropped_; using LruSessionCache = LruCache; // CompletionSession instances which are preloaded, ie, files which the user // has viewed but not requested code completion for. LruSessionCache preloads; // CompletionSession instances which the user has actually performed // completion on. This is more rare so these instances tend to stay alive // much longer than the ones in |preloaded_sessions_|. LruSessionCache sessions; // Mutex which protects |view_sessions_| and |edit_sessions_|. std::mutex sessions_lock_; std::mutex diag_mutex; std::unordered_map next_diag; // Request a code completion at the given location. ThreadedQueue> completion_request_; ThreadedQueue diagnostic_request_; // Parse requests. The path may already be parsed, in which case it should be // reparsed. ThreadedQueue preload_requests_; std::shared_ptr PCH; }; // Cached completion information, so we can give fast completion results when // the user erases a character. vscode will resend the completion request if // that happens. template struct CompleteConsumerCache { // NOTE: Make sure to access these variables under |WithLock|. std::optional path; std::optional position; T result; std::mutex mutex; void WithLock(std::function action) { std::lock_guard lock(mutex); action(); } bool IsCacheValid(const lsTextDocumentPositionParams ¶ms) { std::lock_guard lock(mutex); return path == params.textDocument.uri.GetPath() && position == params.position; } };