results.cpp

// #################################################################################################
//  ALib C++ Library
//
//  Copyright 2013-2023 A-Worx GmbH, Germany
//  Published under 'Boost Software License' (a free software license, see LICENSE.txt)
// #################################################################################################
#include "alib/alib_precompile.hpp"
 
#if !defined(ALIB_DOX)
#   if !defined (HPP_ALIB_RESULTS_RESULTS)
#      include "alib/results/results.hpp"
#   endif
#   if !defined (HPP_ALIB_RESULTS_ICLONEMESSAGEARGUMENT)
#      include "alib/results/iclonemessageargument.hpp"
#   endif
#   if !defined (HPP_ALIB_BOXING_ENUM)
#      include "alib/boxing/enum.hpp"
#   endif
#   if !defined (HPP_ALIB_FS_MODULES_DISTRIBUTION)
#      include "alib/lib/fs_modules/distribution.hpp"
#   endif
#   if !defined (HPP_ALIB_RESOURCES_RESOURCES)
#      include "alib/resources/resources.hpp"
#   endif
#   if !defined (HPP_ALIB_ENUMS_RECORDBOOTSTRAP)
#      include "alib/enums/recordbootstrap.hpp"
#   endif
#   if !defined (HPP_ALIB_RESULTS_REPORT)
#      include "alib/results/report.hpp"
#   endif
#endif // !defined(ALIB_DOX)
 
namespace aworx { namespace lib {
 
results::Results RESULTS;
 
/**
 * This \alibmod is very small and might undergo some changes in the future development of the
 * library.
 *
 * Please consult \ref alib_mod_results "ALib Module Results - Programmer's Manual"
 * for further information.
 */
namespace results {
 
// #################################################################################################
// Replacement method for ALib Essential Reports
// #################################################################################################
#if ALIB_DEBUG
#if !defined(ALIB_DOX)
namespace {
#endif
ALIB_WARNINGS_ALLOW_UNSAFE_BUFFER_USAGE
/**
 * This method is installed with \alib{DBG_SIMPLE_ALIB_MSG_PLUGIN} in method
 * \alib{Module::bootstrap}.
 *
 * The message strings are simply passed to the default \alib{results,Report}.
 * This way, the essential assert, error and message macros are using the \alib report system
 * in the moment that the complete %ALib library is in place (instead of only one of the
 * library's modules.
 *
 * @param file    Information about the scope of invocation.
 * @param line    Information about the scope of invocation.
 * @param method  Information about the scope of invocation.
 * @param type    The type of message. See \alib{results,Message}.
 * @param topic   The topic of message.
 * @param qtyMsgs The number of messages in \p{msgs}.
 * @param msgs    A list of strings (this is all that the essential versions of \alib reporting
 *                macros provide).
 */
void debugReportPlugin(const char* file, int line, const char* method,
                       int type, const char* topic, int qtyMsgs, const nchar** msgs)
{
    Message message( file,line,method, Report::Types(type), topic );
    for (int i= 0; i< qtyMsgs; ++i )
        message.Add( msgs[i] );
    Report::GetDefault().DoReport( message );
}
ALIB_WARNINGS_RESTORE
 
#if !defined(ALIB_DOX)
} // anonymous namespace
#endif
#endif // ALIB_DEBUG
 
// #################################################################################################
// Module class Messages
// #################################################################################################
Results::Results()
: Module( ALIB_VERSION, ALIB_REVISION, "RSLTS" )
{
    ALIB_ASSERT_ERROR( this == &RESULTS, "RESULTS",
        "Instances of class Results must not be created. Use singleton aworx::lib::RESULTS" )
}
 
 
void Results::bootstrap( BootstrapPhases phase, int, const char**, const wchar_t** )
{
    if( phase == BootstrapPhases::PrepareResources )
    {
        ALIB.CheckDistribution();
 
        ALIB_BOXING_BOOTSTRAP_VTABLE_DBG_REGISTER( vt_alib_exception )
        ALIB_BOXING_BOOTSTRAP_VTABLE_DBG_REGISTER( vt_alib_report_types )
 
 
        #if ALIB_DEBUG
            lib::DBG_SIMPLE_ALIB_MSG_PLUGIN= debugReportPlugin;
        #endif
 
 
 
#if !ALIB_RESOURCES_OMIT_DEFAULTS
        resourcePool->BootstrapBulk( ResourceCategory,
 
        //#####################   aworx::lib::results::Exceptions   ################################
        "E<", A_CHAR("results::") ,
        "E" , A_CHAR("1,ErrorWritingReport,E1") ,
 
        "E1", A_CHAR("Error writing ALib report."),
 
        //#####################################    Various    ######################################
        "ExcFmtExc",       A_CHAR("\nAn exception occurred while formatting another (!) exception:\n" ),
        "RepFmtExc",       A_CHAR("\nAn exception occurred while formatting an ALib report (!):\n" ),
 
 
        // end of BootstrapBulk()
        nullptr );
#endif // !ALIB_RESOURCES_OMIT_DEFAULTS
    }
 
    else if( phase == BootstrapPhases::PrepareConfig )
    {
        EnumRecords<Exceptions>::Bootstrap();
    }
 
}
 
void Results::shutdown( ShutdownPhases phase )
{
    if( phase == ShutdownPhases::Destruct )
    {
        #if ALIB_DEBUG
            lib::DBG_SIMPLE_ALIB_MSG_PLUGIN= nullptr;
        #endif
 
        if ( Report::defaultReport != nullptr )
            delete Report::defaultReport;
 
        if( ReportWriterStdIO::singleton )
            delete ReportWriterStdIO::singleton;
    }
}
 
 
}}} // namespace [aworx::lib::results]