Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
Classes | Functions | Variables
QDOC_CATCH_GENERATORS_ROOT_NAMESPACE::QDOC_CATCH_GENERATORS_PRIVATE_NAMESPACE Namespace Reference

\variable PathGeneratorConfiguration::multi_device_path_probability More...

Classes

class  CycleGenerator
 
class  KPartitionOfRGenerator
 
class  OneOfGenerator
 
class  PathGenerator
 
class  QCharGenerator
 
class  QStringGenerator
 

Functions

Catch::Generators::GeneratorWrapper< QString > posix_root ()
 Returns a generator that generates strings that are suitable to be used as a root component in POSIX paths.
 
Catch::Generators::GeneratorWrapper< QString > portable_posix_directory_name ()
 Returns a generator that generates strings that are suitable to be used as directory components in POSIX paths and that use an alphabet that should generally be supported by other systems.
 
Catch::Generators::GeneratorWrapper< QString > portable_posix_filename ()
 Returns a generator that generates strings that are suitable to be used as filenames in POSIX paths and that use an alphabet that should generally be supported by other systems.
 
Catch::Generators::GeneratorWrapper< QString > posix_separator ()
 Returns a generator that generates strings that can be used as POSIX compliant separators.
 
Catch::Generators::GeneratorWrapper< QString > windows_logical_drives ()
 Returns a generator that generates strings that can be suitably used as logical drive names in Windows' paths.
 
Catch::Generators::GeneratorWrapper< QString > windows_separator ()
 Returns a generator that generate strings that can be used as separators in Windows based paths.
 

Variables

static constexpr std::size_t minimum_component_length {1}
 
static constexpr std::size_t maximum_component_length {14}
 

Detailed Description

\variable PathGeneratorConfiguration::multi_device_path_probability

Every path produced by a PathGenerator configured with a mutli_device_path_probability of n has a probability of n to be {Multi-Device} and a probability of 1.0 - n to not be {Multi-Device}.

multi_device_path_probability should be a value in the range [0.0, 1.0].

\variable PathGeneratorConfiguration::absolute_path_probability

Every path produced by a PathGenerator configured with an absolute_path_probability of n has a probability of n to be {Absolute} and a probability of 1.0 - n to be {Relative}.

absolute_path_probability should be a value in the range [0.0, 1.0].

\variable PathGeneratorConfiguration::directory_path_probability

Every path produced by a PathGenerator configured with a directory_path_probability of n has a probability of n to be {To a Directory} and a probability of 1.0 - n to be {To a File}.

directory_path_probability should be a value in the range [0.0, 1.0].

\variable PathGeneratorConfiguration::has_trailing_separator_probability

Every path produced by a PathGenerator configured with an has_trailing_separator_probability of n has a probability of n to {Have a Trailing Separator} and a probability of 1.0 - n to not {Have a Trailing Separator}, when this is applicable.

has_trailing_separator_probability should be a value in the range [0.0, 1.0].

\variable PathGeneratorConfiguration::minimum_components_amount

Every path produced by a PathGenerator configured with a minimum_components_amount of n will be the concatenation of at least n non {device}, non {root}, non {separator} components.

minimum_components_amount should be greater than zero and less than maximum_components_amount.

\variable PathGeneratorConfiguration::maximum_components_amount

Every path produced by a PathGenerator configured with a maximum_components_amount of n will be the concatenation of at most n non {device}, non {root}, non {separator} components.

maximum_components_amount should be greater than or equal to minimum_components_amount.

Function Documentation

◆ portable_posix_directory_name()

Catch::Generators::GeneratorWrapper< QString > QDOC_CATCH_GENERATORS_ROOT_NAMESPACE::QDOC_CATCH_GENERATORS_PRIVATE_NAMESPACE::portable_posix_directory_name ( )
inline

Returns a generator that generates strings that are suitable to be used as directory components in POSIX paths and that use an alphabet that should generally be supported by other systems.

