takane
Validators for ArtifactDB file formats
Loading...
Searching...
No Matches
fasta_file.hpp
Go to the documentation of this file.
1#ifndef TAKANE_FASTA_FILE_HPP
2#define TAKANE_FASTA_FILE_HPP
3
4#include "utils_files.hpp"
5#include "ritsuko/ritsuko.hpp"
6
7#include <filesystem>
8#include <stdexcept>
9#include <string>
10
16namespace takane {
17
22namespace fasta_file {
23
32inline void validate(const std::filesystem::path& path, const ObjectMetadata& metadata, Options& options) {
33 const std::string type_name = "fasta_file"; // use a separate variable to avoid dangling reference warnings from GCC.
34 const auto& famap = internal_json::extract_typed_object_from_metadata(metadata.other, type_name);
35
36 const std::string version_name = "version"; // again, avoid dangling reference warnings.
37 const std::string& vstring = internal_json::extract_string_from_typed_object(famap, version_name, type_name);
38 auto version = ritsuko::parse_version_string(vstring.c_str(), vstring.size(), /* skip_patch = */ true);
39 if (version.major != 1) {
40 throw std::runtime_error("unsupported version string '" + vstring + "'");
41 }
42
43 internal_files::check_sequence_type(famap, type_name.c_str());
44
45 // Check if it's indexed.
46 bool indexed = internal_files::is_indexed(famap);
47 auto fpath = path / "file.fasta.";
48 if (indexed) {
49 fpath += "bgz";
50 } else {
51 fpath += "gz";
52 }
53
54 internal_files::check_gzip_signature(fpath);
55 auto reader = internal_other::open_reader<byteme::GzipFileReader>(fpath, 10);
56 byteme::PerByte<> pb(&reader);
57 if (!pb.valid() || pb.get() != '>') {
58 throw std::runtime_error("FASTA file does not start with '>'");
59 }
60
61 if (indexed) {
62 auto fixpath = path / "file.fasta.fai";
63 if (!std::filesystem::exists(fixpath)) {
64 throw std::runtime_error("missing FASTA index file");
65 }
66
67 auto ixpath = fpath;
68 ixpath += ".gzi";
69 if (!std::filesystem::exists(ixpath)) {
70 throw std::runtime_error("missing BGZF index file");
71 }
72 }
73
74 if (options.fasta_file_strict_check) {
75 options.fasta_file_strict_check(path, metadata, options, indexed);
76 }
77}
78
79}
80
81}
82
83#endif
void validate(const std::filesystem::path &path, const ObjectMetadata &metadata, Options &options)
Definition fasta_file.hpp:32
takane validation functions.
Definition _derived_from.hpp:15
Object metadata, including the type and other fields.
Definition utils_public.hpp:26
std::unordered_map< std::string, std::shared_ptr< millijson::Base > > other
Definition utils_public.hpp:35
Validation options.
Definition utils_public.hpp:94
std::function< void(const std::filesystem::path &, const ObjectMetadata &, Options &, bool)> fasta_file_strict_check
Definition utils_public.hpp:199