JAL-629 parse SubVals once with ArgValue. Ensure SubVals exists. Change to setprops...
[jalview.git] / src / jalview / bin / Commands.java
index 7a6e3ac..4a70bd9 100644 (file)
@@ -2,6 +2,7 @@ package jalview.bin;
 
 import java.io.File;
 import java.io.IOException;
+import java.util.AbstractMap;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collections;
@@ -10,23 +11,31 @@ import java.util.Iterator;
 import java.util.List;
 import java.util.Locale;
 import java.util.Map;
+import java.util.Map.Entry;
 
 import jalview.analysis.AlignmentUtils;
 import jalview.api.AlignmentViewPanel;
-import jalview.bin.ArgParser.Arg;
-import jalview.bin.ArgParser.ArgValue;
-import jalview.bin.ArgParser.ArgValuesMap;
-import jalview.bin.ArgParser.SubVals;
+import jalview.bin.argparser.Arg;
+import jalview.bin.argparser.ArgParser;
+import jalview.bin.argparser.ArgValue;
+import jalview.bin.argparser.ArgValues;
+import jalview.bin.argparser.ArgValuesMap;
+import jalview.bin.argparser.SubVals;
 import jalview.datamodel.AlignmentAnnotation;
 import jalview.datamodel.AlignmentI;
+import jalview.datamodel.PDBEntry;
 import jalview.datamodel.SequenceI;
 import jalview.datamodel.annotations.AlphaFoldAnnotationRowBuilder;
 import jalview.gui.AlignFrame;
 import jalview.gui.AlignmentPanel;
+import jalview.gui.AssociatePdbFileWithSeq;
 import jalview.gui.Desktop;
+import jalview.gui.Preferences;
 import jalview.gui.StructureChooser;
+import jalview.gui.StructureViewer;
 import jalview.io.AppletFormatAdapter;
 import jalview.io.DataSourceType;
+import jalview.io.FileFormat;
 import jalview.io.FileFormatException;
 import jalview.io.FileFormatI;
 import jalview.io.FileLoader;
@@ -46,37 +55,65 @@ public class Commands
 {
   Desktop desktop;
 
-  private static boolean headless;
+  private boolean headless;
 
-  private static ArgParser argParser;
+  private ArgParser argParser;
 
   private Map<String, AlignFrame> afMap;
 
-  public static boolean processArgs(ArgParser ap, boolean h)
+  private boolean commandArgsProvided = false;
+
+  private boolean argsWereParsed = false;
+
+  public Commands(ArgParser argparser, boolean headless)
+  {
+    this(Desktop.instance, argparser, headless);
+  }
+
+  public Commands(Desktop d, ArgParser argparser, boolean h)
   {
-    argParser = ap;
+    argParser = argparser;
     headless = h;
-    boolean argsWereParsed = false;
-    if (headless)
+    desktop = d;
+    afMap = new HashMap<String, AlignFrame>();
+    if (argparser != null)
     {
-      System.setProperty("java.awt.headless", "true");
+      processArgs(argparser, headless);
     }
+  }
+
+  private boolean processArgs(ArgParser argparser, boolean h)
+  {
+    argParser = argparser;
+    headless = h;
+    boolean theseArgsWereParsed = false;
 
     if (argParser != null && argParser.linkedIds() != null)
     {
       for (String id : argParser.linkedIds())
       {
-        Commands cmds = new Commands();
+        ArgValuesMap avm = argParser.linkedArgs(id);
+        theseArgsWereParsed = true;
         if (id == null)
         {
-          cmds.processUnlinked(id);
+          theseArgsWereParsed &= processUnlinked(id);
         }
         else
         {
-          cmds.processLinked(id);
+          theseArgsWereParsed &= processLinked(id);
+        }
+        theseArgsWereParsed &= processImages(id);
+
+        // close ap
+        if (avm.getBoolean(Arg.CLOSE))
+        {
+          AlignFrame af = afMap.get(id);
+          if (af != null)
+          {
+            af.closeMenuItem_actionPerformed(true);
+          }
         }
-        cmds.processImages(id);
-        argsWereParsed |= cmds.wereParsed();
+
       }
 
     }
@@ -86,70 +123,77 @@ public class Commands
       return true;
     }
     // carry on with jalview.bin.Jalview
+    argsWereParsed = theseArgsWereParsed;
     return argsWereParsed;
   }
 
