95 template <
typename val
idator_type>
96 SEQAN3_CONCEPT
validator = std::copyable<std::remove_cvref_t<validator_type>> &&
120 template <arithmetic option_value_t>
141 if (!((cmp <=
max) && (cmp >=
min)))
151 template <std::ranges::forward_range range_type>
157 std::for_each(range.begin(), range.end(), [&] (
auto cmp) { (*this)(cmp); });
191 template <
typename option_value_t>
213 template <std::ranges::forward_range range_type>
215 requires std::constructible_from<option_value_type, std::ranges::range_rvalue_reference_t<range_type>>
228 template <
typename ...option_types>
230 requires ((std::constructible_from<option_value_type, option_types> && ...))
253 template <std::ranges::forward_range range_type>
255 requires std::convertible_to<std::ranges::range_value_t<range_type>,
option_value_type>
259 std::for_each(std::ranges::begin(range), std::ranges::end(range), [&] (
auto cmp) { (*this)(cmp); });
279 template <
typename option_type,
typename ...option_types>
287 template <typename range_type>
289 requires (
std::ranges::forward_range<
std::decay_t<range_type>> &&
290 std::constructible_from<
std::
string,
std::ranges::range_value_t<range_type>>)
295 template <typename option_type, typename ...option_types>
299 template <typename range_type>
301 requires (
std::ranges::forward_range<
std::decay_t<range_type>>)
352 template <std::ranges::forward_range range_type>
358 std::for_each(v.begin(), v.end(), [&] (
auto cmp) { this->operator()(cmp); });
370 if (extensions.empty())
376 " one of the following valid extensions:", extensions,
"!")};
381 if (file_path.front() ==
'.')
382 file_path.erase(0, 1);
388 auto case_insensitive_ends_with = [&] (
std::string const & ext)
390 return case_insensitive_string_ends_with(file_path, ext);
397 "! Got ", all_extensions,
" instead!")};
414 if (
static_cast<bool>(ec))
424 if (!file.is_open() || !file.good())
440 bool is_open = file.is_open();
441 bool is_good = file.good();
444 if (!is_good || !is_open)
453 if (extensions.empty())
466 size_t const suffix_length{suffix.
size()};
467 size_t const str_length{str.
size()};
468 return suffix_length > str_length ?
470 std::ranges::equal(str.
substr(str_length - suffix_length), suffix, [] (
char const chr1,
char const chr2)
472 return std::tolower(chr1) == std::tolower(chr2);
502 template <
typename file_t =
void>
507 static_assert(std::same_as<file_t, void> || detail::has_type_valid_formats<file_t>,
508 "Expected either a template type with a static member called valid_formats (a file type) or void.");
527 if constexpr (!std::same_as<file_t, void>)
547 requires std::same_as<file_t, void>
559 using file_validator_base::operator();
592 return "The input file must exist and read permissions must be granted." +
632 template <
typename file_t =
void>
636 static_assert(std::same_as<file_t, void> || detail::has_type_valid_formats<file_t>,
637 "Expected either a template type with a static member called valid_formats (a file type) or void.");
656 #ifdef SEQAN3_DEPRECATED_310
690 if constexpr (!std::same_as<file_t, void>)
691 return detail::valid_file_extensions<typename file_t::valid_formats>();
696 using file_validator_base::operator();
731 return "The output file must not exist already and write permissions must be granted." +
775 using file_validator_base::operator();
847 using file_validator_base::operator();
861 if (
static_cast<bool>(ec))
870 dir_guard.remove_all();
941 template <std::ranges::forward_range range_type>
943 requires std::convertible_to<std::ranges::range_reference_t<range_type>,
option_value_type const &>
947 for (
auto && file_name : v)
978 template <
typename option_value_t>
1006 template <val
idator val
idator1_type, val
idator val
idator2_type>
1008 requires std::common_with<typename validator1_type::option_value_type, typename validator2_type::option_value_type>
1015 typename validator2_type::option_value_type>;
1046 template <
typename cmp_type>
1048 requires std::invocable<validator1_type, cmp_type const> && std::invocable<validator2_type, cmp_type const>
1098 template <val
idator val
idator1_type, val
idator val
idator2_type>
1100 requires std::common_with<typename std::remove_reference_t<validator1_type>::option_value_type,
1103 auto operator|(validator1_type && vali1, validator2_type && vali2)
1106 std::forward<validator2_type>(vali2)};
Adaptations of algorithms from the Ranges TS.
A validator that checks whether a number is inside a given range.
Definition: validators.hpp:122
void operator()(option_value_type const &cmp) const
Tests whether cmp lies inside [min, max].
Definition: validators.hpp:139
option_value_type max
Maximum of the range to test.
Definition: validators.hpp:171
option_value_t option_value_type
The type of value that this validator invoked upon.
Definition: validators.hpp:125
void operator()(range_type const &range) const
Tests whether every element in range lies inside [min, max].
Definition: validators.hpp:155
option_value_type min
Minimum of the range to test.
Definition: validators.hpp:168
std::string get_help_page_message() const
Returns a message that can be appended to the (positional) options help page info.
Definition: validators.hpp:161
arithmetic_range_validator(option_value_type const min_, option_value_type const max_)
The constructor.
Definition: validators.hpp:131
A safe guard to manage a filesystem entry, e.g. a file or a directory.
Definition: safe_filesystem_entry.hpp:38
A helper struct to chain validators recursively via the pipe operator.
Definition: validators.hpp:1011
validator_chain_adaptor(validator_chain_adaptor &&)=default
Defaulted.
validator_chain_adaptor & operator=(validator_chain_adaptor &&)=default
Defaulted.
void operator()(cmp_type const &cmp) const
Calls the operator() of each validator on the value cmp.
Definition: validators.hpp:1050
validator_chain_adaptor(validator1_type vali1_, validator2_type vali2_)
Constructing from two validators.
Definition: validators.hpp:1030
validator2_type vali2
The second validator in the chain.
Definition: validators.hpp:1066
~validator_chain_adaptor()=default
The destructor.
validator_chain_adaptor & operator=(validator_chain_adaptor const &pf)=default
Defaulted.
validator_chain_adaptor(validator_chain_adaptor const &pf)=default
Defaulted.
validator_chain_adaptor()=delete
Deleted.
std::string get_help_page_message() const
Returns a message that can be appended to the (positional) options help page info.
Definition: validators.hpp:1057
validator1_type vali1
The first validator in the chain.
Definition: validators.hpp:1064
An abstract base class for the file and directory validators.
Definition: validators.hpp:319
file_validator_base & operator=(file_validator_base &&)=default
Defaulted.
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:464
void validate_filename(std::filesystem::path const &path) const
Validates the given filename path based on the specified extensions.
Definition: validators.hpp:367
file_validator_base & operator=(file_validator_base const &)=default
Defaulted.
std::string valid_extensions_help_page_message() const
Returns the information of valid file extensions.
Definition: validators.hpp:451
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
void operator()(range_type const &v) const
Tests whether every path in list v passes validation. See operator()(option_value_type const & value)...
Definition: validators.hpp:356
file_validator_base(file_validator_base &&)=default
Defaulted.
void validate_readability(std::filesystem::path const &path) const
Checks if the given path is readable.
Definition: validators.hpp:407
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:477
virtual ~file_validator_base()=default
void validate_writeability(std::filesystem::path const &path) const
Checks if the given path is writable.
Definition: validators.hpp:435
A validator that checks if a given path is a valid output directory.
Definition: validators.hpp:827
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:854
output_directory_validator & operator=(output_directory_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:888
A validator that checks if a given path is a valid output file.
Definition: validators.hpp:634
output_file_validator(output_file_validator &&)=default
Defaulted.
output_file_validator(output_file_validator const &)=default
Defaulted.
output_file_validator & operator=(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:703
output_file_validator(std::vector< std::string > extensions)
Definition: validators.hpp:658
static std::vector< std::string > default_extensions()
The default extensions of file_t.
Definition: validators.hpp:688
output_file_validator()
Default constructor.
Definition: validators.hpp:647
output_file_validator & operator=(output_file_validator &&)=default
Defaulted.
output_file_open_options mode
Stores the current mode of whether it is valid to overwrite the output file.
Definition: validators.hpp:737
std::string get_help_page_message() const
Returns a message that can be appended to the (positional) options help page info.
Definition: validators.hpp:726
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:669
A validator that checks if a matches a regular expression pattern.
Definition: validators.hpp:912
std::string get_help_page_message() const
Returns a message that can be appended to the (positional) options help page info.
Definition: validators.hpp:955
std::string pattern
The pattern to match.
Definition: validators.hpp:962
void operator()(option_value_type const &cmp) const
Tests whether cmp lies inside values.
Definition: validators.hpp:928
void operator()(range_type const &v) const
Tests whether every filename in list v matches the pattern.
Definition: validators.hpp:945
std::string option_value_type
Type of values that are tested by validator.
Definition: validators.hpp:915
regex_validator(std::string const &pattern_)
Constructing from a vector.
Definition: validators.hpp:920
Argument parser exception thrown when an argument could not be casted to the according type.
Definition: exceptions.hpp:141
A validator that checks whether a value is inside a list of valid values.
Definition: validators.hpp:193
value_list_validator()=default
Defaulted.
void operator()(option_value_type const &cmp) const
Tests whether cmp lies inside values.
Definition: validators.hpp:242
value_list_validator(value_list_validator const &)=default
Defaulted.
option_value_t option_value_type
Type of values that are tested by validator.
Definition: validators.hpp:196
std::string get_help_page_message() const
Returns a message that can be appended to the (positional) options help page info.
Definition: validators.hpp:263
std::vector< option_value_type > values
Minimum of the range to test.
Definition: validators.hpp:271
value_list_validator & operator=(value_list_validator &&)=default
Defaulted.
void operator()(range_type const &range) const
Tests whether every element in range lies inside values.
Definition: validators.hpp:257
value_list_validator(value_list_validator &&)=default
Defaulted.
~value_list_validator()=default
Defaulted.
value_list_validator & operator=(value_list_validator const &)=default
Defaulted.
value_list_validator(range_type rng)
Constructing from a range.
Definition: validators.hpp:217
T create_directory(T... args)
T current_exception(T... args)
Auxiliary for pretty printing of exception messages.
Provides seqan3::debug_stream and related types.
T emplace_back(T... args)
Provides parser related exceptions.
Provides concepts for core language types and relations that don't have concepts in C++20 (yet).
This header includes C++17 filesystem support and imports it into namespace std::filesystem (independ...
auto operator|(validator1_type &&vali1, validator2_type &&vali2)
Enables the chaining of validators.
Definition: validators.hpp:1103
constexpr ptrdiff_t find_if
Get the index of the first type in a pack that satisfies the given predicate.
Definition: traits.hpp:209
auto const move
A view that turns lvalue-references into rvalue-references.
Definition: move.hpp:70
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.
std::string get_help_page_message() const
Returns a message that can be appended to the (positional) options help page info.
Provides various utility functions.
T is_directory(T... args)
T is_regular_file(T... args)
Provides seqan3::views::join.
std::string to_string(value_type &&...values)
Streams all parameters via the seqan3::debug_stream and returns a concatenated string.
Definition: to_string.hpp:29
The main SeqAn3 namespace.
Definition: aligned_sequence_concept.hpp:29
output_file_open_options
Mode of an output file: Determines whether an existing file can be (silently) overwritten.
Definition: validators.hpp:599
@ create_new
Forbid overwriting the output file.
@ open_or_create
Allow to overwrite the output file.
SeqAn specific customisations in the standard namespace.
Adaptations of concepts from the standard library.
Adaptations of concepts from the Ranges TS.
T rethrow_exception(T... args)
Provides seqan3::detail::safe_filesystem_entry.
Validator that always returns true.
Definition: validators.hpp:980
void operator()(option_value_t const &) const noexcept
Value cmp always passes validation because the operator never throws.
Definition: validators.hpp:985
option_value_t option_value_type
Type of values that are tested by validator.
Definition: validators.hpp:982
std::string get_help_page_message() const
Since no validation is happening the help message is empty.
Definition: validators.hpp:989
T throw_with_nested(T... args)
Provides traits for seqan3::type_list.
Provides various traits for template packs.
Provides various type traits on generic types.