Changeset 2607

Timestamp:

10/29/08 16:51:15 (2 months ago)

Author:

leo

Message:

OptionParser?: help message done.

Location:

XerialJ/trunk/xerial-core/src

Files:

• main/java/org/xerial/core/XerialErrorCode.java (modified) (1 diff)
• main/java/org/xerial/util/Algorithm.java (modified) (1 diff)
• main/java/org/xerial/util/Range.java (modified) (2 diffs)
• main/java/org/xerial/util/log/Logger.java (modified) (6 diffs)
• main/java/org/xerial/util/shell/Argument.java (modified) (1 diff)
• main/java/org/xerial/util/shell/ArgumentItem.java (modified) (2 diffs)
• main/java/org/xerial/util/shell/Option.java (modified) (2 diffs)
• main/java/org/xerial/util/shell/OptionItem.java (modified) (5 diffs)
• main/java/org/xerial/util/shell/OptionParser.java (modified) (4 diffs)
• main/java/org/xerial/util/shell/OptionSchema.java (modified) (6 diffs)
• main/java/org/xerial/util/shell/OptionSetterViaField.java (modified) (2 diffs)
• main/java/org/xerial/util/shell/OptionSetterViaMethod.java (modified) (4 diffs)
• main/java/org/xerial/util/shell/Usage.java (added)
• test/java/org/xerial/util/shell/OptionParserTest.java (modified) (3 diffs)
• test/java/org/xerial/util/shell/OptionSchemaTest.java (added)
• test/java/org/xerial/util/shell/OptionTest.java (modified) (1 diff)

XerialJ/trunk/xerial-core/src/main/java/org/xerial/core/XerialErrorCode.java

@@ -39 +39 @@
     // option parser error
     DUPLICATE_OPTION,
-    
+    NO_OPTION,
+    NO_USAGE_ANNOTATION,
     // type 
-    MISSING_TYPE_PARAMETER
+    MISSING_TYPE_PARAMETER,
 
     ;

XerialJ/trunk/xerial-core/src/main/java/org/xerial/util/Algorithm.java

@@ -144 +144 @@
         }
 
-        return null;
+        return result;
     }
 

XerialJ/trunk/xerial-core/src/main/java/org/xerial/util/Range.java

@@ -30 +30 @@
  * @author leo
  */
-public class Range
+public class Range implements Comparable<Range>
 {
     public final int start;
@@ -52 +52 @@
     }
 
+    public int compareTo(Range o)
+    {
+        int diff = this.start - o.start;
+        return diff == 0 ? this.end - o.end : diff;
+    }
+
 }

XerialJ/trunk/xerial-core/src/main/java/org/xerial/util/log/Logger.java

