libcruft-util/cruft/util/io.cpp

/*
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * Copyright 2010-2018 Danny Robson <danny@nerdcruft.net>
 */

#include "io.hpp"

#include "debug/assert.hpp"
#include "cast.hpp"
#include "posix/except.hpp"

#include <fmt/ostream.h>
#include <fmt/std.h>

#include <cstdio>
#include <fcntl.h>
#include <sys/stat.h>
#include <unistd.h>

#include <filesystem>
#include <stdexcept>


using namespace cruft;


//////////////////////////////////////////////////////////////////////////////
template <typename T>
std::vector<T>
cruft::slurp (const std::filesystem::path &path)
{
    posix::fd out (path, O_RDONLY | O_BINARY);

    // Calculate the total file size
    off_t size = posix::error::try_value (lseek (out, 0, SEEK_END));
    if (size % sizeof (T))
        throw std::runtime_error ("filesize not correctly rounded");

    posix::error::try_value (lseek (out, 0, SEEK_SET));

    // Allocate a buffer, and keep reading until it's full.
    std::vector<T> buffer (size);

    CHECK_GE (size, 0);
    unsigned remaining = cruft::cast::lossless<unsigned> (size);
    T *cursor = buffer.data ();

    while (remaining) {
        ssize_t consumed = posix::error::try_value(
            ::read (out, cursor, remaining)
        );

        CHECK_GT (consumed, 0);
        CHECK_LE (cruft::cast::sign<size_t> (consumed), remaining);

        remaining -= cruft::cast::sign<size_t> (consumed);
        cursor    += consumed;
    }

    return buffer;
}


//-----------------------------------------------------------------------------
template std::vector<char> cruft::slurp (const std::filesystem::path&);
template std::vector<unsigned char> cruft::slurp (const std::filesystem::path&);
template std::vector<std::byte> cruft::slurp (const std::filesystem::path&);
template std::vector<uint32_t> cruft::slurp (const std::filesystem::path&);


///////////////////////////////////////////////////////////////////////////////
template <typename T>
std::vector<T>
cruft::slurp (FILE *stream)
{
    static_assert (
        sizeof (T) == 1,
        "slurp is designed for grabbing bytes, not complex structures"
    );

    // find how much data is in this file
    const int desc = cruft::posix::error::try_value (fileno (stream));

    struct stat meta;
    posix::error::try_value (fstat (desc, &meta));

    std::vector<T> buf;

    // we think we know the size, so try to do a simple read
    if (meta.st_size) {
        buf.resize (meta.st_size);

        // read as much as possible, then resize to the actual length
        auto res = fread (buf.data (), 1, meta.st_size, stream);
        buf.resize (res);
    }

    // try reading small chunks until we've hit the end. important for
    // handling pipe streams (like from popen) which report a zero size.
    constexpr size_t CHUNK_SIZE = 128;
    size_t cursor = buf.size ();

    while (!feof (stream) && !ferror (stream)) {
        auto oldsize = buf.size ();
        buf.resize (oldsize + CHUNK_SIZE);
        auto res = fread (buf.data () + cursor, 1, CHUNK_SIZE, stream);

        if (res != CHUNK_SIZE)
            buf.resize (oldsize + res);
    }

    if (ferror (stream))
        throw stream_error ();

    return buf;
}


//-----------------------------------------------------------------------------
template std::vector<char> cruft::slurp (FILE*);
template std::vector<std::byte> cruft::slurp (FILE*);



///////////////////////////////////////////////////////////////////////////////
template <typename ValueT>
std::vector<ValueT>
cruft::slurp (posix::fd &src)
{
    struct stat meta;
    posix::error::try_value (fstat (src, &meta));

    std::vector<ValueT> buf;

    // we think we know the size, so try to do a simple read
    if (meta.st_size) {
        buf.resize (meta.st_size);

        // read as much as possible, then resize to the actual length
        auto const res = cruft::posix::error::try_call (
            ::read, src.native (), buf.data (), meta.st_size
        );
        buf.resize (res);
    }

    // try reading small chunks until we've hit the end. important for
    // handling pipe streams (like from popen) which report a zero size.
    constexpr size_t CHUNK_SIZE = 1024;

    while (1) {
        // Make room for some more data
        auto const oldsize = buf.size ();
        buf.resize (oldsize + CHUNK_SIZE);

        // Append the data
        auto const res = cruft::posix::error::try_call (
            ::read, src.native (), buf.data () + oldsize, CHUNK_SIZE
        );
        buf.resize (oldsize + res);

        // Bail if we've hit EOF
        if (res == 0)
            break;
    }

    return buf;
}


//-----------------------------------------------------------------------------
template std::vector<char> cruft::slurp (posix::fd&);
template std::vector<std::byte> cruft::slurp (posix::fd&);


//////////////////////////////////////////////////////////////////////////////
int
indenter::overflow (int ch) {
    if (m_line_start && ch != '\n')
        m_dest->sputn (m_indent.data (), cruft::cast::sign<std::streamsize> (m_indent.size ()));

    m_line_start = ch == '\n';
    return m_dest->sputc (ch);
}


//-----------------------------------------------------------------------------
indenter::indenter (std::streambuf* _dest, size_t _indent)
    : m_dest       (_dest)
    , m_line_start (true)
    , m_indent     (_indent, ' ')
    , m_owner      (NULL)
{ ; }


//-----------------------------------------------------------------------------
indenter::indenter (std::ostream& _dest, size_t _indent)
    : m_dest       (_dest.rdbuf())
    , m_line_start (true)
    , m_indent     (_indent, ' ')
    , m_owner      (&_dest)
{
    m_owner->rdbuf (this);
}


//-----------------------------------------------------------------------------
indenter::~indenter ()
{
    if (m_owner != NULL)
        m_owner->rdbuf (m_dest);
}


//////////////////////////////////////////////////////////////////////////////
scoped_cwd::scoped_cwd ()
{
    m_original.resize (16);
    while (getcwd (&m_original[0], cruft::cast::lossless<int> (m_original.size ())) == nullptr && errno == ERANGE)
        m_original.resize (m_original.size () * 2);
    posix::error::try_code ();
}


//-----------------------------------------------------------------------------
scoped_cwd::~scoped_cwd ()
{
    if (!chdir (m_original.c_str ()))
        posix::error::throw_code ();
}


///////////////////////////////////////////////////////////////////////////////
path_error::path_error (std::filesystem::path const &_path):
    runtime_error (fmt::format ("Unknown path: {}", _path)),
    m_path (_path)
{ ; }


//-----------------------------------------------------------------------------
const std::filesystem::path&
path_error::path (void) const noexcept
{
    return m_path;
}