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
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
|
/* This file is part of the KDE libraries
Copyright (C) 2005 Christoph Cullmann <[email protected]>
Copyright (C) 2005 Joseph Wenninger <[email protected]>
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 __kate_jscript_h__
#define __kate_jscript_h__
#include "../interfaces/document.h"
#include "kateindentscriptabstracts.h"
#include <qdict.h>
#include <kdebug.h>
/**
* Some common stuff
*/
class KateDocument;
class KateView;
class QString;
class KateJSDocument;
class KateJSView;
class KateJSIndenter;
class KateDocCursor;
/**
* Cool, this is all we need here
*/
namespace KJS {
class Object;
class ObjectImp;
class Interpreter;
class ExecState;
}
/**
* Whole Kate Part scripting in one classs
* Allow subclassing to allow specialized scripting engine for indenters
*/
class KateJScript
{
public:
/**
* generate new global interpreter for part scripting
*/
KateJScript ();
/**
* be destructive
*/
virtual ~KateJScript ();
/**
* creates a JS wrapper object for given KateDocument
* @param exec execution state, to find out interpreter to use
* @param doc document object to wrap
* @return new js wrapper object
*/
KJS::ObjectImp *wrapDocument (KJS::ExecState *exec, KateDocument *doc);
/**
* creates a JS wrapper object for given KateView
* @param exec execution state, to find out interpreter to use
* @param view view object to wrap
* @return new js wrapper object
*/
KJS::ObjectImp *wrapView (KJS::ExecState *exec, KateView *view);
/**
* execute given script
* the script will get the doc and view exposed via document and view object
* in global scope
* @param view view to expose
* @param script source code of script to execute
* @param errorMsg error to return if no success
* @return success or not?
*/
bool execute (KateView *view, const QString &script, QString &errorMsg);
protected:
/**
* global object of interpreter
*/
KJS::Object *m_global;
/**
* js interpreter
*/
KJS::Interpreter *m_interpreter;
/**
* object for document
*/
KJS::Object *m_document;
/**
* object for view
*/
KJS::Object *m_view;
};
class KateJScriptManager : public Kate::Command
{
private:
/**
* Internal used Script Representation
*/
class Script
{
public:
/**
* get desktop filename
* @return desktop filename
*/
inline QString desktopFilename () { return filename.left(filename.length()-2).append ("desktop"); }
public:
/**
* command name, as used for command line and more
*/
QString name;
/**
* filename of the script
*/
QString filename;
/**
* has it a desktop file?
*/
bool desktopFileExists;
};
public:
KateJScriptManager ();
~KateJScriptManager ();
private:
/**
* go, search our scripts
* @param force force cache updating?
*/
void collectScripts (bool force = false);
//
// Here we deal with the Kate::Command stuff
//
public:
/**
* execute command
* @param view view to use for execution
* @param cmd cmd string
* @param errorMsg error to return if no success
* @return success
*/
bool exec( class Kate::View *view, const QString &cmd, QString &errorMsg );
/**
* get help for a command
* @param view view to use
* @param cmd cmd name
* @param msg help message
* @return help available or not
*/
bool help( class Kate::View *view, const QString &cmd, QString &msg );
/**
* supported commands as prefixes
* @return prefix list
*/
QStringList cmds();
private:
/**
* we need to know somewhere which scripts are around
*/
QDict<KateJScriptManager::Script> m_scripts;
};
class KateIndentJScriptImpl: public KateIndentScriptImplAbstract {
public:
KateIndentJScriptImpl(const QString& internalName,
const QString &filePath, const QString &niceName,
const QString ©right, double version);
~KateIndentJScriptImpl();
virtual bool processChar( class Kate::View *view, QChar c, QString &errorMsg );
virtual bool processLine( class Kate::View *view, const KateDocCursor &line, QString &errorMsg );
virtual bool processNewline( class Kate::View *view, const KateDocCursor &begin, bool needcontinue, QString &errorMsg );
protected:
virtual void decRef();
private:
KateJSView *m_viewWrapper;
KateJSDocument *m_docWrapper;
KJS::Object *m_indenter;
KJS::Interpreter *m_interpreter;
bool setupInterpreter(QString &errorMsg);
void deleteInterpreter();
};
class KateIndentJScriptManager: public KateIndentScriptManagerAbstract
{
public:
KateIndentJScriptManager ();
virtual ~KateIndentJScriptManager ();
virtual KateIndentScript script(const QString &scriptname);
private:
/**
* go, search our scripts
* @param force force cache updating?
*/
void collectScripts (bool force = false);
void parseScriptHeader(const QString &filePath,
QString *niceName,QString *copyright,double *version);
QDict<KateIndentJScriptImpl> m_scripts;
};
#endif
// kate: space-indent on; indent-width 2; replace-tabs on;
|
