libcruft-util/io.hpp

106 lines
2.7 KiB
C++
Raw Normal View History

2011-05-23 17:18:52 +10:00
/*
* This file is part of libgim.
2011-05-23 17:18:52 +10:00
*
2012-04-11 15:18:26 +10:00
* libgim is free software: you can redistribute it and/or modify it under the
2011-05-23 17:18:52 +10:00
* terms of the GNU General Public License as published by the Free Software
* Foundation, either version 3 of the License, or (at your option) any later
* version.
*
2012-04-11 15:18:26 +10:00
* libgim is distributed in the hope that it will be useful, but WITHOUT ANY
2011-05-23 17:18:52 +10:00
* WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
* details.
*
* You should have received a copy of the GNU General Public License
* along with libgim. If not, see <http://www.gnu.org/licenses/>.
2011-05-23 17:18:52 +10:00
*
2012-04-23 13:06:41 +10:00
* Copyright 2010-2012 Danny Robson <danny@nerdcruft.net>
2011-05-23 17:18:52 +10:00
*/
#ifndef __UTIL_IO_HPP
#define __UTIL_IO_HPP
2011-05-25 23:02:39 +10:00
#include "annotations.hpp"
2012-04-12 14:06:26 +10:00
#include "types.hpp"
2012-04-26 18:18:09 +10:00
#include "memory.hpp"
2011-05-25 23:02:39 +10:00
2011-05-23 17:18:52 +10:00
#include <cstdio>
#include <cstdint>
#include <memory>
#include <boost/filesystem/path.hpp>
2011-05-23 17:18:52 +10:00
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
};
2011-05-23 17:18:52 +10:00
/// Reads an entire file into memory. Caller frees the result. Guarantees a
/// null trailing byte.
2012-04-26 18:18:09 +10:00
std::unique_ptr<char []>
slurp (const boost::filesystem::path&) mustuse;
2011-05-23 17:18:52 +10:00
/// A simple RAII wrapper for file descriptors
struct fd_ref {
public:
int fd;
2011-05-23 17:18:52 +10:00
fd_ref (int _fd);
~fd_ref ();
operator int (void) const;
};
2011-05-23 17:18:52 +10:00
2012-04-12 14:06:26 +10:00
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 ();
};
#if defined(HAVE_MMAP)
/// Wraps a mechanism to map a file into memory. Read only.
class mapped_file {
protected:
fd_ref m_fd;
uint8_t *m_data;
size_t m_size;
2011-05-23 17:18:52 +10:00
void load_fd (void);
2011-05-23 17:18:52 +10:00
public:
mapped_file (const char *path);
mapped_file (const std::string &path);
mapped_file (const boost::filesystem::path &path);
2011-05-23 17:18:52 +10:00
mapped_file (const mapped_file &rhs);
mapped_file& operator =(const mapped_file &rhs);
2011-05-23 17:18:52 +10:00
~mapped_file ();
2011-05-23 17:18:52 +10:00
const uint8_t* data (void) const;
size_t size (void) const;
};
#endif
}
2011-05-23 17:18:52 +10:00
#endif