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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
|
/***************************************************************************
*
* Copyright (C) 2005 Elad Lahav (elad_lahav@users.sourceforge.net)
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
***************************************************************************/
#ifndef SYMBOLCOMPLETION_H
#define SYMBOLCOMPLETION_H
#include <qobject.h>
#include <qregexp.h>
#include <ktexteditor/codecompletioninterface.h>
#include <ktexteditor/view.h>
#include "cscopefrontend.h"
/**
* This class executes symbol definition queries based on symbol prefixes.
* The results can then be displayed as symbol completion lists.
* @author Albert Yosher
*/
class SymbolCompletion : public QObject
{
Q_OBJECT
public:
/**
* A pure-virtual class that allows a SymbolCompletion object access to
* text-editing objects.
* Classes that wish to utilise SymbolCompletion need to inplement this
* interface.
* @author Albert Yosher
*/
struct Interface
{
/**
* Class destructor.
* NOTE: A virtual destructor is required by GCC 4.0
*/
virtual ~Interface() {}
/**
* Returns the word currently under the editing cursor.
* Symbol completion will be provided for this word only if the cursor
* is positioned at the end of this word.
* @param pPosInWord Set this value to the offset in the word on
* which the cursor is positioned
*/
virtual QString getWordUnderCursor(uint* pPosInWord) = 0;
/**
* Returns a target object for displaying the completion list.
* @return A pointer to an object implementing
* KTextEditor::CodeCompletionInterface, or NULL if the
* implementation does not support this interface.
*/
virtual QObject* getCCObject() = 0;
};
SymbolCompletion(SymbolCompletion::Interface*, QObject* pParent = 0,
const char* szName = 0);
~SymbolCompletion();
void abort();
static void initAutoCompletion(bool, uint, uint, uint);
public slots:
void slotComplete();
void slotAutoComplete();
private:
/**
* Symbol completion entry object, used in the completion list.
* Implements operators required for sorting the completion list.
* @author Albert Yosher
*/
class Entry : public KTextEditor::CompletionEntry
{
public:
/**
* Determines whether a given entry is smaller than this one.
* @param entry The entry to compare with
* @return true if the given entry is smaller, false otherwise
*/
bool operator < (const SymbolCompletion::Entry& entry) const {
return (text < entry.text);
}
/**
* Determines whether a given entry is equal to this one.
* @param entry The entry to compare with
* @return true if the given entry equals this one, false otherwise
*/
bool operator == (const SymbolCompletion::Entry& entry) const {
return (text == entry.text);
}
};
/**
* A sortable version of the value list used by CodeCompletionInterface.
* @author Albert Yosher
*/
class EntryList : public QValueList<Entry>
{
public:
/**
* Sorts completion list.
*/
void sort() { qHeapSort(*this); }
/**
* Type casting support required for calling showCompletionBox().
* @return A casted reference to this object
*/
operator QValueList<KTextEditor::CompletionEntry>()
{ return *(QValueList<KTextEditor::CompletionEntry>*)this; }
};
/** Editor object for which symbol completion is provided. */
Interface* m_pEditor;
/** An object that supports KTextEditor::CodeCompletionInterface, as
supplied by the editor. */
QObject* m_pCCObject;
/** Cscope process used to run completion queries. */
CscopeFrontend* m_pCscope;
/** The prefix used for the current query. */
QString m_sPrefix;
/** A list of possible completions for the given prefix. */
EntryList m_elEntries;
/** The maximal number of completions to accept. */
uint m_nMaxEntries;
/** Regular expression for extracting a symbol out of Cscope's text field.
NOTE: This member is required due to a bug in Cscope that renders the
symbol field useless. */
QRegExp m_reSymbol;
/** Auto-completion timer. */
QTimer* m_pAutoCompTimer;
/** Auto-completion flag */
bool m_bAutoCompletion;
void complete(const QString&, int nMaxEntries = 1000);
void filterEntries();
void makeErrMsg(const QString&);
/** true if auto-completion is enabled, false otherwise. */
static bool s_bACEnabled;
/** The minimum number of characters a symbol must have for
auto-completion. */
static uint s_nACMinChars;
/** The interval between the time slotAutoComplete() is called and the
time the completion process begins (in milliseconds). */
static uint s_nACDelay;
/** The maximal number of entries for auto-completion. */
static uint s_nACMaxEntries;
private slots:
void slotAutoCompleteTimeout();
void slotAddEntry(FrontendToken*);
void slotQueryFinished(uint);
void slotFilterInsert(KTextEditor::CompletionEntry*, QString*);
};
#endif
|
