forked from Taritsyn/JavaScriptEngineSwitcher
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathIJsEngine.cs
More file actions
413 lines (381 loc) · 15.5 KB
/
IJsEngine.cs
File metadata and controls
413 lines (381 loc) · 15.5 KB
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
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
using System;
using System.IO;
using System.Text;
using System.Reflection;
namespace JavaScriptEngineSwitcher.Core
{
/// <summary>
/// Defines a interface of JS engine
/// </summary>
public interface IJsEngine : IDisposable
{
/// <summary>
/// Gets a name of JS engine
/// </summary>
string Name
{
get;
}
/// <summary>
/// Gets a version of original JS engine
/// </summary>
string Version
{
get;
}
/// <summary>
/// Gets a value that indicates if the JS engine supports script pre-compilation
/// </summary>
bool SupportsScriptPrecompilation
{
get;
}
/// <summary>
/// Gets a value that indicates if the JS engine supports script interruption
/// </summary>
bool SupportsScriptInterruption
{
get;
}
/// <summary>
/// Gets a value that indicates if the JS engine supports garbage collection
/// </summary>
bool SupportsGarbageCollection
{
get;
}
/// <summary>
/// Creates a pre-compiled script from JS code
/// </summary>
/// <param name="code">JS code</param>
/// <returns>A pre-compiled script that can be executed by different instances of JS engine</returns>
/// <exception cref="ObjectDisposedException"/>
/// <exception cref="ArgumentNullException"/>
/// <exception cref="ArgumentException"/>
/// <exception cref="JsCompilationException"/>
/// <exception cref="JsException"/>
IPrecompiledScript Precompile(string code);
/// <summary>
/// Creates a pre-compiled script from JS code
/// </summary>
/// <param name="code">JS code</param>
/// <param name="documentName">Document name</param>
/// <returns>A pre-compiled script that can be executed by different instances of JS engine</returns>
/// <exception cref="ObjectDisposedException"/>
/// <exception cref="ArgumentNullException"/>
/// <exception cref="ArgumentException"/>
/// <exception cref="JsCompilationException"/>
/// <exception cref="JsException"/>
IPrecompiledScript Precompile(string code, string documentName);
/// <summary>
/// Creates a pre-compiled script from JS file
/// </summary>
/// <param name="path">Path to the JS file</param>
/// <param name="encoding">Text encoding</param>
/// <returns>A pre-compiled script that can be executed by different instances of JS engine</returns>
/// <exception cref="ObjectDisposedException"/>
/// <exception cref="ArgumentNullException"/>
/// <exception cref="ArgumentException"/>
/// <exception cref="FileNotFoundException"/>
/// <exception cref="JsUsageException"/>
/// <exception cref="JsCompilationException"/>
/// <exception cref="JsException"/>
IPrecompiledScript PrecompileFile(string path, Encoding encoding = null);
/// <summary>
/// Creates a pre-compiled script from embedded JS resource
/// </summary>
/// <param name="resourceName">The case-sensitive resource name without the namespace of the specified type</param>
/// <param name="type">The type, that determines the assembly and whose namespace is used to scope
/// the resource name</param>
/// <returns>A pre-compiled script that can be executed by different instances of JS engine</returns>
/// <exception cref="ObjectDisposedException"/>
/// <exception cref="ArgumentNullException"/>
/// <exception cref="ArgumentException"/>
/// <exception cref="NullReferenceException"/>
/// <exception cref="JsUsageException"/>
/// <exception cref="JsCompilationException"/>
/// <exception cref="JsException"/>
IPrecompiledScript PrecompileResource(string resourceName, Type type);
/// <summary>
/// Creates a pre-compiled script from embedded JS resource
/// </summary>
/// <param name="resourceName">The case-sensitive resource name</param>
/// <param name="assembly">The assembly, which contains the embedded resource</param>
/// <returns>A pre-compiled script that can be executed by different instances of JS engine</returns>
/// <exception cref="ObjectDisposedException"/>
/// <exception cref="ArgumentNullException"/>
/// <exception cref="ArgumentException"/>
/// <exception cref="NullReferenceException"/>
/// <exception cref="JsUsageException"/>
/// <exception cref="JsCompilationException"/>
/// <exception cref="JsException"/>
IPrecompiledScript PrecompileResource(string resourceName, Assembly assembly);
/// <summary>
/// Evaluates an expression
/// </summary>
/// <param name="expression">JS expression</param>
/// <returns>Result of the expression</returns>
/// <exception cref="ObjectDisposedException"/>
/// <exception cref="ArgumentNullException"/>
/// <exception cref="ArgumentException"/>
/// <exception cref="JsCompilationException"/>
/// <exception cref="JsTimeoutException"/>
/// <exception cref="JsInterruptedException"/>
/// <exception cref="JsRuntimeException"/>
/// <exception cref="JsException"/>
object Evaluate(string expression);
/// <summary>
/// Evaluates an expression
/// </summary>
/// <param name="expression">JS expression</param>
/// <param name="documentName">Document name</param>
/// <returns>Result of the expression</returns>
/// <exception cref="ObjectDisposedException"/>
/// <exception cref="ArgumentNullException"/>
/// <exception cref="ArgumentException"/>
/// <exception cref="JsCompilationException"/>
/// <exception cref="JsTimeoutException"/>
/// <exception cref="JsInterruptedException"/>
/// <exception cref="JsRuntimeException"/>
/// <exception cref="JsException"/>
object Evaluate(string expression, string documentName);
/// <summary>
/// Evaluates an expression
/// </summary>
/// <typeparam name="T">Type of result</typeparam>
/// <param name="expression">JS expression</param>
/// <returns>Result of the expression</returns>
/// <exception cref="ObjectDisposedException"/>
/// <exception cref="ArgumentNullException"/>
/// <exception cref="ArgumentException"/>
/// <exception cref="JsCompilationException"/>
/// <exception cref="JsTimeoutException"/>
/// <exception cref="JsInterruptedException"/>
/// <exception cref="JsRuntimeException"/>
/// <exception cref="JsException"/>
T Evaluate<T>(string expression);
/// <summary>
/// Evaluates an expression
/// </summary>
/// <typeparam name="T">Type of result</typeparam>
/// <param name="expression">JS expression</param>
/// <param name="documentName">Document name</param>
/// <returns>Result of the expression</returns>
/// <exception cref="ObjectDisposedException"/>
/// <exception cref="ArgumentNullException"/>
/// <exception cref="ArgumentException"/>
/// <exception cref="JsCompilationException"/>
/// <exception cref="JsTimeoutException"/>
/// <exception cref="JsInterruptedException"/>
/// <exception cref="JsRuntimeException"/>
/// <exception cref="JsException"/>
T Evaluate<T>(string expression, string documentName);
/// <summary>
/// Executes a code
/// </summary>
/// <param name="code">JS code</param>
/// <exception cref="ObjectDisposedException"/>
/// <exception cref="ArgumentNullException"/>
/// <exception cref="ArgumentException"/>
/// <exception cref="JsCompilationException"/>
/// <exception cref="JsTimeoutException"/>
/// <exception cref="JsInterruptedException"/>
/// <exception cref="JsRuntimeException"/>
/// <exception cref="JsException"/>
void Execute(string code);
/// <summary>
/// Executes a code
/// </summary>
/// <param name="code">JS code</param>
/// <param name="documentName">Document name</param>
/// <exception cref="ObjectDisposedException"/>
/// <exception cref="ArgumentNullException"/>
/// <exception cref="ArgumentException"/>
/// <exception cref="JsCompilationException"/>
/// <exception cref="JsTimeoutException"/>
/// <exception cref="JsInterruptedException"/>
/// <exception cref="JsRuntimeException"/>
/// <exception cref="JsException"/>
void Execute(string code, string documentName);
/// <summary>
/// Executes a pre-compiled script
/// </summary>
/// <param name="precompiledScript">A pre-compiled script that can be executed by different
/// instances of JS engine</param>
/// <exception cref="ObjectDisposedException"/>
/// <exception cref="ArgumentNullException"/>
/// <exception cref="ArgumentException"/>
/// <exception cref="JsUsageException"/>
/// <exception cref="JsTimeoutException"/>
/// <exception cref="JsInterruptedException"/>
/// <exception cref="JsRuntimeException"/>
/// <exception cref="JsException"/>
void Execute(IPrecompiledScript precompiledScript);
/// <summary>
/// Executes a code from JS file
/// </summary>
/// <param name="path">Path to the JS file</param>
/// <param name="encoding">Text encoding</param>
/// <exception cref="ObjectDisposedException"/>
/// <exception cref="ArgumentNullException"/>
/// <exception cref="ArgumentException"/>
/// <exception cref="FileNotFoundException"/>
/// <exception cref="JsUsageException"/>
/// <exception cref="JsCompilationException"/>
/// <exception cref="JsTimeoutException"/>
/// <exception cref="JsInterruptedException"/>
/// <exception cref="JsRuntimeException"/>
/// <exception cref="JsException"/>
void ExecuteFile(string path, Encoding encoding = null);
/// <summary>
/// Executes a code from embedded JS resource
/// </summary>
/// <param name="resourceName">The case-sensitive resource name without the namespace of the specified type</param>
/// <param name="type">The type, that determines the assembly and whose namespace is used to scope
/// the resource name</param>
/// <exception cref="ObjectDisposedException"/>
/// <exception cref="ArgumentNullException"/>
/// <exception cref="ArgumentException"/>
/// <exception cref="NullReferenceException"/>
/// <exception cref="JsUsageException"/>
/// <exception cref="JsCompilationException"/>
/// <exception cref="JsTimeoutException"/>
/// <exception cref="JsInterruptedException"/>
/// <exception cref="JsRuntimeException"/>
/// <exception cref="JsException"/>
void ExecuteResource(string resourceName, Type type);
/// <summary>
/// Executes a code from embedded JS resource
/// </summary>
/// <param name="resourceName">The case-sensitive resource name</param>
/// <param name="assembly">The assembly, which contains the embedded resource</param>
/// <exception cref="ObjectDisposedException"/>
/// <exception cref="ArgumentNullException"/>
/// <exception cref="ArgumentException"/>
/// <exception cref="NullReferenceException"/>
/// <exception cref="JsUsageException"/>
/// <exception cref="JsCompilationException"/>
/// <exception cref="JsTimeoutException"/>
/// <exception cref="JsInterruptedException"/>
/// <exception cref="JsRuntimeException"/>
/// <exception cref="JsException"/>
void ExecuteResource(string resourceName, Assembly assembly);
/// <summary>
/// Calls a function
/// </summary>
/// <param name="functionName">Function name</param>
/// <param name="args">Function arguments</param>
/// <returns>Result of the function execution</returns>
/// <exception cref="ObjectDisposedException"/>
/// <exception cref="ArgumentNullException"/>
/// <exception cref="ArgumentException"/>
/// <exception cref="JsTimeoutException"/>
/// <exception cref="JsInterruptedException"/>
/// <exception cref="JsRuntimeException"/>
/// <exception cref="JsException"/>
object CallFunction(string functionName, params object[] args);
/// <summary>
/// Calls a function
/// </summary>
/// <typeparam name="T">Type of function result</typeparam>
/// <param name="functionName">Function name</param>
/// <param name="args">Function arguments</param>
/// <returns>Result of the function execution</returns>
/// <exception cref="ObjectDisposedException"/>
/// <exception cref="ArgumentNullException"/>
/// <exception cref="ArgumentException"/>
/// <exception cref="JsTimeoutException"/>
/// <exception cref="JsInterruptedException"/>
/// <exception cref="JsRuntimeException"/>
/// <exception cref="JsException"/>
T CallFunction<T>(string functionName, params object[] args);
/// <summary>
/// Сhecks for the existence of a variable
/// </summary>
/// <param name="variableName">Variable name</param>
/// <returns>Result of check (true - exists; false - not exists</returns>
/// <exception cref="ObjectDisposedException"/>
/// <exception cref="ArgumentNullException"/>
/// <exception cref="ArgumentException"/>
/// <exception cref="JsRuntimeException"/>
/// <exception cref="JsException"/>
bool HasVariable(string variableName);
/// <summary>
/// Gets a value of variable
/// </summary>
/// <param name="variableName">Variable name</param>
/// <returns>Value of variable</returns>
/// <exception cref="ObjectDisposedException"/>
/// <exception cref="ArgumentNullException"/>
/// <exception cref="ArgumentException"/>
/// <exception cref="JsRuntimeException"/>
/// <exception cref="JsException"/>
object GetVariableValue(string variableName);
/// <summary>
/// Gets a value of variable
/// </summary>
/// <typeparam name="T">Type of variable</typeparam>
/// <param name="variableName">Variable name</param>
/// <returns>Value of variable</returns>
/// <exception cref="ObjectDisposedException"/>
/// <exception cref="ArgumentNullException"/>
/// <exception cref="ArgumentException"/>
/// <exception cref="JsRuntimeException"/>
/// <exception cref="JsException"/>
T GetVariableValue<T>(string variableName);
/// <summary>
/// Sets a value of variable
/// </summary>
/// <param name="variableName">Variable name</param>
/// <param name="value">Value of variable</param>
/// <exception cref="ObjectDisposedException"/>
/// <exception cref="ArgumentNullException"/>
/// <exception cref="ArgumentException"/>
/// <exception cref="JsRuntimeException"/>
/// <exception cref="JsException"/>
void SetVariableValue(string variableName, object value);
/// <summary>
/// Removes a variable
/// </summary>
/// <param name="variableName">Variable name</param>
/// <exception cref="ObjectDisposedException"/>
/// <exception cref="ArgumentNullException"/>
/// <exception cref="ArgumentException"/>
/// <exception cref="JsRuntimeException"/>
/// <exception cref="JsException"/>
void RemoveVariable(string variableName);
/// <summary>
/// Embeds a host object to script code
/// </summary>
/// <param name="itemName">The name for the new global variable or function that will represent the object</param>
/// <param name="value">The object to expose</param>
/// <remarks>Allows to embed instances of simple classes (or structures) and delegates.</remarks>
/// <exception cref="ObjectDisposedException"/>
/// <exception cref="ArgumentNullException"/>
/// <exception cref="ArgumentException"/>
/// <exception cref="JsException"/>
void EmbedHostObject(string itemName, object value);
/// <summary>
/// Embeds a host type to script code
/// </summary>
/// <param name="itemName">The name for the new global variable that will represent the type</param>
/// <param name="type">The type to expose</param>
/// <remarks>
/// Host types are exposed to script code in the form of objects whose properties and
/// methods are bound to the type's static members.
/// </remarks>
/// <exception cref="ObjectDisposedException"/>
/// <exception cref="ArgumentNullException"/>
/// <exception cref="ArgumentException"/>
/// <exception cref="JsException"/>
void EmbedHostType(string itemName, Type type);
/// <summary>
/// Interrupts script execution and causes the JS engine to throw an exception
/// </summary>
void Interrupt();
/// <summary>
/// Performs a full garbage collection
/// </summary>
void CollectGarbage();
}
}