Started to make a pass over Chapter 5

javascript/latexContent.js

@@ -121,7 +121,7 @@ export const preamble = `\\documentclass[a4paper, 12pt]{report}
    escapechar=^
 }
 
-\\usepackage{xcolor}
+\\usepackage[svgnames]{xcolor}
 \\definecolor{LeftBarClickable}{RGB}{187, 187, 187}
 
 \\lstdefinestyle{JavaScript}{

javascript/parseXmlLatexSplit.js

@@ -0,0 +1,386 @@
+import { getChildrenByTagName, ancestorHasTag } from "./utilityFunctions";
+import { checkIndexBadEndWarning } from "./processingFunctions/warnings.js";
+
+import {
+  replaceTagWithSymbol,
+  processEpigraphPdf,
+  processFigurePdf,
+  processFigureEpub,
+  generateImage,
+  processExercisePdf,
+  processExerciseEpub,
+  processFileInput,
+  processSnippetPdf,
+  processSnippetEpub,
+  processTable,
+  recursiveProcessPureText,
+  processList,
+  addName
+} from "./processingFunctions";
+
+const tagsToRemove = new Set([
+  "#comment",
+  "COMMENT",
+  "CHANGE",
+  "EDIT",
+  "EXCLUDE",
+  "HISTORY",
+  "NAME",
+  "INDEX",
+  "CODEINDEX",
+  "EM_NO_INDEX",
+  "ORDER",
+  "SOLUTION",
+  "WEB_ONLY"
+]);
+// SOLUTION tag handled by processSnippet
+
+const ignoreTags = new Set([
+  "CHAPTERCONTENT",
+  "JAVASCRIPT",
+  "SCHEME",
+  "NOBR",
+  "SECTIONCONTENT",
+  "span",
+  "SPLIT",
+  "SPLITINLINE"
+]);
+
+const processTextFunctionsDefaultLatex = {
+  SCHEME: (node, writeTo) => {
+    writeTo.push("{\\color{LightGrey} ");
+    recursiveProcessTextLatex(node.firstChild, writeTo);
+    writeTo.push("}");
+  },
+
+  JAVASCRIPT: (node, writeTo) => {
+    writeTo.push("{\\color{DarkGrey} ");
+    recursiveProcessTextLatex(node.firstChild, writeTo);
+    writeTo.push("}");
+  },
+
+  PDF_ONLY: (node, writeTo) => {
+    recursiveProcessTextLatex(node.firstChild, writeTo);
+  },
+
+  "#text": (node, writeTo) => {
+    const trimedValue = node.nodeValue
+      .replace(/[\r\n]+/, " ")
+      .replace(/\s+/g, " ")
+      .replace(/\^/g, "^{}")
+      .replace(/%/g, "\\%");
+    if (trimedValue.match(/&(\w|\.)+;/)) {
+      processFileInput(trimedValue.trim(), writeTo);
+    } else {
+      writeTo.push(trimedValue);
+    }
+    // if (!trimedValue.match(/^\s*$/)) {
+    // }
+  },
+
+  ABOUT: (node, writeTo) => {
+    writeTo.push("\\chapter*{");
+    const name = addName(node, writeTo);
+    writeTo.push("\n\\addcontentsline{toc}{chapter}{");
+    writeTo.push(name + "}\n\n");
+    recursiveProcessTextLatex(node.firstChild, writeTo);
+  },
+  REFERENCES: (node, writeTo) =>
+    processTextFunctionsLatex["ABOUT"](node, writeTo),
+  WEBPREFACE: (node, writeTo) =>
+    processTextFunctionsLatex["ABOUT"](node, writeTo),
+  MATTER: (node, writeTo) => processTextFunctionsLatex["ABOUT"](node, writeTo),
+
+  B: (node, writeTo) => {
+    writeTo.push("\\textbf{");
+    recursiveProcessTextLatex(node.firstChild, writeTo);
+    writeTo.push("}");
+  },
+
+  BR: (node, writeTo) => {
+    writeTo.push("\n\\noindent ");
+  },
+
+  BLOCKQUOTE: (node, writeTo) => {
+    writeTo.push("\n\\begin{quote}");
+    recursiveProcessTextLatex(node.firstChild, writeTo);
+    writeTo.push("\\end{quote}\n");
+  },
+
+  CHAPTER: (node, writeTo) => {
+    writeTo.push("\\chapter{");
+    addName(node, writeTo);
+    writeTo.push("\\pagestyle{main}\n");
+    recursiveProcessTextLatex(node.firstChild, writeTo);
+  },
+
+  CITATION: (node, writeTo) => {
+    // Currently just text. Not linked to biblography.
+    const text = node.getElementsByTagName("TEXT")[0];
+    if (text) {
+      recursiveProcessTextLatex(text.firstChild, writeTo);
+    } else {
+      recursiveProcessTextLatex(node.firstChild, writeTo);
+    }
+  },
+
+  EM: (node, writeTo) => processTextFunctionsLatex["em"](node, writeTo),
+  em: (node, writeTo) => {
+    writeTo.push("{\\em ");
+    recursiveProcessTextLatex(node.firstChild, writeTo);
+    writeTo.push("}");
+  },
+
+  EPIGRAPH: (node, writeTo) => {
+    processEpigraphPdf(node, writeTo);
+  },
+
+  EXERCISE: (node, writeTo) => {
+    processExercisePdf(node, writeTo);
+  },
+
+  FIGURE: (node, writeTo) => {
+    processFigurePdf(node, writeTo);
+  },
+
+  FOOTNOTE: (node, writeTo) => {
+    writeTo.push("\\cprotect\\footnote{");
+    recursiveProcessTextLatex(node.firstChild, writeTo);
+    writeTo.push("}\n");
+  },
+
+  H2: (node, writeTo) => {
+    writeTo.push("\n\\subsection*{");
+    recursiveProcessTextLatex(node.firstChild, writeTo);
+    writeTo.push("}\n");
+  },
+
+  /*
+  INDEX: (node, writeTo) => {
+    writeTo.push("\\index{");
+    const indexArr = [];
+    const order = getChildrenByTagName(node, "ORDER")[0];
+    if (order) {
+      recursiveProcessTextLatex(order.firstChild, indexArr);
+      indexArr.push("@");
+    }
+    recursiveProcessTextLatex(node.firstChild, indexArr);
+    const indexStr = indexArr.join("").trim();
+
+    // Do error checking
+    checkIndexBadEndWarning(indexStr);
+    writeTo.push(indexStr);
+    writeTo.push("}");
+  },
+    */
+
+  IMAGE: (node, writeTo) => {
+    writeTo.push(
+      "\\begin{figure}[H]\n\\centering" +
+        generateImage(node.getAttribute("src")) +
+        "\n\\end{figure}\n"
+    );
+  },
+
+  LABEL: (node, writeTo) => {
+    writeTo.push("\\label{" + node.getAttribute("NAME") + "}\n");
+  },
+
+  LINK: (node, writeTo) => {
+    writeTo.push("\\href{" + node.getAttribute("address") + "}{");
+    recursiveProcessTextLatex(node.firstChild, writeTo);
+    writeTo.push("}");
+  },
+
+  LATEX: (node, writeTo) =>
+    processTextFunctionsLatex["LATEXINLINE"](node, writeTo),
+  LATEXINLINE: (node, writeTo) => {
+    recursiveProcessPureText(node.firstChild, writeTo);
+  },
+
+  MATTERSECTION: (node, writeTo) => {
+    writeTo.push("\\section*{");
+    addName(node, writeTo);
+    recursiveProcessTextLatex(node.firstChild, writeTo);
+  },
+
+  OL: (node, writeTo) => {
+    writeTo.push("\n\\begin{enumerate}");
+    writeTo.push(ancestorHasTag(node, "EXERCISE") ? "[a.]\n" : "\n");
+    processList(node.firstChild, writeTo);
+    writeTo.push("\\end{enumerate}\n");
+  },
+
+  P: (node, writeTo) => processTextFunctionsLatex["TEXT"](node, writeTo),
+  TEXT: (node, writeTo) => {
+    writeTo.push("\n\n");
+    recursiveProcessTextLatex(node.firstChild, writeTo);
+    writeTo.push("\n");
+  },
+
+  QUOTE: (node, writeTo) => {
+    writeTo.push("\\enquote{");
+    recursiveProcessTextLatex(node.firstChild, writeTo);
+    writeTo.push("}");
+  },
+
+  REF: (node, writeTo) => {
+    writeTo.push("\\ref{" + node.getAttribute("NAME") + "}");
+  },
+
+  REFERENCE: (node, writeTo) => {
+    // Doesn't do anything special
+    writeTo.push("\n");
+    recursiveProcessTextLatex(node.firstChild, writeTo);
+    writeTo.push("\n");
+  },
+
+  SC: (node, writeTo) => {
+    writeTo.push("{\\scshape ");
+    recursiveProcessTextLatex(node.firstChild, writeTo);
+    writeTo.push("}");
+  },
+
+  SECTION: (node, writeTo) => {
+    writeTo.push("\\section{");
+    addName(node, writeTo);
+    writeTo.push("\\pagestyle{section}\n");
+    recursiveProcessTextLatex(node.firstChild, writeTo);
+  },
+
+  SUBHEADING: (node, writeTo) => {
+    writeTo.push("\\subsubsection{");
+    addName(node, writeTo);
+    recursiveProcessTextLatex(node.firstChild, writeTo);
+  },
+  SUBSUBSECTION: (node, writeTo) =>
+    processTextFunctionsLatex["SUBHEADING"](node, writeTo),
+
+  SCHEMEINLINE: (node, writeTo) =>
+    processTextFunctionsLatex["JAVASCRIPTINLINE"](node, writeTo),
+  JAVASCRIPTINLINE: (node, writeTo) => {
+    writeTo.push("{\\lstinline[mathescape=true]$");
+    recursiveProcessPureText(node.firstChild, writeTo, {
+      removeNewline: "all"
+    });
+    writeTo.push("$}");
+  },
+
+  SNIPPET: (node, writeTo) => {
+    processSnippetPdf(node, writeTo);
+  },
+
+  SUBHEADING: (node, writeTo) => {
+    writeTo.push("\\subsubsection{");
+    addName(node, writeTo);
+    recursiveProcessTextLatex(node.firstChild, writeTo);
+  },
+
+  SUBINDEX: (node, writeTo) => {
+    // should occur only within INDEX
+    // also should only exist after stuff in the main index
+    writeTo.push("!");
+    const order = getChildrenByTagName(node, "ORDER")[0];
+    if (order) {
+      recursiveProcessTextLatex(order.firstChild, writeTo);
+      writeTo.push("@");
+    }
+    recursiveProcessTextLatex(node.firstChild, writeTo);
+  },
+
+  SUBSECTION: (node, writeTo) => {
+    writeTo.push("\\subsection{");
+    addName(node, writeTo);
+    writeTo.push("\\pagestyle{subsection}\n");
+    recursiveProcessTextLatex(node.firstChild, writeTo);
+  },
+
+  TABLE: (node, writeTo) => {
+    processTable(node, writeTo);
+  },
+
+  TT: (node, writeTo) => {
+    writeTo.push("\\texttt{");
+    recursiveProcessTextLatex(node.firstChild, writeTo, true);
+    writeTo.push("}");
+  },
+
+  UL: (node, writeTo) => {
+    writeTo.push("\n\\begin{itemize}\n");
+    processList(node.firstChild, writeTo);
+    writeTo.push("\\end{itemize}\n");
+  }
+};
+
+const processTextFunctionsEpub = {
+  EXERCISE: (node, writeTo) => {
+    processExerciseEpub(node, writeTo);
+  },
+  FIGURE: (node, writeTo) => {
+    processFigureEpub(node, writeTo);
+  },
+  SECTION: (node, writeTo) => {
+    writeTo.push("\\section{");
+    addName(node, writeTo);
+    recursiveProcessTextLatex(node.firstChild, writeTo);
+  },
+  JAVASCRIPTINLINE: (node, writeTo) => {
+    writeTo.push("{\\lstinline[mathescape=true, language=JavaScript]$");
+    recursiveProcessPureText(node.firstChild, writeTo, {
+      removeNewline: "all"
+    });
+    writeTo.push("$}");
+  },
+  SNIPPET: (node, writeTo) => {
+    processSnippetEpub(node, writeTo);
+  },
+  SUBSECTION: (node, writeTo) => {
+    writeTo.push("\\subsection{");
+    addName(node, writeTo);
+    recursiveProcessTextLatex(node.firstChild, writeTo);
+  },
+  SUBHEADING: (node, writeTo) => {
+    writeTo.push("\\paragraph{");
+    addName(node, writeTo);
+    recursiveProcessTextLatex(node.firstChild, writeTo);
+  },
+  SUBSUBSECTION: (node, writeTo) =>
+    processTextFunctionsEpub["SUBHEADING"](node, writeTo)
+};
+
+let processTextFunctionsLatex = processTextFunctionsDefaultLatex;
+
+export const switchParseFunctionsLatex = parseType => {
+  if (parseType == "pdf") {
+    processTextFunctionsLatex = processTextFunctionsDefaultLatex;
+  } else if (parseType == "epub") {
+    console.log("using parsetype epub");
+    processTextFunctionsLatex = {
+      ...processTextFunctionsDefaultLatex,
+      ...processTextFunctionsEpub
+    };
+  }
+};
+
+export const processTextLatex = (node, writeTo) => {
+  const name = node.nodeName;
+  if (processTextFunctionsLatex[name]) {
+    processTextFunctionsLatex[name](node, writeTo);
+    return true;
+  } else {
+    if (replaceTagWithSymbol(node, writeTo) || tagsToRemove.has(name)) {
+      return true;
+    } else if (ignoreTags.has(name)) {
+      recursiveProcessTextLatex(node.firstChild, writeTo);
+      return true;
+    }
+  }
+  console.log("WARNING Unrecognised Tag:\n" + node.toString() + "\n");
+  return false;
+};
+
+export const recursiveProcessTextLatex = (node, writeTo) => {
+  if (!node) return;
+  processTextLatex(node, writeTo);
+  return recursiveProcessTextLatex(node.nextSibling, writeTo);
+};