-
Notifications
You must be signed in to change notification settings - Fork 82
/
Interpreter.cs
1623 lines (1411 loc) · 59.8 KB
/
Interpreter.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
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* [The "BSD license"]
* Copyright (c) 2011 Terence Parr
* All rights reserved.
*
* Conversion to C#:
* Copyright (c) 2011 Sam Harwell, Tunnel Vision Laboratories, LLC
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. The name of the author may not be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
namespace Antlr4.StringTemplate
{
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.Linq;
using Antlr4.StringTemplate.Compiler;
using Antlr4.StringTemplate.Debug;
using Antlr4.StringTemplate.Extensions;
using Antlr4.StringTemplate.Misc;
using ArgumentNullException = System.ArgumentNullException;
using Array = System.Array;
using BitConverter = System.BitConverter;
using Console = System.Console;
using CultureInfo = System.Globalization.CultureInfo;
using Environment = System.Environment;
using Exception = System.Exception;
using ICollection = System.Collections.ICollection;
using IDictionary = System.Collections.IDictionary;
using IEnumerable = System.Collections.IEnumerable;
using IEnumerator = System.Collections.IEnumerator;
using IList = System.Collections.IList;
using IOException = System.IO.IOException;
using Math = System.Math;
using StringBuilder = System.Text.StringBuilder;
using StringWriter = System.IO.StringWriter;
/** This class knows how to execute template bytecodes relative to a
* particular TemplateGroup. To execute the byte codes, we need an output stream
* and a reference to an Template an instance. That instance's impl field points at
* a CompiledTemplate, which contains all of the byte codes and other information
* relevant to execution.
*
* This interpreter is a stack-based bytecode interpreter. All operands
* go onto an operand stack.
*
* If the group that we're executing relative to has debug set, we track
* interpreter events. For now, I am only tracking instance creation events.
* These are used by STViz to pair up output chunks with the template
* expressions that generate them.
*
* We create a new interpreter for each Template.Render(), DebugTemplate.Visualize, or
* DebugTemplate.GetEvents() invocation.
*/
public partial class Interpreter
{
public const int DefaultOperandStackSize = 512;
private static readonly string[] predefinedAnonSubtemplateAttributes = { "i", "i0" };
/** Dump bytecode instructions as we execute them? */
private static bool trace = false;
/** Exec st with respect to this group. Once set in Template.ToString(),
* it should be fixed. Template has group also.
*/
private readonly TemplateGroup group;
/** For renderers, we have to pass in the culture */
private readonly CultureInfo culture;
private readonly ErrorManager _errorManager;
/** Operand stack, grows upwards */
private object[] operands = new object[DefaultOperandStackSize];
private int sp = -1; // stack pointer register
private int nwline = 0; // how many char written on this template LINE so far?
/** If trace mode, track trace here */
// TODO: track the pieces not a string and track what it contributes to output
private List<string> executeTrace;
/** Track events inside templates and in this.events */
private bool _debug;
/** Track everything happening in interp if debug across all templates.
* The last event in this field is the EvalTemplateEvent for the root
* template.
*/
private List<InterpEvent> events;
public Interpreter(TemplateGroup group, bool debug)
: this(group, CultureInfo.CurrentCulture, group.ErrorManager, debug)
{
}
public Interpreter(TemplateGroup group, CultureInfo culture, bool debug)
: this(group, culture, group.ErrorManager, debug)
{
}
public Interpreter(TemplateGroup group, ErrorManager errorManager, bool debug)
: this(group, CultureInfo.CurrentCulture, errorManager, debug)
{
}
public Interpreter(TemplateGroup group, CultureInfo culture, ErrorManager errorManager, bool debug)
{
if (errorManager == null)
throw new ArgumentNullException("errorManager");
this.group = group;
this.culture = culture;
this._errorManager = errorManager;
this._debug = debug;
if (debug)
{
events = new List<InterpEvent>();
executeTrace = new List<string>();
}
}
public static ReadOnlyCollection<string> PredefinedAnonymousSubtemplateAttributes
{
get
{
return new ReadOnlyCollection<string>(predefinedAnonSubtemplateAttributes);
}
}
/** Execute template self and return how many characters it wrote to out */
public virtual int Execute(ITemplateWriter @out, TemplateFrame frame)
{
try
{
if (frame.StackDepth > 200)
throw new TemplateException("Template stack overflow.", null);
if (trace)
Console.Out.WriteLine("Execute({0})", frame.Template.Name);
SetDefaultArguments(frame);
return ExecuteImpl(@out, frame);
}
catch (Exception e)
{
if (e.IsCritical())
{
e.PreserveStackTrace();
throw;
}
StringBuilder builder = new StringBuilder();
builder.AppendLine(e.ToString());
builder.AppendLine(e.StackTrace);
_errorManager.RuntimeError(frame, ErrorType.INTERNAL_ERROR, "internal error: " + builder);
return 0;
}
}
protected virtual int ExecuteImpl(ITemplateWriter @out, TemplateFrame frame)
{
Template self = frame.Template;
int start = @out.Index; // track char we're about to Write
Bytecode prevOpcode = Bytecode.Invalid;
int n = 0; // how many char we Write out
int nargs;
int nameIndex;
int addr;
string name;
object o, left, right;
Template st;
object[] options;
byte[] code = self.impl.instrs; // which code block are we executing
int ip = 0;
while (ip < self.impl.codeSize)
{
if (trace || _debug)
Trace(frame, ip);
Bytecode opcode = (Bytecode)code[ip];
frame.InstructionPointer = ip;
ip++; //jump to next instruction or first byte of operand
switch (opcode)
{
case Bytecode.INSTR_LOAD_STR:
int strIndex = GetShort(code, ip);
ip += Instruction.OperandSizeInBytes;
operands[++sp] = self.impl.strings[strIndex];
break;
case Bytecode.INSTR_LOAD_ATTR:
nameIndex = GetShort(code, ip);
ip += Instruction.OperandSizeInBytes;
name = self.impl.strings[nameIndex];
try
{
o = GetAttribute(frame, name);
if (o == Template.EmptyAttribute)
o = null;
}
catch (AttributeNotFoundException)
{
_errorManager.RuntimeError(frame, ErrorType.NO_SUCH_ATTRIBUTE, name);
o = null;
}
operands[++sp] = o;
break;
case Bytecode.INSTR_LOAD_LOCAL:
int valueIndex = GetShort(code, ip);
ip += Instruction.OperandSizeInBytes;
o = self.locals[valueIndex];
if (o == Template.EmptyAttribute)
o = null;
operands[++sp] = o;
break;
case Bytecode.INSTR_LOAD_PROP:
nameIndex = GetShort(code, ip);
ip += Instruction.OperandSizeInBytes;
o = operands[sp--];
name = self.impl.strings[nameIndex];
operands[++sp] = GetObjectProperty(frame, o, name);
break;
case Bytecode.INSTR_LOAD_PROP_IND:
object propName = operands[sp--];
o = operands[sp];
operands[sp] = GetObjectProperty(frame, o, propName);
break;
case Bytecode.INSTR_NEW:
nameIndex = GetShort(code, ip);
ip += Instruction.OperandSizeInBytes;
name = self.impl.strings[nameIndex];
nargs = GetShort(code, ip);
ip += Instruction.OperandSizeInBytes;
// look up in original hierarchy not enclosing template (variable group)
// see TestSubtemplates.testEvalSTFromAnotherGroup()
st = self.Group.GetEmbeddedInstanceOf(frame, name);
// get n args and store into st's attr list
StoreArguments(frame, nargs, st);
sp -= nargs;
operands[++sp] = st;
break;
case Bytecode.INSTR_NEW_IND:
nargs = GetShort(code, ip);
ip += Instruction.OperandSizeInBytes;
name = (string)operands[sp - nargs];
st = self.Group.GetEmbeddedInstanceOf(frame, name);
StoreArguments(frame, nargs, st);
sp -= nargs;
sp--; // pop template name
operands[++sp] = st;
break;
case Bytecode.INSTR_NEW_BOX_ARGS:
nameIndex = GetShort(code, ip);
ip += Instruction.OperandSizeInBytes;
name = self.impl.strings[nameIndex];
IDictionary<string, object> attrs = (IDictionary<string, object>)operands[sp--];
// look up in original hierarchy not enclosing template (variable group)
// see TestSubtemplates.testEvalSTFromAnotherGroup()
st = self.Group.GetEmbeddedInstanceOf(frame, name);
// get n args and store into st's attr list
StoreArguments(frame, attrs, st);
operands[++sp] = st;
break;
case Bytecode.INSTR_SUPER_NEW:
nameIndex = GetShort(code, ip);
ip += Instruction.OperandSizeInBytes;
name = self.impl.strings[nameIndex];
nargs = GetShort(code, ip);
ip += Instruction.OperandSizeInBytes;
SuperNew(frame, name, nargs);
break;
case Bytecode.INSTR_SUPER_NEW_BOX_ARGS:
nameIndex = GetShort(code, ip);
ip += Instruction.OperandSizeInBytes;
name = self.impl.strings[nameIndex];
attrs = (IDictionary<string, object>)operands[sp--];
SuperNew(frame, name, attrs);
break;
case Bytecode.INSTR_STORE_OPTION:
int optionIndex = GetShort(code, ip);
ip += Instruction.OperandSizeInBytes;
o = operands[sp--]; // value to store
options = (object[])operands[sp]; // get options
options[optionIndex] = o; // store value into options on stack
break;
case Bytecode.INSTR_STORE_ARG:
nameIndex = GetShort(code, ip);
name = self.impl.strings[nameIndex];
ip += Instruction.OperandSizeInBytes;
o = operands[sp--];
attrs = (IDictionary<string, object>)operands[sp];
attrs[name] = o; // leave attrs on stack
break;
case Bytecode.INSTR_WRITE:
o = operands[sp--];
int n1 = WriteObjectNoOptions(@out, frame, o);
n += n1;
nwline += n1;
break;
case Bytecode.INSTR_WRITE_OPT:
options = (object[])operands[sp--]; // get options
o = operands[sp--]; // get option to Write
int n2 = WriteObjectWithOptions(@out, frame, o, options);
n += n2;
nwline += n2;
break;
case Bytecode.INSTR_MAP:
st = (Template)operands[sp--]; // get prototype off stack
o = operands[sp--]; // get object to map prototype across
Map(frame, o, st);
break;
case Bytecode.INSTR_ROT_MAP:
int nmaps = GetShort(code, ip);
ip += Instruction.OperandSizeInBytes;
List<Template> templates = new List<Template>();
for (int i = nmaps - 1; i >= 0; i--)
templates.Add((Template)operands[sp - i]);
sp -= nmaps;
o = operands[sp--];
if (o != null)
RotateMap(frame, o, templates);
break;
case Bytecode.INSTR_ZIP_MAP:
st = (Template)operands[sp--];
nmaps = GetShort(code, ip);
ip += Instruction.OperandSizeInBytes;
List<object> exprs = new List<object>();
for (int i = nmaps - 1; i >= 0; i--)
exprs.Add(operands[sp - i]);
sp -= nmaps;
operands[++sp] = ZipMap(frame, exprs, st);
break;
case Bytecode.INSTR_BR:
ip = GetShort(code, ip);
break;
case Bytecode.INSTR_BRF:
addr = GetShort(code, ip);
ip += Instruction.OperandSizeInBytes;
o = operands[sp--]; // <if(expr)>...<endif>
if (!TestAttributeTrue(o))
ip = addr; // jump
break;
case Bytecode.INSTR_OPTIONS:
operands[++sp] = new object[Compiler.TemplateCompiler.NUM_OPTIONS];
break;
case Bytecode.INSTR_ARGS:
operands[++sp] = new Dictionary<string, object>();
break;
case Bytecode.INSTR_PASSTHRU:
nameIndex = GetShort(code, ip);
ip += Instruction.OperandSizeInBytes;
name = self.impl.strings[nameIndex];
attrs = (IDictionary<string, object>)operands[sp];
PassThrough(frame, name, attrs);
break;
case Bytecode.INSTR_LIST:
operands[++sp] = new List<object>();
break;
case Bytecode.INSTR_ADD:
o = operands[sp--]; // pop value
List<object> list = (List<object>)operands[sp]; // don't pop list
AddToList(list, frame, o);
break;
case Bytecode.INSTR_TOSTR:
// replace with string value; early eval
operands[sp] = ToString(frame, operands[sp]);
break;
case Bytecode.INSTR_FIRST:
operands[sp] = First(frame, operands[sp]);
break;
case Bytecode.INSTR_LAST:
operands[sp] = Last(frame, operands[sp]);
break;
case Bytecode.INSTR_REST:
operands[sp] = Rest(frame, operands[sp]);
break;
case Bytecode.INSTR_TRUNC:
operands[sp] = Trunc(frame, operands[sp]);
break;
case Bytecode.INSTR_STRIP:
operands[sp] = Strip(frame, operands[sp]);
break;
case Bytecode.INSTR_TRIM:
o = operands[sp--];
if (o.GetType() == typeof(string))
{
operands[++sp] = ((string)o).Trim();
}
else
{
_errorManager.RuntimeError(frame, ErrorType.EXPECTING_STRING, "trim", o.GetType());
operands[++sp] = o;
}
break;
case Bytecode.INSTR_LENGTH:
operands[sp] = Length(operands[sp]);
break;
case Bytecode.INSTR_STRLEN:
o = operands[sp--];
if (o.GetType() == typeof(string))
{
operands[++sp] = ((string)o).Length;
}
else
{
_errorManager.RuntimeError(frame, ErrorType.EXPECTING_STRING, "strlen", o.GetType());
operands[++sp] = 0;
}
break;
case Bytecode.INSTR_REVERSE:
operands[sp] = Reverse(frame, operands[sp]);
break;
case Bytecode.INSTR_NOT:
operands[sp] = !TestAttributeTrue(operands[sp]);
break;
case Bytecode.INSTR_OR:
right = operands[sp--];
left = operands[sp--];
operands[++sp] = TestAttributeTrue(left) || TestAttributeTrue(right);
break;
case Bytecode.INSTR_AND:
right = operands[sp--];
left = operands[sp--];
operands[++sp] = TestAttributeTrue(left) && TestAttributeTrue(right);
break;
case Bytecode.INSTR_INDENT:
strIndex = GetShort(code, ip);
ip += Instruction.OperandSizeInBytes;
Indent(@out, frame, strIndex);
break;
case Bytecode.INSTR_DEDENT:
@out.PopIndentation();
break;
case Bytecode.INSTR_NEWLINE:
try
{
if (prevOpcode == Bytecode.INSTR_NEWLINE ||
prevOpcode == Bytecode.INSTR_INDENT ||
nwline > 0)
{
@out.Write(Environment.NewLine);
}
nwline = 0;
}
catch (IOException ioe)
{
_errorManager.IOError(self, ErrorType.WRITE_IO_ERROR, ioe);
}
break;
case Bytecode.INSTR_NOOP:
break;
case Bytecode.INSTR_POP:
sp--; // throw away top of stack
break;
case Bytecode.INSTR_NULL:
operands[++sp] = null;
break;
case Bytecode.INSTR_TRUE:
operands[++sp] = true;
break;
case Bytecode.INSTR_FALSE:
operands[++sp] = false;
break;
case Bytecode.INSTR_WRITE_STR:
strIndex = GetShort(code, ip);
ip += Instruction.OperandSizeInBytes;
o = self.impl.strings[strIndex];
n1 = WriteObjectNoOptions(@out, frame, o);
n += n1;
nwline += n1;
break;
// TODO: generate this optimization
//case Bytecode.INSTR_WRITE_LOCAL:
// valueIndex = GetShort(code, ip);
// ip += Instruction.OperandSizeInBytes;
// o = self.locals[valueIndex];
// if (o == Template.EmptyAttribute)
// o = null;
// n1 = WriteObjectNoOptions(@out, frame, o);
// n += n1;
// nwline += n1;
// break;
default:
_errorManager.InternalError(self, "invalid bytecode @ " + (ip - 1) + ": " + opcode, null);
self.impl.Dump();
break;
}
prevOpcode = opcode;
}
if (_debug)
{
EvalTemplateEvent e = new EvalTemplateEvent(frame, Interval.FromBounds(start, @out.Index));
TrackDebugEvent(frame, e);
}
return n;
}
// TODO: refactor to Remove dup'd code
internal virtual void SuperNew(TemplateFrame frame, string name, int nargs)
{
Template self = frame.Template;
Template st = null;
CompiledTemplate imported = self.impl.NativeGroup.LookupImportedTemplate(name);
if (imported == null)
{
_errorManager.RuntimeError(frame, ErrorType.NO_IMPORTED_TEMPLATE, name);
st = self.Group.CreateStringTemplateInternally(new CompiledTemplate());
}
else
{
st = imported.NativeGroup.GetEmbeddedInstanceOf(frame, name);
st.Group = group;
}
// get n args and store into st's attr list
StoreArguments(frame, nargs, st);
sp -= nargs;
operands[++sp] = st;
}
internal virtual void SuperNew(TemplateFrame frame, string name, IDictionary<string, object> attrs)
{
Template self = frame.Template;
Template st = null;
CompiledTemplate imported = self.impl.NativeGroup.LookupImportedTemplate(name);
if (imported == null)
{
_errorManager.RuntimeError(frame, ErrorType.NO_IMPORTED_TEMPLATE, name);
st = self.Group.CreateStringTemplateInternally(new CompiledTemplate());
}
else
{
st = imported.NativeGroup.CreateStringTemplateInternally(imported);
st.Group = group;
}
// get n args and store into st's attr list
StoreArguments(frame, attrs, st);
operands[++sp] = st;
}
internal virtual void PassThrough(TemplateFrame frame, string templateName, IDictionary<string, object> attrs)
{
CompiledTemplate c = group.LookupTemplate(templateName);
if (c == null)
return; // will get error later
if (c.FormalArguments == null)
return;
foreach (FormalArgument arg in c.FormalArguments)
{
// if not already set by user, set to value from outer scope
if (!attrs.ContainsKey(arg.Name))
{
//System.out.println("arg "+arg.name+" missing");
try
{
object o = GetAttribute(frame, arg.Name);
// If the attribute exists but there is no value and
// the formal argument has no default value, make it null.
if (o == Template.EmptyAttribute && arg.DefaultValueToken == null)
{
attrs[arg.Name] = null;
}
// Else, the attribute has an existing value, set arg.
else if (o != Template.EmptyAttribute)
{
attrs[arg.Name] = o;
}
}
catch (AttributeNotFoundException)
{
// if no such attribute exists for arg.name, set parameter
// if no default value
if (arg.DefaultValueToken == null)
{
_errorManager.RuntimeError(frame, ErrorType.NO_SUCH_ATTRIBUTE_PASS_THROUGH, arg.Name);
attrs[arg.Name] = null;
}
}
}
}
}
internal virtual void StoreArguments(TemplateFrame frame, IDictionary<string, object> attrs, Template st)
{
if (attrs != null && attrs.Count > 0 &&
!st.impl.HasFormalArgs && st.impl.FormalArguments == null)
{
st.Add(Template.ImplicitArgumentName, null); // pretend we have "it" arg
}
int nformalArgs = 0;
if (st.impl.FormalArguments != null)
nformalArgs = st.impl.FormalArguments.Count;
int nargs = 0;
if (attrs != null)
nargs = attrs.Count;
if (nargs < (nformalArgs - st.impl.NumberOfArgsWithDefaultValues) || nargs > nformalArgs)
{
_errorManager.RuntimeError(frame,
ErrorType.ARGUMENT_COUNT_MISMATCH,
nargs,
st.impl.Name,
nformalArgs);
}
foreach (string argName in attrs.Keys)
{
// don't let it throw an exception in RawSetAttribute
if (st.impl.FormalArguments == null || !st.impl.FormalArguments.Exists(i => i.Name == argName))
{
_errorManager.RuntimeError(frame, ErrorType.NO_SUCH_ATTRIBUTE, argName);
continue;
}
object o = attrs[argName];
st.RawSetAttribute(argName, o);
}
}
internal virtual void StoreArguments(TemplateFrame frame, int nargs, Template st)
{
if (nargs > 0 && !st.impl.HasFormalArgs && st.impl.FormalArguments == null)
{
st.Add(Template.ImplicitArgumentName, null); // pretend we have "it" arg
}
int nformalArgs = 0;
if (st.impl.FormalArguments != null)
nformalArgs = st.impl.FormalArguments.Count;
int firstArg = sp - (nargs - 1);
int numToStore = Math.Min(nargs, nformalArgs);
if (st.impl.IsAnonSubtemplate)
nformalArgs -= predefinedAnonSubtemplateAttributes.Length;
if (nargs < (nformalArgs - st.impl.NumberOfArgsWithDefaultValues) ||
nargs > nformalArgs)
{
_errorManager.RuntimeError(frame,
ErrorType.ARGUMENT_COUNT_MISMATCH,
nargs,
st.impl.Name,
nformalArgs);
}
if (st.impl.FormalArguments == null)
return;
for (int i = 0; i < numToStore; i++)
{
object o = operands[firstArg + i];
string argName = st.impl.FormalArguments[i].Name;
st.RawSetAttribute(argName, o);
}
}
protected void Indent(ITemplateWriter @out, TemplateFrame frame, int strIndex)
{
Template self = frame.Template;
string indent = self.impl.strings[strIndex];
if (_debug)
{
int start = @out.Index; // track char we're about to write
EvalExprEvent e = new IndentEvent(frame, new Interval(start, indent.Length), GetExpressionInterval(frame));
TrackDebugEvent(frame, e);
}
@out.PushIndentation(indent);
}
/** Write out an expression result that doesn't use expression options.
* E.g., <name>
*/
protected virtual int WriteObjectNoOptions(ITemplateWriter @out, TemplateFrame frame, object o)
{
int start = @out.Index; // track char we're about to Write
int n = WriteObject(@out, frame, o, null);
if (_debug)
{
Interval templateLocation = frame.Template.impl.sourceMap[frame.InstructionPointer];
EvalExprEvent e = new EvalExprEvent(frame, Interval.FromBounds(start, @out.Index), templateLocation);
TrackDebugEvent(frame, e);
}
return n;
}
/** Write out an expression result that uses expression options.
* E.g., <names; separator=", ">
*/
protected virtual int WriteObjectWithOptions(ITemplateWriter @out, TemplateFrame frame, object o, object[] options)
{
int start = @out.Index; // track char we're about to Write
// precompute all option values (Render all the way to strings)
string[] optionStrings = null;
if (options != null)
{
optionStrings = new string[options.Length];
for (int i = 0; i < Compiler.TemplateCompiler.NUM_OPTIONS; i++)
{
optionStrings[i] = ToString(frame, options[i]);
}
}
if (options != null && options[(int)RenderOption.Anchor] != null)
{
@out.PushAnchorPoint();
}
int n = WriteObject(@out, frame, o, optionStrings);
if (options != null && options[(int)RenderOption.Anchor] != null)
{
@out.PopAnchorPoint();
}
if (_debug)
{
Interval templateLocation = frame.Template.impl.sourceMap[frame.InstructionPointer];
EvalExprEvent e = new EvalExprEvent(frame, Interval.FromBounds(start, @out.Index), templateLocation);
TrackDebugEvent(frame, e);
}
return n;
}
/** Generic method to emit text for an object. It differentiates
* between templates, iterable objects, and plain old Java objects (POJOs)
*/
protected virtual int WriteObject(ITemplateWriter @out, TemplateFrame frame, object o, string[] options)
{
int n = 0;
if (o == null)
{
if (options != null && options[(int)RenderOption.Null] != null)
o = options[(int)RenderOption.Null];
else
return 0;
}
ITypeProxyFactory proxyFactory = frame.Template.Group.GetTypeProxyFactory(o.GetType());
if (proxyFactory != null)
o = proxyFactory.CreateProxy(frame, o);
System.Diagnostics.Debug.Assert(!(o is TemplateFrame));
Template template = o as Template;
if (template != null)
{
frame = new TemplateFrame(template, frame);
if (options != null && options[(int)RenderOption.Wrap] != null)
{
// if we have a wrap string, then inform writer it
// might need to wrap
try
{
@out.WriteWrap(options[(int)RenderOption.Wrap]);
}
catch (IOException ioe)
{
_errorManager.IOError(template, ErrorType.WRITE_IO_ERROR, ioe);
}
}
n = Execute(@out, frame);
}
else
{
o = ConvertAnythingIteratableToIterator(frame, o); // normalize
try
{
if (o is IEnumerator)
n = WriteIterator(@out, frame, o, options);
else
n = WritePlainObject(@out, frame, o, options);
}
catch (IOException ioe)
{
_errorManager.IOError(frame.Template, ErrorType.WRITE_IO_ERROR, ioe, o);
}
}
return n;
}
protected virtual int WriteIterator(ITemplateWriter @out, TemplateFrame frame, object o, string[] options)
{
if (o == null)
return 0;
int n = 0;
IEnumerator it = (IEnumerator)o;
string separator = null;
if (options != null)
separator = options[(int)RenderOption.Separator];
bool seenAValue = false;
while (it.MoveNext())
{
object iterValue = it.Current;
// Emit separator if we're beyond first value
bool needSeparator = seenAValue &&
separator != null && // we have a separator and
(iterValue != null || // either we have a value
options[(int)RenderOption.Null] != null); // or no value but null option
if (needSeparator)
n += @out.WriteSeparator(separator);
int nw = WriteObject(@out, frame, iterValue, options);
if (nw > 0)
seenAValue = true;
n += nw;
}
return n;
}
protected virtual int WritePlainObject(ITemplateWriter @out, TemplateFrame frame, object o, string[] options)
{
string formatString = null;
if (options != null)
formatString = options[(int)RenderOption.Format];
IAttributeRenderer r = frame.Template.impl.NativeGroup.GetAttributeRenderer(o.GetType());
string v;
if (r != null)
{
v = r.ToString(o, formatString, culture);
}
else
{
if (o is bool)
v = (bool)o ? "true" : "false";
else if (o is bool? && ((bool?)o).HasValue)
v = ((bool?)o).Value ? "true" : "false";
else
v = o.ToString();
}
int n;
if (options != null && options[(int)RenderOption.Wrap] != null)
{
n = @out.Write(v, options[(int)RenderOption.Wrap]);
}
else
{
n = @out.Write(v);
}
return n;
}
protected virtual Interval GetExpressionInterval(TemplateFrame frame)
{
return frame.Template.impl.sourceMap[frame.InstructionPointer];
}
protected virtual void Map(TemplateFrame frame, object attr, Template st)
{
RotateMap(frame, attr, new List<Template>() { st });
}
// <names:a()> or <names:a(),b()>
protected virtual void RotateMap(TemplateFrame frame, object attr, List<Template> prototypes)
{
if (attr == null)
{
operands[++sp] = null;
return;
}
attr = ConvertAnythingIteratableToIterator(frame, attr);
IEnumerator iterator = attr as IEnumerator;
if (iterator != null)
{
List<Template> mapped = RotateMapIterator(frame, iterator, prototypes);
operands[++sp] = mapped;
}
else
{
// if only single value, just apply first template to sole value
Template proto = prototypes[0];
Template st = group.CreateStringTemplateInternally(proto);
if (st != null)
{
SetFirstArgument(frame, st, attr);
if (st.impl.IsAnonSubtemplate)
{
st.RawSetAttribute("i0", 0);
st.RawSetAttribute("i", 1);
}
operands[++sp] = st;
}
else
{
operands[++sp] = null;
}
}
}
protected virtual List<Template> RotateMapIterator(TemplateFrame frame, IEnumerator iterator, List<Template> prototypes)
{
List<Template> mapped = new List<Template>();
int i0 = 0;
int i = 1;
int ti = 0;
while (iterator.MoveNext())
{
object iterValue = iterator.Current;
if (iterValue == null)
{
mapped.Add(null);
continue;
}
int templateIndex = ti % prototypes.Count; // rotate through
ti++;
Template proto = prototypes[templateIndex];
Template st = group.CreateStringTemplateInternally(proto);
SetFirstArgument(frame, st, iterValue);
if (st.impl.IsAnonSubtemplate)
{
st.RawSetAttribute("i0", i0);
st.RawSetAttribute("i", i);
}
mapped.Add(st);