serenity/AK/ScopeLogger.h
Ali Mohammad Pur 080f2c0e3e AK: Add an optional 'extra' descriptive field to ScopeLogger
Often it's easier to know what the functions are doing with a unique
name next to the function's name :)
2021-05-08 22:14:39 +02:00

59 lines
1.5 KiB
C++

/*
* Copyright (c) 2020, Denis Campredon <deni_@hotmail.fr>
*
* SPDX-License-Identifier: BSD-2-Clause
*/
#pragma once
#include <AK/SourceLocation.h>
#include <AK/StringBuilder.h>
namespace AK {
class ScopeLogger {
public:
#ifdef DEBUG_SPAM
ScopeLogger(StringView extra, const SourceLocation& location = SourceLocation::current())
: m_location(location)
, m_extra(extra)
{
StringBuilder sb;
for (auto indent = m_depth++; indent > 0; indent--)
sb.append(' ');
if (m_extra.is_empty())
dbgln("\033[1;{}m{}entering {}\033[0m", m_depth % 8 + 30, sb.to_string(), m_location);
else
dbgln("\033[1;{}m{}entering {} ({})\033[0m", m_depth % 8 + 30, sb.to_string(), m_location, m_extra);
}
ScopeLogger(SourceLocation location = SourceLocation::current())
: ScopeLogger({}, move(location))
{
}
~ScopeLogger()
{
StringBuilder sb;
auto depth = m_depth;
for (auto indent = --m_depth; indent > 0; indent--)
sb.append(' ');
if (m_extra.is_empty())
dbgln("\033[1;{}m{}leaving {}\033[0m", depth % 8 + 30, sb.to_string(), m_location);
else
dbgln("\033[1;{}m{}leaving {} ({})\033[0m", depth % 8 + 30, sb.to_string(), m_location, m_extra);
}
private:
static inline size_t m_depth = 0;
SourceLocation m_location;
StringView m_extra;
#else
ScopeLogger() = default;
#endif
};
}
using AK::ScopeLogger;