Thread: [FOray-commit] SF.net SVN: foray:[10907] trunk/foray (Page 4)

SourceForge Headquarters 1320 Columbia Street Suite 310 San Diego, CA 92101 +1 (858) 422-6466

Revision: 10907
          http://foray.svn.sourceforge.net/foray/?rev=10907&view=rev
Author:   victormote
Date:     2010-02-01 18:44:35 +0000 (Mon, 01 Feb 2010)

Log Message:
-----------
Push Commons CLI in a bit further.

Modified Paths:
--------------
    trunk/foray/foray-app/src/java/org/foray/app/CommandLineOptions.java
    trunk/foray/foray-app/src/java/org/foray/app/FOray.java
    trunk/foray/foray-app/src/java/org/foray/app/FOraySpecific.java
    trunk/foray/foray-common/src/java/org/foray/common/StringUtil.java
    trunk/foray/foray-core/src/java/org/foray/core/ConfigurationParser.java
    trunk/foray/foray-core/src/java/org/foray/core/SessionConfig.java

Modified: trunk/foray/foray-app/src/java/org/foray/app/CommandLineOptions.java
===================================================================

--- trunk/foray/foray-app/src/java/org/foray/app/CommandLineOptions.java	2010-02-01 17:09:24 UTC (rev 10906)
+++ trunk/foray/foray-app/src/java/org/foray/app/CommandLineOptions.java	2010-02-01 18:44:35 UTC (rev 10907)
@@ -29,12 +29,14 @@
 package org.foray.app;
 
 import org.foray.common.Logging;
+import org.foray.common.StringUtil;
 import org.foray.common.url.URLFactory;
 import org.foray.common.url.URLUtil;
 import org.foray.core.FOrayException;
 import org.foray.core.SessionConfig;
 import org.foray.output.OutputConfig;
 
+import org.apache.commons.cli.CommandLine;
 import org.apache.commons.logging.Log;
 
 import org.xml.sax.InputSource;
@@ -99,16 +101,21 @@
     /** State variable indicating current index into args[]. */
     private transient int currentArgument = 0;
 
+    /** The command line parsed by Commons CLI. */
+    private CommandLine parsedCommandLine;
+
     /**
      * Constructor.
      * @param args The command-line arguments.
      * @param logger The logger.
+     * @param parsedCommandLine The command line parsed by Commons CLI.
      * @throws FOrayException For errors parsing options.
      * @throws FileNotFoundException For errors finding specified files.
      */
-    public CommandLineOptions(final String[] args, final Log logger)
+    public CommandLineOptions(final String[] args, final Log logger, final CommandLine parsedCommandLine)
             throws FOrayException, FileNotFoundException {
         this.log = logger;
+        this.parsedCommandLine = parsedCommandLine;
 
         boolean optionsParsed = true;
         this.sessionConfig = new SessionConfig(this.log);
@@ -127,6 +134,7 @@
             printUsage(this.log);
             throw e;
         }
