/* Copyright 2017-2018 ccls Authors Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ==============================================================================*/ #pragma once #include "clang_tu.hh" #include "lsp.hh" #include "project.hh" #include "threaded_queue.hh" #include "working_files.hh" #include #include #include #include #include #include #include #include #include namespace ccls { struct PreambleData; 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; }; TextEdit ToTextEdit(const clang::SourceManager &SM, const clang::LangOptions &L, const clang::FixItHint &FixIt); template struct LruCache { LruCache(int capacity) : capacity(capacity) {} std::shared_ptr Get(const K &key) { for (auto it = items.begin(); it != items.end(); ++it) if (it->first == key) { auto x = std::move(*it); std::move_backward(items.begin(), it, it + 1); items[0] = std::move(x); return items[0].second; } return nullptr; } std::shared_ptr Take(const K &key) { for (auto it = items.begin(); it != items.end(); ++it) if (it->first == key) { auto x = std::move(it->second); items.erase(it); return x; } return nullptr; } void Insert(const K &key, std::shared_ptr value) { if ((int)items.size() >= capacity) items.pop_back(); items.emplace(items.begin(), key, std::move(value)); } void Clear() { items.clear(); } private: std::vector>> items; int capacity; }; 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 = llvm::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(); }; 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 RequestId &id, const TextDocumentIdentifier &document, const Position &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) {} RequestId id; TextDocumentIdentifier document; Position 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 *wfiles, 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 *wfiles_; 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 std::string path, Position position) { std::lock_guard lock(mutex); return this->path == path && this->position == position; } }; } // namespace ccls