relicense to 0BSD

[pforth] / csrc / pf_io.h

diff --git a/csrc/pf_io.h b/csrc/pf_io.h
index 8af1667..56cc905 100644 (file)
--- a/csrc/pf_io.h
+++ b/csrc/pf_io.h
@@ -8,20 +8,28 @@
 ** Author: Phil Burk
 ** Copyright 1994 3DO, Phil Burk, Larry Polansky, David Rosenboom
 **
 ** Author: Phil Burk
 ** Copyright 1994 3DO, Phil Burk, Larry Polansky, David Rosenboom
 **

-** The pForth software code is dedicated to the public domain,
-** and any third party may reproduce, distribute and modify
-** the pForth software code or any derivative works thereof
-** without any compensation or license.  The pForth software
-** code is provided on an "as is" basis without any warranty
-** of any kind, including, without limitation, the implied
-** warranties of merchantability and fitness for a particular
-** purpose and their equivalents under the laws of any jurisdiction.
+** Permission to use, copy, modify, and/or distribute this
+** software for any purpose with or without fee is hereby granted.
+**
+** THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
+** WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
+** WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL
+** THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR
+** CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING
+** FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF
+** CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+** OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

 **
 ***************************************************************/
 
 **
 ***************************************************************/
 

+#include "pf_types.h"
+

 #define PF_CHAR_XON    (0x11)
 #define PF_CHAR_XOFF   (0x13)
 
 #define PF_CHAR_XON    (0x11)
 #define PF_CHAR_XOFF   (0x13)
 

+#ifdef __cplusplus
+extern "C" {
+#endif

 int  sdTerminalOut( char c );
 int  sdTerminalEcho( char c );
 int  sdTerminalFlush( void );
 int  sdTerminalOut( char c );
 int  sdTerminalEcho( char c );
 int  sdTerminalFlush( void );


@@ -29,11 +37,13 @@ int  sdTerminalIn( void );
 int  sdQueryTerminal( void );
 void sdTerminalInit( void );
 void sdTerminalTerm( void );
 int  sdQueryTerminal( void );
 void sdTerminalInit( void );
 void sdTerminalTerm( void );

+#ifdef __cplusplus
+}
+#endif

 
 void ioInit( void );
 void ioTerm( void );
 
 
 void ioInit( void );
 void ioTerm( void );
 

-

 #ifdef PF_NO_CHARIO
     void sdEnableInput( void );
     void sdDisableInput( void );
 #ifdef PF_NO_CHARIO
     void sdEnableInput( void );
     void sdDisableInput( void );


@@ -84,8 +94,11 @@ void ioTerm( void );
     cell_t sdFlushFile( FileStream * Stream  );
     cell_t sdReadFile( void *ptr, cell_t Size, int32_t nItems, FileStream * Stream  );
     cell_t sdWriteFile( void *ptr, cell_t Size, int32_t nItems, FileStream * Stream  );
     cell_t sdFlushFile( FileStream * Stream  );
     cell_t sdReadFile( void *ptr, cell_t Size, int32_t nItems, FileStream * Stream  );
     cell_t sdWriteFile( void *ptr, cell_t Size, int32_t nItems, FileStream * Stream  );

-    cell_t sdSeekFile( FileStream * Stream, off_t Position, int32_t Mode );
-    off_t sdTellFile( FileStream * Stream );
+    cell_t sdSeekFile( FileStream * Stream, file_offset_t Position, int32_t Mode );
+    cell_t sdRenameFile( const char *OldName, const char *NewName );
+    cell_t sdDeleteFile( const char *FileName );
+    ThrowCode sdResizeFile( FileStream *, uint64_t Size);
+    file_offset_t sdTellFile( FileStream * Stream );

     cell_t sdCloseFile( FileStream * Stream );
     cell_t sdInputChar( FileStream *stream );
 
     cell_t sdCloseFile( FileStream * Stream );
     cell_t sdInputChar( FileStream *stream );
 


@@ -114,19 +127,24 @@ void ioTerm( void );
         typedef FILE FileStream;
 
         #define sdOpenFile      fopen
         typedef FILE FileStream;
 
         #define sdOpenFile      fopen

-        #define sdDeleteFile      remove
+        #define sdDeleteFile    remove

         #define sdFlushFile     fflush
         #define sdReadFile      fread
         #define sdWriteFile     fwrite
         #define sdFlushFile     fflush
         #define sdReadFile      fread
         #define sdWriteFile     fwrite

-        #if defined(WIN32) || defined(__NT__) || defined(AMIGA)
-            /* TODO To support 64-bit file offset we probably need fseeki64(). */
-            #define sdSeekFile      fseek
-            #define sdTellFile      ftell
-        #else
-            #define sdSeekFile      fseeko
-            #define sdTellFile      ftello
-        #endif
+
+        /*
+         * Note that fseek() and ftell() only support a long file offset.
+         * So 64-bit offsets may not be supported on some platforms.
+         * At one point we supported fseeko() and ftello() but they require
+         * the off_t data type, which is not very portable.
+         * So we decided to sacrifice vary large file support in
+         * favor of portability.
+         */
+        #define sdSeekFile      fseek
+        #define sdTellFile      ftell
+

         #define sdCloseFile     fclose
         #define sdCloseFile     fclose

+        #define sdRenameFile    rename

         #define sdInputChar     fgetc
 
         #define PF_STDIN  ((FileStream *) stdin)
         #define sdInputChar     fgetc
 
         #define PF_STDIN  ((FileStream *) stdin)


@@ -136,6 +154,9 @@ void ioTerm( void );
         #define  PF_SEEK_CUR   (SEEK_CUR)
         #define  PF_SEEK_END   (SEEK_END)
 
         #define  PF_SEEK_CUR   (SEEK_CUR)
         #define  PF_SEEK_END   (SEEK_END)
 

+        /* TODO review the Size data type. */
+        ThrowCode sdResizeFile( FileStream *, uint64_t Size);
+

         /*
         ** printf() is only used for debugging purposes.
         ** It is not required for normal operation.
         /*
         ** printf() is only used for debugging purposes.
         ** It is not required for normal operation.