core.hpp

#pragma once
 
#include "terminalpp/detail/export.hpp"  // IWYU pragma: export
 
#include <span>
#include <string>
#include <cstdint>
 
namespace terminalpp {
 
// A byte in Terminal++ is represented consistently as an unsigned
// 8-bit integer.
using byte = std::uint8_t;
 
// A stream of bytes in Terminal++ is exposed as a non-owning span.  It is
// expected that the data will live for no longer than any function in which
// it is found.  For that reason, these spans should never be stored directly.
// If storage is necessary, it must be converted into a longer-term data
// structure.
using bytes = std::span<byte const>;
 
// Where necessary, bytes are stored in this type, which has the small string
// optimization, meaning that most cases will not cause an allocation.
using byte_storage = std::basic_string<byte>;
 
// A co-ordinate in a terminal is represented consistently as a signed
// 32-bit integer.
using coordinate_type = std::int32_t;
 
inline namespace literals {
 
// A helper function to convert from a character literal to a byte.
constexpr byte operator""_tb(char const text)
{
    return static_cast<byte>(text);
}
 
// A helper function to convert from string literals to stored bytes.
constexpr byte_storage operator""_tb(char const *text, size_t length)
{
    byte_storage result;
    result.reserve(length);
 
    for (auto const ch : std::span{text, length})
    {
        result.push_back(static_cast<byte>(ch));
    }
 
    return result;
}
 
}  // namespace literals
 
// A helper function to convert from strings to stored bytes.
constexpr byte_storage to_bytes(std::string const &str)
{
    byte_storage result;
    result.reserve(str.size());
 
    for (auto const ch : str)
    {
        result.push_back(static_cast<byte>(ch));
    }
 
    return result;
}
 
}  // namespace terminalpp