callerinfo.inl

Go to the documentation of this file.

//==================================================================================================
/// \file
/// This header-file is part of module \alib_lang of the \aliblong.
///
/// \emoji :copyright: 2013-2025 A-Worx GmbH, Germany.
/// Published under \ref mainpage_license "Boost Software License".
//==================================================================================================
ALIB_EXPORT namespace alib { namespace lang {
 
/// A simple struct that holds source code location information.
/// Usually, this is information about a caller of a function, used with debug-compilations.
/// Module \alib_alox might be explicitly compiled to include such caller information also in
/// release-versions of software.
///
///
/// @see
///  - Chapter \ref alib_manual_appendix_callerinfo of the General Programmer's Manual.
///  - Macros \ref ALIB_CALLER, \ref ALIB_CALLER_PRUNED, \ref ALIB_COMMA_CALLER_PRUNED and
///    \ref ALIB_CALLER_NULLED.
///  - Instances of this type are appendable to class \b AString in a default way.
///    This is implemented with functor
///    \alib{strings::APPENDABLES;AppendableTraits<lang::CallerInfo,TChar,TAllocator>}.
///  - Class \alib{format;FMTCallerInfo} defines a format specification to customize
///    the output.
///    As always, \alib{format;FMTCallerInfo;that syntax} is directly available in
///    placeholder fields of class \alib{format;FormatterPythonStyle}.
struct CallerInfo
{
    const char*     File{nullptr};  ///< The name of the source file as given by compiler.
    int             Line{0};        ///< The line number within #File.
    const char*     Func{nullptr};  ///< The function name of the source location. Nulled if
                                    ///< the location is not inside a function or method.
                                    ///
    #if ALIB_EXT_LIB_THREADS_AVAILABLE
    std::thread::id ThreadID;       ///< The ID of the calling thread.
    #endif
    const std::type_info* TypeInfo{nullptr}; ///< The calling type.
};
 
 
} // namespace alib[::lang]
 
/// Type alias in namespace \b alib.
using CallerInfo      = lang::CallerInfo;
 
} // namespace [alib]