feat(file): Implement character read and write functions for LocalFile (#1431)

Author: Mauller

Core/GameEngine/Include/Common/LocalFile.h

@@ -99,9 +99,13 @@ class LocalFile : public File
 		virtual Bool	open( const Char *filename, Int access = NONE, size_t bufferSize = BUFFERSIZE ); ///< Open a file for access
 		virtual void	close( void );																			///< Close the file
 		virtual Int		read( void *buffer, Int bytes );										///< Read the specified number of bytes in to buffer: See File::read
+		virtual Int		readChar();																///< Read a character from the file
+		virtual Int		readWideChar();															///< Read a wide character from the file
 		virtual Int		write( const void *buffer, Int bytes );							///< Write the specified number of bytes from the buffer: See File::write
 		virtual Int		writeFormat( const Char* format, ... );							///< Write an unterminated formatted string to the file
 		virtual Int		writeFormat( const WideChar* format, ... );						///< Write an unterminated formatted string to the file
+		virtual Int		writeChar( const Char* character );								///< Write a character to the file
+		virtual Int		writeChar( const WideChar* character );							///< Write a wide character to the file
 		virtual Int		seek( Int new_pos, seekMode mode = CURRENT );				///< Set file position: See File::seek
 		virtual Bool	flush();													///< flush data to disk
 		virtual void	nextLine(Char *buf = NULL, Int bufSize = 0);				///< moves file position to after the next new-line

Core/GameEngine/Include/Common/RAMFile.h

@@ -90,9 +90,13 @@ class RAMFile : public File
 		virtual Bool	open( const Char *filename, Int access = NONE, size_t bufferSize = 0 ); ///< Open a file for access
 		virtual void	close( void );																			///< Close the file
 		virtual Int		read( void *buffer, Int bytes );										///< Read the specified number of bytes in to buffer: See File::read
+		virtual Int		readChar();																///< Read a character from the file
+		virtual Int		readWideChar();															///< Read a wide character from the file
 		virtual Int		write( const void *buffer, Int bytes );							///< Write the specified number of bytes from the buffer: See File::write
 		virtual Int		writeFormat( const Char* format, ... );							///< Write the formatted string to the file
 		virtual Int		writeFormat( const WideChar* format, ... );						///< Write the formatted string to the file
+		virtual Int		writeChar( const Char* character );								///< Write a character to the file
+		virtual Int		writeChar( const WideChar* character );							///< Write a wide character to the file
 		virtual Int		seek( Int new_pos, seekMode mode = CURRENT );				///< Set file position: See File::seek
 		virtual Bool	flush();													///< flush data to disk
 		virtual void	nextLine(Char *buf = NULL, Int bufSize = 0);				///< moves current position to after the next new-line

Core/GameEngine/Include/Common/file.h

@@ -149,6 +149,14 @@ class File : public MemoryPoolObject
 																																			  *  memory pointed at by buffer. Returns the number of bytes read.
 																																			  *  Returns -1 if an error occurred.
 																																			  */
+		virtual Int		readChar() = 0 ;											/**< Read a character from the file
+																																			  *  Returns the character converted to an integer.
+																																			  *  Returns EOF if an error occurred.
+																																			  */
+		virtual Int		readWideChar() = 0 ;										/**< Read a wide character from the file
+																																			  *  Returns the wide character converted to an integer.
+																																			  *  Returns wide EOF if an error occurred.
+																																			  */
 		virtual Int		write( const void *buffer, Int bytes ) = 0 ;						/**< Write the specified number of bytes from the
 																																			  *	 memory pointed at by buffer to the file. Returns the number of bytes written.
 																																			  *	 Returns -1 if an error occurred.
@@ -161,6 +169,14 @@ class File : public MemoryPoolObject
 																																			  *	 Returns the number of bytes written.
 																																			  *	 Returns -1 if an error occurred.
 																																			  */
+		virtual Int		writeChar( const Char* character ) = 0 ;						/**< Write a character to the file
+																																			  *	 Returns a copy of the character written.
+																																			  *	 Returns EOF if an error occurred.
+																																			  */
+		virtual Int		writeChar( const WideChar* character ) = 0 ;						/**< Write a wide character to the file
+																																			  *	 Returns a copy of the wide character written.
+																																			  *	 Returns wide EOF if an error occurred.
+																																			  */
 		virtual Int		seek( Int bytes, seekMode mode = CURRENT ) = 0;	/**< Sets the file position of the next read/write operation. Returns the new file
 																																				*  position as the number of bytes from the start of the file.
 																																				*  Returns -1 if an error occurred.

Core/GameEngine/Source/Common/System/LocalFile.cpp

@@ -360,6 +360,38 @@ Int LocalFile::read( void *buffer, Int bytes )
 	return ret;
 }
 
+//=================================================================
+// LocalFile::readChar
+//=================================================================
+
+Int LocalFile::readChar( )
+{
+	Char character = '\0';
+
+	Int ret = read( &character, sizeof(character) );
+
+	if (ret == sizeof(character))
+		return (Int)character;
+
+	return EOF;
+}
+
+//=================================================================
+// LocalFile::readWideChar
+//=================================================================
+
+Int LocalFile::readWideChar( )
+{
+	WideChar character = L'\0';
+
+	Int ret = read( &character, sizeof(character) );
+
+	if (ret == sizeof(character))
+		return (Int)character;
+
+	return WEOF;
+}
+
 //=================================================================
 // LocalFile::write
 //=================================================================
@@ -412,6 +444,32 @@ Int LocalFile::writeFormat( const WideChar* format, ... )
 	return write( buffer, length * sizeof(WideChar) );
 }
 
+//=================================================================
+// LocalFile::writeChar - Ascii
+//=================================================================
+
+Int LocalFile::writeChar( const Char* character )
+{
+	if ( write( character, sizeof(Char) ) == sizeof(Char) ) {
+		return (Int)character;
+	}
+
+	return EOF;
+}
+
+//=================================================================
+// LocalFile::writeChar - Wide character
+//=================================================================
+
+Int LocalFile::writeChar( const WideChar* character )
+{
+	if ( write( character, sizeof(WideChar) ) == sizeof(WideChar) ) {
+		return (Int)character;
+	}
+
+	return WEOF;
+}
+
 //=================================================================
 // LocalFile::seek
 //=================================================================

Core/GameEngine/Source/Common/System/RAMFile.cpp

@@ -285,6 +285,24 @@ Int RAMFile::read( void *buffer, Int bytes )
 	return bytes;
 }
 
+//=================================================================
+// RAMFile::readChar
+//=================================================================
+
+Int RAMFile::readChar( )
+{
+	return EOF;
+}
+
+//=================================================================
+// RAMFile::readWideChar
+//=================================================================
+
+Int RAMFile::readWideChar( )
+{
+	return WEOF;
+}
+
 //=================================================================
 // RAMFile::write
 //=================================================================
@@ -312,6 +330,24 @@ Int RAMFile::writeFormat( const WideChar* format, ... )
 	return -1;
 }
 
+//=================================================================
+// RAMFile::writeChar - Ascii
+//=================================================================
+
+Int RAMFile::writeChar( const Char* character )
+{
+	return EOF;
+}
+
+//=================================================================
+// RAMFile::writeChar - Wide character
+//=================================================================
+
+Int RAMFile::writeChar( const WideChar* character )
+{
+	return WEOF;
+}
+
 //=================================================================
 // RAMFile::seek
 //=================================================================