ALib C++ Library
Library Version: 2510 R0
Documentation generated by doxygen
Loading...
Searching...
No Matches
resources_debug.inl
Go to the documentation of this file.
1//==================================================================================================
2/// \file
3/// This header-file contributes to module \alib_resources but for technical reasons is part of
4/// the module \alib_format.
5///
6/// \emoji :copyright: 2013-2025 A-Worx GmbH, Germany.
7/// Published under \ref mainpage_license "Boost Software License".
8//==================================================================================================
9#if ALIB_DEBUG_RESOURCES
11
12//==================================================================================================
13/// Writes the list of resources obtainable with \alib{resources;ResourcePool::DbgGetList} to an
14/// \b %AString.
15///
16/// \par Availability
17/// This function is an extension, which is injected by the higher-level module \alib_format and
18/// is accessed through the header file \implude{Format}.
19/// Furthermore, the compiler-symbol \ref ALIB_DEBUG_RESOURCES has to be set.
20///
21/// \see
22/// Methods \alib{resources;ResourcePool::DbgGetList} and
23/// \alib{resources;ResourcePool::DbgGetCategories}.
24///
25/// @param list The list of resources, obtained with \b DbgGetList.
26/// @param catFilter Comma-separated list of names of categories to print.
27/// Defaults to nulled string, which includes all caegories.
28/// @param format The format of a line.
29/// Defaults to <b>"({3:}) {1}={2!TAB20!ESC<!Q}\\n"</b>.
30/// @return The dump of all resources.
31//==================================================================================================
33AString DbgDump( std::vector<std::tuple<NString, NString, String, integer>>& list,
34 const NString& catFilter = nullptr,
35 const String& format = A_CHAR("({3:}) {1}={2!TAB20!ESC<!Q}\n") );
36
37#include "ALib.Lang.CIMethods.H"
38} // namespace [alib::enumrecords::bootstrap]
39
40#endif // ALIB_DEBUG_RESOURCES
41
#define ALIB_DLL
Definition alib.inl:496
#define A_CHAR(STR)
#define ALIB_EXPORT
Definition alib.inl:488
AString DbgDump(std::vector< std::tuple< NString, NString, String, integer > > &list, const NString &catFilter, const String &format)
strings::TAString< character, lang::HeapAllocator > AString
Type alias in namespace alib.
strings::TString< nchar > NString
Type alias in namespace alib.
Definition string.inl:2390
strings::TString< character > String
Type alias in namespace alib.
Definition string.inl:2381