Components of this kind use the \l {https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap03.html#tag_03_282}{Portable Filename Character Set}.

Definition at line 535 of file path_generator.h.

◆ portable_posix_filename()

Catch::Generators::GeneratorWrapper< QString > QDOC_CATCH_GENERATORS_ROOT_NAMESPACE::QDOC_CATCH_GENERATORS_PRIVATE_NAMESPACE::portable_posix_filename ( )
inline

Returns a generator that generates strings that are suitable to be used as filenames in POSIX paths and that use an alphabet that should generally be supported by other systems.

Filenames of this kind use the \l {https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap03.html#tag_03_282}{Portable Filename Character Set}.

Definition at line 551 of file path_generator.h.

◆ posix_root()

Catch::Generators::GeneratorWrapper< QString > QDOC_CATCH_GENERATORS_ROOT_NAMESPACE::QDOC_CATCH_GENERATORS_PRIVATE_NAMESPACE::posix_root ( )
inline

Returns a generator that generates strings that are suitable to be used as a root component in POSIX paths.

As per \l {https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap03.html#tag_03_02}, this is any sequence of slash characters that is not of length 2.

Definition at line 516 of file path_generator.h.

◆ posix_separator()

Catch::Generators::GeneratorWrapper< QString > QDOC_CATCH_GENERATORS_ROOT_NAMESPACE::QDOC_CATCH_GENERATORS_PRIVATE_NAMESPACE::posix_separator ( )
inline

Returns a generator that generates strings that can be used as POSIX compliant separators.

As per \l {https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap03.html#tag_03_271}, a separator is a sequence of one or more slashes.

Definition at line 566 of file path_generator.h.

◆ windows_logical_drives()

Catch::Generators::GeneratorWrapper< QString > QDOC_CATCH_GENERATORS_ROOT_NAMESPACE::QDOC_CATCH_GENERATORS_PRIVATE_NAMESPACE::windows_logical_drives ( )
inline

Returns a generator that generates strings that can be suitably used as logical drive names in Windows' paths.

As per \l {https://docs.microsoft.com/en-us/dotnet/standard/io/file-path-formats#traditional-dos-paths} and \l {https://docs.microsoft.com/en-us/windows/win32/api/fileapi/nf-fileapi-getlogicaldrives}, they are composed of a single letter. Each generated string always follows the lettet with a colon, as it is specifically intended for path usages, where this is required.

We use only uppercase letters for the drives names albeit, depending on case sensitivity, lowercase letter could be used.

Definition at line 587 of file path_generator.h.

◆ windows_separator()

Catch::Generators::GeneratorWrapper< QString > QDOC_CATCH_GENERATORS_ROOT_NAMESPACE::QDOC_CATCH_GENERATORS_PRIVATE_NAMESPACE::windows_separator ( )
inline

Returns a generator that generate strings that can be used as separators in Windows based paths.

As per \l {https://docs.microsoft.com/en-us/dotnet/api/system.io.path.directoryseparatorchar?view=net-6.0} and \l {https://docs.microsoft.com/en-us/dotnet/standard/io/file-path-formats#canonicalize-separators}, this is a sequence of one or more backward or forward slashes.

Definition at line 624 of file path_generator.h.

Variable Documentation

◆ maximum_component_length

std::size_t QDOC_CATCH_GENERATORS_ROOT_NAMESPACE::QDOC_CATCH_GENERATORS_PRIVATE_NAMESPACE::maximum_component_length {14}
inlinestaticconstexpr

Definition at line 505 of file path_generator.h.

◆ minimum_component_length

std::size_t QDOC_CATCH_GENERATORS_ROOT_NAMESPACE::QDOC_CATCH_GENERATORS_PRIVATE_NAMESPACE::minimum_component_length {1}
inlinestaticconstexpr

Definition at line 504 of file path_generator.h.