/*
* This file is part of the DXX-Rebirth project .
* It is copyright by its individual contributors, as recorded in the
* project's Git history. See COPYING.txt at the top level for license
* terms and a link to the Git history.
*/
#pragma once
#include
#include
#include
#include "dxxsconf.h"
template
class location_wrapper
{
public:
location_wrapper() = default;
/* Allow callers to pass explicit file/line, for signature
* compatibility with `location_wrapper`.
*/
location_wrapper(const char *, unsigned)
{
}
/* This must be a template to be compatible with the `scratch_buffer`
* template-typedef in `location_wrapper`.
*/
template
using scratch_buffer = std::false_type;
template
static std::span insert_location_leader(char (&buffer)[N])
{
return buffer;
}
/* Define overloads to preserve const qualification */
static std::span prepare_buffer(scratch_buffer<0> &, char *const text, const std::size_t len)
{
return {text, len};
}
static std::span prepare_buffer(scratch_buffer<0> &, const char *const text, const std::size_t len)
{
return {text, len};
}
};
#ifdef DXX_HAVE_CXX_BUILTIN_FILE_LINE
#include
template <>
class location_wrapper
{
const char *file;
unsigned line;
public:
template
using scratch_buffer = char[N];
location_wrapper(const char *const f = __builtin_FILE(), const unsigned l = __builtin_LINE()) :
file(f), line(l)
{
}
/* Return a span describing the unwritten area into which the caller can
* place further text.
*/
template
std::span insert_location_leader(char (&buffer)[N]) const
{
const auto written = std::snprintf(buffer, sizeof(buffer), "%s:%u: ", file, line);
return std::span(buffer).subspan(written);
}
/* Return a span describing the written area that the caller can read
* without accessing undefined bytes.
*/
template
std::span prepare_buffer(char (&buffer)[N], const char *const text, const std::size_t len) const
{
const auto written = std::snprintf(buffer, sizeof(buffer), "%s:%u: %.*s", file, line, static_cast(len), text);
return {buffer, written};
}
/* Delegate to the const-qualified version, but return a `char *` to
* match the non-const input `char *`, to preserve the choice of
* overload for the function to receive this result.
*/
template
std::span prepare_buffer(char (&buffer)[N], char *const text, const std::size_t len) const
{
return {buffer, prepare_buffer(buffer, const_cast(text), len).size()};
}
};
#endif
template
class location_value_wrapper : public location_wrapper
{
T value;
public:
/* Allow callers to pass explicit file/line, for signature
* compatibility with `location_value_wrapper`.
*/
#ifndef DXX_HAVE_CXX_BUILTIN_FILE_LINE
location_value_wrapper(const T &v) :
value(v)
{
}
#endif
location_value_wrapper(const T &v,
const char *const f
#ifdef DXX_HAVE_CXX_BUILTIN_FILE_LINE
= __builtin_FILE()
#endif
, const unsigned l
#ifdef DXX_HAVE_CXX_BUILTIN_FILE_LINE
= __builtin_LINE()
#endif
) :
location_wrapper(f, l),
value(v)
{
}
operator T() const
{
return value;
}
};