+        this.setConfigurationOptions();
     }
 
     /**
@@ -334,9 +342,6 @@
             } else if (this.outputmode == null) {
                 this.outputmode = OutputTargetType.PDF;
                 this.outfile = new File(args[this.currentArgument]);
-            } else {
-                throw new FOrayException("Don't know what to do with "
-                                       + args[this.currentArgument]);
             }
             return true;
         }
@@ -351,8 +356,8 @@
             this.currentArgument++;
             return true;
         }
-        throw new FOrayException("Invalid command-line option: \""
-                + args[this.currentArgument] + "\"");
+        /* TODO: Next statement is not right. This section will be removed after we get converted to Commons CLI. */
+        return true;
     }
 
     /**
@@ -386,6 +391,16 @@
     }
 
     /**
+     * Sets configuration options from parsed command-line options.
+     */
+    private void setConfigurationOptions() {
+        if (this.parsedCommandLine.hasOption("catalogs")) {
+            this.sessionConfig.parseOption("xml-catalog", this.parsedCommandLine.getOptionValue("catalogs"),
+                    OutputConfig.PRECEDENCE_COMMAND_LINE);
+        }
+    }
+
+    /**
      * Sets the output mode.
      * @param mode The new output mode to set.
      * @throws FOrayException If the output mode has already been set.
@@ -460,10 +475,6 @@
         }
     }
 
-//    private void setLogger(final Log newLogger) {
-//        this.log = newLogger;
-//    }
-
     /**
      * Returns the output type specifiedon the command-line.
      * @return The integer representing a Renderer type.
@@ -584,72 +595,90 @@
         return this.language;
     }
 
-//    /**
-//     * return either the fofile or the xmlfile
-//     */
-//    public File getInputFile() {
-//        switch (inputmode) {
-//        case INPUT_FO:
-//            return foInput;
-//        case INPUT_XSLT:
-//            return xmlInput;
-//        default:
-//            return foInput;
-//        }
-//    }
-
     /**
      * Shows the commandline syntax including a summary of all available
      * options and some examples.
      * @param logger The logger on which to print the message.
      */
     public static void printUsage(final Log logger) {
-        logger.error("\nUSAGE\nFOray [options] [-fo|-xml] infile "
+        final String indent1 = " ";
+        final String indent2 = "  ";
+        final String indent2ndLine = "                 ";
+        logger.error(
+                StringUtil.LINE_SEPARATOR
+                + "USAGE"
+                + StringUtil.LINE_SEPARATOR
+                + "FOray [options] [-fo|-xml] infile "
                 + "[-xsl file] [-awt|-pdf|-mif|-pcl|-ps|-txt|-at|-print] "
-                + "<outfile>\n"
-                + " [OPTIONS]\n"
-                + "  -c cfg.xml     use additional configuration file cfg.xml\n"
-                + "  -so option-key option-value\n"
-                + "                 configure a session-option key-value pair\n"
-                + "\n"
-                + " [INPUT]\n"
-                + "  infile            xsl:fo input file (the same as the "
-                + "next)\n"
-                + "  -fo  infile       xsl:fo input file\n"
-                + "  -xml infile       xml input file, must be used together "
-                + "with -xsl\n"
-                + "  -xsl stylesheet   xslt stylesheet\n"
-                + "\n"
-                + " [OUTPUT]\n"
-                + "  outfile           input will be rendered as pdf file "
-                + "into outfile\n"
-                + "  -pdf outfile      input will be rendered as pdf file "
-                + "(outfile req'd)\n"
-                + "  -awt              input will be displayed on screen\n"
-                + "  -mif outfile      input will be rendered as mif file "
-                + "(outfile req'd)\n"
-                + "  -pcl outfile      input will be rendered as pcl file "
-                + "(outfile req'd)\n"
-                + "  -ps outfile       input will be rendered as PostScript "
-                + "file (outfile req'd)\n"
-                + "  -txt outfile      input will be rendered as text file "
-                + "(outfile req'd)\n"
-                + "  -svg outfile      input will be rendered as an svg slides "
-                + "file (outfile req'd)\n"
-                + "  -at outfile       representation of area tree as XML "
-                + "(outfile req'd)\n"
-                + "  -print            input file will be rendered and sent to "
-                + "the printer\n"
-                + "                    see print specific options with "
-                + "\"-print help\"\n"
-                + "\n [Examples]\n"
-                + "  FOray foo.fo foo.pdf\n"
-                + "  FOray -fo foo.fo -pdf foo.pdf (does the same as the "
-                + "previous line)\n"
-                + "  FOray -xsl foo.xsl -xml foo.xml -pdf foo.pdf\n"
-                + "  FOray foo.fo -mif foo.mif\n"
-                + "  FOray foo.fo -print or FOray -print foo.fo\n"
-                + "  FOray foo.fo -awt\n");
+                + "<outfile>"
+                + StringUtil.LINE_SEPARATOR
+                + indent1 + "[OPTIONS]"
+                + StringUtil.LINE_SEPARATOR
+                + indent2 + "-c cfg.xml     use additional configuration file cfg.xml"
+                + StringUtil.LINE_SEPARATOR
+                + indent2 + "-so option-key option-value"
+                + StringUtil.LINE_SEPARATOR
+                + indent2ndLine + "configure a session-option key-value pair"
+                + StringUtil.LINE_SEPARATOR
+                + StringUtil.LINE_SEPARATOR
+                + indent1 + "[INPUT]"
+                + StringUtil.LINE_SEPARATOR
+                + indent2 + "infile            xsl:fo input file (the same as the "
+                + "next)"
+                + StringUtil.LINE_SEPARATOR
+                + indent2 + "-fo  infile       xsl:fo input file"
+                + StringUtil.LINE_SEPARATOR
+                + indent2 + "-xml infile       xml input file, must be used together "
+                + "with -xsl"
+                + StringUtil.LINE_SEPARATOR
+                + indent2 + "-xsl stylesheet   xslt stylesheet"
+                + StringUtil.LINE_SEPARATOR
+                + StringUtil.LINE_SEPARATOR
+                + indent1 + "[OUTPUT]"
+                + StringUtil.LINE_SEPARATOR
+                + indent2 + "outfile           input will be rendered as pdf file "
+                + "into outfile"
+                + StringUtil.LINE_SEPARATOR
+                + indent2 + "-pdf outfile      input will be rendered as pdf file "
+                + "(outfile req'd)"
+                + StringUtil.LINE_SEPARATOR
+                + indent2 + "-awt              input will be displayed on screen"
+                + StringUtil.LINE_SEPARATOR
+                + indent2 + "-mif outfile      input will be rendered as mif file "
+                + "(outfile req'd)"
+                + StringUtil.LINE_SEPARATOR
+                + indent2 + "-pcl outfile      input will be rendered as pcl file "
+                + "(outfile req'd)"
+                + StringUtil.LINE_SEPARATOR
+                + indent2 + "-ps outfile       input will be rendered as PostScript "
+                + "file (outfile req'd)"
+                + StringUtil.LINE_SEPARATOR
+                + indent2 + "-txt outfile      input will be rendered as text file "
+                + "(outfile req'd)"
+                + StringUtil.LINE_SEPARATOR
+                + indent2 + "-svg outfile      input will be rendered as an svg slides "
+                + "file (outfile req'd)"
+                + StringUtil.LINE_SEPARATOR
+                + indent2 + "-at outfile       representation of area tree as XML "
+                + "(outfile req'd)"
+                + StringUtil.LINE_SEPARATOR
+                + indent2 + "-print            input file will be rendered and sent to "
+                + "the printer"
+                + StringUtil.LINE_SEPARATOR
+                + indent2ndLine + "see print specific options with "
+                + "\"-print help\""
+                + StringUtil.LINE_SEPARATOR
+                + StringUtil.LINE_SEPARATOR
+                + indent1 + "[Examples]"
+                + StringUtil.LINE_SEPARATOR
+                + indent2 + FOray.class.getName() + StringUtil.SINGLE_SPACE + FOray.COMMAND_LINE_EXAMPLE_001
+                + StringUtil.LINE_SEPARATOR
+                + indent2 + FOray.class.getName() + StringUtil.SINGLE_SPACE + FOray.COMMAND_LINE_EXAMPLE_002
+                + StringUtil.LINE_SEPARATOR
+                + indent2 + FOray.class.getName() + StringUtil.SINGLE_SPACE + FOray.COMMAND_LINE_EXAMPLE_003
+                + StringUtil.LINE_SEPARATOR
+                + indent2 + FOray.class.getName() + StringUtil.SINGLE_SPACE + FOray.COMMAND_LINE_EXAMPLE_004
+                + StringUtil.LINE_SEPARATOR);
     }
 
     /**

Modified: trunk/foray/foray-app/src/java/org/foray/app/FOray.java
===================================================================
--- trunk/foray/foray-app/src/java/org/foray/app/FOray.java	2010-02-01 17:09:24 UTC (rev 10906)
+++ trunk/foray/foray-app/src/java/org/foray/app/FOray.java	2010-02-01 18:44:35 UTC (rev 10907)
@@ -92,6 +92,12 @@
         configurationFile.setArgName("file");
         clOptions.addOption(configurationFile);
 
+        final Option catalogOption = new Option("catalogs", "xml-catalog", true, "path to an OASOS XML catalog");
+        catalogOption.setRequired(false);
+        catalogOption.setArgName("file");
+        catalogOption.setArgs(Option.UNLIMITED_VALUES);
+        clOptions.addOption(catalogOption);
+
         /* Input. */
         final OptionGroup inputGroup = new OptionGroup();
         inputGroup.setRequired(true);
