src/api/internal/BamHeader_p.h

   1 // ***************************************************************************
   2 // BamHeader_p.h (c) 2010 Derek Barnett
   3 // Marth Lab, Department of Biology, Boston College
   4 // All rights reserved.
   5 // ---------------------------------------------------------------------------
   6 // Last modified: 26 January 2011 (DB)
   7 // ---------------------------------------------------------------------------
   8 // Provides the basic functionality for handling BAM headers.
   9 // ***************************************************************************
  10
  11 #ifndef BAMHEADER_P_H
  12 #define BAMHEADER_P_H
  13
  14 //  -------------
  15 //  W A R N I N G
  16 //  -------------
  17 //
  18 // This file is not part of the BamTools API.  It exists purely as an
  19 // implementation detail. This header file may change from version to version
  20 // without notice, or even be removed.
  21 //
  22 // We mean it.
  23
  24 #include <api/SamHeader.h>
  25 #include <string>
  26
  27 namespace BamTools {
  28 namespace Internal {
  29
  30 class BgzfStream;
  31
  32 class BamHeader {
  33
  34     // ctor & dtor
  35     public:
  36         BamHeader(void);
  37         ~BamHeader(void);
  38
  39     // BamHeader interface
  40     public:
  41         // clear SamHeader data
  42         void Clear(void);
  43         // return true if SamHeader data is valid
  44         bool IsValid(void) const;
  45         // load BAM header ('magic number' and SAM header text) from BGZF stream
  46         // returns true if all OK
  47         bool Load(BgzfStream* stream);
  48         // returns (editable) copy of SamHeader data object
  49         SamHeader ToSamHeader(void) const;
  50         // returns SAM-formatted string of header data
  51         std::string ToString(void) const;
  52
  53     // internal methods
  54     private:
  55         // reads magic number from BGZF stream, returns true if valid
  56         bool CheckMagicNumber(BgzfStream* stream);
  57         // reads SAM header length from BGZF stream, stores it in @length
  58         // returns read success/fail status
  59         bool ReadHeaderLength(BgzfStream* stream, uint32_t& length);
  60         // reads SAM header text from BGZF stream, stores in SamHeader object
  61         // returns read success/fail status
  62         bool ReadHeaderText(BgzfStream* stream, const uint32_t& length);
  63
  64     // data members
  65     private:
  66         SamHeader m_header;
  67 };
  68
  69 } // namespace Internal
  70 } // namespace BamTools
  71
  72 #endif // BAMHEADER_P_H