93template <
typename val
idator_type>
95 std::copyable<std::remove_cvref_t<validator_type>>
101 } -> std::same_as<void>;
104 } -> std::same_as<std::string>;
123template <arithmetic option_value_t>
143 if (!((cmp <= max) && (cmp >= min)))
144 throw validation_error{detail::to_string(
"Value ", cmp,
" is not in range [", min,
",", max,
"].")};
153 template <std::ranges::forward_range range_type>
168 return detail::to_string(
"Value must be in range [", min,
",", max,
"].");
198template <
typename option_value_t>
220 template <std::ranges::forward_range range_type>
221 requires std::constructible_from<option_value_type, std::ranges::range_rvalue_reference_t<range_type>>
233 template <
typename... option_types>
234 requires ((std::constructible_from<option_value_type, option_types> && ...))
237 (values.
emplace_back(std::forward<option_types>(opts)), ...);
248 throw validation_error{detail::to_string(
"Value ", cmp,
" is not one of ", std::views::all(values),
".")};
256 template <std::ranges::forward_range range_type>
257 requires std::convertible_to<std::ranges::range_value_t<range_type>,
option_value_type>
261 std::ranges::end(range),
271 return detail::to_string(
"Value must be one of ", std::views::all(values),
".");
284template <
typename option_type,
typename... option_types>
285 requires (std::constructible_from<std::string, std::decay_t<option_types>> && ...
286 && std::constructible_from<std::string, std::decay_t<option_type>>)
290template <
typename range_type>
291 requires (std::ranges::forward_range<std::decay_t<range_type>>
292 && std::constructible_from<std::string, std::ranges::range_value_t<range_type>>)
296template <
typename option_type,
typename... option_types>
300template <
typename range_type>
301 requires (std::ranges::forward_range<std::decay_t<range_type>>)
352 template <std::ranges::forward_range range_type>
354 && !std::convertible_to<range_type, std::filesystem::path const &>)
355 void operator()(range_type
const & v)
const
361 this->operator()(cmp);
381 " has no extension. Expected"
382 " one of the following valid extensions:",
389 if (file_path.front() ==
'.')
390 file_path.erase(0, 1);
396 auto case_insensitive_ends_with = [&](
std::string const & ext)
404 throw validation_error{detail::to_string(
"Expected one of the following valid extensions: ",
424 if (
static_cast<bool>(ec))
425 throw validation_error{detail::to_string(
"Cannot read the directory ", path,
"!")};
431 throw validation_error{detail::to_string(
"Expected a regular file ", path,
"!")};
434 if (!file.is_open() || !file.good())
435 throw validation_error{detail::to_string(
"Cannot read the file ", path,
"!")};
447 detail::safe_filesystem_entry file_guard{path};
449 bool is_open = file.is_open();
450 bool is_good = file.good();
453 if (!is_good || !is_open)
465 return detail::to_string(
" Valid file extensions are: [",
477 size_t const suffix_length{suffix.
size()};
478 size_t const str_length{str.
size()};
479 return suffix_length > str_length ? false
482 [](
char const chr1,
char const chr2)
484 return std::tolower(chr1) == std::tolower(chr2);
516template <
typename file_t =
void>
520 static_assert(std::same_as<file_t, void> || detail::has_type_valid_formats<file_t>,
521 "Expected either a template type with a static member called valid_formats (a file type) or void.");
540 if constexpr (!std::same_as<file_t, void>)
559 requires std::same_as<file_t, void>
570 using file_validator_base::operator();
582 throw validation_error{detail::to_string(
"The file ", file,
" does not exist!")};
646template <
typename file_t =
void>
650 static_assert(std::same_as<file_t, void> || detail::has_type_valid_formats<file_t>,
651 "Expected either a template type with a static member called valid_formats (a file type) or void.");
698 if constexpr (!std::same_as<file_t, void>)
699 return detail::valid_file_extensions<typename file_t::valid_formats>();
704 using file_validator_base::operator();
716 throw validation_error{detail::to_string(
"The file ", file,
" already exists!")};
741 return "The output file must not exist already and write permissions must be granted."
787 using file_validator_base::operator();
799 throw validation_error{detail::to_string(
"The directory ", dir,
" does not exists!")};
802 throw validation_error{detail::to_string(
"The path ", dir,
" is not a directory!")};
822 return detail::to_string(
"An existing, readable path for the input directory.");
863 using file_validator_base::operator();
877 if (
static_cast<bool>(ec))
878 throw validation_error{detail::to_string(
"Cannot create directory: ", dir,
"!")};
884 detail::safe_filesystem_entry dir_guard{dir};
886 dir_guard.remove_all();
908 return detail::to_string(
"A valid path for the output directory.");
951 throw validation_error{detail::to_string(
"Value ", cmp,
" did not match the pattern ", pattern,
".")};
960 template <std::ranges::forward_range range_type>
961 requires std::convertible_to<std::ranges::range_reference_t<range_type>,
option_value_type const &>
964 for (
auto && file_name : v)
974 return detail::to_string(
"Value must match the pattern '", pattern,
"'.");
997template <
typename option_value_t>
998struct default_validator
1001 using option_value_type = option_value_t;
1004 void operator()(option_value_t
const & )
const noexcept
1027template <val
idator val
idator1_type, val
idator val
idator2_type>
1028 requires std::common_with<typename validator1_type::option_value_type, typename validator2_type::option_value_type>
1029class validator_chain_adaptor
1039 validator_chain_adaptor() =
delete;
1040 validator_chain_adaptor(validator_chain_adaptor
const & pf) =
default;
1041 validator_chain_adaptor & operator=(validator_chain_adaptor
const & pf) =
default;
1042 validator_chain_adaptor(validator_chain_adaptor &&) =
default;
1043 validator_chain_adaptor & operator=(validator_chain_adaptor &&) =
default;
1049 validator_chain_adaptor(validator1_type vali1_, validator2_type vali2_) :
1055 ~validator_chain_adaptor() =
default;
1066 template <
typename cmp_type>
1067 requires std::invocable<validator1_type, cmp_type const> && std::invocable<validator2_type, cmp_type const>
1077 return detail::to_string(vali1.get_help_page_message(),
" ", vali2.get_help_page_message());
1082 validator1_type vali1;
1084 validator2_type vali2;
1118template <val
idator val
idator1_type, val
idator val
idator2_type>
1119 requires std::common_with<typename std::remove_reference_t<validator1_type>::option_value_type,
1121auto operator|(validator1_type && vali1, validator2_type && vali2)
1123 return detail::validator_chain_adaptor{std::forward<validator1_type>(vali1), std::forward<validator2_type>(vali2)};
T back_inserter(T... args)
Provides various type traits on generic types.
A validator that checks whether a number is inside a given range.
Definition validators.hpp:125
void operator()(option_value_type const &cmp) const
Tests whether cmp lies inside [min, max].
Definition validators.hpp:141
option_value_t option_value_type
The type of value that this validator invoked upon.
Definition validators.hpp:128
void operator()(range_type const &range) const
Tests whether every element in range lies inside [min, max].
Definition validators.hpp:155
std::string get_help_page_message() const
Returns a message that can be appended to the (positional) options help page info.
Definition validators.hpp:166
arithmetic_range_validator(option_value_type const min_, option_value_type const max_)
The constructor.
Definition validators.hpp:134
An abstract base class for the file and directory validators.
Definition validators.hpp:320
bool case_insensitive_string_ends_with(std::string_view str, std::string_view suffix) const
Helper function that checks if a string is a suffix of another string. Case insensitive.
Definition validators.hpp:475
void validate_filename(std::filesystem::path const &path) const
Validates the given filename path based on the specified extensions.
Definition validators.hpp:371
std::string valid_extensions_help_page_message() const
Returns the information of valid file extensions.
Definition validators.hpp:460
virtual void operator()(std::filesystem::path const &path) const =0
Tests if the given path is a valid input, respectively output, file or directory.
std::string option_value_type
Type of values that are tested by validator.
Definition validators.hpp:323
file_validator_base(file_validator_base &&)=default
Defaulted.
file_validator_base & operator=(file_validator_base &&)=default
Defaulted.
void validate_readability(std::filesystem::path const &path) const
Checks if the given path is readable.
Definition validators.hpp:417
file_validator_base()=default
Defaulted.
file_validator_base(file_validator_base const &)=default
Defaulted.
std::vector< std::string > extensions
Stores the extensions.
Definition validators.hpp:489
virtual ~file_validator_base()=default
file_validator_base & operator=(file_validator_base const &)=default
Defaulted.
void validate_writeability(std::filesystem::path const &path) const
Checks if the given path is writable.
Definition validators.hpp:444
A validator that checks if a given path is a valid output directory.
Definition validators.hpp:843
output_directory_validator()=default
Defaulted.
output_directory_validator & operator=(output_directory_validator const &)=default
Defaulted.
virtual ~output_directory_validator()=default
Virtual Destructor.
output_directory_validator(output_directory_validator &&)=default
Defaulted.
output_directory_validator(output_directory_validator const &)=default
Defaulted.
virtual void operator()(std::filesystem::path const &dir) const override
Tests whether path is writable.
Definition validators.hpp:870
std::string get_help_page_message() const
Returns a message that can be appended to the (positional) options help page info.
Definition validators.hpp:906
output_directory_validator & operator=(output_directory_validator &&)=default
Defaulted.
A validator that checks if a given path is a valid output file.
Definition validators.hpp:648
static std::vector< std::string > default_extensions()
The default extensions of file_t.
Definition validators.hpp:696
output_file_validator(output_file_validator &&)=default
Defaulted.
output_file_validator(output_file_validator const &)=default
Defaulted.
virtual void operator()(std::filesystem::path const &file) const override
Tests whether path is does not already exists and is writable.
Definition validators.hpp:711
output_file_validator()
Default constructor.
Definition validators.hpp:661
output_file_validator & operator=(output_file_validator const &)=default
Defaulted.
output_file_validator & operator=(output_file_validator &&)=default
Defaulted.
std::string get_help_page_message() const
Returns a message that can be appended to the (positional) options help page info.
Definition validators.hpp:736
virtual ~output_file_validator()=default
Virtual Destructor.
output_file_validator(output_file_open_options const mode, std::vector< std::string > extensions=default_extensions())
Constructs from a given overwrite mode and a list of valid extensions.
Definition validators.hpp:676
A validator that checks if a matches a regular expression pattern.
Definition validators.hpp:932
std::string get_help_page_message() const
Returns a message that can be appended to the (positional) options help page info.
Definition validators.hpp:972
void operator()(option_value_type const &cmp) const
Tests whether cmp lies inside values.
Definition validators.hpp:947
std::string option_value_type
Type of values that are tested by validator.
Definition validators.hpp:935
void operator()(range_type const &v) const
Tests whether every filename in list v matches the pattern.
Definition validators.hpp:962
regex_validator(std::string const &pattern_)
Constructing from a vector.
Definition validators.hpp:940
Argument parser exception thrown when an argument could not be casted to the according type.
Definition exceptions.hpp:128
A validator that checks whether a value is inside a list of valid values.
Definition validators.hpp:200
value_list_validator(option_type, option_types...) -> value_list_validator< option_type >
Deduction guide for a parameter pack.
value_list_validator()=default
Defaulted.
void operator()(option_value_type const &cmp) const
Tests whether cmp lies inside values.
Definition validators.hpp:245
value_list_validator(value_list_validator const &)=default
Defaulted.
value_list_validator & operator=(value_list_validator const &)=default
Defaulted.
option_value_t option_value_type
Type of values that are tested by validator.
Definition validators.hpp:203
void operator()(range_type const &range) const
Tests whether every element in range lies inside values.
Definition validators.hpp:258
std::string get_help_page_message() const
Returns a message that can be appended to the (positional) options help page info.
Definition validators.hpp:269
value_list_validator(value_list_validator &&)=default
Defaulted.
~value_list_validator()=default
Defaulted.
value_list_validator(range_type &&rng) -> value_list_validator< std::string >
Deduction guide for ranges over a value type convertible to std::string.
value_list_validator(option_type, option_types...) -> value_list_validator< std::string >
Type deduction guides.
value_list_validator & operator=(value_list_validator &&)=default
Defaulted.
value_list_validator(range_type rng)
Constructing from a range.
Definition validators.hpp:222
value_list_validator(range_type &&rng) -> value_list_validator< std::ranges::range_value_t< range_type > >
Deduction guide for ranges.
value_list_validator(option_types &&... opts)
Constructing from a parameter pack.
Definition validators.hpp:235
T create_directory(T... args)
T current_exception(T... args)
T emplace_back(T... args)
Provides parser related exceptions.
auto operator|(validator1_type &&vali1, validator2_type &&vali2)
Enables the chaining of validators.
Definition validators.hpp:1121
seqan::stl::views::join_with join_with
A view adaptor that represents view consisting of the sequence obtained from flattening a view of ran...
Definition join_with.hpp:25
T has_extension(T... args)
A type that satisfies std::is_arithmetic_v<t>.
The concept for option validators passed to add_option/positional_option.
void operator()(option_value_type const &cmp) const
Validates the value 'cmp' and throws a seqan3::validation_error on failure.
std::string get_help_page_message() const
Returns a message that can be appended to the (positional) options help page info.
using option_value_type
The type of value on which the validator is called on.
Provides various utility functions.
T is_directory(T... args)
T is_regular_file(T... args)
Provides seqan3::views::join_with.
The main SeqAn3 namespace.
Definition aligned_sequence_concept.hpp:26
output_file_open_options
Mode of an output file: Determines whether an existing file can be (silently) overwritten.
Definition validators.hpp:611
@ create_new
Forbid overwriting the output file.
@ open_or_create
Allow to overwrite the output file.
SeqAn specific customisations in the standard namespace.
Provides seqan3::debug_stream and related types.
T rethrow_exception(T... args)
Provides seqan3::detail::safe_filesystem_entry.
T throw_with_nested(T... args)
Auxiliary for pretty printing of exception messages.
Provides traits for seqan3::type_list.
Provides various traits for template packs.
Provides concepts that do not have equivalents in C++20.