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 jalview.util.Platform;
  24
  25 import java.net.URLDecoder;
  26 import java.util.ArrayList;
  27 import java.util.List;
  28
  29 /**
  30  * Notes: this argParser does not distinguish between parameter switches,
  31  * parameter values and argument text. If an argument happens to be identical to
  32  * a parameter, it will be taken as such (even though it didn't have a '-'
  33  * prefixing it).
  34  *
  35  * @author Andrew Waterhouse and JBP documented.
  36  *
  37  */
  38 public class ArgsParser
  39 {
  40
  41   // BH 2019 - new
  42
  43   public static final String NOCALCULATION = "nocalculation";
  44
  45   public static final String NOMENUBAR = "nomenubar";
  46
  47   public static final String NOSTATUS = "nostatus";
  48
  49   public static final String SHOWOVERVIEW = "showoverview";
  50
  51   //
  52   public static final String ANNOTATIONS = "annotations";
  53
  54   public static final String COLOUR = "colour";
  55
  56   public static final String FEATURES = "features";
  57
  58   public static final String GROOVY = "groovy";
  59
  60   public static final String GROUPS = "groups";
  61
  62   public static final String HEADLESS = "headless";
  63
  64   public static final String JABAWS = "jabaws";
  65
  66   public static final String NOANNOTATION = "no-annotation";
  67
  68   public static final String NOANNOTATION2 = "noannotation"; // BH 2019.05.07
  69
  70   public static final String NODISPLAY = "nodisplay";
  71
  72   public static final String NOGUI = "nogui";
  73
  74   public static final String NONEWS = "nonews";
  75
  76   public static final String NOQUESTIONNAIRE = "noquestionnaire";
  77
  78   public static final String NOSORTBYTREE = "nosortbytree";
  79
  80   public static final String NOUSAGESTATS = "nousagestats";
  81
  82   public static final String OPEN = "open";
  83
  84   public static final String OPEN2 = "open2"; // BH added -- for applet
  85                                               // compatibility; not fully
  86                                               // implemented
  87
  88   public static final String PROPS = "props";
  89
  90   public static final String QUESTIONNAIRE = "questionnaire";
  91
  92   public static final String SETPROP = "setprop";
  93
  94   public static final String SORTBYTREE = "sortbytree";
  95
  96   public static final String TREE = "tree";
  97
  98   public static final String VDOC = "vdoc";
  99
 100   public static final String VSESS = "vsess";
 101
 102   private List<String> vargs = null;
 103
 104   private boolean isApplet;
 105
 106   private AppletParams appletParams;
 107
 108   public boolean isApplet()
 109   {
 110     return isApplet;
 111   }
 112
 113   public ArgsParser(String[] args)
 114   {
 115     vargs = new ArrayList<>();
 116     isApplet = (args.length > 0 && args[0].startsWith("<applet"));
 117     if (isApplet)
 118     {
 119       appletParams = AppletParams.getAppletParams(args, vargs);
 120     }
 121     else if (Platform.isJS() && args.length == 0)
 122     {
 123       isApplet = true;
 124       appletParams = AppletParams
 125               .getAppletParams(Platform.getAppletInfoAsMap(), vargs);
 126     }
 127     else
 128     {
 129       for (int i = 0; i < args.length; i++)
 130       {
 131         String arg = args[i].trim();
 132         if (arg.charAt(0) == '-')
 133         {
 134           arg = arg.substring(1);
 135         }
 136         vargs.add(arg);
 137       }
 138     }
 139   }
 140
 141   /**
 142    * check for and remove first occurence of arg+parameter in arglist.
 143    *
 144    * @param arg
 145    * @return return the argument following the given arg if arg was in list.
 146    */
 147   public String getValue(String arg)
 148   {
 149     return getValue(arg, false);
 150   }
 151
 152   public String getValue(String arg, boolean utf8decode)
 153   {
 154     int index = vargs.indexOf(arg);
 155     String dc = null, ret = null;
 156     if (index != -1)
 157     {
 158       ret = vargs.get(index + 1).toString();
 159       vargs.remove(index);
 160       vargs.remove(index);
 161       if (utf8decode && ret != null)
 162       {
 163         try
 164         {
 165           dc = URLDecoder.decode(ret, "UTF-8");
 166           ret = dc;
 167         } catch (Exception e)
 168         {
 169           // TODO: log failure to decode
 170         }
 171       }
 172     }
 173     return ret;
 174   }
 175
 176   /**
 177    * check for and remove first occurence of arg in arglist.
 178    *
 179    * @param arg
 180    * @return true if arg was present in argslist.
 181    */
 182   public boolean contains(String arg)
 183   {
 184     if (vargs.contains(arg))
 185     {
 186       vargs.remove(arg);
 187       return true;
 188     }
 189     else
 190     {
 191       return false;
 192     }
 193   }
 194
 195   public String nextValue()
 196   {
 197     return vargs.remove(0);
 198   }
 199
 200   public int getSize()
 201   {
 202     return vargs.size();
 203   }
 204
 205   public Object getAppletValue(String key, String def, boolean asString)
 206   {
 207     Object value;
 208     return (appletParams == null ? null
 209             : (value = appletParams.get(key.toLowerCase())) == null
 210                     ? def : asString ? value.toString()
 211                     : value);
 212   }
 213
 214 }