-
Notifications
You must be signed in to change notification settings - Fork 160
Expand file tree
/
Copy pathVBScriptEngine.cs
More file actions
145 lines (127 loc) · 6.68 KB
/
VBScriptEngine.cs
File metadata and controls
145 lines (127 loc) · 6.68 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
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT license.
using System;
using System.Collections.Generic;
using Microsoft.ClearScript.Util;
namespace Microsoft.ClearScript.Windows
{
/// <summary>
/// Represents an instance of the VBScript engine in a desktop environment.
/// </summary>
/// <remarks>
/// Each Windows Script engine instance in a desktop environment has thread affinity and is
/// bound to a <c><see cref="System.Windows.Threading.Dispatcher"/></c> during instantiation.
/// Attempting to execute script code on a different thread results in an exception. Script
/// delegates and event handlers are marshaled synchronously onto the correct thread.
/// </remarks>
public class VBScriptEngine : WindowsScriptEngine, IVBScriptEngineTag
{
#region constructors
/// <summary>
/// Initializes a new VBScript engine instance.
/// </summary>
public VBScriptEngine()
: this(null)
{
}
/// <summary>
/// Initializes a new VBScript engine instance with the specified name.
/// </summary>
/// <param name="name">A name to associate with the instance. Currently, this name is used only as a label in presentation contexts such as debugger user interfaces.</param>
public VBScriptEngine(string name)
: this(name, WindowsScriptEngineFlags.None)
{
}
/// <summary>
/// Initializes a new VBScript engine instance with the specified options.
/// </summary>
/// <param name="flags">A value that selects options for the operation.</param>
public VBScriptEngine(WindowsScriptEngineFlags flags)
: this(null, flags)
{
}
/// <summary>
/// Initializes a new VBScript engine instance with the specified name and options.
/// </summary>
/// <param name="name">A name to associate with the instance. Currently, this name is used only as a label in presentation contexts such as debugger user interfaces.</param>
/// <param name="flags">A value that selects options for the operation.</param>
public VBScriptEngine(string name, WindowsScriptEngineFlags flags)
: this("VBScript", name, "vbs", flags)
{
}
/// <summary>
/// Initializes a new VBScript engine instance with the specified programmatic
/// identifier, name, list of supported file name extensions, and options.
/// </summary>
/// <param name="progID">The programmatic identifier (ProgID) of the VBScript engine class.</param>
/// <param name="name">A name to associate with the instance. Currently, this name is used only as a label in presentation contexts such as debugger user interfaces.</param>
/// <param name="fileNameExtensions">A semicolon-delimited list of supported file name extensions.</param>
/// <param name="flags">A value that selects options for the operation.</param>
/// <remarks>
/// The <paramref name="progID"/> argument can be a class identifier (CLSID) in standard
/// GUID format with braces (e.g., "{F414C260-6AC0-11CF-B6D1-00AA00BBBB58}").
/// </remarks>
protected VBScriptEngine(string progID, string name, string fileNameExtensions, WindowsScriptEngineFlags flags)
: base(progID, name, fileNameExtensions, flags)
{
Execute(MiscHelpers.FormatInvariant("{0} [internal]", GetType().Name), Core.VBScriptEngine.InitScript);
}
#endregion
#region ScriptEngine overrides
/// <summary>
/// Gets the script engine's recommended file name extension for script files.
/// </summary>
/// <remarks>
/// <c><see cref="VBScriptEngine"/></c> instances return "vbs" for this property.
/// </remarks>
public override string FileNameExtension => "vbs";
/// <summary>
/// Executes script code as a command.
/// </summary>
/// <param name="command">The script command to execute.</param>
/// <returns>The command output.</returns>
/// <remarks>
/// <para>
/// This method is similar to <c><see cref="ScriptEngine.Evaluate(string)"/></c> but optimized for
/// command consoles. The specified command must be limited to a single expression or
/// statement. Script engines can override this method to customize command execution as
/// well as the process of converting the result to a string for console output.
/// </para>
/// <para>
/// The <c><see cref="VBScriptEngine"/></c> version of this method supports both expressions and
/// statements. If the specified command begins with "eval " (not case-sensitive), the
/// engine executes the remainder as an expression and attempts to use
/// <c><see href="https://docs.microsoft.com/en-us/previous-versions//0zk841e9(v=vs.85)">CStr</see></c>
/// to convert the result value. Otherwise, it executes the command as a statement and does
/// not return a value.
/// </para>
/// </remarks>
public override string ExecuteCommand(string command)
{
var trimmedCommand = command.Trim();
if (trimmedCommand.StartsWith("eval ", StringComparison.OrdinalIgnoreCase))
{
var expression = MiscHelpers.FormatInvariant("EngineInternal.getCommandResult({0})", trimmedCommand.Substring(5));
var documentInfo = new DocumentInfo("Expression") { Flags = DocumentFlags.IsTransient };
return GetCommandResultString(Evaluate(documentInfo.MakeUnique(this), expression, false));
}
Execute("Command", true, trimmedCommand);
return null;
}
internal override IDictionary<int, string> RuntimeErrorMap => Core.VBScriptEngine.StaticRuntimeErrorMap;
internal override IDictionary<int, string> SyntaxErrorMap => Core.VBScriptEngine.StaticSyntaxErrorMap;
internal override object Execute(UniqueDocumentInfo documentInfo, string code, bool evaluate)
{
if (FormatCode)
{
code = MiscHelpers.FormatCode(code);
}
if (documentInfo.Category != DocumentCategory.Script)
{
throw new NotSupportedException("The script engine cannot execute documents of type '" + documentInfo.Category + "'");
}
return base.Execute(documentInfo, code, evaluate);
}
#endregion
}
}