BamHeader.h

#ifndef theplu_yat_omic_bam_header
#define theplu_yat_omic_bam_header

// $Id: BamHeader.h 3999 2020-10-08 23:22:32Z peter $

/*
  Copyright (C) 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2020 Peter Johansson

  This file is part of the yat library, http://dev.thep.lu.se/yat

  The yat library is free software; you can redistribute it and/or
  modify it under the terms of the GNU General Public License as
  published by the Free Software Foundation; either version 3 of the
  License, or (at your option) any later version.

  The yat library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with yat. If not, see <http://www.gnu.org/licenses/>.
*/

#include "yat/utility/config_public.h"
#include "yat/utility/stl_utility.h"

#include <htslib/sam.h>

#include <boost/iterator/transform_iterator.hpp>

#include <map>
#include <string>

namespace theplu {
namespace yat {
namespace omic {

  class BamHeader
  {
    typedef std::map<std::string, std::string> strMap;
    typedef std::map<std::string, strMap> strMap2;
  public:
    BamHeader(void);

    ~BamHeader(void);

    BamHeader(const BamHeader&);

    BamHeader(BamHeader&&) noexcept;

    void parse_region(const std::string& reg, int& tid, int& begin,
                      int& end) const;

    const std::string& program_group(const std::string& id,
                                     const std::string& key) const;

    const std::string& read_group(const std::string& id,
                                  const std::string& key) const;

    const std::map<std::string, std::string>&
    read_group(const std::string& id) const;

    typedef boost::transform_iterator<
      utility::PairFirst<const strMap2::value_type>,
      strMap2::const_iterator>
    read_group_iterator;

    read_group_iterator read_group_begin(void) const;

    read_group_iterator read_group_end(void) const;

    void swap(BamHeader& other);

    const char* target_name(size_t tid) const;

    uint32_t target_length(size_t tid) const;

    std::string text(void) const;

    void text(const std::string& txt);

    int32_t tid(const std::string& name) const;

    int32_t n_targets(void) const;

    BamHeader& operator=(const BamHeader& rhs);

    BamHeader& operator=(BamHeader&& rhs);

  private:
    bam_hdr_t* header_;
    mutable strMap2 read_group_;
    mutable strMap2 program_group_;

    friend class InBamFile;
    friend class OutBamFile;

    const std::string& group(strMap2& map, const std::string& type,
                             const std::string& id,
                             const std::string& key) const;

    void update_group(strMap2& map, const std::string& type) const;

    // using compiler generated copy and assignment
  };

  void swap(BamHeader& lhs, BamHeader& rhs);

}}}
#endif