libcruft-util/io.hpp

80 lines
2.0 KiB
C++
Raw Normal View History

2011-05-23 17:18:52 +10:00
/*
* This file is part of waif.
*
* Waif is free software: you can redistribute it and/or modify it under the
* 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.
*
* Waif is distributed in the hope that it will be useful, but WITHOUT ANY
* 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 waif. If not, see <http://www.gnu.org/licenses/>.
*
* Copyright 2010 Danny Robson <danny@blubinc.net>
*/
#ifndef __UTIL_IO_HPP
#define __UTIL_IO_HPP
2011-05-25 23:02:39 +10:00
#include "annotations.hpp"
2011-05-23 17:18:52 +10:00
#include <cstdio>
#include <cstdint>
#include <memory>
#include <boost/filesystem.hpp>
2011-05-25 23:02:39 +10:00
/// Specifies bitwise combinations of IO access rights.
2011-05-23 17:18:52 +10:00
enum access_t {
ACCESS_READ = 1 << 0,
ACCESS_WRITE = 1 << 1,
ACCESS_READWRITE = ACCESS_READ | ACCESS_WRITE
};
2011-05-25 23:02:39 +10:00
/// Reads an entire file into memory. Caller frees the result. Guarantees a
/// null trailing byte.
uint8_t *
slurp (boost::filesystem::path&) mustuse;
2011-05-23 17:18:52 +10:00
2011-05-25 23:02:39 +10:00
/// A simple RAII wrapper for file descriptors
2011-05-23 17:18:52 +10:00
struct fd_ref {
public:
2011-05-25 23:02:39 +10:00
int fd;
2011-05-23 17:18:52 +10:00
fd_ref (int _fd);
~fd_ref ();
operator int (void) const;
};
2011-05-25 23:02:39 +10:00
/// Wraps a mechanism to map a file into memory. Read only.
2011-05-23 17:18:52 +10:00
class mapped_file {
protected:
fd_ref m_fd;
uint8_t *m_data;
size_t m_size;
void load_fd (void);
public:
mapped_file (const char *path);
mapped_file (const std::string &path);
mapped_file (const boost::filesystem::path &path);
mapped_file (const mapped_file &rhs);
mapped_file& operator =(const mapped_file &rhs);
~mapped_file ();
const uint8_t* data (void) const;
size_t size (void) const;
};
#endif