source_location.hpp

Go to the documentation of this file.

#ifndef BSL_SOURCE_LOCATION_HPP
#define BSL_SOURCE_LOCATION_HPP

#include "color.hpp"
#include "cstdint.hpp"
#include "cstr_type.hpp"
#include "debug.hpp"

namespace bsl
{
    class source_location final
    {
        using file_type = bsl::cstr_type;
        using func_type = bsl::cstr_type;
        using line_type = bsl::intmax;

        constexpr source_location(                    // --
            file_type const current_file,             // --
            func_type const current_func,             // --
            line_type const current_line) noexcept    // --
            : m_file{current_file}                    // --
            , m_func{current_func}                    // --
            , m_line{current_line}
        {}

    public:
        constexpr source_location() noexcept    // --
            : m_file{"unknown"}                 // --
            , m_func{"unknown"}                 // --
            , m_line{-1}
        {}

        static constexpr source_location
        current(
            file_type const current_file = BSL_BUILTIN_FILE,
            func_type const current_func = BSL_BUILTIN_FUNCTION,
            line_type const current_line = BSL_BUILTIN_LINE) noexcept
        {
            return {current_file, current_func, current_line};
        }

        [[nodiscard]] constexpr file_type
        file_name() const noexcept
        {
            return m_file;
        }

        [[nodiscard]] constexpr func_type
        function_name() const noexcept
        {
            return m_func;
        }

        [[nodiscard]] constexpr line_type
        line() const noexcept
        {
            return m_line;
        }

    private:
        file_type m_file;
        func_type m_func;
        line_type m_line;
    };

    constexpr source_location
    here(source_location const &sloc = source_location::current()) noexcept
    {
        return sloc;
    }

    template<typename T>
    [[maybe_unused]] constexpr out<T>
    operator<<(out<T> const o, source_location const &sloc) noexcept
    {
        if constexpr (o.empty()) {
            return o;
        }

        o << "  --> "                                               // --
          << bsl::yellow << sloc.file_name() << bsl::reset_color    // --
          << ": "                                                   // --
          << bsl::cyan << sloc.line() << bsl::reset_color           // --
          << bsl::endl;                                             // --

        return o;
    }

    using sloc_type = source_location;
}    // namespace bsl

#endif