/
SrgsRuleRef.cs
297 lines (256 loc) · 9.21 KB
/
SrgsRuleRef.cs
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
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
using System.ComponentModel;
using System.Diagnostics;
using System.Speech.Internal;
using System.Speech.Internal.SrgsParser;
using System.Text;
using System.Xml;
namespace System.Speech.Recognition.SrgsGrammar
{
[Serializable]
[ImmutableObject(true)]
[DebuggerDisplay("{DebuggerDisplayString()}")]
public class SrgsRuleRef : SrgsElement, IRuleRef
{
#region Constructors
public SrgsRuleRef(Uri uri)
{
UriInit(uri, null, null, null);
}
public SrgsRuleRef(Uri uri, string rule)
{
Helpers.ThrowIfEmptyOrNull(rule, nameof(rule));
UriInit(uri, rule, null, null);
}
public SrgsRuleRef(Uri uri, string rule, string semanticKey)
{
Helpers.ThrowIfEmptyOrNull(semanticKey, nameof(semanticKey));
UriInit(uri, rule, semanticKey, null);
}
public SrgsRuleRef(Uri uri, string rule, string semanticKey, string parameters)
{
Helpers.ThrowIfEmptyOrNull(parameters, nameof(parameters));
UriInit(uri, rule, semanticKey, parameters);
}
public SrgsRuleRef(SrgsRule rule)
{
Helpers.ThrowIfNull(rule, nameof(rule));
_uri = new Uri("#" + rule.Id, UriKind.Relative);
}
public SrgsRuleRef(SrgsRule rule, string semanticKey)
: this(rule)
{
Helpers.ThrowIfEmptyOrNull(semanticKey, nameof(semanticKey));
_semanticKey = semanticKey;
}
public SrgsRuleRef(SrgsRule rule, string semanticKey, string parameters)
: this(rule)
{
Helpers.ThrowIfEmptyOrNull(parameters, nameof(parameters));
_semanticKey = semanticKey;
_params = parameters;
}
/// <summary>
/// Special private constructor for Special Rulerefs
/// </summary>
private SrgsRuleRef(SpecialRuleRefType type)
{
_type = type;
}
internal SrgsRuleRef(string semanticKey, string parameters, Uri uri)
{
_uri = uri;
_semanticKey = semanticKey;
_params = parameters;
}
#endregion
#region public Properties
// Uri of the rule this rule reference references.
public Uri Uri
{
get
{
return _uri;
}
}
/// <summary>
/// Set the semanticKey for a Ruleref
/// </summary>
public string SemanticKey
{
get
{
return _semanticKey;
}
}
/// <summary>
/// Set the init parameters for a Ruleref
/// </summary>
public string Params
{
get
{
return _params;
}
}
// The Null SpecialRuleRef defines a rule that is automatically matched:
// that is, matched without the user speaking any word.
public static readonly SrgsRuleRef Null = new(SpecialRuleRefType.Null);
// The Void SpecialRuleRef defines a rule that can never be spoken. Inserting
// VOID into a sequence automatically makes that sequence unspeakable.
public static readonly SrgsRuleRef Void = new(SpecialRuleRefType.Void);
// The Garbage SpecialRuleRef defines a rule that may match any speech up until
// the next rule match, the next token or until the end of spoken input.
public static readonly SrgsRuleRef Garbage = new(SpecialRuleRefType.Garbage);
public static readonly SrgsRuleRef Dictation = new(new Uri("grammar:dictation"));
public static readonly SrgsRuleRef MnemonicSpelling = new(new Uri("grammar:dictation#spelling"));
#endregion
#region Internal methods
internal override void WriteSrgs(XmlWriter writer)
{
// Write <ruleref _uri="_uri" />
writer.WriteStartElement("ruleref");
if (_uri != null)
{
writer.WriteAttributeString("uri", _uri.ToString());
}
else
{
string special;
switch (_type)
{
case SpecialRuleRefType.Null:
special = "NULL";
break;
case SpecialRuleRefType.Void:
special = "VOID";
break;
case SpecialRuleRefType.Garbage:
special = "GARBAGE";
break;
default:
XmlParser.ThrowSrgsException(SRID.InvalidSpecialRuleRef);
special = null;
break;
}
writer.WriteAttributeString("special", special);
}
// Write the 'name' attribute
if (_semanticKey != null)
{
writer.WriteAttributeString("sapi", "semantic-key", XmlParser.sapiNamespace, _semanticKey);
}
// Write the 'params' attribute
if (_params != null)
{
writer.WriteAttributeString("sapi", "params", XmlParser.sapiNamespace, _params);
}
writer.WriteEndElement();
}
/// <summary>
/// Validate the SRGS element.
/// </summary>
internal override void Validate(SrgsGrammar grammar)
{
bool fScript = _params != null || _semanticKey != null;
grammar._fContainsCode |= fScript;
grammar.HasSapiExtension |= fScript;
// Validate _uri
if (_uri != null)
{
string sUri = _uri.ToString();
if (sUri[0] == '#')
{
bool uriFound = false;
if (sUri.StartsWith("#grammar:dictation", StringComparison.Ordinal))
{
uriFound = true;
}
else
{
sUri = sUri.Substring(1);
foreach (SrgsRule rule in grammar.Rules)
{
if (rule.Id == sUri)
{
uriFound = true;
break;
}
}
}
if (!uriFound)
{
XmlParser.ThrowSrgsException(SRID.UndefRuleRef, sUri);
}
}
}
base.Validate(grammar);
}
internal override string DebuggerDisplayString()
{
StringBuilder sb = new("SrgsRuleRef");
if (_uri != null)
{
sb.Append(" uri = '");
sb.Append(_uri.ToString());
sb.Append('\'');
}
else
{
sb.Append(" special = '");
sb.Append(_type.ToString());
sb.Append('\'');
}
return sb.ToString();
}
#endregion
#region Private Method
/// <summary>
/// Call by constructors. No check is made on the parameters except for the Uri
/// </summary>
private void UriInit(Uri uri, string rule, string semanticKey, string initParameters)
{
Helpers.ThrowIfNull(uri, nameof(uri));
if (string.IsNullOrEmpty(rule))
{
_uri = uri;
}
else
{
_uri = new Uri(uri.ToString() + "#" + rule, UriKind.RelativeOrAbsolute);
}
_semanticKey = semanticKey;
_params = initParameters;
}
#endregion
#region Private Fields
#region Private Enums
// Special rule references allow grammars based on CFGs to have powerful
// additional features, such as transitions into dictation (both recognized
// or not recognized) and word sequences from SAPI 5.0.
private enum SpecialRuleRefType
{
// Defines a rule that is automatically matched that is, matched without
// the user speaking any word.
Null,
// Defines a rule that can never be spoken. Inserting VOID into a sequence
// automatically makes that sequence unspeakable.
Void,
// Defines a rule that may match any speech up until the next rule match,
// the next token or until the end of spoken input.
// Designed for applications that would like to recognize some phrases
// without failing due to irrelevant, or ignorable words.
Garbage,
}
#endregion
// if the uri is null then it is a special rule ref
private Uri _uri;
private SpecialRuleRefType _type;
// Alias string for the semantic dictionary
private string _semanticKey;
// Alias string for the semantic dictionary
private string _params;
#endregion
}
}