Files
harbour-core/contrib/xhb/stream.prg
Viktor Szakats 5a2a287752 2017-09-08 16:00 UTC Viktor Szakats (vszakats users.noreply.github.com)
* *
    * partial sync with the 3.4 fork codebase. These are the things
      synces for the most part:
      - copyright headers
      - grammar/typos in comments and some readmes
      - comment/whitespace/decorations
      - variable scoping in C files
      - DO CASE/SWITCH and some other alternate syntax usage
      - minimal amount of human readable text in strings
      - minor code updates
      - HB_TRACE() void * casts for pointers and few other changes to
        avoid C compiler warnings
      - various other, minor code cleanups
      - only Harbour/C code/headers were touched in src, utils, contrib,
        include. No 3rd party code, no make files, and with just a few
        exceptions, no 'tests' code was touched.
      - certain components were not touched were 3.4 diverged too much
        already, like f.e. hbmk2, hbssl, hbcurl, hbexpat
      - the goal was that no actual program logic should be altered by
        these changes. Except some possible minor exceptions, any such
        change is probably a bug in this patch.
      It's a massive patch, if you find anything broken after it, please
      open an Issue with the details. Build test was done on macOS.
      The goal is make it easier to see what actual code/logic was changed
      in 3.4 compared to 3.2 and to make patches easier to apply in both
      ways.
2017-09-08 16:25:13 +00:00

273 lines
7.0 KiB
Plaintext