-  boolean argsWereParsed = false;
-
-  private boolean wereParsed()
+  public boolean commandArgsProvided()
   {
-    return argsWereParsed;
-  }
-
-  public Commands()
-  {
-    this(Desktop.instance);
+    return commandArgsProvided;
   }
 
-  public Commands(Desktop d)
+  public boolean argsWereParsed()
   {
-    this.desktop = d;
-    afMap = new HashMap<String, AlignFrame>();
+    return argsWereParsed;
   }
 
-  protected void processUnlinked(String id)
+  protected boolean processUnlinked(String id)
   {
-    ArgValuesMap avm = new ArgValuesMap(argParser.linkedArgs(id));
-
-    processLinked(id);
+    return processLinked(id);
   }
 
-  protected void processLinked(String id)
+  protected boolean processLinked(String id)
   {
-    ArgValuesMap avm = new ArgValuesMap(argParser.linkedArgs(id));
+    boolean theseArgsWereParsed = false;
+    ArgValuesMap avm = argParser.linkedArgs(id);
+    if (avm == null)
+      return true;
 
     /*
-    // script to execute after all loading is completed one way or another
-    String groovyscript = m.get(Arg.GROOVY) == null ? null
-            : m.get(Arg.GROOVY).getValue();
-    String file = m.get(Arg.OPEN) == null ? null
-            : m.get(Arg.OPEN).getValue();
-    String data = null;
-    FileFormatI format = null;
-    DataSourceType protocol = null;
-    */
-    if (avm.hasValue(Arg.OPEN))
+     * // script to execute after all loading is completed one way or another String
+     * groovyscript = m.get(Arg.GROOVY) == null ? null :
+     * m.get(Arg.GROOVY).getValue(); String file = m.get(Arg.OPEN) == null ? null :
+     * m.get(Arg.OPEN).getValue(); String data = null; FileFormatI format = null;
+     * DataSourceType protocol = null;
+     */
+    if (avm.containsArg(Arg.OPEN) || avm.containsArg(Arg.OPENNEW))
     {
+      commandArgsProvided = true;
       long progress = -1;
 
       boolean first = true;
+      boolean progressBarSet = false;
       AlignFrame af;
-      for (ArgValue av : avm.getArgValueList(Arg.OPEN))
+      // Combine the OPEN and OPENNEW files into one list, along with whether it
+      // was OPEN or OPENNEW
+      List<Entry<Arg, ArgValue>> openAvList = new ArrayList<>();
+      avm.getArgValueList(Arg.OPEN).stream()
+              .forEachOrdered(av -> openAvList.add(
+                      new AbstractMap.SimpleEntry<Arg, ArgValue>(Arg.OPEN,
+                              av)));
+      avm.getArgValueList(Arg.OPENNEW).stream()
+              .forEachOrdered(av -> openAvList
+                      .add(new AbstractMap.SimpleEntry<Arg, ArgValue>(
+                              Arg.OPENNEW, av)));
+      for (Entry<Arg, ArgValue> aav : openAvList)
       {
+        Arg a = aav.getKey();
+        ArgValue av = aav.getValue();
         String openFile = av.getValue();
         if (openFile == null)
           continue;
 
-        argsWereParsed = true;
+        theseArgsWereParsed = true;
         if (first)
         {
           first = false;
-          if (!headless)
+          if (!headless && desktop != null)
           {
             desktop.setProgressBar(
                     MessageManager.getString(
                             "status.processing_commandline_args"),
                     progress = System.currentTimeMillis());
+            progressBarSet = true;
           }
         }
 
@@ -182,41 +226,29 @@ public class Commands
         }
 
         af = afMap.get(id);
-        if (af == null)
+        if (af == null || "true".equals(av.getSubVal("new"))
+                || a == Arg.OPENNEW || format == FileFormat.Jalview)
         {
           /*
-           * this approach isn't working yet
-          // get default annotations before opening AlignFrame
-          if (m.get(Arg.SSANNOTATION) != null)
-          {
-            Console.debug("***** SSANNOTATION="
-                    + m.get(Arg.SSANNOTATION).getBoolean());
-          }
-          if (m.get(Arg.NOTEMPFAC) != null)
-          {
-            Console.debug(
-                    "***** NOTEMPFAC=" + m.get(Arg.NOTEMPFAC).getBoolean());
-          }
-          boolean showSecondaryStructure = (m.get(Arg.SSANNOTATION) != null)
-                  ? m.get(Arg.SSANNOTATION).getBoolean()
-                  : false;
-          boolean showTemperatureFactor = (m.get(Arg.NOTEMPFAC) != null)
-                  ? !m.get(Arg.NOTEMPFAC).getBoolean()
-                  : false;
-          Console.debug("***** tempfac=" + showTemperatureFactor
-                  + ", showSS=" + showSecondaryStructure);
-          StructureSelectionManager ssm = StructureSelectionManager
-                  .getStructureSelectionManager(Desktop.instance);
-          if (ssm != null)
-          {
-            ssm.setAddTempFacAnnot(showTemperatureFactor);
-            ssm.setProcessSecondaryStructure(showSecondaryStructure);
-          }
+           * this approach isn't working yet // get default annotations before opening
+           * AlignFrame if (m.get(Arg.SSANNOTATION) != null) {
+           * Console.debug("##### SSANNOTATION=" + m.get(Arg.SSANNOTATION).getBoolean());
+           * } if (m.get(Arg.NOTEMPFAC) != null) { Console.debug( "##### NOTEMPFAC=" +
+           * m.get(Arg.NOTEMPFAC).getBoolean()); } boolean showSecondaryStructure =
+           * (m.get(Arg.SSANNOTATION) != null) ? m.get(Arg.SSANNOTATION).getBoolean() :
+           * false; boolean showTemperatureFactor = (m.get(Arg.NOTEMPFAC) != null) ?
+           * !m.get(Arg.NOTEMPFAC).getBoolean() : false; Console.debug("##### tempfac=" +
+           * showTemperatureFactor + ", showSS=" + showSecondaryStructure);
+           * StructureSelectionManager ssm = StructureSelectionManager
+           * .getStructureSelectionManager(Desktop.instance); if (ssm != null) {
+           * ssm.setAddTempFacAnnot(showTemperatureFactor);
+           * ssm.setProcessSecondaryStructure(showSecondaryStructure); }
            */
 
           // get kind of temperature factor annotation
           StructureImportSettings.TFType tempfacType = TFType.DEFAULT;
-          if ((!avm.getBoolean(Arg.NOTEMPFAC)) && avm.hasValue(Arg.TEMPFAC))
+          if ((!avm.getBoolean(Arg.NOTEMPFAC))
+                  && avm.containsArg(Arg.TEMPFAC))
           {
             try
             {
@@ -228,8 +260,8 @@ public class Commands
             } catch (IllegalArgumentException e)
             {
               // Just an error message!
-              StringBuilder sb = new StringBuilder().append("Cannot set --")
-                      .append(Arg.TEMPFAC.getName()).append(" to '")
+              StringBuilder sb = new StringBuilder().append("Cannot set ")
+                      .append(Arg.TEMPFAC.argString()).append(" to '")
                       .append(tempfacType)
                       .append("', ignoring.  Valid values are: ");
               Iterator<StructureImportSettings.TFType> it = Arrays
@@ -261,13 +293,13 @@ public class Commands
           }
 
           // colour aligment?
-          if (avm.hasValue(Arg.COLOUR))
+          if (avm.containsArg(Arg.COLOUR))
           {
             af.changeColour_actionPerformed(avm.getValue(Arg.COLOUR));
           }
 
           // change alignment frame title
-          if (avm.hasValue(Arg.TITLE))
+          if (avm.containsArg(Arg.TITLE))
             af.setTitle(avm.getValue(Arg.TITLE));
 
           /* hacky approach to hiding the annotations */
@@ -293,11 +325,12 @@ public class Commands
                     false, false);
           }
           else
-          /* comment out hacky approach up to here and add this line:
-           if (showTemperatureFactor)
-             */
+          /*
+           * comment out hacky approach up to here and add this line: if
+           * (showTemperatureFactor)
+           */
           {
-            if (avm.hasValue(Arg.TEMPFAC_LABEL))
+            if (avm.containsArg(Arg.TEMPFAC_LABEL))
             {
               AlignmentAnnotation aa = AlignmentUtils
                       .getFirstSequenceAnnotationOfType(
@@ -327,14 +360,14 @@ public class Commands
                     .getStructureSelectionManager(Desktop.instance);
             SequenceI seq = af.alignPanel.getAlignment().getSequenceAt(0);
             ssm.computeMapping(false, new SequenceI[] { seq }, null,
-                    openFile, DataSourceType.FILE, null);
+                    openFile, DataSourceType.FILE, null, null, null);
           }
         }
         else
         {
           Console.debug(
                   "Opening '" + openFile + "' in existing alignment frame");
-          af.getCurrentView().addFile(new File(openFile), format);
+          af.getCurrentView().addFile(new File(openFile), format, false);
         }
 
         Console.debug("Command " + Arg.OPEN + " executed successfully!");
@@ -344,16 +377,15 @@ public class Commands
       {
         if (headless)
         {
-          Console.error("Could not open any files in headless mode");
-          System.exit(1);
+          Jalview.exit("Could not open any files in headless mode", 1);
         }
         else
         {
           Console.warn("No more files to open");
-          if (desktop != null)
-            desktop.setProgressBar(null, progress);
         }
       }
+      if (progressBarSet && desktop != null)
+        desktop.setProgressBar(null, progress);
 
     }
 
@@ -361,17 +393,26 @@ public class Commands
     if (!avm.getBoolean(Arg.NOSTRUCTURE))
     {
       AlignFrame af = afMap.get(id);
-      if (avm.hasValue(Arg.STRUCTURE))
+      if (avm.containsArg(Arg.STRUCTURE))
       {
+        commandArgsProvided = true;
         for (ArgValue av : avm.getArgValueList(Arg.STRUCTURE))
         {
           String val = av.getValue();
-          SubVals subId = new SubVals(val);
+          SubVals subId = av.getSubVals();
           SequenceI seq = getSpecifiedSequence(af, subId);
           if (seq == null)
           {
-            Console.warn("Could not find sequence for argument --"
-                    + Arg.STRUCTURE + "=" + val);
+            // Could not find sequence from subId, let's assume the first
+            // sequence in the alignframe
+            AlignmentI al = af.getCurrentView().getAlignment();
+            seq = al.getSequenceAt(0);
+          }
+
+          if (seq == null)
+          {
+            Console.warn("Could not find sequence for argument "
+                    + Arg.STRUCTURE.argString() + "=" + val);
             // you probably want to continue here, not break
             // break;
             continue;
@@ -384,6 +425,16 @@ public class Commands
             Console.debug("Using structure file (from argument) '"
                     + structureFile.getAbsolutePath() + "'");
           }
+          // TRY THIS
+          /*
+           * PDBEntry fileEntry = new AssociatePdbFileWithSeq()
+           * .associatePdbWithSeq(selectedPdbFileName, DataSourceType.FILE,
+           * selectedSequence, true, Desktop.instance);
+           * 
+           * sViewer = launchStructureViewer(ssm, new PDBEntry[] { fileEntry }, ap, new
+           * SequenceI[] { selectedSequence });
+           * 
+           */
           /* THIS DOESN'T WORK */
           else if (seq.getAllPDBEntries() != null
                   && seq.getAllPDBEntries().size() > 0)
@@ -410,16 +461,32 @@ public class Commands
           Console.debug("Using structure file "
                   + structureFile.getAbsolutePath());
 
+          PDBEntry fileEntry = new AssociatePdbFileWithSeq()
+                  .associatePdbWithSeq(structureFile.getAbsolutePath(),
+                          DataSourceType.FILE, seq, true, Desktop.instance);
+
           // open structure view
           AlignmentPanel ap = af.alignPanel;
-          StructureChooser.openStructureFileForSequence(ap, seq,
-                  structureFile);
+          if (headless)
+          {
+            Cache.setProperty(Preferences.STRUCTURE_DISPLAY,
+                    StructureViewer.ViewerType.JMOL.toString());
+          }
+
+          // get tft, paeFilename, label?
+          /*
+           * ArgValue tftAv = avm.getArgValuesReferringTo("structid", structId,
+           * Arg.TEMPFAC);
+           */
+          StructureChooser.openStructureFileForSequence(null, null, ap, seq,
+                  false, structureFile.getAbsolutePath(), null, null); // tft,
+          // paeFilename);
         }
       }
     }
 
-    // load a pAE file if given
-    if (avm.hasValue(Arg.PAEMATRIX))
+    // load a PAE file if given
+    if (avm.containsArg(Arg.PAEMATRIX))
     {
       AlignFrame af = afMap.get(id);
       if (af != null)
@@ -427,7 +494,8 @@ public class Commands
         for (ArgValue av : avm.getArgValueList(Arg.PAEMATRIX))
         {
           String val = av.getValue();
-          SubVals subVals = ArgParser.getSubVals(val);
+          SubVals subVals = av.getSubVals();
+          String paeLabel = subVals.get("label");
           File paeFile = new File(subVals.getContent());
           String paePath = null;
           try
@@ -439,39 +507,66 @@ public class Commands
             Console.warn(
                     "Problem with the PAE file path: '" + paePath + "'");
           }
-          String structId = subVals.get("structid");
-          if (subVals.notSet())
+          String structid = subVals.get("structid");
+          String structfile = subVals.get("structfile");
+          String seqid = subVals.get("seqid");
+          int seqindex = subVals.getIndex();
+
+          // let's find a structure
+          if (structfile == null && structid == null && seqid == null
+                  && seqindex == SubVals.NOTSET)
+          {
+            ArgValue likelyStructure = avm
+                    .getClosestPreviousArgValueOfArg(av, Arg.STRUCTURE);
+            if (likelyStructure != null)
+            {
+              SubVals sv = likelyStructure.getSubVals();
+              if (sv != null && sv.has(ArgValues.ID))
+              {
+                structid = sv.get(ArgValues.ID);
+              }
+              else
+              {
+                structfile = likelyStructure.getValue();
+                Console.debug(
+                        "##### Using closest previous structure argument '"
+                                + structfile + "'");
+              }
+            }
+          }
+
+          if (structfile != null)
           {
-            // take structid from pdbfilename
+            Console.debug("##### Attaching paeFile '" + paePath + "' to "
+                    + "structfile=" + structfile);
+            EBIAlfaFold.addAlphaFoldPAE(af.getCurrentView().getAlignment(),
+                    paeFile, seqindex, structfile, true, false, paeLabel);
           }
-          if (subVals.has("structfile"))
+          else if (structid != null)
           {
-            Console.info("***** Attaching paeFile '" + paePath + "' to "
-                    + "structfile=" + subVals.get("structfile"));
-            EBIAlfaFold.addAlphaFoldPAEToStructure(
-                    af.getCurrentView().getAlignment(), paeFile,
-                    subVals.getIndex(), subVals.get("structfile"), false);
+            Console.debug("##### Attaching paeFile '" + paePath + "' to "
+                    + "structid=" + structid);
+            EBIAlfaFold.addAlphaFoldPAE(af.getCurrentView().getAlignment(),
+                    paeFile, seqindex, structid, true, true, paeLabel);
           }
-          else if (subVals.has("structid"))
+          else if (seqid != null)
           {
-            Console.info("***** Attaching paeFile '" + paePath + "' to "
-                    + "structid=" + subVals.get("structid"));
-            EBIAlfaFold.addAlphaFoldPAEToStructure(
-                    af.getCurrentView().getAlignment(), paeFile,
-                    subVals.getIndex(), subVals.get("structid"), true);
+            Console.debug("##### Attaching paeFile '" + paePath + "' to "
+                    + "seqid=" + seqid);
+            EBIAlfaFold.addAlphaFoldPAE(af.getCurrentView().getAlignment(),
+                    paeFile, seqindex, seqid, false, false, paeLabel);
           }
-          else
+          else if (seqindex >= 0)
           {
-            Console.debug("***** Attaching paeFile '" + paePath
-                    + "' to sequence index " + subVals.getIndex());
-            EBIAlfaFold.addAlphaFoldPAEToSequence(
-                    af.getCurrentView().getAlignment(), paeFile,
-                    subVals.getIndex(), null);
-            // required to readjust the height and position of the pAE
-            // annotation
+            Console.debug("##### Attaching paeFile '" + paePath
+                    + "' to sequence index " + seqindex);
+            EBIAlfaFold.addAlphaFoldPAE(af.getCurrentView().getAlignment(),
+                    paeFile, seqindex, null, false, false, paeLabel);
           }
           for (AlignmentViewPanel ap : af.getAlignPanels())
           {
+            // required to readjust the height and position of the PAE
+            // annotation
             ap.adjustAnnotationHeight();
           }
         }
@@ -492,25 +587,27 @@ public class Commands
         Console.info("Changed colour " + acg.toString());
       }
     }
