qt-creator/src/tools/clangbackend/source/tokeninfo.cpp

/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of Qt Creator.
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 as published by the Free Software
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
****************************************************************************/

#include "clangstring.h"
#include "cursor.h"
#include "token.h"
#include "tokeninfo.h"
#include "sourcelocation.h"
#include "sourcerange.h"
#include "sourcerangecontainer.h"

#include <array>

namespace ClangBackEnd {

TokenInfo::TokenInfo(const Cursor &cursor,
                     const Token *token,
                     std::vector<CXSourceRange> &currentOutputArgumentRanges)
    : m_originalCursor(cursor),
      m_token(token),
      m_currentOutputArgumentRanges(&currentOutputArgumentRanges)
{
    const SourceRange sourceRange = token->extent();
    const auto start = sourceRange.start();
    const auto end = sourceRange.end();

    m_line = start.line();
    m_column = start.column();
    m_offset = start.offset();
    m_length = end.offset() - start.offset();
}

bool TokenInfo::hasInvalidMainType() const
{
    return m_types.mainHighlightingType == HighlightingType::Invalid;
}

bool TokenInfo::hasMainType(HighlightingType type) const
{
    return m_types.mainHighlightingType == type;
}

unsigned TokenInfo::mixinSize() const {
    return m_types.mixinHighlightingTypes.size();
}

bool TokenInfo::hasMixinType(HighlightingType type) const
{
    auto found = std::find(m_types.mixinHighlightingTypes.begin(),
                           m_types.mixinHighlightingTypes.end(),
                           type);

    return found != m_types.mixinHighlightingTypes.end();
}

bool TokenInfo::hasMixinTypeAt(uint position, HighlightingType type) const
{
    return m_types.mixinHighlightingTypes.size() > position &&
           m_types.mixinHighlightingTypes.at(position) == type;
}

bool TokenInfo::hasOnlyType(HighlightingType type) const
{
    return m_types.mixinHighlightingTypes.size() == 0 && hasMainType(type);
}

bool TokenInfo::hasFunctionArguments() const
{
    return m_originalCursor.argumentCount() > 0;
}

TokenInfo::operator TokenInfoContainer() const
{
    return TokenInfoContainer(m_line, m_column, m_length, m_types);
}

static bool isFinalFunction(const Cursor &cursor)
{
    auto referencedCursor = cursor.referenced();
    if (referencedCursor.hasFinalFunctionAttribute())
        return true;
    else
        return false;
}

static bool isFunctionInFinalClass(const Cursor &cursor)
{
    auto functionBase = cursor.functionBaseDeclaration();
    if (functionBase.isValid() && functionBase.hasFinalClassAttribute())
        return true;

    return false;
}

void TokenInfo::memberReferenceKind(const Cursor &cursor)
{
    if (cursor.isDynamicCall()) {
        if (isFinalFunction(cursor) || isFunctionInFinalClass(cursor))
            m_types.mainHighlightingType = HighlightingType::Function;
        else
            m_types.mainHighlightingType = HighlightingType::VirtualFunction;
    } else {
        identifierKind(cursor.referenced(), Recursion::RecursivePass);
    }
}

void TokenInfo::overloadedDeclRefKind(const Cursor &cursor)
{
    m_types.mainHighlightingType = HighlightingType::Function;

    // CLANG-UPGRADE-CHECK: Workaround still needed?
    // Workaround https://bugs.llvm.org//show_bug.cgi?id=33256 - SomeType in
    // "using N::SomeType" is mistakenly considered as a CXCursor_OverloadedDeclRef.
    if (cursor.overloadedDeclarationsCount() >= 1
            && cursor.overloadedDeclaration(0).kind() != CXCursor_FunctionDecl
            && cursor.overloadedDeclaration(0).kind() != CXCursor_FunctionTemplate) {
        m_types.mainHighlightingType = HighlightingType::Type;
    }
}

void TokenInfo::variableKind(const Cursor &cursor)
{
    if (cursor.isLocalVariable())
        m_types.mainHighlightingType = HighlightingType::LocalVariable;
    else
        m_types.mainHighlightingType = HighlightingType::GlobalVariable;

    if (isOutputArgument())
        m_types.mixinHighlightingTypes.push_back(HighlightingType::OutputArgument);
}

void TokenInfo::fieldKind(const Cursor &cursor)
{
    m_types.mainHighlightingType = HighlightingType::Field;

    const CXCursorKind kind = cursor.kind();
    switch (kind) {
        default:
            m_types.mainHighlightingType = HighlightingType::Invalid;
            return;
        case CXCursor_ObjCPropertyDecl:
            m_types.mixinHighlightingTypes.push_back(HighlightingType::ObjectiveCProperty);
            Q_FALLTHROUGH();
        case CXCursor_FieldDecl:
        case CXCursor_MemberRef:
            if (isOutputArgument())
                m_types.mixinHighlightingTypes.push_back(HighlightingType::OutputArgument);
            return;
        case CXCursor_ObjCClassMethodDecl:
            m_types.mixinHighlightingTypes.push_back(HighlightingType::ObjectiveCMethod);
            return;
        case CXCursor_ObjCIvarDecl:
        case CXCursor_ObjCInstanceMethodDecl:
        case CXCursor_ObjCSynthesizeDecl:
        case CXCursor_ObjCDynamicDecl:
            return;
    }

}

bool TokenInfo::isDefinition() const
{
    return m_originalCursor.isDefinition();
}

bool TokenInfo::isVirtualMethodDeclarationOrDefinition(const Cursor &cursor) const
{
    return cursor.isVirtualMethod()
        && (m_originalCursor.isDeclaration() || m_originalCursor.isDefinition());
}

static bool isNotFinalFunction(const Cursor &cursor)
{
    return !cursor.hasFinalFunctionAttribute();
}

bool TokenInfo::isRealDynamicCall(const Cursor &cursor) const
{
    return m_originalCursor.isDynamicCall() && isNotFinalFunction(cursor);
}

void TokenInfo::addExtraTypeIfFirstPass(HighlightingType type,
                                               Recursion recursion)
{
    if (recursion == Recursion::FirstPass)
        m_types.mixinHighlightingTypes.push_back(type);
}

bool TokenInfo::isArgumentInCurrentOutputArgumentLocations() const
{
    auto originalSourceLocation = m_originalCursor.cxSourceLocation();

    const auto isNotSameOutputArgument = [&] (const CXSourceRange &currentSourceRange) {
        return originalSourceLocation.int_data >= currentSourceRange.begin_int_data
            && originalSourceLocation.int_data <= currentSourceRange.end_int_data;
    };

    auto found = std::find_if(m_currentOutputArgumentRanges->begin(),
                              m_currentOutputArgumentRanges->end(),
                              isNotSameOutputArgument);

    bool isOutputArgument = found != m_currentOutputArgumentRanges->end();

    return isOutputArgument;
}

// For reasons I don't fully understand, the cursors from clang_annotateTokens() are sometimes
// not the actual cursor for the respective token, but the one for a construct higher up
// in the syntax tree. This is often not what we want (e.g. QTCREATORBUG-21522, QTCREATORBUG-21534),
// so in such cases we re-retrieve the cursor for the token via clang_getCursor().
Cursor TokenInfo::realCursor(const Cursor &cursor)
{
    // Magic Qt stuff.
    if (cursor.kind() == CXCursor_InvalidFile && invalidFileKind() != QtMacroPart::None)
        return cursor;

    const SourceLocation tokenLoc = m_token->location();
    const SourceLocation cursorLoc = cursor.sourceLocation();
    if (tokenLoc == cursorLoc)
        return cursor;

    // Note: clang_getTokenLocation() does not work.
    const CXFile cxFile = clang_getFile(m_token->tu(), tokenLoc.filePath().toByteArray());
    const CXSourceLocation cxLoc = clang_getLocation(m_token->tu(), cxFile, tokenLoc.line(),
                                                     tokenLoc.column());
    return clang_getCursor(m_token->tu(), cxLoc);
}

bool TokenInfo::isOutputArgument() const
{
    if (m_currentOutputArgumentRanges->empty())
        return false;

    return isArgumentInCurrentOutputArgumentLocations();
}

void TokenInfo::collectOutputArguments(const Cursor &cursor)
{
    cursor.collectOutputArgumentRangesTo(*m_currentOutputArgumentRanges);
    filterOutPreviousOutputArguments();
}

static uint getEnd(CXSourceRange cxSourceRange)
{
    CXSourceLocation startSourceLocation = clang_getRangeEnd(cxSourceRange);

    uint endOffset;

    clang_getFileLocation(startSourceLocation, nullptr, nullptr, nullptr, &endOffset);

    return endOffset;
}

void TokenInfo::filterOutPreviousOutputArguments()
{
    auto isAfterLocation = [this] (CXSourceRange outputRange) {
        return getEnd(outputRange) > m_offset;
    };

    auto precedingBegin = std::partition(m_currentOutputArgumentRanges->begin(),
                                         m_currentOutputArgumentRanges->end(),
                                         isAfterLocation);

    m_currentOutputArgumentRanges->erase(precedingBegin, m_currentOutputArgumentRanges->end());
}

void TokenInfo::functionKind(const Cursor &cursor, Recursion recursion)
{
    if (isRealDynamicCall(cursor) || isVirtualMethodDeclarationOrDefinition(cursor))
        m_types.mainHighlightingType = HighlightingType::VirtualFunction;
    else
        m_types.mainHighlightingType = HighlightingType::Function;

    if (isOutputArgument())
        m_types.mixinHighlightingTypes.push_back(HighlightingType::OutputArgument);

    addExtraTypeIfFirstPass(HighlightingType::Declaration, recursion);

    if (isDefinition())
        addExtraTypeIfFirstPass(HighlightingType::FunctionDefinition, recursion);
}

void TokenInfo::referencedTypeKind(const Cursor &cursor)
{
    typeKind(cursor.referenced());
}

void TokenInfo::typeKind(const Cursor &cursor)
{
    m_types.mainHighlightingType = HighlightingType::Type;
    const CXCursorKind kind = cursor.kind();
    switch (kind) {
        default:
            m_types.mainHighlightingType = HighlightingType::Invalid;
            return;
        case CXCursor_TemplateRef:
        case CXCursor_NamespaceRef:
        case CXCursor_TypeRef:
            referencedTypeKind(cursor);
            return;
        case CXCursor_ClassTemplate:
        case CXCursor_ClassTemplatePartialSpecialization:
        case CXCursor_ClassDecl:
            m_types.mixinHighlightingTypes.push_back(HighlightingType::Class);
            return;
        case CXCursor_UnionDecl:
            m_types.mixinHighlightingTypes.push_back(HighlightingType::Union);
            return;
        case CXCursor_StructDecl:
            m_types.mixinHighlightingTypes.push_back(HighlightingType::Struct);
            return;
        case CXCursor_EnumDecl:
            m_types.mixinHighlightingTypes.push_back(HighlightingType::Enum);
            return;
        case CXCursor_NamespaceAlias:
        case CXCursor_Namespace:
            m_types.mixinHighlightingTypes.push_back(HighlightingType::Namespace);
            return;
        case CXCursor_TypeAliasDecl:
        case CXCursor_TypeAliasTemplateDecl:
            m_types.mixinHighlightingTypes.push_back(HighlightingType::TypeAlias);
            return;
        case CXCursor_TypedefDecl:
            m_types.mixinHighlightingTypes.push_back(HighlightingType::Typedef);
            return;
        case CXCursor_ObjCClassRef:
            m_types.mixinHighlightingTypes.push_back(HighlightingType::ObjectiveCClass);
            return;
        case CXCursor_ObjCProtocolDecl:
        case CXCursor_ObjCProtocolRef:
            m_types.mixinHighlightingTypes.push_back(HighlightingType::ObjectiveCProtocol);
            return;
        case CXCursor_ObjCInterfaceDecl:
            m_types.mixinHighlightingTypes.push_back(HighlightingType::ObjectiveCInterface);
            return;
        case CXCursor_ObjCImplementationDecl:
            m_types.mixinHighlightingTypes.push_back(HighlightingType::ObjectiveCImplementation);
            return;
        case CXCursor_ObjCCategoryDecl:
        case CXCursor_ObjCCategoryImplDecl:
            m_types.mixinHighlightingTypes.push_back(HighlightingType::ObjectiveCCategory);
            return;
        case CXCursor_TemplateTypeParameter:
            m_types.mixinHighlightingTypes.push_back(HighlightingType::TemplateTypeParameter);
            return;
        case CXCursor_TemplateTemplateParameter:
            m_types.mixinHighlightingTypes.push_back(HighlightingType::TemplateTemplateParameter);
            return;
        case CXCursor_ObjCSuperClassRef:
        case CXCursor_CXXStaticCastExpr:
        case CXCursor_CXXReinterpretCastExpr:
            break;
    }
}

void TokenInfo::identifierKind(const Cursor &cursor, Recursion recursion)
{
    if (cursor.isInvalidDeclaration())
        return;

    if (recursion == Recursion::FirstPass && cursor.kind() != CXCursor_NotImplemented) {
        const Cursor c = realCursor(cursor);
        if (!clang_isInvalid(c.kind()) && c != cursor) {
            identifierKind(c, Recursion::FirstPass);
            return;
        }
    }

    const CXCursorKind kind = cursor.kind();
    switch (kind) {
        case CXCursor_Destructor:
        case CXCursor_Constructor:
        case CXCursor_FunctionDecl:
        case CXCursor_FunctionTemplate:
        case CXCursor_CallExpr:
        case CXCursor_CXXMethod:
            functionKind(cursor, recursion);
            break;
        case CXCursor_NonTypeTemplateParameter:
            m_types.mainHighlightingType = HighlightingType::LocalVariable;
            break;
        case CXCursor_ParmDecl:
        case CXCursor_VarDecl:
        case CXCursor_VariableRef:
        case CXCursor_UnexposedDecl: // structured bindings; see https://reviews.llvm.org/D78213
            variableKind(cursor.referenced());
            break;
        case CXCursor_DeclRefExpr:
            identifierKind(cursor.referenced(), Recursion::RecursivePass);
            break;
        case CXCursor_MemberRefExpr:
            memberReferenceKind(cursor);
            break;
        case CXCursor_FieldDecl:
        case CXCursor_MemberRef:
        case CXCursor_ObjCPropertyDecl:
        case CXCursor_ObjCIvarDecl:
        case CXCursor_ObjCClassMethodDecl:
        case CXCursor_ObjCInstanceMethodDecl:
        case CXCursor_ObjCSynthesizeDecl:
        case CXCursor_ObjCDynamicDecl:
            fieldKind(cursor);
            break;
        case CXCursor_TemplateRef:
        case CXCursor_NamespaceRef:
        case CXCursor_TypeRef:
            referencedTypeKind(cursor);
            break;
        case CXCursor_ClassDecl:
        case CXCursor_ClassTemplate:
        case CXCursor_ClassTemplatePartialSpecialization:
        case CXCursor_UnionDecl:
        case CXCursor_StructDecl:
        case CXCursor_EnumDecl:
        case CXCursor_Namespace:
            m_types.mixinHighlightingTypes.push_back(HighlightingType::Declaration);
            Q_FALLTHROUGH();
        case CXCursor_TemplateTypeParameter:
        case CXCursor_TemplateTemplateParameter:
        case CXCursor_NamespaceAlias:
        case CXCursor_TypeAliasDecl:
        case CXCursor_TypedefDecl:
        case CXCursor_CXXStaticCastExpr:
        case CXCursor_CXXReinterpretCastExpr:
        case CXCursor_ObjCCategoryDecl:
        case CXCursor_ObjCCategoryImplDecl:
        case CXCursor_ObjCImplementationDecl:
        case CXCursor_ObjCInterfaceDecl:
        case CXCursor_ObjCProtocolDecl:
        case CXCursor_ObjCProtocolRef:
        case CXCursor_ObjCClassRef:
        case CXCursor_ObjCSuperClassRef:
            typeKind(cursor);
            break;
        case CXCursor_OverloadedDeclRef:
            overloadedDeclRefKind(cursor);
            break;
        case CXCursor_EnumConstantDecl:
            m_types.mainHighlightingType = HighlightingType::Enumeration;
            break;
        case CXCursor_PreprocessingDirective:
            m_types.mainHighlightingType = HighlightingType::Preprocessor;
            break;
        case CXCursor_MacroExpansion:
            m_types.mainHighlightingType = HighlightingType::PreprocessorExpansion;
            break;
        case CXCursor_MacroDefinition:
            m_types.mainHighlightingType = HighlightingType::PreprocessorDefinition;
            break;
        case CXCursor_InclusionDirective:
            // Included files are sometimes reported as strings and sometimes as
            // include directives, depending on various circumstances.
            m_types.mainHighlightingType = m_token->spelling() == "include"
                    ? HighlightingType::Preprocessor : HighlightingType::StringLiteral;
            break;
        case CXCursor_LabelRef:
        case CXCursor_LabelStmt:
            m_types.mainHighlightingType = HighlightingType::Label;
            break;
        default:
            break;
    }
}

static HighlightingType literalKind(const Cursor &cursor)
{
    switch (cursor.kind()) {
        case CXCursor_CharacterLiteral:
        case CXCursor_StringLiteral:
        case CXCursor_InclusionDirective:
        case CXCursor_ObjCStringLiteral:
            return HighlightingType::StringLiteral;
        case CXCursor_IntegerLiteral:
        case CXCursor_ImaginaryLiteral:
        case CXCursor_FloatingLiteral:
            return HighlightingType::NumberLiteral;
        default:
            return HighlightingType::Invalid;
    }

    Q_UNREACHABLE();
}

static bool isTokenPartOfOperator(const Cursor &declarationCursor, const Token &token)
{
    Q_ASSERT(declarationCursor.isDeclaration());
    const CXTranslationUnit cxTranslationUnit = declarationCursor.cxTranslationUnit();
    const ClangString tokenName = token.spelling();
    if (tokenName == "operator")
        return true;

    if (tokenName == "(") {
        // Valid operator declarations have at least one token after '(' so
        // it's safe to proceed to token + 1 without extra checks.
        const ClangString nextToken = clang_getTokenSpelling(cxTranslationUnit, *(token.cx() + 1));
        if (nextToken != ")") {
            // Argument lists' parentheses are not operator tokens.
            // This '('-token opens a (non-empty) argument list.
            return false;
        }
    }

    // It's safe to evaluate the preceding token because we will at least have
    // the 'operator'-keyword's token to the left.
    CXToken *prevToken = token.cx() - 1;
    if (clang_getTokenKind(*prevToken) == CXToken_Punctuation) {
        if (tokenName == "(") {
            // In an operator declaration, when a '(' follows another punctuation
            // then this '(' opens an argument list. Ex: operator*()|operator()().
            return false;
        }

        // This token is preceded by another punctuation token so this token
        // could be the second token of a two-tokened operator such as
        // operator+=|-=|*=|/=|<<|==|<=|++ or the third token of operator
        // new[]|delete[]. We decrement one more time to hit one of the keywords:
        // "operator" / "delete" / "new".
        --prevToken;
    }

    const ClangString precedingKeyword =
            clang_getTokenSpelling(cxTranslationUnit, *prevToken);

    return precedingKeyword == "operator" ||
           precedingKeyword == "new" ||
           precedingKeyword == "delete";
}

void TokenInfo::overloadedOperatorKind()
{
    bool inOperatorDeclaration = m_originalCursor.isDeclaration();
    Cursor declarationCursor =
            inOperatorDeclaration ? m_originalCursor :
                                    m_originalCursor.referenced();
    if (!declarationCursor.displayName().startsWith("operator"))
        return;

    if (inOperatorDeclaration && !isTokenPartOfOperator(declarationCursor, *m_token))
        return;

    m_types.mixinHighlightingTypes.push_back(HighlightingType::Operator);
    m_types.mixinHighlightingTypes.push_back(HighlightingType::OverloadedOperator);
}

void TokenInfo::punctuationOrOperatorKind()
{
    m_types.mainHighlightingType = HighlightingType::Punctuation;
    auto kind = m_originalCursor.kind();
    switch (kind) {
        case CXCursor_CallExpr:
            collectOutputArguments(m_originalCursor);
            Q_FALLTHROUGH();
        case CXCursor_FunctionDecl:
        case CXCursor_CXXMethod:
        case CXCursor_DeclRefExpr:
            // TODO(QTCREATORBUG-19948): Mark calls to overloaded new and delete.
            // Today we can't because libclang sets these cursors' spelling to "".
            // case CXCursor_CXXNewExpr:
            // case CXCursor_CXXDeleteExpr:
            overloadedOperatorKind();
            break;
        case CXCursor_UnaryOperator:
        case CXCursor_BinaryOperator:
        case CXCursor_CompoundAssignOperator:
        case CXCursor_ConditionalOperator:
            m_types.mixinHighlightingTypes.push_back(HighlightingType::Operator);
            if (kind == CXCursor_ConditionalOperator) {
                if (m_token->spelling() == "?")
                    m_types.mixinHighlightingTypes.push_back(HighlightingType::TernaryIf);
                else
                    m_types.mixinHighlightingTypes.push_back(HighlightingType::TernaryElse);
            }
            break;
        default:
            break;
    }

    if (m_types.mainHighlightingType == HighlightingType::Punctuation
            && m_types.mixinHighlightingTypes.empty()
            && kind != CXCursor_InclusionDirective
            && kind != CXCursor_PreprocessingDirective) {
        const ClangString spelling = m_token->spelling();
        if (spelling == "<")
            m_types.mixinHighlightingTypes.push_back(HighlightingType::AngleBracketOpen);
        else if (spelling == ">")
            m_types.mixinHighlightingTypes.push_back(HighlightingType::AngleBracketClose);
        else if (spelling == ">>")
            m_types.mixinHighlightingTypes.push_back(HighlightingType::DoubleAngleBracketClose);
    }

    if (isOutputArgument())
        m_types.mixinHighlightingTypes.push_back(HighlightingType::OutputArgument);
}

static bool isFirstTokenOfCursor(const Cursor &cursor, const Token &token)
{
    return cursor.sourceLocation() == token.location();
}

static bool isLastTokenOfCursor(const Cursor &cursor, const Token &token)
{
    return cursor.sourceRange().end() == token.location();
}

static bool isValidMacroToken(const Cursor &cursor, const Token &token)
{
    // Proper macro token has at least '(' and ')' around it.
    return !isFirstTokenOfCursor(cursor, token) && !isLastTokenOfCursor(cursor, token);
}

TokenInfo::QtMacroPart TokenInfo::propertyPart(const Token &token)
{
    static constexpr const char *propertyKeywords[]
            = {"READ", "WRITE", "MEMBER", "RESET", "NOTIFY", "REVISION", "DESIGNABLE",
               "SCRIPTABLE", "STORED", "USER", "CONSTANT", "FINAL"
              };

    if (std::find(std::begin(propertyKeywords), std::end(propertyKeywords), token.spelling())
            != std::end(propertyKeywords)) {
        return QtMacroPart::Keyword;
    }

    const ClangString nextToken = clang_getTokenSpelling(token.tu(), *(token.cx() + 1));
    const ClangString previousToken = clang_getTokenSpelling(token.tu(), *(token.cx() - 1));
    if (std::find(std::begin(propertyKeywords), std::end(propertyKeywords), nextToken)
            != std::end(propertyKeywords)) {
        if (std::find(std::begin(propertyKeywords), std::end(propertyKeywords), previousToken)
                == std::end(propertyKeywords)) {
            return QtMacroPart::Property;
        }

        return QtMacroPart::FunctionOrPrimitiveType;
    }

    if (std::find(std::begin(propertyKeywords), std::end(propertyKeywords), previousToken)
            != std::end(propertyKeywords)) {
        return QtMacroPart::FunctionOrPrimitiveType;
    }
    return QtMacroPart::Type;
}

TokenInfo::QtMacroPart TokenInfo::signalSlotPart(CXTranslationUnit cxTranslationUnit,
                                                 CXToken *token, bool signal)
{
    // We are inside macro so current token has at least '(' and macro name before it.
    const ClangString prevToken = clang_getTokenSpelling(cxTranslationUnit, *(token - 2));
    if (signal)
        return (prevToken == "SIGNAL") ? QtMacroPart::SignalFunction : QtMacroPart::SignalType;
    return (prevToken == "SLOT") ? QtMacroPart::SlotFunction : QtMacroPart::SlotType;
}

TokenInfo::QtMacroPart TokenInfo::qtMacroPart(const Token &token)
{
    const SourceLocation location = token.location();

    // If current token is inside macro then the cursor from token's position will be
    // the whole macro cursor.
    Cursor possibleQtMacroCursor = clang_getCursor(token.tu(), location.cx());
    if (!isValidMacroToken(possibleQtMacroCursor, token))
        return QtMacroPart::None;

    ClangString spelling = possibleQtMacroCursor.spelling();
    if (spelling == "Q_PROPERTY")
        return propertyPart(token);

    if (spelling == "SIGNAL")
        return signalSlotPart(token.tu(), token.cx(), true);
    if (spelling == "SLOT")
        return signalSlotPart(token.tu(), token.cx(), false);
    return QtMacroPart::None;
}

TokenInfo::QtMacroPart TokenInfo::invalidFileKind()
{
    const QtMacroPart macroPart = qtMacroPart(*m_token);

    switch (macroPart) {
    case QtMacroPart::None:
    case QtMacroPart::Keyword:
        m_types.mainHighlightingType = HighlightingType::Invalid;
        break;
    case QtMacroPart::SignalFunction:
    case QtMacroPart::SlotFunction:
        m_types.mainHighlightingType = HighlightingType::Function;
        break;
    case QtMacroPart::SignalType:
    case QtMacroPart::SlotType:
        m_types.mainHighlightingType = HighlightingType::Type;
        break;
    case QtMacroPart::Property:
        m_types.mainHighlightingType = HighlightingType::QtProperty;
        break;
    case QtMacroPart::Type:
        m_types.mainHighlightingType = HighlightingType::Type;
        break;
    case QtMacroPart::FunctionOrPrimitiveType:
        m_types.mainHighlightingType = HighlightingType::Function;
        break;
    }

    return macroPart;
}

void TokenInfo::keywordKind()
{
    switch (m_originalCursor.kind()) {
        case CXCursor_PreprocessingDirective:
            m_types.mainHighlightingType = HighlightingType::Preprocessor;
            return;
        case CXCursor_InclusionDirective:
            m_types.mainHighlightingType = HighlightingType::StringLiteral;
            return;
        default:
            break;
    }

    const ClangString spelling = m_token->spelling();
    if (spelling == "bool"
            || spelling == "char"
            || spelling == "char16_t"
            || spelling == "char32_t"
            || spelling == "double"
            || spelling == "float"
            || spelling == "int"
            || spelling == "long"
            || spelling == "short"
            || spelling == "signed"
            || spelling == "unsigned"
            || spelling == "void"
            || spelling == "wchar_t") {
        m_types.mainHighlightingType =  HighlightingType::PrimitiveType;
        return;
    }

    m_types.mainHighlightingType = HighlightingType::Keyword;

    if (spelling == "new" || spelling == "delete" || spelling == "operator")
        overloadedOperatorKind();
}

void TokenInfo::evaluate()
{
    auto cxTokenKind = m_token->kind();

    m_types = HighlightingTypes();

    switch (cxTokenKind) {
        case CXToken_Keyword:
            keywordKind();
            break;
        case CXToken_Punctuation:
            punctuationOrOperatorKind();
            break;
        case CXToken_Identifier:
            identifierKind(m_originalCursor, Recursion::FirstPass);
            break;
        case CXToken_Comment:
            m_types.mainHighlightingType = HighlightingType::Comment;
            break;
        case CXToken_Literal:
            m_types.mainHighlightingType = literalKind(m_originalCursor);
            break;
    }
}

} // namespace ClangBackEnd