franta-hg@128
|
1 |
/**
|
franta-hg@128
|
2 |
* SQL-DK
|
franta-hg@128
|
3 |
* Copyright © 2014 František Kučera (frantovo.cz)
|
franta-hg@128
|
4 |
*
|
franta-hg@128
|
5 |
* This program is free software: you can redistribute it and/or modify
|
franta-hg@128
|
6 |
* it under the terms of the GNU General Public License as published by
|
franta-hg@128
|
7 |
* the Free Software Foundation, either version 3 of the License, or
|
franta-hg@128
|
8 |
* (at your option) any later version.
|
franta-hg@128
|
9 |
*
|
franta-hg@128
|
10 |
* This program is distributed in the hope that it will be useful,
|
franta-hg@128
|
11 |
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
franta-hg@128
|
12 |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
franta-hg@128
|
13 |
* GNU General Public License for more details.
|
franta-hg@128
|
14 |
*
|
franta-hg@128
|
15 |
* You should have received a copy of the GNU General Public License
|
franta-hg@128
|
16 |
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
franta-hg@128
|
17 |
*/
|
franta-hg@128
|
18 |
package info.globalcode.sql.dk.formatting;
|
franta-hg@128
|
19 |
|
franta-hg@128
|
20 |
import info.globalcode.sql.dk.ColorfulPrintWriter;
|
franta-hg@128
|
21 |
import info.globalcode.sql.dk.ColorfulPrintWriter.TerminalColor;
|
franta-hg@128
|
22 |
import java.util.Stack;
|
franta-hg@128
|
23 |
import javax.xml.namespace.QName;
|
franta-hg@128
|
24 |
import static info.globalcode.sql.dk.Functions.isEmpty;
|
franta-hg@128
|
25 |
import static info.globalcode.sql.dk.Functions.toHex;
|
franta-hg@128
|
26 |
import java.nio.charset.Charset;
|
franta-hg@128
|
27 |
import java.util.EmptyStackException;
|
franta-hg@128
|
28 |
import java.util.HashMap;
|
franta-hg@128
|
29 |
import java.util.LinkedHashMap;
|
franta-hg@128
|
30 |
import java.util.Map;
|
franta-hg@128
|
31 |
import java.util.Map.Entry;
|
franta-hg@128
|
32 |
import java.util.logging.Level;
|
franta-hg@128
|
33 |
import java.util.logging.Logger;
|
franta-hg@128
|
34 |
|
franta-hg@128
|
35 |
/**
|
franta-hg@155
|
36 |
* <p>
|
franta-hg@155
|
37 |
* Provides helper methods for printing pretty intended and optionally colorful (syntax highlighted)
|
franta-hg@155
|
38 |
* XML output.
|
franta-hg@155
|
39 |
* </p>
|
franta-hg@155
|
40 |
*
|
franta-hg@155
|
41 |
* <p>
|
franta-hg@155
|
42 |
* Must be used with care – bad usage can lead to invalid XML (e.g. using undeclared namespaces).
|
franta-hg@155
|
43 |
* </p>
|
franta-hg@128
|
44 |
*
|
franta-hg@128
|
45 |
* @author Ing. František Kučera (frantovo.cz)
|
franta-hg@128
|
46 |
*/
|
franta-hg@128
|
47 |
public abstract class AbstractXmlFormatter extends AbstractFormatter {
|
franta-hg@128
|
48 |
|
franta-hg@128
|
49 |
private static final Logger log = Logger.getLogger(AbstractXmlFormatter.class.getName());
|
franta-hg@128
|
50 |
public static final String PROPERTY_COLORFUL = "color";
|
franta-hg@128
|
51 |
public static final String PROPERTY_INDENT = "indent";
|
franta-hg@130
|
52 |
/**
|
franta-hg@130
|
53 |
* Whether text with line breaks should be indented (default). Otherwise original whitespace
|
franta-hg@130
|
54 |
* will be preserved.
|
franta-hg@130
|
55 |
*/
|
franta-hg@130
|
56 |
public static final String PROPERTY_INDENT_TEXT = "indentText";
|
franta-hg@128
|
57 |
private static final TerminalColor ELEMENT_COLOR = TerminalColor.Magenta;
|
franta-hg@128
|
58 |
private static final TerminalColor ATTRIBUTE_NAME_COLOR = TerminalColor.Green;
|
franta-hg@128
|
59 |
private static final TerminalColor ATTRIBUTE_VALUE_COLOR = TerminalColor.Yellow;
|
franta-hg@128
|
60 |
private static final TerminalColor XML_DECLARATION_COLOR = TerminalColor.Red;
|
franta-hg@136
|
61 |
private static final TerminalColor XML_DOCTYPE_COLOR = TerminalColor.Cyan;
|
franta-hg@128
|
62 |
private Stack<QName> treePosition = new Stack<>();
|
franta-hg@128
|
63 |
private final ColorfulPrintWriter out;
|
franta-hg@128
|
64 |
private final String indent;
|
franta-hg@130
|
65 |
private final boolean indentText;
|
franta-hg@128
|
66 |
|
franta-hg@128
|
67 |
public AbstractXmlFormatter(FormatterContext formatterContext) {
|
franta-hg@128
|
68 |
super(formatterContext);
|
franta-hg@128
|
69 |
boolean colorful = formatterContext.getProperties().getBoolean(PROPERTY_COLORFUL, false);
|
franta-hg@128
|
70 |
out = new ColorfulPrintWriter(formatterContext.getOutputStream(), false, colorful);
|
franta-hg@128
|
71 |
indent = formatterContext.getProperties().getString(PROPERTY_INDENT, "\t");
|
franta-hg@130
|
72 |
indentText = formatterContext.getProperties().getBoolean(PROPERTY_INDENT_TEXT, true);
|
franta-hg@128
|
73 |
|
franta-hg@128
|
74 |
if (!indent.matches("\\s*")) {
|
franta-hg@128
|
75 |
log.log(Level.WARNING, "Setting indent to „{0}“ is weird & freaky; in hex: {1}", new Object[]{indent, toHex(indent.getBytes())});
|
franta-hg@128
|
76 |
}
|
franta-hg@128
|
77 |
|
franta-hg@128
|
78 |
}
|
franta-hg@128
|
79 |
|
franta-hg@128
|
80 |
protected void printStartDocument() {
|
franta-hg@128
|
81 |
out.print(XML_DECLARATION_COLOR, "<?xml version=\"1.0\" encoding=\"" + Charset.defaultCharset().name() + "\"?>");
|
franta-hg@128
|
82 |
}
|
franta-hg@128
|
83 |
|
franta-hg@136
|
84 |
protected void printDoctype(String doctype) {
|
franta-hg@136
|
85 |
out.print(XML_DOCTYPE_COLOR, "\n<!DOCTYPE " + doctype + ">");
|
franta-hg@136
|
86 |
}
|
franta-hg@136
|
87 |
|
franta-hg@128
|
88 |
protected void printEndDocument() {
|
franta-hg@128
|
89 |
out.println();
|
franta-hg@128
|
90 |
out.flush();
|
franta-hg@128
|
91 |
if (!treePosition.empty()) {
|
franta-hg@128
|
92 |
throw new IllegalStateException("Some elements are not closed: " + treePosition);
|
franta-hg@128
|
93 |
}
|
franta-hg@128
|
94 |
}
|
franta-hg@128
|
95 |
|
franta-hg@128
|
96 |
protected void printStartElement(QName element) {
|
franta-hg@128
|
97 |
printStartElement(element, null);
|
franta-hg@128
|
98 |
}
|
franta-hg@128
|
99 |
|
franta-hg@128
|
100 |
protected Map<QName, String> singleAttribute(QName name, String value) {
|
franta-hg@152
|
101 |
Map<QName, String> attributes = new HashMap<>(2);
|
franta-hg@128
|
102 |
attributes.put(name, value);
|
franta-hg@128
|
103 |
return attributes;
|
franta-hg@128
|
104 |
}
|
franta-hg@128
|
105 |
|
franta-hg@128
|
106 |
protected void printStartElement(QName element, Map<QName, String> attributes) {
|
franta-hg@128
|
107 |
printStartElement(element, attributes, false);
|
franta-hg@128
|
108 |
}
|
franta-hg@128
|
109 |
|
franta-hg@128
|
110 |
/**
|
franta-hg@128
|
111 |
* @param empty whether element should be closed <codfe>… /></code> (has no content, do not
|
franta-hg@128
|
112 |
* call {@linkplain #printEndElement()})
|
franta-hg@128
|
113 |
*/
|
franta-hg@128
|
114 |
private void printStartElement(QName element, Map<QName, String> attributes, boolean empty) {
|
franta-hg@128
|
115 |
printIndent();
|
franta-hg@128
|
116 |
|
franta-hg@128
|
117 |
out.print(ELEMENT_COLOR, "<" + toString(element));
|
franta-hg@128
|
118 |
|
franta-hg@128
|
119 |
if (attributes != null) {
|
franta-hg@128
|
120 |
for (Entry<QName, String> attribute : attributes.entrySet()) {
|
franta-hg@128
|
121 |
out.print(" ");
|
franta-hg@128
|
122 |
out.print(ATTRIBUTE_NAME_COLOR, toString(attribute.getKey()));
|
franta-hg@128
|
123 |
out.print("=");
|
franta-hg@128
|
124 |
out.print(ATTRIBUTE_VALUE_COLOR, '"' + escapeXmlAttribute(attribute.getValue()) + '"');
|
franta-hg@128
|
125 |
}
|
franta-hg@128
|
126 |
}
|
franta-hg@128
|
127 |
|
franta-hg@128
|
128 |
if (empty) {
|
franta-hg@128
|
129 |
out.print(ELEMENT_COLOR, "/>");
|
franta-hg@128
|
130 |
} else {
|
franta-hg@128
|
131 |
out.print(ELEMENT_COLOR, ">");
|
franta-hg@128
|
132 |
treePosition.add(element);
|
franta-hg@128
|
133 |
}
|
franta-hg@128
|
134 |
|
franta-hg@128
|
135 |
out.flush();
|
franta-hg@128
|
136 |
}
|
franta-hg@128
|
137 |
|
franta-hg@128
|
138 |
/**
|
franta-hg@128
|
139 |
* Prints text node wrapped in given element without indenting the text and adding line breaks
|
franta-hg@128
|
140 |
* (useful for short texts).
|
franta-hg@128
|
141 |
*
|
franta-hg@128
|
142 |
* @param attributes use {@linkplain LinkedHashMap} to preserve attributes order
|
franta-hg@128
|
143 |
*/
|
franta-hg@128
|
144 |
protected void printTextElement(QName element, Map<QName, String> attributes, String text) {
|
franta-hg@128
|
145 |
printStartElement(element, attributes);
|
franta-hg@130
|
146 |
|
franta-hg@130
|
147 |
String[] lines = text.split("\\n");
|
franta-hg@130
|
148 |
|
franta-hg@130
|
149 |
if (indentText && lines.length > 1) {
|
franta-hg@130
|
150 |
for (String line : lines) {
|
franta-hg@130
|
151 |
printText(line, true);
|
franta-hg@130
|
152 |
}
|
franta-hg@130
|
153 |
printEndElement(true);
|
franta-hg@130
|
154 |
} else {
|
franta-hg@130
|
155 |
/*
|
franta-hg@130
|
156 |
* line breaks at the end of the text will be eaten – if you need them, use indentText = false
|
franta-hg@130
|
157 |
*/
|
franta-hg@132
|
158 |
if (lines.length == 1 && text.endsWith("\n")) {
|
franta-hg@132
|
159 |
text = text.substring(0, text.length() - 1);
|
franta-hg@132
|
160 |
}
|
franta-hg@132
|
161 |
|
franta-hg@132
|
162 |
printText(text, false);
|
franta-hg@130
|
163 |
printEndElement(false);
|
franta-hg@130
|
164 |
}
|
franta-hg@128
|
165 |
}
|
franta-hg@128
|
166 |
|
franta-hg@128
|
167 |
protected void printEmptyElement(QName element, Map<QName, String> attributes) {
|
franta-hg@128
|
168 |
printStartElement(element, attributes, true);
|
franta-hg@128
|
169 |
}
|
franta-hg@128
|
170 |
|
franta-hg@128
|
171 |
protected void printEndElement() {
|
franta-hg@128
|
172 |
printEndElement(true);
|
franta-hg@128
|
173 |
}
|
franta-hg@128
|
174 |
|
franta-hg@128
|
175 |
private void printEndElement(boolean indent) {
|
franta-hg@128
|
176 |
try {
|
franta-hg@128
|
177 |
QName name = treePosition.pop();
|
franta-hg@128
|
178 |
|
franta-hg@128
|
179 |
if (indent) {
|
franta-hg@128
|
180 |
printIndent();
|
franta-hg@128
|
181 |
}
|
franta-hg@128
|
182 |
|
franta-hg@128
|
183 |
out.print(ELEMENT_COLOR, "</" + toString(name) + ">");
|
franta-hg@128
|
184 |
out.flush();
|
franta-hg@128
|
185 |
|
franta-hg@128
|
186 |
} catch (EmptyStackException e) {
|
franta-hg@128
|
187 |
throw new IllegalStateException("No more elements to end.", e);
|
franta-hg@128
|
188 |
}
|
franta-hg@128
|
189 |
}
|
franta-hg@128
|
190 |
|
franta-hg@130
|
191 |
protected void printText(String s, boolean indent) {
|
franta-hg@128
|
192 |
if (indent) {
|
franta-hg@128
|
193 |
printIndent();
|
franta-hg@128
|
194 |
}
|
franta-hg@128
|
195 |
out.print(escapeXmlText(s));
|
franta-hg@128
|
196 |
out.flush();
|
franta-hg@128
|
197 |
}
|
franta-hg@128
|
198 |
|
franta-hg@128
|
199 |
protected void printIndent() {
|
franta-hg@128
|
200 |
out.println();
|
franta-hg@128
|
201 |
for (int i = 0; i < treePosition.size(); i++) {
|
franta-hg@128
|
202 |
out.print(indent);
|
franta-hg@128
|
203 |
}
|
franta-hg@128
|
204 |
}
|
franta-hg@128
|
205 |
|
franta-hg@128
|
206 |
protected static QName qname(String name) {
|
franta-hg@128
|
207 |
return new QName(name);
|
franta-hg@128
|
208 |
}
|
franta-hg@128
|
209 |
|
franta-hg@128
|
210 |
protected static QName qname(String prefix, String name) {
|
franta-hg@128
|
211 |
return new QName(null, name, prefix);
|
franta-hg@128
|
212 |
}
|
franta-hg@128
|
213 |
|
franta-hg@128
|
214 |
private String toString(QName name) {
|
franta-hg@128
|
215 |
if (isEmpty(name.getPrefix(), true)) {
|
franta-hg@128
|
216 |
return escapeName(name.getLocalPart());
|
franta-hg@128
|
217 |
} else {
|
franta-hg@128
|
218 |
return escapeName(name.getPrefix()) + ":" + escapeName(name.getLocalPart());
|
franta-hg@128
|
219 |
}
|
franta-hg@128
|
220 |
}
|
franta-hg@128
|
221 |
|
franta-hg@128
|
222 |
private String escapeName(String s) {
|
franta-hg@128
|
223 |
// TODO: avoid ugly values in <name name="…"/>
|
franta-hg@128
|
224 |
return s;
|
franta-hg@128
|
225 |
}
|
franta-hg@128
|
226 |
|
franta-hg@128
|
227 |
private static String escapeXmlText(String s) {
|
franta-hg@128
|
228 |
return s.replaceAll("&", "&").replaceAll("<", "<").replaceAll(">", ">");
|
franta-hg@128
|
229 |
// Not needed:
|
franta-hg@128
|
230 |
// return s.replaceAll("&", "&").replaceAll("<", "<").replaceAll(">", ">").replaceAll("\"", """).replaceAll("'", "'");
|
franta-hg@128
|
231 |
}
|
franta-hg@128
|
232 |
|
franta-hg@128
|
233 |
/**
|
franta-hg@128
|
234 |
* Expects attribute values enclosed in "quotes" not 'apostrophes'.
|
franta-hg@128
|
235 |
*/
|
franta-hg@128
|
236 |
private static String escapeXmlAttribute(String s) {
|
franta-hg@128
|
237 |
return s.replaceAll("&", "&").replaceAll("<", "<").replaceAll(">", ">").replaceAll("\"", """);
|
franta-hg@128
|
238 |
}
|
franta-hg@128
|
239 |
}
|