JAL-629 Add image output and quit
[jalview.git] / src / jalview / bin / Commands.java
index 4239ec7..2a71e74 100644 (file)
@@ -14,14 +14,19 @@ import jalview.analysis.AlignmentUtils;
 import jalview.api.AlignmentViewPanel;
 import jalview.bin.ArgParser.Arg;
 import jalview.bin.ArgParser.ArgValues;
+import jalview.bin.ArgParser.SubVal;
 import jalview.datamodel.AlignmentAnnotation;
+import jalview.datamodel.SequenceI;
 import jalview.gui.AlignFrame;
+import jalview.gui.AlignmentPanel;
 import jalview.gui.Desktop;
+import jalview.gui.StructureChooser;
 import jalview.io.AppletFormatAdapter;
 import jalview.io.DataSourceType;
 import jalview.io.FileFormatException;
 import jalview.io.FileFormatI;
 import jalview.io.FileLoader;
+import jalview.io.HtmlSvgOutput;
 import jalview.io.IdentifyFile;
 import jalview.util.HttpUtils;
 import jalview.util.MessageManager;
@@ -42,16 +47,25 @@ public class Commands
   {
     argParser = ap;
     headless = h;
-    for (String id : argParser.linkedIds())
+    if (argParser != null && argParser.linkedIds() != null)
     {
-      Commands cmds = new Commands();
-      if (id == null)
+      for (String id : argParser.linkedIds())
       {
-        cmds.processUnlinked(id);
+        Commands cmds = new Commands();
+        if (id == null)
+        {
+          cmds.processUnlinked(id);
+        }
+        else
+        {
+          cmds.processLinked(id);
+        }
+        cmds.processImages(id);
       }
-      else
+
+      if (argParser.getBool(Arg.QUIT))
       {
-        cmds.processLinked(id);
+        Jalview.getInstance().quit();
       }
     }
   }
@@ -87,13 +101,13 @@ public class Commands
     DataSourceType protocol = null;
     */
 
