idrec.hpp

/*
    SPDX-License-Identifier: MIT
    Copyright © 2016-2023 Amebis
*/
 
#pragma once
 
#include "sal.hpp"
#include "stream.hpp"
#include <ios>
#include <istream>
#include <ostream>
 
namespace stdex {
    namespace idrec {
        template <class T_ID>
        _Success_(return) bool read_id(_In_ std::istream& stream, _Out_ T_ID &id, _In_opt_ std::streamoff end = (std::streamoff)-1)
        {
            if (end == (std::streamoff)-1 || stream.tellg() < end) {
                stream.read((char*)&id, sizeof(id));
                return stream.good();
            } else
                return false;
        }
 
        template <class T_ID>
        _Success_(return) bool read_id(_In_ stdex::stream::basic_file& stream, _Out_ T_ID &id, _In_opt_ stdex::stream::fpos_t end = stdex::stream::fpos_max)
        {
            if (end == stdex::stream::fpos_max || stream.tell() < end) {
                stream >> id;
                return stream.ok();
            } else
                return false;
        }
 
        template <class T_SIZE, unsigned int ALIGN>
        bool ignore(_In_ std::istream& stream)
        {
            // Read record size.
            T_SIZE size;
            stream.read((char*)&size, sizeof(size));
            if (!stream.good()) _Unlikely_ return false;
 
            // Skip the record data.
            size += (T_SIZE)(ALIGN - size) % ALIGN;
            stream.ignore(size);
            if (!stream.good()) _Unlikely_ return false;
 
            return true;
        }
 
        template <class T_SIZE, unsigned int ALIGN>
        bool ignore(_In_ stdex::stream::basic_file& stream)
        {
            // Read record size.
            T_SIZE size;
            stream >> size;
            if (!stream.ok()) _Unlikely_ return false;
 
            // Skip the record data.
            size += (T_SIZE)(ALIGN - size) % ALIGN;
            stream.skip(size);
            if (!stream.ok()) _Unlikely_ return false;
 
            return true;
        }
 
        template <class T_ID, class T_SIZE, unsigned int ALIGN>
        bool find(_In_ std::istream& stream, _In_ T_ID id, _In_opt_ std::streamoff end = (std::streamoff)-1)
        {
            T_ID _id;
            while (end == (std::streamoff)-1 || stream.tellg() < end) {
                stream.read((char*)&_id, sizeof(_id));
                if (!stream.good()) _Unlikely_ return false;
                if (_id == id) {
                    // The record was found.
                    return true;
                } else
                    ignore<T_SIZE, ALIGN>(stream);
            }
            return false;
        }
 
        template <class T_ID, class T_SIZE, unsigned int ALIGN>
        bool find(_In_ stdex::stream::basic_file& stream, _In_ T_ID id, _In_opt_ stdex::stream::fpos_t end = stdex::stream::fpos_max)
        {
            T_ID _id;
            while (end == stdex::stream::fpos_max || stream.tell() < end) {
                stream >> _id;
                if (!stream.ok()) _Unlikely_ return false;
                if (_id == id) {
                    // The record was found.
                    return true;
                } else
                    ignore<T_SIZE, ALIGN>(stream);
            }
            return false;
        }
 
        template <class T_ID, class T_SIZE>
        std::streamoff open(_In_ std::ostream& stream, _In_ T_ID id)
        {
            std::streamoff start = stream.tellp();
 
            // Write ID.
            if (stream.fail()) _Unlikely_ return (std::streamoff)-1;
            stream.write((const char*)&id, sizeof(id));
 
            // Write 0 as a placeholder for data size.
            if (stream.fail()) _Unlikely_ return (std::streamoff)-1;
            T_SIZE size = 0;
            stream.write((const char*)&size, sizeof(size));
 
            return start;
        }
 
        template <class T_ID, class T_SIZE>
        stdex::stream::fpos_t open(_In_ stdex::stream::basic_file& stream, _In_ T_ID id)
        {
            auto start = stream.tell();
 
            // Write ID.
            if (!stream.ok()) _Unlikely_ return stdex::stream::fpos_max;
            stream << id;
 
            // Write 0 as a placeholder for data size.
            if (!stream.ok()) _Unlikely_ return stdex::stream::fpos_max;
            stream << (T_SIZE)0;
 
            return start;
        }
 
        template <class T_ID, class T_SIZE, unsigned int ALIGN>
        std::streamoff close(_In_ std::ostream& stream, _In_ std::streamoff start)
        {
            std::streamoff end = stream.tellp();
            T_SIZE
                size      = static_cast<T_SIZE>(end - start - sizeof(T_ID) - sizeof(T_SIZE)),
                remainder = static_cast<T_SIZE>((ALIGN - size) % ALIGN); // Number of bytes we need to add, to keep the data integral number of ALIGN blocks long
 
            if (remainder) {
                // Append padding.
                static const char padding[ALIGN] = {};
                stream.write(padding, remainder);
                end += remainder;
            }
 
            // Update the data size.
            if (stream.fail()) _Unlikely_ return (std::streamoff)-1;
            stream.seekp(start + sizeof(T_ID));
            stream.write((const char*)&size, sizeof(size));
            stream.seekp(end);
 
            return end;
        }
 
