forked from nkast/MonoGame
-
-
Notifications
You must be signed in to change notification settings - Fork 10
/
CommandLineParser.cs
612 lines (493 loc) · 20.3 KB
/
CommandLineParser.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
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
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
// MonoGame - Copyright (C) The MonoGame Team
// This file is subject to the terms and conditions defined in
// file 'LICENSE.txt', which is part of this source code package.
using System;
using System.IO;
using System.Linq;
using System.Collections;
using System.Collections.Generic;
using System.Diagnostics;
using System.Reflection;
using System.ComponentModel;
namespace Microsoft.Xna.Framework.Content.Pipeline.Builder
{
/// <summary>
/// Adapted from this generic command line argument parser:
/// http://blogs.msdn.com/b/shawnhar/archive/2012/04/20/a-reusable-reflection-based-command-line-parser.aspx
/// </summary>
public class CommandLineParser
{
public static CommandLineParser Instance;
private readonly object _optionsObject;
private readonly Queue<MemberInfo> _requiredOptions;
private readonly Dictionary<string, MemberInfo> _optionalOptions;
private readonly Dictionary<string, string> _flags;
private readonly List<string> _requiredUsageHelp;
public readonly Dictionary<string, string> _properties;
public delegate void ErrorCallback(string msg, object[] args);
public event ErrorCallback OnError;
public CommandLineParser(object optionsObject)
{
Instance = this;
_optionsObject = optionsObject;
_requiredOptions = new Queue<MemberInfo>();
_optionalOptions = new Dictionary<string, MemberInfo>();
_requiredUsageHelp = new List<string>();
_properties = new Dictionary<string, string>();
// Reflect to find what commandline options are available...
// Fields
foreach (var field in optionsObject.GetType().GetFields())
{
var param = GetAttribute<CommandLineParameterAttribute>(field);
if (param == null)
continue;
CheckReservedPrefixes(param.Name);
if (param.Required)
{
// Record a required option.
_requiredOptions.Enqueue(field);
_requiredUsageHelp.Add(string.Format("<{0}>", param.Name));
}
else
{
// Record an optional option.
_optionalOptions.Add(param.Name.ToLowerInvariant(), field);
}
}
// Properties
foreach (var property in optionsObject.GetType().GetProperties())
{
var param = GetAttribute<CommandLineParameterAttribute>(property);
if (param == null)
continue;
CheckReservedPrefixes(param.Name);
if (param.Required)
{
// Record a required option.
_requiredOptions.Enqueue(property);
_requiredUsageHelp.Add(string.Format("<{0}>", param.Name));
}
else
{
// Record an optional option.
_optionalOptions.Add(param.Name.ToLowerInvariant(), property);
}
}
// Methods
foreach (var method in optionsObject.GetType().GetMethods())
{
var param = GetAttribute<CommandLineParameterAttribute>(method);
if (param == null)
continue;
CheckReservedPrefixes(param.Name);
// Only accept methods that take less than 1 parameter.
if (method.GetParameters().Length > 1)
throw new NotSupportedException("Methods must have one or zero parameters.");
if (param.Required)
{
// Record a required option.
_requiredOptions.Enqueue(method);
_requiredUsageHelp.Add(string.Format("<{0}>", param.Name));
}
else
{
// Record an optional option.
_optionalOptions.Add(param.Name.ToLowerInvariant(), method);
}
}
_flags = new Dictionary<string, string>();
foreach(var pair in _optionalOptions)
{
var fi = GetAttribute<CommandLineParameterAttribute>(pair.Value);
if(!string.IsNullOrEmpty(fi.Flag))
_flags.Add(fi.Flag, fi.Name);
}
}
public bool Parse(IEnumerable<string> args)
{
var preprocargs = Preprocess(args);
var showUsage = true;
var success = true;
foreach (var arg in preprocargs)
{
showUsage = false;
if (!ParseFlags(arg))
{
success = false;
break;
}
}
var missingRequiredOption = _requiredOptions.FirstOrDefault(field => !IsList(field) || GetList(field).Count == 0);
if (missingRequiredOption != null)
{
ShowError("Missing argument '{0}'", GetAttribute<CommandLineParameterAttribute>(missingRequiredOption).Name);
return false;
}
if (showUsage)
ShowError(null);
return success;
}
private IEnumerable<string> Preprocess(IEnumerable<string> args)
{
var output = new List<string>();
var ifstack = new Stack<IfCondition>();
foreach (var arg in args)
ParsePreprocessArg(arg, output, ifstack, false);
return output;
}
private void ParsePreprocessArg(string arg, List<string> output, Stack<IfCondition> ifstack, bool inResponseFile)
{
if (arg.StartsWith("$endif"))
{
ifstack.Pop();
return;
}
if (ifstack.Count > 0)
{
foreach (var ifCondition in ifstack)
{
var expected = ifCondition.Value;
string actual;
if (!_properties.TryGetValue(ifCondition.Key, out actual))
return;
if (expected != string.Empty && !expected.Equals(actual))
return;
}
}
if (arg.StartsWith("$set "))
{
if (!inResponseFile)
throw new Exception("$set is invalid outside of a response file.");
var words = arg.Substring(5).Split('=');
var name = words[0].Trim();
var value = words.Length > 1 ? words[1].Trim() : string.Empty;
_properties[name] = value;
return;
}
if (arg.StartsWith("$if "))
{
if (!inResponseFile)
throw new Exception("$if is invalid outside of a response file.");
var words = arg.Substring(4).Split('=');
var name = words[0].Trim();
var value = words.Length > 1 ? words[1].Trim() : string.Empty;
var condition = new IfCondition(name, value);
ifstack.Push(condition);
return;
}
if (arg.StartsWith("/define:") || arg.StartsWith("--define:"))
{
arg = arg.Substring(arg[0] == '/' ? 8 : 9);
var words = arg.Split('=');
var name = words[0];
var value = words.Length > 1 ? words[1] : string.Empty;
_properties[name] = value;
return;
}
if (arg.StartsWith("/@:") || arg.StartsWith("--@:") || arg.StartsWith("-@:"))
{
string file = null;
if (arg.StartsWith("/@:") || arg.StartsWith("-@:"))
file = arg.Substring(3);
if (file.StartsWith("--@:"))
file = arg.Substring(4);
file = Path.GetFullPath(file);
if (!File.Exists(file))
throw new Exception(string.Format("File '{0}' does not exist.", file));
string responseFilename = Path.GetFileName(file);
if (!inResponseFile)
output.Add("/@:" + responseFilename);
var prevDir = Directory.GetCurrentDirectory();
var dir = Path.GetDirectoryName(file);
if (prevDir != dir)
{
// make sure the working dir is changed both during preprocessing and during execution
Directory.SetCurrentDirectory(dir);
output.Add("/workingDir:" + dir);
}
var lines = File.ReadAllLines(file);
foreach (var line in lines)
{
if (string.IsNullOrWhiteSpace(line) || line.StartsWith("#"))
continue;
ParsePreprocessArg(line, output, ifstack, true);
}
if (prevDir != dir)
{
Directory.SetCurrentDirectory(prevDir);
output.Add("/workingDir:" + prevDir);
}
return;
}
output.Add(arg);
}
private bool ParseFlags(string arg)
{
// Only one flag
if (arg.Length >= 3 &&
(arg[0] == '-' || arg[0] == '/') &&
(arg[2] == '=' || arg[2] == ':'))
{
string name;
if (!_flags.TryGetValue(arg[1].ToString(), out name))
{
ShowError("Unknown option '{0}'", arg[1].ToString());
return false;
}
ParseArgument("/" + name + arg.Substring(2));
return true;
}
// Not a flag, parse argument
return ParseArgument(arg);
}
private bool ParseArgument(string arg)
{
if (arg.StartsWith("/") || arg.StartsWith("--"))
{
// After the first escaped argument we can no
// longer read non-escaped arguments.
if (_requiredOptions.Count > 0)
return false;
// Parse an optional argument.
char[] separators = { ':', '=' };
var split = arg.Substring(arg.StartsWith("/") ? 1 : 2).Split(separators, 2, StringSplitOptions.None);
var name = split[0];
var value = (split.Length > 1) ? split[1] : "true";
MemberInfo member;
if (!_optionalOptions.TryGetValue(name.ToLowerInvariant(), out member))
{
ShowError("Unknown option '{0}'", name);
return false;
}
return SetOption(member, value);
}
if (_requiredOptions.Count > 0)
{
// Parse the next non escaped argument.
var field = _requiredOptions.Peek();
if (!IsList(field))
_requiredOptions.Dequeue();
return SetOption(field, arg);
}
ShowError("Too many arguments");
return false;
}
bool SetOption(MemberInfo member, string value)
{
try
{
if (IsList(member))
{
// Append this value to a list of options.
GetList(member).Add(ChangeType(value, ListElementType(member)));
}
else
{
// Set the value of a single option.
if (member is MethodInfo)
{
var method = member as MethodInfo;
var parameters = method.GetParameters();
if (parameters.Length == 0)
method.Invoke(_optionsObject, null);
else
method.Invoke(_optionsObject, new[] { ChangeType(value, parameters[0].ParameterType) });
}
else if (member is FieldInfo)
{
var field = member as FieldInfo;
field.SetValue(_optionsObject, ChangeType(value, field.FieldType));
}
else
{
var property = member as PropertyInfo;
property.SetValue(_optionsObject, ChangeType(value, property.PropertyType), null);
}
}
return true;
}
catch (TargetInvocationException tiex)
{
ShowError("Invalid value '{0}' for option '{1}'", value, GetAttribute<CommandLineParameterAttribute>(member).Name);
ShowError(tiex.InnerException.Message);
return false;
}
catch
{
ShowError("Invalid value '{0}' for option '{1}'", value, GetAttribute<CommandLineParameterAttribute>(member).Name);
return false;
}
}
static readonly string[] ReservedPrefixes = new[]
{
"$",
"/",
"#",
"--",
"-"
};
static void CheckReservedPrefixes(string str)
{
foreach (var i in ReservedPrefixes)
{
if (str.StartsWith(i))
throw new Exception(string.Format("'{0}' is a reserved prefix and cannot be used at the start of an argument name.", i));
}
}
static object ChangeType(string value, Type type)
{
var converter = TypeDescriptor.GetConverter(type);
return converter.ConvertFromInvariantString(value);
}
static bool IsList(MemberInfo member)
{
if (member is MethodInfo)
return false;
if (member is FieldInfo)
return typeof(IList).IsAssignableFrom((member as FieldInfo).FieldType);
return typeof(IList).IsAssignableFrom((member as PropertyInfo).PropertyType);
}
IList GetList(MemberInfo member)
{
if (member is PropertyInfo)
return (IList)(member as PropertyInfo).GetValue(_optionsObject, null);
if (member is FieldInfo)
return (IList)(member as FieldInfo).GetValue(_optionsObject);
throw new Exception();
}
static Type ListElementType(MemberInfo member)
{
if (member is FieldInfo)
{
var field = member as FieldInfo;
var interfaces = from i in field.FieldType.GetInterfaces()
where i.IsGenericType && i.GetGenericTypeDefinition() == typeof (IEnumerable<>)
select i;
return interfaces.First().GetGenericArguments()[0];
}
if (member is PropertyInfo)
{
var property = member as PropertyInfo;
var interfaces = from i in property.PropertyType.GetInterfaces()
where i.IsGenericType && i.GetGenericTypeDefinition() == typeof(IEnumerable<>)
select i;
return interfaces.First().GetGenericArguments()[0];
}
throw new ArgumentException("Only FieldInfo and PropertyInfo are valid arguments.", "member");
}
public string Title { get; set; }
bool IsWindows()
{
switch (Environment.OSVersion.Platform)
{
case PlatformID.Win32NT:
case PlatformID.Win32S:
case PlatformID.Win32Windows:
case PlatformID.WinCE:
return true;
}
return false;
}
public void ShowError(string message, params object[] args)
{
if (!string.IsNullOrEmpty(message) && OnError != null)
{
OnError(message, args);
return;
}
var name = Path.GetFileNameWithoutExtension(Process.GetCurrentProcess().ProcessName);
if (!string.IsNullOrEmpty(Title))
{
Console.Error.WriteLine(Title);
Console.Error.WriteLine();
}
if (!string.IsNullOrEmpty(message))
{
Console.Error.WriteLine(message, args);
Console.Error.WriteLine();
}
var defaultParamPrefix = IsWindows() ? "/" : "--";
Console.Error.WriteLine("Usage: {0} {1}{2}",
name,
_requiredUsageHelp.Count > 0 ? string.Join(" ", _requiredUsageHelp) + " " : string.Empty,
_optionalOptions.Count > 0 ? "<Options>" : string.Empty);
if (_optionalOptions.Count > 0)
{
Console.Error.WriteLine();
Console.Error.WriteLine("Options:");
var data = _optionalOptions.Values.ToList();
data.Sort((x, y) => {
var px = GetAttribute<CommandLineParameterAttribute>(x);
var py = GetAttribute<CommandLineParameterAttribute>(y);
return px.Name.CompareTo(py.Name);
});
foreach(var d in data)
{
var attr = GetAttribute<CommandLineParameterAttribute>(d);
var field = d as FieldInfo;
var prop = d as PropertyInfo;
var method = d as MethodInfo;
var hasValue = false;
if (field != null && field.FieldType != typeof (bool))
hasValue = true;
if (prop != null && prop.PropertyType != typeof (bool))
hasValue = true;
if (method != null && method.GetParameters().Length != 0)
hasValue = true;
var s = " ";
s += (!string.IsNullOrEmpty(attr.Flag)) ? (IsWindows() ? "/" : "-") + attr.Flag + "," : " ";
s += " " + defaultParamPrefix + attr.Name;
if (hasValue)
{
if (IsWindows())
s += ":<" + attr.ValueName + ">";
else
s += "=" + attr.ValueName.Replace("=", ":").ToUpper();
}
s = s.PadRight(35, ' ');
// Wrap text description
var bw = Math.Max(60, Console.BufferWidth);
var desc = attr.Description.Split(' ');
foreach(var dw in desc)
{
if (s.Length + dw.Length >= bw)
{
Console.WriteLine(s);
s = string.Empty.PadRight(37, ' ');
}
s += " " + dw;
}
Console.WriteLine(s);
}
}
}
static T GetAttribute<T>(ICustomAttributeProvider provider) where T : Attribute
{
return provider.GetCustomAttributes(typeof(T), false).OfType<T>().FirstOrDefault();
}
private struct IfCondition
{
public readonly string Key;
public readonly string Value;
public IfCondition(string key, string value)
{
Key = key;
Value = value;
}
}
}
// Used on an optionsObject field or method to rename the corresponding commandline option.
[AttributeUsage(AttributeTargets.Field | AttributeTargets.Method | AttributeTargets.Property)]
public sealed class CommandLineParameterAttribute : Attribute
{
public CommandLineParameterAttribute()
{
ValueName = "value";
}
public string Name { get; set; }
public string Flag { get; set; }
public bool Required { get; set; }
public string ValueName { get; set; }
public string Description { get; set; }
}
}