/*****************************************************************************
#   Copyright (C) 1994-2008 by David Gordon.
#   All rights reserved.                           
#                                                                           
#   This software is part of a beta-test version of the Consed/Autofinish
#   package.  It should not be redistributed or
#   used for any commercial purpose, including commercially funded
#   sequencing, without written permission from the author and the
#   University of Washington.
#   
#   This software is provided ``AS IS'' and any express or implied
#   warranties, including, but not limited to, the implied warranties of
#   merchantability and fitness for a particular purpose, are disclaimed.
#   In no event shall the authors or the University of Washington be
#   liable for any direct, indirect, incidental, special, exemplary, or
#   consequential damages (including, but not limited to, procurement of
#   substitute goods or services; loss of use, data, or profits; or
#   business interruption) however caused and on any theory of liability,
#   whether in contract, strict liability, or tort (including negligence
#   or otherwise) arising in any way out of the use of this software, even
#   if advised of the possibility of such damage.
#
#   Building Consed from source is error prone and not simple which is
#   why I provide executables.  Due to time limitations I cannot
#   provide any assistance in building Consed.  Even if you do not
#   modify the source, you may introduce errors due to using a
#   different version of the compiler, a different version of motif,
#   different versions of other libraries than I used, etc.  For this
#   reason, if you discover Consed bugs, I can only offer help with
#   those bugs if you first reproduce those bugs with an executable
#   provided by me--not an executable you have built.
# 
#   Modifying Consed is also difficult.  Although Consed is modular,
#   some modules are used by many other modules.  Thus making a change
#   in one place can have unforeseen effects on many other features.
#   It may takes months for you to notice these other side-effects
#   which may not seen connected at all.  It is not feasable for me to
#   provide help with modifying Consed sources because of the
#   potentially huge amount of time involved.
#
#*****************************************************************************/
//
// EditInsertColOfPads.h
//
// The EditInsertColOfPads object inserts a column of pads into the
// consensus and fragments aligned at a particular location in the
// passed Contig.
//

#ifndef EDITINSERTCOLOFPADS_INCLUDED
#define EDITINSERTCOLOFPADS_INCLUDED




#include    "sysdepend.h"
#include    "assert.h"
#include    "editaction.h"
#include    "contig.h"
#include    "locatedFragment.h"
#include    "tedwin.h"
#include    "assembly.h"
#include    "contigwin.h"
#include    "consed.h"

class EditInsertColOfPads : public EditAction {

 public:

   EditInsertColOfPads()
      :
      pContig_(0),
      nConsPos_(0) {}
   
   EditInsertColOfPads(Contig* pContig,
                  const int nConsPos )
      :
      pContig_(pContig),
      nConsPos_(nConsPos) {}
   
   ~EditInsertColOfPads() {}

   void doEditSpecific() {
      assert(pContig_);  // bug spray
      
      pContig_->insertColOfPads(nConsPos_);
   }

   void undoEditSpecific() { 
      assert(pContig_);

      pContig_->undoInsertColOfPads(nConsPos_);
   }

   virtual void refreshContigWin(ContigWin* pContigWin) {
      if (pContigWin->pGetContig() == pContig_ ) {
         pContigWin->resetSliderMax();
         pContigWin->drawBasesAndConsensus( true ); // erase first
      }
   }

   void setChangedIfNecessary() {
      bOldContigChanged_ = pContig_->bChanged();
      pContig_->setChanged();
   }      


   void undoSetChangedIfNecessary() {
      if ( ! bOldContigChanged_ ) {
         pContig_->setUnchanged();
      }
   }


   virtual void refreshTeditor( Teditor* pTeditor );


   virtual void writeEditToEditHistoryFile() {

    ConsEd :: pGetConsEd()->pAssemblyGet()->writeEditToEditHistoryFile( 
            "insertColumnOfPads %s %d", 
            (char*)pContig_->soGetName().data(),
            nConsPos_ );
   }

   virtual RWCString soGetDescriptionOfEdit() {
      int nUnpadded = pContig_->nUnpaddedIndex( nConsPos_ );
      
      char szTemp[200];
      sprintf( szTemp, "%d", nUnpadded );

      RWCString soDescription = "insert column of pads " +
         pContig_->soGetName() +
         " unpadded pos: " + szTemp;

      return( soDescription );
   }
   

 private:
   // contig where insertion is taking place
   Contig* pContig_;

   // consensus relative position of inserted column
   int nConsPos_;

   bool bOldContigChanged_;

};


#endif // EDITINSERTCOLOFPADS_INCLUDED