123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527 |
- /*
- * Copyright (C) 2001 The Apache Software Foundation. All rights reserved.
- * For details on use and redistribution please refer to the
- * LICENSE file included with these sources."
- */
-
-
- package org.apache.fop.apps;
-
- //java
- import java.util.Vector;
- import java.io.File;
-
- // FOP
- import org.apache.fop.messaging.MessageHandler;
- import org.apache.fop.configuration.Configuration;
- import org.apache.fop.apps.FOPException;
-
- /**
- * Options parses the commandline arguments
- */
-
- public class CommandLineOptions {
-
- /* input / output not set */
- private static final int NOT_SET = 0;
- /* input: fo file */
- private static final int FO_INPUT = 1;
- /* input: xml+xsl file */
- private static final int XSLT_INPUT = 2;
- /* output: pdf file */
- private static final int PDF_OUTPUT = 1;
- /* output: screen using swing */
- private static final int AWT_OUTPUT = 2;
- /* output: mif file */
- private static final int MIF_OUTPUT = 3;
- /* output: sent swing rendered file to printer */
- private static final int PRINT_OUTPUT = 4;
-
- /* use debug mode*/
- Boolean errorDump = null;
- /* show configuration information */
- Boolean dumpConfiguration = null;
- /*suppress any progress information */
- Boolean quiet = null;
- /* name of user configuration file*/
- File userConfigFile = null;
- /* name of input fo file */
- File fofile = null;
- /* name of xsltfile (xslt transformation as input)*/
- File xsltfile = null;
- /* name of xml file (xslt transformation as input)*/
- File xmlfile = null;
- /* name of output file */
- File outfile = null;
- /* input mode */
- int inputmode = NOT_SET;
- /*output mode */
- int outputmode = NOT_SET;
- /* language for user information */
- String language = null;
-
- public CommandLineOptions (String [] args) {
- parseOptions(args);
- checkSettings ();
- if (errorDump != null && errorDump.booleanValue()) {
- debug();
- }
- }
-
- /**
- * parses the commandline arguments
- */
- private void parseOptions (String args[]) {
- for (int i = 0; i < args.length; i++) {
- if (args[i].equals("-d") || args[i].equals("--full-error-dump")) {
- errorDump = new Boolean(true);
- } else if (args[i].equals("-x") || args[i].equals("--dump-config")) {
- dumpConfiguration = new Boolean(true);
- } else if (args[i].equals("-q") || args[i].equals("--quiet")) {
- quiet = new Boolean(true);
- } else if (args[i].equals("-c")) {
- if ((i + 1 == args.length) ||
- (args[i + 1].charAt(0) == '-')) {
- MessageHandler.errorln("ERROR: if you use '-c', you must specify the name of the configuration file");
- printUsage();
- } else {
- userConfigFile = new File (args[i + 1]);
- i++;
- }
- } else if (args[i].equals("-l")) {
- if ((i + 1 == args.length) ||
- (args[i + 1].charAt(0) == '-')) {
- MessageHandler.errorln("ERROR: if you use '-l', you must specify a language");
- printUsage();
- } else {
- language = args[i + 1];
- i++;
- }
- } else if (args[i].equals("-fo")) {
- inputmode = FO_INPUT;
- if ((i + 1 == args.length) ||
- (args[i + 1].charAt(0) == '-')) {
- MessageHandler.errorln("ERROR: you must specify the fo file");
- printUsage();
- } else {
- fofile = new File (args[i + 1]);
- i++;
- }
- } else if (args[i].equals("-xsl")) {
- inputmode = XSLT_INPUT;
- if ((i + 1 == args.length) ||
- (args[i + 1].charAt(0) == '-')) {
- MessageHandler.errorln("ERROR: you must specify the stylesheet file");
- printUsage();
- } else {
- xsltfile = new File(args[i + 1]);
- i++;
- }
- } else if (args[i].equals("-xml")) {
- inputmode = XSLT_INPUT;
- if ((i + 1 == args.length) ||
- (args[i + 1].charAt(0) == '-')) {
- MessageHandler.errorln("ERROR: you must specify the input file");
- printUsage();
- } else {
- xmlfile = new File(args[i + 1]);
- i++;
- }
- } else if (args[i].equals("-awt")) {
- if (outputmode == NOT_SET) {
- outputmode = AWT_OUTPUT;
- } else {
- MessageHandler.errorln("ERROR: you can only set one output method");
- printUsage();
- }
- } else if (args[i].equals("-pdf")) {
- if (outputmode == NOT_SET) {
- outputmode = PDF_OUTPUT;
- } else {
- MessageHandler.errorln("ERROR: you can only set one output method");
- printUsage();
- }
- if ((i + 1 == args.length) ||
- (args[i + 1].charAt(0) == '-')) {
- MessageHandler.errorln("ERROR: you must specify the pdf output file");
- printUsage();
- } else {
- outfile = new File (args[i + 1]);
- i++;
- }
- } else if (args[i].equals("-mif")) {
- if (outputmode == NOT_SET) {
- outputmode = MIF_OUTPUT;
- } else {
- MessageHandler.errorln("ERROR: you can only set one output method");
- printUsage();
- }
- if ((i + 1 == args.length) ||
- (args[i + 1].charAt(0) == '-')) {
- MessageHandler.errorln("ERROR: you must specify the mif output file");
- printUsage();
- } else {
- outfile = new File(args[i + 1]);
- i++;
- }
- } else if (args[i].equals("-print")) {
- if (outputmode == NOT_SET) {
- outputmode = PRINT_OUTPUT;
- } else {
- MessageHandler.errorln("ERROR: you can only set one output method");
- printUsage();
- }
- //show print help
- if (i + 1 < args.length) {
- if (args[i + 1].equals("help")) {
- printUsagePrintOutput();
- }
- }
- }
- else if (args[i].charAt(0) != '-') {
- if (inputmode == NOT_SET) {
- inputmode = FO_INPUT;
- fofile = new File (args[i]);
- } else if (outputmode == NOT_SET) {
- outputmode = PDF_OUTPUT;
- outfile = new File(args[i]);
- } else {
- MessageHandler.errorln(
- "ERROR: Don't know what to do with " + args[i]);
- printUsage();
- }
- } else {
- printUsage();
- }
- }
- } //end parseOptions
-
- /**
- * checks whether all necessary information has been given in a consistent way
- */
- private void checkSettings () {
- if (inputmode == NOT_SET) {
- MessageHandler.errorln("ERROR: you have to specify an input file");
- printUsage();
- }
-
- if (outputmode == NOT_SET) {
- MessageHandler.errorln("ERROR: you have to specify an output mode");
- printUsage();
- }
-
- if (inputmode == XSLT_INPUT) {
- //check whether xml *and* xslt file have been set
- if (xmlfile == null || xsltfile == null) {
- MessageHandler.errorln(
- "ERROR: if you want to use an xml file transformed with an xslt file as input\n" +
- " you must specify both files. \n" +
- " Your input is \nxmlfile: " +
- xmlfile.getAbsolutePath() + "\nxsltfile: " +
- xsltfile.getAbsolutePath());
- printUsage();
- }
- //warning if fofile has been set in xslt mode
- if (fofile != null) {
- MessageHandler.errorln(
- "ERROR: Can't use fo file in transformation!" +
- " Your input is \nxmlfile: " +
- xmlfile.getAbsolutePath() + "\nxsltfile: " +
- xsltfile.getAbsolutePath() + "\nfofile: " +
- fofile.getAbsolutePath());
- }
- if (!xmlfile.exists()) {
- MessageHandler.errorln("ERROR: xml file " +
- xmlfile.getAbsolutePath() + " not found ");
- System.exit(1);
- }
- if (!xsltfile.exists()) {
- MessageHandler.errorln("ERROR: xsl file " +
- xsltfile.getAbsolutePath() + " not found ");
- System.exit(1);
- }
-
- } else if (inputmode == FO_INPUT) {
- if (xmlfile != null || xsltfile != null) {
- MessageHandler.logln("ERROR: fo input mode, but xmlfile or xslt file are set:");
- MessageHandler.logln("xml file: " + xmlfile.toString());
- MessageHandler.logln("xslt file: " + xsltfile.toString());
- }
- if (!fofile.exists()) {
- MessageHandler.errorln("ERROR: fo file " +
- fofile.getAbsolutePath() + " not found ");
- System.exit(1);
- }
-
- }
- }// end checkSettings
-
-
- /**
- * returns the chosen renderer, throws FOPException
- */
- public int getRenderer () throws FOPException {
- switch (outputmode) {
- case NOT_SET:
- throw new FOPException("Renderer has not been set!");
- case PDF_OUTPUT:
- return Driver.RENDER_PDF;
- case AWT_OUTPUT:
- return Driver.RENDER_AWT;
- case MIF_OUTPUT:
- return Driver.RENDER_MIF;
- case PRINT_OUTPUT:
- return Driver.RENDER_PRINT;
- default:
- throw new FOPException("Invalid Renderer setting!");
- }
- }
-
- /**
- *
- **/
- public InputHandler getInputHandler () {
- switch (inputmode) {
- case FO_INPUT:
- return new FOInputHandler(fofile);
- case XSLT_INPUT:
- return new XSLTInputHandler(xmlfile, xsltfile);
- default:
- return new FOInputHandler(fofile);
- }
- }
-
-
- public Starter getStarter() {
- switch (outputmode) {
- case PDF_OUTPUT:
- return new CommandLineStarter(this);
- case AWT_OUTPUT:
- try {
- return((Starter) Class.forName(
- "org.apache.fop.apps.AWTStarter").
- getConstructor(
- new Class[]{CommandLineOptions.class}).
- newInstance(new Object[]{this}));
- } catch (Exception e) {
- MessageHandler.errorln(
- "ERROR: AWTStarter could not be loaded. " +
- e.toString());
- return(null);
- }
- case MIF_OUTPUT:
- return new CommandLineStarter(this);
- case PRINT_OUTPUT:
- try {
- return((Starter) Class.forName(
- "org.apache.fop.apps.PrintStarter").
- getConstructor(
- new Class[]{CommandLineOptions.class}).
- newInstance(new Object[]{this}));
- } catch (Exception e) {
- MessageHandler.errorln(
- "ERROR: PrintStarter could not be loaded. " +
- e.toString());
- return(null);
- }
-
- default:
- return new CommandLineStarter(this);
- }
- }
-
- public int getInputMode() {
- return inputmode;
- }
-
- public int getOutputMode() {
- return outputmode;
- }
-
- public File getFOFile() {
- return fofile;
- }
-
- public File getXMLFile() {
- return xmlfile;
- }
-
- public File getXSLFile() {
- return xsltfile;
- }
-
- public File getOutputFile() {
- return outfile;
- }
-
- public File getUserConfigFile () {
- return userConfigFile;
- }
-
- public String getLanguage() {
- return language;
- }
-
- public Boolean isQuiet() {
- return quiet;
- }
-
- public Boolean dumpConfiguration() {
- return dumpConfiguration;
- }
-
- public Boolean isDebugMode() {
- return errorDump;
- }
-
-
- /**
- * return either the fofile or the xmlfile
- */
- public File getInputFile() {
- switch (inputmode) {
- case FO_INPUT:
- return fofile;
- case XSLT_INPUT:
- return xmlfile;
- default:
- return fofile;
- }
- }
-
-
- /**
- * shows the commandline syntax including a summary of all available options and some examples
- */
- public static void printUsage() {
- MessageHandler.logln(
- "\nUSAGE\nFop [options] [-fo|-xml] infile [-xsl file] [-awt|-pdf|-mif|-print] <outfile>\n" +
- " [OPTIONS] \n" + " -d debug mode \n" +
- " -x dump configuration settings \n" +
- " -q quiet mode \n" +
- " -c cfg.xml use additional configuration file cfg.xml\n" +
- " -l lang the language to use for user information \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" +
- " -print input file will be rendered and sent to the printer \n" +
- " see options with \"-print help\" \n\n" +
- " [Examples]\n" + " Fop foo.fo foo.pdf \n" +
- " Fop -fo foo.fo -pdf foo.pdf (does the same as the previous line)\n" +
- " Fop -xsl foo.xsl -xml foo.xml -pdf foo.pdf\n" +
- " Fop foo.fo -mif foo.mif\n" +
- " Fop foo.fo -print or Fop -print foo.fo \n" + " Fop foo.fo -awt ");
- System.exit(1);
- }
-
- /**
- * shows the options for print output
- */
- public void printUsagePrintOutput() {
- MessageHandler.errorln(
- "USAGE: -print [-Dstart=i] [-Dend=i] [-Dcopies=i] [-Deven=true|false] " +
- " org.apache.fop.apps.Fop (..) -print \n" +
- "Example:\n" + "java -Dstart=1 -Dend=2 org.apache.Fop.apps.Fop infile.fo -print ");
- System.exit(1);
- }
-
-
- /**
- * debug mode. outputs all commandline settings
- */
- private void debug () {
- System.out.print("Input mode: ");
- switch (inputmode) {
- case NOT_SET:
- MessageHandler.logln("not set");
- break;
- case FO_INPUT:
- MessageHandler.logln("FO ");
- MessageHandler.logln("fo input file: " + fofile.toString());
- break;
- case XSLT_INPUT:
- MessageHandler.logln("xslt transformation");
- MessageHandler.logln("xml input file: " +
- xmlfile.toString());
- MessageHandler.logln("xslt stylesheet: " +
- xsltfile.toString());
- break;
- default:
- MessageHandler.logln("unknown input type");
- }
- System.out.print("Output mode: ");
- switch (outputmode) {
- case NOT_SET:
- MessageHandler.logln("not set");
- break;
- case PDF_OUTPUT:
- MessageHandler.logln("pdf");
- MessageHandler.logln("output file: " + outfile.toString());
- break;
- case AWT_OUTPUT:
- MessageHandler.logln("awt on screen");
- if (outfile != null) {
- MessageHandler.logln("ERROR: awt mode, but outfile is set:");
- MessageHandler.logln("out file: " + outfile.toString());
- }
- break;
- case MIF_OUTPUT:
- MessageHandler.logln("mif");
- MessageHandler.logln("output file: " + outfile.toString());
- break;
- case PRINT_OUTPUT:
- MessageHandler.logln("print directly");
- if (outfile != null) {
- MessageHandler.logln("ERROR: print mode, but outfile is set:");
- MessageHandler.logln("out file: " + outfile.toString());
- }
- break;
- default:
- MessageHandler.logln("unknown input type");
- }
-
-
- MessageHandler.logln("OPTIONS");
- if (userConfigFile != null) {
- MessageHandler.logln("user configuration file: " +
- userConfigFile.toString());
- } else {
- MessageHandler.logln("no user configuration file is used [default]");
- }
- if (errorDump != null) {
- MessageHandler.logln("debug mode on");
- } else {
- MessageHandler.logln("debug mode off [default]");
- }
- if (dumpConfiguration != null) {
- MessageHandler.logln("dump configuration");
- } else {
- MessageHandler.logln("don't dump configuration [default]");
- }
- if (quiet != null) {
- MessageHandler.logln("quiet mode on");
- } else {
- MessageHandler.logln("quiet mode off [default]");
- }
-
- }
-
- //debug: create class and output all settings
- public static void main (String args[]) {
- /*
- for (int i = 0; i < args.length; i++) {
- MessageHandler.logln(">"+args[i]+"<");
- }*/
-
- CommandLineOptions options = new CommandLineOptions (args);
- //options.debug();
- }
- }
|