adds hyphenation (Carlos Villegas, Fotis Jannidis) and simple configuration support (F.J.)

git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@193861 13f79535-47bb-0310-9956-ffa450edef68

5 files changed, 338 insertions, 132 deletions

diff --git a/lib/Fop.class b/lib/Fop.class
index 34a0f1011..c905191b0 100644
--- a/lib/Fop.class
+++ b/lib/Fop.class
diff --git a/lib/Fop.java b/lib/Fop.java
index cd929c7fa..dbe4c568a 100644
--- a/lib/Fop.java
+++ b/lib/Fop.java
@@ -3,34 +3,34 @@
  ============================================================================
                    The Apache Software License, Version 1.1
  ============================================================================
- 
+
     Copyright (C) 1999 The Apache Software Foundation. All rights reserved.
- 
+
  Redistribution and use in source and binary forms, with or without modifica-
  tion, are permitted provided that the following conditions are met:
- 
+
  1. Redistributions of  source code must  retain the above copyright  notice,
     this list of conditions and the following disclaimer.
- 
+
  2. Redistributions in binary form must reproduce the above copyright notice,
     this list of conditions and the following disclaimer in the documentation
     and/or other materials provided with the distribution.
- 
+
  3. The end-user documentation included with the redistribution, if any, must
     include  the following  acknowledgment:  "This product includes  software
     developed  by the  Apache Software Foundation  (http://www.apache.org/)."
     Alternately, this  acknowledgment may  appear in the software itself,  if
     and wherever such third-party acknowledgments normally appear.
- 
+
  4. The names "Fop" and  "Apache Software Foundation"  must not be used to
     endorse  or promote  products derived  from this  software without  prior
     written permission. For written permission, please contact
     apache@apache.org.
- 
+
  5. Products  derived from this software may not  be called "Apache", nor may
     "Apache" appear  in their name,  without prior written permission  of the
     Apache Software Foundation.
- 
+
  THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
  INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
  FITNESS  FOR A PARTICULAR  PURPOSE ARE  DISCLAIMED.  IN NO  EVENT SHALL  THE
@@ -41,12 +41,12 @@
  ANY  THEORY OF LIABILITY,  WHETHER  IN CONTRACT,  STRICT LIABILITY,  OR TORT
  (INCLUDING  NEGLIGENCE OR  OTHERWISE) ARISING IN  ANY WAY OUT OF THE  USE OF
  THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- 
+
  This software  consists of voluntary contributions made  by many individuals
  on  behalf of the Apache Software  Foundation and was  originally created by
- James Tauber <jtauber@jtauber.com>. For more  information on the Apache 
+ James Tauber <jtauber@jtauber.com>. For more  information on the Apache
  Software Foundation, please see <http://www.apache.org/>.
- 
+
  */
 
 // Ant
@@ -74,137 +74,144 @@ import org.apache.fop.messaging.MessageHandler;
 import org.apache.fop.apps.*;
 
 /**
- * extension to Ant which allows usage of Fop in the 
+ * extension to Ant which allows usage of Fop in the
  * same way as org.apache.fop.apps.CommandLine (the code is adapted from this class)
  * Gets input and output filenames from the script file <br/>
- * needed libraries: Sax 2 parser (defaults to Xerces-J), Jimi for images, w3c.jar 
+ * needed libraries: Sax 2 parser (defaults to Xerces-J), Jimi for images, w3c.jar
  * containing org.w3c.dom.svg etc. for svg support
  */
 
 public class Fop {
-  String fofile, pdffile;
-  
-  /**
-   * sets the name of the input file
-   * @param String name of the input fo file 
-   */
-  public void setFofile(String fofile) {
-    this.fofile = fofile;
-  }
-  
-  /**
-   * sets the name of the output file
-   * @param String name of the output pdf file 
-   */
-  public void setPdffile(String pdffile) {
-    this.pdffile = pdffile;
-  }
-  
-
-  /**
-   * creates a SAX parser, using the value of org.xml.sax.parser
-   * defaulting to org.apache.xerces.parsers.SAXParser
-   *
-   * @return the created SAX parser
-   */
-  static XMLReader createParser() {
-    String parserClassName =
-        System.getProperty("org.xml.sax.parser");
-    if (parserClassName == null) {
-        parserClassName = "org.apache.xerces.parsers.SAXParser";
-    }
-    MessageHandler.logln("using SAX parser " + parserClassName);
-
-    try {
-        return (XMLReader)
-          Class.forName(parserClassName).newInstance();
-    } catch (ClassNotFoundException e) {
-        MessageHandler.errorln("Could not find " + parserClassName);
-    } catch (InstantiationException e) {
-        MessageHandler.errorln("Could not instantiate "
-                       + parserClassName);
-    } catch (IllegalAccessException e) {
-        MessageHandler.errorln("Could not access " + parserClassName);
-    } catch (ClassCastException e) {
-        MessageHandler.errorln(parserClassName + " is not a SAX driver"); 
-    }
-    return null;
-  }  // end: createParser
-
-  /**
-   * create an InputSource from a file name
-   *
-   * @param filename the name of the file
-   * @return the InputSource created
-   */
-  protected static InputSource fileInputSource(String filename) {
-
-    /* this code adapted from James Clark's in XT */
-    File file = new File(filename);
-    String path = file.getAbsolutePath();
-    String fSep = System.getProperty("file.separator");
-    if (fSep != null && fSep.length() == 1)
-        path = path.replace(fSep.charAt(0), '/');
-    if (path.length() > 0 && path.charAt(0) != '/')
-        path = '/' + path;
-    try {
-        return new InputSource(new URL("file", null,
-               path).toString());
-    }
-    catch (java.net.MalformedURLException e) {
-        throw new Error("unexpected MalformedURLException");
-    }
-  }  // end: fileInputSource
-
-  /**
-   * main method, starts execution of this task
-   * 
-   */
-  public void execute () throws BuildException {
-    boolean errors = false;
-    String version = Version.getVersion();
-    MessageHandler.logln("=======================\nTask " + version + 
-                       "\nconverting file " + fofile + " to " + pdffile);
-  
-    if (!(new File(fofile).exists())) {
-      errors = true;
-      MessageHandler.errorln("Task Fop - ERROR: Formatting objects file " + fofile + " missing.");
-    }
-  
-    XMLReader parser = createParser();
-  
-    if (parser == null) {
-        MessageHandler.errorln("Task Fop - ERROR: Unable to create SAX parser");
-        errors = true;
+    String fofile, pdffile;
+
+    /**
+     * sets the name of the input file
+     * @param String name of the input fo file
+     */
+    public void setFofile(String fofile) {
+        this.fofile = fofile;
     }
 
-    // setting the parser features
-    try {
-      parser.setFeature("http://xml.org/sax/features/namespace-prefixes", true);
-    } catch (SAXException e) {
-      MessageHandler.errorln("Error in setting up parser feature namespace-prefixes");
-      MessageHandler.errorln("You need a parser which supports SAX version 2");  
-      System.exit(1);  
+    /**
+      * sets the name of the output file
+      * @param String name of the output pdf file
+      */
+    public void setPdffile(String pdffile) {
+        this.pdffile = pdffile;
     }
 
-    if (!errors) {
-      try {
+
+    /**
+      * creates a SAX parser, using the value of org.xml.sax.parser
+      * defaulting to org.apache.xerces.parsers.SAXParser
+      *
+      * @return the created SAX parser
+      */
+    static XMLReader createParser() {
+        String parserClassName = System.getProperty("org.xml.sax.parser");
+        if (parserClassName == null) {
+            parserClassName = "org.apache.xerces.parsers.SAXParser";
+        }
+        MessageHandler.logln("using SAX parser " + parserClassName);
+
+        try {
+            return (XMLReader) Class.forName(
+                     parserClassName).newInstance();
+        } catch (ClassNotFoundException e) {
+            MessageHandler.errorln("Could not find " + parserClassName);
+        }
+        catch (InstantiationException e) {
+            MessageHandler.errorln("Could not instantiate " +
+                                   parserClassName);
+        }
+        catch (IllegalAccessException e) {
+            MessageHandler.errorln("Could not access " + parserClassName);
+        }
+        catch (ClassCastException e) {
+            MessageHandler.errorln(parserClassName + " is not a SAX driver");
+        }
+        return null;
+    } // end: createParser
+
+    /**
+     * create an InputSource from a file name
+     *
+     * @param filename the name of the file
+     * @return the InputSource created
+     */
+    protected static InputSource fileInputSource(String filename) {
+
+        /* this code adapted from James Clark's in XT */
+        File file = new File(filename);
+        String path = file.getAbsolutePath();
+        String fSep = System.getProperty("file.separator");
+        if (fSep != null && fSep.length() == 1)
+            path = path.replace(fSep.charAt(0), '/');
+        if (path.length() > 0 && path.charAt(0) != '/')
+            path = '/' + path;
+        try {
+            return new InputSource(new URL("file", null, path).toString());
+        } catch (java.net.MalformedURLException e) {
+            throw new Error("unexpected MalformedURLException");
+        }
+    } // end: fileInputSource
+
+    /**
+     * main method, starts execution of this task
+     *
+     */
+    public void execute () throws BuildException {
         Driver driver = new Driver();
-        driver.setRenderer("org.apache.fop.render.pdf.PDFRenderer", version);
-        driver.addElementMapping("org.apache.fop.fo.StandardElementMapping");
-        driver.addElementMapping("org.apache.fop.svg.SVGElementMapping");
-	    driver.addPropertyList("org.apache.fop.fo.StandardPropertyListMapping");
-	    driver.addPropertyList("org.apache.fop.svg.SVGPropertyListMapping");
-        driver.setWriter(new PrintWriter(new FileWriter(pdffile)));
-        driver.buildFOTree(parser, fileInputSource(fofile));
-        driver.format();
-        driver.render();
-      } catch (Exception e) {
-        MessageHandler.errorln("Task Fop - FATAL ERROR: " + e.getMessage());
-        System.exit(1);
-      }
-    }
-    MessageHandler.logln("=======================\n");  
-  } // end: execute
+        driver.loadStandardConfiguration("standard");
+        driver.setBaseDir(fofile);
+        boolean errors = false;
+        String version = Version.getVersion();
+        MessageHandler.logln("=======================\nTask " +
+                             version + "\nconverting file " + fofile + " to " + pdffile);
+
+        if (!(new File(fofile).exists())) {
+            errors = true;
+            MessageHandler.errorln(
+              "Task Fop - ERROR: Formatting objects file " +
+              fofile + " missing.");
+        }
+
+        XMLReader parser = createParser();
+
+        if (parser == null) {
+            MessageHandler.errorln("Task Fop - ERROR: Unable to create SAX parser");
+            errors = true;
+        }
+
+        // setting the parser features
+        try {
+            parser.setFeature("http://xml.org/sax/features/namespace-prefixes",
+                              true);
+        } catch (SAXException e) {
+            MessageHandler.errorln("Error in setting up parser feature namespace-prefixes");
+            MessageHandler.errorln("You need a parser which supports SAX version 2");
+            System.exit(1);
+        }
+
+        if (!errors) {
+            try {
+                driver.setRenderer("org.apache.fop.render.pdf.PDFRenderer",
+                                   version);
+                driver.addElementMapping("org.apache.fop.fo.StandardElementMapping");
+                driver.addElementMapping("org.apache.fop.svg.SVGElementMapping");
+                driver.addPropertyList("org.apache.fop.fo.StandardPropertyListMapping");
+                driver.addPropertyList("org.apache.fop.svg.SVGPropertyListMapping");
+                driver.setWriter(new PrintWriter(new FileWriter(pdffile)));
+                driver.buildFOTree(parser, fileInputSource(fofile));
+                driver.format();
+                driver.render();
+            } catch (Exception e) {
+                MessageHandler.errorln("Task Fop - FATAL ERROR: " +
+                                       e.getMessage());
+                System.exit(1);
+            }
+        }
+        MessageHandler.logln("=======================\n");
+    } // end: execute
 }
 
diff --git a/lib/SerializeHyphPattern.class b/lib/SerializeHyphPattern.class
new file mode 100644
index 000000000..375be27a0
--- /dev/null
+++ b/lib/SerializeHyphPattern.class
diff --git a/lib/SerializeHyphPattern.java b/lib/SerializeHyphPattern.java
new file mode 100644
index 000000000..f43f6d762
--- /dev/null
+++ b/lib/SerializeHyphPattern.java
@@ -0,0 +1,198 @@
+/*
+ * The Apache Software License, Version 1.1
+ *
+ * Copyright (c) 1999 The Apache Software Foundation.  All rights
+ * reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright
+ *  notice, this list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *  notice, this list of conditions and the following disclaimer in
+ *  the documentation and/or other materials provided with the
+ *  distribution.
+ *
+ * 3. The end-user documentation included with the redistribution, if
+ *  any, must include the following acknowlegement:
+ *     "This product includes software developed by the
+ *    Apache Software Foundation (http://www.apache.org/)."
+ *  Alternately, this acknowlegement may appear in the software itself,
+ *  if and wherever such third-party acknowlegements normally appear.
+ *
+ * 4. The names "The Jakarta Project", "Tomcat", and "Apache Software
+ *  Foundation" must not be used to endorse or promote products derived
+ *  from this software without prior written permission. For written
+ *  permission, please contact apache@apache.org.
+ *
+ * 5. Products derived from this software may not be called "Apache"
+ *  nor may "Apache" appear in their names without prior written
+ *  permission of the Apache Group.
+ *
+ * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
+ * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+ * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
+ * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
+ * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
+ * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ * SUCH DAMAGE.
+ * ====================================================================
+ *
+ * This software consists of voluntary contributions made by many
+ * individuals on behalf of the Apache Software Foundation.  For more
+ * information on the Apache Software Foundation, please see
+ * <http://www.apache.org/>.
+ */
+
+//package org.apache.tools.ant.taskdefs;
+
+import org.apache.tools.ant.taskdefs.MatchingTask;
+import org.apache.tools.ant.DirectoryScanner;
+import java.net.*;
+import java.io.*;
+import java.util.*;
+import org.xml.sax.SAXException;
+
+//fop
+import org.apache.fop.layout.hyphenation.HyphenationTree;
+import org.apache.fop.layout.hyphenation.HyphenationException;
+
+/**
+ *    SerializeHyphPattern
+ */
+
+
+public class SerializeHyphPattern extends MatchingTask {
+    private File sourceDir, targetDir;
+    private boolean errorDump = false;
+
+    /**
+       *  Main method, which is called by ant.
+       */
+    public void execute () throws org.apache.tools.ant.BuildException {
+        DirectoryScanner ds = this.getDirectoryScanner(sourceDir);
+        String[] files = ds.getIncludedFiles();
+        for (int i = 0; i < files.length ; i++) {
+            processFile(files[i].substring(0, files[i].length() - 4));
+        }
+    } //end execute
+
+
+    /**
+       * Sets the source directory
+       *
+       */
+    public void setSourceDir (String sourceDir) {
+        File dir = new File(sourceDir);
+        if (!dir.exists()) {
+            System.err.println("Fatal Error: source directory " +
+                               sourceDir + " for hyphenation files doesn't exist.");
+            System.exit(1);
+        }
+        this.sourceDir = dir;
+    }
+
+    /**
+         * Sets the target directory
+         *
+         */
+    public void setTargetDir (String targetDir) {
+        File dir = new File(targetDir);
+        this.targetDir = dir;
+    }
+
+    /**
+         * more error information
+         *
+         */
+    public void setErrorDump (boolean errorDump) {
+        this.errorDump = errorDump;
+    }
+
+
+    /*
+      * checks whether input or output files exists or the latter is older than input file
+      * and start build if necessary
+      */
+    private void processFile (String filename) {
+        File infile = new File (sourceDir , filename + ".xml");
+        File outfile = new File(targetDir , filename + ".hyp");
+        long outfileLastModified = outfile.lastModified();
+        boolean startProcess = true;
+
+        startProcess = rebuild(infile, outfile);
+        if (startProcess) {
+            buildPatternFile(infile, outfile);
+        }
+    }
+
+    /*
+       * serializes pattern files
+       */
+    private void buildPatternFile (File infile, File outfile) {
+        System.out.println("Processing " + infile);
+        HyphenationTree hTree = new HyphenationTree();
+        try {
+            hTree.loadPatterns(infile.toString());
+            if (errorDump) {
+                System.out.println("Stats: ");
+                hTree.printStats();
+            }
+        } catch (HyphenationException ex) {
+            System.err.println("Can't load patterns from xml file " +
+                               infile + " - Maybe hyphenation.dtd is missing?");
+            if (errorDump) {
+                System.err.println(ex.toString());
+            }
+        }
+        //serialize class
+        try {
+            ObjectOutputStream out = new ObjectOutputStream (
+                                       new FileOutputStream(outfile));
+            out.writeObject(hTree);
+            out.close();
+        } catch (IOException ioe) {
+            System.err.println("Can't write compiled pattern file: " +
+                               outfile);
+            System.err.println(ioe);
+        }
+    }
+
+    /**
+       *  Checks for existence of output file and compares
+       *  dates with input and stylesheet file
+       */
+    private boolean rebuild (File infile, File outfile) {
+        if (outfile.exists()) {
+            //checks whether output file is older than input file
+            if (outfile.lastModified() < infile.lastModified()) {
+                return true;
+            }
+        } else {
+            //if output file does not exist, start process
+            return true;
+        }
+        return false;
+    } //end rebuild
+
+/*
+    //quick access for debugging
+    public static void main (String args[]) {
+        SerializeHyphPattern ser = new SerializeHyphPattern();
+        ser.setIncludes("*.xml");
+        ser.setSourceDir("\\xml-fop\\hyph\\");
+        ser.setTargetDir("\\xml-fop\\hyph\\");
+        ser.execute();
+    }
+*/
+
+
+}
diff --git a/lib/readme b/lib/readme
index d99053365..3dafbcf89 100644
--- a/lib/readme
+++ b/lib/readme
@@ -9,3 +9,4 @@ w3c.jar                  the svg library from the w3 consortium
 Compare.java             a ant task which compares files
 Fop.java                 a ant task which allows calling Fop from Ant 
 Xslt.java                a ant task which allows calling Xalan from Ant
+SerializeHyphPattern     a ant task which serializes hyphenation patterns for quicker access