logtools.inl

Go to the documentation of this file.

//==================================================================================================
/// \file
/// This header-file is part of module \alib_alox of the \aliblong.
///
/// \emoji :copyright: 2013-2025 A-Worx GmbH, Germany.
/// Published under \ref mainpage_license "Boost Software License".
//==================================================================================================
ALIB_EXPORT namespace alib { namespace lox {
 
//==================================================================================================
/// Simple class with static tool functions.
/// Currently the only functionality is logging objects of type \alib{exceptions;Exception}.
//==================================================================================================
class LogTools
{
  public:
    /// Logs an \b %alib::Exception. If available, the correct source information is used for
    /// each entry.
    ///
    /// Parameter \p{domainPrefix} and \p{logPrefix} are both set on outer thread scope (using
    /// \ref alib::lox::Lox::SetDomain "SetDomain( domainPrefix, Scope::ThreadOuter )" and
    /// \ref alib::lox::Lox::SetPrefix "SetPrefix( logPrefix, Scope::ThreadOuter )".
    /// The reason for this approach is that it may occur that other prefixes or scope domains
    /// are set set on source scope for the source files and methods found in the exception
    /// entry's source code information. This is especially important to understand in respect
    /// to the log domain: With the default value of parameter \p{domainPrefix} being \e "/ERR",
    /// all source related domains will appear as a subdomain of \e "/ERR" when the exception
    /// is logged using this tool function.
    ///
    /// @param lox           The lox to log into.
    /// @param e             The exception to log.
    /// @param verbosity     The verbosity of the log output.<br>
    ///                      Defaults to \b Verbosity::Error.
    /// @param domainPrefix  The domain to log into. If nulled , no domain is set and
    ///                      the default domain is used instead.<br>
    ///                      Defaults to \e "/ERR".
    /// @param logPrefix     A log prefix string. If nulled, no prefix is set.<br>
    ///                      Defaults to <b>"  "</b> (two spaces).
    ALIB_DLL
    static void Exception( Lox&                          lox,
                           const exceptions::Exception&  e,
                           Verbosity                     verbosity      = Verbosity::Error,
                           const NString&                domainPrefix   = "/ERR",
                           const String&                 logPrefix      = A_CHAR("  ")    );
}; // class LogTools
 
} // namespace alib[::lox]
 
/// Type alias in namespace \b alib.
using     LogTools=           lox::LogTools;
 
}  // namespace [alib]