libcruft-util/io.hpp
Danny Robson e48aebb503 io: remove lvalue write function
writing arbitrary lvalues is incredibly dangerous if we don't have total
coverage of suitable overloads. eg, we have accidentally written string
objects to file descriptors.

instead we prefer byte/char views which the user can create as desired.
there's a little more cognitive overhead here, but it's substantially
less dangerous in casual usage.
2017-12-19 18:18:10 +11:00

139 lines
3.6 KiB
C++

/*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* Copyright 2010-2014 Danny Robson <danny@nerdcruft.net>
*/
#ifndef __UTIL_IO_HPP
#define __UTIL_IO_HPP
#include "platform.hpp"
#include "posix/fd.hpp"
#include <cstddef>
#include <cstdint>
#include <cstdio>
#include <experimental/filesystem>
#include <vector>
#include <streambuf>
#ifdef PLATFORM_WIN32
#include <windows.h>
#else
#define O_BINARY 0
#endif
namespace util {
//-------------------------------------------------------------------------
/// Reads an entire file into memory.
template <typename T = std::byte>
std::vector<T> slurp (const std::experimental::filesystem::path&);
template <typename T = std::byte>
std::vector<T> slurp (FILE *);
//-------------------------------------------------------------------------
void write (const posix::fd&, const void *restrict data, size_t bytes);
inline void
write (const posix::fd &dst, util::view<const char*> data)
{
write (dst, std::data (data), std::size (data));
}
template <typename T>
void write (const posix::fd &_fd, const T &data)
{
return write (_fd, make_view (data));
}
//-------------------------------------------------------------------------
class indenter : public std::streambuf {
protected:
std::streambuf* m_dest;
bool m_line_start;
std::string m_indent;
std::ostream* m_owner;
protected:
virtual int overflow (int ch) override;
public:
explicit indenter (std::streambuf* _dest, size_t _indent = 4);
explicit indenter (std::ostream& _dest, size_t _indent = 4);
virtual ~indenter ();
};
//-------------------------------------------------------------------------
template <typename T>
struct indented {
explicit indented (const T &_data);
const T &data;
};
//-------------------------------------------------------------------------
template <typename T>
indented<T>
make_indented (const T &_data);
//-------------------------------------------------------------------------
template <typename T>
std::ostream&
operator<< (std::ostream &os, const util::indented<T> &v);
//-------------------------------------------------------------------------
class scoped_cwd {
public:
scoped_cwd ();
~scoped_cwd ();
protected:
std::string m_original;
};
//-------------------------------------------------------------------------
class path_error : public std::runtime_error {
public:
explicit path_error (const std::experimental::filesystem::path &path);
const std::experimental::filesystem::path& path (void) const noexcept;
private:
const std::experimental::filesystem::path m_path;
};
class stream_error : public std::exception {
public:
virtual const char* what (void) const noexcept
{ return "error on C stream"; }
};
}
#ifdef PLATFORM_WIN32
#include "io_win32.hpp"
#else
#include "io_posix.hpp"
#endif
#include "io.ipp"
#endif