-
Notifications
You must be signed in to change notification settings - Fork 25
/
MacroProcessor.cs
329 lines (297 loc) · 13.9 KB
/
MacroProcessor.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
using System;
using System.Collections.Generic;
using System.Linq;
using System.Reflection;
using System.Threading;
using System.Threading.Tasks;
using Loyc;
using Loyc.Collections;
using Loyc.Syntax;
using Loyc.Threading;
using LeMP.Prelude;
using System.Diagnostics;
using Loyc.Collections.Impl;
/// <summary>The lexical macro processor. Main classes: <see cref="LeMP.Compiler"/> and <see cref="LeMP.MacroProcessor"/>.</summary>
namespace LeMP
{
/// <summary>
/// For LeMP: an input file plus per-file options (input and output language) and output code.
/// </summary>
public class InputOutput
{
public InputOutput(ICharSource text, string fileName, IParsingService input = null, ILNodePrinter outPrinter = null, string outFileName = null)
{
Text = text;
FileName = fileName ?? "";
InputLang = input;
OutPrinter = outPrinter;
OutFileName = outFileName;
PreOpenedNamespaces = AutoPreOpenedNamespaces(FileName);
}
public readonly ICharSource Text;
public readonly string FileName; // Should include the full path
public IParsingService InputLang;
public bool? PreserveComments; // null means unassigned (to use the Compiler default)
public ParsingMode ParsingMode; // inputType argument when parsing with IParsingService.Parse
public ILNodePrinter OutPrinter;
public ILNodePrinterOptions OutOptions;
public string OutFileName;
public LNodeList Output;
/// <summary>Specifies namespaces to be opened implicitly. It is combined with
/// <see cref="MacroProcessor.PreOpenedNamespaces"/> when LeMP processes the
/// file. The constructor of this class adds pre-opened namespaces `LeMP.ext`
/// and `ext` based on the file extension `ext`.</summary>
public MSet<Symbol> PreOpenedNamespaces;
public override string ToString()
{
return FileName;
}
public static MSet<Symbol> AutoPreOpenedNamespaces(string fileName)
{
var ext = System.IO.Path.GetExtension(fileName).ToLowerInvariant();
if (ext.Length != 0)
return new MSet<Symbol> { (Symbol)("LeMP" + ext), (Symbol)ext.Slice(1) };
else
return new MSet<Symbol>();
}
}
/// <summary>
/// Encapsulates the LeMP engine, a simple LISP-style macro processor,
/// suitable for running LLLPG and other lexical macros.
/// </summary>
/// <remarks>
/// MacroProcessor itself only cares about a few nodes including
/// #importMacros and #unimportMacros, and { braces } (for scoping the
/// #import statements). The macro processor should be configured with any
/// needed macros like this:
/// <code>
/// var prelude = typeof(LeMP.Prelude.BuiltinMacros); // the default prelude
/// var MP = new MacroProcessor(prelude, sink);
/// MP.AddMacros(typeof(LeMP.StandardMacros).Assembly);
/// MP.PreOpenedNamespaces.Add((Symbol) "LeMP.Prelude"); // already done for you
/// MP.PreOpenedNamespaces.Add((Symbol) "LeMP");
/// </code>
/// In order for the input code to have access to macros, two steps are
/// necessary: you have to add the macro classes with <see cref="AddMacros"/>
/// and then you have to import the namespace that contains the class(es).
/// Higher-level code (e.g. <see cref="Compiler"/>) can define "always-open"
/// namespaces by adding entries to PreOpenedNamespaces, and the code being
/// processed can open additional namespaces with a #importMacros(Namespace)
/// statement.
/// <para/>
/// MacroProcessor is not aware of any distinction between "statements"
/// and "expressions"; it will run macros no matter where they are located,
/// whether as standalone statements, attributes, or arguments to functions.
/// <para/>
/// MacroProcessor's main responsibilities are to keep track of a table of
/// registered macros (call <see cref="AddMacros"/> to register more), to
/// keep track of which namespaces are open, to scan the input for macros to
/// call; and to control the printout of messages.
/// <para/>
/// This class processes a batch of files at once. Call either
/// <see cref="ProcessSynchronously"/> or <see cref="ProcessParallel"/>.
/// Parallelizing on a file-by-file basis is easy; each source file is completely
/// independent, since no semantic analysis is being done.
/// </remarks>
public partial class MacroProcessor
{
IMessageSink _sink;
public IMessageSink Sink { get { return _sink ?? MessageSink.Default; } set { _sink = value; } }
public int MaxExpansions = 255;
[ThreadStatic]
internal static MacroProcessor _current;
/// <summary>Returns the <c>MacroProcessor</c> running on the current thread, or null if none.</summary>
public static MacroProcessor Current { get { return _current; } }
/// <summary>Initializes MacroProcessor with default prelude.</summary>
public MacroProcessor(IMessageSink sink) : this(sink, typeof(BuiltinMacros)) { }
/// <summary>Initializes MacroProcessor.</summary>
/// <param name="sink">The destination for warning and error messages. NOTE:
/// this class can process files in parallel. Consider using a thread-safe
/// implementation of <see cref="IMessageSink"/>.</param>
/// <param name="prelude">An initial type from which to add macros.
/// Omit this parameter to use typeof(LeMP.Prelude.BuiltinMacros).</param>
public MacroProcessor(IMessageSink sink, Type prelude)
{
_sink = sink;
if (prelude != null)
AddMacros(prelude);
AbortTimeout = TimeSpan.FromSeconds(30);
PreOpenedNamespaces.Add(GSymbol.Empty);
PreOpenedNamespaces.Add((Symbol)"LeMP.Prelude");
}
MMap<Symbol, InternalList<InternalMacroInfo>> _macros = new MMap<Symbol, InternalList<InternalMacroInfo>>();
internal MMap<Symbol, InternalList<InternalMacroInfo>> Macros { get { return _macros; } }
/// <summary>Macros in these namespaces will be available without an explicit
/// import command (#importMacros). By default this list has one item:
/// @@LeMP.Prelude (i.e. (Symbol)"LeMP.Prelude"). This set is combined with
/// <see cref="InputOutput.PreOpenedNamespaces"/> when processing starts.</summary>
public ICollection<Symbol> PreOpenedNamespaces { get { return _preOpenedNamespaces; } }
internal MSet<Symbol> _preOpenedNamespaces = new MSet<Symbol>();
/// <summary>Default values of scoped properties.</summary>
/// <remarks>Code being processed can look up a scoped property named "N" with
/// <c>#getScopedProperty("N")</c> in LESv2 or EC#. This map is empty by default.
/// Scoped properties are "scoped" in the sense that setting a property with
/// <c>#setScopedProperty(keyLiteral, valueLiteral)</c> takes effect only until
/// the end of the braced block in which it appears.
/// <para/>
/// The @@#inputFolder and @@#inputFileName properties (note: @@ is EC#
/// syntax for <see cref="Symbol"/>) are not normally stored in this collection;
/// when you use <see cref="ProcessSynchronously"/> or <see cref="ProcessParallel"/>,
/// @@#inputFolder and @@#inputFileName are set according to the folder and
/// filename in <see cref="InputOutput.FileName"/>. However, @@#inputFolder
/// is not set if the filename has no folder component, so this collection
/// could be used to provide a value of @@#inputFolder in that case.
/// </remarks>
public MMap<object, object> DefaultScopedProperties = new MMap<object, object>();
#region Adding macros from types (AddMacros())
public int AddMacros(Type type)
{
int found = 0;
foreach (var info in LeMP.MacroInfo.GetMacros(type, _sink)) {
found++;
AddMacro(_macros, info);
}
return found;
}
public int AddMacros(Assembly assembly, bool writeToSink = true)
{
int found = 0;
foreach (Type type in assembly.GetExportedTypes()) {
if (!type.IsGenericTypeDefinition &&
type.GetCustomAttributes(typeof(ContainsMacrosAttribute), true).Any())
{
if (writeToSink && Sink.IsEnabled(Severity.Verbose))
Sink.Write(Severity.Verbose, assembly.GetName().Name, "Adding macros in type '{0}'", type);
found += AddMacros(type);
}
}
if (found == 0 && writeToSink)
Sink.Warning(assembly, "No macros found");
return found;
}
static SymbolPool Wildcards = new SymbolPool();
internal static Symbol MatchEveryIdentifier = Wildcards.Get(nameof(MatchEveryIdentifier));
internal static Symbol MatchEveryCall = Wildcards.Get(nameof(MatchEveryCall));
internal static Symbol MatchEveryLiteral = Wildcards.Get(nameof(MatchEveryLiteral));
internal static void AddMacro(MMap<Symbol, InternalList<InternalMacroInfo>> macros, LeMP.MacroInfo newMacro)
{
if (newMacro?.Macro == null)
return; // TODO: should we throw? log an error?
if (newMacro.DeprecatedNames != null)
foreach (string name_ in newMacro.DeprecatedNames.WhereNotNull())
AddMacroByName(macros, (Symbol)name_, true, newMacro);
if (newMacro.Names != null)
foreach (string name_ in newMacro.Names.WhereNotNull())
AddMacroByName(macros, (Symbol)name_, false, newMacro);
if ((newMacro.Mode & MacroMode.MatchEveryCall) != 0)
AddMacroByName(macros, MatchEveryCall, false, newMacro);
if ((newMacro.Mode & MacroMode.MatchEveryIdentifier) != 0)
AddMacroByName(macros, MatchEveryIdentifier, false, newMacro);
if ((newMacro.Mode & MacroMode.MatchEveryLiteral) != 0)
AddMacroByName(macros, MatchEveryLiteral, false, newMacro);
}
private static void AddMacroByName(MMap<Symbol, InternalList<InternalMacroInfo>> macros, Symbol name, bool isDeprecatedName, MacroInfo newMacro)
{
var macrosWithThisName = macros[name, InternalList<InternalMacroInfo>.Empty];
// Check if the same macro was added earlier, possibly in a different namespace
foreach (var macro in macrosWithThisName)
{
if (macro.Macro.Equals(newMacro.Macro))
{
if (!macro.Namespaces.Select(p => p.A).Contains(newMacro.Namespace))
macro.Namespaces.Add(Pair.Create(newMacro.Namespace, isDeprecatedName));
return;
}
}
// It's a new macro, add it
var imi = new InternalMacroInfo
{
Name = name,
Attr = newMacro,
Macro = newMacro.Macro,
Namespaces = new InternalList<Pair<Symbol, bool>>(new [] { Pair.Create(newMacro.Namespace, isDeprecatedName) })
};
macrosWithThisName.Add(imi);
macros[name] = macrosWithThisName;
}
#endregion
/// <summary>Processes a list of nodes directly on the current thread.</summary>
/// <remarks>Note: <c>AbortTimeout</c> doesn't work when using this overload.</remarks>
public LNodeList ProcessSynchronously(LNodeList stmts)
{
return new MacroProcessorTask(this).ProcessRoot(stmts, _preOpenedNamespaces);
}
#region Batch processing: ProcessSynchronously, ProcessParallel, ProcessAsync
// TimeSpan.Zero or TimeSpan.MaxValue mean 'infinite' and prevent spawning a new thread
public TimeSpan AbortTimeout { get; set; }
/// <summary>Processes source files one at a time (may be easier for debugging).</summary>
public void ProcessSynchronously(IReadOnlyList<InputOutput> sourceFiles, Action<InputOutput> onProcessed = null)
{
foreach (var io in sourceFiles)
new MacroProcessorTask(this).ProcessFileWithThreadAbort(io, onProcessed, AbortTimeout);
}
/// <summary>Processes source files in parallel. All files are fully
/// processed before the method returns.</summary>
public void ProcessParallel(IReadOnlyList<InputOutput> sourceFiles, Action<InputOutput> onProcessed = null)
{
Task<LNodeList>[] tasks = ProcessAsync(sourceFiles, onProcessed);
for (int i = 0; i < tasks.Length; i++)
tasks[i].Wait();
}
/// <summary>Processes source files in parallel using .NET Tasks. The method returns immediately.</summary>
public Task<LNodeList>[] ProcessAsync(IReadOnlyList<InputOutput> sourceFiles, Action<InputOutput> onProcessed = null)
{
int parentThreadId = Thread.CurrentThread.ManagedThreadId;
Task<LNodeList>[] tasks = new Task<LNodeList>[sourceFiles.Count];
for (int i = 0; i < tasks.Length; i++)
{
var io = sourceFiles[i];
tasks[i] = System.Threading.Tasks.Task.Factory.StartNew<LNodeList>(() => {
using (ThreadEx.PropagateVariables(parentThreadId))
return new MacroProcessorTask(this).ProcessFileWithThreadAbort(io, onProcessed, AbortTimeout);
});
}
return tasks;
}
#endregion
[ThreadStatic]
internal static int _nextTempCounter;
/// <summary>Gets the next number to use as a suffix for temporary variables (without incrementing).</summary>
public static int NextTempCounter { get { return Math.Max(10, _nextTempCounter); } }
/// <summary>Gets the next number to use as a suffix for temporary variables, then increments it.</summary>
/// <remarks>MacroProcessor currently starts this counter at 10 to avoid
/// collisions with names like tmp_2 and tmp_3 that might be names chosen
/// by a developer; tmp_10 is much less likely to collide.</remarks>
public static int IncrementTempCounter() { _nextTempCounter = NextTempCounter; return _nextTempCounter++; }
}
/// <summary>A macro delegate with a list of namespaces and <see cref="LexicalMacroAttribute"/>.
/// The difference between this and the public class <see cref="LeMP.MacroInfo"/>
/// is that here the goal is to associate a list of namespaces with a a single
/// macro name (in case the macro is re-used in other namespaces) and the other
/// MacroInfo associates a single namespace with macro attributes that
/// potentially list multiple names.</summary>
internal class InternalMacroInfo
{
public Symbol Name;
public LexicalMacro Macro;
public LexicalMacroAttribute Attr;
// The boolean is true if the macro is deprecated in the given namespace
public InternalList<Pair<Symbol, bool>> Namespaces = InternalList<Pair<Symbol, bool>>.Empty;
public MacroMode Mode => Attr.Mode;
}
internal struct QualifiedMacroInfo
{
public InternalMacroInfo IMI;
public Symbol Namespace;
public bool IsDeprecated;
public MacroMode Mode => IMI.Attr.Mode;
public QualifiedMacroInfo(InternalMacroInfo imi, Symbol @namespace, bool deprecated)
{
IMI = imi;
Namespace = @namespace;
IsDeprecated = deprecated;
}
public static Comparison<QualifiedMacroInfo> CompareDescendingByPriority =
(a, b) => b.IMI.Attr.Priority.CompareTo(a.IMI.Attr.Priority);
}
}