src/jalview/ext/jmol/JalviewJmolBinding.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3
  10  * of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  */
  21 package jalview.ext.jmol;
  22
  23 import jalview.api.AlignViewportI;
  24 import jalview.api.AlignmentViewPanel;
  25 import jalview.api.FeatureRenderer;
  26 import jalview.api.SequenceRenderer;
  27 import jalview.datamodel.AlignmentI;
  28 import jalview.datamodel.HiddenColumns;
  29 import jalview.datamodel.PDBEntry;
  30 import jalview.datamodel.SequenceI;
  31 import jalview.gui.IProgressIndicator;
  32 import jalview.io.DataSourceType;
  33 import jalview.io.StructureFile;
  34 import jalview.schemes.ColourSchemeI;
  35 import jalview.schemes.ResidueProperties;
  36 import jalview.structure.AtomSpec;
  37 import jalview.structure.StructureMappingcommandSet;
  38 import jalview.structure.StructureSelectionManager;
  39 import jalview.structures.models.AAStructureBindingModel;
  40 import jalview.util.MessageManager;
  41
  42 import java.awt.Color;
  43 import java.awt.Container;
  44 import java.awt.event.ComponentEvent;
  45 import java.awt.event.ComponentListener;
  46 import java.io.File;
  47 import java.net.URL;
  48 import java.util.ArrayList;
  49 import java.util.BitSet;
  50 import java.util.Hashtable;
  51 import java.util.List;
  52 import java.util.Map;
  53 import java.util.Vector;
  54
  55 import org.jmol.adapter.smarter.SmarterJmolAdapter;
  56 import org.jmol.api.JmolAppConsoleInterface;
  57 import org.jmol.api.JmolSelectionListener;
  58 import org.jmol.api.JmolStatusListener;
  59 import org.jmol.api.JmolViewer;
  60 import org.jmol.c.CBK;
  61 import org.jmol.script.T;
  62 import org.jmol.viewer.Viewer;
  63
  64 public abstract class JalviewJmolBinding extends AAStructureBindingModel
  65         implements JmolStatusListener, JmolSelectionListener,
  66         ComponentListener
  67 {
  68   boolean allChainsSelected = false;
  69
  70   /*
  71    * when true, try to search the associated datamodel for sequences that are
  72    * associated with any unknown structures in the Jmol view.
  73    */
  74   private boolean associateNewStructs = false;
  75
  76   Vector<String> atomsPicked = new Vector<>();
  77
  78   private List<String> chainNames;
  79
  80   Hashtable<String, String> chainFile;
  81
  82   /*
  83    * the default or current model displayed if the model cannot be identified
  84    * from the selection message
  85    */
  86   int frameNo = 0;
  87
  88   // protected JmolGenericPopup jmolpopup; // not used - remove?
  89
  90   String lastCommand;
  91
  92   String lastMessage;
  93
  94   boolean loadedInline;
  95
  96   StringBuffer resetLastRes = new StringBuffer();
  97
  98   public Viewer viewer;
  99
 100   public JalviewJmolBinding(StructureSelectionManager ssm,
 101           PDBEntry[] pdbentry, SequenceI[][] sequenceIs,
 102           DataSourceType protocol)
 103   {
 104     super(ssm, pdbentry, sequenceIs, protocol);
 105     /*
 106      * viewer = JmolViewer.allocateViewer(renderPanel, new SmarterJmolAdapter(),
 107      * "jalviewJmol", ap.av.applet .getDocumentBase(),
 108      * ap.av.applet.getCodeBase(), "", this);
 109      *
 110      * jmolpopup = JmolPopup.newJmolPopup(viewer, true, "Jmol", true);
 111      */
 112   }
 113
 114   public JalviewJmolBinding(StructureSelectionManager ssm,
 115           SequenceI[][] seqs, Viewer theViewer)
 116   {
 117     super(ssm, seqs);
 118
 119     viewer = theViewer;
 120     viewer.setJmolStatusListener(this);
 121     viewer.addSelectionListener(this);
 122   }
 123
 124   /**
 125    * construct a title string for the viewer window based on the data jalview
 126    * knows about
 127    *
 128    * @return
 129    */
 130   public String getViewerTitle()
 131   {
 132     return getViewerTitle("Jmol", true);
 133   }
 134
 135   /**
 136    * prepare the view for a given set of models/chains. chainList contains
 137    * strings of the form 'pdbfilename:Chaincode'
 138    *
 139    * @param chainList
 140    *          list of chains to make visible
 141    */
 142   public void centerViewer(Vector<String> chainList)
 143   {
 144     StringBuilder cmd = new StringBuilder(128);
 145     int mlength, p;
 146     for (String lbl : chainList)
 147     {
 148       mlength = 0;
 149       do
 150       {
 151         p = mlength;
 152         mlength = lbl.indexOf(":", p);
 153       } while (p < mlength && mlength < (lbl.length() - 2));
 154       // TODO: lookup each pdb id and recover proper model number for it.
 155       cmd.append(":" + lbl.substring(mlength + 1) + " /"
 156               + (1 + getModelNum(chainFile.get(lbl))) + " or ");
 157     }
 158     if (cmd.length() > 0)
 159     {
 160       cmd.setLength(cmd.length() - 4);
 161     }
 162     evalStateCommand("select *;restrict " + cmd + ";cartoon;center " + cmd);
 163   }
 164
 165   public void closeViewer()
 166   {
 167     // remove listeners for all structures in viewer
 168     getSsm().removeStructureViewerListener(this, this.getStructureFiles());
 169     viewer.dispose();
 170     lastCommand = null;
 171     viewer = null;
 172     releaseUIResources();
 173   }
 174
 175   @Override
 176   public void colourByChain()
 177   {
 178     colourBySequence = false;
 179     // TODO: colour by chain should colour each chain distinctly across all
 180     // visible models
 181     // TODO: http://issues.jalview.org/browse/JAL-628
 182     evalStateCommand("select *;color chain");
 183   }
 184
 185   @Override
 186   public void colourByCharge()
 187   {
 188     colourBySequence = false;
 189     evalStateCommand("select *;color white;select ASP,GLU;color red;"
 190             + "select LYS,ARG;color blue;select CYS;color yellow");
 191   }
 192
 193   /**
 194    * superpose the structures associated with sequences in the alignment
 195    * according to their corresponding positions.
 196    */
 197   public void superposeStructures(AlignmentI alignment)
 198   {
 199     superposeStructures(alignment, -1, null);
 200   }
 201
 202   /**
 203    * superpose the structures associated with sequences in the alignment
 204    * according to their corresponding positions. ded)
 205    *
 206    * @param refStructure
 207    *          - select which pdb file to use as reference (default is -1 - the
 208    *          first structure in the alignment)
 209    */
 210   public void superposeStructures(AlignmentI alignment, int refStructure)
 211   {
 212     superposeStructures(alignment, refStructure, null);
 213   }
 214
 215   /**
 216    * superpose the structures associated with sequences in the alignment
 217    * according to their corresponding positions. ded)
 218    *
 219    * @param refStructure
 220    *          - select which pdb file to use as reference (default is -1 - the
 221    *          first structure in the alignment)
 222    * @param hiddenCols
 223    *          TODO
 224    */
 225   public void superposeStructures(AlignmentI alignment, int refStructure,
 226           HiddenColumns hiddenCols)
 227   {
 228     superposeStructures(new AlignmentI[] { alignment },
 229             new int[]
 230             { refStructure }, new HiddenColumns[] { hiddenCols });
 231   }
 232
 233   /**
 234    * {@inheritDoc}
 235    */
 236   @Override
 237   public String superposeStructures(AlignmentI[] _alignment,
 238           int[] _refStructure, HiddenColumns[] _hiddenCols)
 239   {
 240     while (viewer.isScriptExecuting())
 241     {
 242       try
 243       {
 244         Thread.sleep(10);
 245       } catch (InterruptedException i)
 246       {
 247       }
 248     }
 249
 250     /*
 251      * get the distinct structure files modelled
 252      * (a file with multiple chains may map to multiple sequences)
 253      */
 254     String[] files = getStructureFiles();
 255     if (!waitForFileLoad(files))
 256     {
 257       return null;
 258     }
 259
 260     StringBuilder selectioncom = new StringBuilder(256);
 261     // In principle - nSeconds specifies the speed of animation for each
 262     // superposition - but is seems to behave weirdly, so we don't specify it.
 263     String nSeconds = " ";
 264     if (files.length > 10)
 265     {
 266       nSeconds = " 0.005 ";
 267     }
 268     else
 269     {
 270       nSeconds = " " + (2.0 / files.length) + " ";
 271       // if (nSeconds).substring(0,5)+" ";
 272     }
 273
 274     // see JAL-1345 - should really automatically turn off the animation for
 275     // large numbers of structures, but Jmol doesn't seem to allow that.
 276     // nSeconds = " ";
 277     // union of all aligned positions are collected together.
 278     for (int a = 0; a < _alignment.length; a++)
 279     {
 280       int refStructure = _refStructure[a];
 281       AlignmentI alignment = _alignment[a];
 282       HiddenColumns hiddenCols = _hiddenCols[a];
 283       if (a > 0 && selectioncom.length() > 0 && !selectioncom
 284               .substring(selectioncom.length() - 1).equals("|"))
 285       {
 286         selectioncom.append("|");
 287       }
 288       // process this alignment
 289       if (refStructure >= files.length)
 290       {
 291         System.err.println(
 292                 "Invalid reference structure value " + refStructure);
 293         refStructure = -1;
 294       }
 295
 296       /*
 297        * 'matched' bit j will be set for visible alignment columns j where
 298        * all sequences have a residue with a mapping to the PDB structure
 299        */
 300       BitSet matched = new BitSet();
 301       for (int m = 0; m < alignment.getWidth(); m++)
 302       {
 303         if (hiddenCols == null || hiddenCols.isVisible(m))
 304         {
 305           matched.set(m);
 306         }
 307       }
 308
 309       SuperposeData[] structures = new SuperposeData[files.length];
 310       for (int f = 0; f < files.length; f++)
 311       {
 312         structures[f] = new SuperposeData(alignment.getWidth());
 313       }
 314
 315       /*
 316        * Calculate the superposable alignment columns ('matched'), and the
 317        * corresponding structure residue positions (structures.pdbResNo)
 318        */
 319       int candidateRefStructure = findSuperposableResidues(alignment,
 320               matched, structures);
 321       if (refStructure < 0)
 322       {
 323         /*
 324          * If no reference structure was specified, pick the first one that has
 325          * a mapping in the alignment
 326          */
 327         refStructure = candidateRefStructure;
 328       }
 329
 330       String[] selcom = new String[files.length];
 331       int nmatched = matched.cardinality();
 332       if (nmatched < 4)
 333       {
 334         return (MessageManager.formatMessage("label.insufficient_residues",
 335                 nmatched));
 336       }
 337
 338       /*
 339        * generate select statements to select regions to superimpose structures
 340        */
 341       {
 342         // TODO extract method to construct selection statements
 343         for (int pdbfnum = 0; pdbfnum < files.length; pdbfnum++)
 344         {
 345           String chainCd = ":" + structures[pdbfnum].chain;
 346           int lpos = -1;
 347           boolean run = false;
 348           StringBuilder molsel = new StringBuilder();
 349           molsel.append("{");
 350
 351           int nextColumnMatch = matched.nextSetBit(0);
 352           while (nextColumnMatch != -1)
 353           {
 354             int pdbResNo = structures[pdbfnum].pdbResNo[nextColumnMatch];
 355             if (lpos != pdbResNo - 1)
 356             {
 357               // discontinuity
 358               if (lpos != -1)
 359               {
 360                 molsel.append(lpos);
 361                 molsel.append(chainCd);
 362                 molsel.append("|");
 363               }
 364               run = false;
 365             }
 366             else
 367             {
 368               // continuous run - and lpos >-1
 369               if (!run)
 370               {
 371                 // at the beginning, so add dash
 372                 molsel.append(lpos);
 373                 molsel.append("-");
 374               }
 375               run = true;
 376             }
 377             lpos = pdbResNo;
 378             nextColumnMatch = matched.nextSetBit(nextColumnMatch + 1);
 379           }
 380           /*
 381            * add final selection phrase
 382            */
 383           if (lpos != -1)
 384           {
 385             molsel.append(lpos);
 386             molsel.append(chainCd);
 387             molsel.append("}");
 388           }
 389           if (molsel.length() > 1)
 390           {
 391             selcom[pdbfnum] = molsel.toString();
 392             selectioncom.append("((");
 393             selectioncom.append(selcom[pdbfnum].substring(1,
 394                     selcom[pdbfnum].length() - 1));
 395             selectioncom.append(" )& ");
 396             selectioncom.append(pdbfnum + 1);
 397             selectioncom.append(".1)");
 398             if (pdbfnum < files.length - 1)
 399             {
 400               selectioncom.append("|");
 401             }
 402           }
 403           else
 404           {
 405             selcom[pdbfnum] = null;
 406           }
 407         }
 408       }
 409       StringBuilder command = new StringBuilder(256);
 410       // command.append("set spinFps 10;\n");
 411
 412       for (int pdbfnum = 0; pdbfnum < files.length; pdbfnum++)
 413       {
 414         if (pdbfnum == refStructure || selcom[pdbfnum] == null
 415                 || selcom[refStructure] == null)
 416         {
 417           continue;
 418         }
 419         command.append("echo ");
 420         command.append("\"Superposing (");
 421         command.append(structures[pdbfnum].pdbId);
 422         command.append(") against reference (");
 423         command.append(structures[refStructure].pdbId);
 424         command.append(")\";\ncompare " + nSeconds);
 425         command.append("{");
 426         command.append(Integer.toString(1 + pdbfnum));
 427         command.append(".1} {");
 428         command.append(Integer.toString(1 + refStructure));
 429         // conformation=1 excludes alternate locations for CA (JAL-1757)
 430         command.append(
 431                 ".1} SUBSET {(*.CA | *.P) and conformation=1} ATOMS ");
 432
 433         // for (int s = 0; s < 2; s++)
 434         // {
 435         // command.append(selcom[(s == 0 ? pdbfnum : refStructure)]);
 436         // }
 437         command.append(selcom[pdbfnum]);
 438         command.append(selcom[refStructure]);
 439         command.append(" ROTATE TRANSLATE;\n");
 440       }
 441       if (selectioncom.length() > 0)
 442       {
 443         // TODO is performing selectioncom redundant here? is done later on
 444         // System.out.println("Select regions:\n" + selectioncom.toString());
 445         evalStateCommand("select *; cartoons off; backbone; select ("
 446                 + selectioncom.toString() + "); cartoons; ");
 447         // selcom.append("; ribbons; ");
 448         String cmdString = command.toString();
 449         // System.out.println("Superimpose command(s):\n" + cmdString);
 450
 451         evalStateCommand(cmdString);
 452       }
 453     }
 454     if (selectioncom.length() > 0)
 455     {// finally, mark all regions that were superposed.
 456       if (selectioncom.substring(selectioncom.length() - 1).equals("|"))
 457       {
 458         selectioncom.setLength(selectioncom.length() - 1);
 459       }
 460       // System.out.println("Select regions:\n" + selectioncom.toString());
 461       evalStateCommand("select *; cartoons off; backbone; select ("
 462               + selectioncom.toString() + "); cartoons; ");
 463       // evalStateCommand("select *; backbone; select "+selcom.toString()+";
 464       // cartoons; center "+selcom.toString());
 465     }
 466
 467     return null;
 468   }
 469
 470   public void evalStateCommand(String command)
 471   {
 472     jmolHistory(false);
 473     if (lastCommand == null || !lastCommand.equals(command))
 474     {
 475       viewer.evalStringQuiet(command + "\n");
 476     }
 477     jmolHistory(true);
 478     lastCommand = command;
 479   }
 480
 481   Thread colourby = null;
 482   /**
 483    * Sends a set of colour commands to the structure viewer
 484    *
 485    * @param colourBySequenceCommands
 486    */
 487   @Override
 488   protected void colourBySequence(
 489           final StructureMappingcommandSet[] colourBySequenceCommands)
 490   {
 491     if (colourby != null)
 492     {
 493       colourby.interrupt();
 494       colourby = null;
 495     }
 496     colourby = new Thread(new Runnable()
 497     {
 498       @Override
 499       public void run()
 500       {
 501         for (StructureMappingcommandSet cpdbbyseq : colourBySequenceCommands)
 502         {
 503           for (String cbyseq : cpdbbyseq.commands)
 504           {
 505             executeWhenReady(cbyseq);
 506           }
 507         }
 508       }
 509     });
 510     colourby.start();
 511   }
 512
 513   /**
 514    * @param files
 515    * @param sr
 516    * @param viewPanel
 517    * @return
 518    */
 519   @Override
 520   protected StructureMappingcommandSet[] getColourBySequenceCommands(
 521           String[] files, SequenceRenderer sr, AlignmentViewPanel viewPanel)
 522   {
 523     return JmolCommands.getColourBySequenceCommand(getSsm(), files,
 524             getSequence(), sr, viewPanel);
 525   }
 526
 527   /**
 528    * @param command
 529    */
 530   protected void executeWhenReady(String command)
 531   {
 532     evalStateCommand(command);
 533   }
 534
 535   public void createImage(String file, String type, int quality)
 536   {
 537     System.out.println("JMOL CREATE IMAGE");
 538   }
 539
 540   @Override
 541   public String createImage(String fileName, String type,
 542           Object textOrBytes, int quality)
 543   {
 544     System.out.println("JMOL CREATE IMAGE");
 545     return null;
 546   }
 547
 548   @Override
 549   public String eval(String strEval)
 550   {
 551     // System.out.println(strEval);
 552     // "# 'eval' is implemented only for the applet.";
 553     return null;
 554   }
 555
 556   // End StructureListener
 557   // //////////////////////////
 558
 559   @Override
 560   public float[][] functionXY(String functionName, int x, int y)
 561   {
 562     return null;
 563   }
 564
 565   @Override
 566   public float[][][] functionXYZ(String functionName, int nx, int ny,
 567           int nz)
 568   {
 569     // TODO Auto-generated method stub
 570     return null;
 571   }
 572
 573   public Color getColour(int atomIndex, int pdbResNum, String chain,
 574           String pdbfile)
 575   {
 576     if (getModelNum(pdbfile) < 0)
 577     {
 578       return null;
 579     }
 580     // TODO: verify atomIndex is selecting correct model.
 581     // return new Color(viewer.getAtomArgb(atomIndex)); Jmol 12.2.4
 582     int colour = viewer.ms.at[atomIndex].atomPropertyInt(T.color);
 583     return new Color(colour);
 584   }
 585
 586   /**
 587    * instruct the Jalview binding to update the pdbentries vector if necessary
 588    * prior to matching the jmol view's contents to the list of structure files
 589    * Jalview knows about.
 590    */
 591   public abstract void refreshPdbEntries();
 592
 593   private int getModelNum(String modelFileName)
 594   {
 595     String[] mfn = getStructureFiles();
 596     if (mfn == null)
 597     {
 598       return -1;
 599     }
 600     for (int i = 0; i < mfn.length; i++)
 601     {
 602       if (mfn[i].equalsIgnoreCase(modelFileName))
 603       {
 604         return i;
 605       }
 606     }
 607     return -1;
 608   }
 609
 610   /**
 611    * map between index of model filename returned from getPdbFile and the first
 612    * index of models from this file in the viewer. Note - this is not trimmed -
 613    * use getPdbFile to get number of unique models.
 614    */
 615   private int _modelFileNameMap[];
 616
 617   @Override
 618   public synchronized String[] getStructureFiles()
 619   {
 620     List<String> mset = new ArrayList<>();
 621     if (viewer == null)
 622     {
 623       return new String[0];
 624     }
 625
 626     if (modelFileNames == null)
 627     {
 628       int modelCount = viewer.ms.mc;
 629       String filePath = null;
 630       for (int i = 0; i < modelCount; ++i)
 631       {
 632         filePath = viewer.ms.getModelFileName(i);
 633         if (!mset.contains(filePath))
 634         {
 635           mset.add(filePath);
 636         }
 637       }
 638       modelFileNames = mset.toArray(new String[mset.size()]);
 639     }
 640
 641     return modelFileNames;
 642   }
 643
 644   /**
 645    * map from string to applet
 646    */
 647   @Override
 648   public Map<String, Object> getRegistryInfo()
 649   {
 650     // TODO Auto-generated method stub
 651     return null;
 652   }
 653
 654   // ///////////////////////////////
 655   // JmolStatusListener
 656
 657   public void handlePopupMenu(int x, int y)
 658   {
 659     // jmolpopup.show(x, y);
 660     // jmolpopup.jpiShow(x, y);
 661   }
 662
 663   /**
 664    * Highlight zero, one or more atoms on the structure
 665    */
 666   @Override
 667   public void highlightAtoms(List<AtomSpec> atoms)
 668   {
 669     if (atoms != null)
 670     {
 671       if (resetLastRes.length() > 0)
 672       {
 673         viewer.evalStringQuiet(resetLastRes.toString());
 674         resetLastRes.setLength(0);
 675       }
 676       for (AtomSpec atom : atoms)
 677       {
 678         highlightAtom(atom.getAtomIndex(), atom.getPdbResNum(),
 679                 atom.getChain(), atom.getPdbFile());
 680       }
 681     }
 682   }
 683
 684   // jmol/ssm only
 685   public void highlightAtom(int atomIndex, int pdbResNum, String chain,
 686           String pdbfile)
 687   {
 688     if (modelFileNames == null)
 689     {
 690       return;
 691     }
 692
 693     // look up file model number for this pdbfile
 694     int mdlNum = 0;
 695     // may need to adjust for URLencoding here - we don't worry about that yet.
 696     while (mdlNum < modelFileNames.length
 697             && !pdbfile.equals(modelFileNames[mdlNum]))
 698     {
 699       mdlNum++;
 700     }
 701     if (mdlNum == modelFileNames.length)
 702     {
 703       return;
 704     }
 705
 706     jmolHistory(false);
 707
 708     StringBuilder cmd = new StringBuilder(64);
 709     cmd.append("select " + pdbResNum); // +modelNum
 710
 711     resetLastRes.append("select " + pdbResNum); // +modelNum
 712
 713     cmd.append(":");
 714     resetLastRes.append(":");
 715     if (!chain.equals(" "))
 716     {
 717       cmd.append(chain);
 718       resetLastRes.append(chain);
 719     }
 720     {
 721       cmd.append(" /" + (mdlNum + 1));
 722       resetLastRes.append("/" + (mdlNum + 1));
 723     }
 724     cmd.append(";wireframe 100;" + cmd.toString() + " and not hetero;");
 725
 726     resetLastRes.append(";wireframe 0;" + resetLastRes.toString()
 727             + " and not hetero; spacefill 0;");
 728
 729     cmd.append("spacefill 200;select none");
 730
 731     viewer.evalStringQuiet(cmd.toString());
 732     jmolHistory(true);
 733
 734   }
 735
 736   boolean debug = true;
 737
 738   private void jmolHistory(boolean enable)
 739   {
 740     viewer.evalStringQuiet("History " + ((debug || enable) ? "on" : "off"));
 741   }
 742
 743   public void loadInline(String string)
 744   {
 745     loadedInline = true;
 746     // TODO: re JAL-623
 747     // viewer.loadInline(strModel, isAppend);
 748     // could do this:
 749     // construct fake fullPathName and fileName so we can identify the file
 750     // later.
 751     // Then, construct pass a reader for the string to Jmol.
 752     // ((org.jmol.Viewer.Viewer) viewer).loadModelFromFile(fullPathName,
 753     // fileName, null, reader, false, null, null, 0);
 754     viewer.openStringInline(string);
 755   }
 756
 757   public void mouseOverStructure(int atomIndex, String strInfo)
 758   {
 759     int pdbResNum;
 760     int alocsep = strInfo.indexOf("^");
 761     int mdlSep = strInfo.indexOf("/");
 762     int chainSeparator = strInfo.indexOf(":"), chainSeparator1 = -1;
 763
 764     if (chainSeparator == -1)
 765     {
 766       chainSeparator = strInfo.indexOf(".");
 767       if (mdlSep > -1 && mdlSep < chainSeparator)
 768       {
 769         chainSeparator1 = chainSeparator;
 770         chainSeparator = mdlSep;
 771       }
 772     }
 773     // handle insertion codes
 774     if (alocsep != -1)
 775     {
 776       pdbResNum = Integer.parseInt(
 777               strInfo.substring(strInfo.indexOf("]") + 1, alocsep));
 778
 779     }
 780     else
 781     {
 782       pdbResNum = Integer.parseInt(
 783               strInfo.substring(strInfo.indexOf("]") + 1, chainSeparator));
 784     }
 785     String chainId;
 786
 787     if (strInfo.indexOf(":") > -1)
 788     {
 789       chainId = strInfo.substring(strInfo.indexOf(":") + 1,
 790               strInfo.indexOf("."));
 791     }
 792     else
 793     {
 794       chainId = " ";
 795     }
 796
 797     String pdbfilename = modelFileNames[frameNo]; // default is first or current
 798     // model
 799     if (mdlSep > -1)
 800     {
 801       if (chainSeparator1 == -1)
 802       {
 803         chainSeparator1 = strInfo.indexOf(".", mdlSep);
 804       }
 805       String mdlId = (chainSeparator1 > -1)
 806               ? strInfo.substring(mdlSep + 1, chainSeparator1)
 807               : strInfo.substring(mdlSep + 1);
 808       try
 809       {
 810         // recover PDB filename for the model hovered over.
 811         int mnumber = Integer.valueOf(mdlId).intValue() - 1;
 812         if (_modelFileNameMap != null)
 813         {
 814           int _mp = _modelFileNameMap.length - 1;
 815
 816           while (mnumber < _modelFileNameMap[_mp])
 817           {
 818             _mp--;
 819           }
 820           pdbfilename = modelFileNames[_mp];
 821         }
 822         else
 823         {
 824           if (mnumber >= 0 && mnumber < modelFileNames.length)
 825           {
 826             pdbfilename = modelFileNames[mnumber];
 827           }
 828
 829           if (pdbfilename == null)
 830           {
 831             pdbfilename = new File(viewer.ms.getModelFileName(mnumber))
 832                     .getAbsolutePath();
 833           }
 834         }
 835       } catch (Exception e)
 836       {
 837       }
 838       ;
 839     }
 840     if (lastMessage == null || !lastMessage.equals(strInfo))
 841     {
 842       getSsm().mouseOverStructure(pdbResNum, chainId, pdbfilename);
 843     }
 844
 845     lastMessage = strInfo;
 846   }
 847
 848   public void notifyAtomHovered(int atomIndex, String strInfo, String data)
 849   {
 850     if (data != null)
 851     {
 852       System.err.println("Ignoring additional hover info: " + data
 853               + " (other info: '" + strInfo + "' pos " + atomIndex + ")");
 854     }
 855     mouseOverStructure(atomIndex, strInfo);
 856   }
 857
 858   /*
 859    * { if (history != null && strStatus != null &&
 860    * !strStatus.equals("Script completed")) { history.append("\n" + strStatus);
 861    * } }
 862    */
 863
 864   public void notifyAtomPicked(int atomIndex, String strInfo,
 865           String strData)
 866   {
 867     /**
 868      * this implements the toggle label behaviour copied from the original
 869      * structure viewer, MCView
 870      */
 871     if (strData != null)
 872     {
 873       System.err.println("Ignoring additional pick data string " + strData);
 874     }
 875     int chainSeparator = strInfo.indexOf(":");
 876     int p = 0;
 877     if (chainSeparator == -1)
 878     {
 879       chainSeparator = strInfo.indexOf(".");
 880     }
 881
 882     String picked = strInfo.substring(strInfo.indexOf("]") + 1,
 883             chainSeparator);
 884     String mdlString = "";
 885     if ((p = strInfo.indexOf(":")) > -1)
 886     {
 887       picked += strInfo.substring(p, strInfo.indexOf("."));
 888     }
 889
 890     if ((p = strInfo.indexOf("/")) > -1)
 891     {
 892       mdlString += strInfo.substring(p, strInfo.indexOf(" #"));
 893     }
 894     picked = "((" + picked + ".CA" + mdlString + ")|(" + picked + ".P"
 895             + mdlString + "))";
 896     jmolHistory(false);
 897
 898     if (!atomsPicked.contains(picked))
 899     {
 900       viewer.evalStringQuiet("select " + picked + ";label %n %r:%c");
 901       atomsPicked.addElement(picked);
 902     }
 903     else
 904     {
 905       viewer.evalString("select " + picked + ";label off");
 906       atomsPicked.removeElement(picked);
 907     }
 908     jmolHistory(true);
 909     // TODO: in application this happens
 910     //
 911     // if (scriptWindow != null)
 912     // {
 913     // scriptWindow.sendConsoleMessage(strInfo);
 914     // scriptWindow.sendConsoleMessage("\n");
 915     // }
 916
 917   }
 918
 919   @Override
 920   public void notifyCallback(CBK type, Object[] data)
 921   {
 922     try
 923     {
 924       switch (type)
 925       {
 926       case LOADSTRUCT:
 927         notifyFileLoaded((String) data[1], (String) data[2],
 928                 (String) data[3], (String) data[4],
 929                 ((Integer) data[5]).intValue());
 930
 931         break;
 932       case PICK:
 933         notifyAtomPicked(((Integer) data[2]).intValue(), (String) data[1],
 934                 (String) data[0]);
 935         // also highlight in alignment
 936         // deliberate fall through
 937       case HOVER:
 938         notifyAtomHovered(((Integer) data[2]).intValue(), (String) data[1],
 939                 (String) data[0]);
 940         break;
 941       case SCRIPT:
 942         notifyScriptTermination((String) data[2],
 943                 ((Integer) data[3]).intValue());
 944         break;
 945       case ECHO:
 946         sendConsoleEcho((String) data[1]);
 947         break;
 948       case MESSAGE:
 949         sendConsoleMessage(
 950                 (data == null) ? ((String) null) : (String) data[1]);
 951         break;
 952       case ERROR:
 953         // System.err.println("Ignoring error callback.");
 954         break;
 955       case SYNC:
 956       case RESIZE:
 957         refreshGUI();
 958         break;
 959       case MEASURE:
 960
 961       case CLICK:
 962       default:
 963         System.err.println(
 964                 "Unhandled callback " + type + " " + data[1].toString());
 965         break;
 966       }
 967     } catch (Exception e)
 968     {
 969       System.err.println("Squashed Jmol callback handler error:");
 970       e.printStackTrace();
 971     }
 972   }
 973
 974   @Override
 975   public boolean notifyEnabled(CBK callbackPick)
 976   {
 977     switch (callbackPick)
 978     {
 979     case ECHO:
 980     case LOADSTRUCT:
 981     case MEASURE:
 982     case MESSAGE:
 983     case PICK:
 984     case SCRIPT:
 985     case HOVER:
 986     case ERROR:
 987       return true;
 988     default:
 989       return false;
 990     }
 991   }
 992
 993   // incremented every time a load notification is successfully handled -
 994   // lightweight mechanism for other threads to detect when they can start
 995   // referrring to new structures.
 996   private long loadNotifiesHandled = 0;
 997
 998   public long getLoadNotifiesHandled()
 999   {
1000     return loadNotifiesHandled;
1001   }
1002
1003   public void notifyFileLoaded(String fullPathName, String fileName2,
1004           String modelName, String errorMsg, int modelParts)
1005   {
1006     if (errorMsg != null)
1007     {
1008       fileLoadingError = errorMsg;
1009       refreshGUI();
1010       return;
1011     }
1012     // TODO: deal sensibly with models loaded inLine:
1013     // modelName will be null, as will fullPathName.
1014
1015     // the rest of this routine ignores the arguments, and simply interrogates
1016     // the Jmol view to find out what structures it contains, and adds them to
1017     // the structure selection manager.
1018     fileLoadingError = null;
1019     String[] oldmodels = modelFileNames;
1020     modelFileNames = null;
1021     chainNames = new ArrayList<>();
1022     chainFile = new Hashtable<>();
1023     boolean notifyLoaded = false;
1024     String[] modelfilenames = getStructureFiles();
1025     // first check if we've lost any structures
1026     if (oldmodels != null && oldmodels.length > 0)
1027     {
1028       int oldm = 0;
1029       for (int i = 0; i < oldmodels.length; i++)
1030       {
1031         for (int n = 0; n < modelfilenames.length; n++)
1032         {
1033           if (modelfilenames[n] == oldmodels[i])
1034           {
1035             oldmodels[i] = null;
1036             break;
1037           }
1038         }
1039         if (oldmodels[i] != null)
1040         {
1041           oldm++;
1042         }
1043       }
1044       if (oldm > 0)
1045       {
1046         String[] oldmfn = new String[oldm];
1047         oldm = 0;
1048         for (int i = 0; i < oldmodels.length; i++)
1049         {
1050           if (oldmodels[i] != null)
1051           {
1052             oldmfn[oldm++] = oldmodels[i];
1053           }
1054         }
1055         // deregister the Jmol instance for these structures - we'll add
1056         // ourselves again at the end for the current structure set.
1057         getSsm().removeStructureViewerListener(this, oldmfn);
1058       }
1059     }
1060     refreshPdbEntries();
1061     for (int modelnum = 0; modelnum < modelfilenames.length; modelnum++)
1062     {
1063       String fileName = modelfilenames[modelnum];
1064       boolean foundEntry = false;
1065       StructureFile pdb = null;
1066       String pdbfile = null;
1067       // model was probably loaded inline - so check the pdb file hashcode
1068       if (loadedInline)
1069       {
1070         // calculate essential attributes for the pdb data imported inline.
1071         // prolly need to resolve modelnumber properly - for now just use our
1072         // 'best guess'
1073         pdbfile = viewer.getData(
1074                 "" + (1 + _modelFileNameMap[modelnum]) + ".0", "PDB");
1075       }
1076       // search pdbentries and sequences to find correct pdbentry for this
1077       // model
1078       for (int pe = 0; pe < getPdbCount(); pe++)
1079       {
1080         boolean matches = false;
1081         addSequence(pe, getSequence()[pe]);
1082         if (fileName == null)
1083         {
1084           if (false)
1085           // see JAL-623 - need method of matching pasted data up
1086           {
1087             pdb = getSsm().setMapping(getSequence()[pe], getChains()[pe],
1088                     pdbfile, DataSourceType.PASTE,
1089                     getIProgressIndicator());
1090             getPdbEntry(modelnum).setFile("INLINE" + pdb.getId());
1091             matches = true;
1092             foundEntry = true;
1093           }
1094         }
1095         else
1096         {
1097           File fl = new File(getPdbEntry(pe).getFile());
1098           matches = fl.equals(new File(fileName));
1099           if (matches)
1100           {
1101             foundEntry = true;
1102             // TODO: Jmol can in principle retrieve from CLASSLOADER but
1103             // this
1104             // needs
1105             // to be tested. See mantis bug
1106             // https://mantis.lifesci.dundee.ac.uk/view.php?id=36605
1107             DataSourceType protocol = DataSourceType.URL;
1108             try
1109             {
1110               if (fl.exists())
1111               {
1112                 protocol = DataSourceType.FILE;
1113               }
1114             } catch (Exception e)
1115             {
1116             } catch (Error e)
1117             {
1118             }
1119             // Explicitly map to the filename used by Jmol ;
1120             pdb = getSsm().setMapping(getSequence()[pe], getChains()[pe],
1121                     fileName, protocol, getIProgressIndicator());
1122             // pdbentry[pe].getFile(), protocol);
1123
1124           }
1125         }
1126         if (matches)
1127         {
1128           // add an entry for every chain in the model
1129           for (int i = 0; i < pdb.getChains().size(); i++)
1130           {
1131             String chid = new String(
1132                     pdb.getId() + ":" + pdb.getChains().elementAt(i).id);
1133             chainFile.put(chid, fileName);
1134             chainNames.add(chid);
1135           }
1136           notifyLoaded = true;
1137         }
1138       }
1139
1140       if (!foundEntry && associateNewStructs)
1141       {
1142         // this is a foreign pdb file that jalview doesn't know about - add
1143         // it to the dataset and try to find a home - either on a matching
1144         // sequence or as a new sequence.
1145         String pdbcontent = viewer.getData("/" + (modelnum + 1) + ".1",
1146                 "PDB");
1147         // parse pdb file into a chain, etc.
1148         // locate best match for pdb in associated views and add mapping to
1149         // ssm
1150         // if properly registered then
1151         notifyLoaded = true;
1152
1153       }
1154     }
1155     // FILE LOADED OK
1156     // so finally, update the jmol bits and pieces
1157     // if (jmolpopup != null)
1158     // {
1159     // // potential for deadlock here:
1160     // // jmolpopup.updateComputedMenus();
1161     // }
1162     if (!isLoadingFromArchive())
1163     {
1164       viewer.evalStringQuiet(
1165               "model *; select backbone;restrict;cartoon;wireframe off;spacefill off");
1166     }
1167     // register ourselves as a listener and notify the gui that it needs to
1168     // update itself.
1169     getSsm().addStructureViewerListener(this);
1170     if (notifyLoaded)
1171     {
1172       FeatureRenderer fr = getFeatureRenderer(null);
1173       if (fr != null)
1174       {
1175         fr.featuresAdded();
1176       }
1177       refreshGUI();
1178       loadNotifiesHandled++;
1179     }
1180     setLoadingFromArchive(false);
1181   }
1182
1183   @Override
1184   public List<String> getChainNames()
1185   {
1186     return chainNames;
1187   }
1188
1189   protected IProgressIndicator getIProgressIndicator()
1190   {
1191     return null;
1192   }
1193
1194   public void notifyNewPickingModeMeasurement(int iatom, String strMeasure)
1195   {
1196     notifyAtomPicked(iatom, strMeasure, null);
1197   }
1198
1199   public abstract void notifyScriptTermination(String strStatus,
1200           int msWalltime);
1201
1202   /**
1203    * display a message echoed from the jmol viewer
1204    *
1205    * @param strEcho
1206    */
1207   public abstract void sendConsoleEcho(String strEcho); /*
1208                                                          * { showConsole(true);
1209                                                          *
1210                                                          * history.append("\n" +
1211                                                          * strEcho); }
1212                                                          */
1213
1214   // /End JmolStatusListener
1215   // /////////////////////////////
1216
1217   /**
1218    * @param strStatus
1219    *          status message - usually the response received after a script
1220    *          executed
1221    */
1222   public abstract void sendConsoleMessage(String strStatus);
1223
1224   @Override
1225   public void setCallbackFunction(String callbackType,
1226           String callbackFunction)
1227   {
1228     System.err.println("Ignoring set-callback request to associate "
1229             + callbackType + " with function " + callbackFunction);
1230
1231   }
1232
1233   @Override
1234   public void setJalviewColourScheme(ColourSchemeI cs)
1235   {
1236     colourBySequence = false;
1237
1238     if (cs == null)
1239     {
1240       return;
1241     }
1242
1243     jmolHistory(false);
1244     StringBuilder command = new StringBuilder(128);
1245     command.append("select *;color white;");
1246     List<String> residueSet = ResidueProperties.getResidues(isNucleotide(),
1247             false);
1248     for (String resName : residueSet)
1249     {
1250       char res = resName.length() == 3
1251               ? ResidueProperties.getSingleCharacterCode(resName)
1252               : resName.charAt(0);
1253       Color col = cs.findColour(res, 0, null, null, 0f);
1254       command.append("select " + resName + ";color[" + col.getRed() + ","
1255               + col.getGreen() + "," + col.getBlue() + "];");
1256     }
1257
1258     evalStateCommand(command.toString());
1259     jmolHistory(true);
1260   }
1261
1262   public void showHelp()
1263   {
1264     showUrl("http://jmol.sourceforge.net/docs/JmolUserGuide/", "jmolHelp");
1265   }
1266
1267   /**
1268    * open the URL somehow
1269    *
1270    * @param target
1271    */
1272   public abstract void showUrl(String url, String target);
1273
1274   /**
1275    * called when the binding thinks the UI needs to be refreshed after a Jmol
1276    * state change. this could be because structures were loaded, or because an
1277    * error has occured.
1278    */
1279   public abstract void refreshGUI();
1280
1281   /**
1282    * called to show or hide the associated console window container.
1283    *
1284    * @param show
1285    */
1286   public abstract void showConsole(boolean show);
1287
1288   /**
1289    * @param renderPanel
1290    * @param jmolfileio
1291    *          - when true will initialise jmol's file IO system (should be false
1292    *          in applet context)
1293    * @param htmlName
1294    * @param documentBase
1295    * @param codeBase
1296    * @param commandOptions
1297    */
1298   public void allocateViewer(Container renderPanel, boolean jmolfileio,
1299           String htmlName, URL documentBase, URL codeBase,
1300           String commandOptions)
1301   {
1302     allocateViewer(renderPanel, jmolfileio, htmlName, documentBase,
1303             codeBase, commandOptions, null, null);
1304   }
1305
1306   /**
1307    *
1308    * @param renderPanel
1309    * @param jmolfileio
1310    *          - when true will initialise jmol's file IO system (should be false
1311    *          in applet context)
1312    * @param htmlName
1313    * @param documentBase
1314    * @param codeBase
1315    * @param commandOptions
1316    * @param consolePanel
1317    *          - panel to contain Jmol console
1318    * @param buttonsToShow
1319    *          - buttons to show on the console, in ordr
1320    */
1321   public void allocateViewer(Container renderPanel, boolean jmolfileio,
1322           String htmlName, URL documentBase, URL codeBase,
1323           String commandOptions, final Container consolePanel,
1324           String buttonsToShow)
1325   {
1326     if (commandOptions == null)
1327     {
1328       commandOptions = "";
1329     }
1330     viewer = (Viewer) JmolViewer.allocateViewer(renderPanel,
1331             (jmolfileio ? new SmarterJmolAdapter() : null),
1332             htmlName + ((Object) this).toString(), documentBase, codeBase,
1333             commandOptions, this);
1334
1335     viewer.setJmolStatusListener(this); // extends JmolCallbackListener
1336
1337     console = createJmolConsole(consolePanel, buttonsToShow);
1338     if (consolePanel != null)
1339     {
1340       consolePanel.addComponentListener(this);
1341
1342     }
1343
1344   }
1345
1346   protected abstract JmolAppConsoleInterface createJmolConsole(
1347           Container consolePanel, String buttonsToShow);
1348
1349   protected org.jmol.api.JmolAppConsoleInterface console = null;
1350
1351   @Override
1352   public void setBackgroundColour(java.awt.Color col)
1353   {
1354     jmolHistory(false);
1355     viewer.evalStringQuiet("background [" + col.getRed() + ","
1356             + col.getGreen() + "," + col.getBlue() + "];");
1357     jmolHistory(true);
1358   }
1359
1360   @Override
1361   public int[] resizeInnerPanel(String data)
1362   {
1363     // Jalview doesn't honour resize panel requests
1364     return null;
1365   }
1366
1367   /**
1368    *
1369    */
1370   protected void closeConsole()
1371   {
1372     if (console != null)
1373     {
1374       try
1375       {
1376         console.setVisible(false);
1377       } catch (Error e)
1378       {
1379       } catch (Exception x)
1380       {
1381       }
1382       ;
1383       console = null;
1384     }
1385   }
1386
1387   /**
1388    * ComponentListener method
1389    */
1390   @Override
1391   public void componentMoved(ComponentEvent e)
1392   {
1393   }
1394
1395   /**
1396    * ComponentListener method
1397    */
1398   @Override
1399   public void componentResized(ComponentEvent e)
1400   {
1401   }
1402
1403   /**
1404    * ComponentListener method
1405    */
1406   @Override
1407   public void componentShown(ComponentEvent e)
1408   {
1409     showConsole(true);
1410   }
1411
1412   /**
1413    * ComponentListener method
1414    */
1415   @Override
1416   public void componentHidden(ComponentEvent e)
1417   {
1418     showConsole(false);
1419   }
1420
1421   @Override
1422   public void showStructures(AlignViewportI av)
1423   {
1424     // TODO show Jmol structure optionally restricted to visible alignment
1425   }
1426 }