bdlat_fuzzutiloptions.h

Go to the documentation of this file.

/// @file bdlat_fuzzutiloptions.h
///
/// The content of this file has been pre-processed for Doxygen.
///
 
 
// bdlat_fuzzutiloptions.h                                            -*-C++-*-
#ifndef INCLUDED_BDLAT_FUZZUTILOPTIONS
#define INCLUDED_BDLAT_FUZZUTILOPTIONS
 
#include <bsls_ident.h>
BSLS_IDENT("$Id: $")
 
/// @defgroup bdlat_fuzzutiloptions bdlat_fuzzutiloptions
/// @brief  Provide options for `bdlat::FuzzUtil`.
/// @addtogroup bdl
/// @{
/// @addtogroup bdlat
/// @{
/// @addtogroup bdlat_fuzzutiloptions
/// @{
///
/// <h1> Outline </h1>
/// * <a href="#bdlat_fuzzutiloptions-purpose"> Purpose</a>
/// * <a href="#bdlat_fuzzutiloptions-classes"> Classes </a>
/// * <a href="#bdlat_fuzzutiloptions-description"> Description </a>
///
/// # Purpose {#bdlat_fuzzutiloptions-purpose}
/// Provide options for `bdlat::FuzzUtil`.
///
/// # Classes {#bdlat_fuzzutiloptions-classes}
///
/// - bdlat::FuzzUtilOptions: options for `bdlat::FuzzUtil`
///
/// @see  bdlat_fuzzutil
///
/// # Description {#bdlat_fuzzutiloptions-description}
/// This component provides a set of customization options for
/// `bdlat::FuzzUtil`, e.g. limits on the lengths of generated strings and
/// arrays.
/// @}
/** @} */
/** @} */
 
/** @addtogroup bdl
 * @{
 */
/** @addtogroup bdlat
 * @{
 */
/** @addtogroup bdlat_fuzzutiloptions
 * @{
 */
 
#include <bslscm_version.h>
 
 
namespace bdlat {
 
                            // =====================
                            // class FuzzUtilOptions
                            // =====================
 
/// Options for `bdlat::FuzzUtil`.
///
/// See @ref bdlat_fuzzutiloptions 
class FuzzUtilOptions {
    // DATA
    unsigned d_maxArrayLength;
    unsigned d_maxStringLength;
    bool     d_printableAsciiCharsOnly;
 
  public:
    // TYPES
 
    /// Default values
    static const unsigned k_MAX_ARRAY_LENGTH_DEFAULT  = 8;
    static const unsigned k_MAX_STRING_LENGTH_DEFAULT = 32;
    static const bool     k_PRINTABLE_ASCII_CHARS_ONLY_DEFAULT = true;
 
    // CREATORS
 
    /// Set all the attributes to to the corresponding default values.
    FuzzUtilOptions();
 
    // MANIPULATORS
 
    /// Set the maximum array length to the specified `value`.  Return a
    /// reference to `*this`.
    FuzzUtilOptions& setMaxArrayLength(unsigned value);
 
    /// Set the maximum string length to the specified `value`.  Return a
    /// reference to `*this`.
    FuzzUtilOptions& setMaxStringLength(unsigned value);
 
    /// Set whether to generate only printable ASCII characters for strings.
    FuzzUtilOptions& setPrintableAsciiCharsOnly(bool value);
 
    // ACCESSORS
 
    /// Return the maximum array length.
    unsigned maxArrayLength() const;
 
    /// Return the maximum string length.
    unsigned maxStringLength() const;
 
    /// Return whether to generate only printable ASCII characters for strings.
    bool printableAsciiCharsOnly() const;
};
 
// FREE OPERATORS
 
/// Return `true` if the specified `lhs` and `rhs` objects have the same value,
/// and `false` otherwise.  Two `FuzzUtilOptions` objects have the same value
/// if all of the corresponding values of their `maxArrayLength`,
/// `maxStringLength`, and `printableAsciiCharsOnly` attributes are the same.
bool operator==(const FuzzUtilOptions& lhs, const FuzzUtilOptions& rhs);
 
/// Return `true` if the specified `lhs` and `rhs` objects do not have the same
/// value, and `false` otherwise.  Two `FuzzUtilOptions` objects do not have
/// the same value if any of the corresponding values of their
/// `maxArrayLength`, `maxStringLength`, and `printableAsciiCharsOnly`
/// attributes are not the same.
bool operator!=(const FuzzUtilOptions& lhs, const FuzzUtilOptions& rhs);
 
// ============================================================================
//                              INLINE DEFINITIONS
// ============================================================================
 
                            // ---------------------
                            // class FuzzUtilOptions
                            // ---------------------
 
// MANIPULATORS
inline
FuzzUtilOptions& FuzzUtilOptions::setMaxArrayLength(unsigned value)
{
    d_maxArrayLength = value;
    return *this;
}
 
inline
FuzzUtilOptions& FuzzUtilOptions::setMaxStringLength(unsigned value)
{
    d_maxStringLength = value;
    return *this;
}
 
inline
FuzzUtilOptions& FuzzUtilOptions::setPrintableAsciiCharsOnly(bool value)
{
    d_printableAsciiCharsOnly = value;
    return *this;
}
 
// ACCESSORS
inline
unsigned FuzzUtilOptions::maxArrayLength() const
{
    return d_maxArrayLength;
}
 
inline
unsigned FuzzUtilOptions::maxStringLength() const
{
    return d_maxStringLength;
}
 
inline
bool FuzzUtilOptions::printableAsciiCharsOnly() const
{
    return d_printableAsciiCharsOnly;
}
 
}  // close package namespace
 
// FREE OPERATORS
inline
bool bdlat::operator==(const FuzzUtilOptions& lhs, const FuzzUtilOptions& rhs)
{
    return lhs.maxArrayLength() == rhs.maxArrayLength()
        && lhs.maxStringLength() == rhs.maxStringLength()
        && lhs.printableAsciiCharsOnly() == rhs.printableAsciiCharsOnly();
}
 
inline
bool bdlat::operator!=(const FuzzUtilOptions& lhs, const FuzzUtilOptions& rhs)
{
    return !(lhs == rhs);
}
 
 
 
#endif
 
// ----------------------------------------------------------------------------
// Copyright 2025 Bloomberg Finance L.P.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// ----------------------------- END-OF-FILE ----------------------------------
 
/** @} */
/** @} */
/** @} */