Files
harbour-core/harbour/doc/en/hb_macro.txt
Viktor Szakats 0f365f1a5d 2012-07-03 13:14 UTC+0200 Viktor Szakats (harbour syenar.net)
* doc/en/command.txt
  * doc/en/datetime.txt
  * doc/en/dbdelim.txt
  * doc/en/dbsdf.txt
  * doc/en/dbstrux.txt
  * doc/en/dir.txt
  * doc/en/diskspac.txt
  * doc/en/eval.txt
  * doc/en/garbage.txt
  * doc/en/gtslang.txt
  * doc/en/hashes.txt
  * doc/en/hb_api.txt
  * doc/en/hb_apier.txt
  * doc/en/hb_apigt.txt
  * doc/en/hb_apiit.txt
  * doc/en/hb_apiln.txt
  * doc/en/hb_apird.txt
  * doc/en/hb_compa.txt
  * doc/en/hb_date.txt
  * doc/en/hb_macro.txt
  * doc/en/hb_set.txt
  * doc/en/hb_vm.txt
  * doc/en/idle.txt
  * doc/en/input.txt
  * doc/en/lang.txt
  * doc/en/macro.txt
  * doc/en/math.txt
  * doc/en/memo.txt
  * doc/en/memvar2.txt
  * doc/en/misc.txt
  * doc/en/string.txt
  * doc/en/var.txt
    * fixes

  * doc/en/*.txt
    * set mime-type to UTF-8
2012-07-03 11:20:27 +00:00

1130 lines
16 KiB
Plaintext

/*
* $Id$
*/
/*
* The following parts are Copyright of the individual authors.
* www - http://harbour-project.org
*
* Copyright 1999 Ryszard Glab
* Header file for the Macro compiler
*
* See COPYING for licensing terms.
*
*/
/* $DOC$
* $TEMPLATE$
* Procedure
* $NAME$
* hb_macroError()
* $CATEGORY$
* C level API
* $SUBCATEGORY$
* Macro
* $ONELINER$
*
* $SYNTAX$
* C Prototype
*
* #include "hbmacro.h"
* hb_macroError( int iError, HB_BISON_PTR pMacro )
* $ARGUMENTS$
* <iError>
*
* <pMacro>
* $DESCRIPTION$
*
* $EXAMPLES$
*
* $STATUS$
* R
* $COMPLIANCE$
* NA
* $FILES$
* Library is macro
* $PLATFORMS$
* All
* $SEEALSO$
*
* $END$
*/
/* $DOC$
* $TEMPLATE$
* Function
* $NAME$
* hb_macroYYParse()
* $CATEGORY$
* C level API
* $SUBCATEGORY$
* Macro
* $ONELINER$
*
* $SYNTAX$
* C Prototype
*
* #include "hbmacro.h"
* hb_macroYYParse( HB_MACRO_PTR pMacro ) --> ( int )iResult
* $ARGUMENTS$
* <pMacro>
* $RETURNS$
* <iResult>
* $DESCRIPTION$
*
* $EXAMPLES$
*
* $STATUS$
* R
* $COMPLIANCE$
* NA
* $FILES$
* Library is macro
* $PLATFORMS$
* All
* $SEEALSO$
*
* $END$
*/
/* $DOC$
* $TEMPLATE$
* Procedure
* $NAME$
* hb_compGenPCode1()
* $CATEGORY$
* C level API
* $SUBCATEGORY$
* Macro
* $ONELINER$
*
* $SYNTAX$
* C Prototype
*
* #include "hbmacro.h"
* hb_compGenPCode1( BYTE byte, HB_BISON_PTR pMacro )
* $ARGUMENTS$
* <byte>
*
* <pMacro>
* $DESCRIPTION$
*
* $EXAMPLES$
*
* $STATUS$
* R
* $COMPLIANCE$
* NA
* $FILES$
* Library is macro
* $PLATFORMS$
* All
* $SEEALSO$
*
* $END$
*/
/* $DOC$
* $TEMPLATE$
* Procedure
* $NAME$
* hb_compGenPCode2()
* $CATEGORY$
* C level API
* $SUBCATEGORY$
* Macro
* $ONELINER$
*
* $SYNTAX$
* C Prototype
*
* #include "hbmacro.h"
* hb_compGenPCode2( BYTE byte1, BYTE byte2, HB_BISON_PTR pMacro )
* $ARGUMENTS$
* <byte1>
*
* <byte2>
*
* <pMacro>
* $DESCRIPTION$
*
* $EXAMPLES$
*
* $STATUS$
* R
* $COMPLIANCE$
* NA
* $FILES$
* Library is macro
* $PLATFORMS$
* All
* $SEEALSO$
*
* $END$
*/
/* $DOC$
* $TEMPLATE$
* Procedure
* $NAME$
* hb_compGenPCode3()
* $CATEGORY$
* C level API
* $SUBCATEGORY$
* Macro
* $ONELINER$
*
* $SYNTAX$
* C Prototype
*
* #include "hbmacro.h"
* hb_compGenPCode3( BYTE byte1, BYTE byte2, BYTE byte3, HB_BISON_PTR pMacro )
* $ARGUMENTS$
* <byte1>
*
* <byte2>
*
* <byte3>
*
* <pMacro>
* $DESCRIPTION$
*
* $EXAMPLES$
*
* $STATUS$
* R
* $COMPLIANCE$
* NA
* $FILES$
* Library is macro
* $PLATFORMS$
* All
* $SEEALSO$
*
* $END$
*/
/* $DOC$
* $TEMPLATE$
* Procedure
* $NAME$
* hb_compGenPCode4()
* $CATEGORY$
* C level API
* $SUBCATEGORY$
* Macro
* $ONELINER$
*
* $SYNTAX$
* C Prototype
*
* #include "hbmacro.h"
* hb_compGenPCode4( BYTE byte1, BYTE byte2, BYTE byte3, BYTE byte4, HB_BISON_PTR pMacro )
* $ARGUMENTS$
* <byte1>
*
* <byte2>
*
* <byte3>
*
* <byte4>
*
* <pMacro>
* $DESCRIPTION$
*
* $EXAMPLES$
*
* $STATUS$
* R
* $COMPLIANCE$
* NA
* $FILES$
* Library is macro
* $PLATFORMS$
* All
* $SEEALSO$
*
* $END$
*/
/* $DOC$
* $TEMPLATE$
* Procedure
* $NAME$
* hb_compGenPCodeN()
* $CATEGORY$
* C level API
* $SUBCATEGORY$
* Macro
* $ONELINER$
*
* $SYNTAX$
* C Prototype
*
* #include "hbmacro.h"
* hb_compGenPCodeN( BYTE * pBuffer, ULONG ulSize, HB_BISON_PTR pMacro )
* $ARGUMENTS$
* <pBuffer>
*
* <ulSize>
*
* <pMacro>
* $DESCRIPTION$
*
* $EXAMPLES$
*
* $STATUS$
* R
* $COMPLIANCE$
* NA
* $FILES$
* Library is macro
* $PLATFORMS$
* All
* $SEEALSO$
*
* $END$
*/
/* $DOC$
* $TEMPLATE$
* Function
* $NAME$
* hb_compLocalVarGetPos()
* $CATEGORY$
* C level API
* $SUBCATEGORY$
* Macro
* $ONELINER$
*
* $SYNTAX$
* C Prototype
*
* #include "hbmacro.h"
* hb_compLocalVarGetPos( char * szVarName, HB_BISON_PTR pMacro ) --> ( int )iResult
* $ARGUMENTS$
* <szVarName>
*
* <pMacro>
* $RETURNS$
* <iResult>
* $DESCRIPTION$
*
* $EXAMPLES$
*
* $STATUS$
* R
* $COMPLIANCE$
* NA
* $FILES$
* Library is macro
* $PLATFORMS$
* All
* $SEEALSO$
*
* $END$
*/
/* $DOC$
* $TEMPLATE$
* Function
* $NAME$
* hb_compGenJump()
* $CATEGORY$
* C level API
* $SUBCATEGORY$
* Macro
* $ONELINER$
*
* $SYNTAX$
* C Prototype
*
* #include "hbmacro.h"
* hb_compGenJump( LONG lOffset, HB_BISON_PTR pMacro ) --> ( ULONG )ulResult
* $ARGUMENTS$
* <lOffset>
*
* <pMacro>
* $RETURNS$
* <ulResult>
* $DESCRIPTION$
*
* $EXAMPLES$
*
* $STATUS$
* R
* $COMPLIANCE$
* NA
* $FILES$
* Library is macro
* $PLATFORMS$
* All
* $SEEALSO$
*
* $END$
*/
/* $DOC$
* $TEMPLATE$
* Function
* $NAME$
* hb_compGenJumpFalse()
* $CATEGORY$
* C level API
* $SUBCATEGORY$
* Macro
* $ONELINER$
*
* $SYNTAX$
* C Prototype
*
* #include "hbmacro.h"
* hb_compGenJumpFalse( LONG lOffset, HB_BISON_PTR pMacro ) --> ( ULONG )ulResult
* $ARGUMENTS$
* <lOffset>
*
* <pMacro>
* $RETURNS$
* <ulResult>
* $DESCRIPTION$
*
* $EXAMPLES$
*
* $STATUS$
* R
* $COMPLIANCE$
* NA
* $FILES$
* Library is macro
* $PLATFORMS$
* All
* $SEEALSO$
*
* $END$
*/
/* $DOC$
* $TEMPLATE$
* Procedure
* $NAME$
* hb_compGenJumpThere()
* $CATEGORY$
* C level API
* $SUBCATEGORY$
* Macro
* $ONELINER$
*
* $SYNTAX$
* C Prototype
*
* #include "hbmacro.h"
* hb_compGenJumpThere( ULONG ulFrom, ULONG ulTo, HB_BISON_PTR pMacro )
* $ARGUMENTS$
* <ulFrom>
*
* <ulTo>
*
* <pMacro>
* $DESCRIPTION$
*
* $EXAMPLES$
*
* $STATUS$
* R
* $COMPLIANCE$
* NA
* $FILES$
* Library is macro
* $PLATFORMS$
* All
* $SEEALSO$
*
* $END$
*/
/* $DOC$
* $TEMPLATE$
* Procedure
* $NAME$
* hb_compGenJumpHere()
* $CATEGORY$
* C level API
* $SUBCATEGORY$
* Macro
* $ONELINER$
*
* $SYNTAX$
* C Prototype
*
* #include "hbmacro.h"
* hb_compGenJumpHere( ULONG ulOffset, HB_BISON_PTR pMacro )
* $ARGUMENTS$
* <ulOffset>
*
* <pMacro>
* $DESCRIPTION$
*
* $EXAMPLES$
*
* $STATUS$
* R
* $COMPLIANCE$
* NA
* $FILES$
* Library is macro
* $PLATFORMS$
* All
* $SEEALSO$
*
* $END$
*/
/* $DOC$
* $TEMPLATE$
* Function
* $NAME$
* hb_compGenJumpTrue()
* $CATEGORY$
* C level API
* $SUBCATEGORY$
* Macro
* $ONELINER$
*
* $SYNTAX$
* C Prototype
*
* #include "hbmacro.h"
* hb_compGenJumpTrue( LONG lOffset, HB_BISON_PTR pMacro ) --> ( ULONG )ulResult
* $ARGUMENTS$
* <lOffset>
*
* <pMacro>
* $RETURNS$
* <ulResult>
* $DESCRIPTION$
*
* $EXAMPLES$
*
* $STATUS$
* R
* $COMPLIANCE$
* NA
* $FILES$
* Library is macro
* $PLATFORMS$
* All
* $SEEALSO$
*
* $END$
*/
/* $DOC$
* $TEMPLATE$
* Procedure
* $NAME$
* hb_compMemvarGenPCode()
* $CATEGORY$
* C level API
* $SUBCATEGORY$
* Macro
* $ONELINER$
*
* $SYNTAX$
* C Prototype
*
* #include "hbmacro.h"
* hb_compMemvarGenPCode( BYTE bPCode, char * szVarName, HB_BISON_PTR pMacro )
* $ARGUMENTS$
* <bPCode>
*
* <szVarName>
*
* <pMacro>
* $DESCRIPTION$
*
* $EXAMPLES$
*
* $STATUS$
* R
* $COMPLIANCE$
* NA
* $FILES$
* Library is macro
* $PLATFORMS$
* All
* $SEEALSO$
*
* $END$
*/
/* $DOC$
* $TEMPLATE$
* Procedure
* $NAME$
* hb_compGenPushSymbol()
* $CATEGORY$
* C level API
* $SUBCATEGORY$
* Macro
* $ONELINER$
*
* $SYNTAX$
* C Prototype
*
* #include "hbmacro.h"
* hb_compGenPushSymbol( char * szSymbolName, int isFunction, HB_BISON_PTR pMacro )
* $ARGUMENTS$
* <szSymbolName>
*
* <isFunction>
*
* <pMacro>
* $DESCRIPTION$
*
* $EXAMPLES$
*
* $STATUS$
* R
* $COMPLIANCE$
* NA
* $FILES$
* Library is macro
* $PLATFORMS$
* All
* $SEEALSO$
*
* $END$
*/
/* $DOC$
* $TEMPLATE$
* Procedure
* $NAME$
* hb_compGenPushLong()
* $CATEGORY$
* C level API
* $SUBCATEGORY$
* Macro
* $ONELINER$
*
* $SYNTAX$
* C Prototype
*
* #include "hbmacro.h"
* hb_compGenPushLong( long lNumber, HB_BISON_PTR pMacro )
* $ARGUMENTS$
* <lNumber>
*
* <pMacro>
* $DESCRIPTION$
*
* $EXAMPLES$
*
* $STATUS$
* R
* $COMPLIANCE$
* NA
* $FILES$
* Library is macro
* $PLATFORMS$
* All
* $SEEALSO$
*
* $END$
*/
/* $DOC$
* $TEMPLATE$
* Procedure
* $NAME$
* hb_compGenMessage()
* $CATEGORY$
* C level API
* $SUBCATEGORY$
* Macro
* $ONELINER$
*
* $SYNTAX$
* C Prototype
*
* #include "hbmacro.h"
* hb_compGenMessage( char * szMsgName, HB_BISON_PTR pMacro )
* $ARGUMENTS$
* <szMsgName>
*
* <pMacro>
* $DESCRIPTION$
*
* $EXAMPLES$
*
* $STATUS$
* R
* $COMPLIANCE$
* NA
* $FILES$
* Library is macro
* $PLATFORMS$
* All
* $SEEALSO$
*
* $END$
*/
/* $DOC$
* $TEMPLATE$
* Procedure
* $NAME$
* hb_compGenMessageData()
* $CATEGORY$
* C level API
* $SUBCATEGORY$
* Macro
* $ONELINER$
*
* $SYNTAX$
* C Prototype
*
* #include "hbmacro.h"
* hb_compGenMessageData( char * szMsg, HB_BISON_PTR pMacro )
* $ARGUMENTS$
* <szMsg>
*
* <pMacro>
* $DESCRIPTION$
*
* $EXAMPLES$
*
* $STATUS$
* R
* $COMPLIANCE$
* NA
* $FILES$
* Library is macro
* $PLATFORMS$
* All
* $SEEALSO$
*
* $END$
*/
/* $DOC$
* $TEMPLATE$
* Procedure
* $NAME$
* hb_compGenPopVar()
* $CATEGORY$
* C level API
* $SUBCATEGORY$
* Macro
* $ONELINER$
*
* $SYNTAX$
* C Prototype
*
* #include "hbmacro.h"
* hb_compGenPopVar( char * szVarName, HB_BISON_PTR pMacro )
* $ARGUMENTS$
* <szVarName>
*
* <pMacro>
* $DESCRIPTION$
*
* $EXAMPLES$
*
* $STATUS$
* R
* $COMPLIANCE$
* NA
* $FILES$
* Library is macro
* $PLATFORMS$
* All
* $SEEALSO$
*
* $END$
*/
/* $DOC$
* $TEMPLATE$
* Procedure
* $NAME$
* hb_compGenPopAliasedVar()
* $CATEGORY$
* C level API
* $SUBCATEGORY$
* Macro
* $ONELINER$
*
* $SYNTAX$
* C Prototype
*
* #include "hbmacro.h"
* hb_compGenPopAliasedVar( char * szVarName, HB_BOOL bPushAliasValue, char * szAlias, long lWorkarea, HB_BISON_PTR pMacro )
* $ARGUMENTS$
* <szVarName>
*
* <bPushAliasValue>
*
* <szAlias>
*
* <lWorkarea>
*
* <pMacro>
* $DESCRIPTION$
*
* $EXAMPLES$
*
* $STATUS$
* R
* $COMPLIANCE$
* NA
* $FILES$
* Library is macro
* $PLATFORMS$
* All
* $SEEALSO$
*
* $END$
*/
/* $DOC$
* $TEMPLATE$
* Procedure
* $NAME$
* hb_compGenPushVar()
* $CATEGORY$
* C level API
* $SUBCATEGORY$
* Macro
* $ONELINER$
*
* $SYNTAX$
* C Prototype
*
* #include "hbmacro.h"
* hb_compGenPushVar( char * szVarName, HB_BISON_PTR pMacro )
* $ARGUMENTS$
* <szVarName>
*
* <pMacro>
* $DESCRIPTION$
*
* $EXAMPLES$
*
* $STATUS$
* R
* $COMPLIANCE$
* NA
* $FILES$
* Library is macro
* $PLATFORMS$
* All
* $SEEALSO$
*
* $END$
*/
/* $DOC$
* $TEMPLATE$
* Procedure
* $NAME$
* hb_compGenPushVarRef()
* $CATEGORY$
* C level API
* $SUBCATEGORY$
* Macro
* $ONELINER$
*
* $SYNTAX$
* C Prototype
*
* #include "hbmacro.h"
* hb_compGenPushVarRef( char * szVarName, HB_BISON_PTR pMacro )
* $ARGUMENTS$
* <szVarName>
*
* <pMacro>
* $DESCRIPTION$
*
* $EXAMPLES$
*
* $STATUS$
* R
* $COMPLIANCE$
* NA
* $FILES$
* Library is macro
* $PLATFORMS$
* All
* $SEEALSO$
*
* $END$
*/
/* $DOC$
* $TEMPLATE$
* Procedure
* $NAME$
* hb_compGenPushAliasedVar()
* $CATEGORY$
* C level API
* $SUBCATEGORY$
* Macro
* $ONELINER$
*
* $SYNTAX$
* C Prototype
*
* #include "hbmacro.h"
* hb_compGenPushAliasedVar( char * szVarName, HB_BOOL bPushAliasValue, char * szAlias, long lWorkarea, HB_BISON_PTR pMacro )
* $ARGUMENTS$
* <szVarName>
*
* <bPushAliasValue>
*
* <szAlias>
*
* <lWorkarea>
*
* <pMacro>
* $DESCRIPTION$
*
* $EXAMPLES$
*
* $STATUS$
* R
* $COMPLIANCE$
* NA
* $FILES$
* Library is macro
* $PLATFORMS$
* All
* $SEEALSO$
*
* $END$
*/
/* $DOC$
* $TEMPLATE$
* Procedure
* $NAME$
* hb_compGenPushLogical()
* $CATEGORY$
* C level API
* $SUBCATEGORY$
* Macro
* $ONELINER$
*
* $SYNTAX$
* C Prototype
*
* #include "hbmacro.h"
* hb_compGenPushLogical( int iTrueFalse, HB_BISON_PTR pMacro )
* $ARGUMENTS$
* <iTrueFalse>
*
* <pMacro>
* $DESCRIPTION$
*
* $EXAMPLES$
*
* $STATUS$
* R
* $COMPLIANCE$
* NA
* $FILES$
* Library is macro
* $PLATFORMS$
* All
* $SEEALSO$
*
* $END$
*/
/* $DOC$
* $TEMPLATE$
* Procedure
* $NAME$
* hb_compGenPushDouble()
* $CATEGORY$
* C level API
* $SUBCATEGORY$
* Macro
* $ONELINER$
*
* $SYNTAX$
* C Prototype
*
* #include "hbmacro.h"
* hb_compGenPushDouble( double dNumber, BYTE bWidth, BYTE bDec, HB_BISON_PTR pMacro )
* $ARGUMENTS$
* <dNumber>
*
* <bWidth>
*
* <bDec>
*
* <pMacro>
* $DESCRIPTION$
*
* $EXAMPLES$
*
* $STATUS$
* R
* $COMPLIANCE$
* NA
* $FILES$
* Library is macro
* $PLATFORMS$
* All
* $SEEALSO$
*
* $END$
*/
/* $DOC$
* $TEMPLATE$
* Procedure
* $NAME$
* hb_compGenPushFunCall()
* $CATEGORY$
* C level API
* $SUBCATEGORY$
* Macro
* $ONELINER$
*
* $SYNTAX$
* C Prototype
*
* #include "hbmacro.h"
* hb_compGenPushFunCall( char * szFunName, HB_BISON_PTR pMacro )
* $ARGUMENTS$
* <szFunName>
*
* <pMacro>
* $DESCRIPTION$
*
* $EXAMPLES$
*
* $STATUS$
* R
* $COMPLIANCE$
* NA
* $FILES$
* Library is macro
* $PLATFORMS$
* All
* $SEEALSO$
*
* $END$
*/
/* $DOC$
* $TEMPLATE$
* Procedure
* $NAME$
* hb_compGenPushString()
* $CATEGORY$
* C level API
* $SUBCATEGORY$
* Macro
* $ONELINER$
*
* $SYNTAX$
* C Prototype
*
* #include "hbmacro.h"
* hb_compGenPushString( char * szText, ULONG ulStrLen, HB_BISON_PTR pMacro )
* $ARGUMENTS$
* <szText>
*
* <ulStrLen>
*
* <pMacro>
* $DESCRIPTION$
*
* $EXAMPLES$
*
* $STATUS$
* R
* $COMPLIANCE$
* NA
* $FILES$
* Library is macro
* $PLATFORMS$
* All
* $SEEALSO$
*
* $END$
*/
/* $DOC$
* $TEMPLATE$
* Procedure
* $NAME$
* hb_compCodeBlockStart()
* $CATEGORY$
* C level API
* $SUBCATEGORY$
* Macro
* $ONELINER$
*
* $SYNTAX$
* C Prototype
*
* #include "hbmacro.h"
* hb_compCodeBlockStart( HB_BISON_PTR pMacro )
* $ARGUMENTS$
* <pMacro>
* $DESCRIPTION$
*
* $EXAMPLES$
*
* $STATUS$
* R
* $COMPLIANCE$
* NA
* $FILES$
* Library is macro
* $PLATFORMS$
* All
* $SEEALSO$
*
* $END$
*/
/* $DOC$
* $TEMPLATE$
* Procedure
* $NAME$
* hb_compCodeBlockEnd()
* $CATEGORY$
* C level API
* $SUBCATEGORY$
* Macro
* $ONELINER$
*
* $SYNTAX$
* C Prototype
*
* #include "hbmacro.h"
* hb_compCodeBlockEnd( HB_BISON_PTR pMacro )
* $ARGUMENTS$
* <pMacro>
* $DESCRIPTION$
*
* $EXAMPLES$
*
* $STATUS$
* R
* $COMPLIANCE$
* NA
* $FILES$
* Library is macro
* $PLATFORMS$
* All
* $SEEALSO$
*
* $END$
*/