/* 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. ==============================================================================*/ #include "message_handler.h" #include "pipeline.hh" #include "query_utils.h" using namespace ccls; #include #include #include namespace { MethodType kMethodType = "textDocument/definition"; struct In_TextDocumentDefinition : public RequestInMessage { MethodType GetMethodType() const override { return kMethodType; } lsTextDocumentPositionParams params; }; MAKE_REFLECT_STRUCT(In_TextDocumentDefinition, id, params); REGISTER_IN_MESSAGE(In_TextDocumentDefinition); struct Out_TextDocumentDefinition : public lsOutMessage { lsRequestId id; std::vector result; }; MAKE_REFLECT_STRUCT(Out_TextDocumentDefinition, jsonrpc, id, result); std::vector GetNonDefDeclarationTargets(DB *db, SymbolRef sym) { switch (sym.kind) { case SymbolKind::Var: { std::vector ret = GetNonDefDeclarations(db, sym); // If there is no declaration, jump the its type. if (ret.empty()) { for (auto &def : db->GetVar(sym).def) if (def.type) { if (Maybe use = GetDefinitionSpell( db, SymbolIdx{def.type, SymbolKind::Type})) { ret.push_back(*use); break; } } } return ret; } default: return GetNonDefDeclarations(db, sym); } } struct Handler_TextDocumentDefinition : BaseMessageHandler { MethodType GetMethodType() const override { return kMethodType; } void Run(In_TextDocumentDefinition *request) override { auto ¶ms = request->params; int file_id; QueryFile *file; if (!FindFileOrFail(db, project, request->id, params.textDocument.uri.GetPath(), &file, &file_id)) return; Out_TextDocumentDefinition out; out.id = request->id; Maybe on_def; bool has_symbol = false; WorkingFile *wfile = working_files->GetFileByFilename(file->def->path); lsPosition &ls_pos = params.position; for (SymbolRef sym : FindSymbolsAtLocation(wfile, file, ls_pos)) { // Found symbol. Return definition. has_symbol = true; // Special cases which are handled: // - symbol has declaration but no definition (ie, pure virtual) // - start at spelling but end at extent for better mouse tooltip // - goto declaration while in definition of recursive type std::vector uses; EachEntityDef(db, sym, [&](const auto &def) { if (def.spell && def.extent) { Use spell = *def.spell; // If on a definition, clear |uses| to find declarations below. if (spell.file_id == file_id && spell.range.Contains(ls_pos.line, ls_pos.character)) { on_def = spell; uses.clear(); return false; } // We use spelling start and extent end because this causes vscode // to highlight the entire definition when previewing / hoving with // the mouse. spell.range.end = def.extent->range.end; uses.push_back(spell); } return true; }); if (uses.empty()) { // The symbol has no definition or the cursor is on a definition. uses = GetNonDefDeclarationTargets(db, sym); // There is no declaration but the cursor is on a definition. if (uses.empty() && on_def) uses.push_back(*on_def); } auto locs = GetLsLocationExs(db, working_files, uses); out.result.insert(out.result.end(), locs.begin(), locs.end()); if (!out.result.empty()) break; } // No symbols - check for includes. if (out.result.empty()) { for (const IndexInclude &include : file->def->includes) { if (include.line == ls_pos.line) { lsLocationEx result; result.uri = lsDocumentUri::FromPath(include.resolved_path); out.result.push_back(result); has_symbol = true; break; } } // Find the best match of the identifier at point. if (!has_symbol) { lsPosition position = request->params.position; const std::string &buffer = wfile->buffer_content; std::string_view query = LexIdentifierAroundPos(position, buffer); std::string_view short_query = query; { auto pos = query.rfind(':'); if (pos != std::string::npos) short_query = query.substr(pos + 1); } // For symbols whose short/detailed names contain |query| as a // substring, we use the tuple to find the best match. std::tuple best_score{INT_MAX, 0, true, 0}; SymbolIdx best_sym; best_sym.kind = SymbolKind::Invalid; auto fn = [&](SymbolIdx sym) { std::string_view short_name = db->GetSymbolName(sym, false), name = short_query.size() < query.size() ? db->GetSymbolName(sym, true) : short_name; if (short_name != short_query) return; if (Maybe use = GetDefinitionSpell(db, sym)) { std::tuple score{ int(name.size() - short_query.size()), 0, use->file_id != file_id, std::abs(use->range.start.line - position.line)}; // Update the score with qualified name if the qualified name // occurs in |name|. auto pos = name.rfind(query); if (pos != std::string::npos) { std::get<0>(score) = int(name.size() - query.size()); std::get<1>(score) = -int(pos); } if (score < best_score) { best_score = score; best_sym = sym; } } }; for (auto &func : db->funcs) fn({func.usr, SymbolKind::Func}); for (auto &type : db->types) fn({type.usr, SymbolKind::Type}); for (auto &var : db->vars) if (var.def.size() && !var.def[0].is_local()) fn({var.usr, SymbolKind::Var}); if (best_sym.kind != SymbolKind::Invalid) { Maybe use = GetDefinitionSpell(db, best_sym); assert(use); if (auto ls_loc = GetLsLocationEx(db, working_files, *use, g_config->xref.container)) out.result.push_back(*ls_loc); } } } pipeline::WriteStdout(kMethodType, out); } }; REGISTER_MESSAGE_HANDLER(Handler_TextDocumentDefinition); } // namespace