summaryrefslogtreecommitdiffstats
path: root/src/declarative/qml/rewriter/rewriter_p.h
blob: ed9be1662d9b2ad7d6a4c3166e02b23449973066 (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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
/****************************************************************************
**
** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** This file is part of the QtDeclarative module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** No Commercial Usage
** This file contains pre-release code and may not be distributed.
** You may use this file in accordance with the terms and conditions
** contained in the Technology Preview License Agreement accompanying
** this package.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights.  These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
**
**
**
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/

#ifndef REWRITER_H
#define REWRITER_H

#include <QtCore/QList>
#include <QtCore/QString>

#include "textwriter_p.h"
#include "qmljsastvisitor_p.h"

QT_BEGIN_HEADER
QT_QML_BEGIN_NAMESPACE

namespace QmlJS {

////////////////////////////////////////////////////////////////////////////////
// Replacement
////////////////////////////////////////////////////////////////////////////////
class Replacement
{
	int _offset;
	int _length;
	QString _text;

public:
	Replacement(int offset = 0, int length = 0, const QString &text = QString())
		: _offset(offset), _length(length), _text(text)
	{ }

	bool isNull() const { return _offset == _length; }
	operator bool() const { return ! isNull(); }

	int offset() const { return _offset; }
	int length() const { return _length; }
	QString text() const { return _text; }
};



////////////////////////////////////////////////////////////////////////////////
// Rewriter
////////////////////////////////////////////////////////////////////////////////
class Rewriter: public AST::Visitor
{
protected:
	TextWriter textWriter;
public:
	//
	// Token based API
	//

	/// Returns the text of the token at the given \a location.
	QString textAt(const AST::SourceLocation &location) const;

	QString textAt(const AST::SourceLocation &firstLoc,
				   const AST::SourceLocation &lastLoc) const;

	/// Replace the token at \a loc with the given \a text.
	void replace(const AST::SourceLocation &loc, const QString &text);

	/// Remove the token at the given \a location.
	void remove(const AST::SourceLocation &location);

	/// Remove all tokens in the range [\a firstLoc, \a lastLoc].
	void remove(const AST::SourceLocation &firstLoc, const AST::SourceLocation &lastLoc);

	/// Insert \a text before the token at the given \a location.
	void insertTextBefore(const AST::SourceLocation &location, const QString &text);

	/// Insert \a text after the token at the given \a location.
	void insertTextAfter(const AST::SourceLocation &loc, const QString &text);

	void moveTextBefore(const AST::SourceLocation &firstLoc,
						const AST::SourceLocation &lastLoc,
						const AST::SourceLocation &loc);

	void moveTextAfter(const AST::SourceLocation &firstLoc,
					   const AST::SourceLocation &lastLoc,
					   const AST::SourceLocation &loc);

	//
	// low-level offset based API
	//
    virtual void replace(int offset, int length, const QString &text);
    virtual void move(int pos, int length, int to);
	void insertText(int offset, const QString &text);
	void removeText(int offset, int length);

	/// Visit the given \a node.
	void accept(AST::Node *node);

	/// Returns the original unchanged source code.
	QString code() const { return _code; }

	/// Returns the list of replacements.
	QList<Replacement> replacementList() const { return _replacementList; }

protected:
	/// \internal
	void setCode(const QString &code) { _code = code; }

private:
	QString _code;
	QList<Replacement> _replacementList;
};

} // end of namespace QmlJS

QT_QML_END_NAMESPACE
QT_END_HEADER

#endif // REWRITER_H