Changeset 8003 for trunk/tools/common/kFile.cpp

Timestamp:

Feb 24, 2002, 3:47:28 AM (24 years ago)

Author:

bird

Message:

New kFile* classes; now in sync with os2tools.

File:

• trunk/tools/common/kFile.cpp (modified) (60 diffs)

trunk/tools/common/kFile.cpp

@@ -1 @@
-/* $Id: kFile.cpp,v 1.9 2001-10-17 14:21:10 bird Exp $
+/* $Id: kFile.cpp,v 1.10 2002-02-24 02:47:24 bird Exp $
  *
  * kFile - Simple (for the time being) file class.
@@ -27 +27 @@
 #include <stdlib.h>
 
+#include "kTypes.h"
+#include "kError.h"
 #include "kFile.h"
 
@@ -43 +45 @@
  * @remark
  */
-BOOL    kFile::refreshFileStatus()
+KBOOL   kFile::refreshFileStatus()
 {
     if (fStdDev)
@@ -50 +52 @@
     if (!fStatusClean)
     {
-        rc = DosQueryFileInfo(hFile, FIL_QUERYEASIZE, &filestatus, sizeof(filestatus));
+        rc = DosQueryFileInfo(OSData.os2.hFile, FIL_QUERYEASIZE, &OSData.os2.filestatus, sizeof(OSData.os2.filestatus));
         fStatusClean = (rc == NO_ERROR);
         if (!fStatusClean && fThrowErrors)
-            throw ((int)rc);
+            throw (kError(rc));
     }
     else
@@ -66 +68 @@
  * @returns     Success indicator.
  */
-BOOL    kFile::position()
+KBOOL   kFile::position()
 {
     /*
@@ -75 +77 @@
     {
         ULONG   off;
-        rc = DosSetFilePtr(hFile, offVirtual, FILE_BEGIN, &off);
+        rc = DosSetFilePtr(OSData.os2.hFile, offVirtual, FILE_BEGIN, &off);
         if (rc != NO_ERROR || off != offVirtual)
         {
             if (fThrowErrors)
-                throw ((int)rc);
+                throw (kError(rc));
             return FALSE;
         }
@@ -99 +101 @@
  * @author  knut st. osmundsen (knut.stange.osmundsen@mynd.no)
  */
-BOOL kFile::bufferRead(ULONG offFile) throw (int)
+KBOOL kFile::bufferRead(unsigned long offFile) throw(kError)
 {
     ULONG   cbRead;
@@ -108 +110 @@
 
     /* check that the request is valid */
-    if (offFile > filestatus.cbFile)
+    if (offFile > OSData.os2.filestatus.cbFile)
         return FALSE;
 
@@ -123 +125 @@
 
     /* If readonly file optimize end of file */
-    if (fReadOnly && cbBuffer + offFile > filestatus.cbFile)
-        offFile = filestatus.cbFile > cbBuffer ? filestatus.cbFile - cbBuffer : 0UL;
+    if (fReadOnly && cbBuffer + offFile > OSData.os2.filestatus.cbFile)
+        offFile = OSData.os2.filestatus.cbFile > cbBuffer ? OSData.os2.filestatus.cbFile - cbBuffer : 0UL;
 
     /* need to change file ptr? */
@@ -130 +132 @@
     {
         ULONG ul;
-        rc = DosSetFilePtr(hFile, offFile, FILE_BEGIN, &ul);
+        rc = DosSetFilePtr(OSData.os2.hFile, offFile, FILE_BEGIN, &ul);
         if (rc != NO_ERROR)
         {
             if (fThrowErrors)
-                throw ((int)rc);
+                throw (kError(rc));
             return FALSE;
         }
@@ -141 +143 @@
 
     /* read from the file */
-    cbRead = min(filestatus.cbFile - offFile, cbBuffer);
-    rc = DosRead(hFile, pachBuffer, cbRead, &cbRead);
+    cbRead = KMIN(OSData.os2.filestatus.cbFile - offFile, cbBuffer);
+    rc = DosRead(OSData.os2.hFile, pachBuffer, cbRead, &cbRead);
     if (rc == NO_ERROR)
     {
@@ -156 +158 @@
         fBufferDirty    = FALSE;
         if (fThrowErrors)
-            throw ((int)rc);
+            throw (kError(rc));
         return FALSE;
     }
@@ -169 +171 @@
  * @author  knut st. osmundsen (knut.stange.osmundsen@mynd.no)
  */
-BOOL kFile::bufferCommit(void) throw (int)
+KBOOL kFile::bufferCommit(void) throw(kError)
 {
     ULONG   cbWrote;
@@ -181 +183 @@
     if (offBuffer != offReal)
     {
-        rc = DosSetFilePtr(hFile, offBuffer, FILE_BEGIN, &ul);
+        rc = DosSetFilePtr(OSData.os2.hFile, offBuffer, FILE_BEGIN, &ul);
         if (rc != NO_ERROR)
         {
             if (fThrowErrors)
-                throw ((int)rc);
+                throw (kError(rc));
             return FALSE;
         }
@@ -192 +194 @@
 
     /* write to the file */
-    rc = DosWrite(hFile, pachBuffer, cbBufferValid, &cbWrote);
+    rc = DosWrite(OSData.os2.hFile, pachBuffer, cbBufferValid, &cbWrote);
     fStatusClean = FALSE;
     if (rc == NO_ERROR)
@@ -201 +203 @@
     else
     {
-        DosSetFilePtr(hFile, offReal, FILE_BEGIN, &ul);
+        DosSetFilePtr(OSData.os2.hFile, offReal, FILE_BEGIN, &ul);
         if (fThrowErrors)
-            throw ((int)rc);
+            throw (kError(rc));
         return FALSE;
     }
@@ -222 +224 @@
  * @author      knut st. osmundsen (knut.stange.osmundsen@mynd.no)
  */
-kFile::kFile(HFILE hFile, BOOL fReadOnly)
+kFile::kFile(HFILE hFile, KBOOL fReadOnly)
 :   fReadOnly(fReadOnly),
     fStatusClean(FALSE),
@@ -229 +231 @@
     offReal(0),
     pszFilename(NULL),
-    hFile(hFile),
     fStdDev(TRUE),
     pachBuffer(NULL),
@@ -236 +237 @@
     fBufferDirty(FALSE)
 {
+    OSData.os2.hFile = hFile;
     if (!refreshFileStatus())
-        throw ((int)rc);
+        throw (kError(rc));
     this->pszFilename = strdup("");
 }
@@ -252 +254 @@
  * @author      knut st. osmundsen (knut.stange.osmundsen@mynd.no)
  */
-kFile::kFile(const char *pszFilename, BOOL fReadOnly/*=TRUE*/)
+kFile::kFile(const char *pszFilename, KBOOL fReadOnly/*=TRUE*/)
 :   fReadOnly(fReadOnly),
     fStatusClean(FALSE),
@@ -283 +285 @@
     }
 
-    rc = DosOpen((PCSZ)pszFilename, &hFile, &ulAction, 0, FILE_NORMAL,
+    rc = DosOpen((PCSZ)pszFilename, &OSData.os2.hFile, &ulAction, 0, FILE_NORMAL,
                  fulOpenFlags, fulOpenMode, NULL);
     if (rc != NO_ERROR)
-        throw ((int)rc);
+        throw (kError(rc));
 
     if (!refreshFileStatus())
-        throw ((int)rc);
+        throw (kError(rc));
 
     char szFullName[CCHMAXPATH];
@@ -299 +301 @@
 
     /* Buffering */
-    cbBuffer   = (fReadOnly && filestatus.cbFile < 32768) ? filestatus.cbFile : 8192;
+    cbBuffer   = (fReadOnly && OSData.os2.filestatus.cbFile < 32768) ? OSData.os2.filestatus.cbFile : 8192;
     pachBuffer = new char[cbBuffer];
     if (pachBuffer == NULL)
         throw (ERROR_NOT_ENOUGH_MEMORY);
-    if (fReadOnly && filestatus.cbFile < 32768)
+    if (fReadOnly && OSData.os2.filestatus.cbFile < 32768)
     {
         if (!bufferRead(0))
-            throw ((int)rc);
+            throw (kError(rc));
     }
 }
@@ -320 +322 @@
     if (pachBuffer)
         delete pachBuffer;
-    DosClose(hFile);
+    DosClose(OSData.os2.hFile);
 }
 
@@ -326 +328 @@
 /**
  * Reads <cbBuffer> bytes from the current file posistion into the buffer.
- * @returns     success indicator. (TRUE/FALSE)
+ * @returns     0 on success. kError error number.
  * @param       pvBuffer    Output buffer.
  * @param       cbBuffer    Amount of bytes to read.
  */
-BOOL            kFile::read(void *pvBuffer, long cbBuffer)
+int             kFile::read(void *pvBuffer, long cbBuffer)
 {
     ULONG   cbRead;
@@ -336 +338 @@
     /* Validate parameters */
     if (cbBuffer == 0)
-        return TRUE;
+        return NO_ERROR;
     if (cbBuffer < 0)
     {
         rc = ERROR_INVALID_PARAMETER;
         if (fThrowErrors)
-            throw ((int)rc);
-        return FALSE;
+            throw (kError(rc));
+        return rc;
     }
 
     /* refresh file status (cbFile) */
     if (!refreshFileStatus())
-        return FALSE;
+        return rc;
 
     /* check if valid request */
-    if (    offVirtual > filestatus.cbFile
-        ||  offVirtual + cbBuffer > filestatus.cbFile
+    if (    offVirtual > OSData.os2.filestatus.cbFile
+        ||  offVirtual + cbBuffer > OSData.os2.filestatus.cbFile
         )
     {   /* invalid request */
         rc = ERROR_NO_DATA;
     }
-    else if (this->cbBufferValid == filestatus.cbFile && offBuffer == 0)
+    else if (this->cbBufferValid == OSData.os2.filestatus.cbFile && offBuffer == 0)
     {
         /*
@@ -386 +388 @@
             {   /* copy data from buffer */
                 cbRead = cbBufferValid - offVirtual + offBuffer;
-                cbRead = min(cbRead, cbBuffer);
+                cbRead = KMIN(cbRead, cbBuffer);
                 memcpy(pvBuffer, &pachBuffer[offVirtual - offBuffer], (size_t)cbRead);
                 offVirtual += cbRead;
@@ -396 +398 @@
                 /* read into buffer */
                 if (!bufferRead(offVirtual))
-                    return FALSE;
+                    return rc;
             }
         }
@@ -406 +408 @@
          * unbuffered read.
          */
-        rc = DosRead(hFile, pvBuffer, cbBuffer, &cbRead);
+        rc = DosRead(OSData.os2.hFile, pvBuffer, cbBuffer, &cbRead);
         if (rc == NO_ERROR)
             offVirtual = offReal += cbRead;
@@ -412 +414 @@
 
     /* check for error and return accordingly */
-    if (rc)
-    {
-        if (fThrowErrors)
-            throw ((int)rc);
-        return FALSE;
-    }
-    return TRUE;
+    if (rc && fThrowErrors)
+        throw (kError(rc));
+    return rc;
 }
 
@@ -424 +422 @@
 /**
  * Reads <cbBuffer> bytes at file offset <off>.
- * @returns     success indicator. (TRUE/FALSE)
+ * @returns     0 on success. kError error number.
  * @param       pvBuffer    Output buffer.
  * @param       cbBuffer    Amount of bytes to read.
  * @param       off         Absolute file offset.
  */
-BOOL            kFile::readAt(void *pvBuffer, long cbBuffer, long off)
-{
-    return set(off) && read(pvBuffer, cbBuffer);
+int             kFile::readAt(void *pvBuffer, long cbBuffer, long off)
+{
+    if (set(off))
+        return rc;
+    read(pvBuffer, cbBuffer);
+    return rc;
 }
 
@@ -439 +440 @@
  * (The memory block has a '\0' at the end just in case you
  *  are using it as a long string.)
+ * Must call the static kFile::mapFree function to free the memory block.
  * @returns     Pointer to file in memory.
  */
-void *          kFile::readFile() throw(int)
+void *          kFile::mapFile() throw(kError)
 {
     void *pv;
@@ -450 +452 @@
     {
         if (fThrowErrors)
-            throw(ERROR_NOT_ENOUGH_MEMORY);
+            throw (kError(kError::NOT_ENOUGH_MEMORY));
         return NULL;
     }
 
     /* go the start of the file and read it. */
-    if (start() && read(pv, this->getSize()))
+    if (!start() && !read(pv, this->getSize()))
         return pv; // successfull exit!
 
@@ -467 +469 @@
  * Reads a single line from the file into the given buffer.
  * Newline is stripped!
- * @returns Success indicator.
+ * @returns 0 on success. kError error number.
  * @param   pszBuffer   Pointer to string buffer.
  *                      Will hold a zero-string upon successful return.
@@ -475 +477 @@
  * @author  knut st. osmundsen (knut.stange.osmundsen@mynd.no)
  */
-BOOL            kFile::readln(char *pszBuffer, long cchBuffer) throw (int)
+int             kFile::readln(char *pszBuffer, long cchBuffer) throw(kError)
 {
     long    cbRead;
@@ -481 +483 @@
     /* refresh file status (cbFile) */
     if (!refreshFileStatus())
-        return FALSE;
+        return rc;
 
     /*
@@ -488 +490 @@
      *      Loop buffer by buffer looking for a newline.
      */
-    cbRead = min(max((long)filestatus.cbFile - (long)offVirtual, 0), cchBuffer-1);
+    cbRead = KMIN(KMAX((long)OSData.os2.filestatus.cbFile - (long)offVirtual, 0), cchBuffer-1);
     if (cbRead == 0)
-        return FALSE;
+        return rc = ERROR_HANDLE_EOF;
 
     while (cbRead > 0)
@@ -502 +504 @@
         if (offVirtual >= offBuffer + cbBufferValid || offVirtual < offBuffer)
             if (!bufferRead(offVirtual))
-                return FALSE;
+                return rc;
 
         /* Scan buffer for new line */
@@ -542 +544 @@
             else
                 offVirtual++;
-            return TRUE;
-        }
-    }
-
-    return TRUE;
+            return NO_ERROR;
+        }
+    }
+
+    return NO_ERROR;
 }
 
@@ -552 +554 @@
 /**
  * Writes <cbBuffer> bytes to the file at the current file position.
- * @returns     success indicator. (TRUE/FALSE)
+ * @returns     0 on success. kError error number.
  * @param       pvBuffer    Output buffer.
  * @param       cbBuffer    Amount of bytes to write.
  */
-BOOL            kFile::write(const void *pv, long cb)
+int             kFile::write(const void *pv, long cb)
 {
     if (fReadOnly)
@@ -604 +606 @@
                     offVirtual += cb + cbAddPost;
                     fBufferDirty = TRUE;
-                    return TRUE;
+                    return NO_ERROR;
                 }
 
@@ -634 +636 @@
                 {   /* don't fit anywhere... */
                     if (!bufferCommit())
-                        return FALSE;
+                        return rc;
                     offBuffer = offVirtual;
                     cbWrite = cbBufferValid = cb > cbBuffer ? cbBuffer : cb;
@@ -648 +650 @@
             offVirtual += cbAddPost;
 
-            return TRUE;
+            return NO_ERROR;
         }
         else if (position())
@@ -654 +656 @@
             ULONG   cbWrote;
 
-            rc = DosWrite(hFile, (PVOID)pv, cb, &cbWrote);
+            rc = DosWrite(OSData.os2.hFile, (PVOID)pv, cb, &cbWrote);
             if (rc == NO_ERROR)
             {
                 offVirtual = offReal += cbWrote;
-                return TRUE;
+                return NO_ERROR;
             }
         }
@@ -664 +666 @@
 
     if (fThrowErrors)
-        throw ((int)rc);
-    return FALSE;
+        throw (kError(rc));
+    return rc;
 }
 