@@ -39 +39 @@
 public class Logger
 {
-    private static String[] logPrefix = { "", // ALL
+    private static String[]                logPrefix           = { "", // ALL
             "\033[0;32m", // TRACE
             "", // DEBUG
@@ -47 +47 @@
             "\033[1;31m", // FATAL
             "", // OFF
-            "", };
-
-    private Writer _out = null;
-    private LogLevel _threshold = LogLevel.UNSPECIFIED;
-    private String _loggerFullName = "";
-    private String _loggerShortName = "";
-    private Logger _parentLogger = null;
-    private boolean _emitEscapeSequence = false;
-
-    private static TreeMap<String, Logger> _loggerHolder = new TreeMap<String, Logger>();
-    private static Logger _rootLogger = new Logger();
+            "",                                               };
+
+    private Writer                         _out                = null;
+    private LogLevel                       _threshold          = LogLevel.UNSPECIFIED;
+    private String                         _loggerFullName     = "";
+    private String                         _loggerShortName    = "";
+    private Logger                         _parentLogger       = null;
+    private boolean                        _emitEscapeSequence = false;
+
+    private static TreeMap<String, Logger> _loggerHolder       = new TreeMap<String, Logger>();
+    private static Logger                  _rootLogger         = new Logger();
 
     static
@@ -67 +67 @@
 
         String logLevel = System.getProperty("xerial.loglevel");
-        if(logLevel != null)
+        if (logLevel != null)
         {
             _rootLogger.setLogLevel(logLevel);
@@ -74 +74 @@
         {
             logLevel = System.getProperty("loglevel");
-            if(logLevel != null)
+            if (logLevel != null)
             {
                 _rootLogger.setLogLevel(logLevel);
             }
         }
-        
-        
+
+        String useColor = System.getProperty("color");
+        if (useColor != null)
+            _rootLogger._emitEscapeSequence = Boolean.parseBoolean(useColor);
+
         String loggerConfigFile = System.getProperty("log.config");
         if (loggerConfigFile != null)
@@ -152 +155 @@
             Logger newLogger = new Logger(fullTypeName);
             _loggerHolder.put(fullTypeName, newLogger);
+            newLogger._emitEscapeSequence = _rootLogger._emitEscapeSequence;
             return newLogger;
         }
@@ -168 +172 @@
     public static void configure(Reader configurationFileReader) throws IOException
     {
-        Properties configProperties = new Properties();
-        
-        StringBuilder sb = new StringBuilder();
-        int ch;
-        while((ch = configurationFileReader.read()) > 0)
-        {  
-            sb.append((char) ch);
-        }
-        ByteArrayInputStream bs = new ByteArrayInputStream(sb.toString().getBytes());
-        configProperties.load(bs);
-        
-        for(Object key : configProperties.keySet())
-        {
-            String[] lhs = ((String) key).split("#");
-                String loggerName = lhs[0];
-                String value = configProperties.getProperty(key.toString());
-                Logger logger = getLogger(loggerName);
-                if(lhs.length <= 1)
-                {
-                    logger.setLogLevel(value);
-                }
-                else if(lhs.length > 1)
-                {
-                    // packageName:parameter = value configuration
-                    String parameter = lhs[1];
-                    if(parameter.equals("color"))
-                    {
-                        logger.setColor(Boolean.parseBoolean(value));
-                    }
-                    else
-                    {
-                        System.err.println("unknown configuration parameter: " + parameter);
-                    }
-                }
-                else
-                {
-                    System.err.println("Error in the logger configuration file: " + key);
-                }
-        }
+        Properties configProperties = new Properties();
+
+        StringBuilder sb = new StringBuilder();
+        int ch;
+        while ((ch = configurationFileReader.read()) > 0)
+        {
+            sb.append((char) ch);
+        }
+        ByteArrayInputStream bs = new ByteArrayInputStream(sb.toString().getBytes());
+        configProperties.load(bs);
+
+        for (Object key : configProperties.keySet())
+        {
+            String[] lhs = ((String) key).split("#");
+            String loggerName = lhs[0];
+            String value = configProperties.getProperty(key.toString());
+            Logger logger = getLogger(loggerName);
+            if (lhs.length <= 1)
+            {
+                logger.setLogLevel(value);
+            }
+            else if (lhs.length > 1)
+            {
+                // packageName:parameter = value configuration
+                String parameter = lhs[1];
+                if (parameter.equals("color"))
+                {
+                    logger.setColor(Boolean.parseBoolean(value));
+                }
+                else
+                {
+                    System.err.println("unknown configuration parameter: " + parameter);
+                }
+            }
+            else
+            {
+                System.err.println("Error in the logger configuration file: " + key);
+            }
+        }
     }
 

XerialJ/trunk/xerial-core/src/main/java/org/xerial/util/shell/Argument.java

@@ -41 +41 @@
 
     /**
-     * description of the argument
+     * name of the argument
      */
-    String description() default "";
+    String name() default "";
 
     /**
-     * This argument is required
+     * This argument is required or not
      */
-    boolean required() default false;
+    boolean required() default true;
 
     /**

XerialJ/trunk/xerial-core/src/main/java/org/xerial/util/shell/ArgumentItem.java

@@ -28 +28 @@
 import java.lang.reflect.Method;
 
+import org.xerial.util.Range;
 import org.xerial.util.bean.TypeInformation;
 import org.xerial.util.cui.OptionParserException;
@@ -83 +84 @@
     }
 
+    public static Range getRangeOf(ArgumentItem arg)
+    {
+        int start = arg.getArgumentDescriptor().index();
+        int end = arg.takesMultipleArguments() ? Integer.MAX_VALUE : start;
+        return new Range(start, end);
+    }
+
+    public Range getRange()
+    {
+        return getRangeOf(this);
+    }
+
     public void set(Object bean, Object value) throws OptionParserException
     {

XerialJ/trunk/xerial-core/src/main/java/org/xerial/util/shell/Option.java

@@ -43 +43 @@
 
     /**
-     * Name of the option. If the name is "h", it handles option "-h"
+     * symbol of the option. If the symbol is "h", it handles option "-h"
      * 
      */
-    String name();
+    String symbol() default "";
 
     /**
@@ -56 +56 @@
 
     /**
+     * Variable name used to describe option argument (e.g. --file=VALUE). The
+     * default value is capitalized name().
+     */
+    String varName() default "VAR";
+
+    /**
      * Description of the option, used to generate a help message of the
      * command-line options
      */
     String description() default "";
-    
+
 }

