import java.io.File;
import java.io.IOException;
+import java.util.ArrayList;
+import java.util.List;
import be.nikiroo.fanfix.Instance;
import be.nikiroo.fanfix.bundles.StringId;
import be.nikiroo.fanfix.data.Chapter;
import be.nikiroo.fanfix.data.Paragraph;
-import be.nikiroo.fanfix.data.Story;
import be.nikiroo.fanfix.data.Paragraph.ParagraphType;
+import be.nikiroo.fanfix.data.Story;
+import be.nikiroo.utils.Progress;
/**
* This class is the base class used by the other output classes. It can be used
;
+ @Override
public String toString() {
return super.toString().toLowerCase();
}
/**
* 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;
/**
* 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(boolean readerTarget) {
BasicOutput output = BasicOutput.getOutput(this, 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
}
/**
- * Call {@link OutputType#valueOf(String.toUpperCase())} but return NULL
- * for NULL instead of raising exception.
+ * Call {@link OutputType#valueOf(String)} after conversion to upper
+ * case but return NULL for NULL and empty instead of raising an
+ * exception.
*
* @param typeName
* the possible type name
* @return NULL or the type
*/
public static OutputType valueOfNullOkUC(String typeName) {
- if (typeName == null) {
+ if (typeName == null || typeName.isEmpty()) {
return null;
}
}
/**
- * 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 NULL in case of error instead of raising an
+ * exception.
*
* @param typeName
* the possible type name
private OutputType type;
private boolean writeCover;
private boolean writeInfo;
+ private Progress storyPg;
+ private Progress chapPg;
/**
* Process the {@link Story} into the given target.
* @param target
* the target where to save to (will not necessary be taken as is
* by the processor, for instance an extension can be added)
+ * @param pg
+ * the optional progress reporter
*
* @return the actual main target saved, which can be slightly different
* that the input one
* @throws IOException
* in case of I/O error
*/
- public File process(Story story, String target) throws IOException {
- 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());
+ public File process(Story story, String target, Progress pg)
+ throws IOException {
+ storyPg = pg;
+
+ 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());
+ }
}
}
* the target filename (will not necessary be taken as is by the
* processor, for instance an extension can be added)
*
+ *
* @return the actual main target saved, which can be slightly different
* that the input one
*
*
* @param type
* the new type
- * @param infoCover
- * TRUE to enable the creation of a .info file and a cover if
- * possible
+ * @param writeInfo
+ * TRUE to enable the creation of a .info file
+ * @param writeCover
+ * TRUE to enable the creation of a cover if possible
*
* @return this
*/
/**
* 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 {
}
protected void writeStory(Story story) throws IOException {
+ if (storyPg == null) {
+ storyPg = new Progress(0, story.getChapters().size() + 2);
+ } else {
+ storyPg.setMinMax(0, story.getChapters().size() + 2);
+ }
+
String chapterNameNum = String.format("%03d", 0);
String paragraphNumber = String.format("%04d", 0);
imageName = paragraphNumber + "_" + chapterNameNum + ".png";
InfoCover.writeInfo(targetDir, targetName, story.getMeta());
}
- writeStoryHeader(story);
+ storyPg.setProgress(1);
+
+ List<Progress> chapPgs = new ArrayList<Progress>(story.getChapters()
+ .size());
for (Chapter chap : story) {
- writeChapter(chap);
+ chapPg = new Progress(0, chap.getParagraphs().size());
+ storyPg.addProgress(chapPg, 1);
+ chapPgs.add(chapPg);
+ chapPg = null;
+ }
+
+ writeStoryHeader(story);
+ for (int i = 0; i < story.getChapters().size(); i++) {
+ chapPg = chapPgs.get(i);
+ writeChapter(story.getChapters().get(i));
+ chapPg.setProgress(chapPg.getMax());
+ chapPg = null;
}
writeStoryFooter(story);
+
+ storyPg.setProgress(storyPg.getMax());
+ storyPg = null;
}
protected void writeChapter(Chapter chap) throws IOException {
imageName = chapterNameNum + "_" + paragraphNumber + ".png";
writeChapterHeader(chap);
+ int i = 1;
for (Paragraph para : chap) {
paragraphNumber = String.format("%04d", num++);
imageName = chapterNameNum + "_" + paragraphNumber + ".png";
writeParagraph(para);
+ if (chapPg != null) {
+ chapPg.setProgress(i++);
+ }
}
writeChapterFooter(chap);
}
writeParagraphFooter(para);
}
+ @SuppressWarnings("unused")
protected void writeTextLine(ParagraphType type, String line)
throws IOException {
}
case LATEX:
return new LaTeX().setType(type, infoCover, infoCover);
case HTML:
- return new Html().setType(type, false, false);
+ return new Html().setType(type, infoCover, infoCover);
}
}
git://git.nikiroo.be / nikiroo-utils.git / blobdiff