debug.hpp File Reference

#include "details/out_type_alert.hpp"
#include "details/out_type_debug.hpp"
#include "details/out_type_empty.hpp"
#include "details/out_type_error.hpp"
#include "details/out_type_print.hpp"
#include "details/out.hpp"
#include "char_type.hpp"
#include "conditional.hpp"
#include "cstdint.hpp"
#include "fmt.hpp"

Go to the source code of this file.

Typedefs
template<bsl::uintmax DL, typename T >
using	bsl::out_t = conditional_t< DL<=BSL_DEBUG_LEVEL, out< T >, out< details::out_type_empty > >
	used to disable debugging for debug() and alert()

Functions
constexpr out< details::out_type_print >	bsl::print () noexcept
	Returns and instance of bsl::out<T>. This version of bsl::out<T> does not print a label and does not accept a debug level (as it cannot be turned off). All output is redirected to bsl::details::putc_stdout and bsl::details::puts_stdout. See bsl::fmt for formatting documentation and examples. More...
template<bsl::uintmax DL = 0>
constexpr out_t< DL, details::out_type_debug >	bsl::debug () noexcept
	Returns and instance of bsl::out<T>. This version of bsl::out<T> prints "DEBUG: " when created and accepts a debug level, allowing it to be disabled. All output is redirected to bsl::details::putc_stdout and bsl::details::puts_stdout. See bsl::fmt for formatting documentation and examples. More...
template<bsl::uintmax DL = 0>
constexpr out_t< DL, details::out_type_alert >	bsl::alert () noexcept
	Returns and instance of bsl::out<T>. This version of bsl::out<T> prints "ALERT: " when created and accepts a debug level, allowing it to be disabled. All output is redirected to bsl::details::putc_stderr and bsl::details::puts_stderr. See bsl::fmt for formatting documentation and examples. More...
constexpr out< details::out_type_error >	bsl::error () noexcept
	Returns and instance of bsl::out<T>. This version of bsl::out<T> prints "ERROR: " when created and does not accept a debug level (as it cannot be turned off). All output is redirected to bsl::details::putc_stderr and bsl::details::puts_stderr. See bsl::fmt for formatting documentation and examples. More...

Variables
constexpr bsl::uintmax	bsl::v {1U}
	defines "-v" verbose mode
constexpr bsl::uintmax	bsl::vv {2U}
	defines "-vv" verbose mode
constexpr bsl::uintmax	bsl::vvv {3U}
	defines "-vvv" verbose mode
constexpr bsl::char_type	bsl::endl {'\n'}
	newline constant

Detailed Description

Copyright

Copyright (C) 2020 Assured Information Security, Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Function Documentation

print()

constexpr out<details::out_type_print> bsl::print ( )

noexcept

Returns and instance of bsl::out<T>. This version of bsl::out<T> does not print a label and does not accept a debug level (as it cannot be turned off). All output is redirected to bsl::details::putc_stdout and bsl::details::puts_stdout. See bsl::fmt for formatting documentation and examples.

#include <bsl/debug.hpp>

namespace bsl
{
    inline void
    example_debug_print() noexcept
    {
        constexpr bsl::int32 val{42};
        bsl::print() << "example message: " << val << bsl::endl;
    }
}

Returns

Returns and instance of bsl::out<T>

debug()

template<bsl::uintmax DL = 0>

constexpr out_t<DL, details::out_type_debug> bsl::debug ( )

noexcept

Returns and instance of bsl::out<T>. This version of bsl::out<T> prints "DEBUG: " when created and accepts a debug level, allowing it to be disabled. All output is redirected to bsl::details::putc_stdout and bsl::details::puts_stdout. See bsl::fmt for formatting documentation and examples.

#include <bsl/debug.hpp>

namespace bsl
{
    inline void
    example_debug_debug() noexcept
    {
        constexpr bsl::int32 val{42};
        bsl::debug() << "example message: " << val << bsl::endl;
    }
}

Returns

Returns and instance of bsl::out<T>

alert()

template<bsl::uintmax DL = 0>

constexpr out_t<DL, details::out_type_alert> bsl::alert ( )

noexcept

Returns and instance of bsl::out<T>. This version of bsl::out<T> prints "ALERT: " when created and accepts a debug level, allowing it to be disabled. All output is redirected to bsl::details::putc_stderr and bsl::details::puts_stderr. See bsl::fmt for formatting documentation and examples.

#include <bsl/debug.hpp>

namespace bsl
{
    inline void
    example_debug_alert() noexcept
    {
        constexpr bsl::int32 val{42};
        bsl::alert() << "example message: " << val << bsl::endl;
    }
}

Returns

Returns and instance of bsl::out<T>

error()

constexpr out<details::out_type_error> bsl::error ( )

noexcept

Returns and instance of bsl::out<T>. This version of bsl::out<T> prints "ERROR: " when created and does not accept a debug level (as it cannot be turned off). All output is redirected to bsl::details::putc_stderr and bsl::details::puts_stderr. See bsl::fmt for formatting documentation and examples.

#include <bsl/debug.hpp>

namespace bsl
{
    inline void
    example_debug_error() noexcept
    {
        constexpr bsl::int32 val{42};
        bsl::error() << "example message: " << val << bsl::endl;
    }
}

Returns

Returns and instance of bsl::out<T>