src/jalview/ext/jmol/JalviewJmolBinding.java

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