diff options
| author | Michael Williamson <mike@zwobble.org> | 2016-02-24 20:57:09 +0000 |
|---|---|---|
| committer | Michael Williamson <mike@zwobble.org> | 2016-02-24 20:57:09 +0000 |
| commit | b693b50ba55ab80cb7df90f150bf6585ba9fdc09 (patch) | |
| tree | cb2a7f6d4887b0dd31401957b04905067ae62ee9 /src/main/java/org/zwobble/mammoth/internal/DocumentConverter.java | |
| parent | 8dd12c1ca7703a085b57fe4c5c35ef6e19d92134 (diff) | |
Rename DocumentConverter to DocumentToHtml
Diffstat (limited to 'src/main/java/org/zwobble/mammoth/internal/DocumentConverter.java')
| -rw-r--r-- | src/main/java/org/zwobble/mammoth/internal/DocumentConverter.java | 258 |
1 files changed, 0 insertions, 258 deletions
diff --git a/src/main/java/org/zwobble/mammoth/internal/DocumentConverter.java b/src/main/java/org/zwobble/mammoth/internal/DocumentConverter.java deleted file mode 100644 index 4e5dc05..0000000 --- a/src/main/java/org/zwobble/mammoth/internal/DocumentConverter.java +++ /dev/null @@ -1,258 +0,0 @@ -package org.zwobble.mammoth.internal; - -import com.google.common.collect.ImmutableList; -import com.google.common.collect.ImmutableMap; -import com.google.common.collect.Iterables; -import com.google.common.io.ByteStreams; -import org.zwobble.mammoth.internal.documents.*; -import org.zwobble.mammoth.internal.html.Html; -import org.zwobble.mammoth.internal.html.HtmlNode; -import org.zwobble.mammoth.results.Result; -import org.zwobble.mammoth.results.Warning; -import org.zwobble.mammoth.internal.styles.HtmlPath; -import org.zwobble.mammoth.internal.styles.StyleMap; -import org.zwobble.mammoth.internal.util.MammothLists; - -import java.io.IOException; -import java.util.ArrayList; -import java.util.Base64; -import java.util.List; -import java.util.Map; - -import static org.zwobble.mammoth.results.Warning.warning; -import static org.zwobble.mammoth.internal.util.MammothLists.*; -import static org.zwobble.mammoth.internal.util.MammothMaps.map; - -public class DocumentConverter { - public static Result<List<HtmlNode>> convertToHtml(Document document, DocumentToHtmlOptions options) { - DocumentConverter documentConverter = new DocumentConverter(options); - return new Result<>( - documentConverter.convertToHtml(document), - documentConverter.warnings.build()); - } - - private static List<Note> findNotes(Document document, Iterable<NoteReference> noteReferences) { - return ImmutableList.copyOf(Iterables.transform( - noteReferences, - // TODO: handle missing notes - reference -> document.getNotes().findNote(reference.getNoteType(), reference.getNoteId()).get())); - } - - public static Result<List<HtmlNode>> convertToHtml(DocumentElement element, DocumentToHtmlOptions options) { - DocumentConverter documentConverter = new DocumentConverter(options); - return new Result<>( - documentConverter.convertToHtml(element), - documentConverter.warnings.build()); - } - - private final String idPrefix; - private final boolean preserveEmptyParagraphs; - private final StyleMap styleMap; - private final List<NoteReference> noteReferences = new ArrayList<>(); - private final ImmutableList.Builder<Warning> warnings = ImmutableList.builder(); - - private DocumentConverter(DocumentToHtmlOptions options) { - this.idPrefix = options.idPrefix(); - this.preserveEmptyParagraphs = options.shouldPreserveEmptyParagraphs(); - this.styleMap = options.styleMap(); - } - - private List<HtmlNode> convertToHtml(Document document) { - List<HtmlNode> mainBody = convertChildrenToHtml(document); - // TODO: can you have note references inside a note? - List<Note> notes = findNotes(document, noteReferences); - if (notes.isEmpty()) { - return mainBody; - } else { - HtmlNode noteNode = Html.element("ol", - ImmutableList.copyOf(Iterables.transform(notes, this::convertToHtml))); - - return ImmutableList.copyOf(Iterables.concat(mainBody, list(noteNode))); - } - } - - private HtmlNode convertToHtml(Note note) { - String id = generateNoteHtmlId(note.getNoteType(), note.getId()); - String referenceId = generateNoteRefHtmlId(note.getNoteType(), note.getId()); - ImmutableList.Builder<HtmlNode> children = ImmutableList.builder(); - children.addAll(convertToHtml(note.getBody())); - // TODO: we probably want this to collapse more eagerly than other collapsible elements - // -- for instance, any paragraph will probably do, regardless of attributes. (Possible other elements will do too.) - children.add(Html.collapsibleElement("p", list( - Html.text(" "), - Html.element("a", map("href", "#" + referenceId), list(Html.text("↑")))))); - return Html.element("li", map("id", id), children.build()); - } - - private List<HtmlNode> convertToHtml(List<DocumentElement> elements) { - return eagerFlatMap( - elements, - this::convertToHtml); - } - - private List<HtmlNode> convertChildrenToHtml(HasChildren element) { - return convertToHtml(element.getChildren()); - } - - private List<HtmlNode> convertToHtml(DocumentElement element) { - return element.accept(new DocumentElementVisitor<List<HtmlNode>>() { - @Override - public List<HtmlNode> visit(Paragraph paragraph) { - List<HtmlNode> content = convertChildrenToHtml(paragraph); - List<HtmlNode> children = preserveEmptyParagraphs ? cons(Html.FORCE_WRITE, content) : content; - HtmlPath mapping = styleMap.getParagraphHtmlPath(paragraph) - .orElseGet(() -> { - if (paragraph.getStyle().isPresent()) { - warnings.add(warning("Unrecognised paragraph style: " + paragraph.getStyle().get().describe())); - } - return HtmlPath.element("p"); - }); - return mapping.wrap(children); - } - - @Override - public List<HtmlNode> visit(Run run) { - List<HtmlNode> nodes = convertChildrenToHtml(run); - if (run.isStrikethrough()) { - nodes = styleMap.getStrikethrough().orElse(HtmlPath.collapsibleElement("s")).wrap(nodes); - } - if (run.isUnderline()) { - nodes = styleMap.getUnderline().orElse(HtmlPath.EMPTY).wrap(nodes); - } - if (run.getVerticalAlignment() == VerticalAlignment.SUBSCRIPT) { - nodes = list(Html.collapsibleElement("sub", nodes)); - } - if (run.getVerticalAlignment() == VerticalAlignment.SUPERSCRIPT) { - nodes = list(Html.collapsibleElement("sup", nodes)); - } - if (run.isItalic()) { - nodes = list(Html.collapsibleElement("em", nodes)); - } - if (run.isBold()) { - nodes = list(Html.collapsibleElement("strong", nodes)); - } - HtmlPath mapping = styleMap.getRunHtmlPath(run) - .orElseGet(() -> { - if (run.getStyle().isPresent()) { - warnings.add(warning("Unrecognised run style: " + run.getStyle().get().describe())); - } - return HtmlPath.EMPTY; - }); - return mapping.wrap(nodes); - } - - @Override - public List<HtmlNode> visit(Text text) { - if (text.getValue().isEmpty()) { - return list(); - } else { - return list(Html.text(text.getValue())); - } - } - - @Override - public List<HtmlNode> visit(Tab tab) { - return list(Html.text("\t")); - } - - @Override - public List<HtmlNode> visit(LineBreak lineBreak) { - return list(Html.selfClosingElement("br")); - } - - @Override - public List<HtmlNode> visit(Table table) { - return list(Html.element("table", convertChildrenToHtml(table))); - } - - @Override - public List<HtmlNode> visit(TableRow tableRow) { - return list(Html.element("tr", convertChildrenToHtml(tableRow))); - } - - @Override - public List<HtmlNode> visit(TableCell tableCell) { - return list(Html.element("td", - MammothLists.cons(Html.FORCE_WRITE, convertChildrenToHtml(tableCell)))); - } - - @Override - public List<HtmlNode> visit(Hyperlink hyperlink) { - Map<String, String> attributes = map("href", generateHref(hyperlink)); - return list(Html.collapsibleElement("a", attributes, convertChildrenToHtml(hyperlink))); - } - - private String generateHref(Hyperlink hyperlink) { - if (hyperlink.getHref().isPresent()) { - return hyperlink.getHref().get(); - } else if (hyperlink.getAnchor().isPresent()) { - return "#" + generateId(hyperlink.getAnchor().get()); - } else { - return ""; - } - } - - @Override - public List<HtmlNode> visit(Bookmark bookmark) { - return list(Html.element("a", map("id", generateId(bookmark.getName())), list(Html.FORCE_WRITE))); - } - - @Override - public List<HtmlNode> visit(NoteReference noteReference) { - noteReferences.add(noteReference); - String noteAnchor = generateNoteHtmlId(noteReference.getNoteType(), noteReference.getNoteId()); - String noteReferenceAnchor = generateNoteRefHtmlId(noteReference.getNoteType(), noteReference.getNoteId()); - return list(Html.element("sup", list( - Html.element("a", map("href", "#" + noteAnchor, "id", noteReferenceAnchor), list( - Html.text("[" + noteReferences.size() + "]")))))); - } - - @Override - public List<HtmlNode> visit(Image image) { - // TODO: custom image handlers - // TODO: handle empty content type - return image.getContentType() - .map(contentType -> { - try { - ImmutableMap.Builder<String, String> attributes = ImmutableMap.builder(); - - String base64 = Base64.getEncoder().encodeToString(ByteStreams.toByteArray(image.open())); - String src = "data:" + contentType + ";base64," + base64; - attributes.put("src", src); - - image.getAltText().ifPresent(altText -> attributes.put("alt", altText)); - - return list(Html.selfClosingElement("img", attributes.build())); - } catch (IOException exception) { - warnings.add(warning(exception.getMessage())); - return MammothLists.<HtmlNode>list(); - } - }) - .orElse(list()); - } - }); - } - - private String generateNoteHtmlId(NoteType noteType, String noteId) { - return generateId(noteTypeToIdFragment(noteType) + "-" + noteId); - } - - private String generateNoteRefHtmlId(NoteType noteType, String noteId) { - return generateId(noteTypeToIdFragment(noteType) + "-ref-" + noteId); - } - - private String noteTypeToIdFragment(NoteType noteType) { - switch (noteType) { - case FOOTNOTE: - return "footnote"; - case ENDNOTE: - return "endnote"; - default: - throw new UnsupportedOperationException(); - } - } - - private String generateId(String bookmarkName) { - return idPrefix + bookmarkName; - } -} |