-    if (m.get(Arg.OPEN) != null)
+    if (ArgParser.getArgValues(m, Arg.OPEN) != null)
     {
       long progress = -1;
 
       boolean first = true;
       AlignFrame af;
-      OPEN: for (String openFile : m.get(Arg.OPEN).getValues())
+      OPEN: for (String openFile : ArgParser.getValues(m, Arg.OPEN))
       {
         if (openFile == null)
           continue OPEN;
@@ -142,21 +156,50 @@ public class Commands
         af = afMap.get(id);
         if (af == null)
         {
+          /*
+           * 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
           AlignmentAnnotation.TFType tempfacType = null;
-          if ((m.get(Arg.NOTEMPFAC) == null
-                  || !m.get(Arg.NOTEMPFAC).getBoolean())
-                  && m.get(Arg.TEMPFAC) != null)
+          if ((!ArgParser.getBoolean(m, Arg.NOTEMPFAC))
+                  && ArgParser.getArgValues(m, Arg.TEMPFAC) != null)
           {
             try
             {
-              tempfacType = AlignmentAnnotation.TFType
-                      .valueOf(m.get(Arg.TEMPFAC).getValue()
-                              .toUpperCase(Locale.ROOT));
+              tempfacType = AlignmentAnnotation.TFType.valueOf(ArgParser
+                      .getValue(m, Arg.TEMPFAC).toUpperCase(Locale.ROOT));
               Console.debug("Obtained Temperature Factor type of '"
                       + tempfacType + "'");
             } catch (IllegalArgumentException e)
             {
+              // Just an error message!
               StringBuilder sb = new StringBuilder().append("Cannot set --")
                       .append(Arg.TEMPFAC.getName()).append(" to '")
                       .append(tempfacType)
@@ -181,18 +224,18 @@ public class Commands
                   tempfacType);
 
           // wrap alignment?
-          if (m.get(Arg.WRAP) != null && m.get(Arg.WRAP).getBoolean())
+          if (ArgParser.getBoolean(m, Arg.WRAP))
           {
             af.getCurrentView().setWrapAlignment(true);
           }
 
           // change alignment frame title
-          if (m.get(Arg.TITLE) != null)
-            af.setTitle(m.get(Arg.TITLE).getValue());
+          if (ArgParser.getValue(m, Arg.TITLE) != null)
+            af.setTitle(ArgParser.getValue(m, Arg.TITLE));
 
+          /* hacky approach to hiding the annotations */
           // show secondary structure annotations?
-          if (m.get(Arg.SSANNOTATION) != null
-                  && !m.get(Arg.SSANNOTATION).getBoolean())
+          if (ArgParser.getBoolean(m, Arg.SSANNOTATION))
           {
             // do this better (annotation types?)
             AlignmentUtils.showOrHideSequenceAnnotations(
@@ -202,8 +245,7 @@ public class Commands
           }
 
           // show temperature factor annotations?
-          if (m.get(Arg.NOTEMPFAC) != null
-                  && m.get(Arg.NOTEMPFAC).getBoolean())
+          if (ArgParser.getBoolean(m, Arg.NOTEMPFAC))
           {
             // do this better (annotation types?)
             List<String> hideThese = new ArrayList<>();
@@ -215,16 +257,26 @@ public class Commands
                     false, false);
           }
           else
+          /* comment out hacky approach up to here and add this line:
+           if (showTemperatureFactor)
+             */
           {
-            if (m.get(Arg.TEMPFAC_LABEL) != null)
+            if (ArgParser.getValue(m, Arg.TEMPFAC_LABEL) != null)
             {
               AlignmentAnnotation aa = AlignmentUtils
                       .getFirstSequenceAnnotationOfType(
                               af.getCurrentView().getAlignment(),
                               AlignmentAnnotation.LINE_GRAPH);
+              String label = ArgParser.getValue(m, Arg.TEMPFAC_LABEL);
               if (aa != null)
               {
-                aa.label = m.get(Arg.TEMPFAC_LABEL).getValue();
+                aa.label = label;
+              }
+              else
+              {
+                Console.info(
+                        "Could not find annotation to apply tempfac_label '"
+                                + label);
               }
             }
           }
@@ -261,18 +313,18 @@ public class Commands
     }
 
     // load a pAE file if given
-    if (m.get(Arg.PAEMATRIX) != null)
+    if (ArgParser.getValues(m, Arg.PAEMATRIX) != null)
     {
       AlignFrame af = afMap.get(id);
       if (af != null)
       {
-        for (String val : m.get(Arg.PAEMATRIX).getValues())
+        for (String val : ArgParser.getValues(m, Arg.PAEMATRIX))
         {
-          SubId subId = new SubId(val);
-          File paeFile = new File(subId.content);
+          SubVal subVal = ArgParser.getSubVal(val);
+          File paeFile = new File(subVal.content);
           EBIAlfaFold.addAlphaFoldPAE(af.getCurrentView().getAlignment(),
-                  paeFile, subId.index,
-                  "id".equals(subId.keyName) ? subId.keyValue : null);
+                  paeFile, subVal.index,
+                  "id".equals(subVal.keyName) ? subVal.keyValue : null);
           // required to readjust the height and position of the pAE
           // annotation
           for (AlignmentViewPanel ap : af.getAlignPanels())
@@ -282,56 +334,135 @@ public class Commands
         }
       }
     }
-  }
 
