bcf_file.hpp

Go to the documentation of this file.

#ifndef TAKANE_BCF_FILE_HPP
#define TAKANE_BCF_FILE_HPP
 
#include "utils_files.hpp"
 
#include "ritsuko/ritsuko.hpp"
 
#include <filesystem>
#include <stdexcept>
#include <string>
 
namespace takane {
 
namespace bcf_file {
 
inline void validate(const std::filesystem::path& path, const ObjectMetadata& metadata, Options& options) {
    const std::string type_name = "bcf_file"; // use a separate variable to avoid dangling reference warnings from GCC.
    const std::string& vstring = internal_json::extract_version_for_type(metadata.other, type_name);
    auto version = ritsuko::parse_version_string(vstring.c_str(), vstring.size(), /* skip_patch = */ true);
    if (version.major != 1) {
        throw std::runtime_error("unsupported version string '" + vstring + "'");
    }
 
    // Magic number taken from https://samtools.github.io/hts-specs/BCFv2_qref.pdf
    // We relax it a little to support both BCF1 and BCF2+ formats.
    auto ipath = path / "file.bcf";
    internal_files::check_gzip_signature(ipath);
    internal_files::check_signature<byteme::GzipFileReader>(ipath, "BCF", 3, "BCF");
 
    // Magic number taken from https://samtools.github.io/hts-specs/tabix.pdf
    auto ixpath = ipath;
    ixpath += ".tbi";
    if (std::filesystem::exists(ixpath)) {
        internal_files::check_gzip_signature(ixpath);
        internal_files::check_signature<byteme::GzipFileReader>(ixpath, "TBI\1", 4, "tabix");
    }
 
    // Magic number taken from https://samtools.github.io/hts-specs/CSIv1.pdf
    ixpath = ipath;
    ixpath += ".csi";
    if (std::filesystem::exists(ixpath)) {
        internal_files::check_gzip_signature(ixpath);
        internal_files::check_signature<byteme::GzipFileReader>(ixpath, "CSI\1", 4, "CSI index");
    }
 
    if (options.bcf_file_strict_check) {
        options.bcf_file_strict_check(path, metadata, options);
    }
}
 
}
 
}
 
#endif