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
|
/* This file is part of KDevelop
Copyright 2006 Hamish Rodda <rodda@kde.org>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License version 2 as published by the Free Software Foundation.
This library 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
Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
#ifndef CPPEDITORINTEGRATOR_H
#define CPPEDITORINTEGRATOR_H
#include <language/editor/rangeinrevision.h>
#include "cppduchainexport.h"
#include "lexer.h"
class AST;
/**
* Provides facilities for easy integration of a text editor component with
* the information parsed from a source file.
*
* Uses a disguised singleton + stateful design.
*
* \todo introduce stacks for the state?
*/
class KDEVCPPDUCHAIN_EXPORT CppEditorIntegrator
{
public:
CppEditorIntegrator(ParseSession* session);
ParseSession* parseSession() const;
enum Edge {
FrontEdge,
BackEdge
};
enum RangeEdge {
InnerEdge,
OuterEdge
};
/**
* Finds the location and \a file where the given \a token was parsed from. This function
* does not change any of the CppEditorIntegrator's state.
*
* \param token token to locate
* \param edge set to FrontEdge to return the start position of the token, BackEdge to return the end position.
*
* \returns the requested cursor relating to the start or end of the given token.
*/
KDevelop::CursorInRevision findPosition(const Token& token, Edge edge = BackEdge) const;
/**
* Finds the location and \a file where the given \a token was parsed from.
* This function does not change any of the CppEditorIntegrator's state.
*
* \param token token to locate
* \param edge set to FrontEdge to return the start position of the token, BackEdge to return the end position.
*
* \returns the requested cursor relating to the start or end of the given token.
*/
KDevelop::CursorInRevision findPosition(std::size_t token, Edge edge = BackEdge) const;
/**
* Create a range encompassing the given AST \a node.
* This function does not change any of the CppEditorIntegrator's state.
*
* \overload
*/
KDevelop::RangeInRevision findRange(AST* node, RangeEdge = OuterEdge);
/**
* Create a range encompassing the given AST \a nodes.
* This function does not change any of the CppEditorIntegrator's state.
*
* \overload
*/
KDevelop::RangeInRevision findRange(AST* from, AST* to);
/**
* Create a range encompassing the given AST \a token.
* This function does not change any of the CppEditorIntegrator's state.
*
* \overload
*/
KDevelop::RangeInRevision findRange(const Token& token);
/**
* Create a range encompassing the given AST \a token.
* This function does not change any of the CppEditorIntegrator's state.
*
* \overload
*/
KDevelop::RangeInRevision findRange(std::size_t token);
/**
* Create a range encompassing the given AST \a tokens.
* This function does not change any of the CppEditorIntegrator's state.
*
* \overload
*/
KDevelop::RangeInRevision findRange(std::size_t start_token, std::size_t end_token);
/**
* Create a range encompassing the given range \a tokens.
*
* The difference to the common functions, this one checks whether the given range has been expanded within
* one macro-expansion, and if it has, returns a collapsed range at the position from where the expansion was started.
* \overload
*/
KDevelop::RangeInRevision findRangeForContext(std::size_t start_token, std::size_t end_token);
/**
* Retrieve the string represented by a token.
*/
QString tokenToString(std::size_t token) const;
/**
* Retrieve the string represented by a range of tokens.
*/
QString tokensToStrings(std::size_t start, std::size_t end) const;
/**
* Retrieve the string represented by a token in utf8.
*/
QByteArray tokenToByteArray(std::size_t token) const;
/**
* Retrieve the string represented by a range of tokens in utf8.
*/
QByteArray tokensToByteArray(std::size_t start, std::size_t end) const;
private:
ParseSession* m_session;
};
#endif // EDITORINTEGRATOR_H
|
