[brailleblaster] [brailleblaster.newdesign] push by john.bo...@xxxxxxxxxxxxxxxxx - Starting on wrapper class org.brailleblaster.document.Document on 2013-01-09 04:59 GMT
- From: brailleblaster@xxxxxxxxxxxxxx
- To: brailleblaster@xxxxxxxxxxxxx
- Date: Wed, 09 Jan 2013 04:59:28 +0000
Revision: 80b77ad2876f
Branch: default
Author: John Boyer <john.boyer@xxxxxxxxxxxxxxxxx>
Date: Tue Jan 8 20:58:18 2013
Log: Starting on wrapper class org.brailleblaster.document.Document
http://code.google.com/p/brailleblaster/source/detail?r=80b77ad2876f&repo=newdesign
Added:
/src/main/org/brailleblaster/document/Actions.java
/src/main/org/brailleblaster/document/Document.java
/src/main/org/brailleblaster/document/Semantics.java
/src/main/org/brailleblaster/document/Styles.java
Deleted:
/src/main/org/brailleblaster/documentmodel/Actions.java
/src/main/org/brailleblaster/documentmodel/Semantics.java
/src/main/org/brailleblaster/documentmodel/Styles.java
=======================================
--- /dev/null
+++ /src/main/org/brailleblaster/document/Actions.java Tue Jan 8 20:58:18
2013
@@ -0,0 +1,107 @@
+/* BrailleBlaster Braille Transcription Application
+ *
+ * Copyright (C) 2010, 2012
+ * ViewPlus Technologies, Inc. www.viewplus.com
+ * and
+ * Abilitiessoft, Inc. www.abilitiessoft.com
+ * and
+ * American Printing House for the Blind, Inc. www.aph.org
+ *
+ * All rights reserved
+ *
+ * This file may contain code borrowed from files produced by various
+ * Java development teams. These are gratefully acknoledged.
+ *
+ * This file is free software; you can redistribute it and/or modify it
+ * under the terms of the Apache 2.0 License, as given at
+ * http://www.apache.org/licenses/
+ *
+ * This file is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE
+ * See the Apache 2.0 License for more details.
+ *
+ * You should have received a copy of the Apache 2.0 License along with
+ * this program; see the file LICENSE.
+ * If not, see
+ * http://www.apache.org/licenses/
+ *
+ * Maintained by John J. Boyer john.boyer@xxxxxxxxxxxxxxxxx
+*/
+
+package org.brailleblaster.document;
+
+import java.io.File;
+import java.io.FileInputStream;
+import java.io.FileOutputStream;
+import java.io.FileNotFoundException;
+import java.io.IOException;
+import nu.xom.Builder;
+import nu.xom.Node;
+import nu.xom.ParsingException;
+import nu.xom.Serializer;
+import nu.xom.Document;
+import nu.xom.Element;
+import nu.xom.Text;
+import nu.xom.Attribute;
+import org.brailleblaster.BBIni;
+import org.brailleblaster.localization.LocaleHandler;
+import org.brailleblaster.util.Notify;
+import org.brailleblaster.util.YesNoChoice;
+import java.util.Hashtable;
+
+/**
+ * This class contains the actions which can be performed on elements.
+ * They are distinct from styles.
+ */
+public class Actions {
+
+/**
+ * The various actions that can be carried out on an xml document, in
+ * addition to processing styles.
+ */
+enum Action {
+ blankSpace,
+ skip,
+ generic,
+ cdata,
+ htmlLink,
+ htmlTarget,
+ noTranslate,
+ attrToText,
+ runningHead,
+ footer,
+ boxLine,
+ italic,
+ bold,
+ underline,
+ compbrl,
+ lineSpacing,
+ blankLine,
+ softReturn,
+ brl,
+ music,
+ math,
+ chemistry,
+ graphic
+};
+
+/**
+ * This method is called to carry out any actions that may be needed
+ * before an elemennt is processed. If the action itself processes the
+ * element, such as skipping it and its subtree, the method returns
+ * false.
+ */
+public boolean actionBeforeElement (Element element) {
+Action act = Action.valueOf ("blankLine");
+ return true;
+}
+
+/**
+ * This method is called after an element and its subtree have been
+ * processed to take any action that might be necessary at this point.
+ */
+public void actionAfterElement() {
+}
+
+}
=======================================
--- /dev/null
+++ /src/main/org/brailleblaster/document/Document.java Tue Jan 8 20:58:18
2013
@@ -0,0 +1,61 @@
+/* BrailleBlaster Braille Transcription Application
+ *
+ * Copyright (C) 2010, 2012
+ * ViewPlus Technologies, Inc. www.viewplus.com
+ * and
+ * Abilitiessoft, Inc. www.abilitiessoft.com
+ * and
+ * American Printing House for the Blind, Inc. www.aph.org
+ *
+ * All rights reserved
+ *
+ * This file may contain code borrowed from files produced by various
+ * Java development teams. These are gratefully acknoledged.
+ *
+ * This file is free software; you can redistribute it and/or modify it
+ * under the terms of the Apache 2.0 License, as given at
+ * http://www.apache.org/licenses/
+ *
+ * This file is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE
+ * See the Apache 2.0 License for more details.
+ *
+ * You should have received a copy of the Apache 2.0 License along with
+ * this program; see the file LICENSE.
+ * If not, see
+ * http://www.apache.org/licenses/
+ *
+ * Maintained by John J. Boyer john.boyer@xxxxxxxxxxxxxxxxx
+*/
+
+package org.brailleblaster.document;
+
+import java.io.InputStream;
+
+public class Document {
+
+private Semantics sm = new Semantics();
+private Styles st = new Styles();
+private Actions act = new Actions();
+
+public void startDocument (InputStream inputStream) throws Exception {
+String fileName = "xxx";
+sm.makeDocumentModel (fileName);
+}
+
+public void saveWorkingFile (String completePath) {
+sm.saveWorkingFile (completePath);
+}
+
+public void saveEnhancedDocument (String completePath) {
+sm.saveEnhancedDocument (completePath);
+}
+
+public void editCreateStyle (String styleName) {
+Styles.StyleType styleType = st.readStyle (styleName);
+st.editStyle (styleType);
+st.writeStyle (styleType);
+}
+
+}
=======================================
--- /dev/null
+++ /src/main/org/brailleblaster/document/Semantics.java Tue Jan 8
20:58:18 2013
@@ -0,0 +1,563 @@
+/* BrailleBlaster Braille Transcription Application
+ *
+ * Copyright (C) 2010, 2012
+ * ViewPlus Technologies, Inc. www.viewplus.com
+ * and
+ * Abilitiessoft, Inc. www.abilitiessoft.com
+ * and
+ * American Printing House for the Blind, Inc. www.aph.org
+ *
+ * All rights reserved
+ *
+ * This file may contain code borrowed from files produced by various
+ * Java development teams. These are gratefully acknoledged.
+ *
+ * This file is free software; you can redistribute it and/or modify it
+ * under the terms of the Apache 2.0 License, as given at
+ * http://www.apache.org/licenses/
+ *
+ * This file is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE
+ * See the Apache 2.0 License for more details.
+ *
+ * You should have received a copy of the Apache 2.0 License along with
+ * this program; see the file LICENSE.
+ * If not, see
+ * http://www.apache.org/licenses/
+ *
+ * Maintained by John J. Boyer john.boyer@xxxxxxxxxxxxxxxxx
+*/
+
+package org.brailleblaster.document;
+
+import java.io.File;
+import java.io.FileInputStream;
+import java.io.FileOutputStream;
+import java.io.FileNotFoundException;
+import java.io.IOException;
+import nu.xom.Builder;
+import nu.xom.Node;
+import nu.xom.ParsingException;
+import nu.xom.Serializer;
+import nu.xom.Document;
+import nu.xom.Element;
+import nu.xom.Text;
+import nu.xom.Attribute;
+import org.brailleblaster.BBIni;
+import org.brailleblaster.localization.LocaleHandler;
+import org.brailleblaster.util.Notify;
+import org.brailleblaster.util.FileUtils;
+import org.brailleblaster.util.YesNoChoice;
+import java.util.Hashtable;
+import java.util.ArrayList;
+
+/**
+ * <p>This class provides the means of displaying and editing any
+ * flavor of xml.
+ * This is accomplished by using a semantic-action file for each type of
+ * xml document, such as NIMAS, epub or docbook. Displaying and editing
+ * in both the print and Braille windows are covered. No transformations
+ * are necessary.</p>
+ * <p>Instances of this class may not be reused. A new instance must be
+ * created for each document.</p>
+ */
+public class Semantics {
+
+/**
+ * This is the parsed xml document (Containing UTDML). It is available
+ * to other classes in this package.
+ */
+Document workingDocument;
+
+/**
+ * Root element of workingDocument
+ */
+private Element rootElement;
+
+public Semantics() {
+workingDocument = null;
+semanticsList = null;
+}
+
+/**
+ * Make the BrailleBlaster document model. The document is parsed and
+ * then the makeSemanticsList method is called to build the
+ * semanticsList. fileName is the complete path of an xml file
+ * containing UTDML. This file is produced by calling the translateFile
+ * method in liblouisutdml with "formatFor utd". It will probably be a
+ * temporary file.
+ * @param fileName: The complete path to a file in which UTDML has been
+ * added to the original xml document.
+ */
+public void makeDocumentModel (String fileName) throws Exception {
+ if (workingDocument != null) {
+ throw new Exception ("Attempt to reuse instance");
+ }
+ File file = new File (fileName);
+Builder parser = new Builder();
+try {
+workingDocument = parser.build (file);
+} catch (ParsingException e) {
+new Notify(lh.localValue("malformedDocument"));
+return;
+} catch (IOException e) {
+new Notify(lh.localValue("couldNotOpen") + " " + fileName);
+return;
+}
+ rootElement = workingDocument.getRootElement();
+ makeSemanticsTable();
+ if (errorCount > 0) {
+ new Notify (errorMessages + errorCount + " errors found. stop.");
+ errorMessages = null;
+ return;
+ }
+ if (!haveSemanticFile) {
+ newEntries = true;
+ }
+ makeSemanticsList();
+ outputNewEntries();
+}
+
+/**
+ * This is an entry in the SemanticsTable, which is used to control
+ * displaying and editing.
+ */
+class SemanticEntry {
+ String markup;
+ String operation;
+ String operand;
+ String parameters;
+ Actions.Action action;
+ Styles.StyleType style;
+ String macro;
+}
+
+/**
+ * The semantic table. The semantic-action file for the type of document
+ * being processed is read and each line is used to create an entry in
+ * this table.
+ */
+SemanticEntry[] semanticsTable = new SemanticEntry[100];
+int semanticsCount = 0; // Number of entries in semanticsTable
+
+/**
+ * The semanticsLookup hash table has literal markup in the
+ * semanticsTable as keys and the index of entries in the samanticsTable
+ * as values.
+ */
+Hashtable<String, Integer> semanticsLookup = new
+ Hashtable<String, Integer>();
+
+private Styles st = new Styles();
+private Actions act = new Actions();
+private LocaleHandler lh = new LocaleHandler();
+private boolean internetAccessRequired;
+private boolean haveSemanticFile = true;
+private boolean newEntries;
+
+/**
+ * Handle the namespaces entries in a semantic-action file. These are
+ * needed for evaluating XPath expressions.
+ */
+private void handleNamespaces (String nm) {
+}
+
+private int errorCount = 0;
+private String errorMessages = "";
+
+/**
+ * Handle error messages.
+ * @Param: fileName, name of semantic file.
+ * @lineNumber, line on which the error occurred.
+ * @message, error message.
+ */
+private void recordError (String fileName, int lineNumber, String
+message) {
+errorCount++;
+errorMessages = errorMessages + "error: " + fileName + ":" + lineNumber
++ ": " +
+message + "\n";
+}
+
+private FileUtils fu = new FileUtils();
+private String fileSep = BBIni.getFileSep();
+
+/**
+ * Compile a semantic-action file. If an include statement is
+ * encountered this method calls itself recursively.
+ * @Param: filename.
+ */
+private boolean compileFile (String fileName) {
+ String completePath = fu.findInProgramData ("semantics" + fileSep +
+ fileName);
+ FileInputStream semFile;
+ try {
+ semFile = new FileInputStream (completePath);
+ } catch (FileNotFoundException e) {
+ haveSemanticFile = false;
+ recordError (fileName, 0, "not found");
+ return false;
+ }
+ byte[] bytebuf = new byte[1024];
+ int numbytes = 0;
+ String line;
+ boolean isCrNext = false;
+ boolean isComment = false;
+ int ch = 0;
+ int prevch = 0;
+ int lineNumber = 0;
+ while (true) {
+ numbytes = 0;
+ prevch = 0;
+ isComment = false;
+ lineNumber++;
+ while (true) {
+ try {
+ ch = semFile.read();
+ } catch (IOException e) {
+ return false;
+ }
+ if (ch == -1) {
+ break;
+ }
+ ch &= 0xff;
+ if (numbytes == 0 && ch <= 32) {
+ continue;
+ }
+ if (ch == 13 && isCrNext) {
+ isCrNext = false;
+ continue;
+ }
+ if (ch == '#') {
+ isComment = true;
+ }
+ if (ch == 10 || ch == 13) {
+ numbytes--;
+ if (prevch == '\\') {
+ isCrNext = true;
+ continue;
+ }
+ break;
+ }
+ prevch = ch;
+ bytebuf[numbytes++] = (byte)ch;
+ }
+ if (ch == -1) {
+ break;
+ }
+ if (isComment) {
+ continue;
+ }
+ line = new String (bytebuf, numbytes);
+ String[] parts = line.split (line, 6);
+ if (parts[0].equals ("include")) {
+ String includeName = fu.findInProgramData ("semantics" +
+ BBIni.getFileSep() + parts[1]);
+ compileFile (includeName);
+ continue;
+ }
+ if (parts[0].equals ("newEntries") && parts[1].equals ("yes")) {
+ newEntries = true;
+ continue;
+ }
+ if (parts[0].equals ("internetAccessRequired") && parts[1].equals
+ ("yes")) {
+ internetAccessRequired = true;
+ continue;
+ }
+ try {
+ semanticsTable[semanticsCount].markup = parts[0]; // markup
+ } catch (ArrayIndexOutOfBoundsException e) {
+ recordError (fileName, lineNumber, "Too many semantic entries.");
+ return false;
+ }
+ semanticsLookup.put (semanticsTable[semanticsCount].markup,
semanticsCount);
+ semanticsTable[semanticsCount].operation = parts[1];
+ semanticsTable[semanticsCount].operand = parts[2];
+ semanticsTable[semanticsCount].parameters = parts[3];
+ semanticsTable[semanticsCount].style = null;
+ if (semanticsTable[semanticsCount].operation.equals ("action")) {
+ semanticsTable[semanticsCount].action = Actions.Action.valueOf
+ (semanticsTable[semanticsCount].operand);
+ }
+ SemanticEntry checkError = semanticsTable[semanticsCount];
+ if (!(checkError.operation.equals ("style") ||
+ checkError.operation.equals ("action") || checkError.operation.equals
+ ("macro"))) {
+ recordError (fileName, lineNumber,
+ "There is no semantic operation called "
+ + checkError.operation);
+ return false;
+ }
+ if (checkError.operation.equals ("style")
+ && fu.findInProgramData ("styles" + fileSep +
+ checkError.operand
+ + ".properties") == null) {
+ recordError (fileName, lineNumber,
+ "There is no style called " + checkError.operand);
+ return false;
+ }
+ if (checkError.operation.equals ("action") &&
+ Actions.Action.valueOf (checkError.operand) == null) {
+ recordError (fileName, lineNumber,
+ "There is no action called " + checkError.operand);
+ return false;
+ }
+ semanticsCount++;
+ }
+ try {
+ semFile.close();
+ } catch (IOException e) {
+ return false;
+ }
+ return true;
+}
+
+/**
+ * This method takes the root element of workingDocument and
+ * concatenates with the path to the semantics directory, and add the
+ * ".sem" suffix. The resulting string is then passed to compileFile,
+ * which constructs the semanticsTable and the lookupSemantics hasTable.
+ */
+private void makeSemanticsTable() {
+ internetAccessRequired = false;
+ newEntries = false;
+ String rootName = rootElement.getLocalName();
+ String partialFileName = "semantics" + BBIni.getFileSep() + rootName
+ + ".sem";
+ String fileName = fu.findInProgramData
+ (partialFileName);
+ compileFile (fileName);
+}
+
+/**
+ * Given the name of a style, find its markup in the semanticsTable. The
+ * search is linear. Since there may be more than one set of markup for
+ * a style, the semantic-action file must be arranged so that the preferred
+ * markup is nearest the beginning.
+ */
+public String findStyleMarkup (String styleName) {
+ for (int i = 0; i < semanticsCount; i++) {
+ if (semanticsTable[i].operation.equals ("style") &&
+ semanticsTable[i].operand.equals (styleName))
+ return semanticsTable[i].markup;
+ }
+ return null;
+}
+
+/**
+ * Given the name of an actgion, find its markup in the semanticsTable.
+ * The search is linear. Since there may be more than one set of markup for
+ * an action, the semantic-action file must be arranged so that the
+ * preferred markup is nearest the beginning.
+ */
+public String findActionMarkup (String actionName) {
+ for (int i = 0; i < semanticsCount; i++) {
+ if (semanticsTable[i].operation.equals ("action") &&
+ semanticsTable[i].operand.equals (actionName))
+ return semanticsTable[i].markup;
+ }
+ return null;
+}
+
+/**
+ * ArrayList for keeping a record of markup not in the semantic-actions
+ * file
+ */
+private ArrayList<String> newMarkup = new ArrayList<String>();
+
+/**
+ * if newEntries = true make a record of any markup that is not listed
+ * in the semanticsTable. This information will later be used to make a
+ * file containing this
+ * information.
+ */
+private void recordNewEntries (String markup) {
+if (newEntries) {
+newMarkup.add (markup);
+}
+}
+
+/**
+ * If any new entries have been recorded, output them to a file in the
+ * user's semantics directory. First sort them so that element names
+ * come first, then element,attribute pairs, then
+ * element,attribute,attribute,balue triplets.
+ */
+private void outputNewEntries() {
+ if (newMarkup.size() == 0) return;
+}
+
+/**
+ * This embedded class contains the semantic information for elements
+ * whose markup is in the SemanticsTable.
+ */
+class ElementSemantics {
+Element element;
+int semanticsIndex;
+int start; // start of text in StyledText.
+int end;
+int depth;
+}
+
+/**
+ * Storage for semantic information.
+ */
+ArrayList<ElementSemantics> semanticsList;
+
+/**
+ * Make the starting SemanticsList immediately after the document has
+ * been parsed and the semanticsTable built.
+ */
+private void makeSemanticsList() {
+semanticsList = new ArrayList<ElementSemantics>(1000);
+doXPathExpressions();
+findSemantics (rootElement, -1);
+}
+
+/**
+ * Evaluate any Xpath expressions that the semanticsTable may contain
+ * and record their nodesets together with the index on the semanticsTable
+ * where the XPath expression occurred.
+ */
+private void doXPathExpressions() {
+}
+
+ /**
+ * Walk through the parse tree, depth-first, and add elements with
+ * semannticsTable markup to semanticsList.
+ */
+private void findSemantics (Node node, int depth) {
+Node newNode;
+Element element;
+String elementName;
+for (int i = 0; i < node.getChildCount(); i++) {
+newNode = node.getChild(i);
+if (newNode instanceof Element) {
+element = (Element)newNode;
+int semanticsIndex;
+if ((semanticsIndex = hasSemantics(element)) != -1 &&
+semanticsTable[semanticsIndex].action != Actions.Action.skip) {
+ElementSemantics elementEntry = new ElementSemantics();
+elementEntry.element = element;
+elementEntry.semanticsIndex = semanticsIndex;
+elementEntry.depth = depth;
+semanticsList.add (elementEntry);
+}
+elementName = element.getLocalName();
+if (!(elementName.equals("brl") || elementName.equals("math"))) {
+findSemantics (element, depth++);
+}
+}
+}
+}
+
+/**
+ * See if the semanticsTable contains markup for this element,its
+ * attributes, and or its attribute values. If so return the index of
+ * the entry in the semanticsTable
+ * @param element, the element to check
+ * @return int the index of the markup in the semanticsTable.
+ */
+private int hasSemantics (Element element) {
+ String elementName = element.getLocalName();
+ Attribute attr;
+ String attrName;
+ String attrValue;
+ String key;
+ Integer semanticsTableIndex;
+ int numAttr = element.getAttributeCount();
+ for (int i = 0; i < numAttr; i++) {
+ attr = element.getAttribute(i);
+ attrName = attr.getLocalName();
+ attrValue = attr.getValue();
+ key = elementName + "," + attrName + "," + attrValue;
+ semanticsTableIndex = semanticsLookup.get (key);
+ if (semanticsTableIndex != null) {
+ return semanticsTableIndex.intValue();
+ }
+ else if (newEntries) {
+ recordNewEntries (key);
+ }
+ key = elementName + "," + attrName;
+ semanticsTableIndex = semanticsLookup.get (key);
+ if (semanticsTableIndex != null) {
+ return semanticsTableIndex.intValue();
+ }
+ else if (newEntries) {
+ recordNewEntries (key);
+ }
+ }
+ semanticsTableIndex = semanticsLookup.get (elementName);
+ if (semanticsTableIndex != null) {
+ return semanticsTableIndex.intValue();
+ }
+ else if (newEntries) {
+ recordNewEntries (elementName);
+ }
+ return -1;
+}
+
+/**
+ * Revise the semanticsList after an edit.
+ * @param startPos: the position at whichh to begin the revision.
+ */
+private void wReviseSemanticList (int startPos) {
+}
+
+/**
+ * This method is used by the readAndEdit method to carry out the
+ * appropriate operations for each element in the semanticsList.
+ */
+private void doSemantics (Element element) {
+}
+
+/**
+ * This method enables the user to read and edit the contents of the
+ * document. It moves around in the parse tree, following the user's
+ * scrolling and cursor movements. The doStyleOrAction method is called
+ * for each element in the semanticsList.
+ */
+public void readAndEdit() {
+for (int i = 0; i < semanticsList.size(); i++) {
+}
+}
+
+/**
+ * Save the file with utd markup so that work can be resumed at a later
+ * time.
+ * @Param fileName: The complete path of the file to which the document
+ * is to be saved.
+ */
+public void saveWorkingFile (String fileName) {
+ FileOutputStream writer = null;
+ try {
+writer = new FileOutputStream(fileName);
+} catch (FileNotFoundException e) {
+new Notify(lh.localValue("cannotOpenFileW") + " " + fileName);
+return;
+}
+Serializer outputDoc = new Serializer(writer);
+try {
+outputDoc.write(workingDocument);
+outputDoc.flush();
+} catch (IOException e) {
+//logger.log(Level.SEVERE, lh.localValue("cannotWriteFile") + ": " +
+new Notify(lh.localValue("cannotWriteFile"));
+return;
+}
+}
+
+/**
+ * Enhance the original document by moving any edited Braille into the
+ * original document Remove the <brl> subtrees and the meta,name,utd
+ * element.
+ * @param fileName: The complete path of the file to which the document
+ * is to be saved.
+ */
+public void saveEnhancedDocument(String fileName) {
+}
+
+}
+
=======================================
--- /dev/null
+++ /src/main/org/brailleblaster/document/Styles.java Tue Jan 8 20:58:18
2013
@@ -0,0 +1,247 @@
+/* BrailleBlaster Braille Transcription Application
+ *
+ * Copyright (C) 2010, 2012
+ * ViewPlus Technologies, Inc. www.viewplus.com
+ * and
+ * Abilitiessoft, Inc. www.abilitiessoft.com
+ * and
+ * American Printing House for the Blind, Inc. www.aph.org
+ *
+ * All rights reserved
+ *
+ * This file may contain code borrowed from files produced by various
+ * Java development teams. These are gratefully acknoledged.
+ *
+ * This file is free software; you can redistribute it and/or modify it
+ * under the terms of the Apache 2.0 License, as given at
+ * http://www.apache.org/licenses/
+ *
+ * This file is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE
+ * See the Apache 2.0 License for more details.
+ *
+ * You should have received a copy of the Apache 2.0 License along with
+ * this program; see the file LICENSE.
+ * If not, see
+ * http://www.apache.org/licenses/
+ *
+ * Maintained by John J. Boyer john.boyer@xxxxxxxxxxxxxxxxx
+*/
+
+package org.brailleblaster.document;
+
+import java.util.Properties;
+import java.io.FileInputStream;
+import java.io.FileOutputStream;
+import nu.xom.Element;
+import org.brailleblaster.BBIni;
+import org.brailleblaster.util.FileUtils;
+import org.brailleblaster.util.Notify;
+import java.io.IOException;
+import java.io.FileNotFoundException;
+
+
+/**
+ * This class contains the data structures and mothods used for handling
+ * styles.
+ * <p>Styles are used in the print window only. The Braille window will
+ * already have been
+ * formatted by liblouisutdml. The rationale behind the use of styles is
+ * that if the print window looks good visually and the correct markup
+ * is used in the document, the Braille will also be formatted
+ * correctly.</p>
+ * <p>Note that BrailleBlaster styles deal with layout. Italic, bold,
+ * etc. are dealt with by action methods in the Actions class.</p>
+ */
+public class Styles {
+
+FileUtils fu = new FileUtils();
+String fileSep = BBIni.getFileSep();
+
+ /**
+ * Reserved styles are defined by the developers. If the user
+ * redefines them the changed styles go in her/his directories.
+ */
+String[] reservedStyles = {
+ "document",
+ "para",
+ "heading1",
+ "heading2",
+ "heading3",
+ "heading4",
+ "contentsHeader",
+ "contents1",
+ "contents2",
+ "contents3",
+ "contents4",
+ };
+
+/**
+ * The different formats that can be applied to styles.
+ */
+enum StyleFormat {
+ inherit,
+ leftJustified,
+ rightJustified,
+ centered,
+ alignColumnsLeft,
+ alignColumnsRight,
+ listColumns,
+ listLines,
+ computerCoded,
+ contents
+};
+
+/**
+ * The status items mark the various stages in the processing of a
+ * style.
+ */
+enum StyleStatus {
+ error,
+ beforeBody,
+ startBody,
+ resumeBody,
+ bodyInterrupted,
+ afterBody,
+};
+
+/**
+ * This embedded class defines the various fields that specify a style.
+ */
+class StyleType {
+ String name = "";
+ int linesBefore = 0;
+ int linesAfter = 0;
+ int leftMargin = 0;
+ int rightMargin= 0;
+ int firstLineIndent = 0;
+ StyleFormat format = StyleFormat.leftJustified;
+}
+
+/**
+ * This methods writes the style as a properties file on
+ * userProgramDataPath/styles.
+ */
+void writeStyle (StyleType st) {
+ String fileName = BBIni.getUserProgramDataPath() +
+ fileSep + "styles" + fileSep + st.name + ".properties";
+ fu.create (fileName);
+Properties prop = new Properties();
+try {
+prop.load(new FileInputStream(fileName));
+} catch (FileNotFoundException e) {
+new Notify(e.getMessage());
+return;
+} catch (IOException e) {
+new Notify(e.getMessage());
+return;
+}
+ prop.setProperty ("name", st.name);
+ prop.setProperty ("linesBeforee", Integer.toString (st.linesBefore));
+ prop.setProperty ("linesAfter", Integer.toString (st.linesAfter));
+ prop.setProperty ("leftMargin", Integer.toString (st.leftMargin));
+ prop.setProperty ("rightMargin", Integer.toString (st.rightMargin));
+ prop.setProperty ("firstLineIndent",
+ Integer.toString (st.firstLineIndent));
+ prop.setProperty ("format", st.format.toString());
+try {
+prop.store(new FileOutputStream (fileName), null);
+} catch (FileNotFoundException e) {
+new Notify(e.getMessage());
+} catch (IOException e) {
+new Notify(e.getMessage());
+}
+}
+
+/**
+ * Read a style from a properties file in programData and create a new
+ * instance of StyleType with all fields initialized from the file.
+ */
+StyleType readStyle (String styleName) {
+ String fileName = fu.findInProgramData ("styles" + fileSep +
+ styleName
+ + ".properties");
+Properties prop = new Properties();
+try {
+prop.load(new FileInputStream(fileName));
+} catch (FileNotFoundException e) {
+new Notify ("There is no style named " + styleName);
+return null;
+} catch (IOException e) {
+new Notify(e.getMessage());
+return null;
+}
+ StyleType st = new StyleType();
+ st.name = prop.getProperty ("name");
+ st.linesBefore = Integer.parseInt (prop.getProperty ("linesBefore"));
+ st.linesAfter = Integer.parseInt (prop.getProperty ("linesAfter"));
+ st.leftMargin = Integer.parseInt (prop.getProperty ("leftMargin"));
+ st.rightMargin = Integer.parseInt (prop.getProperty ("rightMargin"));
+ st.firstLineIndent = Integer.parseInt (prop.getProperty
+ ("firstLineIndent"));
+ st.format = st.format.valueOf (prop.getProperty ("format"));
+ return st;
+}
+
+/**
+ * Edit a StyleType. This is done in a dialog box.
+ */
+public void editStyle (StyleType st) {
+}
+
+/**
+ * An item on the style stack, which is used to handle nested styles. It
+ * is an fifo stack.
+ */
+private class StyleRecord {
+ StyleType style;
+ StyleStatus status;
+ StyleFormat curStyleFormat;
+ Element curElement;
+ int curLeftMargin;
+ int curRightMargin;
+ int curFirstLineIndent;
+}
+
+/**
+ * Index of the top item on the style stack.
+ */
+private int styleTop;
+
+/**
+ * The stack array is managed as a fifo stack to handle nested styles.
+ * For example, we might push a table style onto the stack in the
startStyle
+ * method. Each row would then be pushed onto the stack by StartStyle
+ * and removed by endStyle. When the last row has been processed, the top
of
+ * the stack will contain the table style, which is then completed by
+ * endStyle.
+ */
+private StyleRecord[] stack = new StyleRecord[20];
+
+/**
+ * Begins the processing of a style and places a strylRecord on the top
+ * of the stack. If the element does not have a style it returns false.
+ */
+public boolean startStyle (Element element) {
+ return true;
+}
+
+/**
+ * Completes the processing of the styleRecord on the top of the stack
+ * and pops it.
+ */
+public void endStyle () {
+}
+
+/**
+ * During editing this method is called to add a new style element to
+ * the parse tree at the current location. The element may be the root of a
+ * subtree. For example, its children may be emphasized or MathML
+ * expressions or images.
+ */
+public void applyStyle (Element element) {
+}
+
+}
+
=======================================
--- /src/main/org/brailleblaster/documentmodel/Actions.java Sat Dec 22
16:03:12 2012
+++ /dev/null
@@ -1,107 +0,0 @@
-/* BrailleBlaster Braille Transcription Application
- *
- * Copyright (C) 2010, 2012
- * ViewPlus Technologies, Inc. www.viewplus.com
- * and
- * Abilitiessoft, Inc. www.abilitiessoft.com
- * and
- * American Printing House for the Blind, Inc. www.aph.org
- *
- * All rights reserved
- *
- * This file may contain code borrowed from files produced by various
- * Java development teams. These are gratefully acknoledged.
- *
- * This file is free software; you can redistribute it and/or modify it
- * under the terms of the Apache 2.0 License, as given at
- * http://www.apache.org/licenses/
- *
- * This file is distributed in the hope that it will be useful, but
- * WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE
- * See the Apache 2.0 License for more details.
- *
- * You should have received a copy of the Apache 2.0 License along with
- * this program; see the file LICENSE.
- * If not, see
- * http://www.apache.org/licenses/
- *
- * Maintained by John J. Boyer john.boyer@xxxxxxxxxxxxxxxxx
-*/
-
-package org.brailleblaster.documentmodel;
-
-import java.io.File;
-import java.io.FileInputStream;
-import java.io.FileOutputStream;
-import java.io.FileNotFoundException;
-import java.io.IOException;
-import nu.xom.Builder;
-import nu.xom.Node;
-import nu.xom.ParsingException;
-import nu.xom.Serializer;
-import nu.xom.Document;
-import nu.xom.Element;
-import nu.xom.Text;
-import nu.xom.Attribute;
-import org.brailleblaster.BBIni;
-import org.brailleblaster.localization.LocaleHandler;
-import org.brailleblaster.util.Notify;
-import org.brailleblaster.util.YesNoChoice;
-import java.util.Hashtable;
-
-/**
- * This class contains the actions which can be performed on elements.
- * They are distinct from styles.
- */
-public class Actions {
-
-/**
- * The various actions that can be carried out on an xml document, in
- * addition to processing styles.
- */
-enum Action {
- blankSpace,
- skip,
- generic,
- cdata,
- htmlLink,
- htmlTarget,
- noTranslate,
- attrToText,
- runningHead,
- footer,
- boxLine,
- italic,
- bold,
- underline,
- compbrl,
- lineSpacing,
- blankLine,
- softReturn,
- brl,
- music,
- math,
- chemistry,
- graphic
-};
-
-/**
- * This method is called to carry out any actions that may be needed
- * before an elemennt is processed. If the action itself processes the
- * element, such as skipping it and its subtree, the method returns
- * false.
- */
-public boolean actionBeforeElement (Element element) {
-Action act = Action.valueOf ("blankLine");
- return true;
-}
-
-/**
- * This method is called after an element and its subtree have been
- * processed to take any action that might be necessary at this point.
- */
-public void actionAfterElement() {
-}
-
-}
=======================================
--- /src/main/org/brailleblaster/documentmodel/Semantics.java Thu Jan 3
13:03:59 2013
+++ /dev/null
@@ -1,563 +0,0 @@
-/* BrailleBlaster Braille Transcription Application
- *
- * Copyright (C) 2010, 2012
- * ViewPlus Technologies, Inc. www.viewplus.com
- * and
- * Abilitiessoft, Inc. www.abilitiessoft.com
- * and
- * American Printing House for the Blind, Inc. www.aph.org
- *
- * All rights reserved
- *
- * This file may contain code borrowed from files produced by various
- * Java development teams. These are gratefully acknoledged.
- *
- * This file is free software; you can redistribute it and/or modify it
- * under the terms of the Apache 2.0 License, as given at
- * http://www.apache.org/licenses/
- *
- * This file is distributed in the hope that it will be useful, but
- * WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE
- * See the Apache 2.0 License for more details.
- *
- * You should have received a copy of the Apache 2.0 License along with
- * this program; see the file LICENSE.
- * If not, see
- * http://www.apache.org/licenses/
- *
- * Maintained by John J. Boyer john.boyer@xxxxxxxxxxxxxxxxx
-*/
-
-package org.brailleblaster.documentmodel;
-
-import java.io.File;
-import java.io.FileInputStream;
-import java.io.FileOutputStream;
-import java.io.FileNotFoundException;
-import java.io.IOException;
-import nu.xom.Builder;
-import nu.xom.Node;
-import nu.xom.ParsingException;
-import nu.xom.Serializer;
-import nu.xom.Document;
-import nu.xom.Element;
-import nu.xom.Text;
-import nu.xom.Attribute;
-import org.brailleblaster.BBIni;
-import org.brailleblaster.localization.LocaleHandler;
-import org.brailleblaster.util.Notify;
-import org.brailleblaster.util.FileUtils;
-import org.brailleblaster.util.YesNoChoice;
-import java.util.Hashtable;
-import java.util.ArrayList;
-
-/**
- * <p>This class provides the means of displaying and editing any
- * flavor of xml.
- * This is accomplished by using a semantic-action file for each type of
- * xml document, such as NIMAS, epub or docbook. Displaying and editing
- * in both the print and Braille windows are covered. No transformations
- * are necessary.</p>
- * <p>Instances of this class may not be reused. A new instance must be
- * created for each document.</p>
- */
-public class Semantics {
-
-/**
- * This is the parsed xml document (Containing UTDML). It is available
- * to other classes in this package.
- */
-Document workingDocument;
-
-/**
- * Root element of workingDocument
- */
-private Element rootElement;
-
-public Semantics() throws Exception {
-workingDocument = null;
-semanticsList = null;
-}
-
-/**
- * Make the BrailleBlaster document model. The document is parsed and
- * then the makeSemanticsList method is called to build the
- * semanticsList. fileName is the complete path of an xml file
- * containing UTDML. This file is produced by calling the translateFile
- * method in liblouisutdml with "formatFor utd". It will probably be a
- * temporary file.
- * @param fileName: The complete path to a file in which UTDML has been
- * added to the original xml document.
- */
-public void makeDocumentModel (String fileName) throws Exception {
- if (workingDocument != null) {
- throw new Exception ("Attempt to reuse instance");
- }
- File file = new File (fileName);
-Builder parser = new Builder();
-try {
-workingDocument = parser.build (file);
-} catch (ParsingException e) {
-new Notify(lh.localValue("malformedDocument"));
-return;
-} catch (IOException e) {
-new Notify(lh.localValue("couldNotOpen") + " " + fileName);
-return;
-}
- rootElement = workingDocument.getRootElement();
- makeSemanticsTable();
- if (errorCount > 0) {
- new Notify (errorMessages + errorCount + " errors found. stop.");
- errorMessages = null;
- return;
- }
- if (!haveSemanticFile) {
- newEntries = true;
- }
- makeSemanticsList();
- outputNewEntries();
-}
-
-/**
- * This is an entry in the SemanticsTable, which is used to control
- * displaying and editing.
- */
-class SemanticEntry {
- String markup;
- String operation;
- String operand;
- String parameters;
- Actions.Action action;
- Styles.StyleType style;
- String macro;
-}
-
-/**
- * The semantic table. The semantic-action file for the type of document
- * being processed is read and each line is used to create an entry in
- * this table.
- */
-SemanticEntry[] semanticsTable = new SemanticEntry[100];
-int semanticsCount = 0; // Number of entries in semanticsTable
-
-/**
- * The semanticsLookup hash table has literal markup in the
- * semanticsTable as keys and the index of entries in the samanticsTable
- * as values.
- */
-Hashtable<String, Integer> semanticsLookup = new
- Hashtable<String, Integer>();
-
-private Styles st = new Styles();
-private Actions act = new Actions();
-private LocaleHandler lh = new LocaleHandler();
-private boolean internetAccessRequired;
-private boolean haveSemanticFile = true;
-private boolean newEntries;
-
-/**
- * Handle the namespaces entries in a semantic-action file. These are
- * needed for evaluating XPath expressions.
- */
-private void handleNamespaces (String nm) {
-}
-
-private int errorCount = 0;
-private String errorMessages = "";
-
-/**
- * Handle error messages.
- * @Param: fileName, name of semantic file.
- * @lineNumber, line on which the error occurred.
- * @message, error message.
- */
-private void recordError (String fileName, int lineNumber, String
-message) {
-errorCount++;
-errorMessages = errorMessages + "error: " + fileName + ":" + lineNumber
-+ ": " +
-message + "\n";
-}
-
-private FileUtils fu = new FileUtils();
-private String fileSep = BBIni.getFileSep();
-
-/**
- * Compile a semantic-action file. If an include statement is
- * encountered this method calls itself recursively.
- * @Param: filename.
- */
-private boolean compileFile (String fileName) {
- String completePath = fu.findInProgramData ("semantics" + fileSep +
- fileName);
- FileInputStream semFile;
- try {
- semFile = new FileInputStream (completePath);
- } catch (FileNotFoundException e) {
- haveSemanticFile = false;
- recordError (fileName, 0, "not found");
- return false;
- }
- byte[] bytebuf = new byte[1024];
- int numbytes = 0;
- String line;
- boolean isCrNext = false;
- boolean isComment = false;
- int ch = 0;
- int prevch = 0;
- int lineNumber = 0;
- while (true) {
- numbytes = 0;
- prevch = 0;
- isComment = false;
- lineNumber++;
- while (true) {
- try {
- ch = semFile.read();
- } catch (IOException e) {
- return false;
- }
- if (ch == -1) {
- break;
- }
- ch &= 0xff;
- if (numbytes == 0 && ch <= 32) {
- continue;
- }
- if (ch == 13 && isCrNext) {
- isCrNext = false;
- continue;
- }
- if (ch == '#') {
- isComment = true;
- }
- if (ch == 10 || ch == 13) {
- numbytes--;
- if (prevch == '\\') {
- isCrNext = true;
- continue;
- }
- break;
- }
- prevch = ch;
- bytebuf[numbytes++] = (byte)ch;
- }
- if (ch == -1) {
- break;
- }
- if (isComment) {
- continue;
- }
- line = new String (bytebuf, numbytes);
- String[] parts = line.split (line, 6);
- if (parts[0].equals ("include")) {
- String includeName = fu.findInProgramData ("semantics" +
- BBIni.getFileSep() + parts[1]);
- compileFile (includeName);
- continue;
- }
- if (parts[0].equals ("newEntries") && parts[1].equals ("yes")) {
- newEntries = true;
- continue;
- }
- if (parts[0].equals ("internetAccessRequired") && parts[1].equals
- ("yes")) {
- internetAccessRequired = true;
- continue;
- }
- try {
- semanticsTable[semanticsCount].markup = parts[0]; // markup
- } catch (ArrayIndexOutOfBoundsException e) {
- recordError (fileName, lineNumber, "Too many semantic entries.");
- return false;
- }
- semanticsLookup.put (semanticsTable[semanticsCount].markup,
semanticsCount);
- semanticsTable[semanticsCount].operation = parts[1];
- semanticsTable[semanticsCount].operand = parts[2];
- semanticsTable[semanticsCount].parameters = parts[3];
- semanticsTable[semanticsCount].style = null;
- if (semanticsTable[semanticsCount].operation.equals ("action")) {
- semanticsTable[semanticsCount].action = Actions.Action.valueOf
- (semanticsTable[semanticsCount].operand);
- }
- SemanticEntry checkError = semanticsTable[semanticsCount];
- if (!(checkError.operation.equals ("style") ||
- checkError.operation.equals ("action") || checkError.operation.equals
- ("macro"))) {
- recordError (fileName, lineNumber,
- "There is no semantic operation called "
- + checkError.operation);
- return false;
- }
- if (checkError.operation.equals ("style")
- && fu.findInProgramData ("styles" + fileSep +
- checkError.operand
- + ".properties") == null) {
- recordError (fileName, lineNumber,
- "There is no style called " + checkError.operand);
- return false;
- }
- if (checkError.operation.equals ("action") &&
- Actions.Action.valueOf (checkError.operand) == null) {
- recordError (fileName, lineNumber,
- "There is no action called " + checkError.operand);
- return false;
- }
- semanticsCount++;
- }
- try {
- semFile.close();
- } catch (IOException e) {
- return false;
- }
- return true;
-}
-
-/**
- * This method takes the root element of workingDocument and
- * concatenates with the path to the semantics directory, and add the
- * ".sem" suffix. The resulting string is then passed to compileFile,
- * which constructs the semanticsTable and the lookupSemantics hasTable.
- */
-private void makeSemanticsTable() {
- internetAccessRequired = false;
- newEntries = false;
- String rootName = rootElement.getLocalName();
- String partialFileName = "semantics" + BBIni.getFileSep() + rootName
- + ".sem";
- String fileName = fu.findInProgramData
- (partialFileName);
- compileFile (fileName);
-}
-
-/**
- * Given the name of a style, find its markup in the semanticsTable. The
- * search is linear. Since there may be more than one set of markup for
- * a style, the semantic-action file must be arranged so that the preferred
- * markup is nearest the beginning.
- */
-public String findStyleMarkup (String styleName) {
- for (int i = 0; i < semanticsCount; i++) {
- if (semanticsTable[i].operation.equals ("style") &&
- semanticsTable[i].operand.equals (styleName))
- return semanticsTable[i].markup;
- }
- return null;
-}
-
-/**
- * Given the name of an actgion, find its markup in the semanticsTable.
- * The search is linear. Since there may be more than one set of markup for
- * an action, the semantic-action file must be arranged so that the
- * preferred markup is nearest the beginning.
- */
-public String findActionMarkup (String actionName) {
- for (int i = 0; i < semanticsCount; i++) {
- if (semanticsTable[i].operation.equals ("action") &&
- semanticsTable[i].operand.equals (actionName))
- return semanticsTable[i].markup;
- }
- return null;
-}
-
-/**
- * ArrayList for keeping a record of markup not in the semantic-actions
- * file
- */
-private ArrayList<String> newMarkup = new ArrayList<String>();
-
-/**
- * if newEntries = true make a record of any markup that is not listed
- * in the semanticsTable. This information will later be used to make a
- * file containing this
- * information.
- */
-private void recordNewEntries (String markup) {
-if (newEntries) {
-newMarkup.add (markup);
-}
-}
-
-/**
- * If any new entries have been recorded, output them to a file in the
- * user's semantics directory. First sort them so that element names
- * come first, then element,attribute pairs, then
- * element,attribute,attribute,balue triplets.
- */
-private void outputNewEntries() {
- if (newMarkup.size() == 0) return;
-}
-
-/**
- * This embedded class contains the semantic information for elements
- * whose markup is in the SemanticsTable.
- */
-class ElementSemantics {
-Element element;
-int semanticsIndex;
-int start; // start of text in StyledText.
-int end;
-int depth;
-}
-
-/**
- * Storage for semantic information.
- */
-ArrayList<ElementSemantics> semanticsList;
-
-/**
- * Make the starting SemanticsList immediately after the document has
- * been parsed and the semanticsTable built.
- */
-private void makeSemanticsList() {
-semanticsList = new ArrayList<ElementSemantics>(1000);
-doXPathExpressions();
-findSemantics (rootElement, -1);
-}
-
-/**
- * Evaluate any Xpath expressions that the semanticsTable may contain
- * and record their nodesets together with the index on the semanticsTable
- * where the XPath expression occurred.
- */
-private void doXPathExpressions() {
-}
-
- /**
- * Walk through the parse tree, depth-first, and add elements with
- * semannticsTable markup to semanticsList.
- */
-private void findSemantics (Node node, int depth) {
-Node newNode;
-Element element;
-String elementName;
-for (int i = 0; i < node.getChildCount(); i++) {
-newNode = node.getChild(i);
-if (newNode instanceof Element) {
-element = (Element)newNode;
-int semanticsIndex;
-if ((semanticsIndex = hasSemantics(element)) != -1 &&
-semanticsTable[semanticsIndex].action != Actions.Action.skip) {
-ElementSemantics elementEntry = new ElementSemantics();
-elementEntry.element = element;
-elementEntry.semanticsIndex = semanticsIndex;
-elementEntry.depth = depth;
-semanticsList.add (elementEntry);
-}
-elementName = element.getLocalName();
-if (!(elementName.equals("brl") || elementName.equals("math"))) {
-findSemantics (element, depth++);
-}
-}
-}
-}
-
-/**
- * See if the semanticsTable contains markup for this element,its
- * attributes, and or its attribute values. If so return the index of
- * the entry in the semanticsTable
- * @param element, the element to check
- * @return int the index of the markup in the semanticsTable.
- */
-private int hasSemantics (Element element) {
- String elementName = element.getLocalName();
- Attribute attr;
- String attrName;
- String attrValue;
- String key;
- Integer semanticsTableIndex;
- int numAttr = element.getAttributeCount();
- for (int i = 0; i < numAttr; i++) {
- attr = element.getAttribute(i);
- attrName = attr.getLocalName();
- attrValue = attr.getValue();
- key = elementName + "," + attrName + "," + attrValue;
- semanticsTableIndex = semanticsLookup.get (key);
- if (semanticsTableIndex != null) {
- return semanticsTableIndex.intValue();
- }
- else if (newEntries) {
- recordNewEntries (key);
- }
- key = elementName + "," + attrName;
- semanticsTableIndex = semanticsLookup.get (key);
- if (semanticsTableIndex != null) {
- return semanticsTableIndex.intValue();
- }
- else if (newEntries) {
- recordNewEntries (key);
- }
- }
- semanticsTableIndex = semanticsLookup.get (elementName);
- if (semanticsTableIndex != null) {
- return semanticsTableIndex.intValue();
- }
- else if (newEntries) {
- recordNewEntries (elementName);
- }
- return -1;
-}
-
-/**
- * Revise the semanticsList after an edit.
- * @param startPos: the position at whichh to begin the revision.
- */
-private void wReviseSemanticList (int startPos) {
-}
-
-/**
- * This method is used by the readAndEdit method to carry out the
- * appropriate operations for each element in the semanticsList.
- */
-private void doSemantics (Element element) {
-}
-
-/**
- * This method enables the user to read and edit the contents of the
- * document. It moves around in the parse tree, following the user's
- * scrolling and cursor movements. The doStyleOrAction method is called
- * for each element in the semanticsList.
- */
-public void readAndEdit() {
-for (int i = 0; i < semanticsList.size(); i++) {
-}
-}
-
-/**
- * Save the file with utd markup so that work can be resumed at a later
- * time.
- * @Param fileName: The complete path of the file to which the document
- * is to be saved.
- */
-public void saveWorkikngFile (String fileName) {
- FileOutputStream writer = null;
- try {
-writer = new FileOutputStream(fileName);
-} catch (FileNotFoundException e) {
-new Notify(lh.localValue("cannotOpenFileW") + " " + fileName);
-return;
-}
-Serializer outputDoc = new Serializer(writer);
-try {
-outputDoc.write(workingDocument);
-outputDoc.flush();
-} catch (IOException e) {
-//logger.log(Level.SEVERE, lh.localValue("cannotWriteFile") + ": " +
-new Notify(lh.localValue("cannotWriteFile"));
-return;
-}
-}
-
-/**
- * Enhance the original document by moving any edited Braille into the
- * original document Remove the <brl> subtrees and the meta,name,utd
- * element.
- * @param fileName: The complete path of the file to which the document
- * is to be saved.
- */
-public void saveEnhancedDocument(String fileName) {
-}
-
-}
-
=======================================
--- /src/main/org/brailleblaster/documentmodel/Styles.java Sun Dec 30
10:54:38 2012
+++ /dev/null
@@ -1,247 +0,0 @@
-/* BrailleBlaster Braille Transcription Application
- *
- * Copyright (C) 2010, 2012
- * ViewPlus Technologies, Inc. www.viewplus.com
- * and
- * Abilitiessoft, Inc. www.abilitiessoft.com
- * and
- * American Printing House for the Blind, Inc. www.aph.org
- *
- * All rights reserved
- *
- * This file may contain code borrowed from files produced by various
- * Java development teams. These are gratefully acknoledged.
- *
- * This file is free software; you can redistribute it and/or modify it
- * under the terms of the Apache 2.0 License, as given at
- * http://www.apache.org/licenses/
- *
- * This file is distributed in the hope that it will be useful, but
- * WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE
- * See the Apache 2.0 License for more details.
- *
- * You should have received a copy of the Apache 2.0 License along with
- * this program; see the file LICENSE.
- * If not, see
- * http://www.apache.org/licenses/
- *
- * Maintained by John J. Boyer john.boyer@xxxxxxxxxxxxxxxxx
-*/
-
-package org.brailleblaster.documentmodel;
-
-import java.util.Properties;
-import java.io.FileInputStream;
-import java.io.FileOutputStream;
-import nu.xom.Element;
-import org.brailleblaster.BBIni;
-import org.brailleblaster.util.FileUtils;
-import org.brailleblaster.util.Notify;
-import java.io.IOException;
-import java.io.FileNotFoundException;
-
-
-/**
- * This class contains the data structures and mothods used for handling
- * styles.
- * <p>Styles are used in the print window only. The Braille window will
- * already have been
- * formatted by liblouisutdml. The rationale behind the use of styles is
- * that if the print window looks good visually and the correct markup
- * is used in the document, the Braille will also be formatted
- * correctly.</p>
- * <p>Note that BrailleBlaster styles deal with layout. Italic, bold,
- * etc. are dealt with by action methods in the Actions class.</p>
- */
-public class Styles {
-
-FileUtils fu = new FileUtils();
-String fileSep = BBIni.getFileSep();
-
- /**
- * Reserved styles are defined by the developers. If the user
- * redefines them the changed styles go in her/his directories.
- */
-String[] reservedStyles = {
- "document",
- "para",
- "heading1",
- "heading2",
- "heading3",
- "heading4",
- "contentsHeader",
- "contents1",
- "contents2",
- "contents3",
- "contents4",
- };
-
-/**
- * The different formats that can be applied to styles.
- */
-enum StyleFormat {
- inherit,
- leftJustified,
- rightJustified,
- centered,
- alignColumnsLeft,
- alignColumnsRight,
- listColumns,
- listLines,
- computerCoded,
- contents
-};
-
-/**
- * The status items mark the various stages in the processing of a
- * style.
- */
-enum StyleStatus {
- error,
- beforeBody,
- startBody,
- resumeBody,
- bodyInterrupted,
- afterBody,
-};
-
-/**
- * This embedded class defines the various fields that specify a style.
- */
-class StyleType {
- String name = "";
- int linesBefore = 0;
- int linesAfter = 0;
- int leftMargin = 0;
- int rightMargin= 0;
- int firstLineIndent = 0;
- StyleFormat format = StyleFormat.leftJustified;
-}
-
-/**
- * This methods writes the style as a properties file on
- * userProgramDataPath/styles.
- */
-void writeStyle (StyleType st) {
- String fileName = BBIni.getUserProgramDataPath() +
- fileSep + "styles" + fileSep + st.name + ".properties";
- fu.create (fileName);
-Properties prop = new Properties();
-try {
-prop.load(new FileInputStream(fileName));
-} catch (FileNotFoundException e) {
-new Notify(e.getMessage());
-return;
-} catch (IOException e) {
-new Notify(e.getMessage());
-return;
-}
- prop.setProperty ("name", st.name);
- prop.setProperty ("linesBeforee", Integer.toString (st.linesBefore));
- prop.setProperty ("linesAfter", Integer.toString (st.linesAfter));
- prop.setProperty ("leftMargin", Integer.toString (st.leftMargin));
- prop.setProperty ("rightMargin", Integer.toString (st.rightMargin));
- prop.setProperty ("firstLineIndent",
- Integer.toString (st.firstLineIndent));
- prop.setProperty ("format", st.format.toString());
-try {
-prop.store(new FileOutputStream (fileName), null);
-} catch (FileNotFoundException e) {
-new Notify(e.getMessage());
-} catch (IOException e) {
-new Notify(e.getMessage());
-}
-}
-
-/**
- * Read a style from a properties file in programData and create a new
- * instance of StyleType with all fields initialized from the file.
- */
-StyleType readStyle (String styleName) {
- String fileName = fu.findInProgramData ("styles" + fileSep +
- styleName
- + ".properties");
-Properties prop = new Properties();
-try {
-prop.load(new FileInputStream(fileName));
-} catch (FileNotFoundException e) {
-new Notify ("There is no style named " + styleName);
-return null;
-} catch (IOException e) {
-new Notify(e.getMessage());
-return null;
-}
- StyleType st = new StyleType();
- st.name = prop.getProperty ("name");
- st.linesBefore = Integer.parseInt (prop.getProperty ("linesBefore"));
- st.linesAfter = Integer.parseInt (prop.getProperty ("linesAfter"));
- st.leftMargin = Integer.parseInt (prop.getProperty ("leftMargin"));
- st.rightMargin = Integer.parseInt (prop.getProperty ("rightMargin"));
- st.firstLineIndent = Integer.parseInt (prop.getProperty
- ("firstLineIndent"));
- st.format = st.format.valueOf (prop.getProperty ("format"));
- return st;
-}
-
-/**
- * Edit a StyleType. This is done in a dialog box.
- */
-public void StyleEdit (StyleType st) {
-}
-
-/**
- * An item on the style stack, which is used to handle nested styles. It
- * is an fifo stack.
- */
-private class StyleRecord {
- StyleType style;
- StyleStatus status;
- StyleFormat curStyleFormat;
- Element curElement;
- int curLeftMargin;
- int curRightMargin;
- int curFirstLineIndent;
-}
-
-/**
- * Index of the top item on the style stack.
- */
-private int styleTop;
-
-/**
- * The stack array is managed as a fifo stack to handle nested styles.
- * For example, we might push a table style onto the stack in the
startStyle
- * method. Each row would then be pushed onto the stack by StartStyle
- * and removed by endStyle. When the last row has been processed, the top
of
- * the stack will contain the table style, which is then completed by
- * endStyle.
- */
-private StyleRecord[] stack = new StyleRecord[20];
-
-/**
- * Begins the processing of a style and places a strylRecord on the top
- * of the stack. If the element does not have a style it returns false.
- */
-public boolean startStyle (Element element) {
- return true;
-}
-
-/**
- * Completes the processing of the styleRecord on the top of the stack
- * and pops it.
- */
-public void endStyle () {
-}
-
-/**
- * During editing this method is called to add a new style element to
- * the parse tree at the current location. The element may be the root of a
- * subtree. For example, its children may be emphasized or MathML
- * expressions or images.
- */
-public void applyStyle (Element element) {
-}
-
-}
-
Other related posts:
- » [brailleblaster] [brailleblaster.newdesign] push by john.bo...@xxxxxxxxxxxxxxxxx - Starting on wrapper class org.brailleblaster.document.Document on 2013-01-09 04:59 GMT - brailleblaster
