libcruft-util/io.hpp
2015-04-13 18:06:08 +10:00

151 lines
3.8 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 "types.hpp"
#include "memory.hpp"
#include "platform.hpp"
#include "nocopy.hpp"
#include <cstdio>
#include <cstdint>
#include <memory>
#include <boost/filesystem/path.hpp>
#ifdef PLATFORM_WIN32
#include <windows.h>
#endif
namespace util {
/// Specifies bitwise combinations of IO access rights.
enum access_t {
ACCESS_READ = 1 << 0,
ACCESS_WRITE = 1 << 1,
ACCESS_READWRITE = ACCESS_READ | ACCESS_WRITE
};
/// Reads an entire file into memory. Caller frees the result. Guarantees a
/// null trailing byte.
std::unique_ptr<char []>
slurp [[gnu::warn_unused_result]] (const boost::filesystem::path&);
template <typename T>
void
write (const boost::filesystem::path &, const T *data, size_t len);
///------------------------------------------------------------------------
/// A simple RAII wrapper for file descriptors
struct fd_ref {
public:
int fd;
explicit fd_ref (int _fd);
explicit fd_ref (const boost::filesystem::path&, access_t access);
~fd_ref ();
operator int (void) const;
};
#ifdef PLATFORM_WIN32
struct handle_ref : util::nocopy {
public:
explicit handle_ref (HANDLE);
explicit handle_ref ();
~handle_ref ();
void reset (HANDLE);
operator HANDLE (void) const;
HANDLE handle;
};
#endif
//-------------------------------------------------------------------------
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);
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 {
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:
boost::filesystem::path m_original;
};
void set_cwd (const boost::filesystem::path &);
//-------------------------------------------------------------------------
class path_error : public std::runtime_error {
public:
path_error (const boost::filesystem::path &path):
runtime_error ("Invalid path " + path.string ())
{ ; }
};
}
#ifdef PLATFORM_WIN32
#include "io_win32.hpp"
#else
#include "io_posix.hpp"
#endif
#include "io.ipp"
#endif