2012-10-15 16:58:33 +04:00
|
|
|
#ifndef UTIL_FILE__
|
|
|
|
#define UTIL_FILE__
|
|
|
|
|
2013-01-17 15:58:58 +04:00
|
|
|
#include "util/exception.hh"
|
|
|
|
|
2012-10-15 16:58:33 +04:00
|
|
|
#include <cstddef>
|
|
|
|
#include <cstdio>
|
|
|
|
#include <string>
|
|
|
|
|
|
|
|
#include <stdint.h>
|
|
|
|
|
|
|
|
namespace util {
|
|
|
|
|
|
|
|
class scoped_fd {
|
|
|
|
public:
|
|
|
|
scoped_fd() : fd_(-1) {}
|
|
|
|
|
|
|
|
explicit scoped_fd(int fd) : fd_(fd) {}
|
|
|
|
|
|
|
|
~scoped_fd();
|
|
|
|
|
2013-01-17 15:58:58 +04:00
|
|
|
void reset(int to = -1) {
|
2012-10-15 16:58:33 +04:00
|
|
|
scoped_fd other(fd_);
|
|
|
|
fd_ = to;
|
|
|
|
}
|
|
|
|
|
|
|
|
int get() const { return fd_; }
|
|
|
|
|
|
|
|
int operator*() const { return fd_; }
|
|
|
|
|
|
|
|
int release() {
|
|
|
|
int ret = fd_;
|
|
|
|
fd_ = -1;
|
|
|
|
return ret;
|
|
|
|
}
|
|
|
|
|
|
|
|
private:
|
|
|
|
int fd_;
|
|
|
|
|
|
|
|
scoped_fd(const scoped_fd &);
|
|
|
|
scoped_fd &operator=(const scoped_fd &);
|
|
|
|
};
|
|
|
|
|
|
|
|
class scoped_FILE {
|
|
|
|
public:
|
|
|
|
explicit scoped_FILE(std::FILE *file = NULL) : file_(file) {}
|
|
|
|
|
|
|
|
~scoped_FILE();
|
|
|
|
|
|
|
|
std::FILE *get() { return file_; }
|
|
|
|
const std::FILE *get() const { return file_; }
|
|
|
|
|
|
|
|
void reset(std::FILE *to = NULL) {
|
|
|
|
scoped_FILE other(file_);
|
|
|
|
file_ = to;
|
|
|
|
}
|
|
|
|
|
|
|
|
std::FILE *release() {
|
|
|
|
std::FILE *ret = file_;
|
|
|
|
file_ = NULL;
|
|
|
|
return ret;
|
|
|
|
}
|
|
|
|
|
|
|
|
private:
|
|
|
|
std::FILE *file_;
|
|
|
|
};
|
|
|
|
|
2013-01-17 15:58:58 +04:00
|
|
|
/* Thrown for any operation where the fd is known. */
|
|
|
|
class FDException : public ErrnoException {
|
|
|
|
public:
|
|
|
|
explicit FDException(int fd) throw();
|
|
|
|
|
|
|
|
virtual ~FDException() throw();
|
|
|
|
|
|
|
|
// This may no longer be valid if the exception was thrown past open.
|
|
|
|
int FD() const { return fd_; }
|
|
|
|
|
|
|
|
// Guess from NameFromFD.
|
|
|
|
const std::string &NameGuess() const { return name_guess_; }
|
|
|
|
|
|
|
|
private:
|
|
|
|
int fd_;
|
|
|
|
|
|
|
|
std::string name_guess_;
|
|
|
|
};
|
|
|
|
|
|
|
|
// End of file reached.
|
|
|
|
class EndOfFileException : public Exception {
|
|
|
|
public:
|
|
|
|
EndOfFileException() throw();
|
|
|
|
~EndOfFileException() throw();
|
|
|
|
};
|
|
|
|
|
2012-10-15 16:58:33 +04:00
|
|
|
// Open for read only.
|
|
|
|
int OpenReadOrThrow(const char *name);
|
|
|
|
// Create file if it doesn't exist, truncate if it does. Opened for write.
|
|
|
|
int CreateOrThrow(const char *name);
|
|
|
|
|
|
|
|
// Return value for SizeFile when it can't size properly.
|
|
|
|
const uint64_t kBadSize = (uint64_t)-1;
|
|
|
|
uint64_t SizeFile(int fd);
|
2013-01-17 15:58:58 +04:00
|
|
|
uint64_t SizeOrThrow(int fd);
|
2012-10-15 16:58:33 +04:00
|
|
|
|
|
|
|
void ResizeOrThrow(int fd, uint64_t to);
|
|
|
|
|
2012-10-30 23:33:22 +04:00
|
|
|
std::size_t PartialRead(int fd, void *to, std::size_t size);
|
2012-10-15 16:58:33 +04:00
|
|
|
void ReadOrThrow(int fd, void *to, std::size_t size);
|
2012-10-30 23:33:22 +04:00
|
|
|
std::size_t ReadOrEOF(int fd, void *to_void, std::size_t size);
|
2013-01-17 15:58:58 +04:00
|
|
|
// Positioned: unix only for now.
|
|
|
|
void PReadOrThrow(int fd, void *to, std::size_t size, uint64_t off);
|
2012-10-15 16:58:33 +04:00
|
|
|
|
|
|
|
void WriteOrThrow(int fd, const void *data_void, std::size_t size);
|
|
|
|
void WriteOrThrow(FILE *to, const void *data, std::size_t size);
|
|
|
|
|
|
|
|
void FSyncOrThrow(int fd);
|
|
|
|
|
|
|
|
// Seeking
|
|
|
|
void SeekOrThrow(int fd, uint64_t off);
|
|
|
|
void AdvanceOrThrow(int fd, int64_t off);
|
|
|
|
void SeekEnd(int fd);
|
|
|
|
|
|
|
|
std::FILE *FDOpenOrThrow(scoped_fd &file);
|
2012-10-30 23:33:22 +04:00
|
|
|
std::FILE *FDOpenReadOrThrow(scoped_fd &file);
|
2012-10-15 16:58:33 +04:00
|
|
|
|
2013-01-17 15:58:58 +04:00
|
|
|
// Temporary files
|
|
|
|
int MakeTemp(const std::string &prefix);
|
|
|
|
std::FILE *FMakeTemp(const std::string &prefix);
|
2012-10-15 16:58:33 +04:00
|
|
|
|
2013-01-17 15:58:58 +04:00
|
|
|
// dup an fd.
|
|
|
|
int DupOrThrow(int fd);
|
2012-10-15 16:58:33 +04:00
|
|
|
|
2013-01-17 15:58:58 +04:00
|
|
|
/* Attempt get file name from fd. This won't always work (i.e. on Windows or
|
|
|
|
* a pipe). The file might have been renamed. It's intended for diagnostics
|
|
|
|
* and logging only.
|
|
|
|
*/
|
|
|
|
std::string NameFromFD(int fd);
|
2012-10-15 16:58:33 +04:00
|
|
|
|
|
|
|
} // namespace util
|
|
|
|
|
|
|
|
#endif // UTIL_FILE__
|