src/jalview/bin/ArgsParser.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3
  10  * of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  */
  21 package jalview.bin;
  22
  23 import java.net.URLDecoder;
  24 import java.util.Vector;
  25
  26 /**
  27  * Notes: this argParser does not distinguish between parameter switches,
  28  * parameter values and argument text. If an argument happens to be identical to
  29  * a parameter, it will be taken as such (even though it didn't have a '-'
  30  * prefixing it).
  31  *
  32  * @author Andrew Waterhouse and JBP documented.
  33  *
  34  */
  35 public class ArgsParser
  36 {
  37
  38   public static final String ANNOTATIONS = "annotations";
  39
  40   public static final String COLOUR = "colour";
  41
  42   public static final String FEATURES = "features";
  43
  44   public static final String GROOVY = "groovy";
  45
  46   public static final String GROUPS = "groups";
  47
  48   public static final String HEADLESS = "headless";
  49
  50   public static final String JABAWS = "jabaws";
  51
  52   public static final String NOANNOTATION = "no-annotation";
  53
  54   public static final String NOANNOTATION2 = "noannotation"; // BH 2019.05.07
  55
  56   public static final String NODISPLAY = "nodisplay";
  57
  58   public static final String NOGUI = "nogui";
  59
  60   public static final String NONEWS = "nonews";
  61
  62   public static final String NOQUESTIONNAIRE = "noquestionnaire";
  63
  64   public static final String NOSORTBYTREE = "nosortbytree";
  65
  66   public static final String NOUSAGESTATS = "nousagestats";
  67
  68   public static final String OPEN = "open";
  69
  70   public static final String OPEN2 = "open2"; // BH added -- for applet
  71                                               // compatibility; not fully
  72                                               // implemented
  73
  74   public static final String PROPS = "props";
  75
  76   public static final String QUESTIONNAIRE = "questionnaire";
  77
  78   public static final String SETPROP = "setprop";
  79
  80   public static final String SORTBYTREE = "sortbytree";
  81
  82   public static final String TREE = "tree";
  83
  84   public static final String VDOC = "vdoc";
  85
  86   public static final String VSESS = "vsess";
  87
  88   private Vector<String> vargs = null;
  89
  90   private boolean isApplet;
  91
  92   private AppletParams appletParams;
  93
  94   public boolean isApplet()
  95   {
  96     return isApplet;
  97   }
  98
  99   public ArgsParser(String[] args)
 100   {
 101     vargs = new Vector<>();
 102     isApplet = (args.length > 0 && args[0].startsWith("<applet"));
 103     if (isApplet)
 104     {
 105       appletParams = AppletParams.getAppletParams(args, vargs);
 106     }
 107     else
 108     {
 109       for (int i = 0; i < args.length; i++)
 110       {
 111         String arg = args[i].trim();
 112         if (arg.charAt(0) == '-')
 113         {
 114           arg = arg.substring(1);
 115         }
 116         vargs.addElement(arg);
 117       }
 118     }
 119   }
 120
 121   /**
 122    * check for and remove first occurence of arg+parameter in arglist.
 123    *
 124    * @param arg
 125    * @return return the argument following the given arg if arg was in list.
 126    */
 127   public String getValue(String arg)
 128   {
 129     return getValue(arg, false);
 130   }
 131
 132   public String getValue(String arg, boolean utf8decode)
 133   {
 134     int index = vargs.indexOf(arg);
 135     String dc = null, ret = null;
 136     if (index != -1)
 137     {
 138       ret = vargs.elementAt(index + 1).toString();
 139       vargs.removeElementAt(index);
 140       vargs.removeElementAt(index);
 141       if (utf8decode && ret != null)
 142       {
 143         try
 144         {
 145           dc = URLDecoder.decode(ret, "UTF-8");
 146           ret = dc;
 147         } catch (Exception e)
 148         {
 149           // TODO: log failure to decode
 150         }
 151       }
 152     }
 153     return ret;
 154   }
 155
 156   /**
 157    * check for and remove first occurence of arg in arglist.
 158    *
 159    * @param arg
 160    * @return true if arg was present in argslist.
 161    */
 162   public boolean contains(String arg)
 163   {
 164     if (vargs.contains(arg))
 165     {
 166       vargs.removeElement(arg);
 167       return true;
 168     }
 169     else
 170     {
 171       return false;
 172     }
 173   }
 174
 175   public String nextValue()
 176   {
 177     return vargs.remove(0);
 178   }
 179
 180   public int getSize()
 181   {
 182     return vargs.size();
 183   }
 184
 185   public String getAppletValue(String key, String def)
 186   {
 187     String value;
 188     return (appletParams == null ? null
 189             : (value = appletParams.get(key.toLowerCase())) != null ? value
 190                     : def);
 191   }
 192
 193 }