Files
harbour-core/contrib/hbcomm/comm.prg
Viktor Szakats 9f16c2bf8e 2017-08-13 18:27 UTC Viktor Szakats (vszakats users.noreply.github.com)
* *
    * update copyright headers with new FSF postal address
    * COPYING.txt -> LICENSE.txt (rest of repo to be synced)
2017-08-13 18:38:59 +00:00

174 lines
5.1 KiB
Plaintext

/*
* HBCOMM compatibility library. EXPERIMENTAL CODE. USE AT YOUR OWN RISK. NO GUARANTEES.
*
* Copyright 2010 Viktor Szakats (vszakats.net/harbour)
*
* 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 "hbcom.ch"
STATIC s_hPort := { => }
STATIC s_hbcomm_mutex := hb_mutexCreate()
FUNCTION INIT_PORT( cPort, nBaud, nData, nParity, nStop, nBufferSize )
LOCAL nPort
LOCAL cOldPortName
LOCAL cParity
hb_mutexLock( s_hbcomm_mutex )
/* TOFIX: We should get that number from core to avoid
getting mixed up with com port access outside this
compatibility interface. [vszakats] */
nPort := Len( s_hPort ) + 1
IF HB_ISSTRING( cPort )
cOldPortName := hb_comGetDevice( nPort )
hb_comSetDevice( nPort, cPort )
ENDIF
hb_comClose( nPort )
IF hb_comOpen( nPort )
hb_default( @nBaud, 9600 )
cParity := "N"
IF HB_ISNUMERIC( nParity )
SWITCH nParity
CASE 0 ; cParity := "N" ; EXIT
CASE 1 ; cParity := "O" ; EXIT
CASE 2 ; cParity := "M" ; EXIT
CASE 3 ; cParity := "E" ; EXIT
ENDSWITCH
ENDIF
hb_default( @nStop, 1 )
HB_SYMBOL_UNUSED( nBufferSize )
IF hb_comInit( nPort, nBaud, cParity, nData, nStop )
s_hPort[ nPort ] := cOldPortName
hb_mutexUnlock( s_hbcomm_mutex )
RETURN nPort
ELSE
hb_comClose( nPort )
ENDIF
ENDIF
IF cOldPortName != NIL
hb_comSetDevice( nPort, cOldPortName )
ENDIF
hb_mutexUnlock( s_hbcomm_mutex )
RETURN 0
/* Purge output buffer */
FUNCTION OUTBUFCLR( nPort )
RETURN hb_comFlush( nPort, HB_COM_OFLUSH )
/* See if port is opened correctly */
FUNCTION ISWORKING( nPort )
RETURN nPort $ s_hPort
/* NOTE: INCOMPATIBILITY.
In contratry to original HBCOMM, here <cData> must be passed by reference.
HBCOMM could corrupt HVM because of its buggy way of returning data.
[vszakats] */
/* Fetch <nCount> chars into <cData> */
FUNCTION INCHR( nPort, nCount, /* @ */ cData )
cData := iif( HB_ISNUMERIC( nCount ), Space( nCount ), "" )
RETURN hb_comRecv( nPort, @cData, nCount )
/* Send out characters. Returns .T. if successful. */
FUNCTION OUTCHR( nPort, cData )
LOCAL nLen
DO WHILE hb_BLen( cData ) > 0
/* I expect at least some data to be sent in a second */
nLen := hb_comSend( nPort, cData,, 1000 )
IF nLen <= 0
RETURN .F.
ENDIF
cData := hb_BSubStr( cData, nLen + 1 )
ENDDO
RETURN .T.
/* Find out how many chars are in input buffer */
FUNCTION INBUFSIZE( nPort )
RETURN hb_comInputCount( nPort )
/* Find out how many characters are in output buffer */
FUNCTION OUTBUFSIZE( nPort )
RETURN hb_comOutputCount( nPort )
/* Close port and clear handle */
FUNCTION UNINT_PORT( nPort )
LOCAL lRetVal := .F.
hb_mutexLock( s_hbcomm_mutex )
IF nPort $ s_hPort
IF hb_comClose( nPort )
/* Restore com port name */
IF s_hPort[ nPort ] != NIL
hb_comSetDevice( nPort, s_hPort[ nPort ] )
ENDIF
hb_HDel( s_hPort, nPort )
lRetVal := .T.
ENDIF
ENDIF
hb_mutexUnlock( s_hbcomm_mutex )
RETURN lRetVal