9f16c2bf8e
* *
* update copyright headers with new FSF postal address
* COPYING.txt -> LICENSE.txt (rest of repo to be synced)
256 lines
9.4 KiB
C
256 lines
9.4 KiB
C
/*
|
|
* Header file for the generated C language source code
|
|
*
|
|
* Copyright 1999-2001 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.
|
|
*
|
|
*/
|
|
|
|
#ifndef HB_VMPUB_H_
|
|
#define HB_VMPUB_H_
|
|
|
|
#include "hbdefs.h"
|
|
|
|
/* Maximum symbol name length handled by Harbour compiler and runtime.
|
|
For strict CA-Cl*pper compatibility a value of 10 would have
|
|
to be used, but Harbour won't properly compile using this setting. */
|
|
#define HB_SYMBOL_NAME_LEN 63
|
|
|
|
HB_EXTERN_BEGIN
|
|
|
|
#ifdef _HB_API_INTERNAL_
|
|
|
|
struct _HB_SYMB;
|
|
|
|
# define HB_ITEM_TYPERAW( p ) ( ( p )->type )
|
|
# define HB_ITEM_TYPE( p ) ( HB_ITEM_TYPERAW( p ) & ~ HB_IT_DEFAULT )
|
|
# define HB_OBJ_CLASS( p ) ( ( p )->item.asArray.value->uiClass )
|
|
# define HB_ARRAY_OBJ( p ) ( ( p )->item.asArray.value->uiClass != 0 )
|
|
# define HB_VM_PUSHNIL() do { hb_stackAllocItem()->type = HB_IT_NIL; } while( 0 )
|
|
|
|
# define HB_ITEM_GET_NUMINTRAW( p ) ( HB_IS_INTEGER( p ) ? \
|
|
( HB_MAXINT ) (p)->item.asInteger.value : \
|
|
( HB_MAXINT ) (p)->item.asLong.value )
|
|
|
|
# define HB_ITEM_PUT_NUMINTRAW( p, v ) \
|
|
do { \
|
|
if( HB_LIM_INT( v ) ) \
|
|
{ \
|
|
(p)->type = HB_IT_INTEGER; \
|
|
(p)->item.asInteger.length = HB_INT_EXPLENGTH( v ); \
|
|
(p)->item.asInteger.value = ( int ) (v); \
|
|
} \
|
|
else \
|
|
{ \
|
|
(p)->type = HB_IT_LONG; \
|
|
(p)->item.asLong.value = (v); \
|
|
(p)->item.asLong.length = HB_LONG_EXPLENGTH( v ); \
|
|
} \
|
|
} while( 0 )
|
|
|
|
# if HB_VMINT_MAX >= LONG_MAX
|
|
# define HB_ITEM_PUT_LONGRAW( p, v ) \
|
|
do { \
|
|
(p)->type = HB_IT_INTEGER; \
|
|
(p)->item.asInteger.value = ( int ) (v); \
|
|
(p)->item.asInteger.length = HB_INT_LENGTH( v ); \
|
|
} while( 0 )
|
|
# else
|
|
# define HB_ITEM_PUT_LONGRAW( p, v ) \
|
|
do { \
|
|
(p)->type = HB_IT_LONG; \
|
|
(p)->item.asLong.value = (v); \
|
|
(p)->item.asLong.length = HB_LONG_LENGTH( v ); \
|
|
} while( 0 )
|
|
# endif
|
|
|
|
# define HB_ITEM_GET_NUMDBLRAW( p ) ( HB_IS_INTEGER( p ) ? \
|
|
( double ) (p)->item.asInteger.value : \
|
|
( HB_IS_LONG( p ) ? \
|
|
( double ) (p)->item.asLong.value : \
|
|
(p)->item.asDouble.value ) )
|
|
|
|
# define HB_VM_ISFUNC( pSym ) ( ( pSym )->value.pFunPtr )
|
|
|
|
# define HB_VM_FUNCUNREF( pSym ) \
|
|
do { \
|
|
if( ( ( pSym )->scope.value & HB_FS_DEFERRED ) && \
|
|
( pSym )->pDynSym ) \
|
|
pSym = ( pSym )->pDynSym->pSymbol; \
|
|
} while( 0 )
|
|
|
|
# define HB_VM_EXECUTE( pSym ) \
|
|
do { \
|
|
/* Running pCode dynamic function from .hrb? */ \
|
|
if( ( pSym )->scope.value & HB_FS_PCODEFUNC ) \
|
|
hb_vmExecute( ( pSym )->value.pCodeFunc->pCode, \
|
|
( pSym )->value.pCodeFunc->pSymbols ); \
|
|
else \
|
|
( pSym )->value.pFunPtr(); \
|
|
} while( 0 )
|
|
|
|
/* dynamic symbol structure */
|
|
typedef struct _HB_DYNS
|
|
{
|
|
struct _HB_SYMB * pSymbol; /* pointer to its relative local symbol */
|
|
# if ! defined( HB_MT_VM )
|
|
void * pMemvar; /* memvar pointer ( publics & privates ) */
|
|
HB_USHORT uiArea; /* Workarea number */
|
|
# endif /* ! HB_MT_VM */
|
|
HB_USHORT uiSymNum; /* dynamic symbol number */
|
|
# if ! defined( HB_NO_PROFILER )
|
|
HB_ULONG ulCalls; /* profiler support */
|
|
HB_ULONG ulTime; /* profiler support */
|
|
HB_ULONG ulRecurse; /* profiler support */
|
|
# endif /* ! HB_NO_PROFILER */
|
|
} HB_DYNS, * PHB_DYNS;
|
|
|
|
/* pCode dynamic function - HRB */
|
|
typedef struct _HB_PCODEFUNC
|
|
{
|
|
HB_BYTE * pCode; /* function body - PCODE */
|
|
struct _HB_SYMB * pSymbols;/* module symbol table */
|
|
} HB_PCODEFUNC, * PHB_PCODEFUNC;
|
|
|
|
#else /* ! _HB_API_INTERNAL_ */
|
|
|
|
# undef _HB_API_MACROS_
|
|
# undef _HB_STACK_MACROS_
|
|
|
|
/* This is ugly trick but works without speed overhead */
|
|
#if defined( __cplusplus )
|
|
# define HB_ITEM_TYPERAW( p ) ( * static_cast< HB_TYPE * >( p ) )
|
|
#else
|
|
# define HB_ITEM_TYPERAW( p ) ( * ( HB_TYPE * ) ( p ) )
|
|
#endif
|
|
/* if you do not like it then use this definition */
|
|
/* # define HB_ITEM_TYPERAW( p ) ( hb_itemType( p ) ) */
|
|
|
|
# define HB_ITEM_TYPE( p ) ( HB_ITEM_TYPERAW( p ) & ~HB_IT_DEFAULT )
|
|
|
|
# define HB_OBJ_CLASS( p ) ( hb_objGetClass( p ) )
|
|
# define HB_ARRAY_OBJ( p ) ( hb_arrayIsObject( p ) )
|
|
|
|
/* basic types */
|
|
typedef void * PHB_ITEM;
|
|
typedef void * PHB_CODEBLOCK;
|
|
typedef void * PHB_PCODEFUNC;
|
|
|
|
typedef void HB_STACK;
|
|
|
|
/*
|
|
* The first version reduce the number of modification in existing 3-rd
|
|
* party code but in longer terms I'd prefer to disable it and left
|
|
* only the second one where PHB_DYNS is mapped to void*.
|
|
* This will allow us to fully redesign dynamic symbol internals
|
|
* in the future if it will be necessary. [druzus]
|
|
*/
|
|
#if 0
|
|
struct _HB_SYMB;
|
|
typedef struct
|
|
{
|
|
struct _HB_SYMB * pSymbol; /* pointer to its relative local symbol */
|
|
} _HB_DYNS, * PHB_DYNS;
|
|
#else
|
|
typedef void * PHB_DYNS;
|
|
#endif
|
|
|
|
#endif /* ! _HB_API_INTERNAL_ */
|
|
|
|
/* symbol support structure */
|
|
typedef struct _HB_SYMB
|
|
{
|
|
const char * szName; /* the name of the symbol */
|
|
union
|
|
{
|
|
HB_SYMBOLSCOPE value; /* the scope of the symbol */
|
|
void * pointer; /* filler to force alignment */
|
|
} scope;
|
|
union
|
|
{
|
|
PHB_FUNC pFunPtr; /* machine code function address for function symbol table entries */
|
|
PHB_PCODEFUNC pCodeFunc; /* PCODE function address */
|
|
void * pStaticsBase; /* base offset to array of statics */
|
|
} value;
|
|
PHB_DYNS pDynSym; /* pointer to its dynamic symbol if defined */
|
|
} HB_SYMB, * PHB_SYMB;
|
|
|
|
#define HB_DYNS_FUNC( hbfunc ) HB_BOOL hbfunc( PHB_DYNS pDynSymbol, void * Cargo )
|
|
typedef HB_DYNS_FUNC( ( * PHB_DYNS_FUNC ) );
|
|
|
|
#define HB_CARGO_FUNC( func ) void func( void *cargo )
|
|
typedef HB_CARGO_FUNC( ( * PHB_CARGO_FUNC ) );
|
|
|
|
typedef void * ( * PHB_ALLOCUPDT_FUNC )( void *, int );
|
|
|
|
typedef void ( * HB_INIT_FUNC )( void * );
|
|
/* List of functions used by hb_vmAtInit()/hb_vmAtExit() */
|
|
typedef struct _HB_FUNC_LIST
|
|
{
|
|
HB_INIT_FUNC pFunc;
|
|
void * cargo;
|
|
void * hDynLib;
|
|
struct _HB_FUNC_LIST * pNext;
|
|
} HB_FUNC_LIST, * PHB_FUNC_LIST;
|
|
|
|
/* Harbour Functions scope ( HB_SYMBOLSCOPE ) */
|
|
#define HB_FS_PUBLIC 0x0001
|
|
#define HB_FS_STATIC 0x0002
|
|
#define HB_FS_FIRST 0x0004
|
|
#define HB_FS_INIT 0x0008
|
|
#define HB_FS_EXIT 0x0010
|
|
#define HB_FS_MESSAGE 0x0020
|
|
#define HB_FS_MEMVAR 0x0080
|
|
#define HB_FS_PCODEFUNC 0x0100
|
|
#define HB_FS_LOCAL 0x0200
|
|
#define HB_FS_DYNCODE 0x0400
|
|
#define HB_FS_DEFERRED 0x0800
|
|
#define HB_FS_FRAME 0x1000
|
|
#define HB_FS_USED 0x2000
|
|
|
|
#define HB_FS_INITEXIT ( HB_FS_INIT | HB_FS_EXIT )
|
|
|
|
extern HB_EXPORT void hb_vmExecute( const HB_BYTE * pCode, PHB_SYMB pSymbols ) HB_FLATTEN_ATTR; /* invokes the virtual machine */
|
|
|
|
HB_EXTERN_END
|
|
|
|
#endif /* HB_VMPUB_H_ */
|