X-Git-Url: http://git.nikiroo.be/?a=blobdiff_plain;f=src%2Fbe%2Fnikiroo%2Ffanfix%2Foutput%2FBasicOutput.java;h=5109cce61637a067bb6fc2bfaf38272f54c37c33;hb=16a81ef7656c5c692fb831927e75edde25dd77a0;hp=1342eb03016189535039fedf322f41cadcb92ff7;hpb=bee7dffea9ef8d3312eee90993a9faaeac6c1127;p=nikiroo-utils.git diff --git a/src/be/nikiroo/fanfix/output/BasicOutput.java b/src/be/nikiroo/fanfix/output/BasicOutput.java index 1342eb0..5109cce 100644 --- a/src/be/nikiroo/fanfix/output/BasicOutput.java +++ b/src/be/nikiroo/fanfix/output/BasicOutput.java @@ -11,7 +11,7 @@ import be.nikiroo.fanfix.data.Chapter; import be.nikiroo.fanfix.data.Paragraph; import be.nikiroo.fanfix.data.Paragraph.ParagraphType; import be.nikiroo.fanfix.data.Story; -import be.nikiroo.utils.ui.Progress; +import be.nikiroo.utils.Progress; /** * This class is the base class used by the other output classes. It can be used @@ -45,6 +45,7 @@ public abstract class BasicOutput { ; + @Override public String toString() { return super.toString().toLowerCase(); } @@ -52,15 +53,23 @@ public abstract class BasicOutput { /** * A description of this output type. * + * @param longDesc + * TRUE for the long description, FALSE for the short one + * * @return the description */ - public String getDesc() { - String desc = Instance.getTrans().getStringX(StringId.OUTPUT_DESC, - this.name()); + public String getDesc(boolean longDesc) { + StringId id = longDesc ? StringId.OUTPUT_DESC + : StringId.OUTPUT_DESC_SHORT; + + String desc = Instance.getTrans().getStringX(id, this.name()); + + if (desc == null) { + desc = Instance.getTrans().getString(id, this); + } if (desc == null) { - desc = Instance.getTrans() - .getString(StringId.OUTPUT_DESC, this); + desc = this.toString(); } return desc; @@ -69,19 +78,25 @@ public abstract class BasicOutput { /** * The default extension to add to the output files. * + * @param readerTarget + * the target to point to to read the {@link Story} (for + * instance, the main entry point if this {@link Story} is in + * a directory bundle) + * * @return the extension */ - public String getDefaultExtension() { - BasicOutput output = BasicOutput.getOutput(this, false); + public String getDefaultExtension(boolean readerTarget) { + BasicOutput output = BasicOutput.getOutput(this, false, false); if (output != null) { - return output.getDefaultExtension(); + return output.getDefaultExtension(readerTarget); } return null; } /** - * Call {@link OutputType#valueOf(String.toUpperCase())}. + * Call {@link OutputType#valueOf(String)} after conversion to upper + * case. * * @param typeName * the possible type name @@ -94,36 +109,41 @@ public abstract class BasicOutput { } /** - * Call {@link OutputType#valueOf(String.toUpperCase())} but return NULL - * for NULL and empty instead of raising an exception. + * Call {@link OutputType#valueOf(String)} after conversion to upper + * case but return def for NULL and empty instead of raising an + * exception. * * @param typeName * the possible type name + * @param def + * the default value * * @return NULL or the type */ - public static OutputType valueOfNullOkUC(String typeName) { + public static OutputType valueOfNullOkUC(String typeName, OutputType def) { if (typeName == null || typeName.isEmpty()) { - return null; + return def; } return OutputType.valueOfUC(typeName); } /** - * Call {@link OutputType#valueOf(String.toUpperCase())} but return NULL - * in case of error instead of raising an exception. + * Call {@link OutputType#valueOf(String)} after conversion to upper + * case but return def in case of error instead of raising an exception. * * @param typeName * the possible type name + * @param def + * the default value * * @return NULL or the type */ - public static OutputType valueOfAllOkUC(String typeName) { + public static OutputType valueOfAllOkUC(String typeName, OutputType def) { try { return OutputType.valueOfUC(typeName); } catch (Exception e) { - return null; + return def; } } } @@ -162,15 +182,19 @@ public abstract class BasicOutput { throws IOException { storyPg = pg; - target = new File(target).getAbsolutePath(); - File targetDir = new File(target).getParentFile(); - String targetName = new File(target).getName(); - - String ext = getDefaultExtension(); - if (ext != null && !ext.isEmpty()) { - if (targetName.toLowerCase().endsWith(ext)) { - targetName = targetName.substring(0, - targetName.length() - ext.length()); + File targetDir = null; + String targetName = null; + if (target != null) { + target = new File(target).getAbsolutePath(); + targetDir = new File(target).getParentFile(); + targetName = new File(target).getName(); + + String ext = getDefaultExtension(false); + if (ext != null && !ext.isEmpty()) { + if (targetName.toLowerCase().endsWith(ext)) { + targetName = targetName.substring(0, targetName.length() + - ext.length()); + } } } @@ -216,22 +240,42 @@ public abstract class BasicOutput { return type; } + /** + * Enable the creation of a .info file next to the resulting processed file. + * + * @return TRUE to enable it + */ + protected boolean isWriteInfo() { + return writeInfo; + } + + /** + * Enable the creation of a cover file next to the resulting processed file + * if possible. + * + * @return TRUE to enable it + */ + protected boolean isWriteCover() { + return writeCover; + } + /** * The output type. * * @param type * the new type - * @param infoCover - * TRUE to enable the creation of a .info file and a cover if - * possible + * @param writeCover + * TRUE to enable the creation of a cover if possible + * @param writeInfo + * TRUE to enable the creation of a .info file * * @return this */ - protected BasicOutput setType(OutputType type, boolean writeCover, - boolean writeInfo) { + protected BasicOutput setType(OutputType type, boolean writeInfo, + boolean writeCover) { this.type = type; - this.writeCover = writeCover; this.writeInfo = writeInfo; + this.writeCover = writeCover; return this; } @@ -239,27 +283,39 @@ public abstract class BasicOutput { /** * The default extension to add to the output files. * + * @param readerTarget + * the target to point to to read the {@link Story} (for + * instance, the main entry point if this {@link Story} is in a + * directory bundle) + * * @return the extension */ - public String getDefaultExtension() { + public String getDefaultExtension( + @SuppressWarnings("unused") boolean readerTarget) { return ""; } + @SuppressWarnings("unused") protected void writeStoryHeader(Story story) throws IOException { } + @SuppressWarnings("unused") protected void writeChapterHeader(Chapter chap) throws IOException { } + @SuppressWarnings("unused") protected void writeParagraphHeader(Paragraph para) throws IOException { } + @SuppressWarnings("unused") protected void writeStoryFooter(Story story) throws IOException { } + @SuppressWarnings("unused") protected void writeChapterFooter(Chapter chap) throws IOException { } + @SuppressWarnings("unused") protected void writeParagraphFooter(Paragraph para) throws IOException { } @@ -320,13 +376,13 @@ public abstract class BasicOutput { int num = 0; String paragraphNumber = String.format("%04d", num++); - imageName = chapterNameNum + "_" + paragraphNumber + ".png"; + imageName = chapterNameNum + "_" + paragraphNumber; writeChapterHeader(chap); int i = 1; for (Paragraph para : chap) { paragraphNumber = String.format("%04d", num++); - imageName = chapterNameNum + "_" + paragraphNumber + ".png"; + imageName = chapterNameNum + "_" + paragraphNumber; writeParagraph(para); if (chapPg != null) { chapPg.setProgress(i++); @@ -341,6 +397,7 @@ public abstract class BasicOutput { writeParagraphFooter(para); } + @SuppressWarnings("unused") protected void writeTextLine(ParagraphType type, String line) throws IOException { } @@ -457,29 +514,33 @@ public abstract class BasicOutput { * * @param type * the type - * @param infoCover - * force the .info file and the cover to be saved next + * @param writeCover + * TRUE to enable the creation of a cover if possible to be saved + * next to the main target file + * @param writeInfo + * TRUE to enable the creation of a .info file to be saved next * to the main target file * * @return the {@link BasicOutput} */ - public static BasicOutput getOutput(OutputType type, boolean infoCover) { + public static BasicOutput getOutput(OutputType type, boolean writeInfo, + boolean writeCover) { if (type != null) { switch (type) { case EPUB: - return new Epub().setType(type, infoCover, infoCover); + return new Epub().setType(type, writeInfo, writeCover); case TEXT: - return new Text().setType(type, true, infoCover); + return new Text().setType(type, writeInfo, true); case INFO_TEXT: return new InfoText().setType(type, true, true); case SYSOUT: return new Sysout().setType(type, false, false); case CBZ: - return new Cbz().setType(type, infoCover, infoCover); + return new Cbz().setType(type, writeInfo, writeCover); case LATEX: - return new LaTeX().setType(type, infoCover, infoCover); + return new LaTeX().setType(type, writeInfo, writeCover); case HTML: - return new Html().setType(type, infoCover, infoCover); + return new Html().setType(type, writeInfo, writeCover); } }