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
|
// Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.vespa.hosted.node.admin.task.util.template;
import com.yahoo.vespa.hosted.node.admin.task.util.text.Cursor;
import com.yahoo.vespa.hosted.node.admin.task.util.text.CursorRange;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.function.Consumer;
/**
* The Java representation of a template text.
*
* <p>A template is a sequence of literal text and dynamic sections defined by %{...} directives:</p>
*
* <pre>
* template: section*
* section: literal | variable | list
* literal: plain text not containing %{
* variable: %{=identifier}
* list: %{list identifier}template%{end}
* identifier: a valid Java identifier
* </pre>
*
* <p>If the directive's end delimiter (}) is preceded by a "|" char, then any newline (\n)
* following the end delimiter is removed.</p>
*
* <p>To use the template, <b>Instantiate</b> it to get a form ({@link #instantiate()}), fill it (e.g.
* {@link Form#set(String, String) Form.set()}), and render the String ({@link Form#render()}).</p>
*
* <p>A form (like a template) has direct sections, and indirect sections in the body of direct list
* sections (recursively). The variables that can be set for a form, are the variables defined in
* either direct or indirect variable sections. Forms can only be added to direct list section in
* a form ({@link Form#add(String)}).</p>
*
* @see Form
* @see TemplateParser
* @see TemplateFile
* @author hakonhall
*/
public class Template {
private final Cursor start;
private final Cursor end;
private final List<Consumer<FormBuilder>> sections = new ArrayList<>();
/** The value contains the location of the name of a sample variable section (with that name). */
private final HashMap<String, Cursor> names = new HashMap<>();
public static Template from(String text) { return from(text, new TemplateDescriptor()); }
public static Template from(String text, TemplateDescriptor descriptor) {
return TemplateParser.parse(text, descriptor).template();
}
Template(Cursor start) {
this.start = new Cursor(start);
this.end = new Cursor(start);
}
public Form instantiate() { return instantiate(null); }
Form instantiate(Form parent) {
return FormBuilder.build(parent, range(), sections);
}
void appendLiteralSection(Cursor end) {
CursorRange range = verifyAndUpdateEnd(end);
sections.add((FormBuilder builder) -> builder.addLiteralSection(range));
}
void appendVariableSection(String name, Cursor nameOffset, Cursor end) {
CursorRange range = verifyAndUpdateEnd(end);
sections.add(formBuilder -> formBuilder.addVariableSection(range, name, nameOffset));
}
void appendListSection(String name, Cursor nameCursor, Cursor end, Template body) {
CursorRange range = verifyAndUpdateEnd(end);
verifyNewName(name, nameCursor);
sections.add(formBuilder -> formBuilder.addListSection(range, name, body));
}
private CursorRange range() { return new CursorRange(start, end); }
private CursorRange verifyAndUpdateEnd(Cursor newEnd) {
var range = new CursorRange(this.end, newEnd);
this.end.set(newEnd);
return range;
}
private void verifyNewName(String name, Cursor cursor) {
Cursor alreadyDefinedNameCursor = names.put(name, cursor);
if (alreadyDefinedNameCursor != null) {
throw new NameAlreadyExistsTemplateException(name, alreadyDefinedNameCursor, cursor);
}
}
}
|
