ccls/libclangmm/Cursor.cc

#include <algorithm>
#include <cassert>

#include "Cursor.h"
#include "Utility.h"

namespace clang {

Type::Type() : cx_type() {}

Type::Type(const CXType& other) : cx_type(other) {}


bool Type::operator==(const Type& rhs) const {
  return clang_equalTypes(cx_type, rhs.cx_type);
}

bool Type::is_fundamental() const {
  //switch (cx_type.kind) {
  //case CXType_Auto:
    //return true;
  //}

  // NOTE: This will return false for pointed types. Should we call
  //       strip_qualifiers for the user?
  return cx_type.kind >= CXType_FirstBuiltin &&
         cx_type.kind <= CXType_LastBuiltin;
}

std::string Type::get_usr() const {
  return clang::Cursor(clang_getTypeDeclaration(cx_type)).get_usr();
}

Type Type::strip_qualifiers() const {
  //CXRefQualifierKind qualifiers = clang_Type_getCXXRefQualifier(cx_type)
  switch (cx_type.kind) {
  case CXType_LValueReference:
  case CXType_Pointer:
    return clang_getPointeeType(cx_type);
  }

  return cx_type;
}

std::string Type::get_spelling() const {
  return ToString(clang_getTypeSpelling(cx_type));
}

/*
SourceLocation Cursor::get_source_location() const {
  return SourceLocation(clang_getCursorLocation(cx_cursor));
}
*/

Type Type::get_return_type() const {
  return Type(clang_getResultType(cx_type));
}

std::vector<Type> Type::get_arguments() const {
  int size = clang_getNumArgTypes(cx_type);
  assert(size >= 0);
  if (size < 0)
    return std::vector<Type>();

  std::vector<Type> types(size);
  for (int i = 0; i < size; ++i)
    types.emplace_back(clang_getArgType(cx_type, i));
  return types;
}


std::vector<Type> Type::get_template_arguments() const {
  /*
  CINDEX_LINKAGE int clang_Type_getNumTemplateArguments(CXType T);
  CINDEX_LINKAGE CXType clang_Type_getTemplateArgumentAsType(CXType T, unsigned i);
  */

  int size = clang_Type_getNumTemplateArguments(cx_type);
  assert(size >= 0);
  if (size < 0)
    return std::vector<Type>();

  std::vector<Type> types(size);
  for (int i = 0; i < size; ++i)
    types.emplace_back(clang_Type_getTemplateArgumentAsType(cx_type, i));
  return types;
}


static_assert(sizeof(Cursor) == sizeof(CXCursor),
  "Cursor must be the same size as CXCursor");

Cursor::Cursor() : cx_cursor(clang_getNullCursor()) {}

Cursor::Cursor(const CXCursor& other) : cx_cursor(other) {}

Cursor::operator bool() const {
  return !clang_Cursor_isNull(cx_cursor);
}

bool Cursor::operator==(const Cursor& rhs) const {
  return clang_equalCursors(cx_cursor, rhs.cx_cursor);
}

CXCursorKind Cursor::get_kind() const {
  return cx_cursor.kind;
}

Type Cursor::get_type() const {
  return Type(clang_getCursorType(cx_cursor));
}

/*
SourceRange Cursor::get_source_range() const {
  return SourceRange(clang_getCursorExtent(cx_cursor));
}
*/

std::string Cursor::get_spelling() const {
  return clang::ToString(clang_getCursorSpelling(cx_cursor));
}

std::string Cursor::get_display_name() const {
  return clang::ToString(clang_getCursorDisplayName(cx_cursor));
}

std::string Cursor::get_usr() const {
  return clang::ToString(clang_getCursorUSR(cx_cursor));
}

bool Cursor::is_definition() const {
  return clang_isCursorDefinition(cx_cursor);
}

Cursor Cursor::template_specialization_to_template_definition() const {
  // TODO: Should we return this same cursor if this is not a template? We
  // can probably check USR to do that.
  return clang_getSpecializedCursorTemplate(cx_cursor);
}

Cursor Cursor::get_referenced() const {
  return Cursor(clang_getCursorReferenced(cx_cursor));
}

Cursor Cursor::get_canonical() const {
  return Cursor(clang_getCanonicalCursor(cx_cursor));
}

Cursor Cursor::get_definition() const {
  return Cursor(clang_getCursorDefinition(cx_cursor));
}

Cursor Cursor::get_semantic_parent() const {
  return Cursor(clang_getCursorSemanticParent(cx_cursor));
}

std::vector<Cursor> Cursor::get_arguments() const {
  int size = clang_Cursor_getNumArguments(cx_cursor);
  assert(size >= 0);
  if (size < 0)
    return std::vector<Cursor>();

  std::vector<Cursor> cursors(size);
  for (int i = 0; i < size; ++i)
    cursors.emplace_back(clang_Cursor_getArgument(cx_cursor, i));
  return cursors;
}

bool Cursor::is_valid_kind() const {
  CXCursor referenced = clang_getCursorReferenced(cx_cursor);
  if (clang_Cursor_isNull(referenced))
    return false;

  CXCursorKind kind = get_kind();
  return kind > CXCursor_UnexposedDecl &&
    (kind < CXCursor_FirstInvalid || kind > CXCursor_LastInvalid);
}

std::string Cursor::get_type_description() const {
  std::string spelling;

  auto referenced = clang_getCursorReferenced(cx_cursor);
  if (!clang_Cursor_isNull(referenced)) {
    auto type = clang_getCursorType(referenced);
    spelling = clang::ToString(clang_getTypeSpelling(type));

#if CINDEX_VERSION_MAJOR==0 && CINDEX_VERSION_MINOR<32
    const std::string auto_str = "auto";
    if (spelling.size() >= 4 && std::equal(auto_str.begin(), auto_str.end(), spelling.begin())) {
      auto canonical_type = clang_getCanonicalType(clang_getCursorType(cx_cursor));
      auto canonical_spelling = ToString(clang_getTypeSpelling(canonical_type));
      if (spelling.size() > 5 && spelling[4] == ' ' && spelling[5] == '&' && spelling != canonical_spelling)
        return canonical_spelling + " &";
      else
        return canonical_spelling;
    }

    const std::string const_auto_str = "const auto";
    if (spelling.size() >= 10 && std::equal(const_auto_str.begin(), const_auto_str.end(), spelling.begin())) {
      auto canonical_type = clang_getCanonicalType(clang_getCursorType(cx_cursor));
      auto canonical_spelling = ToString(clang_getTypeSpelling(canonical_type));
      if (spelling.size() > 11 && spelling[10] == ' ' && spelling[11] == '&' && spelling != canonical_spelling)
        return canonical_spelling + " &";
      else
        return canonical_spelling;
}
#endif
}

  if (spelling.empty())
    return get_spelling();

  return spelling;
}

#if false
std::string Cursor::evaluate() const {
  CXEvalResult eval = clang_Cursor_Evaluate(cx_cursor);

  std::string result;
  auto kind = clang_EvalResult_getKind(eval);
  switch (clang_EvalResult_getKind(eval)) {
  case CXEval_Int:
    result = std::to_string(clang_EvalResult_getAsInt(eval));
    break;
  case CXEval_Float:
    result = std::to_string(clang_EvalResult_getAsDouble(eval));
    break;
  default:
  {
    const char* r = clang_EvalResult_getAsStr(eval);
    if (r)
      result = r;
    break;
  }
  }

  clang_EvalResult_dispose(eval);
  return result;

#if false
  typedef enum {
    CXEval_Int = 1,
    CXEval_Float = 2,
    CXEval_ObjCStrLiteral = 3,
    CXEval_StrLiteral = 4,
    CXEval_CFStr = 5,
    CXEval_Other = 6,

    CXEval_UnExposed = 0

  } CXEvalResultKind;

  /**
  * \brief Evaluation result of a cursor
  */
  typedef void * CXEvalResult;

  /**
  * \brief If cursor is a statement declaration tries to evaluate the
  * statement and if its variable, tries to evaluate its initializer,
  * into its corresponding type.
  */
  CINDEX_LINKAGE CXEvalResult clang_Cursor_Evaluate(CXCursor C);

  /**
  * \brief Returns the kind of the evaluated result.
  */
  CINDEX_LINKAGE CXEvalResultKind clang_EvalResult_getKind(CXEvalResult E);

  /**
  * \brief Returns the evaluation result as integer if the
  * kind is Int.
  */
  CINDEX_LINKAGE int clang_EvalResult_getAsInt(CXEvalResult E);

  /**
  * \brief Returns the evaluation result as double if the
  * kind is double.
  */
  CINDEX_LINKAGE double clang_EvalResult_getAsDouble(CXEvalResult E);

  /**
  * \brief Returns the evaluation result as a constant string if the
  * kind is other than Int or float. User must not free this pointer,
  * instead call clang_EvalResult_dispose on the CXEvalResult returned
  * by clang_Cursor_Evaluate.
  */
  CINDEX_LINKAGE const char* clang_EvalResult_getAsStr(CXEvalResult E);

  /**
  * \brief Disposes the created Eval memory.
  */
  CINDEX_LINKAGE void clang_EvalResult_dispose(CXEvalResult E);
#endif


  }
#endif

std::string Cursor::get_comments() const {
  Cursor referenced = get_referenced();
  if (referenced)
    return clang::ToString(clang_Cursor_getRawCommentText(referenced.cx_cursor));

  return "";
}

std::string Cursor::ToString() const {
  return clang::ToString(get_kind()) + " " + get_spelling();
}

  }  // namespace clang