@@ -179,9 +185,9 @@
     public static void main(final String[] args) {
         /* Checkstyle-GenericIllegalRegexp-Off. */
         final Options commandLineOptions = FOray.getCommandLineOptions();
+        CommandLine parsedCommandLine = null;
         try {
-            /* TODO: Keep the return value and use it downstream. Right now all we are doing is testing the options. */
-            FOray.parseCommandLine(commandLineOptions, args);
+            parsedCommandLine = FOray.parseCommandLine(commandLineOptions, args);
         } catch (final ParseException e) {
             System.out.println(e.getMessage());
             final HelpFormatter helpFormatter = new HelpFormatter();
@@ -193,7 +199,7 @@
         final Log logger = Logging.makeDefaultLogger();
 
         try {
-            options = new CommandLineOptions(args, logger);
+            options = new CommandLineOptions(args, logger, parsedCommandLine);
             final Starter starter = options.getStarter();
             starter.run();
         } catch (final FOrayException e) {

Modified: trunk/foray/foray-app/src/java/org/foray/app/FOraySpecific.java
===================================================================
--- trunk/foray/foray-app/src/java/org/foray/app/FOraySpecific.java	2010-02-01 17:09:24 UTC (rev 10906)
+++ trunk/foray/foray-app/src/java/org/foray/app/FOraySpecific.java	2010-02-01 18:44:35 UTC (rev 10907)
@@ -53,7 +53,6 @@
 import org.axsl.text.TextServer;
 
 import org.apache.commons.logging.Log;
-import org.apache.xerces.util.XMLCatalogResolver;
 
 import org.xml.sax.EntityResolver;
 
@@ -135,7 +134,7 @@
      */
     public static FontServer makeFontServer(final Log logger,
             final SessionConfig configuration) throws FOrayException {
-        final EntityResolver entityResolver = makeEntityResolver(configuration);
+        final EntityResolver entityResolver = configuration.makeEntityResolver();
         final PsServer psServer = FOraySpecific.makePsServer();
         final FontServer4a forayFontServer = new FontServer4a(logger, psServer);
         forayFontServer.setBaseFontURL(
@@ -268,23 +267,4 @@
         return new PsServer4a();
     }
 
-    /**
-     * Create a standard entity resolver for use with FOray.
-     * @param configuration The session configuration.
-     * @return The newly-created entity resolver, or null if no XML catalog
-     * is specified.
-     */
-    public static EntityResolver makeEntityResolver(
-            final SessionConfig configuration) {
-        final String catalog = configuration.optionXMLCatalog();
-        if (catalog == null) {
-            return null;
-        }
-        final String [] catalogs = {catalog};
-        final XMLCatalogResolver resolver = new XMLCatalogResolver();
-        resolver.setPreferPublic(true);
-        resolver.setCatalogList(catalogs);
-        return resolver;
-    }
-
 }

Modified: trunk/foray/foray-common/src/java/org/foray/common/StringUtil.java
===================================================================
--- trunk/foray/foray-common/src/java/org/foray/common/StringUtil.java	2010-02-01 17:09:24 UTC (rev 10906)
+++ trunk/foray/foray-common/src/java/org/foray/common/StringUtil.java	2010-02-01 18:44:35 UTC (rev 10907)
@@ -37,6 +37,12 @@
     /** An empty string suitable for String comparisons or initializations. */
     public static final String EMPTY_STRING = "";
 
+    /** A single space. */
+    public static final String SINGLE_SPACE = " ";
+
+    /** A static capture of the system line separator. */
+    public static final String LINE_SEPARATOR = System.getProperty("line.separator");
+
     /** The null terminator character, used to mark the end of Strings in char arrays in some
      * applications, U+0000. */
     public static final char NULL_TERMINATOR = 0;

Modified: trunk/foray/foray-core/src/java/org/foray/core/ConfigurationParser.java
===================================================================
--- trunk/foray/foray-core/src/java/org/foray/core/ConfigurationParser.java	2010-02-01 17:09:24 UTC (rev 10906)
+++ trunk/foray/foray-core/src/java/org/foray/core/ConfigurationParser.java	2010-02-01 18:44:35 UTC (rev 10907)
@@ -31,7 +31,6 @@
 import org.foray.common.Configuration;
 
 import org.apache.commons.logging.Log;
-import org.apache.xerces.util.XMLCatalogResolver;
 
 import org.xml.sax.Attributes;
 import org.xml.sax.EntityResolver;
@@ -172,8 +171,7 @@
             /* TODO: This is not the right EntityResolver to use. We need to
              * use or create one that can find the configuration parser DTD
              * in a jar file that is part of the distribution. */
-            final EntityResolver entityResolver = makeEntityResolver(
-                    this.sessionConfig);
+            final EntityResolver entityResolver = this.sessionConfig.makeEntityResolver();
             xmlReader.setEntityResolver(entityResolver);
             this.logger.debug("Config: Using "
                     + xmlReader.getClass().getName() + " as SAX2 Parser.");
@@ -186,26 +184,6 @@
     }
 
     /**
-     * Creates and returns an entity resolver.
-     * @param sessionConfig The session configuration, which may contain a
-     * specifier for an XML catalog.
-     * @return The entity resolver, if a catalog has been specified, or null
-     * if not.
-     */
-    public static EntityResolver makeEntityResolver(
-            final SessionConfig sessionConfig) {
-        final String catalog = sessionConfig.optionXMLCatalog();
-        if (catalog == null) {
-            return null;
-        }
-        final String [] catalogs = {catalog};
-        final XMLCatalogResolver resolver = new XMLCatalogResolver();
-        resolver.setPreferPublic(true);
-        resolver.setCatalogList(catalogs);
-        return resolver;
-    }
-
-    /**
      * {@inheritDoc}
      */
     public void startDocument() {

Modified: trunk/foray/foray-core/src/java/org/foray/core/SessionConfig.java
===================================================================
--- trunk/foray/foray-core/src/java/org/foray/core/SessionConfig.java	2010-02-01 17:09:24 UTC (rev 10906)
+++ trunk/foray/foray-core/src/java/org/foray/core/SessionConfig.java	2010-02-01 18:44:35 UTC (rev 10907)
@@ -31,7 +31,10 @@
 import org.foray.common.Configuration;
 
 import org.apache.commons.logging.Log;
+import org.apache.xerces.util.XMLCatalogResolver;
 
+import org.xml.sax.EntityResolver;
+
 import java.net.URL;
 
 /**
@@ -252,6 +255,23 @@
     }
 
     /**
+     * Creates and returns an entity resolver.
+     * @return The entity resolver, if a catalog has been specified, or null
+     * if not.
+     */
+    public EntityResolver makeEntityResolver() {
+        final String catalog = this.optionXMLCatalog();
+        if (catalog == null) {
+            return null;
+        }
+        final String [] catalogs = {catalog};
+        final XMLCatalogResolver resolver = new XMLCatalogResolver();
+        resolver.setPreferPublic(true);
+        resolver.setCatalogList(catalogs);
+        return resolver;
+    }
+
+    /**
      * Sets the path to the base document that should be used for finding
      * resources with relative URLs.
      * @param baseDocument The path to the base document.


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.




Thread: [FOray-commit] SF.net SVN: foray:[10907] trunk/foray (Page 4)

Modular XSL-FO Implementation for Java.

foray-commit