org.attoparser.prettyhtml.PrettyHtmlMarkupHandler Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of attoparser Show documentation
Show all versions of attoparser Show documentation
Powerful, fast and easy to use HTML and XML parser for Java
/*
* =============================================================================
*
* Copyright (c) 2012-2014, The ATTOPARSER team (http://www.attoparser.org)
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* =============================================================================
*/
package org.attoparser.prettyhtml;
import java.io.IOException;
import java.io.Writer;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;
import org.attoparser.AbstractMarkupHandler;
import org.attoparser.ParseException;
/**
*
* Implementation of {@link org.attoparser.IMarkupHandler} used for pretty-printing the result of parsing
* the input markup.
*
*
* This handler will write, to the passed {@link java.io.Writer}, an HTML document which will display in a
* visually-useful form the markup output corresponding with the parsing events that reach it.
*
*
* This markup visualization will allow to easily identify elements, attributes, comments... but also those
* auto* events that were required to balance the code (depending on configuration) and any unmatched
* close elements that might be found in input.
*
*
* Note that, as with most handlers, this class is not thread-safe. Also, instances of this class
* should not be reused across parsing operations.
*
*
* Sample usage:
*
*
* final Writer writer = new StringWriter();
* final IMarkupHandler handler = new PrettyHtmlMarkupHandler("Some test document", writer);
* parser.parse(document, handler);
* return writer.toString();
*
*
* @author Daniel Fernández
*
* @since 2.0.0
*
*/
public class PrettyHtmlMarkupHandler extends AbstractMarkupHandler {
private static final String OPEN_TAG_START = "<";
private static final String OPEN_TAG_END = ">";
private static final String CLOSE_TAG_START = "</";
private static final String CLOSE_TAG_END = ">";
private static final String MINIMIZED_TAG_END = "/>";
private static final String DOCUMENT_STYLES = "\n" +
"body {\n" +
" font-family: 'Bitstream Vera Sans Mono', 'Courier New', Courier, monospace;\n" +
" font-size: 13px;\n" +
" background: rgb(53, 39, 38);\n" +
"}\n";
private static final String FRAGMENT_STYLES = "\n" +
"@@ .element {\n" +
" color: #8bd1ff;\n" +
"}\n" +
"@@ .element-auto {\n" +
" color: yellow;\n" +
"}\n" +
"@@ .element-unmatched {\n" +
" color: red;\n" +
"}\n" +
"@@ .attr-name {\n" +
" font-weight: normal;\n" +
" color: white;\n" +
"}\n" +
"@@ .attr-value {\n" +
" font-weight: normal;\n" +
" color: #99cc33;\n" +
"}\n" +
"@@ .doctype {\n" +
" font-weight: bold;\n" +
" font-style: italics;\n" +
" color: #8bd1ff;\n" +
"}\n" +
"@@ .comment {\n" +
" font-style: italic;\n" +
" color: #b58900;\n" +
"}\n" +
"@@ .cdata {\n" +
" font-style: italic;\n" +
" color: #b58900;\n" +
"}\n" +
"@@ .xml-declaration {\n" +
" font-weight: bold;\n" +
" color: olivedrab;\n" +
"}\n" +
"@@ .processing-instruction {\n" +
" color: white;\n" +
" background: black;\n" +
"}\n" +
"@@ .text {\n" +
" color: #b9bdb6;\n" +
"}\n" +
"\n";
private static final String STYLE_DOCTYPE = "doctype";
private static final String STYLE_COMMENT = "comment";
private static final String STYLE_CDATA = "cdata";
private static final String STYLE_XML_DECLARATION = "xml-declaration";
private static final String STYLE_PROCESSING_INSTRUCTION = "processing-instruction";
private static final String STYLE_ELEMENT = "element";
private static final String STYLE_ELEMENT_AUTO = "element-auto";
private static final String STYLE_ELEMENT_UNMATCHED = "element-unmatched";
private static final String STYLE_ATTR_NAME = "attr-name";
private static final String STYLE_ATTR_VALUE = "attr-value";
private static final String STYLE_TEXT = "text";
private static final String TAG_FORMAT_START = "";
private static final String TAG_FORMAT_END = "";
private final String documentName;
private final String documentId;
private final Writer writer;
/**
*
* Creates a new instance of this handler.
*
*
* @param writer the writer to which output will be written.
*/
public PrettyHtmlMarkupHandler(final Writer writer) {
this(null, writer);
}
/**
*
* Creates a new instance of this handler.
*
*
* @param documentName the name of the parsed document (will appear in the title).
* @param writer the writer to which output will be written.
*/
public PrettyHtmlMarkupHandler(final String documentName, final Writer writer) {
super();
if (writer == null) {
throw new IllegalArgumentException("Writer cannot be null");
}
this.documentName =
(documentName == null?
String.valueOf(System.identityHashCode(this)) : documentName);
this.documentId = tokenify(this.documentName);
this.writer = writer;
}
private void writeEscaped(final char[] buffer, final int offset, final int len) throws IOException {
final int maxi = offset + len;
for (int i = offset; i < maxi; i++) {
final char c = buffer[i];
if (c == '\n') {
this.writer.write("
");
} else if (c == ' ') {
this.writer.write(" ");
} else if (c == '\t') {
this.writer.write(" ");
} else if (c == '<') {
this.writer.write("<");
} else if (c == '>') {
this.writer.write(">");
} else if (c == '&') {
this.writer.write("&");
} else if (c == '\"') {
this.writer.write(""");
} else if (c == '\'') {
this.writer.write("'");
} else {
this.writer.write(c);
}
}
}
private void openStyle(final String style) throws IOException {
openStyles(Collections.singletonList(style));
}
private void openStyles(final List styles) throws IOException {
final StringBuilder strBuilder = new StringBuilder();
final Iterator stylesIter = styles.iterator();
strBuilder.append(stylesIter.next());
while (stylesIter.hasNext()) {
strBuilder.append(' ');
strBuilder.append(stylesIter.next());
}
this.writer.write(String.format(TAG_FORMAT_START, strBuilder.toString()));
}
private void closeStyle() throws IOException {
this.writer.write(TAG_FORMAT_END);
}
public String tokenify(final String text) {
final StringBuilder strBuilder = new StringBuilder();
for (int i = 0; i < text.length(); i++) {
final char c = text.charAt(i);
if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z') || (c >= '0' && c <= '9')) {
strBuilder.append(c);
}
}
return strBuilder.toString();
}
@Override
public void handleDocumentStart(final long startTimeNanos,
final int line, final int col)
throws ParseException {
try {
this.writer.write("\n");
this.writer.write("\n");
this.writer.write("\n");
this.writer.write("Parser output: " + this.documentName + " \n");
this.writer.write("\n");
this.writer.write("\n");
this.writer.write("\n");
this.writer.write("\n");
this.writer.write("\n");
this.writer.write("");
} catch (final Exception e) {
throw new ParseException(e);
}
}
@Override
public void handleDocumentEnd(final long endTimeNanos, final long totalTimeNanos,
final int line, final int col)
throws ParseException {
try {
this.writer.write("");
this.writer.write("\n");
this.writer.write("\n");
} catch (final Exception e) {
throw new ParseException(e);
}
}
@Override
public void handleStandaloneElementStart(
final char[] buffer,
final int nameOffset, final int nameLen,
final boolean minimized,
final int line, final int col)
throws ParseException {
try {
openStyle(STYLE_ELEMENT);
this.writer.write(OPEN_TAG_START);
this.writer.write(buffer, nameOffset, nameLen);
} catch (final Exception e) {
throw new ParseException(e);
}
}
@Override
public void handleStandaloneElementEnd(
final char[] buffer,
final int nameOffset, final int nameLen,
final boolean minimized,
final int line, final int col)
throws ParseException {
try {
this.writer.write((minimized? MINIMIZED_TAG_END : OPEN_TAG_END));
closeStyle();
} catch (final Exception e) {
throw new ParseException(e);
}
}
@Override
public void handleOpenElementStart(
final char[] buffer,
final int nameOffset, final int nameLen,
final int line, final int col)
throws ParseException {
try {
openStyle(STYLE_ELEMENT);
this.writer.write(OPEN_TAG_START);
this.writer.write(buffer, nameOffset, nameLen);
} catch (final Exception e) {
throw new ParseException(e);
}
}
@Override
public void handleOpenElementEnd(
final char[] buffer,
final int nameOffset, final int nameLen,
final int line, final int col)
throws ParseException {
try {
this.writer.write(OPEN_TAG_END);
closeStyle();
} catch (final Exception e) {
throw new ParseException(e);
}
}
@Override
public void handleAutoOpenElementStart(
final char[] buffer,
final int nameOffset, final int nameLen,
final int line, final int col)
throws ParseException {
try {
openStyle(STYLE_ELEMENT_AUTO);
this.writer.write(OPEN_TAG_START);
this.writer.write(buffer, nameOffset, nameLen);
} catch (final Exception e) {
throw new ParseException(e);
}
}
@Override
public void handleAutoOpenElementEnd(
final char[] buffer,
final int nameOffset, final int nameLen,
final int line, final int col)
throws ParseException {
try {
this.writer.write(OPEN_TAG_END);
closeStyle();
} catch (final Exception e) {
throw new ParseException(e);
}
}
@Override
public void handleCloseElementStart(
final char[] buffer,
final int nameOffset, final int nameLen,
final int line, final int col)
throws ParseException {
try {
openStyle(STYLE_ELEMENT);
this.writer.write(CLOSE_TAG_START);
this.writer.write(buffer, nameOffset, nameLen);
} catch (final Exception e) {
throw new ParseException(e);
}
}
@Override
public void handleCloseElementEnd(
final char[] buffer,
final int nameOffset, final int nameLen,
final int line, final int col)
throws ParseException {
try {
this.writer.write(CLOSE_TAG_END);
closeStyle();
} catch (final Exception e) {
throw new ParseException(e);
}
}
@Override
public void handleAutoCloseElementStart(
final char[] buffer,
final int nameOffset, final int nameLen,
final int line, final int col)
throws ParseException {
try {
openStyle(STYLE_ELEMENT_AUTO);
this.writer.write(CLOSE_TAG_START);
this.writer.write(buffer, nameOffset, nameLen);
} catch (final Exception e) {
throw new ParseException(e);
}
}
@Override
public void handleAutoCloseElementEnd(
final char[] buffer,
final int nameOffset, final int nameLen,
final int line, final int col)
throws ParseException {
try {
this.writer.write(CLOSE_TAG_END);
closeStyle();
} catch (final Exception e) {
throw new ParseException(e);
}
}
@Override
public void handleUnmatchedCloseElementStart(
final char[] buffer,
final int nameOffset, final int nameLen,
final int line, final int col)
throws ParseException {
try {
openStyle(STYLE_ELEMENT_UNMATCHED);
this.writer.write(CLOSE_TAG_START);
this.writer.write(buffer, nameOffset, nameLen);
} catch (final Exception e) {
throw new ParseException(e);
}
}
@Override
public void handleUnmatchedCloseElementEnd(
final char[] buffer,
final int nameOffset, final int nameLen,
final int line, final int col)
throws ParseException {
try {
this.writer.write(CLOSE_TAG_END);
closeStyle();
} catch (final Exception e) {
throw new ParseException(e);
}
}
@Override
public void handleAttribute(
final char[] buffer,
final int nameOffset, final int nameLen,
final int nameLine, final int nameCol,
final int operatorOffset, final int operatorLen,
final int operatorLine, final int operatorCol,
final int valueContentOffset, final int valueContentLen,
final int valueOuterOffset, final int valueOuterLen,
final int valueLine, final int valueCol)
throws ParseException {
try {
openStyle(STYLE_ATTR_NAME);
this.writer.write(buffer, nameOffset, nameLen);
closeStyle();
this.writer.write(buffer, operatorOffset, operatorLen);
openStyle(STYLE_ATTR_VALUE);
writeEscaped(buffer, valueOuterOffset, valueOuterLen);
closeStyle();
} catch (final Exception e) {
throw new ParseException(e);
}
}
@Override
public void handleInnerWhiteSpace(
final char[] buffer,
final int offset, final int len,
final int line, final int col)
throws ParseException {
try {
this.writer.write(buffer, offset, len);
} catch (final Exception e) {
throw new ParseException(e);
}
}
@Override
public void handleText(final char[] buffer, final int offset, final int len,
final int line, final int col)
throws ParseException {
try {
openStyle(STYLE_TEXT);
writeEscaped(buffer, offset, len);
closeStyle();
} catch (final Exception e) {
throw new ParseException(e);
}
}
@Override
public void handleComment(
final char[] buffer,
final int contentOffset, final int contentLen,
final int outerOffset, final int outerLen,
final int line, final int col)
throws ParseException {
try {
openStyle(STYLE_COMMENT);
this.writer.write("<!--");
writeEscaped(buffer, contentOffset, contentLen);
this.writer.write("-->");
closeStyle();
} catch (final Exception e) {
throw new ParseException(e);
}
}
@Override
public void handleCDATASection(
final char[] buffer,
final int contentOffset, final int contentLen,
final int outerOffset, final int outerLen,
final int line, final int col)
throws ParseException {
try {
openStyle(STYLE_CDATA);
this.writer.write("<![CDATA[");
writeEscaped(buffer, contentOffset, contentLen);
this.writer.write("]]>");
closeStyle();
} catch (final Exception e) {
throw new ParseException(e);
}
}
@Override
public void handleXmlDeclaration(
final char[] buffer,
final int keywordOffset, final int keywordLen,
final int keywordLine, final int keywordCol,
final int versionOffset, final int versionLen,
final int versionLine, final int versionCol,
final int encodingOffset, final int encodingLen,
final int encodingLine, final int encodingCol,
final int standaloneOffset, final int standaloneLen,
final int standaloneLine, final int standaloneCol,
final int outerOffset, final int outerLen,
final int line,final int col)
throws ParseException {
try {
final int outerContentEnd = (outerOffset + outerLen) - 2;
openStyle(STYLE_XML_DECLARATION);
this.writer.write("<");
this.writer.write('?');
this.writer.write(buffer, keywordOffset, keywordLen);
/*
* VERSION (required)
*/
int lastStructureEnd = keywordOffset + keywordLen;
int thisStructureOffset = versionOffset;
int thisStructureLen = versionLen;
int thisStructureEnd = thisStructureOffset + thisStructureLen;
this.writer.write(buffer, lastStructureEnd, thisStructureOffset - lastStructureEnd);
this.writer.write(buffer, thisStructureOffset, thisStructureLen);
/*
* ENCODING (optional)
*/
if (encodingLen > 0) {
lastStructureEnd = thisStructureEnd;
thisStructureOffset = encodingOffset;
thisStructureLen = encodingLen;
thisStructureEnd = thisStructureOffset + thisStructureLen;
this.writer.write(buffer, lastStructureEnd, thisStructureOffset - lastStructureEnd);
this.writer.write(buffer, thisStructureOffset, thisStructureLen);
}
/*
* STANDALONE (optional)
*/
if (standaloneLen > 0) {
lastStructureEnd = thisStructureEnd;
thisStructureOffset = standaloneOffset;
thisStructureLen = standaloneLen;
thisStructureEnd = thisStructureOffset + thisStructureLen;
this.writer.write(buffer, lastStructureEnd, thisStructureOffset - lastStructureEnd);
this.writer.write(buffer, thisStructureOffset, thisStructureLen);
}
this.writer.write(buffer, thisStructureEnd, (outerContentEnd - thisStructureEnd));
this.writer.write('?');
this.writer.write(">");
closeStyle();
} catch (final Exception e) {
throw new ParseException(e);
}
}
@Override
public void handleDocType(
final char[] buffer,
final int keywordOffset, final int keywordLen,
final int keywordLine, final int keywordCol,
final int elementNameOffset, final int elementNameLen,
final int elementNameLine, final int elementNameCol,
final int typeOffset, final int typeLen,
final int typeLine, final int typeCol,
final int publicIdOffset, final int publicIdLen,
final int publicIdLine, final int publicIdCol,
final int systemIdOffset, final int systemIdLen,
final int systemIdLine, final int systemIdCol,
final int internalSubsetOffset, final int internalSubsetLen,
final int internalSubsetLine, final int internalSubsetCol,
final int outerOffset, final int outerLen,
final int outerLine, final int outerCol)
throws ParseException {
try {
openStyle(STYLE_DOCTYPE);
this.writer.write("<");
this.writer.write(buffer, outerOffset + 1, outerLen - 2);
this.writer.write(">");
closeStyle();
} catch (final Exception e) {
throw new ParseException(e);
}
}
@Override
public void handleProcessingInstruction(
final char[] buffer,
final int targetOffset, final int targetLen,
final int targetLine, final int targetCol,
final int contentOffset, final int contentLen,
final int contentLine, final int contentCol,
final int outerOffset, final int outerLen,
final int line, final int col)
throws ParseException {
try {
openStyle(STYLE_PROCESSING_INSTRUCTION);
this.writer.write("<");
this.writer.write('?');
this.writer.write(buffer, targetOffset, targetLen);
if (contentLen > 0) {
this.writer.write(buffer, (targetOffset + targetLen), contentOffset - (targetOffset + targetLen));
this.writer.write(buffer, contentOffset, contentLen);
} else {
this.writer.write(buffer, (targetOffset + targetLen), ((outerOffset + outerLen) - 2) - (targetOffset + targetLen));
}
this.writer.write('?');
this.writer.write(">");
closeStyle();
} catch (final Exception e) {
throw new ParseException(e);
}
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy