ccls/src/messages/textDocument_codeLens.cc

/* 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 "clang_complete.hh"
#include "lsp_code_action.h"
#include "message_handler.h"
#include "pipeline.hh"
#include "query_utils.h"
using namespace ccls;

#include <unordered_set>

namespace {
MethodType kMethodType = "textDocument/codeLens";

using TCodeLens = lsCodeLens<lsCodeLensUserData, lsCodeLensCommandArguments>;
struct In_TextDocumentCodeLens : public RequestInMessage {
  MethodType GetMethodType() const override { return kMethodType; }
  struct Params {
    lsTextDocumentIdentifier textDocument;
  } params;
};
MAKE_REFLECT_STRUCT(In_TextDocumentCodeLens::Params, textDocument);
MAKE_REFLECT_STRUCT(In_TextDocumentCodeLens, id, params);
REGISTER_IN_MESSAGE(In_TextDocumentCodeLens);

struct Out_TextDocumentCodeLens
    : public lsOutMessage<Out_TextDocumentCodeLens> {
  lsRequestId id;
  std::vector<lsCodeLens<lsCodeLensUserData, lsCodeLensCommandArguments>>
      result;
};
MAKE_REFLECT_STRUCT(Out_TextDocumentCodeLens, jsonrpc, id, result);

struct CommonCodeLensParams {
  std::vector<TCodeLens> *result;
  DB *db;
  WorkingFiles *working_files;
  WorkingFile *working_file;
};

Use OffsetStartColumn(Use use, int16_t offset) {
  use.range.start.column += offset;
  return use;
}

void AddCodeLens(const char *singular, const char *plural,
                 CommonCodeLensParams *common, Use use,
                 const std::vector<Use> &uses, bool force_display) {
  TCodeLens code_lens;
  std::optional<lsRange> range = GetLsRange(common->working_file, use.range);
  if (!range)
    return;
  if (use.file_id < 0)
    return;
  code_lens.range = *range;
  code_lens.command = lsCommand<lsCodeLensCommandArguments>();
  code_lens.command->command = "ccls.showReferences";
  code_lens.command->arguments.uri = GetLsDocumentUri(common->db, use.file_id);
  code_lens.command->arguments.position = code_lens.range.start;

  // Add unique uses.
  std::vector<lsLocation> unique_uses;
  for (Use use1 : uses) {
    if (auto ls_loc = GetLsLocation(common->db, common->working_files, use1))
      unique_uses.push_back(*ls_loc);
  }
  code_lens.command->arguments.locations.assign(unique_uses.begin(),
                                                unique_uses.end());

  // User visible label
  size_t num_usages = unique_uses.size();
  code_lens.command->title = std::to_string(num_usages) + " ";
  if (num_usages == 1)
    code_lens.command->title += singular;
  else
    code_lens.command->title += plural;

  if (force_display || unique_uses.size() > 0)
    common->result->push_back(code_lens);
}

struct Handler_TextDocumentCodeLens
    : BaseMessageHandler<In_TextDocumentCodeLens> {
  MethodType GetMethodType() const override { return kMethodType; }
  void Run(In_TextDocumentCodeLens *request) override {
    auto &params = request->params;
    Out_TextDocumentCodeLens out;
    out.id = request->id;

    std::string path = params.textDocument.uri.GetPath();
    clang_complete->NotifyView(path);

    QueryFile *file;
    if (!FindFileOrFail(db, project, request->id,
                        params.textDocument.uri.GetPath(), &file))
      return;

    CommonCodeLensParams common;
    common.result = &out.result;
    common.db = db;
    common.working_files = working_files;
    common.working_file = working_files->GetFileByFilename(file->def->path);

    std::unordered_set<Range> seen;
    for (auto [sym, refcnt] : file->outline2refcnt) {
      if (refcnt <= 0 || !seen.insert(sym.range).second)
        continue;
      // NOTE: We OffsetColumn so that the code lens always show up in a
      // predictable order. Otherwise, the client may randomize it.
      Use use{{sym.range, sym.usr, sym.kind, sym.role}, file->id};

      switch (sym.kind) {
      case SymbolKind::Type: {
        QueryType &type = db->GetType(sym);
        const QueryType::Def *def = type.AnyDef();
        if (!def || def->kind == lsSymbolKind::Namespace)
          continue;
        AddCodeLens("ref", "refs", &common, OffsetStartColumn(use, 0),
                    type.uses, true /*force_display*/);
        AddCodeLens("derived", "derived", &common, OffsetStartColumn(use, 1),
                    GetTypeDeclarations(db, type.derived),
                    false /*force_display*/);
        AddCodeLens("var", "vars", &common, OffsetStartColumn(use, 2),
                    GetVarDeclarations(db, type.instances, true),
                    false /*force_display*/);
        break;
      }
      case SymbolKind::Func: {
        QueryFunc &func = db->GetFunc(sym);
        const QueryFunc::Def *def = func.AnyDef();
        if (!def)
          continue;

        int16_t offset = 0;

        // For functions, the outline will report a location that is using the
        // extent since that is better for outline. This tries to convert the
        // extent location to the spelling location.
        auto try_ensure_spelling = [&](Use use) {
          Maybe<Use> def = GetDefinitionSpell(db, use);
          if (!def || def->range.start.line != use.range.start.line) {
            return use;
          }
          return *def;
        };

        std::vector<Use> base_callers = GetUsesForAllBases(db, func);
        std::vector<Use> derived_callers = GetUsesForAllDerived(db, func);
        if (base_callers.empty() && derived_callers.empty()) {
          Use loc = try_ensure_spelling(use);
          AddCodeLens("call", "calls", &common,
                      OffsetStartColumn(loc, offset++), func.uses,
                      true /*force_display*/);
        } else {
          Use loc = try_ensure_spelling(use);
          AddCodeLens("direct call", "direct calls", &common,
                      OffsetStartColumn(loc, offset++), func.uses,
                      false /*force_display*/);
          if (!base_callers.empty())
            AddCodeLens("base call", "base calls", &common,
                        OffsetStartColumn(loc, offset++), base_callers,
                        false /*force_display*/);
          if (!derived_callers.empty())
            AddCodeLens("derived call", "derived calls", &common,
                        OffsetStartColumn(loc, offset++), derived_callers,
                        false /*force_display*/);
        }

        AddCodeLens(
            "derived", "derived", &common, OffsetStartColumn(use, offset++),
            GetFuncDeclarations(db, func.derived), false /*force_display*/);

        // "Base"
        if (def->bases.size() == 1) {
          Maybe<Use> base_loc = GetDefinitionSpell(
              db, SymbolIdx{def->bases[0], SymbolKind::Func});
          if (base_loc) {
            std::optional<lsLocation> ls_base =
                GetLsLocation(db, working_files, *base_loc);
            if (ls_base) {
              std::optional<lsRange> range =
                  GetLsRange(common.working_file, sym.range);
              if (range) {
                TCodeLens code_lens;
                code_lens.range = *range;
                code_lens.range.start.character += offset++;
                code_lens.command = lsCommand<lsCodeLensCommandArguments>();
                code_lens.command->title = "Base";
                code_lens.command->command = "ccls.goto";
                code_lens.command->arguments.uri = ls_base->uri;
                code_lens.command->arguments.position = ls_base->range.start;
                out.result.push_back(code_lens);
              }
            }
          }
        } else {
          AddCodeLens("base", "base", &common, OffsetStartColumn(use, 1),
                      GetTypeDeclarations(db, def->bases),
                      false /*force_display*/);
        }

        break;
      }
      case SymbolKind::Var: {
        QueryVar &var = db->GetVar(sym);
        const QueryVar::Def *def = var.AnyDef();
        if (!def || (def->is_local() && !g_config->codeLens.localVariables))
          continue;

        bool force_display = true;
        // Do not show 0 refs on macro with no uses, as it is most likely
        // a header guard.
        if (def->kind == lsSymbolKind::Macro)
          force_display = false;

        AddCodeLens("ref", "refs", &common, OffsetStartColumn(use, 0), var.uses,
                    force_display);
        break;
      }
      case SymbolKind::File:
      case SymbolKind::Invalid: {
        assert(false && "unexpected");
        break;
      }
      };
    }

    pipeline::WriteStdout(kMethodType, out);
  }
};
REGISTER_MESSAGE_HANDLER(Handler_TextDocumentCodeLens);
} // namespace