diff options
| author | madmaxoft@gmail.com <madmaxoft@gmail.com@0a769ca7-a7f5-676a-18bf-c427514a06d6> | 2012-01-30 14:54:39 +0100 |
|---|---|---|
| committer | madmaxoft@gmail.com <madmaxoft@gmail.com@0a769ca7-a7f5-676a-18bf-c427514a06d6> | 2012-01-30 14:54:39 +0100 |
| commit | 7e743398a92f6878659fc429bda26501ca2fa357 (patch) | |
| tree | 5d3766ccc9a46d5d64e8311ec3b9b3bf78c878dd /source/cFile.h | |
| parent | Added missing #ifdef _DEBUG in cCriticalSection.cpp (diff) | |
| download | cuberite-7e743398a92f6878659fc429bda26501ca2fa357.tar cuberite-7e743398a92f6878659fc429bda26501ca2fa357.tar.gz cuberite-7e743398a92f6878659fc429bda26501ca2fa357.tar.bz2 cuberite-7e743398a92f6878659fc429bda26501ca2fa357.tar.lz cuberite-7e743398a92f6878659fc429bda26501ca2fa357.tar.xz cuberite-7e743398a92f6878659fc429bda26501ca2fa357.tar.zst cuberite-7e743398a92f6878659fc429bda26501ca2fa357.zip | |
Diffstat (limited to '')
| -rw-r--r-- | source/cFile.h | 99 |
1 files changed, 99 insertions, 0 deletions
diff --git a/source/cFile.h b/source/cFile.h new file mode 100644 index 000000000..0c3abb1d9 --- /dev/null +++ b/source/cFile.h @@ -0,0 +1,99 @@ +
+// cFile.h
+
+// Interfaces to the cFile class providing an OS-independent abstraction of a file.
+
+/*
+The object is optimized towards binary reads.
+The object has no multithreading locks, don't use from multiple threads!
+Usage:
+1, Construct a cFile instance (no-param constructor)
+2, Open a file using Open(), check return value for success
+3, Read / write
+4, Destroy the instance
+
+-- OR --
+
+1, Construct a cFile instance opening the file (filename-param constructor)
+2, Check if the file was opened using IsOpen()
+3, Read / write
+4, Destroy the instance
+*/
+
+
+
+
+
+#pragma once
+#ifndef CFILE_H_INCLUDED
+#define CFILE_H_INCLUDED
+
+
+
+
+
+#ifndef _WIN32
+ #define USE_STDIO_FILE
+#endif // _WIN32
+
+// DEBUG:
+#define USE_STDIO_FILE
+
+
+
+
+
+class cFile
+{
+public:
+ /// The mode in which to open the file
+ enum EMode
+ {
+ fmRead, // Read-only. If the file doesn't exist, object will not be valid
+ fmWrite, // Write-only. If the file already exists, it will be overwritten
+ fmReadWrite, // Read/write. If the file already exists, it will be left intact
+ } ;
+
+ /// Simple constructor - creates an unopened file object, use Open() to open / create a real file
+ cFile(void);
+
+ /// Constructs and opens / creates the file specified, use IsOpen() to check for success
+ cFile(const char * iFileName, EMode iMode);
+
+ /// Auto-closes the file, if open
+ ~cFile();
+
+ bool Open(const char * iFileName, EMode iMode);
+ void Close(void);
+ bool IsOpen(void) const;
+ bool IsEOF(void) const;
+
+ /// Reads up to iNumBytes bytes into iBuffer, returns the number of bytes actually read, or -1 on failure; asserts if not open
+ int Read (void * iBuffer, int iNumBytes);
+
+ /// Writes up to iNumBytes bytes from iBuffer, returns the number of bytes actually written, or -1 on failure; asserts if not open
+ int Write(const void * iBuffer, int iNumBytes);
+
+ /// Seeks to iPosition bytes from file start, returns old position or -1 for failure; asserts if not open
+ int Seek (int iPosition);
+
+ /// Returns the current position (bytes from file start) or -1 for failure; asserts if not open
+ int Tell (void) const;
+
+private:
+ #ifdef USE_STDIO_FILE
+ FILE * m_File;
+ #else
+ HANDLE m_File;
+ #endif
+} ;
+
+
+
+
+
+#endif // CFILE_H_INCLUDED
+
+
+
+
|