/* * $Id$ */ /* * Harbour Project source code: * The Console API * * Copyright 1999 Antonio Linares * www - http://www.harbour-project.org * * 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 software; see the file COPYING. If not, write to * the Free Software Foundation, Inc., 59 Temple Place, Suite 330, * Boston, MA 02111-1307 USA (or visit the web site http://www.gnu.org/). * * 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. * */ /* * The following parts are Copyright of the individual authors. * www - http://www.harbour-project.org * * Copyright 1999 David G. Holm * hb_conOutAlt(), hb_conOutDev(), DEVOUT(), hb_conDevPos(), * DEVPOS(), __EJECT(), * hb_conOut(), hb_conOutErr(), OUTERR(), * hb_conOutStd(), OUTSTD(), PCOL(), PROW(), * SETPRC(), and hb_conInit() * * Copyright 1999-2001 Viktor Szakats * hb_conNewLine() * DISPOUTAT() * * See doc/license.txt for licensing terms. * */ #define HB_OS_WIN_32_USED #include "hbapi.h" #include "hbapiitm.h" #include "hbapifs.h" #include "hbapierr.h" #include "hbapigt.h" #include "hbstack.h" #include "hbset.h" #include "hb_io.h" /* NOTE: Some C compilers like BCC32 optimize the call of small static buffers * into an integer to read it faster. Later, programs like CodeGuard * complain if the given buffer was smaller than an int. [ckedem] */ /* length of buffer for CR/LF characters */ #if !defined(HB_OS_EOL_LEN) || HB_OS_EOL_LEN < 4 # define CRLF_BUFFER_LEN 4 #else # define CRLF_BUFFER_LEN HB_OS_EOL_LEN + 1 #endif #if defined(HB_OS_UNIX_COMPATIBLE) && !defined(HB_EOL_CRLF) static const char s_szCrLf[ CRLF_BUFFER_LEN ] = { HB_CHAR_LF, 0 }; static const int s_iCrLfLen = 1; #else static const char s_szCrLf[ CRLF_BUFFER_LEN ] = { HB_CHAR_CR, HB_CHAR_LF, 0 }; static const int s_iCrLfLen = 2; #endif static HB_FHANDLE s_hFilenoStdin = ( HB_FHANDLE ) HB_STDIN_HANDLE; static HB_FHANDLE s_hFilenoStdout = ( HB_FHANDLE ) HB_STDOUT_HANDLE; static HB_FHANDLE s_hFilenoStderr = ( HB_FHANDLE ) HB_STDERR_HANDLE; typedef struct { USHORT row; USHORT col; } HB_PRNPOS, * PHB_PRNPOS; static HB_TSD_NEW( s_prnPos, sizeof( HB_PRNPOS ), NULL, NULL ); static PHB_PRNPOS hb_prnPos( void ) { return ( PHB_PRNPOS ) hb_stackGetTSD( &s_prnPos ); } void hb_conInit( void ) { HB_TRACE(HB_TR_DEBUG, ("hb_conInit()")); #if !defined( HB_IO_WIN ) /* when HB_IO_WIN is set file handles with numbers 0, 1, 2 are transalted inside filesys to: GetStdHandle( STD_INPUT_HANDLE ), GetStdHandle( STD_OUTPUT_HANDLE ), GetStdHandle( STD_ERROR_HANDLE ) */ s_hFilenoStdin = fileno( stdin ); s_hFilenoStdout = fileno( stdout ); s_hFilenoStderr = fileno( stderr ); #endif #ifdef HB_C52_UNDOC { /* Undocumented CA-Cl*pper switch //STDERR:x */ int iStderr = hb_cmdargNum( "STDERR" ); if( iStderr == 0 || iStderr == 1 ) /* //STDERR with no parameter or 0 */ s_hFilenoStderr = s_hFilenoStdout; /* disabled in default builds. It's not multiplatform and very * dangerous because it can redirect error messages to data files * [druzus] */ #ifdef HB_C52_STRICT else if( iStderr > 0 ) /* //STDERR:x */ s_hFilenoStderr = ( HB_FHANDLE ) iStderr; #endif } #endif /* * Some compilers open stdout and stderr in text mode, but * Harbour needs them to be open in binary mode. */ hb_fsSetDevMode( s_hFilenoStdout, FD_BINARY ); hb_fsSetDevMode( s_hFilenoStderr, FD_BINARY ); if( hb_gtInit( s_hFilenoStdin, s_hFilenoStdout, s_hFilenoStderr ) != SUCCESS ) hb_errInternal( 9998, "Screen driver initialization failure", NULL, NULL ); if( hb_cmdargCheck( "INFO" ) ) { hb_conOutErr( hb_gtVersion( 1 ), 0 ); hb_conOutErr( hb_conNewLine(), 0 ); } } void hb_conRelease( void ) { HB_TRACE(HB_TR_DEBUG, ("hb_conRelease()")); /* * Clipper does not restore screen size on exit so I removed the code with: * hb_gtSetMode( s_originalMaxRow + 1, s_originalMaxCol + 1 ); * If the low level GT drive change some video adapter parameters which * have to be restored on exit then it should does it in its Exit() * method. Here we cannot force any actions because it may cause bad * results in some GTs, f.e. when the screen size is controlled by remote * user and not Harbour application (some terminal modes), [Druzus] */ hb_gtExit(); hb_fsSetDevMode( s_hFilenoStdout, FD_TEXT ); hb_fsSetDevMode( s_hFilenoStderr, FD_TEXT ); } char * hb_conNewLine( void ) { HB_TRACE(HB_TR_DEBUG, ("hb_conNewLine()")); return ( char * ) s_szCrLf; } HB_FUNC( HB_OSNEWLINE ) { hb_retc_const( s_szCrLf ); } /* Output an item to STDOUT */ void hb_conOutStd( const char * pStr, ULONG ulLen ) { HB_TRACE(HB_TR_DEBUG, ("hb_conOutStd(%s, %lu)", pStr, ulLen)); if( ulLen == 0 ) ulLen = strlen( pStr ); if( ulLen > 0 ) hb_gtOutStd( ( BYTE * ) pStr, ulLen ); } /* Output an item to STDERR */ void hb_conOutErr( const char * pStr, ULONG ulLen ) { HB_TRACE(HB_TR_DEBUG, ("hb_conOutErr(%s, %lu)", pStr, ulLen)); if( ulLen == 0 ) ulLen = strlen( pStr ); if( ulLen > 0 ) hb_gtOutErr( ( BYTE * ) pStr, ulLen ); } /* Output an item to the screen and/or printer and/or alternate */ void hb_conOutAlt( const char * pStr, ULONG ulLen ) { HB_TRACE(HB_TR_DEBUG, ("hb_conOutAlt(%s, %lu)", pStr, ulLen)); if( hb_setGetConsole() ) hb_gtWriteCon( ( BYTE * ) pStr, ulLen ); if( hb_setGetAlternate() && hb_setGetAltHan() != FS_ERROR ) { /* Print to alternate file if SET ALTERNATE ON and valid alternate file */ hb_fsWriteLarge( hb_setGetAltHan(), ( BYTE * ) pStr, ulLen ); } if( hb_setGetExtraHan() != FS_ERROR ) { /* Print to extra file if valid alternate file */ hb_fsWriteLarge( hb_setGetExtraHan(), ( BYTE * ) pStr, ulLen ); } if( hb_setGetPrinter() && hb_setGetPrintHan() != FS_ERROR ) { /* Print to printer if SET PRINTER ON and valid printer file */ hb_fsWriteLarge( hb_setGetPrintHan(), ( BYTE * ) pStr, ulLen ); hb_prnPos()->col += ( USHORT ) ulLen; } } /* Output an item to the screen and/or printer */ static void hb_conOutDev( const char * pStr, ULONG ulLen ) { HB_TRACE(HB_TR_DEBUG, ("hb_conOutDev(%s, %lu)", pStr, ulLen)); if( hb_setGetPrintHan() != FS_ERROR && hb_stricmp( hb_setGetDevice(), "PRINTER" ) == 0 ) { /* Display to printer if SET DEVICE TO PRINTER and valid printer file */ hb_fsWriteLarge( hb_setGetPrintHan(), ( BYTE * ) pStr, ulLen ); hb_prnPos()->col += ( USHORT ) ulLen; } else /* Otherwise, display to console */ hb_gtWrite( ( BYTE * ) pStr, ulLen ); } typedef void hb_out_func_typedef( const char *, ULONG ); static char * hb_itemStringCon( PHB_ITEM pItem, ULONG * pulLen, BOOL * pfFreeReq ) { /* logical values in device output (not console, stdout or stderr) are shown as single letter */ if( HB_IS_LOGICAL( pItem ) ) { *pulLen = 1; *pfFreeReq = FALSE; return ( char * ) ( hb_itemGetL( pItem ) ? "T" : "F" ); } return hb_itemString( pItem, pulLen, pfFreeReq ); } /* Format items for output, then call specified output function */ static void hb_conOut( USHORT uiParam, hb_out_func_typedef * pOutFunc ) { char * pszString; ULONG ulLen; BOOL bFreeReq; PHB_ITEM pItem; HB_TRACE(HB_TR_DEBUG, ("hb_conOut(%hu, %p)", uiParam, pOutFunc)); pItem = hb_param( uiParam, HB_IT_ANY ); if( pOutFunc == hb_conOutDev ) pszString = hb_itemStringCon( pItem, &ulLen, &bFreeReq ); else pszString = hb_itemString( pItem, &ulLen, &bFreeReq ); if( ulLen ) pOutFunc( pszString, ulLen ); if( bFreeReq ) hb_xfree( pszString ); } HB_FUNC( OUTSTD ) /* writes a list of values to the standard output device */ { USHORT uiPCount = ( USHORT ) hb_pcount(); USHORT uiParam; for( uiParam = 1; uiParam <= uiPCount; uiParam++ ) { hb_conOut( uiParam, hb_conOutStd ); if( uiParam < uiPCount ) hb_conOutStd( " ", 1 ); } } HB_FUNC( OUTERR ) /* writes a list of values to the standard error device */ { USHORT uiPCount = ( USHORT ) hb_pcount(); USHORT uiParam; for( uiParam = 1; uiParam <= uiPCount; uiParam++ ) { hb_conOut( uiParam, hb_conOutErr ); if( uiParam < uiPCount ) hb_conOutErr( " ", 1 ); } } HB_FUNC( QQOUT ) /* writes a list of values to the current device (screen or printer) and is affected by SET ALTERNATE */ { USHORT uiPCount = ( USHORT ) hb_pcount(); USHORT uiParam; for( uiParam = 1; uiParam <= uiPCount; uiParam++ ) { hb_conOut( uiParam, hb_conOutAlt ); if( uiParam < uiPCount ) hb_conOutAlt( " ", 1 ); } } HB_FUNC( QOUT ) { hb_conOutAlt( s_szCrLf, s_iCrLfLen ); if( hb_setGetPrinter() && hb_setGetPrintHan() != FS_ERROR ) { BYTE buf[ 256 ]; PHB_PRNPOS pPrnPos = hb_prnPos(); pPrnPos->row++; pPrnPos->col = ( USHORT ) hb_setGetMargin(); if( pPrnPos->col ) { if( pPrnPos->col > sizeof( buf ) ) { BYTE * pBuf = ( BYTE * ) hb_xgrab( pPrnPos->col ); memset( pBuf, ' ', pPrnPos->col ); hb_fsWrite( hb_setGetPrintHan(), pBuf, pPrnPos->col ); hb_xfree( pBuf ); } else { memset( buf, ' ', pPrnPos->col ); hb_fsWrite( hb_setGetPrintHan(), buf, pPrnPos->col ); } } } HB_FUNC_EXEC( QQOUT ); } HB_FUNC( __EJECT ) /* Ejects the current page from the printer */ { PHB_PRNPOS pPrnPos; if( hb_setGetPrintHan() != FS_ERROR ) { static const BYTE s_byEop[ 4 ] = { 0x0C, 0x0D, 0x00, 0x00 }; /* Buffer is 4 bytes to make CodeGuard happy */ hb_fsWrite( hb_setGetPrintHan(), s_byEop, 2 ); } pPrnPos = hb_prnPos(); pPrnPos->row = pPrnPos->col = 0; } HB_FUNC( PROW ) /* Returns the current printer row position */ { hb_retni( ( int ) hb_prnPos()->row ); } HB_FUNC( PCOL ) /* Returns the current printer row position */ { hb_retni( ( int ) hb_prnPos()->col ); } static void hb_conDevPos( SHORT iRow, SHORT iCol ) { HB_TRACE(HB_TR_DEBUG, ("hb_conDevPos(%hd, %hd)", iRow, iCol)); /* Position printer if SET DEVICE TO PRINTER and valid printer file otherwise position console */ if( hb_setGetPrintHan() != FS_ERROR && hb_stricmp( hb_setGetDevice(), "PRINTER" ) == 0 ) { USHORT uiPRow = ( USHORT ) iRow; USHORT uiPCol = ( USHORT ) iCol + ( USHORT ) hb_setGetMargin(); PHB_PRNPOS pPrnPos = hb_prnPos(); if( pPrnPos->row != uiPRow || pPrnPos->col != uiPCol ) { BYTE buf[ 256 ]; int iPtr = 0; if( pPrnPos->row != uiPRow ) { if( ++pPrnPos->row > uiPRow ) { memcpy( &buf[ iPtr ], "\x0C\x0D\x00\x00", 2 ); /* Source buffer is 4 bytes to make CodeGuard happy */ iPtr += 2; pPrnPos->row = 0; } else { memcpy( &buf[ iPtr ], s_szCrLf, s_iCrLfLen ); iPtr += s_iCrLfLen; } while( pPrnPos->row < uiPRow ) { if( iPtr + s_iCrLfLen > ( int ) sizeof( buf ) ) { hb_fsWrite( hb_setGetPrintHan(), buf, ( USHORT ) iPtr ); iPtr = 0; } memcpy( &buf[ iPtr ], s_szCrLf, s_iCrLfLen ); iPtr += s_iCrLfLen; ++pPrnPos->row; } pPrnPos->col = 0; } else if( pPrnPos->col > uiPCol ) { buf[ iPtr++ ] = '\x0D'; pPrnPos->col = 0; } while( pPrnPos->col < uiPCol ) { if( iPtr == ( int ) sizeof( buf ) ) { hb_fsWrite( hb_setGetPrintHan(), buf, ( USHORT ) iPtr ); iPtr = 0; } buf[ iPtr++ ] = ' '; ++pPrnPos->col; } if( iPtr ) hb_fsWrite( hb_setGetPrintHan(), buf, ( SHORT ) iPtr ); } } else hb_gtSetPos( iRow, iCol ); } /* NOTE: This should be placed after the hb_conDevPos() definition. */ HB_FUNC( DEVPOS ) /* Sets the screen and/or printer position */ { if( ISNUM( 1 ) && ISNUM( 2 ) ) hb_conDevPos( ( SHORT ) hb_parni( 1 ), ( SHORT ) hb_parni( 2 ) ); } HB_FUNC( SETPRC ) /* Sets the current printer row and column positions */ { if( hb_pcount() == 2 && ISNUM( 1 ) && ISNUM( 2 ) ) { PHB_PRNPOS pPrnPos = hb_prnPos(); pPrnPos->row = ( USHORT ) hb_parni( 1 ); pPrnPos->col = ( USHORT ) hb_parni( 2 ); } } HB_FUNC( DEVOUT ) /* writes a single value to the current device (screen or printer), but is not affected by SET ALTERNATE */ { if( ISCHAR( 2 ) ) { char szOldColor[ HB_CLRSTR_LEN ]; hb_gtGetColorStr( szOldColor ); hb_gtSetColorStr( hb_parc( 2 ) ); hb_conOut( 1, hb_conOutDev ); hb_gtSetColorStr( szOldColor ); } else if( hb_pcount() >= 1 ) hb_conOut( 1, hb_conOutDev ); } HB_FUNC( DISPOUT ) /* writes a single value to the screen, but is not affected by SET ALTERNATE */ { char * pszString; ULONG ulLen; BOOL bFreeReq; if( ISCHAR( 2 ) ) { char szOldColor[ HB_CLRSTR_LEN ]; hb_gtGetColorStr( szOldColor ); hb_gtSetColorStr( hb_parc( 2 ) ); pszString = hb_itemStringCon( hb_param( 1, HB_IT_ANY ), &ulLen, &bFreeReq ); hb_gtWrite( ( BYTE * ) pszString, ulLen ); if( bFreeReq ) hb_xfree( pszString ); hb_gtSetColorStr( szOldColor ); } else if( hb_pcount() >= 1 ) { pszString = hb_itemStringCon( hb_param( 1, HB_IT_ANY ), &ulLen, &bFreeReq ); hb_gtWrite( ( BYTE * ) pszString, ulLen ); if( bFreeReq ) hb_xfree( pszString ); } } /* Undocumented Clipper function */ /* NOTE: Clipper does no checks about the screen positions. [vszakats] */ HB_FUNC( DISPOUTAT ) /* writes a single value to the screen at speficic position, but is not affected by SET ALTERNATE */ { char * pszString; ULONG ulLen; BOOL bFreeReq; if( ISCHAR( 4 ) ) { char szOldColor[ HB_CLRSTR_LEN ]; hb_gtGetColorStr( szOldColor ); hb_gtSetColorStr( hb_parc( 4 ) ); pszString = hb_itemStringCon( hb_param( 3, HB_IT_ANY ), &ulLen, &bFreeReq ); hb_gtWriteAt( ( USHORT ) hb_parni( 1 ), ( USHORT ) hb_parni( 2 ), ( BYTE * ) pszString, ulLen ); if( bFreeReq ) hb_xfree( pszString ); hb_gtSetColorStr( szOldColor ); } else if( hb_pcount() >= 3 ) { pszString = hb_itemStringCon( hb_param( 3, HB_IT_ANY ), &ulLen, &bFreeReq ); hb_gtWriteAt( ( USHORT ) hb_parni( 1 ), ( USHORT ) hb_parni( 2 ), ( BYTE * ) pszString, ulLen ); if( bFreeReq ) hb_xfree( pszString ); } } /* Harbour extension, works like DISPOUTAT but does not change cursor position */ HB_FUNC( HB_DISPOUTAT ) { if( hb_pcount() >= 3 ) { char * pszString; ULONG ulLen; BOOL bFreeReq; int iColor; pszString = hb_itemStringCon( hb_param( 3, HB_IT_ANY ), &ulLen, &bFreeReq ); if( ISCHAR( 4 ) ) iColor = hb_gtColorToN( hb_parc( 4 ) ); else if( ISNUM( 4 ) ) iColor = hb_parni( 4 ); else iColor = -1; hb_gtPutText( ( USHORT ) hb_parni( 1 ), ( USHORT ) hb_parni( 2 ), ( BYTE * ) pszString, ulLen, iColor ); if( bFreeReq ) hb_xfree( pszString ); } } HB_FUNC( HB_GETSTDIN ) /* Return Handel for STDIN */ { hb_retnint( ( HB_NHANDLE ) s_hFilenoStdin ); } HB_FUNC( HB_GETSTDOUT ) /* Return Handel for STDOUT */ { hb_retnint( ( HB_NHANDLE ) s_hFilenoStdout ); } HB_FUNC( HB_GETSTDERR ) /* Return Handel for STDERR */ { hb_retnint( ( HB_NHANDLE ) s_hFilenoStderr ); }