Add OldDiffable export format

schierlm · May 20, 2024 · 329e3dd · 329e3dd
1 parent e115449
commit 329e3dd
Show file tree

Hide file tree

Showing 3 changed files with 243 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -43,6 +43,11 @@ both for import and for export:
 - **RoundtripXML**: Useful for interchange of modules with converters written
   in other programming languages (that prefer XML binding to plaintext parsing)
 
+Note that the **Diffable** format got new features in v0.0.8 as well as in v0.0.9, which
+are backwards compatible but *not* forwards compatible. Use the **OldDiffable** format
+to export Bibles in v0.0.9 so that v0.0.8 or older versions are guaranteed to be able
+to read them.
+
 In addition, there are other formats that can preserve all features supported by
 the BibleMultiConverter framework, and can therefore used for exchanging or editing
 modules without loss of data:

diff --git a/biblemulticonverter/src/main/java/biblemulticonverter/MainModuleRegistry.java b/biblemulticonverter/src/main/java/biblemulticonverter/MainModuleRegistry.java
@@ -24,6 +24,7 @@ public Collection<Module<ExportFormat>> getExportFormats() {
 		List<Module<ExportFormat>> result = new ArrayList<ModuleRegistry.Module<ExportFormat>>();
 		result.add(new Module<ExportFormat>("Validate", "Validate bible for inconsistencies", Validate.HELP_TEXT, Validate.class));
 		result.add(new Module<ExportFormat>("StrippedDiffable", "Like Diffable, but with features stripped.", StrippedDiffable.HELP_TEXT, StrippedDiffable.class));
+		result.add(new Module<ExportFormat>("OldDiffable", "Export bibles to Diffable format of v0.0.8 or v0.0.7 (or older).", OldDiffable.HELP_TEXT, OldDiffable.class));
 		result.add(new Module<ExportFormat>("ZefaniaXMLMyBible", "Zefania XML - well known bible format (with MyBible optimizations).", ZefaniaXMLMyBible.HELP_TEXT, ZefaniaXMLMyBible.class));
 		result.add(new Module<ExportFormat>("ZefDicMyBible", "Zefania Dictionary exporter for MyBible.", ZefDicMyBible.HELP_TEXT, ZefDicMyBible.class));
 		result.add(new Module<ExportFormat>("MobiPocket", "MobiPocket ebook format (predecessor of Kindle's format)", MobiPocket.HELP_TEXT, MobiPocket.class));

diff --git a/biblemulticonverter/src/main/java/biblemulticonverter/format/OldDiffable.java b/biblemulticonverter/src/main/java/biblemulticonverter/format/OldDiffable.java
@@ -0,0 +1,237 @@
+package biblemulticonverter.format;
+
+import java.io.File;
+import java.io.FileOutputStream;
+import java.io.IOException;
+import java.io.OutputStreamWriter;
+import java.io.Writer;
+import java.nio.charset.StandardCharsets;
+
+import biblemulticonverter.data.Bible;
+import biblemulticonverter.data.Book;
+import biblemulticonverter.data.BookID;
+import biblemulticonverter.data.Chapter;
+import biblemulticonverter.data.FormattedText.ExtraAttributePriority;
+import biblemulticonverter.data.FormattedText.FormattingInstructionKind;
+import biblemulticonverter.data.FormattedText.LineBreakKind;
+import biblemulticonverter.data.FormattedText.RawHTMLMode;
+import biblemulticonverter.data.FormattedText.Visitor;
+import biblemulticonverter.data.Verse;
+
+public class OldDiffable implements ExportFormat {
+
+	public static final String[] HELP_TEXT = {
+			"Export bibles to Diffable format of v0.0.8 or v0.0.7 (or older).",
+			"",
+			"Usage: OldDiffable [-older] <OutputFile>",
+			"",
+			"When -older switch is not given, export to v0.0.8 format"
+	};
+
+	private static final String MAGIC = "BibleMultiConverter-1.0 Title: ";
+
+	@Override
+	public void doExport(Bible bible, String... exportArgs) throws Exception {
+		boolean olderFormat = exportArgs[0].equals("-older");
+		File exportFile = new File(exportArgs[olderFormat ? 1 : 0]);
+		try (Writer w = new OutputStreamWriter(new FileOutputStream(exportFile), StandardCharsets.UTF_8)) {
+			doExport(bible, w, olderFormat);
+		}
+	}
+
+	private void doExport(Bible bible, Writer w, boolean olderFormat) throws IOException {
+		w.write(MAGIC + bible.getName() + "\n");
+		for (Book book : bible.getBooks()) {
+			w.write(book.getAbbr() + " = " + book.getId().getOsisID() + "\t" + book.getShortName() + "\t" + book.getLongName() + "\n");
+			int chapterNumber = 0;
+			for (Chapter ch : book.getChapters()) {
+				chapterNumber++;
+				if (ch.getProlog() != null) {
+					ch.getProlog().accept(new OldDiffableVisitor(w, book.getAbbr() + " " + chapterNumber + " ", olderFormat));
+				}
+				for (Verse v : ch.getVerses()) {
+					v.accept(new OldDiffableVisitor(w, book.getAbbr() + " " + chapterNumber + ":" + v.getNumber() + " ", olderFormat));
+				}
+			}
+		}
+	}
+
+	private static class OldDiffableVisitor implements Visitor<IOException> {
+		private final Writer w;
+		private final String linePrefix;
+		private final OldDiffableVisitor childVisitor;
+		private boolean startNewLine = false, inMainContent = false;
+		private boolean olderFormat;
+
+		private OldDiffableVisitor(Writer w, String linePrefix, boolean olderFormat) throws IOException {
+			this.w = w;
+			this.linePrefix = linePrefix;
+			this.olderFormat = olderFormat;
+			childVisitor = linePrefix == null ? this : new OldDiffableVisitor(w, null, olderFormat);
+			if (linePrefix != null)
+				w.write(linePrefix);
+		}
+
+		@Override
+		public int visitElementTypes(String elementTypes) throws IOException {
+			return 0;
+		}
+
+		@Override
+		public Visitor<IOException> visitHeadline(int depth) throws IOException {
+			if (inMainContent)
+				startNewLine = true;
+			checkLine();
+			if (linePrefix != null)
+				startNewLine = true;
+			w.write("<h" + depth + ">");
+			return childVisitor;
+		}
+
+		@Override
+		public void visitStart() throws IOException {
+			if (linePrefix != null)
+				inMainContent = true;
+		}
+
+		@Override
+		public void visitText(String text) throws IOException {
+			checkLine();
+			w.write(text.replace("<", "<<>"));
+		}
+
+		@Override
+		public Visitor<IOException> visitFootnote() throws IOException {
+			checkLine();
+			w.write("<fn>");
+			return childVisitor;
+		}
+
+		@Override
+		public Visitor<IOException> visitCrossReference(String bookAbbr, BookID book, int firstChapter, String firstVerse, int lastChapter, String lastVerse) throws IOException {
+			checkLine();
+			w.write("<xref abbr=\"" + bookAbbr + "\" id=\"" + book.getOsisID() + "\" chapters=\"" + firstChapter + ":" + lastChapter + "\" verses=\"" + firstVerse + ":" + lastVerse + "\">");
+			return childVisitor;
+		}
+
+		@Override
+		public Visitor<IOException> visitFormattingInstruction(FormattingInstructionKind kind) throws IOException {
+			checkLine();
+			w.write("<" + kind.getCode() + ">");
+			return childVisitor;
+		}
+
+		@Override
+		public Visitor<IOException> visitCSSFormatting(String css) throws IOException {
+			checkLine();
+			w.write("<css style=\"" + css + "\">");
+			return childVisitor;
+		}
+
+		@Override
+		public void visitVerseSeparator() throws IOException {
+			checkLine();
+			w.write("<vs/>");
+		}
+
+		@Override
+		public void visitLineBreak(LineBreakKind kind) throws IOException {
+			checkLine();
+			w.write("<br kind=\"" + kind.name() + "\"/>");
+			if (linePrefix != null)
+				startNewLine = true;
+		}
+
+		@Override
+		public Visitor<IOException> visitGrammarInformation(char[] strongsPrefixes, int[] strongs, String[] rmac, int[] sourceIndices) throws IOException {
+			checkLine();
+			w.write("<grammar strong=\"");
+			if (strongs != null) {
+				for (int i = 0; i < strongs.length; i++) {
+					if (i > 0)
+						w.write(',');
+					w.write("" + strongs[i]);
+				}
+			}
+			if (strongsPrefixes != null) {
+				if (olderFormat) {
+					System.out.println("WARNING: Dropping strongs prefixes for older format");
+				} else {
+					w.write("\" strongpfx=\"");
+					w.write(strongsPrefixes);
+				}
+			}
+			w.write("\" rmac=\"");
+			if (rmac != null) {
+				for (int i = 0; i < rmac.length; i++) {
+					if (i > 0)
+						w.write(',');
+					w.write("" + rmac[i]);
+				}
+			}
+			w.write("\" idx=\"");
+			if (sourceIndices != null) {
+				for (int i = 0; i < sourceIndices.length; i++) {
+					if (i > 0)
+						w.write(',');
+					w.write("" + sourceIndices[i]);
+				}
+			}
+			w.write("\">");
+			return childVisitor;
+		}
+
+		@Override
+		public Visitor<IOException> visitDictionaryEntry(String dictionary, String entry) throws IOException {
+			checkLine();
+			w.write("<dict dictionary=\"" + dictionary + "\" entry=\"" + entry + "\">");
+			return childVisitor;
+		}
+
+		@Override
+		public void visitRawHTML(RawHTMLMode mode, String raw) throws IOException {
+			checkLine();
+			int marker = 1;
+			while (raw.contains("</raw:" + marker + ">")) {
+				marker = (int) (Math.random() * 1000000);
+			}
+			w.write("<raw:" + marker + " mode=\"" + mode.name() + "\">" + raw + "</raw:" + marker + ">");
+		}
+
+		@Override
+		public Visitor<IOException> visitVariationText(String[] variations) throws IOException {
+			w.write("<var vars=\"");
+			for (int i = 0; i < variations.length; i++) {
+				if (i > 0)
+					w.write(",");
+				w.write(variations[i]);
+			}
+			w.write("\">");
+			return childVisitor;
+		}
+
+		@Override
+		public Visitor<IOException> visitExtraAttribute(ExtraAttributePriority prio, String category, String key, String value) throws IOException {
+			checkLine();
+			w.write("<extra prio=\"" + prio.name() + "\" category=\"" + category + "\" key=\"" + key + "\" value=\"" + value + "\">");
+			return childVisitor;
+		}
+
+		@Override
+		public boolean visitEnd() throws IOException {
+			if (linePrefix == null)
+				w.write("</>");
+			else
+				w.write("\n");
+			return false;
+		}
+
+		private void checkLine() throws IOException {
+			if (startNewLine) {
+				startNewLine = false;
+				w.write('\n');
+				w.write(linePrefix);
+			}
+		}
+	}
+}