@@ -671 +673 @@
 /**
  * Write <cbBuffer> bytes at file offset <off> from <pvBuffer>.
- * @returns     success indicator. (TRUE/FALSE)
+ * @returns     0 on success. kError error number.
  * @param       pvBuffer    Output buffer.
  * @param       cbBuffer    Amount of bytes to write.
  * @param       off         Absolute file offset.
  */
-BOOL            kFile::writeAt(void *pvBuffer, long cbBuffer, long off)
-{
-    return set(off) && write(pvBuffer, cbBuffer);
+int             kFile::writeAt(const void *pvBuffer, long cbBuffer, long off)
+{
+    if (set(off))
+        return rc;
+    return write(pvBuffer, cbBuffer);
 }
 
@@ -693 +697 @@
  * @remark      Currently limited to 64KB of result data.
  */
-int             kFile::printf(const char *pszFormat, ...) throw (int)
+int             kFile::printf(const char *pszFormat, ...) throw(kError)
 {
     long        offStart = getPos();
@@ -725 +729 @@
 /**
  * Sets the filesize.
- * @returns     Success indicator.
+ * @returns     0 on success. kError error number.
  * @param       cbFile      New filesize.
  *                          Defaults to 0xffffffff, which results in
  *                          cutting the file at the current position.
  */
-BOOL            kFile::setSize(unsigned long cbFile/*= ~0UL*/)
+int             kFile::setSize(unsigned long cbFile/*= ~0UL*/)
 {
     if (cbFile == ~0UL)
         cbFile = offVirtual;
-    rc = DosSetFileSize(hFile, cbFile);
+    rc = DosSetFileSize(OSData.os2.hFile, cbFile);
     if (rc != NO_ERROR && fThrowErrors)
-        throw ((int)rc);
-
-    return rc == NO_ERROR;
+        throw (kError(rc));
+
+    return rc;
 }
 
@@ -752 +756 @@
     char *  pachBuffer  = new char[1024*256];
     long    pos         = AppendFile.getPos();
-    BOOL    fAppend     = AppendFile.fThrowErrors;
-    BOOL    fThis       = fThrowErrors;
+    KBOOL   fAppend     = AppendFile.fThrowErrors;
+    KBOOL   fThis       = fThrowErrors;
 
     setThrowOnErrors();
@@ -762 +766 @@
     AppendFile.refreshFileStatus();
 
-    cb = min(1024*256, AppendFile.filestatus.cbFile);
+    cb = KMIN(1024*256, AppendFile.OSData.os2.filestatus.cbFile);
     while (cb > 0)
     {
         AppendFile.read(pachBuffer, cb);
         write(pachBuffer, cb);
-        cb = min(1024*256, (long)AppendFile.filestatus.cbFile - (long)AppendFile.offVirtual);
+        cb = KMIN(1024*256, (long)AppendFile.OSData.os2.filestatus.cbFile - (long)AppendFile.offVirtual);
     }
 
@@ -781 +785 @@
 /**
  * Seek relative to the current position.
- * @returns     Success indicator.
+ * @returns     0 on success. kError error number.
  * @param       off     Relative reposition.
  */
-BOOL            kFile::move(long off)
+int             kFile::move(long off)
 {
     if ((off + offVirtual) & 0x80000000UL) /* above 2GB or negative */
@@ -790 +794 @@
     else
     {
-        if (off + offVirtual > filestatus.cbFile && fReadOnly) /* can't expand readonly file. */
+        if (off + offVirtual > OSData.os2.filestatus.cbFile && fReadOnly) /* can't expand readonly file. */
             rc = ERROR_HANDLE_EOF;
         else
         {
             offVirtual += off;
-            return TRUE;
+            return rc = NO_ERROR;
         }
     }
 
     if (fThrowErrors)
-        throw ((int)rc);
-    return FALSE;
+        throw (kError(rc));
+    return rc;
 }
 
@@ -807 +811 @@
 /**
  * Seek to an absolute position in the file (off).
- * @returns     Success indicator.
+ * @returns     0 on success. kError error number.
  * @param       off     New file position.
  */
-BOOL            kFile::set(long off)
+int             kFile::set(long off)
 {
     if (off < 0)
@@ -816 +820 @@
     else
     {
-        if ((unsigned long)off > filestatus.cbFile && fReadOnly)
+        if ((unsigned long)off > OSData.os2.filestatus.cbFile && fReadOnly)
             rc = ERROR_HANDLE_EOF;
         else
         {
             offVirtual = off;
-            rc = NO_ERROR;
-            return TRUE;
+            return rc = NO_ERROR;
         }
     }
     if (fThrowErrors)
-        throw ((int)rc);
-    return FALSE;
+        throw (kError(rc));
+    return rc;
 }
 
@@ -833 +836 @@
 /**
  * Seek to the end of the file.
- * @returns     Success indicator. TRUE / FALSE.
+ * @returns     0 on success. kError error number.
  * @remark      Will only throw error if refreshFileStatus failes.
  */
-BOOL            kFile::end()
+int             kFile::end()
 {
     if (!refreshFileStatus())
-        return FALSE;
-
-    if (!fReadOnly && pachBuffer && offBuffer != ~0UL && offBuffer + cbBufferValid > filestatus.cbFile)
+        return rc;
+
+    if (!fReadOnly && pachBuffer && offBuffer != ~0UL && offBuffer + cbBufferValid > OSData.os2.filestatus.cbFile)
         /* a writable file with buffer might have uncommited data in the buffer. */
         offVirtual = offBuffer + cbBufferValid;
     else
-        offVirtual = filestatus.cbFile;
-
-    rc = NO_ERROR;
-    return TRUE;
+        offVirtual = OSData.os2.filestatus.cbFile;
+
+    return rc = NO_ERROR;
 }
 
@@ -854 +856 @@
 /**
  * Seek to the start of the file.
- * @returns     TRUE.
+ * @returns     0 on success. kError error number.
  * @remark      Will never throw errors.
  */
-BOOL            kFile::start()
+int             kFile::start()
 {
     offVirtual = 0;
-    rc = NO_ERROR;
-    return TRUE;
+    return rc = NO_ERROR;
 }
 
@@ -876 +877 @@
         return -1;
 
-    return filestatus.cbFile;
+    return OSData.os2.filestatus.cbFile;
 }
 
@@ -897 +898 @@
  * @remark      Will only throw error if refreshFileStatus failes.
  */
-BOOL            kFile::isEOF()
+KBOOL           kFile::isEOF()
 {
     #if 0
-    throw(ERROR_NOT_SUPPORTED); //this method don't currently work! Need to use flag!
+    throw (kError(kError::NOT_SUPPORTED)); //this method don't currently work! Need to use flag!
     #else
     if (!fReadOnly && !refreshFileStatus())
-        return (BOOL)-1;
-
-    return filestatus.cbFile <= offVirtual; //??? - !!!
+        return (KBOOL)-1;
+
+    return OSData.os2.filestatus.cbFile <= offVirtual; //??? - !!!
     #endif
 }
@@ -913 +914 @@
  * Set error behaviour to fail by throwing the OS/2 return code when an
  * error occures.
- * @returns     TRUE;
  * @remark      Will never throw errors.
  */
-BOOL            kFile::setThrowOnErrors()
+void            kFile::setThrowOnErrors()
 {
     fThrowErrors = TRUE;
     rc = NO_ERROR;
-    return TRUE;
 }
 
@@ -926 +925 @@
 /**
  * Set error behaviour to fail by return FALSE when an error has occures.
- * @returns     TRUE;
  * @remark      Will never throw errors.
  */
-BOOL            kFile::setFailOnErrors()
+void            kFile::setFailOnErrors()
 {
     fThrowErrors = FALSE;
     rc = NO_ERROR;
-    return TRUE;
 }
 
@@ -957 +954 @@
  * @remark  May throw errors.
  */
-void *kFile::readFile(const char *pszFilename)
+void *kFile::mapFile(const char *pszFilename)
 {
     kFile file(pszFilename);
-    return file.readFile();
-}
-
+    file.setThrowOnErrors();
+    return file.mapFile();
+}
+
+
+
+/**
+ * Frees a file mapping done by one of the mapFile members of kFile.
+ * @param   pvFileMapping   The pointer mapFile returned.
+ * @author  knut st. osmundsen (knut.stange.osmundsen@mynd.no)
+ */
+void kFile::mapFree(void *pvFileMapping)
+{
+    if (pvFileMapping)
+        free(pvFileMapping);
+}
+