-  /**
-   * A helper class to parse a string of the possible forms "content"
-   * "[index]content", "[keyName=keyValue]content" and return the integer index,
-   * the strings keyName and keyValue, and the content after the square brackets
-   * (if present). Values not set will be -1 or null.
-   */
-  protected class SubId
-  {
-    protected int index = 0;
+    // open the structure (from same PDB file or given PDBfile)
+    if (!ArgParser.getBoolean(m, Arg.NOSTRUCTURE))
+    {
+      AlignFrame af = afMap.get(id);
+      if (ArgParser.getArgValues(m, Arg.STRUCTURE) != null)
+      {
+        STRUCTURE: for (String val : ArgParser.getValues(m, Arg.STRUCTURE))
+        {
+          SubVal subId = new SubVal(val);
+          SequenceI seq = getSpecifiedSequence(af, subId);
+          if (seq == null)
+          {
+            Console.warn("Could not find sequence for argument --"
+                    + Arg.STRUCTURE + "=" + val);
+            break STRUCTURE;
+          }
+          File structureFile = null;
+          if (subId.content != null && subId.content.length() != 0)
+          {
+            structureFile = new File(subId.content);
+            Console.debug("Using structure file (from argument) '"
+                    + structureFile.getAbsolutePath() + "'");
+          }
+          /* THIS DOESN'T WORK */
+          else if (seq.getAllPDBEntries() != null
+                  && seq.getAllPDBEntries().size() > 0)
+          {
+            structureFile = new File(
+                    seq.getAllPDBEntries().elementAt(0).getFile());
+            Console.debug("Using structure file (from sequence) '"
+                    + structureFile.getAbsolutePath() + "'");
+          }
 
-    protected String keyName = null;
+          if (structureFile == null)
+          {
+            Console.warn("Not provided structure file with '" + val + "'");
+            continue STRUCTURE;
+          }
 
-    protected String keyValue = null;
+          if (!structureFile.exists())
+          {
+            Console.warn("Structure file '"
+                    + structureFile.getAbsoluteFile() + "' not found.");
+            continue STRUCTURE;
+          }
 
-    protected String content = null;
+          Console.debug("Using structure file "
+                  + structureFile.getAbsolutePath());
+
+          // open structure view
+          AlignmentPanel ap = af.alignPanel;
+          StructureChooser.openStructureFileForSequence(ap, seq,
+                  structureFile);
+        }
+      }
+    }
+  }
 
-    protected SubId(String item)
+  protected void processImages(String id)
+  {
+    Map<Arg, ArgValues> m = argParser.linkedArgs(id);
+    AlignFrame af = afMap.get(id);
+
+    if (af == null)
     {
-      if (item.indexOf('[') == 0 && item.indexOf(']') > 1)
+      Console.warn("Did not have an alignment window for id=" + id);
+      return;
+    }
+
+    if (ArgParser.getValues(m, Arg.IMAGE) != null)
+    {
+      for (String val : ArgParser.getValues(m, Arg.IMAGE))
       {
-        int openBracket = item.indexOf('[');
-        int closeBracket = item.indexOf(']');
-        String indexString = item.substring(openBracket + 1, closeBracket);
-        this.content = item.substring(closeBracket + 1);
-        int equals = indexString.indexOf('=');
-        if (equals > -1)
+        SubVal subVal = new SubVal(val);
+        String type = "png"; // default
+        String fileName = subVal.content;
+        File file = new File(fileName);
+        if ("type".equals(subVal.keyName))
         {
-          this.keyName = indexString.substring(0, equals);
-          this.keyValue = indexString.substring(equals + 1);
-          this.index = -1;
+          type = subVal.keyValue;
         }
-        else
+        else if (fileName != null)
         {
-          try
-          {
-            this.index = Integer.parseInt(indexString);
-          } catch (NumberFormatException e)
+          for (String ext : new String[] { "svg", "png", "html" })
           {
-            Console.warn("Failed to obtain sequenced id or index from '"
-                    + item + "'. Setting index=0 and using content='"
-                    + content + "'.");
+            if (fileName.toLowerCase(Locale.ROOT).endsWith("." + ext))
+            {
+              type = ext;
+            }
           }
         }
+        switch (type)
+        {
+        case "svg":
+          af.createSVG(file);
+          break;
+        case "png":
+          af.createPNG(file);
+          break;
+        case "html":
+          HtmlSvgOutput htmlSVG = new HtmlSvgOutput(af.alignPanel);
+          htmlSVG.exportHTML(fileName);
+          break;
+        }
       }
-      else
+    }
+  }
+
+  private SequenceI getSpecifiedSequence(AlignFrame af, SubVal subId)
+  {
+    SequenceI seq = null;
+    SequenceI[] sequences = af.getCurrentView().getAlignment()
+            .getSequencesArray();
+    if (-1 < subId.index && subId.index < sequences.length)
+    {
+      seq = sequences[subId.index];
+    }
+    else if ("id".equals(subId.keyName))
+    {
+      for (SequenceI s : sequences)
       {
-        this.content = item;
+        if (s.getDisplayId(false).equals(subId.keyValue))
+        {
+          seq = s;
+          break;
+        }
       }
     }
+    return seq;
   }
 }