/*
 * $Id: hbapiitm.h,v 1.34 2004/04/20 14:33:08 jacekp Exp $
 */

/*
 * Harbour Project source code:
 * Header file for the Item API
 *
 * Copyright 1999 Antonio Linares <alinares@fivetech.com>
 * 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.
 *
 */

#ifndef HB_APIITM_H_
#define HB_APIITM_H_

#include "hbapi.h"

HB_EXTERN_BEGIN

#define HB_EVAL_PARAM_MAX_ 9

typedef struct
{
   USHORT   paramCount;
   PHB_ITEM pItems[ HB_EVAL_PARAM_MAX_ + 1 ];
} EVALINFO, * PEVALINFO, * EVALINFO_PTR;

extern PHB_ITEM HB_EXPORT hb_evalLaunch   ( PEVALINFO pEvalInfo );
extern BOOL     HB_EXPORT hb_evalNew      ( PEVALINFO pEvalInfo, PHB_ITEM pItem );
extern BOOL     HB_EXPORT hb_evalPutParam ( PEVALINFO pEvalInfo, PHB_ITEM pItem );
extern BOOL     HB_EXPORT hb_evalRelease  ( PEVALINFO pEvalInfo );

extern PHB_ITEM HB_EXPORT hb_itemDo       ( PHB_ITEM pItem, ULONG ulPCount, ... );
extern PHB_ITEM HB_EXPORT hb_itemDoC      ( char * szFunc, ULONG ulPCount, ... );

extern PHB_ITEM HB_EXPORT hb_itemArrayGet     ( PHB_ITEM pArray, ULONG ulIndex );
extern PHB_ITEM HB_EXPORT hb_itemArrayNew     ( ULONG ulLen );
extern PHB_ITEM HB_EXPORT hb_itemArrayPut     ( PHB_ITEM pArray, ULONG ulIndex, PHB_ITEM pItem );
extern ULONG    HB_EXPORT hb_itemCopyC        ( PHB_ITEM pItem, char * szBuffer, ULONG ulLen );
extern BOOL     HB_EXPORT hb_itemFreeC        ( char * szText );
extern char     HB_EXPORT *hb_itemGetC         ( PHB_ITEM pItem );
extern char     HB_EXPORT * hb_itemGetCPtr      ( PHB_ITEM pItem );
extern ULONG    HB_EXPORT hb_itemGetCLen      ( PHB_ITEM pItem );
extern char     HB_EXPORT * hb_itemGetDS        ( PHB_ITEM pItem, char * szDate );
extern LONG     HB_EXPORT hb_itemGetDL        ( PHB_ITEM pItem );
extern BOOL     HB_EXPORT hb_itemGetL         ( PHB_ITEM pItem );
extern double   HB_EXPORT hb_itemGetND        ( PHB_ITEM pItem );
extern int      HB_EXPORT hb_itemGetNI        ( PHB_ITEM pItem );
extern LONG     HB_EXPORT hb_itemGetNL        ( PHB_ITEM pItem );
extern void     HB_EXPORT hb_itemGetNLen      ( PHB_ITEM pItem, int * piWidth, int * piDec );
extern void     HB_EXPORT * hb_itemGetPtr       ( PHB_ITEM pItem );
extern PHB_ITEM HB_EXPORT hb_itemNew          ( PHB_ITEM pNull );
extern USHORT   HB_EXPORT hb_itemPCount       ( void );
extern PHB_ITEM HB_EXPORT hb_itemParam        ( USHORT uiParam );
#if 0
extern HB_ITEM  HB_EXPORT hb_itemParamStack   ( USHORT uiParam ) ;
#endif
extern PHB_ITEM HB_EXPORT hb_itemPutC         ( PHB_ITEM pItem, char * szText );
extern PHB_ITEM HB_EXPORT hb_itemPutCPtr      ( PHB_ITEM pItem, char * szText, ULONG ulLen );
extern PHB_ITEM HB_EXPORT hb_itemPutCRaw      ( PHB_ITEM pItem, char * szText, ULONG ulLen );
extern PHB_ITEM HB_EXPORT hb_itemPutCRawStatic( PHB_ITEM pItem, char * szText, ULONG ulLen );
extern PHB_ITEM HB_EXPORT hb_itemPutCL        ( PHB_ITEM pItem, char * szText, ULONG ulLen );
extern void     HB_EXPORT hb_itemSetCMemo     ( PHB_ITEM pItem );
extern PHB_ITEM HB_EXPORT hb_itemPutD         ( PHB_ITEM pItem, LONG lYear, LONG lMonth, LONG lDay );
extern PHB_ITEM HB_EXPORT hb_itemPutDS        ( PHB_ITEM pItem, char * szDate );
extern PHB_ITEM HB_EXPORT hb_itemPutDL        ( PHB_ITEM pItem, LONG lJulian );
extern PHB_ITEM HB_EXPORT hb_itemPutL         ( PHB_ITEM pItem, BOOL bValue );
extern PHB_ITEM HB_EXPORT hb_itemPutND        ( PHB_ITEM pItem, double dNumber );
extern PHB_ITEM HB_EXPORT hb_itemPutNI        ( PHB_ITEM pItem, int iNumber );
extern PHB_ITEM HB_EXPORT hb_itemPutNL        ( PHB_ITEM pItem, LONG lNumber );
extern PHB_ITEM HB_EXPORT hb_itemPutNLen      ( PHB_ITEM pItem, double dNumber, int iWidth, int iDec );
extern PHB_ITEM HB_EXPORT hb_itemPutNDLen     ( PHB_ITEM pItem, double dNumber, int iWidth, int iDec );
extern PHB_ITEM HB_EXPORT hb_itemPutNILen     ( PHB_ITEM pItem, int iNumber, int iWidth );
extern PHB_ITEM HB_EXPORT hb_itemPutNLLen     ( PHB_ITEM pItem, LONG lNumber, int iWidth );
extern PHB_ITEM HB_EXPORT hb_itemPutPtr       ( PHB_ITEM pItem, void * pValue );
extern PHB_ITEM HB_EXPORT hb_itemPutPtrGC     ( PHB_ITEM pItem, void * pValue );
extern BOOL     HB_EXPORT hb_itemRelease      ( PHB_ITEM pItem );
extern PHB_ITEM HB_EXPORT hb_itemReturn       ( PHB_ITEM pItem );
extern PHB_ITEM HB_EXPORT hb_itemReturnCopy   ( PHB_ITEM pItem );
extern ULONG    HB_EXPORT hb_itemSize         ( PHB_ITEM pItem );
extern USHORT   HB_EXPORT hb_itemType         ( PHB_ITEM pItem );
extern char     HB_EXPORT * hb_itemTypeStr    ( PHB_ITEM pItem );

