X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fbin%2FCommands.java;h=475eba26165d3da7f88e8e51bb554665c10d8d77;hb=164fb77632cc3c9a3b5f5ac5290eadec920ffbc6;hp=fc2ee1af0be16c641543f2b1df42c9e3a67c11df;hpb=0788111a588187a04dd0d254d70b055274cf2c9d;p=jalview.git
diff --git a/src/jalview/bin/Commands.java b/src/jalview/bin/Commands.java
index fc2ee1a..475eba2 100644
--- a/src/jalview/bin/Commands.java
+++ b/src/jalview/bin/Commands.java
@@ -1,24 +1,46 @@
+/*
+ * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
+ * Copyright (C) $$Year-Rel$$ The Jalview Authors
+ *
+ * This file is part of Jalview.
+ *
+ * Jalview is free software: you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation, either version 3
+ * of the License, or (at your option) any later version.
+ *
+ * Jalview is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
+ * PURPOSE. See the GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Jalview. If not, see .
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
+ */
package jalview.bin;
+import java.awt.Color;
import java.io.File;
import java.io.IOException;
-import java.util.AbstractMap;
+import java.net.URISyntaxException;
import java.util.ArrayList;
import java.util.Arrays;
-import java.util.EnumSet;
+import java.util.Collections;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Locale;
import java.util.Map;
-import java.util.Map.Entry;
+
+import javax.swing.SwingUtilities;
import jalview.analysis.AlignmentUtils;
+import jalview.api.structures.JalviewStructureDisplayI;
+import jalview.bin.Jalview.ExitCode;
import jalview.bin.argparser.Arg;
import jalview.bin.argparser.ArgParser;
-import jalview.bin.argparser.ArgParser.Position;
import jalview.bin.argparser.ArgValue;
-import jalview.bin.argparser.ArgValues;
import jalview.bin.argparser.ArgValuesMap;
import jalview.bin.argparser.SubVals;
import jalview.datamodel.AlignmentI;
@@ -26,24 +48,39 @@ import jalview.datamodel.SequenceI;
import jalview.datamodel.annotations.AlphaFoldAnnotationRowBuilder;
import jalview.gui.AlignFrame;
import jalview.gui.AlignmentPanel;
+import jalview.gui.AppJmol;
import jalview.gui.Desktop;
import jalview.gui.Preferences;
import jalview.gui.StructureChooser;
import jalview.gui.StructureViewer;
import jalview.gui.StructureViewer.ViewerType;
import jalview.io.AppletFormatAdapter;
+import jalview.io.BackupFiles;
+import jalview.io.BioJsHTMLOutput;
import jalview.io.DataSourceType;
import jalview.io.FileFormat;
import jalview.io.FileFormatException;
import jalview.io.FileFormatI;
+import jalview.io.FileFormats;
import jalview.io.FileLoader;
import jalview.io.HtmlSvgOutput;
import jalview.io.IdentifyFile;
+import jalview.io.NewickFile;
+import jalview.io.exceptions.ImageOutputException;
+import jalview.schemes.ColourSchemeI;
+import jalview.schemes.ColourSchemeProperty;
+import jalview.structure.StructureCommandI;
import jalview.structure.StructureImportSettings.TFType;
import jalview.structure.StructureSelectionManager;
+import jalview.util.ColorUtils;
+import jalview.util.FileUtils;
import jalview.util.HttpUtils;
+import jalview.util.ImageMaker;
+import jalview.util.ImageMaker.TYPE;
import jalview.util.MessageManager;
import jalview.util.Platform;
+import jalview.util.StringUtils;
+import jalview.util.imagemaker.BitmapImageSizing;
public class Commands
{
@@ -55,10 +92,14 @@ public class Commands
private Map afMap;
+ private Map> svMap;
+
private boolean commandArgsProvided = false;
private boolean argsWereParsed = false;
+ private List errors = new ArrayList<>();
+
public Commands(ArgParser argparser, boolean headless)
{
this(Desktop.instance, argparser, headless);
@@ -69,39 +110,53 @@ public class Commands
argParser = argparser;
headless = h;
desktop = d;
- afMap = new HashMap();
- if (argparser != null)
- {
- processArgs(argparser, headless);
- }
+ afMap = new HashMap<>();
}
- private boolean processArgs(ArgParser argparser, boolean h)
+ protected boolean processArgs()
{
- argParser = argparser;
- headless = h;
+ if (argParser == null)
+ {
+ return true;
+ }
+
boolean theseArgsWereParsed = false;
- if (argParser != null && argParser.linkedIds() != null)
+ if (argParser != null && argParser.getLinkedIds() != null)
{
- for (String id : argParser.linkedIds())
+ for (String id : argParser.getLinkedIds())
{
- ArgValuesMap avm = argParser.linkedArgs(id);
+ ArgValuesMap avm = argParser.getLinkedArgs(id);
theseArgsWereParsed = true;
- if (id == null)
+ boolean processLinkedOkay = processLinked(id);
+ theseArgsWereParsed &= processLinkedOkay;
+
+ processGroovyScript(id);
+
+ // wait around until alignFrame isn't busy
+ AlignFrame af = afMap.get(id);
+ while (af != null && af.getViewport().isCalcInProgress())
{
- theseArgsWereParsed &= processUnlinked(id);
+ try
+ {
+ Thread.sleep(25);
+ } catch (Exception q)
+ {
+ }
+ ;
}
- else
+
+ theseArgsWereParsed &= processImages(id);
+
+ if (processLinkedOkay)
{
- theseArgsWereParsed &= processLinked(id);
+ theseArgsWereParsed &= processOutput(id);
}
- theseArgsWereParsed &= processImages(id);
// close ap
if (avm.getBoolean(Arg.CLOSE))
{
- AlignFrame af = afMap.get(id);
+ af = afMap.get(id);
if (af != null)
{
af.closeMenuItem_actionPerformed(true);
@@ -111,9 +166,22 @@ public class Commands
}
}
- if (argParser.getBool(Arg.QUIT))
+
+ // report errors - if any
+ String errorsRaised = errorsToString();
+ if (errorsRaised.trim().length() > 0)
+ {
+ Console.warn(
+ "The following errors and warnings occurred whilst processing files:\n"
+ + errorsRaised);
+ }
+ // gui errors reported in Jalview
+
+ if (argParser.getBoolean(Arg.QUIT))
{
- Jalview.getInstance().quit();
+ Jalview.getInstance().exit(
+ "Exiting due to " + Arg.QUIT.argString() + " argument.",
+ ExitCode.OK);
return true;
}
// carry on with jalview.bin.Jalview
@@ -131,48 +199,39 @@ public class Commands
return argsWereParsed;
}
- protected boolean processUnlinked(String id)
- {
- return processLinked(id);
- }
-
protected boolean processLinked(String id)
{
boolean theseArgsWereParsed = false;
- ArgValuesMap avm = argParser.linkedArgs(id);
+ ArgValuesMap avm = argParser.getLinkedArgs(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.containsArg(Arg.OPEN) || avm.containsArg(Arg.OPENNEW))
+ Boolean isError = Boolean.valueOf(false);
+
+ // set wrap scope here so it can be applied after structures are opened
+ boolean wrap = false;
+
+ if (avm.containsArg(Arg.APPEND) || avm.containsArg(Arg.OPEN))
{
commandArgsProvided = true;
- long progress = -1;
+ final long progress = System.currentTimeMillis();
boolean first = true;
boolean progressBarSet = false;
AlignFrame af;
- // Combine the OPEN and OPENNEW files into one list, along with whether it
- // was OPEN or OPENNEW
- List> openAvList = new ArrayList<>();
- avm.getArgValueList(Arg.OPEN).stream()
- .forEachOrdered(av -> openAvList.add(
- new AbstractMap.SimpleEntry(Arg.OPEN,
- av)));
- avm.getArgValueList(Arg.OPENNEW).stream()
- .forEachOrdered(av -> openAvList
- .add(new AbstractMap.SimpleEntry(
- Arg.OPENNEW, av)));
- for (Entry aav : openAvList)
+ // Combine the APPEND and OPEN files into one list, along with whether it
+ // was APPEND or OPEN
+ List openAvList = new ArrayList<>();
+ openAvList.addAll(avm.getArgValueList(Arg.OPEN));
+ openAvList.addAll(avm.getArgValueList(Arg.APPEND));
+ // sort avlist based on av.getArgIndex()
+ Collections.sort(openAvList);
+ for (ArgValue av : openAvList)
{
- Arg a = aav.getKey();
- ArgValue av = aav.getValue();
+ Arg a = av.getArg();
+ SubVals sv = av.getSubVals();
String openFile = av.getValue();
if (openFile == null)
continue;
@@ -183,10 +242,18 @@ public class Commands
first = false;
if (!headless && desktop != null)
{
- desktop.setProgressBar(
- MessageManager.getString(
- "status.processing_commandline_args"),
- progress = System.currentTimeMillis());
+ SwingUtilities.invokeLater(new Runnable()
+ {
+ @Override
+ public void run()
+ {
+ desktop.setProgressBar(
+ MessageManager.getString(
+ "status.processing_commandline_args"),
+ progress);
+
+ }
+ });
progressBarSet = true;
}
}
@@ -202,7 +269,9 @@ public class Commands
{
if (!(new File(openFile)).exists())
{
- Console.warn("Can't find file '" + openFile + "'");
+ addError("Can't find file '" + openFile + "'");
+ isError = true;
+ continue;
}
}
}
@@ -216,110 +285,167 @@ public class Commands
format = new IdentifyFile().identify(openFile, protocol);
} catch (FileFormatException e1)
{
- Console.error("Unknown file format for '" + openFile + "'");
+ addError("Unknown file format for '" + openFile + "'");
+ isError = true;
+ continue;
}
af = afMap.get(id);
+ // When to open a new AlignFrame
if (af == null || "true".equals(av.getSubVal("new"))
- || a == Arg.OPENNEW || format == FileFormat.Jalview)
+ || a == Arg.OPEN || format == FileFormat.Jalview)
{
- /*
- * this approach isn't working yet // get default annotations before opening
- * AlignFrame if (m.get(Arg.SSANNOTATIONS) != null) {
- * Console.debug("##### SSANNOTATIONS=" + m.get(Arg.SSANNOTATIONS).getBoolean());
- * } if (m.get(Arg.NOTEMPFAC) != null) { Console.debug( "##### NOTEMPFAC=" +
- * m.get(Arg.NOTEMPFAC).getBoolean()); } boolean showSecondaryStructure =
- * (m.get(Arg.SSANNOTATIONS) != null) ? m.get(Arg.SSANNOTATIONS).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); }
- */
+ if (a == Arg.OPEN)
+ {
+ Jalview.testoutput(argParser, Arg.OPEN, "examples/uniref50.fa",
+ openFile);
+ }
Console.debug(
"Opening '" + openFile + "' in new alignment frame");
FileLoader fileLoader = new FileLoader(!headless);
+ boolean xception = false;
+ try
+ {
+ af = fileLoader.LoadFileWaitTillLoaded(openFile, protocol,
+ format);
+ } catch (Throwable thr)
+ {
+ xception = true;
+ addError("Couldn't open '" + openFile + "' as " + format + " "
+ + thr.getLocalizedMessage()
+ + " (Enable debug for full stack trace)");
+ isError = true;
+ Console.debug("Exception when opening '" + openFile + "'", thr);
+ } finally
+ {
+ if (af == null && !xception)
+ {
+ addInfo("Ignoring '" + openFile
+ + "' - no alignment data found.");
+ continue;
+ }
+ }
- af = fileLoader.LoadFileWaitTillLoaded(openFile, protocol,
- format);
- boolean showAnnotations = ArgParser.getFromSubValArgOrPref(avm,
- Arg.ANNOTATIONS, av.getSubVals(), null,
- "SHOW_ANNOTATIONS", true);
- af.setAnnotationsVisibility(showAnnotations, false, true);
+ // colour alignment
+ String colour = avm.getFromSubValArgOrPref(av, Arg.COLOUR, sv,
+ null, "DEFAULT_COLOUR_PROT", "");
+ this.colourAlignFrame(af, colour);
- // wrap alignment?
- if (avm.getBoolean(Arg.WRAP))
+ // Change alignment frame title
+ String title = avm.getFromSubValArgOrPref(av, Arg.TITLE, sv, null,
+ null, null);
+ if (title != null)
{
- af.getCurrentView().setWrapAlignment(true);
+ af.setTitle(title);
+ Jalview.testoutput(argParser, Arg.TITLE, "test title", title);
}
- // colour aligment?
- if (avm.containsArg(Arg.COLOUR))
+ // Add features
+ String featuresfile = avm.getValueFromSubValOrArg(av,
+ Arg.FEATURES, sv);
+ if (featuresfile != null)
{
- af.changeColour_actionPerformed(avm.getValue(Arg.COLOUR));
+ af.parseFeaturesFile(featuresfile,
+ AppletFormatAdapter.checkProtocol(featuresfile));
+ Jalview.testoutput(argParser, Arg.FEATURES,
+ "examples/testdata/plantfdx.features", featuresfile);
}
- // change alignment frame title
- if (avm.containsArg(Arg.TITLE))
- af.setTitle(avm.getValue(Arg.TITLE));
+ // Add annotations from file
+ String annotationsfile = avm.getValueFromSubValOrArg(av,
+ Arg.ANNOTATIONS, sv);
+ if (annotationsfile != null)
+ {
+ af.loadJalviewDataFile(annotationsfile, null, null, null);
+ Jalview.testoutput(argParser, Arg.ANNOTATIONS,
+ "examples/testdata/plantfdx.annotations",
+ annotationsfile);
+ }
- // show secondary structure annotations?
- boolean showSSAnnotations = ArgParser.getFromSubValArgOrPref(avm,
- Arg.SSANNOTATIONS, av.getSubVals(), null,
- "STRUCT_FROM_PDB", true);
- if (avm.getBoolean(Arg.SSANNOTATIONS))
+ // Set or clear the sortbytree flag
+ boolean sortbytree = avm.getBoolFromSubValOrArg(Arg.SORTBYTREE,
+ sv);
+ if (sortbytree)
{
- af.setAnnotationsVisibility(showSSAnnotations, true, false);
- /*
- AlignmentUtils.showOrHideSequenceAnnotations(
- af.getCurrentView().getAlignment(),
- Collections.singleton("Secondary Structure"), null,
- false, false);
- */
+ af.getViewport().setSortByTree(true);
+ Jalview.testoutput(argParser, Arg.SORTBYTREE);
}
- // show temperature factor annotations?
- if (avm.getBoolean(Arg.NOTEMPFAC))
+ // Load tree from file
+ String treefile = avm.getValueFromSubValOrArg(av, Arg.TREE, sv);
+ if (treefile != null)
{
- // do this better (annotation types?)
- List hideThese = new ArrayList<>();
- hideThese.add("Temperature Factor");
- hideThese.add(AlphaFoldAnnotationRowBuilder.LABEL);
- AlignmentUtils.showOrHideSequenceAnnotations(
- af.getCurrentView().getAlignment(), hideThese, null,
- false, false);
+ try
+ {
+ NewickFile nf = new NewickFile(treefile,
+ AppletFormatAdapter.checkProtocol(treefile));
+ af.getViewport().setCurrentTree(
+ af.showNewickTree(nf, treefile).getTree());
+ Jalview.testoutput(argParser, Arg.TREE,
+ "examples/testdata/uniref50_test_tree", treefile);
+ } catch (IOException e)
+ {
+ addError("Couldn't add tree " + treefile, e);
+ isError = true;
+ }
}
- else
- /*
- * comment out hacky approach up to here and add this line: if
- * (showTemperatureFactor)
- */
+
+ // Show secondary structure annotations?
+ boolean showSSAnnotations = avm.getFromSubValArgOrPref(
+ Arg.SHOWSSANNOTATIONS, av.getSubVals(), null,
+ "STRUCT_FROM_PDB", true);
+
+ // Show sequence annotations?
+ boolean showAnnotations = avm.getFromSubValArgOrPref(
+ Arg.SHOWANNOTATIONS, av.getSubVals(), null,
+ "SHOW_ANNOTATIONS", true);
+
+ boolean hideTFrows = (avm.getBoolean(Arg.NOTEMPFAC));
+ final AlignFrame _af = af;
+ // many of jalview's format/layout methods are only thread safe on the
+ // swingworker thread.
+ // all these methods should be on the alignViewController so it can
+ // coordinate such details
+ try
{
- /*
- if (avm.containsArg(Arg.TEMPFAC_LABEL))
+ SwingUtilities.invokeAndWait(new Runnable()
{
- AlignmentAnnotation aa = AlignmentUtils
- .getFirstSequenceAnnotationOfType(
- af.getCurrentView().getAlignment(),
- AlignmentAnnotation.LINE_GRAPH);
- String label = avm.getValue(Arg.TEMPFAC_LABEL);
- if (aa != null)
- {
- aa.label = label;
- }
- else
+
+ @Override
+ public void run()
{
- Console.info(
- "Could not find annotation to apply tempfac_label '"
- + label);
+ _af.setAnnotationsVisibility(showSSAnnotations, true,
+ false);
+
+ _af.setAnnotationsVisibility(showAnnotations, false, true);
+
+ // show temperature factor annotations?
+ if (hideTFrows)
+ {
+ // do this better (annotation types?)
+ List hideThese = new ArrayList<>();
+ hideThese.add("Temperature Factor");
+ hideThese.add(AlphaFoldAnnotationRowBuilder.LABEL);
+ AlignmentUtils.showOrHideSequenceAnnotations(
+ _af.getCurrentView().getAlignment(), hideThese,
+ null, false, false);
+ }
}
- }
- */
+ });
+ } catch (Exception x)
+ {
+ Console.warn(
+ "Unexpected exception adjusting annotation row visibility.",
+ x);
}
+ // wrap alignment? do this last for formatting reasons
+ wrap = avm.getFromSubValArgOrPref(Arg.WRAP, sv, null,
+ "WRAP_ALIGNMENT", false);
+ // af.setWrapFormat(wrap) is applied after structures are opened for
+ // annotation reasons
+
// store the AlignFrame for this id
afMap.put(id, af);
@@ -337,21 +463,29 @@ public class Commands
{
Console.debug(
"Opening '" + openFile + "' in existing alignment frame");
- af.getCurrentView().addFile(new File(openFile), format, false);
+
+ DataSourceType dst = HttpUtils.startsWithHttpOrHttps(openFile)
+ ? DataSourceType.URL
+ : DataSourceType.FILE;
+
+ FileLoader fileLoader = new FileLoader(!headless);
+ fileLoader.LoadFile(af.getCurrentView(), openFile, dst, null,
+ false);
}
- Console.debug("Command " + Arg.OPEN + " executed successfully!");
+ Console.debug("Command " + Arg.APPEND + " executed successfully!");
}
if (first) // first=true means nothing opened
{
if (headless)
{
- Jalview.exit("Could not open any files in headless mode", 1);
+ Jalview.exit("Could not open any files in headless mode",
+ ExitCode.NO_FILES);
}
else
{
- Console.warn("No more files to open");
+ Console.info("No more files to open");
}
}
if (progressBarSet && desktop != null)
@@ -362,15 +496,20 @@ public class Commands
// open the structure (from same PDB file or given PDBfile)
if (!avm.getBoolean(Arg.NOSTRUCTURE))
{
+
AlignFrame af = afMap.get(id);
if (avm.containsArg(Arg.STRUCTURE))
{
commandArgsProvided = true;
- for (ArgValue av : avm.getArgValueList(Arg.STRUCTURE))
+ for (
+
+ ArgValue av : avm.getArgValueList(Arg.STRUCTURE))
{
+ argParser.setStructureFilename(null);
String val = av.getValue();
SubVals subVals = av.getSubVals();
- SequenceI seq = getSpecifiedSequence(af, subVals);
+ int argIndex = av.getArgIndex();
+ SequenceI seq = getSpecifiedSequence(af, avm, av);
if (seq == null)
{
// Could not find sequence from subId, let's assume the first
@@ -381,63 +520,51 @@ public class Commands
if (seq == null)
{
- Console.warn("Could not find sequence for argument "
+ addWarn("Could not find sequence for argument "
+ Arg.STRUCTURE.argString() + "=" + val);
- // you probably want to continue here, not break
- // break;
continue;
}
+ String structureFilename = null;
File structureFile = null;
if (subVals.getContent() != null
&& subVals.getContent().length() != 0)
{
- structureFile = new File(subVals.getContent());
+ structureFilename = subVals.getContent();
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 });
- *
- */
+ + structureFilename + "'");
+ structureFile = new File(structureFilename);
+ }
/* 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() + "'");
+ if (structureFile != null)
+ {
+ Console.debug("Using structure file (from sequence) '"
+ + structureFile.getAbsolutePath() + "'");
+ }
+ structureFilename = structureFile.getAbsolutePath();
}
- if (structureFile == null)
+ if (structureFilename == null || structureFile == null)
{
- Console.warn("Not provided structure file with '" + val + "'");
+ addWarn("Not provided structure file with '" + val + "'");
continue;
}
if (!structureFile.exists())
{
- Console.warn("Structure file '"
- + structureFile.getAbsoluteFile() + "' not found.");
+ addWarn("Structure file '" + structureFile.getAbsoluteFile()
+ + "' not found.");
continue;
}
Console.debug("Using structure file "
+ structureFile.getAbsolutePath());
- // ##### Does this need to happen? Follow
- // openStructureFileForSequence() below
- /*
- PDBEntry fileEntry = new AssociatePdbFileWithSeq()
- .associatePdbWithSeq(structureFile.getAbsolutePath(),
- DataSourceType.FILE, seq, true, Desktop.instance);
- */
+ argParser.setStructureFilename(structureFilename);
// open structure view
AlignmentPanel ap = af.alignPanel;
@@ -450,45 +577,38 @@ public class Commands
String structureFilepath = structureFile.getAbsolutePath();
// get PAEMATRIX file and label from subvals or Arg.PAEMATRIX
- String paeFilepath = subVals.getWithSubstitutions(argParser, id,
- "paematrix");
- String paeLabel = subVals.get("paelabel");
- ArgValue paeAv = getArgAssociatedWithStructure(Arg.PAEMATRIX, avm,
- af, structureFilepath);
- if (paeFilepath == null && paeAv != null)
+ String paeFilepath = avm.getFromSubValArgOrPrefWithSubstitutions(
+ argParser, Arg.PAEMATRIX, ArgValuesMap.Position.AFTER, av,
+ subVals, null, null, null);
+ if (paeFilepath != null)
{
- SubVals sv = paeAv.getSubVals();
- File paeFile = new File(sv.getContent());
+ File paeFile = new File(paeFilepath);
- paeLabel = sv.get("label");
try
{
paeFilepath = paeFile.getCanonicalPath();
} catch (IOException e)
{
paeFilepath = paeFile.getAbsolutePath();
- Console.warn("Problem with the PAE file path: '"
+ addWarn("Problem with the PAE file path: '"
+ paeFile.getPath() + "'");
}
}
// showing annotations from structure file or not
- boolean ssFromStructure = ArgParser.getFromSubValArgOrPref(avm,
- Arg.SSANNOTATIONS, subVals, null, "STRUCT_FROM_PDB",
+ boolean ssFromStructure = avm.getFromSubValArgOrPref(
+ Arg.SHOWSSANNOTATIONS, subVals, null, "STRUCT_FROM_PDB",
true);
// get TEMPFAC type from subvals or Arg.TEMPFAC in case user Adds
// reference annotations
- String tftString = subVals.get("tempfac");
- TFType tft = avm.getBoolean(Arg.NOTEMPFAC) ? null
- : TFType.DEFAULT;
- ArgValue tftAv = getArgAssociatedWithStructure(Arg.TEMPFAC, avm,
- af, structureFilepath);
- if (tftString == null && tftAv != null)
- {
- tftString = tftAv.getSubVals().getContent();
- }
- if (tftString != null)
+ String tftString = avm.getFromSubValArgOrPrefWithSubstitutions(
+ argParser, Arg.TEMPFAC, ArgValuesMap.Position.AFTER, av,
+ subVals, null, null, null);
+ boolean notempfac = avm.getFromSubValArgOrPref(Arg.NOTEMPFAC,
+ subVals, null, "ADD_TEMPFACT_ANN", false, true);
+ TFType tft = notempfac ? null : TFType.DEFAULT;
+ if (tftString != null && !notempfac)
{
// get kind of temperature factor annotation
try
@@ -511,86 +631,352 @@ public class Commands
if (it.hasNext())
sb.append(", ");
}
- Console.warn(sb.toString());
+ addWarn(sb.toString());
}
}
- String sViewer = ArgParser.getFromSubValArgOrPref(avm,
- Arg.STRUCTUREVIEWER, Position.AFTER, av, subVals,
- "viewer", null, "jmol");
- ViewerType viewerType = null;
- if (!"none".equals(sViewer))
+ String sViewerName = avm.getFromSubValArgOrPref(
+ Arg.STRUCTUREVIEWER, ArgValuesMap.Position.AFTER, av,
+ subVals, null, null, "jmol");
+ ViewerType viewerType = ViewerType.getFromString(sViewerName);
+
+ // TODO use ssFromStructure
+ StructureViewer structureViewer = StructureChooser
+ .openStructureFileForSequence(null, null, ap, seq, false,
+ structureFilepath, tft, paeFilepath, false,
+ ssFromStructure, false, viewerType);
+
+ if (structureViewer == null)
+ {
+ if (!StringUtils.equalsIgnoreCase(sViewerName, "none"))
+ {
+ addError("Failed to import and open structure view for file '"
+ + structureFile + "'.");
+ }
+ continue;
+ }
+ try
{
- for (ViewerType v : EnumSet.allOf(ViewerType.class))
+ long tries = 1000;
+ while (structureViewer.isBusy() && tries > 0)
{
- String name = v.name().toLowerCase(Locale.ROOT)
- .replaceAll(" ", "");
- if (sViewer.equals(name))
+ Thread.sleep(25);
+ if (structureViewer.isBusy())
{
- viewerType = v;
- break;
+ tries--;
+ Console.debug(
+ "Waiting for viewer for " + structureFilepath);
}
}
+ if (tries == 0 && structureViewer.isBusy())
+ {
+ addWarn("Gave up waiting for structure viewer to load file '"
+ + structureFile
+ + "'. Something may have gone wrong.");
+ }
+ } catch (Exception x)
+ {
+ addError("Exception whilst waiting for structure viewer "
+ + structureFilepath, x);
+ isError = true;
+ }
+
+ // add StructureViewer to svMap list
+ if (svMap == null)
+ {
+ svMap = new HashMap<>();
}
+ if (svMap.get(id) == null)
+ {
+ svMap.put(id, new ArrayList<>());
+ }
+ svMap.get(id).add(structureViewer);
- boolean addTempFac = tft != null
- || Cache.getDefault("ADD_TEMPFACT_ANN", false);
+ Console.debug(
+ "Successfully opened viewer for " + structureFilepath);
- // TODO use ssFromStructure
- StructureChooser.openStructureFileForSequence(null, null, ap, seq,
- false, structureFilepath, tft, paeFilepath, false,
- ssFromStructure, false, viewerType);
+ if (avm.containsArg(Arg.STRUCTUREIMAGE))
+ {
+ for (ArgValue structureImageArgValue : avm
+ .getArgValueList(Arg.STRUCTUREIMAGE))
+ {
+ String structureImageFilename = argParser.makeSubstitutions(
+ structureImageArgValue.getValue(), id, true);
+ if (structureViewer != null && structureImageFilename != null)
+ {
+ SubVals structureImageSubVals = null;
+ structureImageSubVals = structureImageArgValue.getSubVals();
+ File structureImageFile = new File(structureImageFilename);
+ String width = avm.getValueFromSubValOrArg(
+ structureImageArgValue, Arg.WIDTH,
+ structureImageSubVals);
+ String height = avm.getValueFromSubValOrArg(
+ structureImageArgValue, Arg.HEIGHT,
+ structureImageSubVals);
+ String scale = avm.getValueFromSubValOrArg(
+ structureImageArgValue, Arg.SCALE,
+ structureImageSubVals);
+ String renderer = avm.getValueFromSubValOrArg(
+ structureImageArgValue, Arg.TEXTRENDERER,
+ structureImageSubVals);
+ String typeS = avm.getValueFromSubValOrArg(
+ structureImageArgValue, Arg.TYPE,
+ structureImageSubVals);
+ if (typeS == null || typeS.length() == 0)
+ {
+ typeS = FileUtils.getExtension(structureImageFile);
+ }
+ TYPE imageType;
+ try
+ {
+ imageType = Enum.valueOf(TYPE.class,
+ typeS.toUpperCase(Locale.ROOT));
+ } catch (IllegalArgumentException e)
+ {
+ addWarn("Do not know image format '" + typeS
+ + "', using PNG");
+ imageType = TYPE.PNG;
+ }
+ BitmapImageSizing userBis = ImageMaker
+ .parseScaleWidthHeightStrings(scale, width, height);
+
+ /////
+ // DON'T TRY TO EXPORT IF VIEWER IS UNSUPPORTED
+ if (viewerType != ViewerType.JMOL)
+ {
+ addWarn("Cannot export image for structure viewer "
+ + viewerType.name() + " yet");
+ continue;
+ }
+
+ /////
+ // Apply the temporary colourscheme to the linked alignment
+ // TODO: enhance for multiple linked alignments.
+
+ String imageColour = avm.getValueFromSubValOrArg(
+ structureImageArgValue, Arg.IMAGECOLOUR,
+ structureImageSubVals);
+ ColourSchemeI originalColourScheme = this
+ .getColourScheme(af);
+ this.colourAlignFrame(af, imageColour);
+
+ /////
+ // custom image background colour
+
+ String bgcolourstring = avm.getValueFromSubValOrArg(
+ structureImageArgValue, Arg.BGCOLOUR,
+ structureImageSubVals);
+ Color bgcolour = null;
+ if (bgcolourstring != null && bgcolourstring.length() > 0)
+ {
+ bgcolour = ColorUtils.parseColourString(bgcolourstring);
+ if (bgcolour == null)
+ {
+ Console.warn(
+ "Background colour string '" + bgcolourstring
+ + "' not recognised -- using default");
+ }
+ }
+
+ JalviewStructureDisplayI sview = structureViewer
+ .getJalviewStructureDisplay();
+
+ File sessionToRestore = null;
+
+ List extraCommands = new ArrayList<>();
+
+ if (extraCommands.size() > 0 || bgcolour != null)
+ {
+ try
+ {
+ sessionToRestore = sview.saveSession();
+ } catch (Throwable t)
+ {
+ Console.warn(
+ "Unable to save temporary session file before custom structure view export operation.");
+ }
+ }
+
+ ////
+ // Do temporary ops
+
+ if (bgcolour != null)
+ {
+ sview.getBinding().setBackgroundColour(bgcolour);
+ }
+
+ sview.getBinding().executeCommands(extraCommands, false,
+ "Executing Custom Commands");
+
+ // and export the view as an image
+ boolean success = this.checksBeforeWritingToFile(avm,
+ subVals, false, structureImageFilename,
+ "structure image", isError);
+
+ if (!success)
+ {
+ continue;
+ }
+ Console.debug("Rendering image to " + structureImageFile);
+ //
+ // TODO - extend StructureViewer / Binding with makePDBImage so
+ // we can do this with every viewer
+ //
+
+ try
+ {
+ // We don't expect class cast exception
+ AppJmol jmol = (AppJmol) sview;
+ jmol.makePDBImage(structureImageFile, imageType, renderer,
+ userBis);
+ Console.info("Exported structure image to "
+ + structureImageFile);
+
+ // RESTORE SESSION AFTER EXPORT IF NEED BE
+ if (sessionToRestore != null)
+ {
+ Console.debug(
+ "Restoring session from " + sessionToRestore);
+
+ sview.getBinding().restoreSession(
+ sessionToRestore.getAbsolutePath());
+
+ }
+ } catch (ImageOutputException ioexec)
+ {
+ addError(
+ "Unexpected error when restoring structure viewer session after custom view operations.");
+ isError = true;
+ continue;
+ } finally
+ {
+ try
+ {
+ this.colourAlignFrame(af, originalColourScheme);
+ } catch (Exception t)
+ {
+ addError(
+ "Unexpected error when restoring colourscheme to alignment after temporary change for export.",
+ t);
+ }
+ }
+ }
+ }
+ }
+ argParser.setStructureFilename(null);
}
}
}
- /*
- boolean doShading = avm.getBoolean(Arg.TEMPFAC_SHADING);
- if (doShading)
+ if (wrap)
{
+
AlignFrame af = afMap.get(id);
- for (AlignmentAnnotation aa : af.alignPanel.getAlignment()
- .findAnnotation(PDBChain.class.getName().toString()))
+ if (af != null)
{
- AnnotationColourGradient acg = new AnnotationColourGradient(aa,
- af.alignPanel.av.getGlobalColourScheme(), 0);
- acg.setSeqAssociated(true);
- af.changeColour(acg);
- Console.info("Changed colour " + acg.toString());
+ af.setWrapFormat(wrap, true);
}
}
+
+ /*
+ boolean doShading = avm.getBoolean(Arg.TEMPFAC_SHADING);
+ if (doShading)
+ {
+ AlignFrame af = afMap.get(id);
+ for (AlignmentAnnotation aa : af.alignPanel.getAlignment()
+ .findAnnotation(PDBChain.class.getName().toString()))
+ {
+ AnnotationColourGradient acg = new AnnotationColourGradient(aa,
+ af.alignPanel.av.getGlobalColourScheme(), 0);
+ acg.setSeqAssociated(true);
+ af.changeColour(acg);
+ Console.info("Changed colour " + acg.toString());
+ }
+ }
*/
- return theseArgsWereParsed;
+ return theseArgsWereParsed && !isError;
+ }
+
+ protected void processGroovyScript(String id)
+ {
+ ArgValuesMap avm = argParser.getLinkedArgs(id);
+ AlignFrame af = afMap.get(id);
+
+ if (avm != null && !avm.containsArg(Arg.GROOVY))
+ {
+ // nothing to do
+ return;
+ }
+
+ if (af == null)
+ {
+ addWarn("Groovy script does not have an alignment window. Proceeding with caution!");
+ }
+
+ if (avm.containsArg(Arg.GROOVY))
+ {
+ for (ArgValue groovyAv : avm.getArgValueList(Arg.GROOVY))
+ {
+ String groovyscript = groovyAv.getValue();
+ if (groovyscript != null)
+ {
+ // Execute the groovy script after we've done all the rendering stuff
+ // and before any images or figures are generated.
+ Console.info("Executing script " + groovyscript);
+ Jalview.getInstance().executeGroovyScript(groovyscript, af);
+ }
+ }
+ }
}
protected boolean processImages(String id)
{
- ArgValuesMap avm = argParser.linkedArgs(id);
+ ArgValuesMap avm = argParser.getLinkedArgs(id);
AlignFrame af = afMap.get(id);
+ if (avm != null && !avm.containsArg(Arg.IMAGE))
+ {
+ // nothing to do
+ return true;
+ }
+
if (af == null)
{
- Console.warn("Did not have an alignment window for id=" + id);
+ addWarn("Do not have an alignment window to create image from (id="
+ + id + "). Not proceeding.");
return false;
}
+ Boolean isError = Boolean.valueOf(false);
if (avm.containsArg(Arg.IMAGE))
{
- for (ArgValue av : avm.getArgValueList(Arg.IMAGE))
+ for (ArgValue imageAv : avm.getArgValueList(Arg.IMAGE))
{
- String val = av.getValue();
- SubVals subVal = av.getSubVals();
- String type = "png"; // default
- String fileName = subVal.getContent();
+ String val = imageAv.getValue();
+ SubVals imageSubVals = imageAv.getSubVals();
+ String fileName = imageSubVals.getContent();
File file = new File(fileName);
- if (subVal.has("type"))
- {
- type = subVal.get("type");
- }
- else if (fileName != null)
+ String name = af.getName();
+ String renderer = avm.getValueFromSubValOrArg(imageAv,
+ Arg.TEXTRENDERER, imageSubVals);
+ if (renderer == null)
+ renderer = "text";
+ String type = "png"; // default
+
+ String scale = avm.getValueFromSubValOrArg(imageAv, Arg.SCALE,
+ imageSubVals);
+ String width = avm.getValueFromSubValOrArg(imageAv, Arg.WIDTH,
+ imageSubVals);
+ String height = avm.getValueFromSubValOrArg(imageAv, Arg.HEIGHT,
+ imageSubVals);
+ BitmapImageSizing userBis = ImageMaker
+ .parseScaleWidthHeightStrings(scale, width, height);
+
+ type = avm.getValueFromSubValOrArg(imageAv, Arg.TYPE, imageSubVals);
+ if (type == null && fileName != null)
{
- for (String ext : new String[] { "svg", "png", "html" })
+ for (String ext : new String[] { "svg", "png", "html", "eps" })
{
if (fileName.toLowerCase(Locale.ROOT).endsWith("." + ext))
{
@@ -602,98 +988,379 @@ public class Commands
Cache.setPropsAreReadOnly(true);
Cache.setProperty("EXPORT_EMBBED_BIOJSON", "false");
- switch (type)
+ String imageColour = avm.getValueFromSubValOrArg(imageAv,
+ Arg.IMAGECOLOUR, imageSubVals);
+ ColourSchemeI originalColourScheme = this.getColourScheme(af);
+ this.colourAlignFrame(af, imageColour);
+
+ Console.info("Writing " + file);
+
+ boolean success = checksBeforeWritingToFile(avm, imageSubVals,
+ false, fileName, "image", isError);
+ if (!success)
{
- case "svg":
- Console.debug("Outputting type '" + type + "' to " + fileName);
- af.createSVG(file);
- break;
- case "png":
- Console.debug("Outputting type '" + type + "' to " + fileName);
- af.createPNG(file);
- break;
- case "html":
- Console.debug("Outputting type '" + type + "' to " + fileName);
- HtmlSvgOutput htmlSVG = new HtmlSvgOutput(af.alignPanel);
- htmlSVG.exportHTML(fileName);
- break;
- default:
- Console.warn(Arg.IMAGE.argString() + " type '" + type
- + "' not known. Ignoring");
- break;
+ continue;
}
+
+ try
+ {
+ switch (type)
+ {
+
+ case "svg":
+ Console.debug("Outputting type '" + type + "' to " + fileName);
+ af.createSVG(file, renderer);
+ break;
+
+ case "png":
+ Console.debug("Outputting type '" + type + "' to " + fileName);
+ af.createPNG(file, null, userBis);
+ break;
+
+ case "html":
+ Console.debug("Outputting type '" + type + "' to " + fileName);
+ HtmlSvgOutput htmlSVG = new HtmlSvgOutput(af.alignPanel);
+ htmlSVG.exportHTML(fileName, renderer);
+ break;
+
+ case "biojs":
+ Console.debug(
+ "Outputting BioJS MSA Viwer HTML file: " + fileName);
+ try
+ {
+ BioJsHTMLOutput.refreshVersionInfo(
+ BioJsHTMLOutput.BJS_TEMPLATES_LOCAL_DIRECTORY);
+ } catch (URISyntaxException e)
+ {
+ e.printStackTrace();
+ }
+ BioJsHTMLOutput bjs = new BioJsHTMLOutput(af.alignPanel);
+ bjs.exportHTML(fileName);
+ break;
+
+ case "eps":
+ Console.debug("Outputting EPS file: " + fileName);
+ af.createEPS(file, renderer);
+ break;
+
+ case "imagemap":
+ Console.debug("Outputting ImageMap file: " + fileName);
+ af.createImageMap(file, name);
+ break;
+
+ default:
+ addWarn(Arg.IMAGE.argString() + " type '" + type
+ + "' not known. Ignoring");
+ break;
+ }
+ } catch (Exception ioex)
+ {
+ addError("Unexpected error during export to '" + fileName + "'",
+ ioex);
+ isError = true;
+ }
+
+ this.colourAlignFrame(af, originalColourScheme);
}
}
- return true;
+ return !isError;
}
- private SequenceI getSpecifiedSequence(AlignFrame af, SubVals subId)
+ protected boolean processOutput(String id)
{
- if (subId == null)
- return null;
- AlignmentI al = af.getCurrentView().getAlignment();
- if (subId.has("seqid"))
+ ArgValuesMap avm = argParser.getLinkedArgs(id);
+ AlignFrame af = afMap.get(id);
+
+ if (avm != null && !avm.containsArg(Arg.OUTPUT))
{
- return al.findName(subId.get("seqid"));
+ // nothing to do
+ return true;
}
- else if (-1 < subId.getIndex()
- && subId.getIndex() < al.getSequences().size())
+
+ if (af == null)
{
- return al.getSequenceAt(subId.getIndex());
+ addWarn("Do not have an alignment window (id=" + id
+ + "). Not proceeding.");
+ return false;
}
- return null;
- }
- // returns the first Arg value intended for the structure structFilename
- // (in the given AlignFrame from the ArgValuesMap)
- private ArgValue getArgAssociatedWithStructure(Arg arg, ArgValuesMap avm,
- AlignFrame af, String structFilename)
- {
- if (af != null)
+ Boolean isError = Boolean.valueOf(false);
+
+ if (avm.containsArg(Arg.OUTPUT))
{
- for (ArgValue av : avm.getArgValueList(arg))
+ for (ArgValue av : avm.getArgValueList(Arg.OUTPUT))
{
+ String val = av.getValue();
SubVals subVals = av.getSubVals();
- String structid = subVals.get("structid");
- String structfile = subVals.get("structfile");
+ String fileName = subVals.getContent();
+ boolean stdout = ArgParser.STDOUTFILENAME.equals(fileName);
+ File file = new File(fileName);
- // let's find a structure
- if (structfile == null && structid == null)
+ String name = af.getName();
+ String format = avm.getValueFromSubValOrArg(av, Arg.FORMAT,
+ subVals);
+ FileFormats ffs = FileFormats.getInstance();
+ List validFormats = ffs.getWritableFormats(false);
+
+ FileFormatI ff = null;
+ if (format == null && fileName != null)
{
- ArgValue likelyStructure = avm.getClosestPreviousArgValueOfArg(av,
- Arg.STRUCTURE);
- if (likelyStructure != null)
+ FORMAT: for (String fname : validFormats)
{
- SubVals sv = likelyStructure.getSubVals();
- if (sv != null && sv.has(ArgValues.ID))
+ FileFormatI tff = ffs.forName(fname);
+ String[] extensions = tff.getExtensions().split(",");
+ for (String ext : extensions)
{
- structid = sv.get(ArgValues.ID);
+ if (fileName.toLowerCase(Locale.ROOT).endsWith("." + ext))
+ {
+ ff = tff;
+ format = ff.getName();
+ break FORMAT;
+ }
}
- else
+ }
+ }
+ if (ff == null && format != null)
+ {
+ ff = ffs.forName(format);
+ }
+ if (ff == null)
+ {
+ if (stdout)
+ {
+ ff = FileFormat.Fasta;
+ }
+ else
+ {
+ StringBuilder validSB = new StringBuilder();
+ for (String f : validFormats)
{
- structfile = likelyStructure.getValue();
- Console.debug(
- "##### Comparing closest previous structure argument '"
- + structfile + "'");
+ if (validSB.length() > 0)
+ validSB.append(", ");
+ validSB.append(f);
+ FileFormatI tff = ffs.forName(f);
+ validSB.append(" (");
+ validSB.append(tff.getExtensions());
+ validSB.append(")");
}
+
+ addError("No valid format specified for "
+ + Arg.OUTPUT.argString() + ". Valid formats are "
+ + validSB.toString() + ".");
+ continue;
}
}
- if (structfile == null && structid != null)
+ boolean success = checksBeforeWritingToFile(avm, subVals, true,
+ fileName, ff.getName(), isError);
+ if (!success)
{
- StructureSelectionManager ssm = StructureSelectionManager
- .getStructureSelectionManager(Desktop.instance);
- if (ssm != null)
- {
- structfile = ssm.findFileForPDBId(structid);
- }
+ continue;
+ }
+
+ boolean backups = avm.getFromSubValArgOrPref(Arg.BACKUPS, subVals,
+ null, Platform.isHeadless() ? null : BackupFiles.ENABLED,
+ !Platform.isHeadless());
+
+ Console.info("Writing " + fileName);
+
+ af.saveAlignment(fileName, ff, stdout, backups);
+ if (af.isSaveAlignmentSuccessful())
+ {
+ Console.debug("Written alignment '" + name + "' in "
+ + ff.getName() + " format to '" + file + "'");
}
- if (structfile != null && structfile.equals(structFilename))
+ else
{
- return av;
+ addError("Error writing file '" + file + "' in " + ff.getName()
+ + " format!");
+ isError = true;
+ continue;
}
+
}
}
- return null;
+ return !isError;
+ }
+
+ private SequenceI getSpecifiedSequence(AlignFrame af, ArgValuesMap avm,
+ ArgValue av)
+ {
+ SubVals subVals = av.getSubVals();
+ ArgValue idAv = avm.getClosestNextArgValueOfArg(av, Arg.SEQID, true);
+ SequenceI seq = null;
+ if (subVals == null && idAv == null)
+ return null;
+ if (af == null || af.getCurrentView() == null)
+ {
+ return null;
+ }
+ AlignmentI al = af.getCurrentView().getAlignment();
+ if (al == null)
+ {
+ return null;
+ }
+ if (subVals != null)
+ {
+ if (subVals.has(Arg.SEQID.getName()))
+ {
+ seq = al.findName(subVals.get(Arg.SEQID.getName()));
+ }
+ else if (-1 < subVals.getIndex()
+ && subVals.getIndex() < al.getSequences().size())
+ {
+ seq = al.getSequenceAt(subVals.getIndex());
+ }
+ }
+ if (seq == null && idAv != null)
+ {
+ seq = al.findName(idAv.getValue());
+ }
+ return seq;
+ }
+
+ public AlignFrame[] getAlignFrames()
+ {
+ AlignFrame[] afs = null;
+ if (afMap != null)
+ {
+ afs = (AlignFrame[]) afMap.values().toArray();
+ }
+
+ return afs;
+ }
+
+ public List getStructureViewers()
+ {
+ List svs = null;
+ if (svMap != null)
+ {
+ for (List svList : svMap.values())
+ {
+ if (svs == null)
+ {
+ svs = new ArrayList<>();
+ }
+ svs.addAll(svList);
+ }
+ }
+ return svs;
+ }
+
+ private void colourAlignFrame(AlignFrame af, String colour)
+ {
+ // use string "none" to remove colour scheme
+ if (colour != null && "" != colour)
+ {
+ ColourSchemeI cs = ColourSchemeProperty.getColourScheme(
+ af.getViewport(), af.getViewport().getAlignment(), colour);
+ if (cs == null && !StringUtils.equalsIgnoreCase(colour, "none"))
+ {
+ addWarn("Couldn't parse '" + colour + "' as a colourscheme.");
+ }
+ else
+ {
+ Jalview.testoutput(argParser, Arg.COLOUR, "zappo", colour);
+ colourAlignFrame(af, cs);
+ }
+ }
+ }
+
+ private void colourAlignFrame(AlignFrame af, ColourSchemeI cs)
+ {
+ // Note that cs == null removes colour scheme from af
+ af.changeColour(cs);
+ }
+
+ private ColourSchemeI getColourScheme(AlignFrame af)
+ {
+ return af.getViewport().getGlobalColourScheme();
+ }
+
+ private void addInfo(String errorMessage)
+ {
+ Console.info(errorMessage);
+ errors.add(errorMessage);
+ }
+
+ private void addWarn(String errorMessage)
+ {
+ Console.warn(errorMessage);
+ errors.add(errorMessage);
+ }
+
+ private void addError(String errorMessage)
+ {
+ addError(errorMessage, null);
+ }
+
+ private void addError(String errorMessage, Exception e)
+ {
+ Console.error(errorMessage, e);
+ errors.add(errorMessage);
+ }
+
+ private boolean checksBeforeWritingToFile(ArgValuesMap avm,
+ SubVals subVal, boolean includeBackups, String filename,
+ String adjective, Boolean isError)
+ {
+ File file = new File(filename);
+
+ boolean overwrite = avm.getFromSubValArgOrPref(Arg.OVERWRITE, subVal,
+ null, "OVERWRITE_OUTPUT", false);
+ boolean stdout = false;
+ boolean backups = false;
+ if (includeBackups)
+ {
+ stdout = ArgParser.STDOUTFILENAME.equals(filename);
+ // backups. Use the Arg.BACKUPS or subval "backups" setting first,
+ // otherwise if headless assume false, if not headless use the user
+ // preference with default true.
+ backups = avm.getFromSubValArgOrPref(Arg.BACKUPS, subVal, null,
+ Platform.isHeadless() ? null : BackupFiles.ENABLED,
+ !Platform.isHeadless());
+ }
+
+ if (file.exists() && !(overwrite || backups || stdout))
+ {
+ addWarn("Won't overwrite file '" + filename + "' without "
+ + Arg.OVERWRITE.argString()
+ + (includeBackups ? " or " + Arg.BACKUPS.argString() : "")
+ + " set");
+ return false;
+ }
+
+ boolean mkdirs = avm.getFromSubValArgOrPref(Arg.MKDIRS, subVal, null,
+ "MKDIRS_OUTPUT", false);
+
+ if (!FileUtils.checkParentDir(file, mkdirs))
+ {
+ addError("Directory '"
+ + FileUtils.getParentDir(file).getAbsolutePath()
+ + "' does not exist for " + adjective + " file '" + filename
+ + "'."
+ + (mkdirs ? "" : " Try using " + Arg.MKDIRS.argString()));
+ isError = true;
+ return false;
+ }
+
+ return true;
+ }
+
+ public List getErrors()
+ {
+ return errors;
+ }
+
+ public String errorsToString()
+ {
+ StringBuilder sb = new StringBuilder();
+ for (String error : errors)
+ {
+ if (sb.length() > 0)
+ sb.append("\n");
+ sb.append("- " + error);
+ }
+ return sb.toString();
}
}