/*  $Id: agp_seq_entry.hpp 409529 2013-08-08 12:45:44Z kornbluh $
 * ===========================================================================
 *
 *                            PUBLIC DOMAIN NOTICE
 *               National Center for Biotechnology Information
 *
 *  This software/database is a "United States Government Work" under the
 *  terms of the United States Copyright Act.  It was written as part of
 *  the author's official duties as a United States Government employee and
 *  thus cannot be copyrighted.  This software/database is freely available
 *  to the public for use. The National Library of Medicine and the U.S.
 *  Government have not placed any restriction on its use or reproduction.
 *
 *  Although all reasonable efforts have been taken to ensure the accuracy
 *  and reliability of the software and data, the NLM and the U.S.
 *  Government do not and cannot warrant the performance or results that
 *  may be obtained by using this software or data. The NLM and the U.S.
 *  Government disclaim all warranties, express or implied, including
 *  warranties of performance, merchantability or fitness for any particular
 *  purpose.
 *
 *  Please cite the author in any work or product based on this material.
 *
 * ===========================================================================
 *
 * Authors:  Mike DiCuccio, Michael Kornbluh
 *
 * File Description:
 *     Convert an AGP file into a vector of Seq-entries
 *
 */

#ifndef __OBJTOOLS_READERS_AGP_SEQ_ENTRY__HPP_
#define __OBJTOOLS_READERS_AGP_SEQ_ENTRY__HPP_

#include <objtools/readers/agp_util.hpp>

#include <objects/seq/Bioseq.hpp>

BEGIN_NCBI_SCOPE

namespace objects {
    class CBioseq;
    class CSeq_entry;
    class CSeq_id;
    class CSeq_gap;
}

/// This class is used to turn an AGP file into a vector of Seq-entry's
class NCBI_XOBJREAD_EXPORT CAgpToSeqEntry : public CAgpReader {
public:

    /// This is the way the results will be returned
    /// Each Seq-entry contains just one Bioseq, built from the AGP file(s).
    typedef vector< CRef<objects::CSeq_entry> > TSeqEntryRefVec;

    enum EFlags {
        /// Found gaps will not be given Seq-data such as Type and Linkage
        fSetSeqGap     = (1 << 0), 
        /// All IDs will be treated as local IDs.
        /// The default if this is NOT set is to first try to parse the ID,
        /// and only make local if parsing fails.
        fForceLocalId  = (1 << 1)  
    };
    typedef int TFlags;

    /// After construction, you probably want to do something like
    /// call ReadStream and then GetResult.
    ///
    /// @param agp_version
    ///   What is the AGP version of the input?  Default is to auto-detect AGP version,
    ///   which is likely what the user wants to do most of the time.
    CAgpToSeqEntry( TFlags fFlags = 0, 
        EAgpVersion agp_version = eAgpVersion_auto,
        CAgpErr* arg = NULL );

    /// This gets the results found, but don't call before finalizing.  We are intentionally
    /// giving a non-const reference because the caller is free to 
    /// take the seq-entries inside and do whatever they like with them.
    /// Each Seq-entry contains just one Bioseq, built from the AGP file(s).
    TSeqEntryRefVec & GetResult(void) { return m_entries; }

    /// This is the default method used to turn strings into Seq-ids in AGP contexts.
    ///
    /// @sa x_GetSeqIdFromStr
    static CRef<objects::CSeq_id> s_DefaultSeqIdFromStr( const std::string & str );

    /// Turn a string into a local Seq-id (removing "lcl|" from the beginning if needed)
    static CRef<objects::CSeq_id> s_LocalSeqIdFromStr( const std::string & str );

protected:

    const TFlags m_fFlags;

    /// Builds new part of delta-seq in current bioseq, or adds bioseq
    /// and starts building a new one.
    virtual void OnGapOrComponent(void);

    /// Parent finalize plus making sure last m_bioseq is added.
    virtual int Finalize(void);

    /// Our own finalization after parent's finalization.
    void x_FinishedBioseq(void);

    /// If you must change exactly how strings are turned into Seq-ids,
    /// you can override this in a subclass.  The default 
    // is to use s_DefaultSeqIdFromStr.
    virtual CRef<objects::CSeq_id> x_GetSeqIdFromStr( const std::string & str );

    /// Fills in out_gap_info based on current CAgpRow
    void x_SetSeqGap( objects::CSeq_gap & out_gap_info );

    /// This is the bioseq currently being built
    CRef<objects::CBioseq> m_bioseq;
    /// Holds the results
    vector< CRef<objects::CSeq_entry> > m_entries;

private:

    // forbid copy and assignment
    CAgpToSeqEntry( const CAgpToSeqEntry & );
    CAgpToSeqEntry & operator = (const CAgpToSeqEntry & );
};

END_NCBI_SCOPE

#endif // end of "include-guard"
