aboutsummaryrefslogtreecommitdiffstats
path: root/src/tools/clangbackend/source/tokeninfo.h
blob: bcb77bddeed64b0a8ac8e5876f2dae326ceddb0e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
/****************************************************************************
**
** 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.
**
****************************************************************************/

#pragma once

#include "clangsupport_global.h"
#include "cursor.h"

#include <clangsupport/tokeninfocontainer.h>

#include <sqlite/utf8string.h>

#include <clang-c/Index.h>

namespace ClangBackEnd {

class Cursor;
class Token;

class TokenInfo
{
    friend bool operator==(const TokenInfo &first, const TokenInfo &second);
    template<class T> friend class TokenProcessor;
public:
    TokenInfo() = default;
    TokenInfo(const Cursor &cursor,
              const Token *token,
              std::vector<CXSourceRange> &m_currentOutputArgumentRanges);
    virtual ~TokenInfo() = default;

    virtual void evaluate();

    bool hasInvalidMainType() const;
    bool hasMainType(HighlightingType type) const;
    unsigned mixinSize() const;
    bool hasMixinType(HighlightingType type) const;
    bool hasMixinTypeAt(uint, HighlightingType type) const;
    bool hasOnlyType(HighlightingType type) const;
    bool hasFunctionArguments() const;

    virtual operator TokenInfoContainer() const;

    const HighlightingTypes &types() const
    {
        return m_types;
    }

    uint line () const
    {
        return m_line;
    }

    uint column() const
    {
        return m_column;
    }

    uint length() const
    {
        return m_length;
    }

protected:
    enum class Recursion {
        FirstPass,
        RecursivePass
    };

    virtual void identifierKind(const Cursor &cursor, Recursion recursion);
    virtual void referencedTypeKind(const Cursor &cursor);
    virtual void overloadedDeclRefKind(const Cursor &cursor);
    virtual void variableKind(const Cursor &cursor);
    virtual void fieldKind(const Cursor &cursor);
    virtual void functionKind(const Cursor &cursor, Recursion recursion);
    virtual void memberReferenceKind(const Cursor &cursor);
    virtual void typeKind(const Cursor &cursor);
    virtual void keywordKind();
    virtual void invalidFileKind();
    virtual void overloadedOperatorKind();
    virtual void punctuationOrOperatorKind();

    Cursor m_originalCursor;
    const Token *m_token;
    HighlightingTypes m_types;

private:
    bool isVirtualMethodDeclarationOrDefinition(const Cursor &cursor) const;
    bool isDefinition() const;
    bool isRealDynamicCall(const Cursor &cursor) const;
    void addExtraTypeIfFirstPass(HighlightingType type, Recursion recursion);
    bool isOutputArgument() const;
    void collectOutputArguments(const Cursor &cursor);
    void filterOutPreviousOutputArguments();
    bool isArgumentInCurrentOutputArgumentLocations() const;
    Cursor realCursor(const Cursor &cursor) const;

    std::vector<CXSourceRange> *m_currentOutputArgumentRanges = nullptr;
    uint m_line = 0;
    uint m_column = 0;
    uint m_length = 0;
    uint m_offset = 0;
};


inline bool operator==(const TokenInfo &first, const TokenInfo &second)
{
    return first.m_line == second.m_line
        && first.m_column == second.m_column
        && first.m_length == second.m_length
        && first.m_types == second.m_types;
}

} // namespace ClangBackEnd