/*****************************************************************************
#   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.
#
#*****************************************************************************/
#ifndef fwdRevPair2_included
#define fwdRevPair2_included


#include    "rwcstring.h"

class LocatedFragment;
class GuiColorText;
class assemblyView;


const char cSQUARE = 's';
const char cTRIANGLE = 't';
const char cLINE = 'l';
   

class fwdRevPair2 {
public:
   LocatedFragment* pLeftLocFrag_;
   LocatedFragment* pRightLocFrag_;
   GuiColorText* pGctToUse_;
   enum { cCONSISTENT_WITHIN_SAME_CONTIG = 'c',
             cCONSISTENT_BETWEEN_SCAFFOLDS = 'b',
             cCONSISTENT_GAP_SPANNING = 'g',
             cINCONSISTENT_SAME_SCAFFOLD = 'i',
          cINCONSISTENT_BETWEEN_SCAFFOLDS = 'n' };
   char cType_; // one of the types above (not the cSQUARE, etc)

   enum { cPOINT_AWAY_FROM_EACH_OTHER = 'a',
          cBOTH_POINT_RIGHT = 'r',
          cBOTH_POINT_LEFT = 'l',
          cTOO_FAR_APART = 't',
          cTOO_FAR_FROM_END_OF_CONTIG = 'c',
          cDO_NOT_KNOW_IF_TOO_FAR_APART = 'd',
          cNO_PROBLEM = 'n' };

   char cProblem_; // one of the codes above

public:

   fwdRevPair2( LocatedFragment* pLeftLocFrag,
                LocatedFragment* pRightLocFrag,
                GuiColorText* pGctToUse,
                const char cType,
                const char cProblem ) :
      pLeftLocFrag_( pLeftLocFrag ),
      pRightLocFrag_( pRightLocFrag ),
      pGctToUse_( pGctToUse ),
      cType_( cType ),
      cProblem_( cProblem ) {}
   bool operator==( const fwdRevPair2& pair ) const {
      if ( this == &pair )
         return( true );
      else
         return( false );

   }


   bool bIsConsistent() {
      return( cType_ == cCONSISTENT_WITHIN_SAME_CONTIG ||
              cType_ == cCONSISTENT_BETWEEN_SCAFFOLDS ||
              cType_ == cCONSISTENT_GAP_SPANNING );
   }

   

   RWCString soGetType() {
      if ( cType_ == cCONSISTENT_WITHIN_SAME_CONTIG )
         return( "consistent within same contig" );
      else if ( cType_ == cCONSISTENT_BETWEEN_SCAFFOLDS )
         return( "consistent between scaffolds" );
      else if ( cType_ == cCONSISTENT_GAP_SPANNING )
         return( "consistent gap-spanning" );
      else if ( cType_ == cINCONSISTENT_SAME_SCAFFOLD )
         return( "inconsistent in same scaffold" );
      else if ( cType_ == cINCONSISTENT_BETWEEN_SCAFFOLDS )
         return( "inconsistent between scaffolds" );
      else {
         return( "?" );
      }
   }


   RWCString soGetProblem() {
      if ( cProblem_ == cPOINT_AWAY_FROM_EACH_OTHER )
         return( "<- ->");
      else if ( cProblem_ == cBOTH_POINT_RIGHT )
         return( "-> ->" );
      else if ( cProblem_ == cBOTH_POINT_LEFT )
         return( "<- <-" );
      else if ( cProblem_ == cTOO_FAR_APART )
         return( "too far apart" );
      else if ( cProblem_ == cTOO_FAR_FROM_END_OF_CONTIG )
         return( "too far from end of contig" );
      else if ( cProblem_ == cNO_PROBLEM )
         return( "no problem" );
      else if ( cProblem_ == cDO_NOT_KNOW_IF_TOO_FAR_APART )
         return( "do not know if too far apart because one of contigs is low quality" );
      else
         return( "?" );
   }


   virtual ~fwdRevPair2() {}


   // I changed this from being pure virtual functions because
   // there was some bug that I couldn't reproduce that gave
   // "abort:  pure virtual function called"

   virtual char cGetType() {
      return( 0 ); // cSQUARE, cTRIANGLE, or cLINE
   }

   virtual void drawThyself( assemblyView* pASV,
      const bool bHighlight ) {}


};

#endif