src/jalview/commands/EditCommand.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.commands;
  22
  23 import jalview.analysis.AlignSeq;
  24 import jalview.datamodel.AlignmentAnnotation;
  25 import jalview.datamodel.AlignmentI;
  26 import jalview.datamodel.Annotation;
  27 import jalview.datamodel.Range;
  28 import jalview.datamodel.Sequence;
  29 import jalview.datamodel.SequenceFeature;
  30 import jalview.datamodel.SequenceI;
  31 import jalview.datamodel.features.SequenceFeaturesI;
  32 import jalview.util.Comparison;
  33 import jalview.util.ReverseListIterator;
  34 import jalview.util.StringUtils;
  35
  36 import java.util.ArrayList;
  37 import java.util.HashMap;
  38 import java.util.Hashtable;
  39 import java.util.Iterator;
  40 import java.util.List;
  41 import java.util.ListIterator;
  42 import java.util.Map;
  43
  44 /**
  45  *
  46  * <p>
  47  * Title: EditCommmand
  48  * </p>
  49  *
  50  * <p>
  51  * Description: Essential information for performing undo and redo for cut/paste
  52  * insert/delete gap which can be stored in the HistoryList
  53  * </p>
  54  *
  55  * <p>
  56  * Copyright: Copyright (c) 2006
  57  * </p>
  58  *
  59  * <p>
  60  * Company: Dundee University
  61  * </p>
  62  *
  63  * @author not attributable
  64  * @version 1.0
  65  */
  66 public class EditCommand implements CommandI
  67 {
  68   public enum Action
  69   {
  70     INSERT_GAP
  71     {
  72       @Override
  73       public Action getUndoAction()
  74       {
  75         return DELETE_GAP;
  76       }
  77     },
  78     DELETE_GAP
  79     {
  80       @Override
  81       public Action getUndoAction()
  82       {
  83         return INSERT_GAP;
  84       }
  85     },
  86     CUT
  87     {
  88       @Override
  89       public Action getUndoAction()
  90       {
  91         return PASTE;
  92       }
  93     },
  94     PASTE
  95     {
  96       @Override
  97       public Action getUndoAction()
  98       {
  99         return CUT;
 100       }
 101     },
 102     REPLACE
 103     {
 104       @Override
 105       public Action getUndoAction()
 106       {
 107         return REPLACE;
 108       }
 109     },
 110     INSERT_NUC
 111     {
 112       @Override
 113       public Action getUndoAction()
 114       {
 115         return null;
 116       }
 117     };
 118     public abstract Action getUndoAction();
 119   };
 120
 121   private List<Edit> edits = new ArrayList<Edit>();
 122
 123   String description;
 124
 125   public EditCommand()
 126   {
 127   }
 128
 129   public EditCommand(String desc)
 130   {
 131     this.description = desc;
 132   }
 133
 134   public EditCommand(String desc, Action command, SequenceI[] seqs,
 135           int position, int number, AlignmentI al)
 136   {
 137     this.description = desc;
 138     if (command == Action.CUT || command == Action.PASTE)
 139     {
 140       setEdit(new Edit(command, seqs, position, number, al));
 141     }
 142
 143     performEdit(0, null);
 144   }
 145
 146   public EditCommand(String desc, Action command, String replace,
 147           SequenceI[] seqs, int position, int number, AlignmentI al)
 148   {
 149     this.description = desc;
 150     if (command == Action.REPLACE)
 151     {
 152       setEdit(new Edit(command, seqs, position, number, al, replace));
 153     }
 154
 155     performEdit(0, null);
 156   }
 157
 158   /**
 159    * Set the list of edits to the specified item (only).
 160    *
 161    * @param e
 162    */
 163   protected void setEdit(Edit e)
 164   {
 165     edits.clear();
 166     edits.add(e);
 167   }
 168
 169   /**
 170    * Add the given edit command to the stored list of commands. If simply
 171    * expanding the range of the last command added, then modify it instead of
 172    * adding a new command.
 173    *
 174    * @param e
 175    */
 176   public void addEdit(Edit e)
 177   {
 178     if (!expandEdit(edits, e))
 179     {
 180       edits.add(e);
 181     }
 182   }
 183
 184   /**
 185    * Returns true if the new edit is incorporated by updating (expanding the
 186    * range of) the last edit on the list, else false. We can 'expand' the last
 187    * edit if the new one is the same action, on the same sequences, and acts on
 188    * a contiguous range. This is the case where a mouse drag generates a series
 189    * of contiguous gap insertions or deletions.
 190    *
 191    * @param edits
 192    * @param e
 193    * @return
 194    */
 195   protected static boolean expandEdit(List<Edit> edits, Edit e)
 196   {
 197     if (edits == null || edits.isEmpty())
 198     {
 199       return false;
 200     }
 201     Edit lastEdit = edits.get(edits.size() - 1);
 202     Action action = e.command;
 203     if (lastEdit.command != action)
 204     {
 205       return false;
 206     }
 207
 208     /*
 209      * Both commands must act on the same sequences - compare the underlying
 210      * dataset sequences, rather than the aligned sequences, which change as
 211      * they are edited.
 212      */
 213     if (lastEdit.seqs.length != e.seqs.length)
 214     {
 215       return false;
 216     }
 217     for (int i = 0; i < e.seqs.length; i++)
 218     {
 219       if (lastEdit.seqs[i].getDatasetSequence() != e.seqs[i]
 220               .getDatasetSequence())
 221       {
 222         return false;
 223       }
 224     }
 225
 226     /**
 227      * Check a contiguous edit; either
 228      * <ul>
 229      * <li>a new Insert <n> positions to the right of the last <insert n>,
 230      * or</li>
 231      * <li>a new Delete <n> gaps which is <n> positions to the left of the last
 232      * delete.</li>
 233      * </ul>
 234      */
 235     boolean contiguous = (action == Action.INSERT_GAP
 236             && e.position == lastEdit.position + lastEdit.number)
 237             || (action == Action.DELETE_GAP
 238                     && e.position + e.number == lastEdit.position);
 239     if (contiguous)
 240     {
 241       /*
 242        * We are just expanding the range of the last edit. For delete gap, also
 243        * moving the start position left.
 244        */
 245       lastEdit.number += e.number;
 246       lastEdit.seqs = e.seqs;
 247       if (action == Action.DELETE_GAP)
 248       {
 249         lastEdit.position--;
 250       }
 251       return true;
 252     }
 253     return false;
 254   }
 255
 256   /**
 257    * Clear the list of stored edit commands.
 258    *
 259    */
 260   protected void clearEdits()
 261   {
 262     edits.clear();
 263   }
 264
 265   /**
 266    * Returns the i'th stored Edit command.
 267    *
 268    * @param i
 269    * @return
 270    */
 271   protected Edit getEdit(int i)
 272   {
 273     if (i >= 0 && i < edits.size())
 274     {
 275       return edits.get(i);
 276     }
 277     return null;
 278   }
 279
 280   @Override
 281   final public String getDescription()
 282   {
 283     return description;
 284   }
 285
 286   @Override
 287   public int getSize()
 288   {
 289     return edits.size();
 290   }
 291
 292   /**
 293    * Return the alignment for the first edit (or null if no edit).
 294    *
 295    * @return
 296    */
 297   final public AlignmentI getAlignment()
 298   {
 299     return (edits.isEmpty() ? null : edits.get(0).al);
 300   }
 301
 302   /**
 303    * append a new editCommand Note. this shouldn't be called if the edit is an
 304    * operation affects more alignment objects than the one referenced in al (for
 305    * example, cut or pasting whole sequences). Use the form with an additional
 306    * AlignmentI[] views parameter.
 307    *
 308    * @param command
 309    * @param seqs
 310    * @param position
 311    * @param number
 312    * @param al
 313    * @param performEdit
 314    */
 315   final public void appendEdit(Action command, SequenceI[] seqs,
 316           int position, int number, AlignmentI al, boolean performEdit)
 317   {
 318     appendEdit(command, seqs, position, number, al, performEdit, null);
 319   }
 320
 321   /**
 322    * append a new edit command with a set of alignment views that may be
 323    * operated on
 324    *
 325    * @param command
 326    * @param seqs
 327    * @param position
 328    * @param number
 329    * @param al
 330    * @param performEdit
 331    * @param views
 332    */
 333   final public void appendEdit(Action command, SequenceI[] seqs,
 334           int position, int number, AlignmentI al, boolean performEdit,
 335           AlignmentI[] views)
 336   {
 337     Edit edit = new Edit(command, seqs, position, number, al);
 338     appendEdit(edit, al, performEdit, views);
 339   }
 340
 341   /**
 342    * Overloaded method that accepts an Edit object with additional parameters.
 343    *
 344    * @param edit
 345    * @param al
 346    * @param performEdit
 347    * @param views
 348    */
 349   final public void appendEdit(Edit edit, AlignmentI al,
 350           boolean performEdit, AlignmentI[] views)
 351   {
 352     if (al.getHeight() == edit.seqs.length)
 353     {
 354       edit.al = al;
 355       edit.fullAlignmentHeight = true;
 356     }
 357
 358     addEdit(edit);
 359
 360     if (performEdit)
 361     {
 362       performEdit(edit, views);
 363     }
 364   }
 365
 366   /**
 367    * Execute all the edit commands, starting at the given commandIndex
 368    *
 369    * @param commandIndex
 370    * @param views
 371    */
 372   public final void performEdit(int commandIndex, AlignmentI[] views)
 373   {
 374     ListIterator<Edit> iterator = edits.listIterator(commandIndex);
 375     while (iterator.hasNext())
 376     {
 377       Edit edit = iterator.next();
 378       performEdit(edit, views);
 379     }
 380   }
 381
 382   /**
 383    * Execute one edit command in all the specified alignment views
 384    *
 385    * @param edit
 386    * @param views
 387    */
 388   protected static void performEdit(Edit edit, AlignmentI[] views)
 389   {
 390     switch (edit.command)
 391     {
 392     case INSERT_GAP:
 393       insertGap(edit);
 394       break;
 395     case DELETE_GAP:
 396       deleteGap(edit);
 397       break;
 398     case CUT:
 399       cut(edit, views);
 400       break;
 401     case PASTE:
 402       paste(edit, views);
 403       break;
 404     case REPLACE:
 405       replace(edit);
 406       break;
 407     case INSERT_NUC:
 408       // TODO:add deleteNuc for UNDO
 409       // case INSERT_NUC:
 410       // insertNuc(edits[e]);
 411       break;
 412     default:
 413       break;
 414     }
 415   }
 416
 417   @Override
 418   final public void doCommand(AlignmentI[] views)
 419   {
 420     performEdit(0, views);
 421   }
 422
 423   /**
 424    * Undo the stored list of commands, in reverse order.
 425    */
 426   @Override
 427   final public void undoCommand(AlignmentI[] views)
 428   {
 429     ListIterator<Edit> iterator = edits.listIterator(edits.size());
 430     while (iterator.hasPrevious())
 431     {
 432       Edit e = iterator.previous();
 433       switch (e.command)
 434       {
 435       case INSERT_GAP:
 436         deleteGap(e);
 437         break;
 438       case DELETE_GAP:
 439         insertGap(e);
 440         break;
 441       case CUT:
 442         paste(e, views);
 443         break;
 444       case PASTE:
 445         cut(e, views);
 446         break;
 447       case REPLACE:
 448         replace(e);
 449         break;
 450       case INSERT_NUC:
 451         // not implemented
 452         break;
 453       default:
 454         break;
 455       }
 456     }
 457   }
 458
 459   /**
 460    * Insert gap(s) in sequences as specified by the command, and adjust
 461    * annotations.
 462    *
 463    * @param command
 464    */
 465   final private static void insertGap(Edit command)
 466   {
 467
 468     for (int s = 0; s < command.seqs.length; s++)
 469     {
 470       command.seqs[s].insertCharAt(command.position, command.number,
 471               command.gapChar);
 472       // System.out.println("pos: "+command.position+" number:
 473       // "+command.number);
 474     }
 475
 476     adjustAnnotations(command, true, false, null);
 477   }
 478
 479   //
 480   // final void insertNuc(Edit command)
 481   // {
 482   //
 483   // for (int s = 0; s < command.seqs.length; s++)
 484   // {
 485   // System.out.println("pos: "+command.position+" number: "+command.number);
 486   // command.seqs[s].insertCharAt(command.position, command.number,'A');
 487   // }
 488   //
 489   // adjustAnnotations(command, true, false, null);
 490   // }
 491
 492   /**
 493    * Delete gap(s) in sequences as specified by the command, and adjust
 494    * annotations.
 495    *
 496    * @param command
 497    */
 498   final static private void deleteGap(Edit command)
 499   {
 500     for (int s = 0; s < command.seqs.length; s++)
 501     {
 502       command.seqs[s].deleteChars(command.position,
 503               command.position + command.number);
 504     }
 505
 506     adjustAnnotations(command, false, false, null);
 507   }
 508
 509   /**
 510    * Carry out a Cut action. The cut characters are saved in case Undo is
 511    * requested.
 512    *
 513    * @param command
 514    * @param views
 515    */
 516   static void cut(Edit command, AlignmentI[] views)
 517   {
 518     boolean seqDeleted = false;
 519     command.string = new char[command.seqs.length][];
 520
 521     for (int i = 0; i < command.seqs.length; i++)
 522     {
 523       final SequenceI sequence = command.seqs[i];
 524       if (sequence.getLength() > command.position)
 525       {
 526         command.string[i] = sequence.getSequence(command.position,
 527                 command.position + command.number);
 528         SequenceI oldds = sequence.getDatasetSequence();
 529         if (command.oldds != null && command.oldds[i] != null)
 530         {
 531           // we are redoing an undone cut.
 532           sequence.setDatasetSequence(null);
 533         }
 534         Range cutPositions = sequence.findPositions(command.position + 1,
 535                 command.position + command.number);
 536         boolean cutIsInternal = cutPositions != null
 537                 && sequence.getStart() != cutPositions
 538                 .getBegin() && sequence.getEnd() != cutPositions.getEnd();
 539         sequence.deleteChars(command.position, command.position
 540                 + command.number);
 541
 542         if (command.oldds != null && command.oldds[i] != null)
 543         {
 544           // Undoing previous Paste - so
 545           // oldds entry contains the cut dataset sequence,
 546           // with sequence features in expected place.
 547           sequence.setDatasetSequence(command.oldds[i]);
 548           command.oldds[i] = oldds;
 549         }
 550         else
 551         {
 552           // New cut operation
 553           // We always keep track of the dataset sequence so we can safely
 554           // restore it during the Undo
 555           if (command.oldds == null)
 556           {
 557             command.oldds = new SequenceI[command.seqs.length];
 558           }
 559           command.oldds[i] = oldds;
 560
 561             if (cutPositions != null)
 562             {
 563               cutFeatures(command, sequence, cutPositions.getBegin(),
 564                               cutPositions.getEnd(), cutIsInternal);
 565             }
 566           }
 567         }
 568       }
 569
 570       if (sequence.getLength() < 1)
 571       {
 572         command.al.deleteSequence(sequence);
 573         seqDeleted = true;
 574       }
 575     }
 576
 577     adjustAnnotations(command, false, seqDeleted, views);
 578   }
 579
 580   /**
 581    * Perform the given Paste command. This may be to add cut or copied sequences
 582    * to an alignment, or to undo a 'Cut' action on a region of the alignment.
 583    *
 584    * @param command
 585    * @param views
 586    */
 587   static void paste(Edit command, AlignmentI[] views)
 588   {
 589     boolean seqWasDeleted = false;
 590
 591     for (int i = 0; i < command.seqs.length; i++)
 592     {
 593       boolean newDSNeeded = false;
 594       boolean newDSWasNeeded = command.oldds != null
 595               && command.oldds[i] != null;
 596       SequenceI sequence = command.seqs[i];
 597       if (sequence.getLength() < 1)
 598       {
 599         /*
 600          * sequence was deleted; re-add it to the alignment
 601          */
 602         if (command.alIndex[i] < command.al.getHeight())
 603         {
 604           List<SequenceI> sequences;
 605           synchronized (sequences = command.al.getSequences())
 606           {
 607             if (!(command.alIndex[i] < 0))
 608             {
 609               sequences.add(command.alIndex[i], sequence);
 610             }
 611           }
 612         }
 613         else
 614         {
 615           command.al.addSequence(sequence);
 616         }
 617         seqWasDeleted = true;
 618       }
 619       int newStart = sequence.getStart();
 620       int newEnd = sequence.getEnd();
 621
 622       StringBuilder tmp = new StringBuilder();
 623       tmp.append(sequence.getSequence());
 624       // Undo of a delete does not replace original dataset sequence on to
 625       // alignment sequence.
 626
 627       int start = 0;
 628       int length = 0;
 629
 630       if (command.string != null && command.string[i] != null)
 631       {
 632         if (command.position >= tmp.length())
 633         {
 634           // This occurs if padding is on, and residues
 635           // are removed from end of alignment
 636           int len = command.position - tmp.length();
 637           while (len > 0)
 638           {
 639             tmp.append(command.gapChar);
 640             len--;
 641           }
 642         }
 643         tmp.insert(command.position, command.string[i]);
 644         for (int s = 0; s < command.string[i].length; s++)
 645         {
 646           if (!Comparison.isGap(command.string[i][s]))
 647           {
 648             length++;
 649             if (!newDSNeeded)
 650             {
 651               newDSNeeded = true;
 652               start = sequence.findPosition(command.position);
 653               // end = sequence
 654               // .findPosition(command.position + command.number);
 655             }
 656             if (sequence.getStart() == start)
 657             {
 658               newStart--;
 659             }
 660             else
 661             {
 662               newEnd++;
 663             }
 664           }
 665         }
 666         command.string[i] = null;
 667       }
 668
 669       sequence.setSequence(tmp.toString());
 670       sequence.setStart(newStart);
 671       sequence.setEnd(newEnd);
 672
 673       /*
 674        * command and Undo share the same dataset sequence if cut was
 675        * at start or end of sequence
 676        */
 677       boolean sameDatasetSequence = false;
 678       if (newDSNeeded)
 679       {
 680         if (sequence.getDatasetSequence() != null)
 681         {
 682           SequenceI ds;
 683           if (newDSWasNeeded)
 684           {
 685             ds = command.oldds[i];
 686           }
 687           else
 688           {
 689             // make a new DS sequence
 690             // use new ds mechanism here
 691             String ungapped = AlignSeq.extractGaps(Comparison.GapChars,
 692                     sequence.getSequenceAsString());
 693             ds = new Sequence(sequence.getName(), ungapped,
 694                     sequence.getStart(), sequence.getEnd());
 695             ds.setDescription(sequence.getDescription());
 696           }
 697           if (command.oldds == null)
 698           {
 699             command.oldds = new SequenceI[command.seqs.length];
 700           }
 701           command.oldds[i] = sequence.getDatasetSequence();
 702           sameDatasetSequence = ds == sequence.getDatasetSequence();
 703           ds.setSequenceFeatures(sequence.getSequenceFeatures());
 704           sequence.setDatasetSequence(ds);
 705         }
 706         undoCutFeatures(command, command.seqs[i], start, length,
 707                 sameDatasetSequence);
 708       }
 709     }
 710     adjustAnnotations(command, true, seqWasDeleted, views);
 711
 712     command.string = null;
 713   }
 714
 715   static void replace(Edit command)
 716   {
 717     StringBuffer tmp;
 718     String oldstring;
 719     int start = command.position;
 720     int end = command.number;
 721     // TODO TUTORIAL - Fix for replacement with different length of sequence (or
 722     // whole sequence)
 723     // TODO Jalview 2.4 bugfix change to an aggregate command - original
 724     // sequence string is cut, new string is pasted in.
 725     command.number = start + command.string[0].length;
 726     for (int i = 0; i < command.seqs.length; i++)
 727     {
 728       boolean newDSWasNeeded = command.oldds != null
 729               && command.oldds[i] != null;
 730
 731       /**
 732        * cut addHistoryItem(new EditCommand("Cut Sequences", EditCommand.CUT,
 733        * cut, sg.getStartRes(), sg.getEndRes()-sg.getStartRes()+1,
 734        * viewport.alignment));
 735        *
 736        */
 737       /**
 738        * then addHistoryItem(new EditCommand( "Add sequences",
 739        * EditCommand.PASTE, sequences, 0, alignment.getWidth(), alignment) );
 740        *
 741        */
 742       oldstring = command.seqs[i].getSequenceAsString();
 743       tmp = new StringBuffer(oldstring.substring(0, start));
 744       tmp.append(command.string[i]);
 745       String nogaprep = jalview.analysis.AlignSeq.extractGaps(
 746               jalview.util.Comparison.GapChars,
 747               new String(command.string[i]));
 748       int ipos = command.seqs[i].findPosition(start)
 749               - command.seqs[i].getStart();
 750       tmp.append(oldstring.substring(end));
 751       command.seqs[i].setSequence(tmp.toString());
 752       command.string[i] = oldstring.substring(start, end).toCharArray();
 753       String nogapold = AlignSeq.extractGaps(Comparison.GapChars,
 754               new String(command.string[i]));
 755       if (!nogaprep.toLowerCase().equals(nogapold.toLowerCase()))
 756       {
 757         if (newDSWasNeeded)
 758         {
 759           SequenceI oldds = command.seqs[i].getDatasetSequence();
 760           command.seqs[i].setDatasetSequence(command.oldds[i]);
 761           command.oldds[i] = oldds;
 762         }
 763         else
 764         {
 765           if (command.oldds == null)
 766           {
 767             command.oldds = new SequenceI[command.seqs.length];
 768           }
 769           command.oldds[i] = command.seqs[i].getDatasetSequence();
 770           SequenceI newds = new Sequence(
 771                   command.seqs[i].getDatasetSequence());
 772           String fullseq, osp = newds.getSequenceAsString();
 773           fullseq = osp.substring(0, ipos) + nogaprep
 774                   + osp.substring(ipos + nogaprep.length());
 775           newds.setSequence(fullseq.toUpperCase());
 776           // TODO: JAL-1131 ensure newly created dataset sequence is added to
 777           // the set of
 778           // dataset sequences associated with the alignment.
 779           // TODO: JAL-1131 fix up any annotation associated with new dataset
 780           // sequence to ensure that original sequence/annotation relationships
 781           // are preserved.
 782           command.seqs[i].setDatasetSequence(newds);
 783
 784         }
 785       }
 786       tmp = null;
 787       oldstring = null;
 788     }
 789   }
 790
 791   final static void adjustAnnotations(Edit command, boolean insert,
 792           boolean modifyVisibility, AlignmentI[] views)
 793   {
 794     AlignmentAnnotation[] annotations = null;
 795
 796     if (modifyVisibility && !insert)
 797     {
 798       // only occurs if a sequence was added or deleted.
 799       command.deletedAnnotationRows = new Hashtable<SequenceI, AlignmentAnnotation[]>();
 800     }
 801     if (command.fullAlignmentHeight)
 802     {
 803       annotations = command.al.getAlignmentAnnotation();
 804     }
 805     else
 806     {
 807       int aSize = 0;
 808       AlignmentAnnotation[] tmp;
 809       for (int s = 0; s < command.seqs.length; s++)
 810       {
 811         command.seqs[s].sequenceChanged();
 812
 813         if (modifyVisibility)
 814         {
 815           // Rows are only removed or added to sequence object.
 816           if (!insert)
 817           {
 818             // remove rows
 819             tmp = command.seqs[s].getAnnotation();
 820             if (tmp != null)
 821             {
 822               int alen = tmp.length;
 823               for (int aa = 0; aa < tmp.length; aa++)
 824               {
 825                 if (!command.al.deleteAnnotation(tmp[aa]))
 826                 {
 827                   // strip out annotation not in the current al (will be put
 828                   // back on insert in all views)
 829                   tmp[aa] = null;
 830                   alen--;
 831                 }
 832               }
 833               command.seqs[s].setAlignmentAnnotation(null);
 834               if (alen != tmp.length)
 835               {
 836                 // save the non-null annotation references only
 837                 AlignmentAnnotation[] saved = new AlignmentAnnotation[alen];
 838                 for (int aa = 0, aapos = 0; aa < tmp.length; aa++)
 839                 {
 840                   if (tmp[aa] != null)
 841                   {
 842                     saved[aapos++] = tmp[aa];
 843                     tmp[aa] = null;
 844                   }
 845                 }
 846                 tmp = saved;
 847                 command.deletedAnnotationRows.put(command.seqs[s], saved);
 848                 // and then remove any annotation in the other views
 849                 for (int alview = 0; views != null
 850                         && alview < views.length; alview++)
 851                 {
 852                   if (views[alview] != command.al)
 853                   {
 854                     AlignmentAnnotation[] toremove = views[alview]
 855                             .getAlignmentAnnotation();
 856                     if (toremove == null || toremove.length == 0)
 857                     {
 858                       continue;
 859                     }
 860                     // remove any alignment annotation on this sequence that's
 861                     // on that alignment view.
 862                     for (int aa = 0; aa < toremove.length; aa++)
 863                     {
 864                       if (toremove[aa].sequenceRef == command.seqs[s])
 865                       {
 866                         views[alview].deleteAnnotation(toremove[aa]);
 867                       }
 868                     }
 869                   }
 870                 }
 871               }
 872               else
 873               {
 874                 // save all the annotation
 875                 command.deletedAnnotationRows.put(command.seqs[s], tmp);
 876               }
 877             }
 878           }
 879           else
 880           {
 881             // recover rows
 882             if (command.deletedAnnotationRows != null
 883                     && command.deletedAnnotationRows
 884                             .containsKey(command.seqs[s]))
 885             {
 886               AlignmentAnnotation[] revealed = command.deletedAnnotationRows
 887                       .get(command.seqs[s]);
 888               command.seqs[s].setAlignmentAnnotation(revealed);
 889               if (revealed != null)
 890               {
 891                 for (int aa = 0; aa < revealed.length; aa++)
 892                 {
 893                   // iterate through al adding original annotation
 894                   command.al.addAnnotation(revealed[aa]);
 895                 }
 896                 for (int aa = 0; aa < revealed.length; aa++)
 897                 {
 898                   command.al.setAnnotationIndex(revealed[aa], aa);
 899                 }
 900                 // and then duplicate added annotation on every other alignment
 901                 // view
 902                 for (int vnum = 0; views != null && vnum < views.length; vnum++)
 903                 {
 904                   if (views[vnum] != command.al)
 905                   {
 906                     int avwidth = views[vnum].getWidth() + 1;
 907                     // duplicate in this view
 908                     for (int a = 0; a < revealed.length; a++)
 909                     {
 910                       AlignmentAnnotation newann = new AlignmentAnnotation(
 911                               revealed[a]);
 912                       command.seqs[s].addAlignmentAnnotation(newann);
 913                       newann.padAnnotation(avwidth);
 914                       views[vnum].addAnnotation(newann);
 915                       views[vnum].setAnnotationIndex(newann, a);
 916                     }
 917                   }
 918                 }
 919               }
 920             }
 921           }
 922           continue;
 923         }
 924
 925         if (command.seqs[s].getAnnotation() == null)
 926         {
 927           continue;
 928         }
 929
 930         if (aSize == 0)
 931         {
 932           annotations = command.seqs[s].getAnnotation();
 933         }
 934         else
 935         {
 936           tmp = new AlignmentAnnotation[aSize
 937                   + command.seqs[s].getAnnotation().length];
 938
 939           System.arraycopy(annotations, 0, tmp, 0, aSize);
 940
 941           System.arraycopy(command.seqs[s].getAnnotation(), 0, tmp, aSize,
 942                   command.seqs[s].getAnnotation().length);
 943
 944           annotations = tmp;
 945         }
 946         aSize = annotations.length;
 947       }
 948     }
 949
 950     if (annotations == null)
 951     {
 952       return;
 953     }
 954
 955     if (!insert)
 956     {
 957       command.deletedAnnotations = new Hashtable<String, Annotation[]>();
 958     }
 959
 960     int aSize;
 961     Annotation[] temp;
 962     for (int a = 0; a < annotations.length; a++)
 963     {
 964       if (annotations[a].autoCalculated
 965               || annotations[a].annotations == null)
 966       {
 967         continue;
 968       }
 969
 970       int tSize = 0;
 971
 972       aSize = annotations[a].annotations.length;
 973       if (insert)
 974       {
 975         temp = new Annotation[aSize + command.number];
 976         if (annotations[a].padGaps)
 977         {
 978           for (int aa = 0; aa < temp.length; aa++)
 979           {
 980             temp[aa] = new Annotation(command.gapChar + "", null, ' ', 0);
 981           }
 982         }
 983       }
 984       else
 985       {
 986         if (command.position < aSize)
 987         {
 988           if (command.position + command.number >= aSize)
 989           {
 990             tSize = aSize;
 991           }
 992           else
 993           {
 994             tSize = aSize - command.number;
 995           }
 996         }
 997         else
 998         {
 999           tSize = aSize;
1000         }
1001
1002         if (tSize < 0)
1003         {
1004           tSize = aSize;
1005         }
1006         temp = new Annotation[tSize];
1007       }
1008
1009       if (insert)
1010       {
1011         if (command.position < annotations[a].annotations.length)
1012         {
1013           System.arraycopy(annotations[a].annotations, 0, temp, 0,
1014                   command.position);
1015
1016           if (command.deletedAnnotations != null
1017                   && command.deletedAnnotations
1018                           .containsKey(annotations[a].annotationId))
1019           {
1020             Annotation[] restore = command.deletedAnnotations
1021                     .get(annotations[a].annotationId);
1022
1023             System.arraycopy(restore, 0, temp, command.position,
1024                     command.number);
1025
1026           }
1027
1028           System.arraycopy(annotations[a].annotations, command.position,
1029                   temp, command.position + command.number,
1030                   aSize - command.position);
1031         }
1032         else
1033         {
1034           if (command.deletedAnnotations != null
1035                   && command.deletedAnnotations
1036                           .containsKey(annotations[a].annotationId))
1037           {
1038             Annotation[] restore = command.deletedAnnotations
1039                     .get(annotations[a].annotationId);
1040
1041             temp = new Annotation[annotations[a].annotations.length
1042                     + restore.length];
1043             System.arraycopy(annotations[a].annotations, 0, temp, 0,
1044                     annotations[a].annotations.length);
1045             System.arraycopy(restore, 0, temp,
1046                     annotations[a].annotations.length, restore.length);
1047           }
1048           else
1049           {
1050             temp = annotations[a].annotations;
1051           }
1052         }
1053       }
1054       else
1055       {
1056         if (tSize != aSize || command.position < 2)
1057         {
1058           int copylen = Math.min(command.position,
1059                   annotations[a].annotations.length);
1060           if (copylen > 0)
1061           {
1062             System.arraycopy(annotations[a].annotations, 0, temp, 0,
1063                     copylen); // command.position);
1064           }
1065
1066           Annotation[] deleted = new Annotation[command.number];
1067           if (copylen >= command.position)
1068           {
1069             copylen = Math.min(command.number,
1070                     annotations[a].annotations.length - command.position);
1071             if (copylen > 0)
1072             {
1073               System.arraycopy(annotations[a].annotations, command.position,
1074                       deleted, 0, copylen); // command.number);
1075             }
1076           }
1077
1078           command.deletedAnnotations.put(annotations[a].annotationId,
1079                   deleted);
1080           if (annotations[a].annotations.length > command.position
1081                   + command.number)
1082           {
1083             System.arraycopy(annotations[a].annotations,
1084                     command.position + command.number, temp,
1085                     command.position, annotations[a].annotations.length
1086                             - command.position - command.number); // aSize
1087           }
1088         }
1089         else
1090         {
1091           int dSize = aSize - command.position;
1092
1093           if (dSize > 0)
1094           {
1095             Annotation[] deleted = new Annotation[command.number];
1096             System.arraycopy(annotations[a].annotations, command.position,
1097                     deleted, 0, dSize);
1098
1099             command.deletedAnnotations.put(annotations[a].annotationId,
1100                     deleted);
1101
1102             tSize = Math.min(annotations[a].annotations.length,
1103                     command.position);
1104             temp = new Annotation[tSize];
1105             System.arraycopy(annotations[a].annotations, 0, temp, 0, tSize);
1106           }
1107           else
1108           {
1109             temp = annotations[a].annotations;
1110           }
1111         }
1112       }
1113
1114       annotations[a].annotations = temp;
1115     }
1116   }
1117
1118   /**
1119    * Restores features to the state before a Cut.
1120    * <ul>
1121    * <li>re-add any features deleted by the cut</li>
1122    * <li>remove any truncated features created by the cut</li>
1123    * <li>shift right any features to the right of the cut</li>
1124    * </ul>
1125    *
1126    * @param command
1127    *          the Cut command
1128    * @param seq
1129    *          the sequence the Cut applied to
1130    * @param start
1131    *          the start residue position of the cut
1132    * @param length
1133    *          the number of residues cut
1134    * @param sameDatasetSequence
1135    *          true if dataset sequence and frame of reference were left
1136    *          unchanged by the Cut
1137    */
1138   final static void undoCutFeatures(Edit command, SequenceI seq,
1139           final int start, final int length, boolean sameDatasetSequence)
1140   {
1141     SequenceI sequence = seq.getDatasetSequence();
1142     if (sequence == null)
1143     {
1144       sequence = seq;
1145     }
1146
1147     /*
1148      * shift right features that lie to the right of the restored cut (but not
1149      * if dataset sequence unchanged - so coordinates were changed by Cut)
1150      */
1151     if (!sameDatasetSequence)
1152     {
1153       /*
1154        * shift right all features right of and not
1155        * contiguous with the cut position
1156        */
1157       seq.getFeatures().shiftFeatures(start + 1, length);
1158
1159       /*
1160        * shift right any features that start at the cut position,
1161        * unless they were truncated
1162        */
1163       List<SequenceFeature> sfs = seq.getFeatures().findFeatures(start,
1164               start);
1165       for (SequenceFeature sf : sfs)
1166       {
1167         if (sf.getBegin() == start)
1168         {
1169           if (!command.truncatedFeatures.containsKey(seq)
1170                   || !command.truncatedFeatures.get(seq).contains(sf))
1171           {
1172             /*
1173              * feature was shifted left to cut position (not truncated),
1174              * so shift it back right
1175              */
1176             SequenceFeature shifted = new SequenceFeature(sf, sf.getBegin()
1177                     + length, sf.getEnd() + length, sf.getFeatureGroup(),
1178                     sf.getScore());
1179             seq.addSequenceFeature(shifted);
1180             seq.deleteFeature(sf);
1181           }
1182         }
1183       }
1184     }
1185
1186     /*
1187      * restore any features that were deleted or truncated
1188      */
1189     if (command.deletedFeatures != null
1190             && command.deletedFeatures.containsKey(seq))
1191     {
1192       for (SequenceFeature deleted : command.deletedFeatures.get(seq))
1193       {
1194         sequence.addSequenceFeature(deleted);
1195       }
1196     }
1197
1198     /*
1199      * delete any truncated features
1200      */
1201     if (command.truncatedFeatures != null
1202             && command.truncatedFeatures.containsKey(seq))
1203     {
1204       for (SequenceFeature amended : command.truncatedFeatures.get(seq))
1205       {
1206         sequence.deleteFeature(amended);
1207       }
1208     }
1209   }
1210
1211   /**
1212    * Returns the list of edit commands wrapped by this object.
1213    *
1214    * @return
1215    */
1216   public List<Edit> getEdits()
1217   {
1218     return this.edits;
1219   }
1220
1221   /**
1222    * Returns a map whose keys are the dataset sequences, and values their
1223    * aligned sequences before the command edit list was applied. The aligned
1224    * sequences are copies, which may be updated without affecting the originals.
1225    *
1226    * The command holds references to the aligned sequences (after editing). If
1227    * the command is an 'undo',then the prior state is simply the aligned state.
1228    * Otherwise, we have to derive the prior state by working backwards through
1229    * the edit list to infer the aligned sequences before editing.
1230    *
1231    * Note: an alternative solution would be to cache the 'before' state of each
1232    * edit, but this would be expensive in space in the common case that the
1233    * original is never needed (edits are not mirrored).
1234    *
1235    * @return
1236    * @throws IllegalStateException
1237    *           on detecting an edit command of a type that can't be unwound
1238    */
1239   public Map<SequenceI, SequenceI> priorState(boolean forUndo)
1240   {
1241     Map<SequenceI, SequenceI> result = new HashMap<SequenceI, SequenceI>();
1242     if (getEdits() == null)
1243     {
1244       return result;
1245     }
1246     if (forUndo)
1247     {
1248       for (Edit e : getEdits())
1249       {
1250         for (SequenceI seq : e.getSequences())
1251         {
1252           SequenceI ds = seq.getDatasetSequence();
1253           // SequenceI preEdit = result.get(ds);
1254           if (!result.containsKey(ds))
1255           {
1256             /*
1257              * copy sequence including start/end (but don't use copy constructor
1258              * as we don't need annotations)
1259              */
1260             SequenceI preEdit = new Sequence("", seq.getSequenceAsString(),
1261                     seq.getStart(), seq.getEnd());
1262             preEdit.setDatasetSequence(ds);
1263             result.put(ds, preEdit);
1264           }
1265         }
1266       }
1267       return result;
1268     }
1269
1270     /*
1271      * Work backwards through the edit list, deriving the sequences before each
1272      * was applied. The final result is the sequence set before any edits.
1273      */
1274     Iterator<Edit> editList = new ReverseListIterator<Edit>(getEdits());
1275     while (editList.hasNext())
1276     {
1277       Edit oldEdit = editList.next();
1278       Action action = oldEdit.getAction();
1279       int position = oldEdit.getPosition();
1280       int number = oldEdit.getNumber();
1281       final char gap = oldEdit.getGapCharacter();
1282       for (SequenceI seq : oldEdit.getSequences())
1283       {
1284         SequenceI ds = seq.getDatasetSequence();
1285         SequenceI preEdit = result.get(ds);
1286         if (preEdit == null)
1287         {
1288           preEdit = new Sequence("", seq.getSequenceAsString(),
1289                   seq.getStart(), seq.getEnd());
1290           preEdit.setDatasetSequence(ds);
1291           result.put(ds, preEdit);
1292         }
1293         /*
1294          * 'Undo' this edit action on the sequence (updating the value in the
1295          * map).
1296          */
1297         if (ds != null)
1298         {
1299           if (action == Action.DELETE_GAP)
1300           {
1301             preEdit.setSequence(new String(StringUtils.insertCharAt(
1302                     preEdit.getSequence(), position, number, gap)));
1303           }
1304           else if (action == Action.INSERT_GAP)
1305           {
1306             preEdit.setSequence(new String(StringUtils.deleteChars(
1307                     preEdit.getSequence(), position, position + number)));
1308           }
1309           else
1310           {
1311             System.err.println("Can't undo edit action " + action);
1312             // throw new IllegalStateException("Can't undo edit action " +
1313             // action);
1314           }
1315         }
1316       }
1317     }
1318     return result;
1319   }
1320
1321   public class Edit
1322   {
1323     public SequenceI[] oldds;
1324
1325     boolean fullAlignmentHeight = false;
1326
1327     Map<SequenceI, AlignmentAnnotation[]> deletedAnnotationRows;
1328
1329     Map<String, Annotation[]> deletedAnnotations;
1330
1331     /*
1332      * features deleted by the cut (re-add on Undo)
1333      * (including the original of any shortened features)
1334      */
1335     Map<SequenceI, List<SequenceFeature>> deletedFeatures;
1336
1337     /*
1338      * shortened features added by the cut (delete on Undo)
1339      */
1340     Map<SequenceI, List<SequenceFeature>> truncatedFeatures;
1341
1342     AlignmentI al;
1343
1344     Action command;
1345
1346     char[][] string;
1347
1348     SequenceI[] seqs;
1349
1350     int[] alIndex;
1351
1352     int position, number;
1353
1354     char gapChar;
1355
1356     public Edit(Action cmd, SequenceI[] sqs, int pos, int count,
1357             char gap)
1358     {
1359       this.command = cmd;
1360       this.seqs = sqs;
1361       this.position = pos;
1362       this.number = count;
1363       this.gapChar = gap;
1364     }
1365
1366     Edit(Action cmd, SequenceI[] sqs, int pos, int count,
1367             AlignmentI align)
1368     {
1369       this(cmd, sqs, pos, count, align.getGapCharacter());
1370
1371       this.al = align;
1372
1373       alIndex = new int[sqs.length];
1374       for (int i = 0; i < sqs.length; i++)
1375       {
1376         alIndex[i] = align.findIndex(sqs[i]);
1377       }
1378
1379       fullAlignmentHeight = (align.getHeight() == sqs.length);
1380     }
1381
1382     Edit(Action cmd, SequenceI[] sqs, int pos, int count,
1383             AlignmentI align, String replace)
1384     {
1385       this(cmd, sqs, pos, count, align);
1386
1387       string = new char[sqs.length][];
1388       for (int i = 0; i < sqs.length; i++)
1389       {
1390         string[i] = replace.toCharArray();
1391       }
1392     }
1393
1394     public SequenceI[] getSequences()
1395     {
1396       return seqs;
1397     }
1398
1399     public int getPosition()
1400     {
1401       return position;
1402     }
1403
1404     public Action getAction()
1405     {
1406       return command;
1407     }
1408
1409     public int getNumber()
1410     {
1411       return number;
1412     }
1413
1414     public char getGapCharacter()
1415     {
1416       return gapChar;
1417     }
1418   }
1419
1420   /**
1421    * Returns an iterator over the list of edit commands which traverses the list
1422    * either forwards or backwards.
1423    *
1424    * @param forwards
1425    * @return
1426    */
1427   public Iterator<Edit> getEditIterator(boolean forwards)
1428   {
1429     if (forwards)
1430     {
1431       return getEdits().iterator();
1432     }
1433     else
1434     {
1435       return new ReverseListIterator<Edit>(getEdits());
1436     }
1437   }
1438
1439   /**
1440    * Adjusts features for Cut, and saves details of changes made to allow Undo
1441    * <ul>
1442    * <li>features left of the cut are unchanged</li>
1443    * <li>features right of the cut are shifted left</li>
1444    * <li>features internal to the cut region are deleted</li>
1445    * <li>features that overlap or span the cut are shortened</li>
1446    * <li>the originals of any deleted or shorted features are saved, to re-add
1447    * on Undo</li>
1448    * <li>any added (shortened) features are saved, to delete on Undo</li>
1449    * </ul>
1450    *
1451    * @param command
1452    * @param seq
1453    * @param fromPosition
1454    * @param toPosition
1455    * @param cutIsInternal
1456    */
1457   protected static void cutFeatures(Edit command, SequenceI seq,
1458           int fromPosition, int toPosition, boolean cutIsInternal)
1459   {
1460     if (!cutIsInternal)
1461     {
1462       return;
1463     }
1464     List<SequenceFeature> added = new ArrayList<>();
1465     List<SequenceFeature> removed = new ArrayList<>();
1466
1467     SequenceFeaturesI featureStore = seq.getFeatures();
1468     if (toPosition < fromPosition || featureStore == null)
1469     {
1470       return;
1471     }
1472
1473     int cutStartPos = fromPosition;
1474     int cutEndPos = toPosition;
1475     int cutWidth = cutEndPos - cutStartPos + 1;
1476
1477     synchronized (featureStore)
1478     {
1479       /*
1480        * get features that overlap the cut region
1481        */
1482       List<SequenceFeature> toAmend = featureStore.findFeatures(
1483               cutStartPos, cutEndPos);
1484
1485       /*
1486        * add any contact features that span the cut region
1487        * (not returned by findFeatures)
1488        */
1489       for (SequenceFeature contact : featureStore.getContactFeatures())
1490       {
1491         if (contact.getBegin() < cutStartPos
1492                 && contact.getEnd() > cutEndPos)
1493         {
1494           toAmend.add(contact);
1495         }
1496       }
1497
1498       /*
1499        * adjust start-end of overlapping features;
1500        * delete features enclosed by the cut;
1501        * delete partially overlapping contact features
1502        */
1503       for (SequenceFeature sf : toAmend)
1504       {
1505         int sfBegin = sf.getBegin();
1506         int sfEnd = sf.getEnd();
1507         int newBegin = sfBegin;
1508         int newEnd = sfEnd;
1509         boolean toDelete = false;
1510         boolean follows = false;
1511
1512         if (sfBegin >= cutStartPos && sfEnd <= cutEndPos)
1513         {
1514           /*
1515            * feature lies within cut region - delete it
1516            */
1517           toDelete = true;
1518         }
1519         else if (sfBegin < cutStartPos && sfEnd > cutEndPos)
1520         {
1521           /*
1522            * feature spans cut region - left-shift the end
1523            */
1524           newEnd -= cutWidth;
1525         }
1526         else if (sfEnd <= cutEndPos)
1527         {
1528           /*
1529            * feature overlaps left of cut region - truncate right
1530            */
1531           newEnd = cutStartPos - 1;
1532           if (sf.isContactFeature())
1533           {
1534             toDelete = true;
1535           }
1536         }
1537         else if (sfBegin >= cutStartPos)
1538         {
1539           /*
1540            * remaining case - feature overlaps right
1541            * truncate left, adjust end of feature
1542            */
1543           newBegin = cutIsInternal ? cutStartPos : cutEndPos + 1;
1544           newEnd = newBegin + sfEnd - cutEndPos - 1;
1545           if (sf.isContactFeature())
1546           {
1547             toDelete = true;
1548           }
1549         }
1550
1551         seq.deleteFeature(sf);
1552         if (!follows)
1553         {
1554           removed.add(sf);
1555         }
1556         if (!toDelete)
1557         {
1558           SequenceFeature copy = new SequenceFeature(sf, newBegin, newEnd,
1559                   sf.getFeatureGroup(), sf.getScore());
1560           seq.addSequenceFeature(copy);
1561           if (!follows)
1562           {
1563             added.add(copy);
1564           }
1565         }
1566       }
1567
1568       /*
1569        * and left shift any features lying to the right of the cut region
1570        * (but not if the cut is at start or end of sequence)
1571        */
1572       if (cutIsInternal)
1573       {
1574         featureStore.shiftFeatures(cutEndPos + 1, -cutWidth);
1575       }
1576     }
1577
1578     /*
1579      * save deleted and amended features, so that Undo can
1580      * re-add or delete them respectively
1581      */
1582     if (command.deletedFeatures == null)
1583     {
1584       command.deletedFeatures = new HashMap<>();
1585     }
1586     if (command.truncatedFeatures == null)
1587     {
1588       command.truncatedFeatures = new HashMap<>();
1589     }
1590     command.deletedFeatures.put(seq, removed);
1591     command.truncatedFeatures.put(seq, added);
1592   }
1593 }