Sharg 1.1.2-rc.1
The argument parser for bio-c++ tools.
Loading...
Searching...
No Matches
sharg::input_directory_validator Class Reference

A validator that checks if a given path is a valid input directory. More...

#include <sharg/validators.hpp>

+ Inheritance diagram for sharg::input_directory_validator:

Public Types

using option_value_type
 Type of values that are tested by validator.
 
- Public Types inherited from sharg::file_validator_base
using option_value_type = std::string
 Type of values that are tested by validator.
 

Public Member Functions

virtual void operator() (std::filesystem::path const &dir) const override
 Tests whether path is an existing directory and is readable.
 
std::string get_help_page_message () const
 Returns a message that can be appended to the (positional) options help page info.
 
Constructors, destructor and assignment
 input_directory_validator ()=default
 Defaulted.
 
 input_directory_validator (input_directory_validator const &)=default
 Defaulted.
 
 input_directory_validator (input_directory_validator &&)=default
 Defaulted.
 
input_directory_validatoroperator= (input_directory_validator const &)=default
 Defaulted.
 
input_directory_validatoroperator= (input_directory_validator &&)=default
 Defaulted.
 
virtual ~input_directory_validator ()=default
 Virtual Destructor.
 
 file_validator_base ()=default
 Defaulted.
 
 file_validator_base (file_validator_base const &)=default
 Defaulted.
 
 file_validator_base (file_validator_base &&)=default
 Defaulted.
 
- Public Member Functions inherited from sharg::file_validator_base
template<std::ranges::forward_range range_type>
requires (std::convertible_to<std::ranges::range_value_t<range_type>, std::filesystem::path const &> && !std::convertible_to<range_type, std::filesystem::path const &>)
void operator() (range_type const &v) const
 Tests whether every path in list v passes validation. See operator()(option_value_type const & value) for further information.
 
 file_validator_base ()=default
 Defaulted.
 
 file_validator_base (file_validator_base const &)=default
 Defaulted.
 
 file_validator_base (file_validator_base &&)=default
 Defaulted.
 
file_validator_baseoperator= (file_validator_base const &)=default
 Defaulted.
 
file_validator_baseoperator= (file_validator_base &&)=default
 Defaulted.
 
virtual ~file_validator_base ()=default
 

Additional Inherited Members

- Protected Member Functions inherited from sharg::file_validator_base
void validate_filename (std::filesystem::path const &path) const
 Validates the given filename path based on the specified extensions.
 
void validate_readability (std::filesystem::path const &path) const
 Checks if the given path is readable.
 
void validate_writeability (std::filesystem::path const &path) const
 Checks if the given path is writable.
 
std::string valid_extensions_help_page_message () const
 Returns the information of valid file extensions.
 
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.
 
- Protected Attributes inherited from sharg::file_validator_base
std::vector< std::stringextensions {}
 Stores the extensions.
 
std::string extensions_str {}
 The extension range as a std:;string for pretty printing.
 

Detailed Description

A validator that checks if a given path is a valid input directory.

The class acts as a functor that throws a sharg::validation_error exception whenever a given directory (std::filesystem::path) does not exist, the specified path is not a directory, or if the directory is not readable.

// SPDX-FileCopyrightText: 2006-2024 Knut Reinert & Freie Universität Berlin
// SPDX-FileCopyrightText: 2016-2024 Knut Reinert & MPI für molekulare Genetik
// SPDX-License-Identifier: CC0-1.0
#include <sharg/all.hpp>
int main(int argc, char const ** argv)
{
sharg::parser myparser{"Test", argc, argv}; // initialize
myparser.add_option(mydir,
.long_id = "dir",
.description = "The directory containing the input files.",
// an exception will be thrown if the user specifies a directory that does not exists or has insufficient
// read permissions.
try
{
myparser.parse();
}
catch (sharg::parser_error const & ext) // the user did something wrong
{
std::cerr << "[PARSER ERROR] " << ext.what() << "\n"; // customize your error message
return -1;
}
std::cerr << "directory given by user passed validation: " << mydir << "\n";
return 0;
}
Meta-header for the Parser module .
A validator that checks if a given path is a valid input directory.
Definition validators.hpp:793
Parser exception that is thrown whenever there is an error while parsing the command line arguments.
Definition exceptions.hpp:40
The Sharg command line parser.
Definition parser.hpp:154
Option struct that is passed to the sharg::parser::add_option() function.
Definition config.hpp:43
char short_id
The short identifier for the option (e.g. 'a', making the option callable via -a).
Definition config.hpp:53
T what(T... args)
Note
The validator works on every type that can be implicitly converted to std::filesystem::path.
Remarks
For a complete overview, take a look at Parser

This entity is experimental and subject to change in the future. Experimental since version 1.0.

Member Function Documentation

◆ get_help_page_message()

std::string sharg::input_directory_validator::get_help_page_message ( ) const
inline

Returns a message that can be appended to the (positional) options help page info.

This entity is experimental and subject to change in the future. Experimental since version 1.0.

◆ operator()()

virtual void sharg::input_directory_validator::operator() ( std::filesystem::path const & dir) const
inlineoverridevirtual

Tests whether path is an existing directory and is readable.

Parameters
dirThe input value to check.
Exceptions
sharg::validation_errorif the validation process failed. Might be nested with std::filesystem::filesystem_error on unhandled OS API errors.

This entity is experimental and subject to change in the future. Experimental since version 1.0.

Implements sharg::file_validator_base.


The documentation for this class was generated from the following file:
Hide me