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           // do we need to edit sequence features for new sequence ?
 562           if (oldds != sequence.getDatasetSequence()
 563                   || (cutIsInternal
 564                           && sequence.getFeatures().hasFeatures()))
 565           {
 566             if (cutPositions != null)
 567             {
 568               cutFeatures(command, sequence, cutPositions.getBegin(),
 569                               cutPositions.getEnd(), cutIsInternal);
 570             }
 571           }
 572         }
 573       }
 574
 575       if (sequence.getLength() < 1)
 576       {
 577         command.al.deleteSequence(sequence);
 578         seqDeleted = true;
 579       }
 580     }
 581
 582     adjustAnnotations(command, false, seqDeleted, views);
 583   }
 584
 585   /**
 586    * Perform the given Paste command. This may be to add cut or copied sequences
 587    * to an alignment, or to undo a 'Cut' action on a region of the alignment.
 588    *
 589    * @param command
 590    * @param views
 591    */
 592   static void paste(Edit command, AlignmentI[] views)
 593   {
 594     boolean seqWasDeleted = false;
 595
 596     for (int i = 0; i < command.seqs.length; i++)
 597     {
 598       boolean newDSNeeded = false;
 599       boolean newDSWasNeeded = command.oldds != null
 600               && command.oldds[i] != null;
 601       SequenceI sequence = command.seqs[i];
 602       if (sequence.getLength() < 1)
 603       {
 604         /*
 605          * sequence was deleted; re-add it to the alignment
 606          */
 607         if (command.alIndex[i] < command.al.getHeight())
 608         {
 609           List<SequenceI> sequences;
 610           synchronized (sequences = command.al.getSequences())
 611           {
 612             if (!(command.alIndex[i] < 0))
 613             {
 614               sequences.add(command.alIndex[i], sequence);
 615             }
 616           }
 617         }
 618         else
 619         {
 620           command.al.addSequence(sequence);
 621         }
 622         seqWasDeleted = true;
 623       }
 624       int newStart = sequence.getStart();
 625       int newEnd = sequence.getEnd();
 626
 627       StringBuilder tmp = new StringBuilder();
 628       tmp.append(sequence.getSequence());
 629       // Undo of a delete does not replace original dataset sequence on to
 630       // alignment sequence.
 631
 632       int start = 0;
 633       int length = 0;
 634
 635       if (command.string != null && command.string[i] != null)
 636       {
 637         if (command.position >= tmp.length())
 638         {
 639           // This occurs if padding is on, and residues
 640           // are removed from end of alignment
 641           int len = command.position - tmp.length();
 642           while (len > 0)
 643           {
 644             tmp.append(command.gapChar);
 645             len--;
 646           }
 647         }
 648         tmp.insert(command.position, command.string[i]);
 649         for (int s = 0; s < command.string[i].length; s++)
 650         {
 651           if (!Comparison.isGap(command.string[i][s]))
 652           {
 653             length++;
 654             if (!newDSNeeded)
 655             {
 656               newDSNeeded = true;
 657               start = sequence.findPosition(command.position);
 658               // end = sequence
 659               // .findPosition(command.position + command.number);
 660             }
 661             if (sequence.getStart() == start)
 662             {
 663               newStart--;
 664             }
 665             else
 666             {
 667               newEnd++;
 668             }
 669           }
 670         }
 671         command.string[i] = null;
 672       }
 673
 674       sequence.setSequence(tmp.toString());
 675       sequence.setStart(newStart);
 676       sequence.setEnd(newEnd);
 677
 678       /*
 679        * command and Undo share the same dataset sequence if cut was
 680        * at start or end of sequence
 681        */
 682       boolean sameDatasetSequence = false;
 683       if (newDSNeeded)
 684       {
 685         if (sequence.getDatasetSequence() != null)
 686         {
 687           SequenceI ds;
 688           if (newDSWasNeeded)
 689           {
 690             ds = command.oldds[i];
 691           }
 692           else
 693           {
 694             // make a new DS sequence
 695             // use new ds mechanism here
 696             String ungapped = AlignSeq.extractGaps(Comparison.GapChars,
 697                     sequence.getSequenceAsString());
 698             ds = new Sequence(sequence.getName(), ungapped,
 699                     sequence.getStart(), sequence.getEnd());
 700             ds.setDescription(sequence.getDescription());
 701           }
 702           if (command.oldds == null)
 703           {
 704             command.oldds = new SequenceI[command.seqs.length];
 705           }
 706           command.oldds[i] = sequence.getDatasetSequence();
 707           sameDatasetSequence = ds == sequence.getDatasetSequence();
 708           ds.setSequenceFeatures(sequence.getSequenceFeatures());
 709           sequence.setDatasetSequence(ds);
 710         }
 711         undoCutFeatures(command, command.seqs[i], start, length,
 712                 sameDatasetSequence);
 713       }
 714     }
 715     adjustAnnotations(command, true, seqWasDeleted, views);
 716
 717     command.string = null;
 718   }
 719
 720   static void replace(Edit command)
 721   {
 722     StringBuffer tmp;
 723     String oldstring;
 724     int start = command.position;
 725     int end = command.number;
 726     // TODO TUTORIAL - Fix for replacement with different length of sequence (or
 727     // whole sequence)
 728     // TODO Jalview 2.4 bugfix change to an aggregate command - original
 729     // sequence string is cut, new string is pasted in.
 730     command.number = start + command.string[0].length;
 731     for (int i = 0; i < command.seqs.length; i++)
 732     {
 733       boolean newDSWasNeeded = command.oldds != null
 734               && command.oldds[i] != null;
 735
 736       /**
 737        * cut addHistoryItem(new EditCommand("Cut Sequences", EditCommand.CUT,
 738        * cut, sg.getStartRes(), sg.getEndRes()-sg.getStartRes()+1,
 739        * viewport.alignment));
 740        *
 741        */
 742       /**
 743        * then addHistoryItem(new EditCommand( "Add sequences",
 744        * EditCommand.PASTE, sequences, 0, alignment.getWidth(), alignment) );
 745        *
 746        */
 747       oldstring = command.seqs[i].getSequenceAsString();
 748       tmp = new StringBuffer(oldstring.substring(0, start));
 749       tmp.append(command.string[i]);
 750       String nogaprep = jalview.analysis.AlignSeq.extractGaps(
 751               jalview.util.Comparison.GapChars,
 752               new String(command.string[i]));
 753       int ipos = command.seqs[i].findPosition(start)
 754               - command.seqs[i].getStart();
 755       tmp.append(oldstring.substring(end));
 756       command.seqs[i].setSequence(tmp.toString());
 757       command.string[i] = oldstring.substring(start, end).toCharArray();
 758       String nogapold = AlignSeq.extractGaps(Comparison.GapChars,
 759               new String(command.string[i]));
 760       if (!nogaprep.toLowerCase().equals(nogapold.toLowerCase()))
 761       {
 762         if (newDSWasNeeded)
 763         {
 764           SequenceI oldds = command.seqs[i].getDatasetSequence();
 765           command.seqs[i].setDatasetSequence(command.oldds[i]);
 766           command.oldds[i] = oldds;
 767         }
 768         else
 769         {
 770           if (command.oldds == null)
 771           {
 772             command.oldds = new SequenceI[command.seqs.length];
 773           }
 774           command.oldds[i] = command.seqs[i].getDatasetSequence();
 775           SequenceI newds = new Sequence(
 776                   command.seqs[i].getDatasetSequence());
 777           String fullseq, osp = newds.getSequenceAsString();
 778           fullseq = osp.substring(0, ipos) + nogaprep
 779                   + osp.substring(ipos + nogaprep.length());
 780           newds.setSequence(fullseq.toUpperCase());
 781           // TODO: JAL-1131 ensure newly created dataset sequence is added to
 782           // the set of
 783           // dataset sequences associated with the alignment.
 784           // TODO: JAL-1131 fix up any annotation associated with new dataset
 785           // sequence to ensure that original sequence/annotation relationships
 786           // are preserved.
 787           command.seqs[i].setDatasetSequence(newds);
 788
 789         }
 790       }
 791       tmp = null;
 792       oldstring = null;
 793     }
 794   }
 795
 796   final static void adjustAnnotations(Edit command, boolean insert,
 797           boolean modifyVisibility, AlignmentI[] views)
 798   {
 799     AlignmentAnnotation[] annotations = null;
 800
 801     if (modifyVisibility && !insert)
 802     {
 803       // only occurs if a sequence was added or deleted.
 804       command.deletedAnnotationRows = new Hashtable<SequenceI, AlignmentAnnotation[]>();
 805     }
 806     if (command.fullAlignmentHeight)
 807     {
 808       annotations = command.al.getAlignmentAnnotation();
 809     }
 810     else
 811     {
 812       int aSize = 0;
 813       AlignmentAnnotation[] tmp;
 814       for (int s = 0; s < command.seqs.length; s++)
 815       {
 816         command.seqs[s].sequenceChanged();
 817
 818         if (modifyVisibility)
 819         {
 820           // Rows are only removed or added to sequence object.
 821           if (!insert)
 822           {
 823             // remove rows
 824             tmp = command.seqs[s].getAnnotation();
 825             if (tmp != null)
 826             {
 827               int alen = tmp.length;
 828               for (int aa = 0; aa < tmp.length; aa++)
 829               {
 830                 if (!command.al.deleteAnnotation(tmp[aa]))
 831                 {
 832                   // strip out annotation not in the current al (will be put
 833                   // back on insert in all views)
 834                   tmp[aa] = null;
 835                   alen--;
 836                 }
 837               }
 838               command.seqs[s].setAlignmentAnnotation(null);
 839               if (alen != tmp.length)
 840               {
 841                 // save the non-null annotation references only
 842                 AlignmentAnnotation[] saved = new AlignmentAnnotation[alen];
 843                 for (int aa = 0, aapos = 0; aa < tmp.length; aa++)
 844                 {
 845                   if (tmp[aa] != null)
 846                   {
 847                     saved[aapos++] = tmp[aa];
 848                     tmp[aa] = null;
 849                   }
 850                 }
 851                 tmp = saved;
 852                 command.deletedAnnotationRows.put(command.seqs[s], saved);
 853                 // and then remove any annotation in the other views
 854                 for (int alview = 0; views != null
 855                         && alview < views.length; alview++)
 856                 {
 857                   if (views[alview] != command.al)
 858                   {
 859                     AlignmentAnnotation[] toremove = views[alview]
 860                             .getAlignmentAnnotation();
 861                     if (toremove == null || toremove.length == 0)
 862                     {
 863                       continue;
 864                     }
 865                     // remove any alignment annotation on this sequence that's
 866                     // on that alignment view.
 867                     for (int aa = 0; aa < toremove.length; aa++)
 868                     {
 869                       if (toremove[aa].sequenceRef == command.seqs[s])
 870                       {
 871                         views[alview].deleteAnnotation(toremove[aa]);
 872                       }
 873                     }
 874                   }
 875                 }
 876               }
 877               else
 878               {
 879                 // save all the annotation
 880                 command.deletedAnnotationRows.put(command.seqs[s], tmp);
 881               }
 882             }
 883           }
 884           else
 885           {
 886             // recover rows
 887             if (command.deletedAnnotationRows != null
 888                     && command.deletedAnnotationRows
 889                             .containsKey(command.seqs[s]))
 890             {
 891               AlignmentAnnotation[] revealed = command.deletedAnnotationRows
 892                       .get(command.seqs[s]);
 893               command.seqs[s].setAlignmentAnnotation(revealed);
 894               if (revealed != null)
 895               {
 896                 for (int aa = 0; aa < revealed.length; aa++)
 897                 {
 898                   // iterate through al adding original annotation
 899                   command.al.addAnnotation(revealed[aa]);
 900                 }
 901                 for (int aa = 0; aa < revealed.length; aa++)
 902                 {
 903                   command.al.setAnnotationIndex(revealed[aa], aa);
 904                 }
 905                 // and then duplicate added annotation on every other alignment
 906                 // view
 907                 for (int vnum = 0; views != null && vnum < views.length; vnum++)
 908                 {
 909                   if (views[vnum] != command.al)
 910                   {
 911                     int avwidth = views[vnum].getWidth() + 1;
 912                     // duplicate in this view
 913                     for (int a = 0; a < revealed.length; a++)
 914                     {
 915                       AlignmentAnnotation newann = new AlignmentAnnotation(
 916                               revealed[a]);
 917                       command.seqs[s].addAlignmentAnnotation(newann);
 918                       newann.padAnnotation(avwidth);
 919                       views[vnum].addAnnotation(newann);
 920                       views[vnum].setAnnotationIndex(newann, a);
 921                     }
 922                   }
 923                 }
 924               }
 925             }
 926           }
 927           continue;
 928         }
 929
 930         if (command.seqs[s].getAnnotation() == null)
 931         {
 932           continue;
 933         }
 934
 935         if (aSize == 0)
 936         {
 937           annotations = command.seqs[s].getAnnotation();
 938         }
 939         else
 940         {
 941           tmp = new AlignmentAnnotation[aSize
 942                   + command.seqs[s].getAnnotation().length];
 943
 944           System.arraycopy(annotations, 0, tmp, 0, aSize);
 945
 946           System.arraycopy(command.seqs[s].getAnnotation(), 0, tmp, aSize,
 947                   command.seqs[s].getAnnotation().length);
 948
 949           annotations = tmp;
 950         }
 951         aSize = annotations.length;
 952       }
 953     }
 954
 955     if (annotations == null)
 956     {
 957       return;
 958     }
 959
 960     if (!insert)
 961     {
 962       command.deletedAnnotations = new Hashtable<String, Annotation[]>();
 963     }
 964
 965     int aSize;
 966     Annotation[] temp;
 967     for (int a = 0; a < annotations.length; a++)
 968     {
 969       if (annotations[a].autoCalculated
 970               || annotations[a].annotations == null)
 971       {
 972         continue;
 973       }
 974
 975       int tSize = 0;
 976
 977       aSize = annotations[a].annotations.length;
 978       if (insert)
 979       {
 980         temp = new Annotation[aSize + command.number];
 981         if (annotations[a].padGaps)
 982         {
 983           for (int aa = 0; aa < temp.length; aa++)
 984           {
 985             temp[aa] = new Annotation(command.gapChar + "", null, ' ', 0);
 986           }
 987         }
 988       }
 989       else
 990       {
 991         if (command.position < aSize)
 992         {
 993           if (command.position + command.number >= aSize)
 994           {
 995             tSize = aSize;
 996           }
 997           else
 998           {
 999             tSize = aSize - command.number;
1000           }
1001         }
1002         else
1003         {
1004           tSize = aSize;
1005         }
1006
1007         if (tSize < 0)
1008         {
1009           tSize = aSize;
1010         }
1011         temp = new Annotation[tSize];
1012       }
1013
1014       if (insert)
1015       {
1016         if (command.position < annotations[a].annotations.length)
1017         {
1018           System.arraycopy(annotations[a].annotations, 0, temp, 0,
1019                   command.position);
1020
1021           if (command.deletedAnnotations != null
1022                   && command.deletedAnnotations
1023                           .containsKey(annotations[a].annotationId))
1024           {
1025             Annotation[] restore = command.deletedAnnotations
1026                     .get(annotations[a].annotationId);
1027
1028             System.arraycopy(restore, 0, temp, command.position,
1029                     command.number);
1030
1031           }
1032
1033           System.arraycopy(annotations[a].annotations, command.position,
1034                   temp, command.position + command.number,
1035                   aSize - command.position);
1036         }
1037         else
1038         {
1039           if (command.deletedAnnotations != null
1040                   && command.deletedAnnotations
1041                           .containsKey(annotations[a].annotationId))
1042           {
1043             Annotation[] restore = command.deletedAnnotations
1044                     .get(annotations[a].annotationId);
1045
1046             temp = new Annotation[annotations[a].annotations.length
1047                     + restore.length];
1048             System.arraycopy(annotations[a].annotations, 0, temp, 0,
1049                     annotations[a].annotations.length);
1050             System.arraycopy(restore, 0, temp,
1051                     annotations[a].annotations.length, restore.length);
1052           }
1053           else
1054           {
1055             temp = annotations[a].annotations;
1056           }
1057         }
1058       }
1059       else
1060       {
1061         if (tSize != aSize || command.position < 2)
1062         {
1063           int copylen = Math.min(command.position,
1064                   annotations[a].annotations.length);
1065           if (copylen > 0)
1066           {
1067             System.arraycopy(annotations[a].annotations, 0, temp, 0,
1068                     copylen); // command.position);
1069           }
1070
1071           Annotation[] deleted = new Annotation[command.number];
1072           if (copylen >= command.position)
1073           {
1074             copylen = Math.min(command.number,
1075                     annotations[a].annotations.length - command.position);
1076             if (copylen > 0)
1077             {
1078               System.arraycopy(annotations[a].annotations, command.position,
1079                       deleted, 0, copylen); // command.number);
1080             }
1081           }
1082
1083           command.deletedAnnotations.put(annotations[a].annotationId,
1084                   deleted);
1085           if (annotations[a].annotations.length > command.position
1086                   + command.number)
1087           {
1088             System.arraycopy(annotations[a].annotations,
1089                     command.position + command.number, temp,
1090                     command.position, annotations[a].annotations.length
1091                             - command.position - command.number); // aSize
1092           }
1093         }
1094         else
1095         {
1096           int dSize = aSize - command.position;
1097
1098           if (dSize > 0)
1099           {
1100             Annotation[] deleted = new Annotation[command.number];
1101             System.arraycopy(annotations[a].annotations, command.position,
1102                     deleted, 0, dSize);
1103
1104             command.deletedAnnotations.put(annotations[a].annotationId,
1105                     deleted);
1106
1107             tSize = Math.min(annotations[a].annotations.length,
1108                     command.position);
1109             temp = new Annotation[tSize];
1110             System.arraycopy(annotations[a].annotations, 0, temp, 0, tSize);
1111           }
1112           else
1113           {
1114             temp = annotations[a].annotations;
1115           }
1116         }
1117       }
1118
1119       annotations[a].annotations = temp;
1120     }
1121   }
1122
1123   /**
1124    * Restores features to the state before a Cut.
1125    * <ul>
1126    * <li>re-add any features deleted by the cut</li>
1127    * <li>remove any truncated features created by the cut</li>
1128    * <li>shift right any features to the right of the cut</li>
1129    * </ul>
1130    *
1131    * @param command
1132    *          the Cut command
1133    * @param seq
1134    *          the sequence the Cut applied to
1135    * @param start
1136    *          the start residue position of the cut
1137    * @param length
1138    *          the number of residues cut
1139    * @param sameDatasetSequence
1140    *          true if dataset sequence and frame of reference were left
1141    *          unchanged by the Cut
1142    */
1143   final static void undoCutFeatures(Edit command, SequenceI seq,
1144           final int start, final int length, boolean sameDatasetSequence)
1145   {
1146     SequenceI sequence = seq.getDatasetSequence();
1147     if (sequence == null)
1148     {
1149       sequence = seq;
1150     }
1151
1152     /*
1153      * shift right features that lie to the right of the restored cut (but not
1154      * if dataset sequence unchanged - so coordinates were changed by Cut)
1155      */
1156     if (!sameDatasetSequence)
1157     {
1158       /*
1159        * shift right all features right of and not
1160        * contiguous with the cut position
1161        */
1162       seq.getFeatures().shiftFeatures(start + 1, length);
1163
1164       /*
1165        * shift right any features that start at the cut position,
1166        * unless they were truncated
1167        */
1168       List<SequenceFeature> sfs = seq.getFeatures().findFeatures(start,
1169               start);
1170       for (SequenceFeature sf : sfs)
1171       {
1172         if (sf.getBegin() == start)
1173         {
1174           if (!command.truncatedFeatures.containsKey(seq)
1175                   || !command.truncatedFeatures.get(seq).contains(sf))
1176           {
1177             /*
1178              * feature was shifted left to cut position (not truncated),
1179              * so shift it back right
1180              */
1181             SequenceFeature shifted = new SequenceFeature(sf, sf.getBegin()
1182                     + length, sf.getEnd() + length, sf.getFeatureGroup(),
1183                     sf.getScore());
1184             seq.addSequenceFeature(shifted);
1185             seq.deleteFeature(sf);
1186           }
1187         }
1188       }
1189     }
1190
1191     /*
1192      * restore any features that were deleted or truncated
1193      */
1194     if (command.deletedFeatures != null
1195             && command.deletedFeatures.containsKey(seq))
1196     {
1197       for (SequenceFeature deleted : command.deletedFeatures.get(seq))
1198       {
1199         sequence.addSequenceFeature(deleted);
1200       }
1201     }
1202
1203     /*
1204      * delete any truncated features
1205      */
1206     if (command.truncatedFeatures != null
1207             && command.truncatedFeatures.containsKey(seq))
1208     {
1209       for (SequenceFeature amended : command.truncatedFeatures.get(seq))
1210       {
1211         sequence.deleteFeature(amended);
1212       }
1213     }
1214   }
1215
1216   /**
1217    * Returns the list of edit commands wrapped by this object.
1218    *
1219    * @return
1220    */
1221   public List<Edit> getEdits()
1222   {
1223     return this.edits;
1224   }
1225
1226   /**
1227    * Returns a map whose keys are the dataset sequences, and values their
1228    * aligned sequences before the command edit list was applied. The aligned
1229    * sequences are copies, which may be updated without affecting the originals.
1230    *
1231    * The command holds references to the aligned sequences (after editing). If
1232    * the command is an 'undo',then the prior state is simply the aligned state.
1233    * Otherwise, we have to derive the prior state by working backwards through
1234    * the edit list to infer the aligned sequences before editing.
1235    *
1236    * Note: an alternative solution would be to cache the 'before' state of each
1237    * edit, but this would be expensive in space in the common case that the
1238    * original is never needed (edits are not mirrored).
1239    *
1240    * @return
1241    * @throws IllegalStateException
1242    *           on detecting an edit command of a type that can't be unwound
1243    */
1244   public Map<SequenceI, SequenceI> priorState(boolean forUndo)
1245   {
1246     Map<SequenceI, SequenceI> result = new HashMap<SequenceI, SequenceI>();
1247     if (getEdits() == null)
1248     {
1249       return result;
1250     }
1251     if (forUndo)
1252     {
1253       for (Edit e : getEdits())
1254       {
1255         for (SequenceI seq : e.getSequences())
1256         {
1257           SequenceI ds = seq.getDatasetSequence();
1258           // SequenceI preEdit = result.get(ds);
1259           if (!result.containsKey(ds))
1260           {
1261             /*
1262              * copy sequence including start/end (but don't use copy constructor
1263              * as we don't need annotations)
1264              */
1265             SequenceI preEdit = new Sequence("", seq.getSequenceAsString(),
1266                     seq.getStart(), seq.getEnd());
1267             preEdit.setDatasetSequence(ds);
1268             result.put(ds, preEdit);
1269           }
1270         }
1271       }
1272       return result;
1273     }
1274
1275     /*
1276      * Work backwards through the edit list, deriving the sequences before each
1277      * was applied. The final result is the sequence set before any edits.
1278      */
1279     Iterator<Edit> editList = new ReverseListIterator<Edit>(getEdits());
1280     while (editList.hasNext())
1281     {
1282       Edit oldEdit = editList.next();
1283       Action action = oldEdit.getAction();
1284       int position = oldEdit.getPosition();
1285       int number = oldEdit.getNumber();
1286       final char gap = oldEdit.getGapCharacter();
1287       for (SequenceI seq : oldEdit.getSequences())
1288       {
1289         SequenceI ds = seq.getDatasetSequence();
1290         SequenceI preEdit = result.get(ds);
1291         if (preEdit == null)
1292         {
1293           preEdit = new Sequence("", seq.getSequenceAsString(),
1294                   seq.getStart(), seq.getEnd());
1295           preEdit.setDatasetSequence(ds);
1296           result.put(ds, preEdit);
1297         }
1298         /*
1299          * 'Undo' this edit action on the sequence (updating the value in the
1300          * map).
1301          */
1302         if (ds != null)
1303         {
1304           if (action == Action.DELETE_GAP)
1305           {
1306             preEdit.setSequence(new String(StringUtils.insertCharAt(
1307                     preEdit.getSequence(), position, number, gap)));
1308           }
1309           else if (action == Action.INSERT_GAP)
1310           {
1311             preEdit.setSequence(new String(StringUtils.deleteChars(
1312                     preEdit.getSequence(), position, position + number)));
1313           }
1314           else
1315           {
1316             System.err.println("Can't undo edit action " + action);
1317             // throw new IllegalStateException("Can't undo edit action " +
1318             // action);
1319           }
1320         }
1321       }
1322     }
1323     return result;
1324   }
1325
1326   public class Edit
1327   {
1328     public SequenceI[] oldds;
1329
1330     boolean fullAlignmentHeight = false;
1331
1332     Map<SequenceI, AlignmentAnnotation[]> deletedAnnotationRows;
1333
1334     Map<String, Annotation[]> deletedAnnotations;
1335
1336     /*
1337      * features deleted by the cut (re-add on Undo)
1338      * (including the original of any shortened features)
1339      */
1340     Map<SequenceI, List<SequenceFeature>> deletedFeatures;
1341
1342     /*
1343      * shortened features added by the cut (delete on Undo)
1344      */
1345     Map<SequenceI, List<SequenceFeature>> truncatedFeatures;
1346
1347     AlignmentI al;
1348
1349     Action command;
1350
1351     char[][] string;
1352
1353     SequenceI[] seqs;
1354
1355     int[] alIndex;
1356
1357     int position, number;
1358
1359     char gapChar;
1360
1361     public Edit(Action cmd, SequenceI[] sqs, int pos, int count,
1362             char gap)
1363     {
1364       this.command = cmd;
1365       this.seqs = sqs;
1366       this.position = pos;
1367       this.number = count;
1368       this.gapChar = gap;
1369     }
1370
1371     Edit(Action cmd, SequenceI[] sqs, int pos, int count,
1372             AlignmentI align)
1373     {
1374       this(cmd, sqs, pos, count, align.getGapCharacter());
1375
1376       this.al = align;
1377
1378       alIndex = new int[sqs.length];
1379       for (int i = 0; i < sqs.length; i++)
1380       {
1381         alIndex[i] = align.findIndex(sqs[i]);
1382       }
1383
1384       fullAlignmentHeight = (align.getHeight() == sqs.length);
1385     }
1386
1387     Edit(Action cmd, SequenceI[] sqs, int pos, int count,
1388             AlignmentI align, String replace)
1389     {
1390       this(cmd, sqs, pos, count, align);
1391
1392       string = new char[sqs.length][];
1393       for (int i = 0; i < sqs.length; i++)
1394       {
1395         string[i] = replace.toCharArray();
1396       }
1397     }
1398
1399     public SequenceI[] getSequences()
1400     {
1401       return seqs;
1402     }
1403
1404     public int getPosition()
1405     {
1406       return position;
1407     }
1408
1409     public Action getAction()
1410     {
1411       return command;
1412     }
1413
1414     public int getNumber()
1415     {
1416       return number;
1417     }
1418
1419     public char getGapCharacter()
1420     {
1421       return gapChar;
1422     }
1423   }
1424
1425   /**
1426    * Returns an iterator over the list of edit commands which traverses the list
1427    * either forwards or backwards.
1428    *
1429    * @param forwards
1430    * @return
1431    */
1432   public Iterator<Edit> getEditIterator(boolean forwards)
1433   {
1434     if (forwards)
1435     {
1436       return getEdits().iterator();
1437     }
1438     else
1439     {
1440       return new ReverseListIterator<Edit>(getEdits());
1441     }
1442   }
1443
1444   /**
1445    * Adjusts features for Cut, and saves details of changes made to allow Undo
1446    * <ul>
1447    * <li>features left of the cut are unchanged</li>
1448    * <li>features right of the cut are shifted left</li>
1449    * <li>features internal to the cut region are deleted</li>
1450    * <li>features that overlap or span the cut are shortened</li>
1451    * <li>the originals of any deleted or shorted features are saved, to re-add
1452    * on Undo</li>
1453    * <li>any added (shortened) features are saved, to delete on Undo</li>
1454    * </ul>
1455    *
1456    * @param command
1457    * @param seq
1458    * @param fromPosition
1459    * @param toPosition
1460    * @param cutIsInternal
1461    */
1462   protected static void cutFeatures(Edit command, SequenceI seq,
1463           int fromPosition, int toPosition, boolean cutIsInternal)
1464   {
1465     if (!cutIsInternal)
1466     {
1467       return;
1468     }
1469     List<SequenceFeature> added = new ArrayList<>();
1470     List<SequenceFeature> removed = new ArrayList<>();
1471
1472     SequenceFeaturesI featureStore = seq.getFeatures();
1473     if (toPosition < fromPosition || featureStore == null)
1474     {
1475       return;
1476     }
1477
1478     int cutStartPos = fromPosition;
1479     int cutEndPos = toPosition;
1480     int cutWidth = cutEndPos - cutStartPos + 1;
1481
1482     synchronized (featureStore)
1483     {
1484       /*
1485        * get features that overlap the cut region
1486        */
1487       List<SequenceFeature> toAmend = featureStore.findFeatures(
1488               cutStartPos, cutEndPos);
1489
1490       /*
1491        * add any contact features that span the cut region
1492        * (not returned by findFeatures)
1493        */
1494       for (SequenceFeature contact : featureStore.getContactFeatures())
1495       {
1496         if (contact.getBegin() < cutStartPos
1497                 && contact.getEnd() > cutEndPos)
1498         {
1499           toAmend.add(contact);
1500         }
1501       }
1502
1503       /*
1504        * adjust start-end of overlapping features;
1505        * delete features enclosed by the cut;
1506        * delete partially overlapping contact features
1507        */
1508       for (SequenceFeature sf : toAmend)
1509       {
1510         int sfBegin = sf.getBegin();
1511         int sfEnd = sf.getEnd();
1512         int newBegin = sfBegin;
1513         int newEnd = sfEnd;
1514         boolean toDelete = false;
1515         boolean follows = false;
1516
1517         if (sfBegin >= cutStartPos && sfEnd <= cutEndPos)
1518         {
1519           /*
1520            * feature lies within cut region - delete it
1521            */
1522           toDelete = true;
1523         }
1524         else if (sfBegin < cutStartPos && sfEnd > cutEndPos)
1525         {
1526           /*
1527            * feature spans cut region - left-shift the end
1528            */
1529           newEnd -= cutWidth;
1530         }
1531         else if (sfEnd <= cutEndPos)
1532         {
1533           /*
1534            * feature overlaps left of cut region - truncate right
1535            */
1536           newEnd = cutStartPos - 1;
1537           if (sf.isContactFeature())
1538           {
1539             toDelete = true;
1540           }
1541         }
1542         else if (sfBegin >= cutStartPos)
1543         {
1544           /*
1545            * remaining case - feature overlaps right
1546            * truncate left, adjust end of feature
1547            */
1548           newBegin = cutIsInternal ? cutStartPos : cutEndPos + 1;
1549           newEnd = newBegin + sfEnd - cutEndPos - 1;
1550           if (sf.isContactFeature())
1551           {
1552             toDelete = true;
1553           }
1554         }
1555
1556         seq.deleteFeature(sf);
1557         if (!follows)
1558         {
1559           removed.add(sf);
1560         }
1561         if (!toDelete)
1562         {
1563           SequenceFeature copy = new SequenceFeature(sf, newBegin, newEnd,
1564                   sf.getFeatureGroup(), sf.getScore());
1565           seq.addSequenceFeature(copy);
1566           if (!follows)
1567           {
1568             added.add(copy);
1569           }
1570         }
1571       }
1572
1573       /*
1574        * and left shift any features lying to the right of the cut region
1575        * (but not if the cut is at start or end of sequence)
1576        */
1577       if (cutIsInternal)
1578       {
1579         featureStore.shiftFeatures(cutEndPos + 1, -cutWidth);
1580       }
1581     }
1582
1583     /*
1584      * save deleted and amended features, so that Undo can
1585      * re-add or delete them respectively
1586      */
1587     if (command.deletedFeatures == null)
1588     {
1589       command.deletedFeatures = new HashMap<>();
1590     }
1591     if (command.truncatedFeatures == null)
1592     {
1593       command.truncatedFeatures = new HashMap<>();
1594     }
1595     command.deletedFeatures.put(seq, removed);
1596     command.truncatedFeatures.put(seq, added);
1597   }
1598 }