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.ColumnSelection;
  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<String>();
  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           ColumnSelection hiddenCols)
 227   {
 228     superposeStructures(new AlignmentI[] { alignment },
 229             new int[] { refStructure },
 230             new ColumnSelection[] { hiddenCols });
 231   }
 232
 233   /**
 234    * {@inheritDoc}
 235    */
 236   @Override
 237   public String superposeStructures(AlignmentI[] _alignment,
 238           int[] _refStructure, ColumnSelection[] _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       ColumnSelection hiddenCols = _hiddenCols[a];
 283       if (a > 0
 284               && selectioncom.length() > 0
 285               && !selectioncom.substring(selectioncom.length() - 1).equals(
 286                       "|"))
 287       {
 288         selectioncom.append("|");
 289       }
 290       // process this alignment
 291       if (refStructure >= files.length)
 292       {
 293         System.err.println("Invalid reference structure value "
 294                 + refStructure);
 295         refStructure = -1;
 296       }
 297
 298       /*
 299        * 'matched' bit j will be set for visible alignment columns j where
 300        * all sequences have a residue with a mapping to the PDB structure
 301        */
 302       BitSet matched = new BitSet();
 303       for (int m = 0; m < alignment.getWidth(); m++)
 304       {
 305         if (hiddenCols == null || hiddenCols.isVisible(m))
 306         {
 307           matched.set(m);
 308         }
 309       }
 310
 311       SuperposeData[] structures = new SuperposeData[files.length];
 312       for (int f = 0; f < files.length; f++)
 313       {
 314         structures[f] = new SuperposeData(alignment.getWidth());
 315       }
 316
 317       /*
 318        * Calculate the superposable alignment columns ('matched'), and the
 319        * corresponding structure residue positions (structures.pdbResNo)
 320        */
 321       int candidateRefStructure = findSuperposableResidues(alignment,
 322               matched, structures);
 323       if (refStructure < 0)
 324       {
 325         /*
 326          * If no reference structure was specified, pick the first one that has
 327          * a mapping in the alignment
 328          */
 329         refStructure = candidateRefStructure;
 330       }
 331
 332       String[] selcom = new String[files.length];
 333       int nmatched = matched.cardinality();
 334       if (nmatched < 4)
 335       {
 336         return (MessageManager.formatMessage(
 337 "label.insufficient_residues",
 338                 nmatched));
 339       }
 340
 341       /*
 342        * generate select statements to select regions to superimpose structures
 343        */
 344       {
 345         // TODO extract method to construct selection statements
 346         for (int pdbfnum = 0; pdbfnum < files.length; pdbfnum++)
 347         {
 348           String chainCd = ":" + structures[pdbfnum].chain;
 349           int lpos = -1;
 350           boolean run = false;
 351           StringBuilder molsel = new StringBuilder();
 352           molsel.append("{");
 353
 354           int nextColumnMatch = matched.nextSetBit(0);
 355           while (nextColumnMatch != -1)
 356           {
 357             int pdbResNo = structures[pdbfnum].pdbResNo[nextColumnMatch];
 358             if (lpos != pdbResNo - 1)
 359             {
 360               // discontinuity
 361               if (lpos != -1)
 362               {
 363                 molsel.append(lpos);
 364                 molsel.append(chainCd);
 365                 molsel.append("|");
 366               }
 367               run = false;
 368             }
 369             else
 370             {
 371               // continuous run - and lpos >-1
 372               if (!run)
 373               {
 374                 // at the beginning, so add dash
 375                 molsel.append(lpos);
 376                 molsel.append("-");
 377               }
 378               run = true;
 379             }
 380             lpos = pdbResNo;
 381             nextColumnMatch = matched.nextSetBit(nextColumnMatch + 1);
 382           }
 383           /*
 384            * add final selection phrase
 385            */
 386           if (lpos != -1)
 387           {
 388             molsel.append(lpos);
 389             molsel.append(chainCd);
 390             molsel.append("}");
 391           }
 392           if (molsel.length() > 1)
 393           {
 394             selcom[pdbfnum] = molsel.toString();
 395             selectioncom.append("((");
 396             selectioncom.append(selcom[pdbfnum].substring(1,
 397                     selcom[pdbfnum].length() - 1));
 398             selectioncom.append(" )& ");
 399             selectioncom.append(pdbfnum + 1);
 400             selectioncom.append(".1)");
 401             if (pdbfnum < files.length - 1)
 402             {
 403               selectioncom.append("|");
 404             }
 405           }
 406           else
 407           {
 408             selcom[pdbfnum] = null;
 409           }
 410         }
 411       }
 412       StringBuilder command = new StringBuilder(256);
 413       // command.append("set spinFps 10;\n");
 414
 415       for (int pdbfnum = 0; pdbfnum < files.length; pdbfnum++)
 416       {
 417         if (pdbfnum == refStructure || selcom[pdbfnum] == null
 418                 || selcom[refStructure] == null)
 419         {
 420           continue;
 421         }
 422         command.append("echo ");
 423         command.append("\"Superposing (");
 424         command.append(structures[pdbfnum].pdbId);
 425         command.append(") against reference (");
 426         command.append(structures[refStructure].pdbId);
 427         command.append(")\";\ncompare " + nSeconds);
 428         command.append("{");
 429         command.append(Integer.toString(1 + pdbfnum));
 430         command.append(".1} {");
 431         command.append(Integer.toString(1 + refStructure));
 432         // conformation=1 excludes alternate locations for CA (JAL-1757)
 433         command.append(".1} SUBSET {(*.CA | *.P) and conformation=1} ATOMS ");
 434
 435         // for (int s = 0; s < 2; s++)
 436         // {
 437         // command.append(selcom[(s == 0 ? pdbfnum : refStructure)]);
 438         // }
 439         command.append(selcom[pdbfnum]);
 440         command.append(selcom[refStructure]);
 441         command.append(" ROTATE TRANSLATE;\n");
 442       }
 443       if (selectioncom.length() > 0)
 444       {
 445         // TODO is performing selectioncom redundant here? is done later on
 446         // System.out.println("Select regions:\n" + selectioncom.toString());
 447         evalStateCommand("select *; cartoons off; backbone; select ("
 448                 + selectioncom.toString() + "); cartoons; ");
 449         // selcom.append("; ribbons; ");
 450         String cmdString = command.toString();
 451         // System.out.println("Superimpose command(s):\n" + cmdString);
 452
 453         evalStateCommand(cmdString);
 454       }
 455     }
 456     if (selectioncom.length() > 0)
 457     {// finally, mark all regions that were superposed.
 458       if (selectioncom.substring(selectioncom.length() - 1).equals("|"))
 459       {
 460         selectioncom.setLength(selectioncom.length() - 1);
 461       }
 462       // System.out.println("Select regions:\n" + selectioncom.toString());
 463       evalStateCommand("select *; cartoons off; backbone; select ("
 464               + selectioncom.toString() + "); cartoons; ");
 465       // evalStateCommand("select *; backbone; select "+selcom.toString()+"; cartoons; center "+selcom.toString());
 466     }
 467
 468     return null;
 469   }
 470
 471   public void evalStateCommand(String command)
 472   {
 473     jmolHistory(false);
 474     if (lastCommand == null || !lastCommand.equals(command))
 475     {
 476       viewer.evalStringQuiet(command + "\n");
 477     }
 478     jmolHistory(true);
 479     lastCommand = command;
 480   }
 481
 482   /**
 483    * Sends a set of colour commands to the structure viewer
 484    *
 485    * @param colourBySequenceCommands
 486    */
 487   @Override
 488   protected void colourBySequence(
 489           StructureMappingcommandSet[] colourBySequenceCommands)
 490   {
 491     for (StructureMappingcommandSet cpdbbyseq : colourBySequenceCommands)
 492     {
 493       for (String cbyseq : cpdbbyseq.commands)
 494       {
 495         executeWhenReady(cbyseq);
 496       }
 497     }
 498   }
 499
 500   /**
 501    * @param files
 502    * @param sr
 503    * @param viewPanel
 504    * @return
 505    */
 506   @Override
 507   protected StructureMappingcommandSet[] getColourBySequenceCommands(
 508           String[] files, SequenceRenderer sr, AlignmentViewPanel viewPanel)
 509   {
 510     return JmolCommands.getColourBySequenceCommand(getSsm(), files,
 511             getSequence(), sr, viewPanel);
 512   }
 513
 514   /**
 515    * @param command
 516    */
 517   protected void executeWhenReady(String command)
 518   {
 519     evalStateCommand(command);
 520   }
 521
 522   public void createImage(String file, String type, int quality)
 523   {
 524     System.out.println("JMOL CREATE IMAGE");
 525   }
 526
 527   @Override
 528   public String createImage(String fileName, String type,
 529           Object textOrBytes, int quality)
 530   {
 531     System.out.println("JMOL CREATE IMAGE");
 532     return null;
 533   }
 534
 535   @Override
 536   public String eval(String strEval)
 537   {
 538     // System.out.println(strEval);
 539     // "# 'eval' is implemented only for the applet.";
 540     return null;
 541   }
 542
 543   // End StructureListener
 544   // //////////////////////////
 545
 546   @Override
 547   public float[][] functionXY(String functionName, int x, int y)
 548   {
 549     return null;
 550   }
 551
 552   @Override
 553   public float[][][] functionXYZ(String functionName, int nx, int ny, int nz)
 554   {
 555     // TODO Auto-generated method stub
 556     return null;
 557   }
 558
 559   public Color getColour(int atomIndex, int pdbResNum, String chain,
 560           String pdbfile)
 561   {
 562     if (getModelNum(pdbfile) < 0)
 563     {
 564       return null;
 565     }
 566     // TODO: verify atomIndex is selecting correct model.
 567     // return new Color(viewer.getAtomArgb(atomIndex)); Jmol 12.2.4
 568     int colour = viewer.ms.at[atomIndex].atomPropertyInt(T.color);
 569     return new Color(colour);
 570   }
 571
 572   /**
 573    * instruct the Jalview binding to update the pdbentries vector if necessary
 574    * prior to matching the jmol view's contents to the list of structure files
 575    * Jalview knows about.
 576    */
 577   public abstract void refreshPdbEntries();
 578
 579   private int getModelNum(String modelFileName)
 580   {
 581     String[] mfn = getStructureFiles();
 582     if (mfn == null)
 583     {
 584       return -1;
 585     }
 586     for (int i = 0; i < mfn.length; i++)
 587     {
 588       if (mfn[i].equalsIgnoreCase(modelFileName))
 589       {
 590         return i;
 591       }
 592     }
 593     return -1;
 594   }
 595
 596   /**
 597    * map between index of model filename returned from getPdbFile and the first
 598    * index of models from this file in the viewer. Note - this is not trimmed -
 599    * use getPdbFile to get number of unique models.
 600    */
 601   private int _modelFileNameMap[];
 602
 603   // ////////////////////////////////
 604   // /StructureListener
 605   // @Override
 606   public synchronized String[] getPdbFilex()
 607   {
 608     if (viewer == null)
 609     {
 610       return new String[0];
 611     }
 612     if (modelFileNames == null)
 613     {
 614       List<String> mset = new ArrayList<String>();
 615       _modelFileNameMap = new int[viewer.ms.mc];
 616       String m = viewer.ms.getModelFileName(0);
 617       if (m != null)
 618       {
 619         String filePath = m;
 620         try
 621         {
 622           filePath = new File(m).getAbsolutePath();
 623         } catch (AccessControlException x)
 624         {
 625           // usually not allowed to do this in applet
 626           System.err
 627                   .println("jmolBinding: Using local file string from Jmol: "
 628                           + m);
 629         }
 630         if (filePath.indexOf("/file:") != -1)
 631         {
 632           // applet path with docroot - discard as format won't match pdbfile
 633           filePath = m;
 634         }
 635         mset.add(filePath);
 636         _modelFileNameMap[0] = 0; // filename index for first model is always 0.
 637       }
 638       int j = 1;
 639       for (int i = 1; i < viewer.ms.mc; i++)
 640       {
 641         m = viewer.ms.getModelFileName(i);
 642         String filePath = m;
 643         if (m != null)
 644         {
 645           try
 646           {
 647             filePath = new File(m).getAbsolutePath();
 648           } catch (AccessControlException x)
 649           {
 650             // usually not allowed to do this in applet, so keep raw handle
 651             // System.err.println("jmolBinding: Using local file string from Jmol: "+m);
 652           }
 653         }
 654
 655         /*
 656          * add this model unless it is read from a structure file we have
 657          * already seen (example: 2MJW is an NMR structure with 10 models)
 658          */
 659         if (!mset.contains(filePath))
 660         {
 661           mset.add(filePath);
 662           _modelFileNameMap[j] = i; // record the model index for the filename
 663           j++;
 664         }
 665       }
 666       modelFileNames = mset.toArray(new String[mset.size()]);
 667     }
 668     return modelFileNames;
 669   }
 670
 671   @Override
 672   public synchronized String[] getStructureFiles()
 673   {
 674     List<String> mset = new ArrayList<String>();
 675     if (viewer == null)
 676     {
 677       return new String[0];
 678     }
 679
 680     if (modelFileNames == null)
 681     {
 682       int modelCount = viewer.ms.mc;
 683       String filePath = null;
 684       for (int i = 0; i < modelCount; ++i)
 685       {
 686         filePath = viewer.ms.getModelFileName(i);
 687         if (!mset.contains(filePath))
 688         {
 689           mset.add(filePath);
 690         }
 691       }
 692       modelFileNames = mset.toArray(new String[mset.size()]);
 693     }
 694
 695     return modelFileNames;
 696   }
 697   /**
 698    * map from string to applet
 699    */
 700   @Override
 701   public Map<String, Object> getRegistryInfo()
 702   {
 703     // TODO Auto-generated method stub
 704     return null;
 705   }
 706
 707
 708
 709   // ///////////////////////////////
 710   // JmolStatusListener
 711
 712   public void handlePopupMenu(int x, int y)
 713   {
 714     // jmolpopup.show(x, y);
 715     // jmolpopup.jpiShow(x, y);
 716   }
 717
 718   /**
 719    * Highlight zero, one or more atoms on the structure
 720    */
 721   @Override
 722   public void highlightAtoms(List<AtomSpec> atoms)
 723   {
 724     if (atoms != null)
 725     {
 726       if (resetLastRes.length() > 0)
 727       {
 728         viewer.evalStringQuiet(resetLastRes.toString());
 729         resetLastRes.setLength(0);
 730       }
 731       for (AtomSpec atom : atoms)
 732       {
 733         highlightAtom(atom.getAtomIndex(), atom.getPdbResNum(),
 734                 atom.getChain(), atom.getPdbFile());
 735       }
 736     }
 737   }
 738
 739   // jmol/ssm only
 740   public void highlightAtom(int atomIndex, int pdbResNum, String chain,
 741           String pdbfile)
 742   {
 743     if (modelFileNames == null)
 744     {
 745       return;
 746     }
 747
 748     // look up file model number for this pdbfile
 749     int mdlNum = 0;
 750     // may need to adjust for URLencoding here - we don't worry about that yet.
 751     while (mdlNum < modelFileNames.length
 752             && !pdbfile.equals(modelFileNames[mdlNum]))
 753     {
 754       mdlNum++;
 755     }
 756     if (mdlNum == modelFileNames.length)
 757     {
 758       return;
 759     }
 760
 761     jmolHistory(false);
 762
 763     StringBuilder cmd = new StringBuilder(64);
 764     cmd.append("select " + pdbResNum); // +modelNum
 765
 766     resetLastRes.append("select " + pdbResNum); // +modelNum
 767
 768     cmd.append(":");
 769     resetLastRes.append(":");
 770     if (!chain.equals(" "))
 771     {
 772       cmd.append(chain);
 773       resetLastRes.append(chain);
 774     }
 775     {
 776       cmd.append(" /" + (mdlNum + 1));
 777       resetLastRes.append("/" + (mdlNum + 1));
 778     }
 779     cmd.append(";wireframe 100;" + cmd.toString() + " and not hetero;");
 780
 781     resetLastRes.append(";wireframe 0;" + resetLastRes.toString()
 782             + " and not hetero; spacefill 0;");
 783
 784     cmd.append("spacefill 200;select none");
 785
 786     viewer.evalStringQuiet(cmd.toString());
 787     jmolHistory(true);
 788
 789   }
 790
 791   boolean debug = true;
 792
 793   private void jmolHistory(boolean enable)
 794   {
 795     viewer.evalStringQuiet("History " + ((debug || enable) ? "on" : "off"));
 796   }
 797
 798   public void loadInline(String string)
 799   {
 800     loadedInline = true;
 801     // TODO: re JAL-623
 802     // viewer.loadInline(strModel, isAppend);
 803     // could do this:
 804     // construct fake fullPathName and fileName so we can identify the file
 805     // later.
 806     // Then, construct pass a reader for the string to Jmol.
 807     // ((org.jmol.Viewer.Viewer) viewer).loadModelFromFile(fullPathName,
 808     // fileName, null, reader, false, null, null, 0);
 809     viewer.openStringInline(string);
 810   }
 811
 812   public void mouseOverStructure(int atomIndex, String strInfo)
 813   {
 814     int pdbResNum;
 815     int alocsep = strInfo.indexOf("^");
 816     int mdlSep = strInfo.indexOf("/");
 817     int chainSeparator = strInfo.indexOf(":"), chainSeparator1 = -1;
 818
 819     if (chainSeparator == -1)
 820     {
 821       chainSeparator = strInfo.indexOf(".");
 822       if (mdlSep > -1 && mdlSep < chainSeparator)
 823       {
 824         chainSeparator1 = chainSeparator;
 825         chainSeparator = mdlSep;
 826       }
 827     }
 828     // handle insertion codes
 829     if (alocsep != -1)
 830     {
 831       pdbResNum = Integer.parseInt(strInfo.substring(
 832               strInfo.indexOf("]") + 1, alocsep));
 833
 834     }
 835     else
 836     {
 837       pdbResNum = Integer.parseInt(strInfo.substring(
 838               strInfo.indexOf("]") + 1, chainSeparator));
 839     }
 840     String chainId;
 841
 842     if (strInfo.indexOf(":") > -1)
 843     {
 844       chainId = strInfo.substring(strInfo.indexOf(":") + 1,
 845               strInfo.indexOf("."));
 846     }
 847     else
 848     {
 849       chainId = " ";
 850     }
 851
 852     String pdbfilename = modelFileNames[frameNo]; // default is first or current
 853     // model
 854     if (mdlSep > -1)
 855     {
 856       if (chainSeparator1 == -1)
 857       {
 858         chainSeparator1 = strInfo.indexOf(".", mdlSep);
 859       }
 860       String mdlId = (chainSeparator1 > -1) ? strInfo.substring(mdlSep + 1,
 861               chainSeparator1) : strInfo.substring(mdlSep + 1);
 862       try
 863       {
 864         // recover PDB filename for the model hovered over.
 865         int _mp = _modelFileNameMap.length - 1, mnumber = new Integer(mdlId)
 866                 .intValue() - 1;
 867         while (mnumber < _modelFileNameMap[_mp])
 868         {
 869           _mp--;
 870         }
 871         pdbfilename = modelFileNames[_mp];
 872         if (pdbfilename == null)
 873         {
 874           pdbfilename = new File(viewer.ms.getModelFileName(mnumber))
 875                   .getAbsolutePath();
 876         }
 877
 878       } catch (Exception e)
 879       {
 880       }
 881       ;
 882     }
 883     if (lastMessage == null || !lastMessage.equals(strInfo))
 884     {
 885       getSsm().mouseOverStructure(pdbResNum, chainId, pdbfilename);
 886     }
 887
 888     lastMessage = strInfo;
 889   }
 890
 891   public void notifyAtomHovered(int atomIndex, String strInfo, String data)
 892   {
 893     if (data != null)
 894     {
 895       System.err.println("Ignoring additional hover info: " + data
 896               + " (other info: '" + strInfo + "' pos " + atomIndex + ")");
 897     }
 898     mouseOverStructure(atomIndex, strInfo);
 899   }
 900
 901   /*
 902    * { if (history != null && strStatus != null &&
 903    * !strStatus.equals("Script completed")) { history.append("\n" + strStatus);
 904    * } }
 905    */
 906
 907   public void notifyAtomPicked(int atomIndex, String strInfo, String strData)
 908   {
 909     /**
 910      * this implements the toggle label behaviour copied from the original
 911      * structure viewer, MCView
 912      */
 913     if (strData != null)
 914     {
 915       System.err.println("Ignoring additional pick data string " + strData);
 916     }
 917     int chainSeparator = strInfo.indexOf(":");
 918     int p = 0;
 919     if (chainSeparator == -1)
 920     {
 921       chainSeparator = strInfo.indexOf(".");
 922     }
 923
 924     String picked = strInfo.substring(strInfo.indexOf("]") + 1,
 925             chainSeparator);
 926     String mdlString = "";
 927     if ((p = strInfo.indexOf(":")) > -1)
 928     {
 929       picked += strInfo.substring(p, strInfo.indexOf("."));
 930     }
 931
 932     if ((p = strInfo.indexOf("/")) > -1)
 933     {
 934       mdlString += strInfo.substring(p, strInfo.indexOf(" #"));
 935     }
 936     picked = "((" + picked + ".CA" + mdlString + ")|(" + picked + ".P"
 937             + mdlString + "))";
 938     jmolHistory(false);
 939
 940     if (!atomsPicked.contains(picked))
 941     {
 942       viewer.evalStringQuiet("select " + picked + ";label %n %r:%c");
 943       atomsPicked.addElement(picked);
 944     }
 945     else
 946     {
 947       viewer.evalString("select " + picked + ";label off");
 948       atomsPicked.removeElement(picked);
 949     }
 950     jmolHistory(true);
 951     // TODO: in application this happens
 952     //
 953     // if (scriptWindow != null)
 954     // {
 955     // scriptWindow.sendConsoleMessage(strInfo);
 956     // scriptWindow.sendConsoleMessage("\n");
 957     // }
 958
 959   }
 960
 961   @Override
 962   public void notifyCallback(CBK type, Object[] data)
 963   {
 964     try
 965     {
 966       switch (type)
 967       {
 968       case LOADSTRUCT:
 969         notifyFileLoaded((String) data[1], (String) data[2],
 970                 (String) data[3], (String) data[4],
 971                 ((Integer) data[5]).intValue());
 972
 973         break;
 974       case PICK:
 975         notifyAtomPicked(((Integer) data[2]).intValue(), (String) data[1],
 976                 (String) data[0]);
 977         // also highlight in alignment
 978       case HOVER:
 979         notifyAtomHovered(((Integer) data[2]).intValue(), (String) data[1],
 980                 (String) data[0]);
 981         break;
 982       case SCRIPT:
 983         notifyScriptTermination((String) data[2],
 984                 ((Integer) data[3]).intValue());
 985         break;
 986       case ECHO:
 987         sendConsoleEcho((String) data[1]);
 988         break;
 989       case MESSAGE:
 990         sendConsoleMessage((data == null) ? ((String) null)
 991                 : (String) data[1]);
 992         break;
 993       case ERROR:
 994         // System.err.println("Ignoring error callback.");
 995         break;
 996       case SYNC:
 997       case RESIZE:
 998         refreshGUI();
 999         break;
1000       case MEASURE:
1001
1002       case CLICK:
1003       default:
1004         System.err.println("Unhandled callback " + type + " "
1005                 + data[1].toString());
1006         break;
1007       }
1008     } catch (Exception e)
1009     {
1010       System.err.println("Squashed Jmol callback handler error:");
1011       e.printStackTrace();
1012     }
1013   }
1014
1015   @Override
1016   public boolean notifyEnabled(CBK callbackPick)
1017   {
1018     switch (callbackPick)
1019     {
1020     case ECHO:
1021     case LOADSTRUCT:
1022     case MEASURE:
1023     case MESSAGE:
1024     case PICK:
1025     case SCRIPT:
1026     case HOVER:
1027     case ERROR:
1028       return true;
1029     default:
1030       return false;
1031     }
1032   }
1033
1034   // incremented every time a load notification is successfully handled -
1035   // lightweight mechanism for other threads to detect when they can start
1036   // referrring to new structures.
1037   private long loadNotifiesHandled = 0;
1038
1039   public long getLoadNotifiesHandled()
1040   {
1041     return loadNotifiesHandled;
1042   }
1043
1044   public void notifyFileLoaded(String fullPathName, String fileName2,
1045           String modelName, String errorMsg, int modelParts)
1046   {
1047     if (errorMsg != null)
1048     {
1049       fileLoadingError = errorMsg;
1050       refreshGUI();
1051       return;
1052     }
1053     // TODO: deal sensibly with models loaded inLine:
1054     // modelName will be null, as will fullPathName.
1055
1056     // the rest of this routine ignores the arguments, and simply interrogates
1057     // the Jmol view to find out what structures it contains, and adds them to
1058     // the structure selection manager.
1059     fileLoadingError = null;
1060     String[] oldmodels = modelFileNames;
1061     modelFileNames = null;
1062     chainNames = new ArrayList<String>();
1063     chainFile = new Hashtable<String, String>();
1064     boolean notifyLoaded = false;
1065     String[] modelfilenames = getStructureFiles();
1066     // first check if we've lost any structures
1067     if (oldmodels != null && oldmodels.length > 0)
1068     {
1069       int oldm = 0;
1070       for (int i = 0; i < oldmodels.length; i++)
1071       {
1072         for (int n = 0; n < modelfilenames.length; n++)
1073         {
1074           if (modelfilenames[n] == oldmodels[i])
1075           {
1076             oldmodels[i] = null;
1077             break;
1078           }
1079         }
1080         if (oldmodels[i] != null)
1081         {
1082           oldm++;
1083         }
1084       }
1085       if (oldm > 0)
1086       {
1087         String[] oldmfn = new String[oldm];
1088         oldm = 0;
1089         for (int i = 0; i < oldmodels.length; i++)
1090         {
1091           if (oldmodels[i] != null)
1092           {
1093             oldmfn[oldm++] = oldmodels[i];
1094           }
1095         }
1096         // deregister the Jmol instance for these structures - we'll add
1097         // ourselves again at the end for the current structure set.
1098         getSsm().removeStructureViewerListener(this, oldmfn);
1099       }
1100     }
1101     refreshPdbEntries();
1102     for (int modelnum = 0; modelnum < modelfilenames.length; modelnum++)
1103     {
1104       String fileName = modelfilenames[modelnum];
1105       boolean foundEntry = false;
1106       StructureFile pdb = null;
1107       String pdbfile = null;
1108       // model was probably loaded inline - so check the pdb file hashcode
1109       if (loadedInline)
1110       {
1111         // calculate essential attributes for the pdb data imported inline.
1112         // prolly need to resolve modelnumber properly - for now just use our
1113         // 'best guess'
1114         pdbfile = viewer.getData("" + (1 + _modelFileNameMap[modelnum])
1115                 + ".0", "PDB");
1116       }
1117       // search pdbentries and sequences to find correct pdbentry for this
1118       // model
1119       for (int pe = 0; pe < getPdbCount(); pe++)
1120       {
1121         boolean matches = false;
1122         addSequence(pe, getSequence()[pe]);
1123         if (fileName == null)
1124         {
1125           if (false)
1126           // see JAL-623 - need method of matching pasted data up
1127           {
1128             pdb = getSsm().setMapping(getSequence()[pe], getChains()[pe],
1129                     pdbfile, DataSourceType.PASTE, getIProgressIndicator());
1130             getPdbEntry(modelnum).setFile("INLINE" + pdb.getId());
1131             matches = true;
1132             foundEntry = true;
1133           }
1134         }
1135         else
1136         {
1137           File fl = new File(getPdbEntry(pe).getFile());
1138           matches = fl.equals(new File(fileName));
1139           if (matches)
1140           {
1141             foundEntry = true;
1142             // TODO: Jmol can in principle retrieve from CLASSLOADER but
1143             // this
1144             // needs
1145             // to be tested. See mantis bug
1146             // https://mantis.lifesci.dundee.ac.uk/view.php?id=36605
1147             DataSourceType protocol = DataSourceType.URL;
1148             try
1149             {
1150               if (fl.exists())
1151               {
1152                 protocol = DataSourceType.FILE;
1153               }
1154             } catch (Exception e)
1155             {
1156             } catch (Error e)
1157             {
1158             }
1159             // Explicitly map to the filename used by Jmol ;
1160             pdb = getSsm().setMapping(getSequence()[pe], getChains()[pe],
1161                     fileName, protocol, getIProgressIndicator());
1162             // pdbentry[pe].getFile(), protocol);
1163
1164           }
1165         }
1166         if (matches)
1167         {
1168           // add an entry for every chain in the model
1169           for (int i = 0; i < pdb.getChains().size(); i++)
1170           {
1171             String chid = new String(pdb.getId() + ":"
1172                     + pdb.getChains().elementAt(i).id);
1173             chainFile.put(chid, fileName);
1174             chainNames.add(chid);
1175           }
1176           notifyLoaded = true;
1177         }
1178       }
1179
1180       if (!foundEntry && associateNewStructs)
1181       {
1182         // this is a foreign pdb file that jalview doesn't know about - add
1183         // it to the dataset and try to find a home - either on a matching
1184         // sequence or as a new sequence.
1185         String pdbcontent = viewer.getData("/" + (modelnum + 1) + ".1",
1186                 "PDB");
1187         // parse pdb file into a chain, etc.
1188         // locate best match for pdb in associated views and add mapping to
1189         // ssm
1190         // if properly registered then
1191         notifyLoaded = true;
1192
1193       }
1194     }
1195     // FILE LOADED OK
1196     // so finally, update the jmol bits and pieces
1197     // if (jmolpopup != null)
1198     // {
1199     // // potential for deadlock here:
1200     // // jmolpopup.updateComputedMenus();
1201     // }
1202     if (!isLoadingFromArchive())
1203     {
1204       viewer.evalStringQuiet("model *; select backbone;restrict;cartoon;wireframe off;spacefill off");
1205     }
1206     // register ourselves as a listener and notify the gui that it needs to
1207     // update itself.
1208     getSsm().addStructureViewerListener(this);
1209     if (notifyLoaded)
1210     {
1211       FeatureRenderer fr = getFeatureRenderer(null);
1212       if (fr != null)
1213       {
1214         fr.featuresAdded();
1215       }
1216       refreshGUI();
1217       loadNotifiesHandled++;
1218     }
1219     setLoadingFromArchive(false);
1220   }
1221
1222   @Override
1223   public List<String> getChainNames()
1224   {
1225     return chainNames;
1226   }
1227
1228   protected abstract IProgressIndicator getIProgressIndicator();
1229
1230   public void notifyNewPickingModeMeasurement(int iatom, String strMeasure)
1231   {
1232     notifyAtomPicked(iatom, strMeasure, null);
1233   }
1234
1235   public abstract void notifyScriptTermination(String strStatus,
1236           int msWalltime);
1237
1238   /**
1239    * display a message echoed from the jmol viewer
1240    *
1241    * @param strEcho
1242    */
1243   public abstract void sendConsoleEcho(String strEcho); /*
1244                                                          * { showConsole(true);
1245                                                          *
1246                                                          * history.append("\n" +
1247                                                          * strEcho); }
1248                                                          */
1249
1250   // /End JmolStatusListener
1251   // /////////////////////////////
1252
1253   /**
1254    * @param strStatus
1255    *          status message - usually the response received after a script
1256    *          executed
1257    */
1258   public abstract void sendConsoleMessage(String strStatus);
1259
1260   @Override
1261   public void setCallbackFunction(String callbackType,
1262           String callbackFunction)
1263   {
1264     System.err.println("Ignoring set-callback request to associate "
1265             + callbackType + " with function " + callbackFunction);
1266
1267   }
1268
1269   @Override
1270   public void setJalviewColourScheme(ColourSchemeI cs)
1271   {
1272     colourBySequence = false;
1273
1274     if (cs == null)
1275     {
1276       return;
1277     }
1278
1279     jmolHistory(false);
1280     StringBuilder command = new StringBuilder(128);
1281     command.append("select *;color white;");
1282     List<String> residueSet = ResidueProperties.getResidues(isNucleotide(),
1283             false);
1284     for (String resName : residueSet)
1285     {
1286       char res = resName.length() == 3 ? ResidueProperties
1287               .getSingleCharacterCode(resName) : resName.charAt(0);
1288       Color col = cs.findColour(res, 0, null, null, 0f);
1289       command.append("select " + resName + ";color[" + col.getRed() + ","
1290               + col.getGreen() + "," + col.getBlue() + "];");
1291     }
1292
1293     evalStateCommand(command.toString());
1294     jmolHistory(true);
1295   }
1296
1297   public void showHelp()
1298   {
1299     showUrl("http://jmol.sourceforge.net/docs/JmolUserGuide/", "jmolHelp");
1300   }
1301
1302   /**
1303    * open the URL somehow
1304    *
1305    * @param target
1306    */
1307   public abstract void showUrl(String url, String target);
1308
1309   /**
1310    * called when the binding thinks the UI needs to be refreshed after a Jmol
1311    * state change. this could be because structures were loaded, or because an
1312    * error has occured.
1313    */
1314   public abstract void refreshGUI();
1315
1316   /**
1317    * called to show or hide the associated console window container.
1318    *
1319    * @param show
1320    */
1321   public abstract void showConsole(boolean show);
1322
1323   /**
1324    * @param renderPanel
1325    * @param jmolfileio
1326    *          - when true will initialise jmol's file IO system (should be false
1327    *          in applet context)
1328    * @param htmlName
1329    * @param documentBase
1330    * @param codeBase
1331    * @param commandOptions
1332    */
1333   public void allocateViewer(Container renderPanel, boolean jmolfileio,
1334           String htmlName, URL documentBase, URL codeBase,
1335           String commandOptions)
1336   {
1337     allocateViewer(renderPanel, jmolfileio, htmlName, documentBase,
1338             codeBase, commandOptions, null, null);
1339   }
1340
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    * @param consolePanel
1352    *          - panel to contain Jmol console
1353    * @param buttonsToShow
1354    *          - buttons to show on the console, in ordr
1355    */
1356   public void allocateViewer(Container renderPanel, boolean jmolfileio,
1357           String htmlName, URL documentBase, URL codeBase,
1358           String commandOptions, final Container consolePanel,
1359           String buttonsToShow)
1360   {
1361     if (commandOptions == null)
1362     {
1363       commandOptions = "";
1364     }
1365     viewer = (Viewer) JmolViewer.allocateViewer(renderPanel,
1366             (jmolfileio ? new SmarterJmolAdapter() : null), htmlName
1367                     + ((Object) this).toString(), documentBase, codeBase,
1368             commandOptions, this);
1369
1370     viewer.setJmolStatusListener(this); // extends JmolCallbackListener
1371
1372     console = createJmolConsole(consolePanel, buttonsToShow);
1373     if (consolePanel != null)
1374     {
1375       consolePanel.addComponentListener(this);
1376
1377     }
1378
1379   }
1380
1381   protected abstract JmolAppConsoleInterface createJmolConsole(
1382           Container consolePanel, String buttonsToShow);
1383
1384   protected org.jmol.api.JmolAppConsoleInterface console = null;
1385
1386   @Override
1387   public void setBackgroundColour(java.awt.Color col)
1388   {
1389     jmolHistory(false);
1390     viewer.evalStringQuiet("background [" + col.getRed() + ","
1391             + col.getGreen() + "," + col.getBlue() + "];");
1392     jmolHistory(true);
1393   }
1394
1395   @Override
1396   public int[] resizeInnerPanel(String data)
1397   {
1398     // Jalview doesn't honour resize panel requests
1399     return null;
1400   }
1401
1402   /**
1403    *
1404    */
1405   protected void closeConsole()
1406   {
1407     if (console != null)
1408     {
1409       try
1410       {
1411         console.setVisible(false);
1412       } catch (Error e)
1413       {
1414       } catch (Exception x)
1415       {
1416       }
1417       ;
1418       console = null;
1419     }
1420   }
1421
1422   /**
1423    * ComponentListener method
1424    */
1425   @Override
1426   public void componentMoved(ComponentEvent e)
1427   {
1428   }
1429
1430   /**
1431    * ComponentListener method
1432    */
1433   @Override
1434   public void componentResized(ComponentEvent e)
1435   {
1436   }
1437
1438   /**
1439    * ComponentListener method
1440    */
1441   @Override
1442   public void componentShown(ComponentEvent e)
1443   {
1444     showConsole(true);
1445   }
1446
1447   /**
1448    * ComponentListener method
1449    */
1450   @Override
1451   public void componentHidden(ComponentEvent e)
1452   {
1453     showConsole(false);
1454   }
1455 }