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