+
+    return theseArgsWereParsed;
   }
 
-  protected void processImages(String id)
+  protected boolean processImages(String id)
   {
-    ArgValuesMap avm = new ArgValuesMap(argParser.linkedArgs(id));
+    ArgValuesMap avm = argParser.linkedArgs(id);
     AlignFrame af = afMap.get(id);
 
     if (af == null)
     {
       Console.warn("Did not have an alignment window for id=" + id);
-      return;
+      return false;
     }
 
-    if (avm.hasValue(Arg.IMAGE))
+    if (avm.containsArg(Arg.IMAGE))
     {
       for (ArgValue av : avm.getArgValueList(Arg.IMAGE))
       {
         String val = av.getValue();
-        SubVals subVal = new SubVals(val);
+        SubVals subVal = av.getSubVals();
         String type = "png"; // default
         String fileName = subVal.getContent();
         File file = new File(fileName);
@@ -548,24 +645,28 @@ public class Commands
           htmlSVG.exportHTML(fileName);
           break;
         default:
-          Console.warn("--image type '" + type + "' not known. Ignoring");
+          Console.warn(Arg.IMAGE.argString() + " type '" + type
+                  + "' not known. Ignoring");
           break;
         }
       }
     }
+    return true;
   }
 
   private SequenceI getSpecifiedSequence(AlignFrame af, SubVals subId)
   {
+    if (subId == null)
+      return null;
     AlignmentI al = af.getCurrentView().getAlignment();
-    if (-1 < subId.getIndex()
-            && subId.getIndex() < al.getSequences().size())
+    if (subId.has("seqid"))
     {
-      return al.getSequenceAt(subId.getIndex());
+      return al.findName(subId.get("seqid"));
     }
-    else if (subId.has("seqid"))
+    else if (-1 < subId.getIndex()
+            && subId.getIndex() < al.getSequences().size())
     {
-      return al.findName(subId.get("seqid"));
+      return al.getSequenceAt(subId.getIndex());
     }
     return null;
   }