/*
* xHarbour stream classes
*
* Copyright 2009 {list of individual authors and e-mail addresses}
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2, or (at your option)
* any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; see the file LICENSE.txt. If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301 USA (or visit https://www.gnu.org/licenses/).
*
* As a special exception, the Harbour Project gives permission for
* additional uses of the text contained in its release of Harbour.
*
* The exception is that, if you link the Harbour libraries with other
* files to produce an executable, this does not by itself cause the
* resulting executable to be covered by the GNU General Public License.
* Your use of that executable is in no way restricted on account of
* linking the Harbour library code into it.
*
* This exception does not however invalidate any other reasons why
* the executable file might be covered by the GNU General Public License.
*
* This exception applies only to the code released by the Harbour
* Project under the name Harbour. If you copy code from other
* Harbour Project or Free Software Foundation releases into a copy of
* Harbour, as the General Public License permits, the exception does
* not apply to the code that you add in this way. To avoid misleading
* anyone as to the status of such modified files, you must delete
* this exception notice from them.
*
* If you write modifications of your own for Harbour, it is your choice
* whether to permit this exception to apply to your modifications.
* If you do not wish that, delete this exception notice.
*
*/
#include "hbclass.ch"
#include "fileio.ch"
#xtranslate Throw( <oErr> ) => ( Eval( ErrorBlock(), <oErr> ), Break( <oErr> ) )
#define BUFFER_SIZE 16384
FUNCTION FileReader( cFile, nMode )
RETURN TStreamFileReader():New( cFile, nMode )
FUNCTION FileWriter( cFile, nMode )
RETURN TStreamFileWriter():New( cFile, nMode )
CREATE CLASS TStream
VAR lCanRead INIT .F.
VAR lCanWrite INIT .F.
VAR lCanSeek INIT .F.
VAR nLength INIT 0
VAR nPosition INIT 0
#if 0
METHOD BeginRead( sBuffer, nOffset, nCount, bCallback, oState )
METHOD EndRead( oAsync ) VIRTUAL
METHOD BeginWrite( sBuffer, nOffset, nCount, bCallback, oState )
METHOD EndWrite( oAsync ) VIRTUAL
#endif
METHOD Close() VIRTUAL
METHOD Flush() VIRTUAL
METHOD Seek( nOffset, Origin ) VIRTUAL
METHOD Read( sBuffer, nOffset, nCount ) VIRTUAL
METHOD ReadByte() VIRTUAL
METHOD Write( sBuffer, nOffset, nCount ) VIRTUAL
METHOD WriteByte() VIRTUAL
METHOD CopyTo( oTargetStream )
ENDCLASS
METHOD PROCEDURE CopyTo( oTargetStream ) CLASS TStream
LOCAL nBytesToRead := ::nLength
LOCAL sBuffer := Space( BUFFER_SIZE )
LOCAL nRead
LOCAL nPosition
IF ! oTargetStream:lCanWrite
Throw( xhb_ErrorNew( "Stream", 0, 1001, ProcName(), "Target not writable.", hb_AParams() ) )
ENDIF
// Save.
nPosition := ::nPosition
::Seek( 0, FS_SET )
oTargetStream:Seek( 0, FS_SET )
DO WHILE nBytesToRead > 0
nRead := ::Read( @sBuffer, 0, BUFFER_SIZE )
oTargetStream:Write( sBuffer, 0, nRead )
nBytesToRead -= nRead
ENDDO
// Truncate incase it was a bigger file.
oTargetStream:Write( "", 0, 0 )
// Restore.
::Seek( nPosition, FS_SET )
RETURN
CREATE CLASS TStreamFileReader FROM TStream
VAR cFile
VAR Handle
METHOD New( cFile, nMode ) CONSTRUCTOR
METHOD Close() INLINE iif( ::Handle > 0, FClose( ::Handle ), ), ::Handle := -2
METHOD Seek( nOffset Origin ) INLINE FSeek( ::Handle, nOffset, Origin )
METHOD Read( sBuffer, nOffset, nCount )
METHOD ReadByte()
DESTRUCTOR Finalize
ENDCLASS
METHOD New( cFile, nMode ) CLASS TStreamFileReader
::lCanRead := .T.
::cFile := cFile
IF nMode == NIL
nMode := 2
ENDIF
::Handle := FOpen( cFile, nMode )
IF ::Handle == F_ERROR
Throw( xhb_ErrorNew( "Stream", 0, 1004, ProcName(), "Open Error: " + Str( FError() ), hb_AParams() ) )
ENDIF
::nPosition := 0
::nLength := FSeek( ::Handle, 0, FS_END )
FSeek( ::Handle, 0, FS_SET )
RETURN Self
METHOD PROCEDURE Finalize CLASS TStreamFileReader
::Close()
RETURN
METHOD Read( sBuffer, nOffset, nCount ) CLASS TStreamFileReader
LOCAL nRead
/*
IF ! HB_ISBYREF( @sBuffer )
Throw( xhb_ErrorNew( "Stream", 0, 1002, ProcName(), "Buffer not BYREF.", hb_AParams() ) )
ENDIF
*/
nRead := FRead( ::Handle, @sBuffer, nCount, nOffset )
::nPosition += nRead
RETURN nRead
METHOD ReadByte() CLASS TStreamFileReader
LOCAL sBuffer := " "
IF FRead( ::Handle, @sBuffer, 1 ) == 1
::nPosition++
RETURN sBuffer
ENDIF
RETURN ""
CREATE CLASS TStreamFileWriter FROM TStream
VAR cFile
VAR Handle
METHOD New( cFile, nMode ) CONSTRUCTOR
METHOD Close() INLINE iif( ::Handle > 0, FClose( ::Handle ), ), ::Handle := -2
METHOD Seek( nOffset Origin ) INLINE ::nPosition := FSeek( ::Handle, nOffset, Origin )
METHOD Write( sBuffer, nOffset, nCount )
METHOD WriteByte( cByte )
DESTRUCTOR Finalize
ENDCLASS
METHOD New( cFile, nMode ) CLASS TStreamFileWriter
::lCanWrite := .T.
::cFile := cFile
IF hb_FileExists( cFile )
__defaultNIL( @nMode, FO_READWRITE )
::Handle := FOpen( cFile, nMode )
IF ::Handle == F_ERROR
Throw( xhb_ErrorNew( "Stream", 0, 1004, ProcName(), "Open Error: " + Str( FError() ), hb_AParams() ) )
ENDIF
::nLength := FSeek( ::Handle, 0, FS_END )
::nPosition := ::nLength
ELSE
__defaultNIL( @nMode, FC_NORMAL )
::Handle := FCreate( cFile, nMode )
IF ::Handle == F_ERROR
Throw( xhb_ErrorNew( "Stream", 0, 1004, ProcName(), "Create Error: " + Str( FError() ), hb_AParams() ) )
ENDIF
::nPosition := 0
::nLength := 0
ENDIF
RETURN Self
METHOD PROCEDURE Finalize CLASS TStreamFileWriter
::Close()
RETURN
METHOD Write( sBuffer, nOffset, nCount ) CLASS TStreamFileWriter
LOCAL nWritten
nWritten := FWrite( ::Handle, sBuffer, nCount, nOffset )
::nPosition += nWritten
IF nWritten != nCount
Throw( xhb_ErrorNew( "Stream", 0, 1003, ProcName(), "Write failed - written:" + Str( nWritten ) + " bytes", hb_AParams() ) )
ENDIF
RETURN nWritten
METHOD PROCEDURE WriteByte( cByte ) CLASS TStreamFileWriter
LOCAL nWritten := FWrite( ::Handle, cByte, 1 )
::nPosition += nWritten
IF nWritten != 1
Throw( xhb_ErrorNew( "Stream", 0, 1006, ProcName(), "Write failed", hb_AParams() ) )
ENDIF
RETURN