fivedev/harbour-core
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
28a0b4c3daec70805cf4c0ea6679dccb0628d3d4
harbour-core/include/hbxvm.h
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

259 lines
16 KiB
C
Raw Blame History

/*
* Header file for the Internal Terminal API
*
* Copyright 2006 Przemyslaw Czerpak < druzus /at/ priv.onet.pl >
*
* 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.
*
*/
#ifndef HB_XVM_H_
#define HB_XVM_H_
#include "hbapi.h"
#include "hbapiitm.h"
#include "hbvm.h"
#include "hbstack.h"
HB_EXTERN_BEGIN
/*
* Functions below which return HB_BOOL value can cause error handler
* executing so we have to check for break request flag. The return
* value is HB_TRUE when break request is set.
* other functions does not execute error handler and we do not have
* to check HVM state so they are simply declared as void.
*/
extern HB_EXPORT void hb_xvmExitProc( void );
extern HB_EXPORT void hb_xvmEndProc( void );
extern HB_EXPORT void hb_xvmSeqBegin( void );
extern HB_EXPORT HB_BOOL hb_xvmSeqEnd( void );
extern HB_EXPORT HB_BOOL hb_xvmSeqEndTest( void );
extern HB_EXPORT HB_BOOL hb_xvmSeqRecover( void );
extern HB_EXPORT void hb_xvmSeqAlways( void );
extern HB_EXPORT HB_BOOL hb_xvmAlwaysBegin( void );
extern HB_EXPORT HB_BOOL hb_xvmAlwaysEnd( void );
extern HB_EXPORT HB_BOOL hb_xvmSeqBlock( void );
extern HB_EXPORT HB_BOOL hb_xvmEnumStart( int, int ); /* prepare FOR EACH loop */
extern HB_EXPORT HB_BOOL hb_xvmEnumNext( void ); /* increment FOR EACH loop counter */
extern HB_EXPORT HB_BOOL hb_xvmEnumPrev( void ); /* decrement FOR EACH loop counter */
extern HB_EXPORT void hb_xvmEnumEnd( void ); /* rewind the stack after FOR EACH loop counter */
extern HB_EXPORT void hb_xvmWithObjectStart( void ); /* prepare WITH OBJECT statement */
extern HB_EXPORT void hb_xvmWithObjectEnd( void ); /* rewind the stack after normal WITH OBJECT */
extern HB_EXPORT void hb_xvmWithObjectMessage( PHB_SYMB ); /* send WITH OBJECT message to current WITH OBJECT control variable */
extern HB_EXPORT HB_BOOL hb_xvmSwitchGet( PHB_ITEM * );
extern HB_EXPORT void hb_xvmSetLine( HB_USHORT uiLine ); /* set .prg line number information */
extern HB_EXPORT void hb_xvmFrame( int iLocals, int iParams ); /* increases the stack pointer for the amount of locals and params supplied */
extern HB_EXPORT void hb_xvmVFrame( int iLocals, int iParams ); /* increases the stack pointer for the amount of locals and variable params */
extern HB_EXPORT void hb_xvmSFrame( PHB_SYMB pSymbol );
extern HB_EXPORT void hb_xvmStatics( PHB_SYMB pSymbol, HB_USHORT uiStatics );
extern HB_EXPORT void hb_xvmThreadStatics( HB_USHORT uiStatics, const HB_BYTE * statics );
extern HB_EXPORT void hb_xvmParameter( PHB_SYMB pSymbol, int iParams );
extern HB_EXPORT void hb_xvmRetValue( void ); /* pops the latest stack value into stack.Return */
extern HB_EXPORT void hb_xvmRetNil( void );
extern HB_EXPORT void hb_xvmRetInt( HB_LONG lValue );
extern HB_EXPORT HB_BOOL hb_xvmDo( HB_USHORT uiParams );
extern HB_EXPORT HB_BOOL hb_xvmFunction( HB_USHORT uiParams );
extern HB_EXPORT HB_BOOL hb_xvmSend( HB_USHORT uiParams );
extern HB_EXPORT HB_BOOL hb_xvmPushObjectVarRef( void );
extern HB_EXPORT void hb_xvmPushStatic( HB_USHORT uiStatic );
extern HB_EXPORT void hb_xvmPushStaticByRef( HB_USHORT uiStatic );
extern HB_EXPORT void hb_xvmPopStatic( HB_USHORT uiStatic );
extern HB_EXPORT HB_BOOL hb_xvmPushVariable( PHB_SYMB pSymbol );
extern HB_EXPORT HB_BOOL hb_xvmPopVariable( PHB_SYMB pSymbol );
extern HB_EXPORT void hb_xvmPushBlock( const HB_BYTE * pCode, PHB_SYMB pSymbols ); /* creates a codeblock */
extern HB_EXPORT void hb_xvmPushBlockShort( const HB_BYTE * pCode, PHB_SYMB pSymbols ); /* creates a codeblock */
extern HB_EXPORT void hb_xvmPushBlockLarge( const HB_BYTE * pCode, PHB_SYMB pSymbols ); /* creates a codeblock */
extern HB_EXPORT void hb_xvmPushSelf( void );
extern HB_EXPORT void hb_xvmPushVParams( void );
extern HB_EXPORT void hb_xvmPushAParams( void );
extern HB_EXPORT void hb_xvmPushLocal( HB_SHORT iLocal ); /* pushes the content of a local onto the stack */
extern HB_EXPORT void hb_xvmPushLocalByRef( HB_SHORT iLocal ); /* pushes a local by reference onto the stack */
extern HB_EXPORT void hb_xvmPopLocal( HB_SHORT iLocal ); /* pops the stack latest value onto a local */
extern HB_EXPORT HB_BOOL hb_xvmPushField( PHB_SYMB pSymbol );
extern HB_EXPORT HB_BOOL hb_xvmPopField( PHB_SYMB pSymbol );
extern HB_EXPORT HB_BOOL hb_xvmPushMemvar( PHB_SYMB pSymbol );
extern HB_EXPORT HB_BOOL hb_xvmPushMemvarByRef( PHB_SYMB pSymbol );
extern HB_EXPORT HB_BOOL hb_xvmPopMemvar( PHB_SYMB pSymbol );
extern HB_EXPORT HB_BOOL hb_xvmPushAliasedField( PHB_SYMB pSymbol );
extern HB_EXPORT HB_BOOL hb_xvmPopAliasedField( PHB_SYMB pSymbol );
extern HB_EXPORT HB_BOOL hb_xvmPushAliasedFieldExt( PHB_SYMB pAlias, PHB_SYMB pField );
extern HB_EXPORT HB_BOOL hb_xvmPopAliasedFieldExt( PHB_SYMB pAlias, PHB_SYMB pField );
extern HB_EXPORT HB_BOOL hb_xvmPushAliasedVar( PHB_SYMB pSymbol );
extern HB_EXPORT HB_BOOL hb_xvmPopAliasedVar( PHB_SYMB pSymbol );
extern HB_EXPORT HB_BOOL hb_xvmPushAlias( void );
extern HB_EXPORT HB_BOOL hb_xvmPopAlias( void ); /* select the workarea using a given item or a substituted value */
extern HB_EXPORT HB_BOOL hb_xvmPopLogical( HB_BOOL * ); /* pops the stack latest value and returns its logical value */
extern HB_EXPORT HB_BOOL hb_xvmSwapAlias( void ); /* swaps items on the eval stack and pops the workarea number */
extern HB_EXPORT HB_BOOL hb_xvmLocalAddInt( int iLocal, HB_LONG lAdd ); /* add integer to given local variable */
extern HB_EXPORT HB_BOOL hb_xvmLocalInc( int iLocal ); /* increment given local variable */
extern HB_EXPORT HB_BOOL hb_xvmLocalDec( int iLocal ); /* decrement given local variable */
extern HB_EXPORT HB_BOOL hb_xvmLocalIncPush( int iLocal ); /* increment given local variable and push it on HVM stack */
extern HB_EXPORT HB_BOOL hb_xvmAnd( void );
extern HB_EXPORT HB_BOOL hb_xvmOr( void );
extern HB_EXPORT HB_BOOL hb_xvmNot( void );
extern HB_EXPORT HB_BOOL hb_xvmNegate( void );
extern HB_EXPORT void hb_xvmDuplicate( void );
extern HB_EXPORT void hb_xvmDuplUnRef( void );
extern HB_EXPORT void hb_xvmPushUnRef( void );
extern HB_EXPORT void hb_xvmSwap( int iCount );
extern HB_EXPORT HB_BOOL hb_xvmForTest( void );
extern HB_EXPORT void hb_xvmFuncPtr( void );
extern HB_EXPORT HB_BOOL hb_xvmEqual( void ); /* checks if the two latest values on the stack are equal, removes both and leaves result */
extern HB_EXPORT HB_BOOL hb_xvmExactlyEqual( void ); /* checks if the two latest values on the stack are exactly equal, removes both and leaves result */
extern HB_EXPORT HB_BOOL hb_xvmNotEqual( void ); /* checks if the two latest values on the stack are not equal, removes both and leaves result */
extern HB_EXPORT HB_BOOL hb_xvmLess( void ); /* checks if the latest - 1 value is less than the latest, removes both and leaves result */
extern HB_EXPORT HB_BOOL hb_xvmLessEqual( void ); /* checks if the latest - 1 value is less than or equal the latest, removes both and leaves result */
extern HB_EXPORT HB_BOOL hb_xvmGreater( void ); /* checks if the latest - 1 value is greater than the latest, removes both and leaves result */
extern HB_EXPORT HB_BOOL hb_xvmGreaterEqual( void ); /* checks if the latest - 1 value is greater than or equal the latest, removes both and leaves result */
extern HB_EXPORT HB_BOOL hb_xvmInstring( void ); /* check whether string 1 is contained in string 2 */
extern HB_EXPORT HB_BOOL hb_xvmPlus( void ); /* sums the latest two values on the stack, removes them and leaves the result */
extern HB_EXPORT HB_BOOL hb_xvmPlusEq( void );
extern HB_EXPORT HB_BOOL hb_xvmPlusEqPop( void );
extern HB_EXPORT HB_BOOL hb_xvmMinus( void ); /* subtracts the latest two values on the stack, removes them and leaves the result */
extern HB_EXPORT HB_BOOL hb_xvmMinusEq( void );
extern HB_EXPORT HB_BOOL hb_xvmMinusEqPop( void );
extern HB_EXPORT HB_BOOL hb_xvmMult( void ); /* multiplies the latest two values on the stack, removes them and leaves the result */
extern HB_EXPORT HB_BOOL hb_xvmMultEq( void );
extern HB_EXPORT HB_BOOL hb_xvmMultEqPop( void );
extern HB_EXPORT HB_BOOL hb_xvmDivide( void ); /* divides the latest two values on the stack, removes them and leaves the result */
extern HB_EXPORT HB_BOOL hb_xvmDivEq( void );
extern HB_EXPORT HB_BOOL hb_xvmDivEqPop( void );
extern HB_EXPORT HB_BOOL hb_xvmModulus( void ); /* calculates the modulus of latest two values on the stack, removes them and leaves the result */
extern HB_EXPORT HB_BOOL hb_xvmModEq( void );
extern HB_EXPORT HB_BOOL hb_xvmModEqPop( void );
extern HB_EXPORT HB_BOOL hb_xvmPower( void );
extern HB_EXPORT HB_BOOL hb_xvmExpEq( void );
extern HB_EXPORT HB_BOOL hb_xvmExpEqPop( void );
extern HB_EXPORT HB_BOOL hb_xvmInc( void );
extern HB_EXPORT HB_BOOL hb_xvmIncEq( void );
extern HB_EXPORT HB_BOOL hb_xvmIncEqPop( void );
extern HB_EXPORT HB_BOOL hb_xvmDec( void );
extern HB_EXPORT HB_BOOL hb_xvmDecEq( void );
extern HB_EXPORT HB_BOOL hb_xvmDecEqPop( void );
extern HB_EXPORT void hb_xvmArrayDim( HB_USHORT uiDimensions ); /* generates an uiDimensions Array and initialize those dimensions from the stack values */
extern HB_EXPORT void hb_xvmArrayGen( HB_SIZE nElements ); /* generates an nElements Array and fills it from the stack values */
extern HB_EXPORT HB_BOOL hb_xvmArrayPush( void ); /* pushes an array element to the stack, removing the array and the index from the stack */
extern HB_EXPORT HB_BOOL hb_xvmArrayPushRef( void ); /* pushes a reference to an array element to the stack, removing the array and the index from the stack */
extern HB_EXPORT HB_BOOL hb_xvmArrayPop( void ); /* pops a value from the stack */
extern HB_EXPORT void hb_xvmHashGen( HB_SIZE nElements ); /* generates an nElements Hash and fills it from the stack values */
extern HB_EXPORT void hb_xvmLocalName( HB_USHORT uiLocal, const char * szLocalName );
extern HB_EXPORT void hb_xvmStaticName( HB_BYTE bIsGlobal, HB_USHORT uiStatic, const char * szStaticName );
extern HB_EXPORT void hb_xvmModuleName( const char * szModuleName );
extern HB_EXPORT HB_BOOL hb_xvmMacroDo( HB_USHORT uiArgSets );
extern HB_EXPORT HB_BOOL hb_xvmMacroFunc( HB_USHORT uiArgSets );
extern HB_EXPORT HB_BOOL hb_xvmMacroSend( HB_USHORT uiArgSets );
extern HB_EXPORT HB_BOOL hb_xvmMacroArrayGen( HB_USHORT uiArgSets );
extern HB_EXPORT HB_BOOL hb_xvmMacroPush( int bFlags );
extern HB_EXPORT HB_BOOL hb_xvmMacroPushRef( void );
extern HB_EXPORT HB_BOOL hb_xvmMacroPushIndex( void );
extern HB_EXPORT HB_BOOL hb_xvmMacroPushArg( PHB_SYMB pSymbol, int bFlags );
extern HB_EXPORT HB_BOOL hb_xvmMacroPushList( int bFlags );
extern HB_EXPORT HB_BOOL hb_xvmMacroPushAliased( int bFlags );
extern HB_EXPORT HB_BOOL hb_xvmMacroPushPare( int bFlags );
extern HB_EXPORT HB_BOOL hb_xvmMacroPop( int bFlags );
extern HB_EXPORT HB_BOOL hb_xvmMacroPopAliased( int bFlags );
extern HB_EXPORT HB_BOOL hb_xvmMacroSymbol( void );
extern HB_EXPORT HB_BOOL hb_xvmMacroText( void );
extern HB_EXPORT void hb_xvmPushStringHidden( int iMethod, const char * szText, HB_SIZE nSize );
extern HB_EXPORT void hb_xvmPushDouble( double dNumber, int iWidth, int iDec );
#ifdef HB_LONG_LONG_OFF
extern HB_EXPORT void hb_xvmPushLongLong( double dNumber );
#else
extern HB_EXPORT void hb_xvmPushLongLong( HB_LONGLONG llNumber );
#endif
#define hb_xvmPushLogical( f ) hb_vmPushLogical( f )
#define hb_xvmPushInteger( i ) hb_vmPushInteger( i )
#define hb_xvmPushLong( l ) hb_vmPushLong( l )
#define hb_xvmPushNil() hb_vmPushNil()
#define hb_xvmPushStringConst( psz, ul ) hb_vmPushStringPcode( psz, ul )
#define hb_xvmPushSymbol( p ) hb_vmPushSymbol( p )
#define hb_xvmPushDate( l ) hb_vmPushDate( l )
#define hb_xvmPushTimeStamp( d, t ) hb_vmPushTimeStamp( d, t )
/*
* additional multi PCODE operations
*/
extern HB_EXPORT HB_BOOL hb_xvmArrayItemPush( HB_SIZE nIndex );
extern HB_EXPORT HB_BOOL hb_xvmArrayItemPop( HB_SIZE nIndex );
extern HB_EXPORT HB_BOOL hb_xvmMultByInt( HB_LONG lValue );
extern HB_EXPORT HB_BOOL hb_xvmDivideByInt( HB_LONG lValue );
extern HB_EXPORT HB_BOOL hb_xvmModulusByInt( HB_LONG lValue );
extern HB_EXPORT HB_BOOL hb_xvmAddInt( HB_LONG lValue );
extern HB_EXPORT void hb_xvmLocalSetInt( int iLocal, HB_LONG lValue );
/*extern HB_EXPORT void hb_xvmLocalSetStr( int iLocal, const char * pValue, HB_SIZE nLen );*/
extern HB_EXPORT void hb_xvmPushFuncSymbol( PHB_SYMB pSym );
extern HB_EXPORT HB_BOOL hb_xvmLessThenInt( HB_LONG lValue );
extern HB_EXPORT HB_BOOL hb_xvmLessThenIntIs( HB_LONG lValue, HB_BOOL * fValue );
extern HB_EXPORT HB_BOOL hb_xvmLessEqualThenInt( HB_LONG lValue );
extern HB_EXPORT HB_BOOL hb_xvmLessEqualThenIntIs( HB_LONG lValue, HB_BOOL * fValue );
extern HB_EXPORT HB_BOOL hb_xvmGreaterThenInt( HB_LONG lValue );
extern HB_EXPORT HB_BOOL hb_xvmGreaterThenIntIs( HB_LONG lValue, HB_BOOL * fValue );
extern HB_EXPORT HB_BOOL hb_xvmGreaterEqualThenInt( HB_LONG lValue );
extern HB_EXPORT HB_BOOL hb_xvmGreaterEqualThenIntIs( HB_LONG lValue, HB_BOOL * fValue );
extern HB_EXPORT HB_BOOL hb_xvmEqualInt( HB_LONG lValue );
extern HB_EXPORT HB_BOOL hb_xvmEqualIntIs( HB_LONG lValue, HB_BOOL * fValue );
extern HB_EXPORT HB_BOOL hb_xvmNotEqualInt( HB_LONG lValue );
extern HB_EXPORT HB_BOOL hb_xvmNotEqualIntIs( HB_LONG lValue, HB_BOOL * fValue );
extern HB_EXPORT HB_BOOL hb_xvmLocalAdd( int iLocal );
extern HB_EXPORT HB_BOOL hb_xvmStaticAdd( HB_USHORT uiStatic );
extern HB_EXPORT HB_BOOL hb_xvmMemvarAdd( PHB_SYMB pSymbol );
extern HB_EXPORT void hb_xvmCopyLocals( int iDest, int iSource );
HB_EXTERN_END
#endif /* HB_XVM_H_ */
Reference in New Issue View Git Blame Copy Permalink