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.AlignmentViewPanel;
  24 import jalview.api.FeatureRenderer;
  25 import jalview.api.SequenceRenderer;
  26 import jalview.datamodel.AlignmentI;
  27 import jalview.datamodel.HiddenColumns;
  28 import jalview.datamodel.PDBEntry;
  29 import jalview.datamodel.SequenceI;
  30 import jalview.gui.IProgressIndicator;
  31 import jalview.io.DataSourceType;
  32 import jalview.io.StructureFile;
  33 import jalview.schemes.ColourSchemeI;
  34 import jalview.schemes.ResidueProperties;
  35 import jalview.structure.AtomSpec;
  36 import jalview.structure.StructureMappingcommandSet;
  37 import jalview.structure.StructureSelectionManager;
  38 import jalview.structures.models.AAStructureBindingModel;
  39 import jalview.util.MessageManager;
  40
  41 import java.awt.Color;
  42 import java.awt.Container;
  43 import java.awt.event.ComponentEvent;
  44 import java.awt.event.ComponentListener;
  45 import java.io.File;
  46 import java.net.URL;
  47 import java.security.AccessControlException;
  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   // ////////////////////////////////
 618   // /StructureListener
 619   // @Override
 620   public synchronized String[] getPdbFilex()
 621   {
 622     if (viewer == null)
 623     {
 624       return new String[0];
 625     }
 626     if (modelFileNames == null)
 627     {
 628       List<String> mset = new ArrayList<>();
 629       _modelFileNameMap = new int[viewer.ms.mc];
 630       String m = viewer.ms.getModelFileName(0);
 631       if (m != null)
 632       {
 633         String filePath = m;
 634         try
 635         {
 636           filePath = new File(m).getAbsolutePath();
 637         } catch (AccessControlException x)
 638         {
 639           // usually not allowed to do this in applet
 640           System.err.println(
 641                   "jmolBinding: Using local file string from Jmol: " + m);
 642         }
 643         if (filePath.indexOf("/file:") != -1)
 644         {
 645           // applet path with docroot - discard as format won't match pdbfile
 646           filePath = m;
 647         }
 648         mset.add(filePath);
 649         _modelFileNameMap[0] = 0; // filename index for first model is always 0.
 650       }
 651       int j = 1;
 652       for (int i = 1; i < viewer.ms.mc; i++)
 653       {
 654         m = viewer.ms.getModelFileName(i);
 655         String filePath = m;
 656         if (m != null)
 657         {
 658           try
 659           {
 660             filePath = new File(m).getAbsolutePath();
 661           } catch (AccessControlException x)
 662           {
 663             // usually not allowed to do this in applet, so keep raw handle
 664             // System.err.println("jmolBinding: Using local file string from
 665             // Jmol: "+m);
 666           }
 667         }
 668
 669         /*
 670          * add this model unless it is read from a structure file we have
 671          * already seen (example: 2MJW is an NMR structure with 10 models)
 672          */
 673         if (!mset.contains(filePath))
 674         {
 675           mset.add(filePath);
 676           _modelFileNameMap[j] = i; // record the model index for the filename
 677           j++;
 678         }
 679       }
 680       modelFileNames = mset.toArray(new String[mset.size()]);
 681     }
 682     return modelFileNames;
 683   }
 684
 685   @Override
 686   public synchronized String[] getStructureFiles()
 687   {
 688     List<String> mset = new ArrayList<>();
 689     if (viewer == null)
 690     {
 691       return new String[0];
 692     }
 693
 694     if (modelFileNames == null)
 695     {
 696       int modelCount = viewer.ms.mc;
 697       String filePath = null;
 698       for (int i = 0; i < modelCount; ++i)
 699       {
 700         filePath = viewer.ms.getModelFileName(i);
 701         if (!mset.contains(filePath))
 702         {
 703           mset.add(filePath);
 704         }
 705       }
 706       modelFileNames = mset.toArray(new String[mset.size()]);
 707     }
 708
 709     return modelFileNames;
 710   }
 711
 712   /**
 713    * map from string to applet
 714    */
 715   @Override
 716   public Map<String, Object> getRegistryInfo()
 717   {
 718     // TODO Auto-generated method stub
 719     return null;
 720   }
 721
 722   // ///////////////////////////////
 723   // JmolStatusListener
 724
 725   public void handlePopupMenu(int x, int y)
 726   {
 727     // jmolpopup.show(x, y);
 728     // jmolpopup.jpiShow(x, y);
 729   }
 730
 731   /**
 732    * Highlight zero, one or more atoms on the structure
 733    */
 734   @Override
 735   public void highlightAtoms(List<AtomSpec> atoms)
 736   {
 737     if (atoms != null)
 738     {
 739       if (resetLastRes.length() > 0)
 740       {
 741         viewer.evalStringQuiet(resetLastRes.toString());
 742         resetLastRes.setLength(0);
 743       }
 744       for (AtomSpec atom : atoms)
 745       {
 746         highlightAtom(atom.getAtomIndex(), atom.getPdbResNum(),
 747                 atom.getChain(), atom.getPdbFile());
 748       }
 749     }
 750   }
 751
 752   // jmol/ssm only
 753   public void highlightAtom(int atomIndex, int pdbResNum, String chain,
 754           String pdbfile)
 755   {
 756     if (modelFileNames == null)
 757     {
 758       return;
 759     }
 760
 761     // look up file model number for this pdbfile
 762     int mdlNum = 0;
 763     // may need to adjust for URLencoding here - we don't worry about that yet.
 764     while (mdlNum < modelFileNames.length
 765             && !pdbfile.equals(modelFileNames[mdlNum]))
 766     {
 767       mdlNum++;
 768     }
 769     if (mdlNum == modelFileNames.length)
 770     {
 771       return;
 772     }
 773
 774     jmolHistory(false);
 775
 776     StringBuilder cmd = new StringBuilder(64);
 777     cmd.append("select " + pdbResNum); // +modelNum
 778
 779     resetLastRes.append("select " + pdbResNum); // +modelNum
 780
 781     cmd.append(":");
 782     resetLastRes.append(":");
 783     if (!chain.equals(" "))
 784     {
 785       cmd.append(chain);
 786       resetLastRes.append(chain);
 787     }
 788     {
 789       cmd.append(" /" + (mdlNum + 1));
 790       resetLastRes.append("/" + (mdlNum + 1));
 791     }
 792     cmd.append(";wireframe 100;" + cmd.toString() + " and not hetero;");
 793
 794     resetLastRes.append(";wireframe 0;" + resetLastRes.toString()
 795             + " and not hetero; spacefill 0;");
 796
 797     cmd.append("spacefill 200;select none");
 798
 799     viewer.evalStringQuiet(cmd.toString());
 800     jmolHistory(true);
 801
 802   }
 803
 804   boolean debug = true;
 805
 806   private void jmolHistory(boolean enable)
 807   {
 808     viewer.evalStringQuiet("History " + ((debug || enable) ? "on" : "off"));
 809   }
 810
 811   public void loadInline(String string)
 812   {
 813     loadedInline = true;
 814     // TODO: re JAL-623
 815     // viewer.loadInline(strModel, isAppend);
 816     // could do this:
 817     // construct fake fullPathName and fileName so we can identify the file
 818     // later.
 819     // Then, construct pass a reader for the string to Jmol.
 820     // ((org.jmol.Viewer.Viewer) viewer).loadModelFromFile(fullPathName,
 821     // fileName, null, reader, false, null, null, 0);
 822     viewer.openStringInline(string);
 823   }
 824
 825   public void mouseOverStructure(int atomIndex, String strInfo)
 826   {
 827     int pdbResNum;
 828     int alocsep = strInfo.indexOf("^");
 829     int mdlSep = strInfo.indexOf("/");
 830     int chainSeparator = strInfo.indexOf(":"), chainSeparator1 = -1;
 831
 832     if (chainSeparator == -1)
 833     {
 834       chainSeparator = strInfo.indexOf(".");
 835       if (mdlSep > -1 && mdlSep < chainSeparator)
 836       {
 837         chainSeparator1 = chainSeparator;
 838         chainSeparator = mdlSep;
 839       }
 840     }
 841     // handle insertion codes
 842     if (alocsep != -1)
 843     {
 844       pdbResNum = Integer.parseInt(
 845               strInfo.substring(strInfo.indexOf("]") + 1, alocsep));
 846
 847     }
 848     else
 849     {
 850       pdbResNum = Integer.parseInt(
 851               strInfo.substring(strInfo.indexOf("]") + 1, chainSeparator));
 852     }
 853     String chainId;
 854
 855     if (strInfo.indexOf(":") > -1)
 856     {
 857       chainId = strInfo.substring(strInfo.indexOf(":") + 1,
 858               strInfo.indexOf("."));
 859     }
 860     else
 861     {
 862       chainId = " ";
 863     }
 864
 865     String pdbfilename = modelFileNames[frameNo]; // default is first or current
 866     // model
 867     if (mdlSep > -1)
 868     {
 869       if (chainSeparator1 == -1)
 870       {
 871         chainSeparator1 = strInfo.indexOf(".", mdlSep);
 872       }
 873       String mdlId = (chainSeparator1 > -1)
 874               ? strInfo.substring(mdlSep + 1, chainSeparator1)
 875               : strInfo.substring(mdlSep + 1);
 876       try
 877       {
 878         // recover PDB filename for the model hovered over.
 879         int _mp = _modelFileNameMap.length - 1,
 880                 mnumber = new Integer(mdlId).intValue() - 1;
 881         while (mnumber < _modelFileNameMap[_mp])
 882         {
 883           _mp--;
 884         }
 885         pdbfilename = modelFileNames[_mp];
 886         if (pdbfilename == null)
 887         {
 888           pdbfilename = new File(viewer.ms.getModelFileName(mnumber))
 889                   .getAbsolutePath();
 890         }
 891
 892       } catch (Exception e)
 893       {
 894       }
 895       ;
 896     }
 897     if (lastMessage == null || !lastMessage.equals(strInfo))
 898     {
 899       getSsm().mouseOverStructure(pdbResNum, chainId, pdbfilename);
 900     }
 901
 902     lastMessage = strInfo;
 903   }
 904
 905   public void notifyAtomHovered(int atomIndex, String strInfo, String data)
 906   {
 907     if (data != null)
 908     {
 909       System.err.println("Ignoring additional hover info: " + data
 910               + " (other info: '" + strInfo + "' pos " + atomIndex + ")");
 911     }
 912     mouseOverStructure(atomIndex, strInfo);
 913   }
 914
 915   /*
 916    * { if (history != null && strStatus != null &&
 917    * !strStatus.equals("Script completed")) { history.append("\n" + strStatus);
 918    * } }
 919    */
 920
 921   public void notifyAtomPicked(int atomIndex, String strInfo,
 922           String strData)
 923   {
 924     /**
 925      * this implements the toggle label behaviour copied from the original
 926      * structure viewer, MCView
 927      */
 928     if (strData != null)
 929     {
 930       System.err.println("Ignoring additional pick data string " + strData);
 931     }
 932     int chainSeparator = strInfo.indexOf(":");
 933     int p = 0;
 934     if (chainSeparator == -1)
 935     {
 936       chainSeparator = strInfo.indexOf(".");
 937     }
 938
 939     String picked = strInfo.substring(strInfo.indexOf("]") + 1,
 940             chainSeparator);
 941     String mdlString = "";
 942     if ((p = strInfo.indexOf(":")) > -1)
 943     {
 944       picked += strInfo.substring(p, strInfo.indexOf("."));
 945     }
 946
 947     if ((p = strInfo.indexOf("/")) > -1)
 948     {
 949       mdlString += strInfo.substring(p, strInfo.indexOf(" #"));
 950     }
 951     picked = "((" + picked + ".CA" + mdlString + ")|(" + picked + ".P"
 952             + mdlString + "))";
 953     jmolHistory(false);
 954
 955     if (!atomsPicked.contains(picked))
 956     {
 957       viewer.evalStringQuiet("select " + picked + ";label %n %r:%c");
 958       atomsPicked.addElement(picked);
 959     }
 960     else
 961     {
 962       viewer.evalString("select " + picked + ";label off");
 963       atomsPicked.removeElement(picked);
 964     }
 965     jmolHistory(true);
 966     // TODO: in application this happens
 967     //
 968     // if (scriptWindow != null)
 969     // {
 970     // scriptWindow.sendConsoleMessage(strInfo);
 971     // scriptWindow.sendConsoleMessage("\n");
 972     // }
 973
 974   }
 975
 976   @Override
 977   public void notifyCallback(CBK type, Object[] data)
 978   {
 979     try
 980     {
 981       switch (type)
 982       {
 983       case LOADSTRUCT:
 984         notifyFileLoaded((String) data[1], (String) data[2],
 985                 (String) data[3], (String) data[4],
 986                 ((Integer) data[5]).intValue());
 987
 988         break;
 989       case PICK:
 990         notifyAtomPicked(((Integer) data[2]).intValue(), (String) data[1],
 991                 (String) data[0]);
 992         // also highlight in alignment
 993         // deliberate fall through
 994       case HOVER:
 995         notifyAtomHovered(((Integer) data[2]).intValue(), (String) data[1],
 996                 (String) data[0]);
 997         break;
 998       case SCRIPT:
 999         notifyScriptTermination((String) data[2],
1000                 ((Integer) data[3]).intValue());
1001         break;
1002       case ECHO:
1003         sendConsoleEcho((String) data[1]);
1004         break;
1005       case MESSAGE:
1006         sendConsoleMessage(
1007                 (data == null) ? ((String) null) : (String) data[1]);
1008         break;
1009       case ERROR:
1010         // System.err.println("Ignoring error callback.");
1011         break;
1012       case SYNC:
1013       case RESIZE:
1014         refreshGUI();
1015         break;
1016       case MEASURE:
1017
1018       case CLICK:
1019       default:
1020         System.err.println(
1021                 "Unhandled callback " + type + " " + data[1].toString());
1022         break;
1023       }
1024     } catch (Exception e)
1025     {
1026       System.err.println("Squashed Jmol callback handler error:");
1027       e.printStackTrace();
1028     }
1029   }
1030
1031   @Override
1032   public boolean notifyEnabled(CBK callbackPick)
1033   {
1034     switch (callbackPick)
1035     {
1036     case ECHO:
1037     case LOADSTRUCT:
1038     case MEASURE:
1039     case MESSAGE:
1040     case PICK:
1041     case SCRIPT:
1042     case HOVER:
1043     case ERROR:
1044       return true;
1045     default:
1046       return false;
1047     }
1048   }
1049
1050   // incremented every time a load notification is successfully handled -
1051   // lightweight mechanism for other threads to detect when they can start
1052   // referrring to new structures.
1053   private long loadNotifiesHandled = 0;
1054
1055   public long getLoadNotifiesHandled()
1056   {
1057     return loadNotifiesHandled;
1058   }
1059
1060   public void notifyFileLoaded(String fullPathName, String fileName2,
1061           String modelName, String errorMsg, int modelParts)
1062   {
1063     if (errorMsg != null)
1064     {
1065       fileLoadingError = errorMsg;
1066       refreshGUI();
1067       return;
1068     }
1069     // TODO: deal sensibly with models loaded inLine:
1070     // modelName will be null, as will fullPathName.
1071
1072     // the rest of this routine ignores the arguments, and simply interrogates
1073     // the Jmol view to find out what structures it contains, and adds them to
1074     // the structure selection manager.
1075     fileLoadingError = null;
1076     String[] oldmodels = modelFileNames;
1077     modelFileNames = null;
1078     chainNames = new ArrayList<>();
1079     chainFile = new Hashtable<>();
1080     boolean notifyLoaded = false;
1081     String[] modelfilenames = getStructureFiles();
1082     // first check if we've lost any structures
1083     if (oldmodels != null && oldmodels.length > 0)
1084     {
1085       int oldm = 0;
1086       for (int i = 0; i < oldmodels.length; i++)
1087       {
1088         for (int n = 0; n < modelfilenames.length; n++)
1089         {
1090           if (modelfilenames[n] == oldmodels[i])
1091           {
1092             oldmodels[i] = null;
1093             break;
1094           }
1095         }
1096         if (oldmodels[i] != null)
1097         {
1098           oldm++;
1099         }
1100       }
1101       if (oldm > 0)
1102       {
1103         String[] oldmfn = new String[oldm];
1104         oldm = 0;
1105         for (int i = 0; i < oldmodels.length; i++)
1106         {
1107           if (oldmodels[i] != null)
1108           {
1109             oldmfn[oldm++] = oldmodels[i];
1110           }
1111         }
1112         // deregister the Jmol instance for these structures - we'll add
1113         // ourselves again at the end for the current structure set.
1114         getSsm().removeStructureViewerListener(this, oldmfn);
1115       }
1116     }
1117     refreshPdbEntries();
1118     for (int modelnum = 0; modelnum < modelfilenames.length; modelnum++)
1119     {
1120       String fileName = modelfilenames[modelnum];
1121       boolean foundEntry = false;
1122       StructureFile pdb = null;
1123       String pdbfile = null;
1124       // model was probably loaded inline - so check the pdb file hashcode
1125       if (loadedInline)
1126       {
1127         // calculate essential attributes for the pdb data imported inline.
1128         // prolly need to resolve modelnumber properly - for now just use our
1129         // 'best guess'
1130         pdbfile = viewer.getData(
1131                 "" + (1 + _modelFileNameMap[modelnum]) + ".0", "PDB");
1132       }
1133       // search pdbentries and sequences to find correct pdbentry for this
1134       // model
1135       for (int pe = 0; pe < getPdbCount(); pe++)
1136       {
1137         boolean matches = false;
1138         addSequence(pe, getSequence()[pe]);
1139         if (fileName == null)
1140         {
1141           if (false)
1142           // see JAL-623 - need method of matching pasted data up
1143           {
1144             pdb = getSsm().setMapping(getSequence()[pe], getChains()[pe],
1145                     pdbfile, DataSourceType.PASTE,
1146                     getIProgressIndicator());
1147             getPdbEntry(modelnum).setFile("INLINE" + pdb.getId());
1148             matches = true;
1149             foundEntry = true;
1150           }
1151         }
1152         else
1153         {
1154           File fl = new File(getPdbEntry(pe).getFile());
1155           matches = fl.equals(new File(fileName));
1156           if (matches)
1157           {
1158             foundEntry = true;
1159             // TODO: Jmol can in principle retrieve from CLASSLOADER but
1160             // this
1161             // needs
1162             // to be tested. See mantis bug
1163             // https://mantis.lifesci.dundee.ac.uk/view.php?id=36605
1164             DataSourceType protocol = DataSourceType.URL;
1165             try
1166             {
1167               if (fl.exists())
1168               {
1169                 protocol = DataSourceType.FILE;
1170               }
1171             } catch (Exception e)
1172             {
1173             } catch (Error e)
1174             {
1175             }
1176             // Explicitly map to the filename used by Jmol ;
1177             pdb = getSsm().setMapping(getSequence()[pe], getChains()[pe],
1178                     fileName, protocol, getIProgressIndicator());
1179             // pdbentry[pe].getFile(), protocol);
1180
1181           }
1182         }
1183         if (matches)
1184         {
1185           // add an entry for every chain in the model
1186           for (int i = 0; i < pdb.getChains().size(); i++)
1187           {
1188             String chid = new String(
1189                     pdb.getId() + ":" + pdb.getChains().elementAt(i).id);
1190             chainFile.put(chid, fileName);
1191             chainNames.add(chid);
1192           }
1193           notifyLoaded = true;
1194         }
1195       }
1196
1197       if (!foundEntry && associateNewStructs)
1198       {
1199         // this is a foreign pdb file that jalview doesn't know about - add
1200         // it to the dataset and try to find a home - either on a matching
1201         // sequence or as a new sequence.
1202         String pdbcontent = viewer.getData("/" + (modelnum + 1) + ".1",
1203                 "PDB");
1204         // parse pdb file into a chain, etc.
1205         // locate best match for pdb in associated views and add mapping to
1206         // ssm
1207         // if properly registered then
1208         notifyLoaded = true;
1209
1210       }
1211     }
1212     // FILE LOADED OK
1213     // so finally, update the jmol bits and pieces
1214     // if (jmolpopup != null)
1215     // {
1216     // // potential for deadlock here:
1217     // // jmolpopup.updateComputedMenus();
1218     // }
1219     if (!isLoadingFromArchive())
1220     {
1221       viewer.evalStringQuiet(
1222               "model *; select backbone;restrict;cartoon;wireframe off;spacefill off");
1223     }
1224     // register ourselves as a listener and notify the gui that it needs to
1225     // update itself.
1226     getSsm().addStructureViewerListener(this);
1227     if (notifyLoaded)
1228     {
1229       FeatureRenderer fr = getFeatureRenderer(null);
1230       if (fr != null)
1231       {
1232         fr.featuresAdded();
1233       }
1234       refreshGUI();
1235       loadNotifiesHandled++;
1236     }
1237     setLoadingFromArchive(false);
1238   }
1239
1240   @Override
1241   public List<String> getChainNames()
1242   {
1243     return chainNames;
1244   }
1245
1246   protected abstract IProgressIndicator getIProgressIndicator();
1247
1248   public void notifyNewPickingModeMeasurement(int iatom, String strMeasure)
1249   {
1250     notifyAtomPicked(iatom, strMeasure, null);
1251   }
1252
1253   public abstract void notifyScriptTermination(String strStatus,
1254           int msWalltime);
1255
1256   /**
1257    * display a message echoed from the jmol viewer
1258    *
1259    * @param strEcho
1260    */
1261   public abstract void sendConsoleEcho(String strEcho); /*
1262                                                          * { showConsole(true);
1263                                                          *
1264                                                          * history.append("\n" +
1265                                                          * strEcho); }
1266                                                          */
1267
1268   // /End JmolStatusListener
1269   // /////////////////////////////
1270
1271   /**
1272    * @param strStatus
1273    *          status message - usually the response received after a script
1274    *          executed
1275    */
1276   public abstract void sendConsoleMessage(String strStatus);
1277
1278   @Override
1279   public void setCallbackFunction(String callbackType,
1280           String callbackFunction)
1281   {
1282     System.err.println("Ignoring set-callback request to associate "
1283             + callbackType + " with function " + callbackFunction);
1284
1285   }
1286
1287   @Override
1288   public void setJalviewColourScheme(ColourSchemeI cs)
1289   {
1290     colourBySequence = false;
1291
1292     if (cs == null)
1293     {
1294       return;
1295     }
1296
1297     jmolHistory(false);
1298     StringBuilder command = new StringBuilder(128);
1299     command.append("select *;color white;");
1300     List<String> residueSet = ResidueProperties.getResidues(isNucleotide(),
1301             false);
1302     for (String resName : residueSet)
1303     {
1304       char res = resName.length() == 3
1305               ? ResidueProperties.getSingleCharacterCode(resName)
1306               : resName.charAt(0);
1307       Color col = cs.findColour(res, 0, null, null, 0f);
1308       command.append("select " + resName + ";color[" + col.getRed() + ","
1309               + col.getGreen() + "," + col.getBlue() + "];");
1310     }
1311
1312     evalStateCommand(command.toString());
1313     jmolHistory(true);
1314   }
1315
1316   public void showHelp()
1317   {
1318     showUrl("http://jmol.sourceforge.net/docs/JmolUserGuide/", "jmolHelp");
1319   }
1320
1321   /**
1322    * open the URL somehow
1323    *
1324    * @param target
1325    */
1326   public abstract void showUrl(String url, String target);
1327
1328   /**
1329    * called when the binding thinks the UI needs to be refreshed after a Jmol
1330    * state change. this could be because structures were loaded, or because an
1331    * error has occured.
1332    */
1333   public abstract void refreshGUI();
1334
1335   /**
1336    * called to show or hide the associated console window container.
1337    *
1338    * @param show
1339    */
1340   public abstract void showConsole(boolean show);
1341
1342   /**
1343    * @param renderPanel
1344    * @param jmolfileio
1345    *          - when true will initialise jmol's file IO system (should be false
1346    *          in applet context)
1347    * @param htmlName
1348    * @param documentBase
1349    * @param codeBase
1350    * @param commandOptions
1351    */
1352   public void allocateViewer(Container renderPanel, boolean jmolfileio,
1353           String htmlName, URL documentBase, URL codeBase,
1354           String commandOptions)
1355   {
1356     allocateViewer(renderPanel, jmolfileio, htmlName, documentBase,
1357             codeBase, commandOptions, null, null);
1358   }
1359
1360   /**
1361    *
1362    * @param renderPanel
1363    * @param jmolfileio
1364    *          - when true will initialise jmol's file IO system (should be false
1365    *          in applet context)
1366    * @param htmlName
1367    * @param documentBase
1368    * @param codeBase
1369    * @param commandOptions
1370    * @param consolePanel
1371    *          - panel to contain Jmol console
1372    * @param buttonsToShow
1373    *          - buttons to show on the console, in ordr
1374    */
1375   public void allocateViewer(Container renderPanel, boolean jmolfileio,
1376           String htmlName, URL documentBase, URL codeBase,
1377           String commandOptions, final Container consolePanel,
1378           String buttonsToShow)
1379   {
1380     if (commandOptions == null)
1381     {
1382       commandOptions = "";
1383     }
1384     viewer = (Viewer) JmolViewer.allocateViewer(renderPanel,
1385             (jmolfileio ? new SmarterJmolAdapter() : null),
1386             htmlName + ((Object) this).toString(), documentBase, codeBase,
1387             commandOptions, this);
1388
1389     viewer.setJmolStatusListener(this); // extends JmolCallbackListener
1390
1391     console = createJmolConsole(consolePanel, buttonsToShow);
1392     if (consolePanel != null)
1393     {
1394       consolePanel.addComponentListener(this);
1395
1396     }
1397
1398   }
1399
1400   protected abstract JmolAppConsoleInterface createJmolConsole(
1401           Container consolePanel, String buttonsToShow);
1402
1403   protected org.jmol.api.JmolAppConsoleInterface console = null;
1404
1405   @Override
1406   public void setBackgroundColour(java.awt.Color col)
1407   {
1408     jmolHistory(false);
1409     viewer.evalStringQuiet("background [" + col.getRed() + ","
1410             + col.getGreen() + "," + col.getBlue() + "];");
1411     jmolHistory(true);
1412   }
1413
1414   @Override
1415   public int[] resizeInnerPanel(String data)
1416   {
1417     // Jalview doesn't honour resize panel requests
1418     return null;
1419   }
1420
1421   /**
1422    *
1423    */
1424   protected void closeConsole()
1425   {
1426     if (console != null)
1427     {
1428       try
1429       {
1430         console.setVisible(false);
1431       } catch (Error e)
1432       {
1433       } catch (Exception x)
1434       {
1435       }
1436       ;
1437       console = null;
1438     }
1439   }
1440
1441   /**
1442    * ComponentListener method
1443    */
1444   @Override
1445   public void componentMoved(ComponentEvent e)
1446   {
1447   }
1448
1449   /**
1450    * ComponentListener method
1451    */
1452   @Override
1453   public void componentResized(ComponentEvent e)
1454   {
1455   }
1456
1457   /**
1458    * ComponentListener method
1459    */
1460   @Override
1461   public void componentShown(ComponentEvent e)
1462   {
1463     showConsole(true);
1464   }
1465
1466   /**
1467    * ComponentListener method
1468    */
1469   @Override
1470   public void componentHidden(ComponentEvent e)
1471   {
1472     showConsole(false);
1473   }
1474 }