XerialJ/trunk/xerial-core/src/main/java/org/xerial/util/shell/OptionItem.java

@@ -40 +40 @@
 public class OptionItem
 {
-    private final Option optionDescriptor;
+    private final Option       optionDescriptor;
     private final OptionSetter optionSetter;
-    
+
     public OptionItem(Method method)
     {
         Option option = method.getAnnotation(Option.class);
-        if(option == null)
+        if (option == null)
             throw new IllegalArgumentException(method + " is not an option item");
 
@@ -52 +52 @@
         this.optionSetter = new OptionSetterViaMethod(method);
     }
-    
+
     public OptionItem(Field field)
     {
         Option option = field.getAnnotation(Option.class);
-        if(option == null)
+        if (option == null)
             throw new IllegalArgumentException(field + " is not an option item");
 
@@ -62 +62 @@
         this.optionSetter = new OptionSetterViaField(field);
     }
-    
 
     @Override
@@ -81 +80 @@
         return optionDescriptor.hashCode();
     }
-    
+
     public boolean needsArgument()
     {
         return optionSetter.takesArgument();
     }
-    
+
+    public boolean hasSymbol()
+    {
+        return optionDescriptor.symbol() != null && optionDescriptor.symbol().length() > 0;
+    }
+
+    public boolean hasLongName()
+    {
+        return optionDescriptor.longName() != null && optionDescriptor.longName().length() > 0;
+    }
+
     public Option getOption()
     {
-        return optionDescriptor; 
+        return optionDescriptor;
     }
-    
+
     public void setOption(Object bean, String value) throws OptionParserException
     {
-        Class<?> optionType = optionSetter.getOptionDataType();
+        Class< ? > optionType = optionSetter.getOptionDataType();
         try
         {
@@ -104 +113 @@
             throw new OptionParserException(ShellError.WRONG_DATA_TYPE, e);
         }
-        
+
     }
-     
 
 }

XerialJ/trunk/xerial-core/src/main/java/org/xerial/util/shell/OptionParser.java

@@ -26 +26 @@
 
 import java.io.OutputStream;
-import java.lang.reflect.Field;
-import java.lang.reflect.Method;
 import java.util.HashSet;
 
@@ -38 +36 @@
  * @author leo
  * 
- */ 
+ */
 public class OptionParser
 {
     private boolean            ignoreUnknownOption = false;
     private final OptionSchema schema;
-    private final Object optionHolder;
+    private final Object       optionHolder;
 
     public <T> OptionParser(T optionHolder)
     {
         this.optionHolder = optionHolder;
-        schema = newOptionSchema(optionHolder);
+        schema = OptionSchema.newOptionSchema(optionHolder);
     }
 
@@ -160 +158 @@
                 argItem.set(optionHolder, currentArg);
                 activatedArgument.add(argItem.getArgumentDescriptor());
+                argIndex++;
             }
 
@@ -165 +164 @@
     }
 
-    public static <OptionBean> OptionSchema newOptionSchema(Class<OptionBean> optionHolderType)
-    {
-        OptionSchema optionSchema = new OptionSchema();
-
-        // traverses through super classes
-        for (Class< ? > optionHolderClass = optionHolderType; optionHolderClass != null; optionHolderClass = optionHolderClass
-                .getSuperclass())
-        {
-            // looks for bean methods annotated with Option or Argument 
-            for (Method eachMethod : optionHolderClass.getDeclaredMethods())
-            {
-                if (eachMethod.getAnnotation(Option.class) != null)
-                    optionSchema.addOptionItem(eachMethod);
-
-                if (eachMethod.getAnnotation(Argument.class) != null)
-                    optionSchema.addArgumentItem(eachMethod);
-            }
-
-            // looks for bean fields annotated with Option or Argument 
-            for (Field f : optionHolderClass.getFields())
-            {
-                if (f.getAnnotation(Option.class) != null)
-                    optionSchema.addOptionItem(f);
-
-                if (f.getAnnotation(Argument.class) != null)
-                    optionSchema.addArgumentItem(f);
-            }
-        }
-
-        return optionSchema;
-    }
-
-    public static <OptionHolder> OptionSchema newOptionSchema(OptionHolder optionHolder)
-    {
-        return newOptionSchema(optionHolder.getClass());
-    }
 }

XerialJ/trunk/xerial-core/src/main/java/org/xerial/util/shell/OptionSchema.java