/* LONGLONG supports */
#ifndef HB_LONG_LONG_OFF
extern LONGLONG HB_EXPORT hb_itemGetNLL       ( PHB_ITEM pItem );
extern PHB_ITEM HB_EXPORT hb_itemPutNLL       ( PHB_ITEM pItem, LONGLONG llNumber );
extern PHB_ITEM HB_EXPORT hb_itemPutNLLLen    ( PHB_ITEM pItem, LONGLONG llNumber, int iWidth);
extern PHB_ITEM HB_EXPORT hb_itemPutNInt      ( PHB_ITEM pItem, LONGLONG lNumber );
extern PHB_ITEM HB_EXPORT hb_itemPutNIntLen   ( PHB_ITEM pItem, LONGLONG lNumber, int iWidth );
#else
extern PHB_ITEM HB_EXPORT hb_itemPutNInt      ( PHB_ITEM pItem, LONG lNumber );
extern PHB_ITEM HB_EXPORT hb_itemPutNIntLen   ( PHB_ITEM pItem, LONG lNumber, int iWidth );
#endif

/* Non Clipper compliant internal API */

extern PHB_ITEM HB_EXPORT hb_itemParamPtr ( USHORT uiParam, int iMask );
extern int      HB_EXPORT hb_itemStrCmp   ( PHB_ITEM pFirst, PHB_ITEM pSecond, BOOL bForceExact ); /* our string compare */
extern int      HB_EXPORT hb_itemStrCmpIgnore ( PHB_ITEM pFirst, PHB_ITEM pSecond, BOOL bForceExact ); /* our string compare */
extern void     HB_EXPORT hb_itemCopy     ( PHB_ITEM pDest, PHB_ITEM pSource );
extern void     HB_EXPORT hb_itemClear    ( PHB_ITEM pItem );
extern PHB_ITEM HB_EXPORT hb_itemUnRef    ( PHB_ITEM pItem ); /* de-references passed variable */
extern PHB_ITEM HB_EXPORT hb_itemUnRefOnce( PHB_ITEM pItem ); /* de-references passed variable, one step*/
extern char     HB_EXPORT * hb_itemStr      ( PHB_ITEM pNumber, PHB_ITEM pWidth, PHB_ITEM pDec ); /* convert a number to a string */
extern char     HB_EXPORT * hb_itemString   ( PHB_ITEM pItem, ULONG * ulLen, BOOL * bFreeReq );  /* Convert any scalar to a string */
extern BOOL     HB_EXPORT hb_itemStrBuf   ( char *szResult, PHB_ITEM pNumber, int iSize, int iDec ); /* convert a number to a string */
extern PHB_ITEM HB_EXPORT hb_itemValToStr ( PHB_ITEM pItem ); /* Convert any scalar to a string */
extern char     HB_EXPORT * hb_itemPadConv  ( PHB_ITEM pItem, ULONG * pulSize, BOOL * bFreeReq ); /* Convert item to a string for PAD* functions */
extern void     HB_EXPORT hb_itemSwap     ( PHB_ITEM pItem1, PHB_ITEM pItem2 );

HB_EXTERN_END

#endif /* HB_APIITM_H_ */