        template <class T_ID, class T_SIZE, unsigned int ALIGN>
        stdex::stream::fpos_t close(_In_ stdex::stream::basic_file& stream, _In_ stdex::stream::fpos_t start)
        {
            auto end = stream.tell();
            T_SIZE
                size      = static_cast<T_SIZE>(end - start - sizeof(T_ID) - sizeof(T_SIZE)),
                remainder = static_cast<T_SIZE>((ALIGN - size) % ALIGN); // Number of bytes we need to add, to keep the data integral number of ALIGN blocks long
 
            if (remainder) {
                // Append padding.
                static const char padding[ALIGN] = {};
                stream.write_array(padding, sizeof(char), remainder);
                end += remainder;
            }
 
            // Update the data size.
            if (!stream.ok()) _Unlikely_ return stdex::stream::fpos_max;
            stream.seek(start + sizeof(T_ID));
            stream << size;
            stream.seek(end);
 
            return end;
        }
 
        template <class T, class T_ID, const T_ID ID, class T_SIZE, unsigned int ALIGN>
        class record
        {
        public:
            record(_In_ T &d) : data(d) {}
 
            record(_In_ const T &d) : data((T&)d) {}
 
            static const T_ID id()
            {
                return ID;
            }
 
            const record<T, T_ID, ID, T_SIZE, ALIGN>& operator =(_In_ const record<T, T_ID, ID, T_SIZE, ALIGN> &r)
            {
                data = r.data;
                return *this;
            }
 
            static std::streamoff open(_In_ std::ostream& stream)
            {
                return stdex::idrec::open<T_ID, T_SIZE>(stream, ID);
            }
 
            static stdex::stream::foff_t open(_In_ stdex::stream::basic_file& stream)
            {
                return stdex::idrec::open<T_ID, T_SIZE>(stream, ID);
            }
 
            static std::streamoff close(_In_ std::ostream& stream, _In_ std::streamoff start)
            {
                return stdex::idrec::close<T_ID, T_SIZE, ALIGN>(stream, start);
            }
 
            static stdex::stream::foff_t close(_In_ stdex::stream::basic_file& stream, _In_ stdex::stream::foff_t start)
            {
                return stdex::idrec::close<T_ID, T_SIZE, ALIGN>(stream, start);
            }
 
            static bool find(_In_ std::istream& stream, _In_opt_ std::streamoff end = (std::streamoff)-1)
            {
                return stdex::idrec::find<T_ID, T_SIZE, ALIGN>(stream, ID, end);
            }
 
            static bool find(_In_ stdex::stream::basic_file& stream, _In_opt_ stdex::stream::foff_t end = stdex::stream::foff_max)
            {
                return stdex::idrec::find<T_ID, T_SIZE, ALIGN>(stream, ID, end);
            }
 
            T &data; 
        };
    };
};
 
template <class T, class T_ID, T_ID ID, class T_SIZE, unsigned int ALIGN>
std::ostream& operator <<(_In_ std::ostream& stream, _In_ const stdex::idrec::record<T, T_ID, ID, T_SIZE, ALIGN> r)
{
    // Parameter r does not need to be passed by reference. It has only one field (data), which is a reference itself already.
 
    auto start = r.open(stream);
    if (stream.fail()) _Unlikely_ return stream;
    stream << r.data;
    r.close(stream, start);
 
    return stream;
}
 
template <class T, class T_ID, T_ID ID, class T_SIZE, unsigned int ALIGN>
stdex::stream::basic_file& operator <<(_In_ stdex::stream::basic_file& stream, _In_ const stdex::idrec::record<T, T_ID, ID, T_SIZE, ALIGN> r)
{
    // Parameter r does not need to be passed by reference. It has only one field (data), which is a reference itself already.
 
    auto start = r.open(stream);
    if (!stream.ok()) _Unlikely_ return stream;
    stream << r.data;
    r.close(stream, start);
 
    return stream;
}
 
template <class T, class T_ID, T_ID ID, class T_SIZE, unsigned int ALIGN>
std::istream& operator >>(_In_ std::istream& stream, _In_ stdex::idrec::record<T, T_ID, ID, T_SIZE, ALIGN> r)
{
    // Parameter r does not need to be passed by reference. It has only one field (data), which is a reference itself already.
 
    // Read data size.
    T_SIZE size;
    stream.read((char*)&size, sizeof(size));
    if (!stream.good()) _Unlikely_ return stream;
 
    // Read data.
    std::streamoff start = stream.tellg();
    stream >> r.data; // TODO: operator >> should not read past the record data! Make a size limited stream and read from it instead.
    if (!stream.good()) _Unlikely_ return stream;
 
    size += static_cast<T_SIZE>((ALIGN - size) % ALIGN);
    stream.seekg(start + size);
 
    return stream;
}
 
template <class T, class T_ID, T_ID ID, class T_SIZE, unsigned int ALIGN>
stdex::stream::basic_file& operator >>(_In_ stdex::stream::basic_file& stream, _In_ stdex::idrec::record<T, T_ID, ID, T_SIZE, ALIGN> r)
{
    // Parameter r does not need to be passed by reference. It has only one field (data), which is a reference itself already.
 
    // Read data size.
    T_SIZE size;
    stream >> size;
    if (!stream.ok()) _Unlikely_ return stream;
 
    // Read data.
    auto start = stream.tell();
    {
        stdex::stream::limiter limiter(stream, size, size);
        limiter >> r.data;
        if (!limiter.ok()) _Unlikely_ return stream;
    }
 
    size += static_cast<T_SIZE>((ALIGN - size) % ALIGN);
    stream.seek(start + size);
 
    return stream;
}