File: codecompletionitemgrouper.h

package info (click to toggle)
kdevelop 4%3A5.6.2-4
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 57,892 kB
  • sloc: cpp: 278,773; javascript: 3,558; python: 3,385; sh: 1,317; ansic: 689; xml: 273; php: 95; makefile: 40; lisp: 13; sed: 12
file content (121 lines) | stat: -rw-r--r-- 4,314 bytes parent folder | download
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
/*
 * KDevelop Generic Code Completion Support
 *
 * Copyright 2006-2008 Hamish Rodda <rodda@kde.org>
 * Copyright 2007-2008 David Nolden <david.nolden.kdevelop@art-master.de>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Library General Public License as
 * published by the Free Software Foundation; either version 2 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public
 * License along with this program; if not, write to the
 * Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 */

#ifndef KDEVPLATFORM_CODECOMPLETIONITEMGROUPER_H
#define KDEVPLATFORM_CODECOMPLETIONITEMGROUPER_H

#include "codecompletionmodel.h"
#include "codecompletionitem.h"
#include <language/duchain/duchain.h>
#include <language/duchain/duchainlock.h>

namespace KDevelop {
///Always the last item of a grouping chain: Only inserts the items
struct CodeCompletionItemLastGrouper
{
    CodeCompletionItemLastGrouper(QList<QExplicitlySharedDataPointer<CompletionTreeElement>>& tree,
                                  CompletionTreeNode* parent, const QList<CompletionTreeItemPointer>& items)
    {
        tree.reserve(tree.size() + items.size());
        for (auto& item : items) {
            item->setParent(parent);
            tree << QExplicitlySharedDataPointer<CompletionTreeElement>(item.data());
        }
    }
};

///Helper class that helps us grouping the completion-list. A chain of groupers can be built, by using NextGrouper.
template <class KeyExtractor, class NextGrouper = CodeCompletionItemLastGrouper>
struct CodeCompletionItemGrouper
{
    using KeyType = typename KeyExtractor::KeyType;

    CodeCompletionItemGrouper(QList<QExplicitlySharedDataPointer<CompletionTreeElement>>& tree,
                              CompletionTreeNode* parent, const QList<CompletionTreeItemPointer>& items)
    {
        using GroupMap = QMap<KeyType, QList<CompletionTreeItemPointer>>;
        GroupMap groups;

        for (auto& item : items) {
            KeyType key = KeyExtractor::extract(item);
            typename GroupMap::iterator it = groups.find(key);
            if (it == groups.end())
                it = groups.insert(key, QList<CompletionTreeItemPointer>());

            (*it).append(item);
        }

        tree.reserve(tree.size() + groups.size());
        for (typename GroupMap::const_iterator it = groups.constBegin(); it != groups.constEnd(); ++it) {
            QExplicitlySharedDataPointer<CompletionTreeNode> node(new CompletionTreeNode());
            node->setParent(parent);
            node->role = ( KTextEditor::CodeCompletionModel::ExtraItemDataRoles )KeyExtractor::Role;
            node->roleValue = QVariant(it.key());

            tree << QExplicitlySharedDataPointer<CompletionTreeElement>(node.data());

            NextGrouper nextGrouper(node->children, node.data(), *it);
        }
    }
};

///Extracts the argument-hint depth from completion-items, to be used in ItemGrouper for grouping by argument-hint depth.
struct ArgumentHintDepthExtractor
{
    using KeyType = int;
    enum { Role = KTextEditor::CodeCompletionModel::ArgumentHintDepth };

    static KeyType extract(const CompletionTreeItemPointer& item)
    {
        return item->argumentHintDepth();
    }
};

struct InheritanceDepthExtractor
{
    using KeyType = int;

    enum { Role = KTextEditor::CodeCompletionModel::InheritanceDepth };

    static KeyType extract(const CompletionTreeItemPointer& item)
    {
        return item->inheritanceDepth();
    }
};

struct SimplifiedAttributesExtractor
{
    using KeyType = int;

    enum { Role = KTextEditor::CodeCompletionModel::CompletionRole };

    static const int groupingProperties;

    static KeyType extract(const CompletionTreeItemPointer& item)
    {
        DUChainReadLocker lock(DUChain::lock());
        return item->completionProperties() & groupingProperties;
    }
};
}

#endif // KDEVPLATFORM_CODECOMPLETIONITEMGROUPER_H