Differential D6914 Diff 17224 src/script/katescriptdocument.h

Changeset View

Standalone View

View Options

src/script/katescriptdocument.h

Context not available.
22 22​
23#include <QObject> 23​#include <QObject>
24#include <QStringList> 24​#include <QStringList>
25#include <QScriptable> ​
26 25​
27#include <ktexteditor_export.h> 26​#include <ktexteditor_export.h>
28 27​
29#include <QScriptValue> 28​#include <QtQml/QJSValue>
30 29​
31#include <ktexteditor/cursor.h> 30​#include <ktexteditor/cursor.h>
32#include <ktexteditor/range.h> 31​#include <ktexteditor/range.h>
Context not available.
37 * Thinish wrapping around KTextEditor::DocumentPrivate, exposing the methods we want exposed 36​ * Thinish wrapping around KTextEditor::DocumentPrivate, exposing the methods we want exposed
38 * and adding some helper methods. 37​ * and adding some helper methods.
39 * 38​ *
40 * We inherit from QScriptable to have more thight access to the scripting ​
41 * engine. ​
42 * ​
43 * setDocument _must_ be called before using any other method. This is not checked 39​ * setDocument _must_ be called before using any other method. This is not checked
44 * for the sake of speed. 40​ * for the sake of speed.
45 */ 41​ */
46class KTEXTEDITOR_EXPORT KateScriptDocument : public QObject, protected QScriptable 42​class KTEXTEDITOR_EXPORT KateScriptDocument : public QObject
47{ 43​{
48 Q_OBJECT 44​ Q_OBJECT
49 // Note: we have no Q_PROPERTIES due to consistency: everything is a function. 45​ // Note: we have no Q_PROPERTIES due to consistency: everything is a function.
50 46​
51public: 47​public:
52 KateScriptDocument(QObject *parent = nullptr); 48​ KateScriptDocument(QJSEngine *, QObject *parent = nullptr);
53 void setDocument(KTextEditor::DocumentPrivate *document); 49​ void setDocument(KTextEditor::DocumentPrivate *document);
54 KTextEditor::DocumentPrivate *document(); 50​ KTextEditor::DocumentPrivate *document();
55 51​
Context not available.
60 Q_INVOKABLE QString encoding(); 56​ Q_INVOKABLE QString encoding();
61 Q_INVOKABLE QString highlightingMode(); 57​ Q_INVOKABLE QString highlightingMode();
62 Q_INVOKABLE QStringList embeddedHighlightingModes(); 58​ Q_INVOKABLE QStringList embeddedHighlightingModes();
63 Q_INVOKABLE QString highlightingModeAt(const KTextEditor::Cursor &pos); 59​ Q_INVOKABLE QString highlightingModeAt(const QJSValue &pos);
64 Q_INVOKABLE bool isModified(); 60​ Q_INVOKABLE bool isModified();
65 Q_INVOKABLE QString text(); 61​ Q_INVOKABLE QString text();
66 Q_INVOKABLE QString text(int fromLine, int fromColumn, int toLine, int toColumn); 62​ Q_INVOKABLE QString text(int fromLine, int fromColumn, int toLine, int toColumn);
67 Q_INVOKABLE QString text(const KTextEditor::Cursor &from, const KTextEditor::Cursor &to); 63​ Q_INVOKABLE QString text(const KTextEditor::Cursor &from, const KTextEditor::Cursor &to);
68 Q_INVOKABLE QString text(const KTextEditor::Range &range); 64​ Q_INVOKABLE QString text(const KTextEditor::Range &range);
65​ Q_INVOKABLE QString text(const QJSValue &jsrange);
dhaumannUnsubmitted
Not Done

If I understand correctly, you are adding an overload for all functions that have KTextEditor::Cursor or Range in the parameter.
Does that imply we could remove the Q_INVOKABLE part of the overloads that use the complex types such as Cursor and Range?

If so, I would be in favor of doing this, just to make this explicit.

dhaumann: If I understand correctly, you are adding an overload for all functions that have KTextEditor…
69 Q_INVOKABLE QString line(int line); 66​ Q_INVOKABLE QString line(int line);
70 Q_INVOKABLE QString wordAt(int line, int column); 67​ Q_INVOKABLE QString wordAt(int line, int column);
71 Q_INVOKABLE QString wordAt(const KTextEditor::Cursor &cursor); 68​ Q_INVOKABLE QString wordAt(const KTextEditor::Cursor &cursor);
72 Q_INVOKABLE KTextEditor::Range wordRangeAt(int line, int column); 69​ Q_INVOKABLE QJSValue wordRangeAt(int line, int column);
73 Q_INVOKABLE KTextEditor::Range wordRangeAt(const KTextEditor::Cursor &cursor); 70​ Q_INVOKABLE QJSValue wordRangeAt(const KTextEditor::Cursor &cursor);
74 Q_INVOKABLE QString charAt(int line, int column); 71​ Q_INVOKABLE QString charAt(int line, int column);
75 Q_INVOKABLE QString charAt(const KTextEditor::Cursor &cursor); 72​ Q_INVOKABLE QString charAt(const KTextEditor::Cursor &cursor);
73​ Q_INVOKABLE QString charAt(const QJSValue &cursor);
76 Q_INVOKABLE QString firstChar(int line); 74​ Q_INVOKABLE QString firstChar(int line);
77 Q_INVOKABLE QString lastChar(int line); 75​ Q_INVOKABLE QString lastChar(int line);
78 Q_INVOKABLE bool isSpace(int line, int column); 76​ Q_INVOKABLE bool isSpace(int line, int column);
79 Q_INVOKABLE bool isSpace(const KTextEditor::Cursor &cursor); 77​ Q_INVOKABLE bool isSpace(const KTextEditor::Cursor &cursor);
78​ Q_INVOKABLE bool isSpace(const QJSValue &jscursor);
80 Q_INVOKABLE bool matchesAt(int line, int column, const QString &s); 79​ Q_INVOKABLE bool matchesAt(int line, int column, const QString &s);
81 Q_INVOKABLE bool matchesAt(const KTextEditor::Cursor &cursor, const QString &s); 80​ Q_INVOKABLE bool matchesAt(const KTextEditor::Cursor &cursor, const QString &s);
81​ Q_INVOKABLE bool matchesAt(const QJSValue &cursor, const QString &s);
82 Q_INVOKABLE bool setText(const QString &s); 82​ Q_INVOKABLE bool setText(const QString &s);
83 Q_INVOKABLE bool clear(); 83​ Q_INVOKABLE bool clear();
84 Q_INVOKABLE bool truncate(int line, int column); 84​ Q_INVOKABLE bool truncate(int line, int column);
85 Q_INVOKABLE bool truncate(const KTextEditor::Cursor &cursor); 85​ Q_INVOKABLE bool truncate(const KTextEditor::Cursor &cursor);
86 Q_INVOKABLE bool insertText(int line, int column, const QString &s); 86​ Q_INVOKABLE bool insertText(int line, int column, const QString &s);
87 Q_INVOKABLE bool insertText(const KTextEditor::Cursor &cursor, const QString &s); 87​ Q_INVOKABLE bool insertText(const KTextEditor::Cursor &cursor, const QString &s);
88​ Q_INVOKABLE bool insertText(const QJSValue &jscursor, const QString &s);
88 Q_INVOKABLE bool removeText(int fromLine, int fromColumn, int toLine, int toColumn); 89​ Q_INVOKABLE bool removeText(int fromLine, int fromColumn, int toLine, int toColumn);
89 Q_INVOKABLE bool removeText(const KTextEditor::Cursor &from, const KTextEditor::Cursor &to); 90​ Q_INVOKABLE bool removeText(const KTextEditor::Cursor &from, const KTextEditor::Cursor &to);
90 Q_INVOKABLE bool removeText(const KTextEditor::Range &range); 91​ Q_INVOKABLE bool removeText(const KTextEditor::Range &range);
92​ Q_INVOKABLE bool removeText(const QJSValue &range);
91 Q_INVOKABLE bool insertLine(int line, const QString &s); 93​ Q_INVOKABLE bool insertLine(int line, const QString &s);
92 Q_INVOKABLE bool removeLine(int line); 94​ Q_INVOKABLE bool removeLine(int line);
93 Q_INVOKABLE bool wrapLine(int line, int column); 95​ Q_INVOKABLE bool wrapLine(int line, int column);
94 Q_INVOKABLE bool wrapLine(const KTextEditor::Cursor &cursor); 96​ Q_INVOKABLE bool wrapLine(const KTextEditor::Cursor &cursor);
97​ Q_INVOKABLE bool wrapLine(const QJSValue &cursor);
95 Q_INVOKABLE void joinLines(int startLine, int endLine); 98​ Q_INVOKABLE void joinLines(int startLine, int endLine);
96 Q_INVOKABLE int lines(); 99​ Q_INVOKABLE int lines();
97 Q_INVOKABLE bool isLineModified(int line); 100​ Q_INVOKABLE bool isLineModified(int line);
Context not available.
117 Q_INVOKABLE QString commentStart(int attribute); 120​ Q_INVOKABLE QString commentStart(int attribute);
118 Q_INVOKABLE QString commentEnd(int attribute); 121​ Q_INVOKABLE QString commentEnd(int attribute);
119 122​
120 Q_INVOKABLE KTextEditor::Range documentRange(); 123​ Q_INVOKABLE QJSValue documentRange();
121 Q_INVOKABLE KTextEditor::Cursor documentEnd(); 124​ Q_INVOKABLE QJSValue documentEnd();
122 Q_INVOKABLE bool isValidTextPosition(int line, int column); 125​ Q_INVOKABLE bool isValidTextPosition(int line, int column);
123 Q_INVOKABLE bool isValidTextPosition(const KTextEditor::Cursor& cursor); 126​ Q_INVOKABLE bool isValidTextPosition(const KTextEditor::Cursor& cursor);
124 127​
Context not available.
139 */ 142​ */
140 Q_INVOKABLE QString attributeName(int line, int column); 143​ Q_INVOKABLE QString attributeName(int line, int column);
141 Q_INVOKABLE QString attributeName(const KTextEditor::Cursor &cursor); 144​ Q_INVOKABLE QString attributeName(const KTextEditor::Cursor &cursor);
145​ Q_INVOKABLE QString attributeName(const QJSValue &jscursor);
142 146​
143 /** 147​ /**
144 * Return true is the name of the syntax attribute equals @p name. 148​ * Return true is the name of the syntax attribute equals @p name.
145 */ 149​ */
146 Q_INVOKABLE bool isAttributeName(int line, int column, const QString &name); 150​ Q_INVOKABLE bool isAttributeName(int line, int column, const QString &name);
147 Q_INVOKABLE bool isAttributeName(const KTextEditor::Cursor &cursor, const QString &name); 151​ Q_INVOKABLE bool isAttributeName(const KTextEditor::Cursor &cursor, const QString &name);
152​ Q_INVOKABLE bool isAttributeName(const QJSValue &cursor, const QString &name);
148 153​
149 Q_INVOKABLE QString variable(const QString &s); 154​ Q_INVOKABLE QString variable(const QString &s);
150 Q_INVOKABLE void setVariable(const QString &s, const QString &v); 155​ Q_INVOKABLE void setVariable(const QString &s, const QString &v);
Context not available.
154 Q_INVOKABLE int lastVirtualColumn(int line); 159​ Q_INVOKABLE int lastVirtualColumn(int line);
155 Q_INVOKABLE int toVirtualColumn(int line, int column); 160​ Q_INVOKABLE int toVirtualColumn(int line, int column);
156 Q_INVOKABLE int toVirtualColumn(const KTextEditor::Cursor &cursor); 161​ Q_INVOKABLE int toVirtualColumn(const KTextEditor::Cursor &cursor);
162​ Q_INVOKABLE int toVirtualColumn(const QJSValue &cursor);
157 Q_INVOKABLE KTextEditor::Cursor toVirtualCursor(const KTextEditor::Cursor &cursor); 163​ Q_INVOKABLE KTextEditor::Cursor toVirtualCursor(const KTextEditor::Cursor &cursor);
158 Q_INVOKABLE int fromVirtualColumn(int line, int virtualColumn); 164​ Q_INVOKABLE int fromVirtualColumn(int line, int virtualColumn);
159 Q_INVOKABLE int fromVirtualColumn(const KTextEditor::Cursor &virtualCursor); 165​ Q_INVOKABLE int fromVirtualColumn(const KTextEditor::Cursor &virtualCursor);
160 Q_INVOKABLE KTextEditor::Cursor fromVirtualCursor(const KTextEditor::Cursor &virtualCursor); 166​ Q_INVOKABLE KTextEditor::Cursor fromVirtualCursor(const KTextEditor::Cursor &virtualCursor);
161 167​
162 Q_INVOKABLE KTextEditor::Cursor anchor(int line, int column, QChar character); 168​ KTextEditor::Cursor anchorInternal(int line, int column, QChar character);
163 Q_INVOKABLE KTextEditor::Cursor anchor(const KTextEditor::Cursor &cursor, QChar character); 169​ Q_INVOKABLE KTextEditor::Cursor anchor(const KTextEditor::Cursor &cursor, QChar character);
164 Q_INVOKABLE KTextEditor::Cursor rfind(int line, int column, const QString &text, int attribute = -1); 170​ Q_INVOKABLE QJSValue anchor(int line, int column, QChar character);
171​ Q_INVOKABLE QJSValue anchor(const QJSValue &cursor, QChar character);
172​ KTextEditor::Cursor rfindInternal(int line, int column, const QString &text, int attribute = -1);
165 Q_INVOKABLE KTextEditor::Cursor rfind(const KTextEditor::Cursor &cursor, const QString &text, int attribute = -1); 173​ Q_INVOKABLE KTextEditor::Cursor rfind(const KTextEditor::Cursor &cursor, const QString &text, int attribute = -1);
174​ Q_INVOKABLE QJSValue rfind(int line, int column, const QString &text, int attribute = -1);
175​ Q_INVOKABLE QJSValue rfind(const QJSValue &cursor, const QString &text, int attribute = -1);
166 176​
167 Q_INVOKABLE int defStyleNum(int line, int column); 177​ Q_INVOKABLE int defStyleNum(int line, int column);
168 Q_INVOKABLE int defStyleNum(const KTextEditor::Cursor &cursor); 178​ Q_INVOKABLE int defStyleNum(const KTextEditor::Cursor &cursor);
169 Q_INVOKABLE bool isCode(int line, int column); 179​ Q_INVOKABLE bool isCode(int line, int column);
170 Q_INVOKABLE bool isCode(const KTextEditor::Cursor &cursor); 180​ Q_INVOKABLE bool isCode(const KTextEditor::Cursor &cursor);
181​ Q_INVOKABLE bool isCode(const QJSValue &cursor);
171 Q_INVOKABLE bool isComment(int line, int column); 182​ Q_INVOKABLE bool isComment(int line, int column);
172 Q_INVOKABLE bool isComment(const KTextEditor::Cursor &cursor); 183​ Q_INVOKABLE bool isComment(const KTextEditor::Cursor &cursor);
184​ Q_INVOKABLE bool isComment(const QJSValue &cursor);
173 Q_INVOKABLE bool isString(int line, int column); 185​ Q_INVOKABLE bool isString(int line, int column);
174 Q_INVOKABLE bool isString(const KTextEditor::Cursor &cursor); 186​ Q_INVOKABLE bool isString(const KTextEditor::Cursor &cursor);
187​ Q_INVOKABLE bool isString(const QJSValue &cursor);
175 Q_INVOKABLE bool isRegionMarker(int line, int column); 188​ Q_INVOKABLE bool isRegionMarker(int line, int column);
176 Q_INVOKABLE bool isRegionMarker(const KTextEditor::Cursor &cursor); 189​ Q_INVOKABLE bool isRegionMarker(const KTextEditor::Cursor &cursor);
190​ Q_INVOKABLE bool isRegionMarker(const QJSValue &cursor);
177 Q_INVOKABLE bool isChar(int line, int column); 191​ Q_INVOKABLE bool isChar(int line, int column);
178 Q_INVOKABLE bool isChar(const KTextEditor::Cursor &cursor); 192​ Q_INVOKABLE bool isChar(const KTextEditor::Cursor &cursor);
193​ Q_INVOKABLE bool isChar(const QJSValue &cursor);
179 Q_INVOKABLE bool isOthers(int line, int column); 194​ Q_INVOKABLE bool isOthers(int line, int column);
180 Q_INVOKABLE bool isOthers(const KTextEditor::Cursor &cursor); 195​ Q_INVOKABLE bool isOthers(const KTextEditor::Cursor &cursor);
196​ Q_INVOKABLE bool isOthers(const QJSValue &cursor);
181 197​
182 Q_INVOKABLE bool startsWith(int line, const QString &pattern, bool skipWhiteSpaces); 198​ Q_INVOKABLE bool startsWith(int line, const QString &pattern, bool skipWhiteSpaces);
183 Q_INVOKABLE bool endsWith(int line, const QString &pattern, bool skipWhiteSpaces); 199​ Q_INVOKABLE bool endsWith(int line, const QString &pattern, bool skipWhiteSpaces);
184 200​
185 Q_INVOKABLE void indent(KTextEditor::Range range, int change); 201​ Q_INVOKABLE void indent(KTextEditor::Range range, int change);
202​ Q_INVOKABLE void indent(const QJSValue &jsrange, int change);
186 203​
187private: 204​private:
188 bool _isCode(int defaultStyle); 205​ bool _isCode(int defaultStyle);
189 206​
190 KTextEditor::DocumentPrivate *m_document; 207​ KTextEditor::DocumentPrivate *m_document;
208​ QJSEngine *m_engine;
191}; 209​};
192 210​
193#endif 211​#endif
Context not available.