X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fext%2Frbvi%2Fchimera%2FJalviewChimeraBinding.java;h=399bad9d9c9d7cd0982644529885594e7bedea43;hb=b7cd96eaeb85474ee2ddec1de92181a3b88ceece;hp=3ae75939efa4001fc88f86caaec45adef1d50aac;hpb=d1707d4c26db76cfeb640f0dbeb3e3427fd40eb7;p=jalview.git diff --git a/src/jalview/ext/rbvi/chimera/JalviewChimeraBinding.java b/src/jalview/ext/rbvi/chimera/JalviewChimeraBinding.java index 3ae7593..399bad9 100644 --- a/src/jalview/ext/rbvi/chimera/JalviewChimeraBinding.java +++ b/src/jalview/ext/rbvi/chimera/JalviewChimeraBinding.java @@ -20,37 +20,13 @@ */ package jalview.ext.rbvi.chimera; -import jalview.api.AlignmentViewPanel; -import jalview.api.SequenceRenderer; -import jalview.api.structures.JalviewStructureDisplayI; -import jalview.bin.Cache; -import jalview.datamodel.AlignmentI; -import jalview.datamodel.HiddenColumns; -import jalview.datamodel.PDBEntry; -import jalview.datamodel.SearchResultMatchI; -import jalview.datamodel.SearchResultsI; -import jalview.datamodel.SequenceFeature; -import jalview.datamodel.SequenceI; -import jalview.httpserver.AbstractRequestHandler; -import jalview.io.DataSourceType; -import jalview.schemes.ColourSchemeI; -import jalview.schemes.ResidueProperties; -import jalview.structure.AtomSpec; -import jalview.structure.StructureMappingcommandSet; -import jalview.structure.StructureSelectionManager; -import jalview.structures.models.AAStructureBindingModel; -import jalview.util.MessageManager; - -import java.awt.Color; import java.io.File; import java.io.FileOutputStream; import java.io.IOException; import java.io.PrintWriter; import java.net.BindException; import java.util.ArrayList; -import java.util.BitSet; import java.util.Collections; -import java.util.Hashtable; import java.util.LinkedHashMap; import java.util.List; import java.util.Map; @@ -59,31 +35,33 @@ import ext.edu.ucsf.rbvi.strucviz2.ChimeraManager; import ext.edu.ucsf.rbvi.strucviz2.ChimeraModel; import ext.edu.ucsf.rbvi.strucviz2.StructureManager; import ext.edu.ucsf.rbvi.strucviz2.StructureManager.ModelType; +import jalview.api.AlignmentViewPanel; +import jalview.bin.Console; +import jalview.datamodel.PDBEntry; +import jalview.datamodel.SearchResultMatchI; +import jalview.datamodel.SearchResultsI; +import jalview.datamodel.SequenceFeature; +import jalview.datamodel.SequenceI; +import jalview.gui.StructureViewer.ViewerType; +import jalview.httpserver.AbstractRequestHandler; +import jalview.io.DataSourceType; +import jalview.structure.AtomSpec; +import jalview.structure.AtomSpecModel; +import jalview.structure.StructureCommand; +import jalview.structure.StructureCommandI; +import jalview.structure.StructureSelectionManager; +import jalview.structures.models.AAStructureBindingModel; public abstract class JalviewChimeraBinding extends AAStructureBindingModel { - public static final String CHIMERA_FEATURE_GROUP = "Chimera"; - - // Chimera clause to exclude alternate locations in atom selection - private static final String NO_ALTLOCS = "&~@.B-Z&~@.2-9"; - - private static final String COLOURING_CHIMERA = MessageManager - .getString("status.colouring_chimera"); - - private static final boolean debug = false; + public static final String CHIMERA_SESSION_EXTENSION = ".py"; - private static final String PHOSPHORUS = "P"; - - private static final String ALPHACARBON = "CA"; - - private List chainNames = new ArrayList(); + public static final String CHIMERA_FEATURE_GROUP = "Chimera"; - private Hashtable chainFile = new Hashtable(); - /* * Object through which we talk to Chimera */ - private ChimeraManager viewer; + private ChimeraManager chimeraManager; /* * Object which listens to Chimera notifications @@ -91,39 +69,27 @@ public abstract class JalviewChimeraBinding extends AAStructureBindingModel private AbstractRequestHandler chimeraListener; /* - * set if chimera state is being restored from some source - instructs binding - * not to apply default display style when structure set is updated for first - * time. - */ - private boolean loadingFromArchive = false; - - /* - * flag to indicate if the Chimera viewer should ignore sequence colouring - * events from the structure manager because the GUI is still setting up - */ - private boolean loadingFinished = true; - - /* * Map of ChimeraModel objects keyed by PDB full local file name */ - private Map> chimeraMaps = new LinkedHashMap>(); + protected Map> chimeraMaps = new LinkedHashMap<>(); String lastHighlightCommand; - /* - * incremented every time a load notification is successfully handled - - * lightweight mechanism for other threads to detect when they can start - * referring to new structures. + /** + * Returns a model of the structure positions described by the Chimera format atomspec + * @param atomSpec + * @return */ - private long loadNotifiesHandled = 0; - - private Thread chimeraMonitor; + protected AtomSpec parseAtomSpec(String atomSpec) + { + return AtomSpec.fromChimeraAtomspec(atomSpec); + } /** * Open a PDB structure file in Chimera and set up mappings from Jalview. * - * We check if the PDB model id is already loaded in Chimera, if so don't - * reopen it. This is the case if Chimera has opened a saved session file. + * We check if the PDB model id is already loaded in Chimera, if so don't reopen + * it. This is the case if Chimera has opened a saved session file. * * @param pe * @return @@ -133,8 +99,8 @@ public abstract class JalviewChimeraBinding extends AAStructureBindingModel String file = pe.getFile(); try { - List modelsToMap = new ArrayList(); - List oldList = viewer.getModelList(); + List modelsToMap = new ArrayList<>(); + List oldList = chimeraManager.getModelList(); boolean alreadyOpen = false; /* @@ -155,16 +121,8 @@ public abstract class JalviewChimeraBinding extends AAStructureBindingModel */ if (!alreadyOpen) { - viewer.openModel(file, pe.getId(), ModelType.PDB_MODEL); - List newList = viewer.getModelList(); - // JAL-1728 newList.removeAll(oldList) does not work - for (ChimeraModel cm : newList) - { - if (cm.getModelName().equals(pe.getId())) - { - modelsToMap.add(cm); - } - } + chimeraManager.openModel(file, pe.getId(), ModelType.PDB_MODEL); + addChimeraModel(pe, modelsToMap); } chimeraMaps.put(file, modelsToMap); @@ -172,8 +130,6 @@ public abstract class JalviewChimeraBinding extends AAStructureBindingModel if (getSsm() != null) { getSsm().addStructureViewerListener(this); - // ssm.addSelectionListener(this); - refreshGUI(); } return true; } catch (Exception q) @@ -186,6 +142,31 @@ public abstract class JalviewChimeraBinding extends AAStructureBindingModel } /** + * Adds the ChimeraModel corresponding to the given PDBEntry, based on model + * name matching PDB id + * + * @param pe + * @param modelsToMap + */ + protected void addChimeraModel(PDBEntry pe, + List modelsToMap) + { + /* + * Chimera: query for actual models and find the one with + * matching model name - already set in viewer.openModel() + */ + List newList = chimeraManager.getModelList(); + // JAL-1728 newList.removeAll(oldList) does not work + for (ChimeraModel cm : newList) + { + if (cm.getModelName().equals(pe.getId())) + { + modelsToMap.add(cm); + } + } + } + + /** * Constructor * * @param ssm @@ -194,363 +175,64 @@ public abstract class JalviewChimeraBinding extends AAStructureBindingModel * @param protocol */ public JalviewChimeraBinding(StructureSelectionManager ssm, - PDBEntry[] pdbentry, SequenceI[][] sequenceIs, DataSourceType protocol) + PDBEntry[] pdbentry, SequenceI[][] sequenceIs, + DataSourceType protocol) { super(ssm, pdbentry, sequenceIs, protocol); - viewer = new ChimeraManager(new StructureManager(true)); + boolean chimeraX = ViewerType.CHIMERAX.equals(getViewerType()); + chimeraManager = chimeraX ? new ChimeraXManager(new StructureManager(true)) : new ChimeraManager(new StructureManager(true)); + setStructureCommands(chimeraX ? new ChimeraXCommands() : new ChimeraCommands()); } - /** - * Starts a thread that waits for the Chimera process to finish, so that we - * can then close the associated resources. This avoids leaving orphaned - * Chimera viewer panels in Jalview if the user closes Chimera. - */ - protected void startChimeraProcessMonitor() + @Override + protected ViewerType getViewerType() { - final Process p = viewer.getChimeraProcess(); - chimeraMonitor = new Thread(new Runnable() - { - - @Override - public void run() - { - try - { - p.waitFor(); - JalviewStructureDisplayI display = getViewer(); - if (display != null) - { - display.closeViewer(false); - } - } catch (InterruptedException e) - { - // exit thread if Chimera Viewer is closed in Jalview - } - } - }); - chimeraMonitor.start(); + return ViewerType.CHIMERA; } /** - * Start a dedicated HttpServer to listen for Chimera notifications, and tell - * it to start listening + * Start a dedicated HttpServer to listen for Chimera notifications, and tell it + * to start listening */ public void startChimeraListener() { try { chimeraListener = new ChimeraListener(this); - viewer.startListening(chimeraListener.getUri()); + startListening(chimeraListener.getUri()); } catch (BindException e) { - System.err.println("Failed to start Chimera listener: " - + e.getMessage()); + System.err.println( + "Failed to start Chimera listener: " + e.getMessage()); } } /** - * Tells Chimera to display only the specified chains - * - * @param toshow - */ - public void showChains(List toshow) - { - /* - * Construct a chimera command like - * - * ~display #*;~ribbon #*;ribbon :.A,:.B - */ - StringBuilder cmd = new StringBuilder(64); - boolean first = true; - for (String chain : toshow) - { - int modelNumber = getModelNoForChain(chain); - String showChainCmd = modelNumber == -1 ? "" : modelNumber + ":." - + chain.split(":")[1]; - if (!first) - { - cmd.append(","); - } - cmd.append(showChainCmd); - first = false; - } - - /* - * could append ";focus" to this command to resize the display to fill the - * window, but it looks more helpful not to (easier to relate chains to the - * whole) - */ - final String command = "~display #*; ~ribbon #*; ribbon :" - + cmd.toString(); - sendChimeraCommand(command, false); - } - - /** * Close down the Jalview viewer and listener, and (optionally) the associated * Chimera window. */ + @Override public void closeViewer(boolean closeChimera) { - getSsm().removeStructureViewerListener(this, this.getPdbFile()); - if (closeChimera) - { - viewer.exitChimera(); - } + super.closeViewer(closeChimera); if (this.chimeraListener != null) { chimeraListener.shutdown(); chimeraListener = null; } - viewer = null; - - if (chimeraMonitor != null) - { - chimeraMonitor.interrupt(); - } - releaseUIResources(); - } - - @Override - public void colourByChain() - { - colourBySequence = false; - sendAsynchronousCommand("rainbow chain", COLOURING_CHIMERA); - } - - /** - * Constructs and sends a Chimera command to colour by charge - *
    - *
  • Aspartic acid and Glutamic acid (negative charge) red
    • - *
  • Lysine and Arginine (positive charge) blue
    • - *
  • Cysteine - yellow
    • - *
  • all others - white
    • - *
- */ - @Override - public void colourByCharge() - { - colourBySequence = false; - String command = "color white;color red ::ASP;color red ::GLU;color blue ::LYS;color blue ::ARG;color yellow ::CYS"; - sendAsynchronousCommand(command, COLOURING_CHIMERA); - } - - /** - * {@inheritDoc} - */ - @Override - public String superposeStructures(AlignmentI[] _alignment, - int[] _refStructure, HiddenColumns[] _hiddenCols) - { - StringBuilder allComs = new StringBuilder(128); - String[] files = getPdbFile(); - - if (!waitForFileLoad(files)) - { - return null; - } - - refreshPdbEntries(); - StringBuilder selectioncom = new StringBuilder(256); - for (int a = 0; a < _alignment.length; a++) + + /* + * the following call is added to avoid a stack trace error in Chimera + * after "stop really" is sent; Chimera > 1.14 will not need it; see also + * http://plato.cgl.ucsf.edu/trac/chimera/ticket/17597 + */ + if (closeChimera && (getViewerType() == ViewerType.CHIMERA)) { - int refStructure = _refStructure[a]; - AlignmentI alignment = _alignment[a]; - HiddenColumns hiddenCols = _hiddenCols[a]; - - if (refStructure >= files.length) - { - System.err.println("Ignoring invalid reference structure value " - + refStructure); - refStructure = -1; - } - - /* - * 'matched' bit i will be set for visible alignment columns i where - * all sequences have a residue with a mapping to the PDB structure - */ - BitSet matched = new BitSet(); - for (int m = 0; m < alignment.getWidth(); m++) - { - if (hiddenCols == null || hiddenCols.isVisible(m)) - { - matched.set(m); - } - } - - SuperposeData[] structures = new SuperposeData[files.length]; - for (int f = 0; f < files.length; f++) - { - structures[f] = new SuperposeData(alignment.getWidth()); - } - - /* - * Calculate the superposable alignment columns ('matched'), and the - * corresponding structure residue positions (structures.pdbResNo) - */ - int candidateRefStructure = findSuperposableResidues(alignment, - matched, structures); - if (refStructure < 0) - { - /* - * If no reference structure was specified, pick the first one that has - * a mapping in the alignment - */ - refStructure = candidateRefStructure; - } - - int nmatched = matched.cardinality(); - if (nmatched < 4) - { - return MessageManager.formatMessage("label.insufficient_residues", - nmatched); - } - - /* - * Generate select statements to select regions to superimpose structures - */ - String[] selcom = new String[files.length]; - for (int pdbfnum = 0; pdbfnum < files.length; pdbfnum++) - { - String chainCd = "." + structures[pdbfnum].chain; - int lpos = -1; - boolean run = false; - StringBuilder molsel = new StringBuilder(); - - int nextColumnMatch = matched.nextSetBit(0); - while (nextColumnMatch != -1) - { - int pdbResNum = structures[pdbfnum].pdbResNo[nextColumnMatch]; - if (lpos != pdbResNum - 1) - { - /* - * discontiguous - append last residue now - */ - if (lpos != -1) - { - molsel.append(String.valueOf(lpos)); - molsel.append(chainCd); - molsel.append(","); - } - run = false; - } - else - { - /* - * extending a contiguous run - */ - if (!run) - { - /* - * start the range selection - */ - molsel.append(String.valueOf(lpos)); - molsel.append("-"); - } - run = true; - } - lpos = pdbResNum; - nextColumnMatch = matched.nextSetBit(nextColumnMatch + 1); - } - - /* - * and terminate final selection - */ - if (lpos != -1) - { - molsel.append(String.valueOf(lpos)); - molsel.append(chainCd); - } - if (molsel.length() > 1) - { - selcom[pdbfnum] = molsel.toString(); - selectioncom.append("#").append(String.valueOf(pdbfnum)) - .append(":"); - selectioncom.append(selcom[pdbfnum]); - selectioncom.append(" "); - if (pdbfnum < files.length - 1) - { - selectioncom.append("| "); - } - } - else - { - selcom[pdbfnum] = null; - } - } - - StringBuilder command = new StringBuilder(256); - for (int pdbfnum = 0; pdbfnum < files.length; pdbfnum++) - { - if (pdbfnum == refStructure || selcom[pdbfnum] == null - || selcom[refStructure] == null) - { - continue; - } - if (command.length() > 0) - { - command.append(";"); - } - - /* - * Form Chimera match command, from the 'new' structure to the - * 'reference' structure e.g. (50 residues, chain B/A, alphacarbons): - * - * match #1:1-30.B,81-100.B@CA #0:21-40.A,61-90.A@CA - * - * @see - * https://www.cgl.ucsf.edu/chimera/docs/UsersGuide/midas/match.html - */ - command.append("match ").append(getModelSpec(pdbfnum)).append(":"); - command.append(selcom[pdbfnum]); - command.append("@").append( - structures[pdbfnum].isRna ? PHOSPHORUS : ALPHACARBON); - // JAL-1757 exclude alternate CA locations - command.append(NO_ALTLOCS); - command.append(" ").append(getModelSpec(refStructure)).append(":"); - command.append(selcom[refStructure]); - command.append("@").append( - structures[refStructure].isRna ? PHOSPHORUS : ALPHACARBON); - command.append(NO_ALTLOCS); - } - if (selectioncom.length() > 0) - { - if (debug) - { - System.out.println("Select regions:\n" + selectioncom.toString()); - System.out.println("Superimpose command(s):\n" - + command.toString()); - } - allComs.append("~display all; chain @CA|P; ribbon ") - .append(selectioncom.toString()) - .append(";" + command.toString()); - } + chimeraManager.getChimeraProcess().destroy(); } - String error = null; - if (selectioncom.length() > 0) - { - // TODO: visually distinguish regions that were superposed - if (selectioncom.substring(selectioncom.length() - 1).equals("|")) - { - selectioncom.setLength(selectioncom.length() - 1); - } - if (debug) - { - System.out.println("Select regions:\n" + selectioncom.toString()); - } - allComs.append("; ~display all; chain @CA|P; ribbon ") - .append(selectioncom.toString()).append("; focus"); - List chimeraReplies = sendChimeraCommand(allComs.toString(), - true); - for (String reply : chimeraReplies) - { - if (reply.toLowerCase().contains("unequal numbers of atoms")) - { - error = reply; - } - } - } - return error; + chimeraManager.clearOnChimeraExit(); + chimeraManager = null; } /** @@ -570,7 +252,7 @@ public abstract class JalviewChimeraBinding extends AAStructureBindingModel { if (pdbfnum < 0 || pdbfnum >= getPdbCount()) { - return ""; + return "#" + pdbfnum; // temp hack for ChimeraX } /* @@ -579,7 +261,7 @@ public abstract class JalviewChimeraBinding extends AAStructureBindingModel * to the Chimera command 'list models type molecule', see * ChimeraManager.getModelList(). */ - List maps = chimeraMaps.get(getPdbFile()[pdbfnum]); + List maps = chimeraMaps.get(getStructureFiles()[pdbfnum]); boolean hasSubModels = maps != null && maps.size() > 1; return "#" + String.valueOf(pdbfnum) + (hasSubModels ? ".1" : ""); } @@ -593,16 +275,15 @@ public abstract class JalviewChimeraBinding extends AAStructureBindingModel */ public boolean launchChimera() { - if (viewer.isChimeraLaunched()) + if (chimeraManager.isChimeraLaunched()) { return true; } - boolean launched = viewer.launchChimera(StructureManager - .getChimeraPaths()); + boolean launched = chimeraManager.launchChimera(getChimeraPaths()); if (launched) { - startChimeraProcessMonitor(); + startExternalViewerMonitor(chimeraManager.getChimeraProcess()); } else { @@ -612,156 +293,81 @@ public abstract class JalviewChimeraBinding extends AAStructureBindingModel } /** + * Returns a list of candidate paths to the Chimera program executable + * + * @return + */ + protected List getChimeraPaths() + { + return StructureManager.getChimeraPaths(false); + } + + /** * Answers true if the Chimera process is still running, false if ended or not * started. * * @return */ - public boolean isChimeraRunning() + @Override + public boolean isViewerRunning() { - return viewer.isChimeraLaunched(); + return chimeraManager!=null && chimeraManager.isChimeraLaunched(); } /** * Send a command to Chimera, and optionally log and return any responses. - *

- * Does nothing, and returns null, if the command is the same as the last one - * sent [why?]. * * @param command * @param getResponse */ - public List sendChimeraCommand(final String command, + @Override + public List executeCommand(final StructureCommandI command, boolean getResponse) { - if (viewer == null) + if (chimeraManager == null || command == null) { // ? thread running after viewer shut down return null; } List reply = null; - viewerCommandHistory(false); - if (true /*lastCommand == null || !lastCommand.equals(command)*/) + // trim command or it may never find a match in the replyLog!! + String cmd = command.getCommand().trim(); + List lastReply = chimeraManager + .sendChimeraCommand(cmd, getResponse); + if (getResponse) { - // trim command or it may never find a match in the replyLog!! - List lastReply = viewer.sendChimeraCommand(command.trim(), - getResponse); - if (getResponse) - { - reply = lastReply; - if (debug) - { - log("Response from command ('" + command + "') was:\n" - + lastReply); - } + reply = lastReply; + if (Console.isDebugEnabled()) { + Console.debug( + "Response from command ('" + cmd + "') was:\n" + lastReply); } } - viewerCommandHistory(true); - - return reply; - } - - /** - * Send a Chimera command asynchronously in a new thread. If the progress - * message is not null, display this message while the command is executing. - * - * @param command - * @param progressMsg - */ - protected abstract void sendAsynchronousCommand(String command, - String progressMsg); - - /** - * Sends a set of colour commands to the structure viewer - * - * @param colourBySequenceCommands - */ - @Override - protected void colourBySequence( - StructureMappingcommandSet[] colourBySequenceCommands) - { - for (StructureMappingcommandSet cpdbbyseq : colourBySequenceCommands) + else { - for (String command : cpdbbyseq.commands) + if (Console.isDebugEnabled()) { - sendAsynchronousCommand(command, COLOURING_CHIMERA); + Console.debug("Command executed: " + cmd); } } - } - /** - * @param files - * @param sr - * @param viewPanel - * @return - */ - @Override - protected StructureMappingcommandSet[] getColourBySequenceCommands( - String[] files, SequenceRenderer sr, AlignmentViewPanel viewPanel) - { - return ChimeraCommands.getColourBySequenceCommand(getSsm(), files, - getSequence(), sr, viewPanel); - } - - /** - * @param command - */ - protected void executeWhenReady(String command) - { - waitForChimera(); - sendChimeraCommand(command, false); - waitForChimera(); - } - - private void waitForChimera() - { - while (viewer != null && viewer.isBusy()) - { - try - { - Thread.sleep(15); - } catch (InterruptedException q) - { - } - } + return reply; } - // End StructureListener - // ////////////////////////// - - /** - * instruct the Jalview binding to update the pdbentries vector if necessary - * prior to matching the viewer's contents to the list of structure files - * Jalview knows about. - */ - public abstract void refreshPdbEntries(); - - /** - * map between index of model filename returned from getPdbFile and the first - * index of models from this file in the viewer. Note - this is not trimmed - - * use getPdbFile to get number of unique models. - */ - private int _modelFileNameMap[]; - - - // //////////////////////////////// - // /StructureListener @Override - public synchronized String[] getPdbFile() + public synchronized String[] getStructureFiles() { - if (viewer == null) + if (chimeraManager == null) { return new String[0]; } - return chimeraMaps.keySet().toArray( - modelFileNames = new String[chimeraMaps.size()]); + return chimeraMaps.keySet() + .toArray(modelFileNames = new String[chimeraMaps.size()]); } /** - * Construct and send a command to highlight zero, one or more atoms. We do - * this by sending an "rlabel" command to show the residue label at that - * position. + * Construct and send a command to highlight zero, one or more atoms. We do this + * by sending an "rlabel" command to show the residue label at that position. */ @Override public void highlightAtoms(List atoms) @@ -771,6 +377,7 @@ public abstract class JalviewChimeraBinding extends AAStructureBindingModel return; } + boolean forChimeraX = chimeraManager.isChimeraX(); StringBuilder cmd = new StringBuilder(128); boolean first = true; boolean found = false; @@ -785,18 +392,26 @@ public abstract class JalviewChimeraBinding extends AAStructureBindingModel { if (first) { - cmd.append("rlabel #").append(cms.get(0).getModelNumber()) - .append(":"); + cmd.append(forChimeraX ? "label #" : "rlabel #"); } else { cmd.append(","); } first = false; - cmd.append(pdbResNum); - if (!chain.equals(" ")) + if (forChimeraX) { - cmd.append(".").append(chain); + cmd.append(cms.get(0).getModelNumber()) + .append("/").append(chain).append(":").append(pdbResNum); + } + else + { + cmd.append(cms.get(0).getModelNumber()) + .append(":").append(pdbResNum); + if (!chain.equals(" ") && !forChimeraX) + { + cmd.append(".").append(chain); + } } found = true; } @@ -810,19 +425,29 @@ public abstract class JalviewChimeraBinding extends AAStructureBindingModel { return; } - + if (!found) + { + // not a valid residue label command, so clear + cmd.setLength(0); + } /* - * unshow the label for the previous residue + * prepend with command + * to unshow the label for the previous residue */ if (lastHighlightCommand != null) { - viewer.sendChimeraCommand("~" + lastHighlightCommand, false); + cmd.insert(0, ";"); + cmd.insert(0,lastHighlightCommand); + cmd.insert(0,"~"); + } - if (found) - { - viewer.sendChimeraCommand(command, false); + if (cmd.length()>0) { + executeCommand(true, null, new StructureCommand(cmd.toString())); + } + + if (found) { + this.lastHighlightCommand = command; } - this.lastHighlightCommand = command; } /** @@ -833,23 +458,56 @@ public abstract class JalviewChimeraBinding extends AAStructureBindingModel /* * Ask Chimera for its current selection */ - List selection = viewer.getSelectedResidueSpecs(); + StructureCommandI command = getCommandGenerator().getSelectedResidues(); + + Runnable action = new Runnable() + { + @Override + public void run() + { + List chimeraReply = executeCommand(command, true); + + List selectedResidues = new ArrayList<>(); + if (chimeraReply != null) + { + /* + * expect 0, 1 or more lines of the format either + * Chimera: + * residue id #0:43.A type GLY + * ChimeraX: + * residue id /A:89 name THR index 88 + * We are only interested in the atomspec (third token of the reply) + */ + for (String inputLine : chimeraReply) + { + String[] inputLineParts = inputLine.split("\\s+"); + if (inputLineParts.length >= 5) + { + selectedResidues.add(inputLineParts[2]); + } + } + } - /* - * Parse model number, residue and chain for each selected position, - * formatted as #0:123.A or #1.2:87.B (#model.submodel:residue.chain) - */ - List atomSpecs = convertStructureResiduesToAlignment(selection); + /* + * Parse model number, residue and chain for each selected position, + * formatted as #0:123.A or #1.2:87.B (#model.submodel:residue.chain) + */ + List atomSpecs = convertStructureResiduesToAlignment( + selectedResidues); - /* - * Broadcast the selection (which may be empty, if the user just cleared all - * selections) - */ - getSsm().mouseOverStructure(atomSpecs); + /* + * Broadcast the selection (which may be empty, if the user just cleared all + * selections) + */ + getSsm().mouseOverStructure(atomSpecs); + + } + }; + new Thread(action).start(); } /** - * Converts a list of Chimera atomspecs to a list of AtomSpec representing the + * Converts a list of Chimera(X) atomspecs to a list of AtomSpec representing the * corresponding residues (if any) in Jalview * * @param structureSelection @@ -858,18 +516,18 @@ public abstract class JalviewChimeraBinding extends AAStructureBindingModel protected List convertStructureResiduesToAlignment( List structureSelection) { - List atomSpecs = new ArrayList(); + List atomSpecs = new ArrayList<>(); for (String atomSpec : structureSelection) { try { - AtomSpec spec = AtomSpec.fromChimeraAtomspec(atomSpec); + AtomSpec spec = parseAtomSpec(atomSpec); String pdbfilename = getPdbFileForModel(spec.getModelNumber()); spec.setPdbFile(pdbfilename); atomSpecs.add(spec); } catch (IllegalArgumentException e) { - System.err.println("Failed to parse atomspec: " + atomSpec); + Console.error("Failed to parse atomspec: " + atomSpec); } } return atomSpecs; @@ -904,195 +562,13 @@ public abstract class JalviewChimeraBinding extends AAStructureBindingModel System.err.println("## Chimera log: " + message); } - private void viewerCommandHistory(boolean enable) - { - // log("(Not yet implemented) History " - // + ((debug || enable) ? "on" : "off")); - } - - public long getLoadNotifiesHandled() - { - return loadNotifiesHandled; - } - - @Override - public void setJalviewColourScheme(ColourSchemeI cs) - { - colourBySequence = false; - - if (cs == null) - { - return; - } - - // Chimera expects RBG values in the range 0-1 - final double normalise = 255D; - viewerCommandHistory(false); - StringBuilder command = new StringBuilder(128); - - List residueSet = ResidueProperties.getResidues(isNucleotide(), - false); - for (String resName : residueSet) - { - char res = resName.length() == 3 ? ResidueProperties - .getSingleCharacterCode(resName) : resName.charAt(0); - Color col = cs.findColour(res, 0, null, null, 0f); - command.append("color " + col.getRed() / normalise + "," - + col.getGreen() / normalise + "," + col.getBlue() - / normalise + " ::" + resName + ";"); - } - - sendAsynchronousCommand(command.toString(), COLOURING_CHIMERA); - viewerCommandHistory(true); - } - - /** - * called when the binding thinks the UI needs to be refreshed after a Chimera - * state change. this could be because structures were loaded, or because an - * error has occurred. - */ - public abstract void refreshGUI(); - - @Override - public void setLoadingFromArchive(boolean loadingFromArchive) - { - this.loadingFromArchive = loadingFromArchive; - } - - /** - * - * @return true if Chimeral is still restoring state or loading is still going - * on (see setFinsihedLoadingFromArchive) - */ - @Override - public boolean isLoadingFromArchive() - { - return loadingFromArchive && !loadingFinished; - } - - /** - * modify flag which controls if sequence colouring events are honoured by the - * binding. Should be true for normal operation - * - * @param finishedLoading - */ - @Override - public void setFinishedLoadingFromArchive(boolean finishedLoading) - { - loadingFinished = finishedLoading; - } - - /** - * Send the Chimera 'background solid " command. - * - * @see https - * ://www.cgl.ucsf.edu/chimera/current/docs/UsersGuide/midas/background - * .html - * @param col - */ - @Override - public void setBackgroundColour(Color col) - { - viewerCommandHistory(false); - double normalise = 255D; - final String command = "background solid " + col.getRed() / normalise - + "," + col.getGreen() / normalise + "," + col.getBlue() - / normalise + ";"; - viewer.sendChimeraCommand(command, false); - viewerCommandHistory(true); - } - - /** - * Ask Chimera to save its session to the given file. Returns true if - * successful, else false. - * - * @param filepath - * @return - */ - public boolean saveSession(String filepath) - { - if (isChimeraRunning()) - { - List reply = viewer.sendChimeraCommand("save " + filepath, - true); - if (reply.contains("Session written")) - { - return true; - } - else - { - Cache.log - .error("Error saving Chimera session: " + reply.toString()); - } - } - return false; - } - - /** - * Ask Chimera to open a session file. Returns true if successful, else false. - * The filename must have a .py extension for this command to work. - * - * @param filepath - * @return - */ - public boolean openSession(String filepath) - { - sendChimeraCommand("open " + filepath, true); - // todo: test for failure - how? - return true; - } - - /** - * Returns a list of chains mapped in this viewer. Note this list is not - * currently scoped per structure. - * - * @return - */ - @Override - public List getChainNames() - { - return chainNames; - } - - /** - * Send a 'focus' command to Chimera to recentre the visible display - */ - public void focusView() - { - sendChimeraCommand("focus", false); - } - - /** - * Send a 'show' command for all atoms in the currently selected columns - * - * TODO: pull up to abstract structure viewer interface - * - * @param vp - */ - public void highlightSelection(AlignmentViewPanel vp) - { - List cols = vp.getAlignViewport().getColumnSelection() - .getSelected(); - AlignmentI alignment = vp.getAlignment(); - StructureSelectionManager sm = getSsm(); - for (SequenceI seq : alignment.getSequences()) - { - /* - * convert selected columns into sequence positions - */ - int[] positions = new int[cols.size()]; - int i = 0; - for (Integer col : cols) - { - positions[i++] = seq.findPosition(col); - } - sm.highlightStructure(this, seq, positions); - } - } - /** * Constructs and send commands to Chimera to set attributes on residues for - * features visible in Jalview + * features visible in Jalview. + *

+ * The syntax is: setattr r <attName> <attValue> <atomSpec> + *

+ * For example: setattr r jv_chain "Ferredoxin-1, Chloroplastic" #0:94.A * * @param avp * @return @@ -1100,90 +576,61 @@ public abstract class JalviewChimeraBinding extends AAStructureBindingModel public int sendFeaturesToViewer(AlignmentViewPanel avp) { // TODO refactor as required to pull up to an interface - AlignmentI alignment = avp.getAlignment(); - String[] files = getPdbFile(); - if (files == null) - { - return 0; - } - - StructureMappingcommandSet commandSet = ChimeraCommands - .getSetAttributeCommandsForFeatures(getSsm(), files, - getSequence(), avp); - String[] commands = commandSet.commands; - if (commands.length > 10) + Map> featureValues = buildFeaturesMap( + avp); + List commands = getCommandGenerator() + .setAttributes(featureValues); + if (commands.size() > 10) { sendCommandsByFile(commands); } else { - for (String command : commands) - { - sendAsynchronousCommand(command, null); - } + executeCommands(commands, false, null); } - return commands.length; + return commands.size(); } /** - * Write commands to a temporary file, and send a command to Chimera to open - * the file as a commands script. For use when sending a large number of - * separate commands would overload the REST interface mechanism. + * Write commands to a temporary file, and send a command to Chimera to open the + * file as a commands script. For use when sending a large number of separate + * commands would overload the REST interface mechanism. * * @param commands */ - protected void sendCommandsByFile(String[] commands) + protected void sendCommandsByFile(List commands) { try { - File tmp = File.createTempFile("chim", ".com"); + File tmp = File.createTempFile("chim", getCommandFileExtension()); tmp.deleteOnExit(); PrintWriter out = new PrintWriter(new FileOutputStream(tmp)); - for (String command : commands) + for (StructureCommandI command : commands) { - out.println(command); + out.println(command.getCommand()); } out.flush(); out.close(); String path = tmp.getAbsolutePath(); - sendAsynchronousCommand("open cmd:" + path, null); + StructureCommandI command = getCommandGenerator() + .openCommandFile(path); + executeCommand(false, null, command); } catch (IOException e) { - System.err - .println("Sending commands to Chimera via file failed with " - + e.getMessage()); + System.err.println("Sending commands to Chimera via file failed with " + + e.getMessage()); } } /** - * Get Chimera residues which have the named attribute, find the mapped - * positions in the Jalview sequence(s), and set as sequence features - * - * @param attName - * @param alignmentPanel + * Returns the file extension required for a file of commands to be read by + * the structure viewer + * @return */ - public void copyStructureAttributesToFeatures(String attName, - AlignmentViewPanel alignmentPanel) + protected String getCommandFileExtension() { - // todo pull up to AAStructureBindingModel (and interface?) - - /* - * ask Chimera to list residues with the attribute, reporting its value - */ - // this alternative command - // list residues spec ':*/attName' attr attName - // doesn't report 'None' values (which is good), but - // fails for 'average.bfactor' (which is bad): - - String cmd = "list residues attr '" + attName + "'"; - List residues = sendChimeraCommand(cmd, true); - - boolean featureAdded = createFeaturesForAttributes(attName, residues); - if (featureAdded) - { - alignmentPanel.getFeatureRenderer().featuresAdded(); - } + return ".com"; } /** @@ -1199,12 +646,12 @@ public abstract class JalviewChimeraBinding extends AAStructureBindingModel * * @param attName * @param residues - * @return + * @return the number of features added */ - protected boolean createFeaturesForAttributes(String attName, + protected int createFeaturesForAttributes(String attName, List residues) { - boolean featureAdded = false; + int featuresAdded = 0; String featureGroup = getViewerFeatureGroup(); for (String residue : residues) @@ -1229,10 +676,10 @@ public abstract class JalviewChimeraBinding extends AAStructureBindingModel try { - spec = AtomSpec.fromChimeraAtomspec(atomSpec); + spec = parseAtomSpec(atomSpec); } catch (IllegalArgumentException e) { - System.err.println("Problem parsing atomspec " + atomSpec); + Console.error("Problem parsing atomspec " + atomSpec); continue; } @@ -1272,10 +719,13 @@ public abstract class JalviewChimeraBinding extends AAStructureBindingModel start, end, score, featureGroup); // todo: should SequenceFeature have an explicit property for chain? // note: repeating the action shouldn't duplicate features - featureAdded |= seq.addSequenceFeature(sf); + if (seq.addSequenceFeature(sf)) + { + featuresAdded++; + } } } - return featureAdded; + return featuresAdded; } /** @@ -1290,24 +740,63 @@ public abstract class JalviewChimeraBinding extends AAStructureBindingModel return CHIMERA_FEATURE_GROUP; } + @Override + public String getModelIdForFile(String pdbFile) + { + List foundModels = chimeraMaps.get(pdbFile); + if (foundModels != null && !foundModels.isEmpty()) + { + return String.valueOf(foundModels.get(0).getModelNumber()); + } + return ""; + } - public Hashtable getChainFile() + /** + * Answers a (possibly empty) list of attribute names in Chimera[X], excluding + * any which were added from Jalview + * + * @return + */ + public List getChimeraAttributes() { - return chainFile; + List attributes = new ArrayList<>(); + StructureCommandI command = getCommandGenerator().listResidueAttributes(); + final List reply = executeCommand(command, true); + if (reply != null) + { + for (String inputLine : reply) + { + String[] lineParts = inputLine.split("\\s"); + if (lineParts.length == 2 && lineParts[0].equals("resattr")) + { + String attName = lineParts[1]; + /* + * exclude attributes added from Jalview + */ + if (!attName.startsWith(ChimeraCommands.NAMESPACE_PREFIX)) + { + attributes.add(attName); + } + } + } + } + return attributes; } - public List getChimeraModelByChain(String chain) + /** + * Returns the file extension to use for a saved viewer session file (.py) + * + * @return + */ + @Override + public String getSessionFileExtension() { - return chimeraMaps.get(chainFile.get(chain)); + return CHIMERA_SESSION_EXTENSION; } - public int getModelNoForChain(String chain) + @Override + public String getHelpURL() { - List foundModels = getChimeraModelByChain(chain); - if (foundModels != null && !foundModels.isEmpty()) - { - return foundModels.get(0).getModelNumber(); - } - return -1; + return "https://www.cgl.ucsf.edu/chimera/docs/UsersGuide"; } }