@@ -25 +25 @@
 package org.xerial.util.shell;
 
+import java.io.IOException;
 import java.io.OutputStream;
+import java.io.OutputStreamWriter;
 import java.io.PrintWriter;
+import java.io.Writer;
 import java.lang.reflect.Field;
 import java.lang.reflect.Method;
 import java.util.ArrayList;
+import java.util.Collections;
+import java.util.Comparator;
+import java.util.List;
 
 import org.xerial.core.XerialError;
@@ -36 +42 @@
 import org.xerial.util.Mapper;
 import org.xerial.util.Range;
-import org.xerial.util.Reducer;
+import org.xerial.util.StringUtil;
 
 /**
@@ -48 +54 @@
     private final ArrayList<OptionItem>   optionItemList   = new ArrayList<OptionItem>();
     private final ArrayList<ArgumentItem> argumentItemList = new ArrayList<ArgumentItem>();
-
-    public void printUsage(OutputStream out)
+    private Usage                         usage            = null;
+
+    List<OptionItem> getOptionItemList()
+    {
+        return optionItemList;
+    }
+
+    List<ArgumentItem> getArgumentItemList()
+    {
+        return argumentItemList;
+    }
+
+    Usage getUsage()
+    {
+        return usage;
+    }
+
+    protected static String optionDescription(OptionItem optionItem)
+    {
+        StringBuilder line = new StringBuilder();
+        Option opt = optionItem.getOption();
+        if (optionItem.hasSymbol())
+        {
+            line.append(String.format("-%s", opt.symbol()));
+            if (optionItem.hasLongName())
+            {
+                line.append(String.format(", --%s", opt.longName()));
+
+                if (optionItem.needsArgument())
+                    line.append(String.format("=%s", opt.varName()));
+            }
+            else
+            {
+                if (optionItem.needsArgument())
+                    line.append(String.format(" ", opt.varName()));
+            }
+        }
+        else if (optionItem.hasLongName())
+        {
+            line.append(String.format("    --%s", opt.longName()));
+            if (optionItem.needsArgument())
+                line.append(String.format("=%s", opt.varName()));
+        }
+        else
+        {
+            throw new XerialError(XerialErrorCode.NO_OPTION, optionItem.toString());
+        }
+
+        return line.toString();
+
+    }
+
+    protected static String argumentExpression(ArgumentItem argItem)
+    {
+        StringBuilder line = new StringBuilder();
+
+        Argument arg = argItem.getArgumentDescriptor();
+        String format;
+
+        if (arg.required())
+            format = argItem.takesMultipleArguments() ? "%s ..." : "%s";
+        else
+            format = argItem.takesMultipleArguments() ? "[%s ...]" : "[%s]";
+
+        String name = arg.name();
+        if (name == null || name.length() <= 0)
+            name = "ARG";
+
+        line.append(String.format(format, name));
+
+        return line.toString();
+    }
+
+    public void printUsage(OutputStream out) throws IOException
+    {
+        printUsage(new OutputStreamWriter(out));
+    }
+
+    public void printUsage(Writer out) throws IOException
     {
         PrintWriter writer = new PrintWriter(out);
-        
-        int longestLongOptionNameSize = 
-            Algorithm.mapReduce(optionItemList, 
-                    new Mapper<OptionItem, Integer>(){
-                public Integer map(OptionItem input)
+
+        // argument list
+        Collections.sort(argumentItemList, new Comparator<ArgumentItem>() {
+            public int compare(ArgumentItem o1, ArgumentItem o2)
+            {
+                return o1.getRange().compareTo(o2.getRange());
+            }
+        });
+
+        List<String> argExpressionList = Algorithm.map(argumentItemList, new Mapper<ArgumentItem, String>() {
+            public String map(ArgumentItem input)
+            {
+                return argumentExpression(input);
+            }
+        });
+
+        // usage information
+        if (usage != null)
+        {
+            writer.print("usage: ");
+            writer.print(usage.command());
+            writer.print(" ");
+        }
+        writer.println(StringUtil.join(argExpressionList, " "));
+
+        if (usage != null)
+        {
+            if (usage.description().length() > 0)
+                writer.println("\t" + usage.description());
+        }
+
+        // option list
+        Collections.sort(optionItemList, new Comparator<OptionItem>() {
+            public int compare(OptionItem o1, OptionItem o2)
+            {
+                Option opt1 = o1.getOption();
+                Option opt2 = o2.getOption();
+
+                // prefer options that have a short name 
+                if (o1.hasSymbol())
                 {
-                    Option opt = input.getOption();
-