bigwig_file.hpp

Go to the documentation of this file.

#ifndef TAKANE_BIGWIG_FILE_HPP
#define TAKANE_BIGWIG_FILE_HPP
 
#include "utils_files.hpp"
 
#include "ritsuko/ritsuko.hpp"
 
#include <filesystem>
#include <stdexcept>
#include <string>
 
namespace takane {
 
namespace bigwig_file {
 
inline void validate(const std::filesystem::path& path, const ObjectMetadata& metadata, Options& options) {
    const std::string type_name = "bigwig_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 numbers taken from https://data.broadinstitute.org/igv/projects/downloads/2.1/IGVDistribution_2.1.11/src/org/broad/igv/bbfile/BBFileHeader.java,
    // which seems to use the magic number to detect endianness of the file as well.
    auto ipath = path / "file.bw";
    std::array<unsigned char, 4> store;
    internal_files::extract_signature(ipath, store.data(), store.size());
 
    std::array<unsigned char, 4> be_magic { 0x26, 0xFC, 0x8F, 0x88 };
    std::array<unsigned char, 4> le_magic { 0x88, 0x8F, 0xFC, 0x26 };
    if (store != be_magic && store != le_magic) {
        throw std::runtime_error("incorrect bigWig file signature for '" + ipath.string() + "'");
    }
 
    if (options.bigwig_file_strict_check) {
        options.bigwig_file_strict_check(path, metadata, options);
    }
}
 
}
 
}
 
#endif