sl@0: // Copyright (c) 2006-2010 Nokia Corporation and/or its subsidiary(-ies).
sl@0: // All rights reserved.
sl@0: // This component and the accompanying materials are made available
sl@0: // under the terms of "Eclipse Public License v1.0"
sl@0: // which accompanies this distribution, and is available
sl@0: // at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: //
sl@0: // Initial Contributors:
sl@0: // Nokia Corporation - initial contribution.
sl@0: //
sl@0: // Contributors:
sl@0: //
sl@0: // Description:
sl@0: // ///////////////                HSqlSrvStmtParamBuf                        ////////////////////////////
sl@0: // 
sl@0: //
sl@0: 
sl@0: /**
sl@0:  
sl@0:  Creates a new HSqlSrvStmtParamBuf instance.
sl@0:  
sl@0:  @param aStatement A reference to the CSqlSrvStatement object, which needs the parameter data.
sl@0:  @param aParamIndex Parameter index, zero based.
sl@0:  @param aDataType Parameter value type - binary, text8 or text16.
sl@0:  @param aBufType IPC stream buffer or a simple "bind param" buffer
sl@0:  
sl@0:  @return A pointer to the created HSqlSrvStmtParamBuf instance.
sl@0:  
sl@0:  @leave KErrNoMemory, an out of memory condition has occurred;
sl@0:  
sl@0:  @panic SqlDb 4 In _DEBUG mode. Parameter index negative.
sl@0: */
sl@0: inline HSqlSrvStmtParamBuf* HSqlSrvStmtParamBuf::NewL(CSqlSrvStatement& aStatement, TInt aParamIndex, 
sl@0: 													  HSqlSrvStmtParamBuf::TDataType aDataType, HSqlSrvStmtParamBuf::TBufType aBufType)
sl@0: 	{
sl@0: 	__ASSERT_DEBUG(aParamIndex >= 0, __SQLPANIC2(ESqlPanicBadArgument));
sl@0: 	HSqlSrvStmtParamBuf* self = new (ELeave) HSqlSrvStmtParamBuf(aStatement, aParamIndex, aDataType, aBufType);
sl@0: 	self->PushL();
sl@0: 	self->ConstructL();
sl@0: 	CleanupStack::Pop();
sl@0: 	return self;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Resets the current HSqlSrvStmtParamBuf instance.
sl@0: 
sl@0: The internal buffer will be resized, if its capacity is bigger than HSqlSrvStmtParamBuf::EExpandSize * 2 bytes.
sl@0: 
sl@0: @param aDataType Parameter value type - binary, text8 or text16.
sl@0: @param aBufType IPC stream buffer or a simple "bind param" buffer
sl@0: 
sl@0: @panic SqlDb 2 In _DEBUG mode. Invalid HSqlSrvStmtParamBuf object.
sl@0: */
sl@0: inline void HSqlSrvStmtParamBuf::Reset(HSqlSrvStmtParamBuf::TDataType aDataType, HSqlSrvStmtParamBuf::TBufType aBufType)
sl@0: 	{
sl@0: 	__ASSERT_DEBUG(iBuf != NULL, __SQLPANIC(ESqlPanicInvalidObj));
sl@0: 	
sl@0: 	iStatementFinalized = EFalse;
sl@0: 	iAlive = ETrue;
sl@0: 	iDataType = aDataType;
sl@0: 	iBufType = aBufType;
sl@0: 	iSynchDone = EFalse;
sl@0: 	
sl@0: 	iBuf->Delete(0, iBuf->Size());
sl@0: 	if(iBuf->Capacity() > (HSqlSrvStmtParamBuf::EExpandSize * 2))
sl@0: 		{
sl@0: 		TRAPD(err, iBuf->SetReserveL(HSqlSrvStmtParamBuf::EExpandSize * 2));//the buffer size is minimized, the call can't fail
sl@0: 		__ASSERT_ALWAYS(err == KErrNone, __SQLPANIC(ESqlPanicInternalError));
sl@0: 		}
sl@0: 	Set(*iBuf, 0, MStreamBuf::ERead | MStreamBuf::EWrite);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Stores the aData into the buffer, from position 0.
sl@0: This function is used when the buffer type is not IPC.
sl@0: 
sl@0: @param aData The data to be stored into the buffer
sl@0: 
sl@0: @leave KErrNoMemory, an out of memory condition has occurred;
sl@0: 
sl@0: @panic SqlDb 2 In _DEBUG mode. Invalid HSqlSrvStmtParamBuf object.
sl@0: @panic SqlDb 7 In _DEBUG mode. The buffer type is not HSqlSrvStmtParamBuf::EBufSimpleBind
sl@0: */
sl@0: inline const TPtrC8 HSqlSrvStmtParamBuf::SetDataL(const TDesC8& aData)
sl@0: 	{
sl@0: 	__ASSERT_DEBUG(iBuf != NULL, __SQLPANIC(ESqlPanicInvalidObj));
sl@0: 	__ASSERT_DEBUG(iBufType == HSqlSrvStmtParamBuf::EBufSimpleBind, __SQLPANIC(ESqlPanicInternalError));
sl@0: 	iBuf->ResizeL(aData.Length());
sl@0: 	iBuf->Write(0, aData);
sl@0: 	//If the size is 0, then return KNullDesC8, where an empty string is hold, not a null one ("" instead of NULL)
sl@0: 	// was return iBuf->Size() == 0 ? KNullDesC8() : iBuf->Ptr(0);
sl@0: 	if (iBuf->Size() == 0)
sl@0: 		{
sl@0: 		return KNullDesC8();
sl@0: 		}
sl@0: 	return iBuf->Ptr(0);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Returns a 8-bit pointer to the parameter data.
sl@0: 
sl@0: @return 8-bit pointer to the parameter data.
sl@0: 
sl@0: @panic SqlDb 2 In _DEBUG mode. Invalid HSqlSrvStmtParamBuf object.
sl@0: */
sl@0: inline const TPtrC8 HSqlSrvStmtParamBuf::Data() const
sl@0: 	{
sl@0: 	__ASSERT_DEBUG(iBuf != NULL, __SQLPANIC(ESqlPanicInvalidObj));
sl@0: 	//If the size is 0, then return KNullDesC8, where an empty string is hold, not a null one ("" instead of NULL)
sl@0: 	// was return iBuf->Size() == 0 ? KNullDesC8() : iBuf->Ptr(0);
sl@0: 	if (iBuf->Size() == 0)
sl@0: 		{
sl@0: 		return KNullDesC8();
sl@0: 		}
sl@0: 	return iBuf->Ptr(0);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: @return Buffered parameter value type - binary, text8 or text16.
sl@0: */
sl@0: inline HSqlSrvStmtParamBuf::TDataType HSqlSrvStmtParamBuf::DataType() const
sl@0: 	{
sl@0: 	return iDataType;		
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Returns the parameter index.
sl@0: 
sl@0: @panic SqlDb 7 In _DEBUG mode. Negative parameter index.
sl@0: 
sl@0: @return Parameter index, zero based.
sl@0: */
sl@0: inline TInt HSqlSrvStmtParamBuf::ParamIndex() const
sl@0: 	{
sl@0: 	__ASSERT_DEBUG(iParamIndex >= 0, __SQLPANIC(ESqlPanicInternalError));
sl@0: 	return iParamIndex;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Initializes the HSqlSrvStmtParamBuf instance data members.
sl@0: 
sl@0: @param aStatement A reference to the CSqlSrvStatement object, which needs the parameter data.
sl@0: @param aParameterIndex Parameter index, zero based.
sl@0: @param aDataType Parameter value type - binary, text8 or text16.
sl@0: @param aBufType IPC stream buffer or a simple "bind param" buffer
sl@0: */
sl@0: inline HSqlSrvStmtParamBuf::HSqlSrvStmtParamBuf(CSqlSrvStatement& aStatement, TInt aParamIndex, 
sl@0: 												HSqlSrvStmtParamBuf::TDataType aDataType, HSqlSrvStmtParamBuf::TBufType aBufType) :
sl@0: 	iStatement(aStatement),
sl@0: 	iBuf(NULL),
sl@0: 	iParamIndex(aParamIndex),
sl@0: 	iStatementFinalized(EFalse),
sl@0: 	iAlive(EFalse),
sl@0: 	iDataType(aDataType),
sl@0: 	iBufType(aBufType),
sl@0: 	iSynchDone(EFalse)
sl@0: 	{
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: HSqlSrvStmtParamBuf - second phase construction.
sl@0: Constructs the internal CFlatBuf object.
sl@0: 
sl@0: @leave KErrNoMemory, an out of memory condition has occurred;
sl@0: */
sl@0: inline void HSqlSrvStmtParamBuf::ConstructL()
sl@0: 	{
sl@0: 	iBuf = CBufFlat::NewL(EExpandSize);
sl@0: 	Set(*iBuf, 0, MStreamBuf::ERead | MStreamBuf::EWrite);
sl@0: 	iAlive = ETrue;
sl@0: 	}
sl@0: 
sl@0: //////////////////////////////////////////////////////////////////////////////////////////////////////
sl@0: /////////////////////////////   CSqlSrvStatement class    ////////////////////////////////////////////
sl@0: //////////////////////////////////////////////////////////////////////////////////////////////////////
sl@0: 
sl@0: /**
sl@0: Executes the SQL statement moving the cursor to the next row if there is a row available.
sl@0: 
sl@0: @return KSqlErrStmtExpired, statement expired (if new functions or collating sequences are 
sl@0: 							registered or if an authorizer function is added or changed);
sl@0: 		KErrNone, the operation completed successfully;
sl@0: 		KSqlAtRow, the next record data is ready for processing by the caller;
sl@0: 		KSqlAtEnd, no more records;
sl@0: 		KSqlErrBusy, database file is locked;
sl@0: 		KSqlErrGeneral, run-time error. Next() should not be called anymore;
sl@0: 		KSqlErrMisuse, Next() called after KSqlAtEnd or KSqlErrGeneral returned by the previous Next() call;
sl@0: 		KErrNoMemory, an out of memory condition has occurred. The statement will be reset.
sl@0: 
sl@0: @panic SqlDb 2 In _DEBUG mode. Invalid (not created) CSqlSrvStatement object.
sl@0: @panic SqlDb 7 In _DEBUG mode. SQLITE internal error. (SQLITE_ERROR, followed by a sqlite3_reset(), which returns SQLITE_OK)
sl@0: */	
sl@0: inline TInt CSqlSrvStatement::Next()
sl@0: 	{
sl@0: 	__ASSERT_DEBUG(iStmtHandle != NULL, __SQLPANIC(ESqlPanicInvalidObj));
sl@0: 	TInt err = ::StmtNext(iStmtHandle);
sl@0: 	iBufFlatType = static_cast <TSqlBufFlatType> (-1);
sl@0: 	iBufFlat.ResetAndMinimize();
sl@0: 	return err;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Resets the prepared SQL statement to its initial state and makes it ready to be executed again.
sl@0: 
sl@0: Any SQL statement parameters that had values bound to them, retain their values.
sl@0: 
sl@0: @return KErrNone,  the operation completed successfully;
sl@0: 		KSqlErrStmtExpired, Statement expired (if new functions or collating sequences are 
sl@0: 							registered or if an authorizer function is added or changed)
sl@0: 
sl@0: @panic SqlDb 2 In _DEBUG mode. Invalid (not created) CSqlSrvStatement object.
sl@0: */	
sl@0: inline TInt CSqlSrvStatement::Reset()
sl@0: 	{
sl@0: 	__ASSERT_DEBUG(iStmtHandle != NULL, __SQLPANIC(ESqlPanicInvalidObj));
sl@0: 	iBufFlatType = static_cast <TSqlBufFlatType> (-1);
sl@0: 	iBufFlat.ResetAndMinimize();
sl@0: 	return ::StmtReset(iStmtHandle);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Executes the prepared SQL statement.
sl@0: 
sl@0: @return KErrNone, the operation completed successfully;
sl@0: 		KSqlErrStmtExpired, statement expired (if new functions or collating sequences are 
sl@0: 							registered or if an authorizer function is added or changed);
sl@0: 		KErrNoMemory, an out of memory condition has occurred. The statement will be reset.
sl@0: 
sl@0: @panic SqlDb 2 In _DEBUG mode. Invalid (not created) CSqlSrvStatement object.
sl@0: @panic SqlDb 7 In _DEBUG mode. SQLITE internal error. (SQLITE_ERROR, followed by a sqlite3_reset(), which returns SQLITE_OK)
sl@0: */	
sl@0: inline TInt CSqlSrvStatement::Exec()
sl@0: 	{
sl@0: 	__ASSERT_DEBUG(iStmtHandle != NULL, __SQLPANIC(ESqlPanicInvalidObj));
sl@0: 	TInt err = ::StmtExec(iStmtHandle);
sl@0: 	iBufFlatType = static_cast <TSqlBufFlatType> (-1);
sl@0: 	iBufFlat.ResetAndMinimize();
sl@0: 	return err;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: @panic SqlDb 2 In _DEBUG mode. Invalid (not created) CSqlSrvStatement object.
sl@0: */
sl@0: inline const RSqlBufFlat& CSqlSrvStatement::BufFlatL(TSqlBufFlatType aWhat) const
sl@0: 	{
sl@0: 	__ASSERT_DEBUG(iStmtHandle != NULL, __SQLPANIC(ESqlPanicInvalidObj));
sl@0: 	if(aWhat != iBufFlatType)
sl@0: 		{
sl@0: 		__SQLLEAVE(KErrArgument);
sl@0: 		}
sl@0: 	return iBufFlat;
sl@0: 	}
sl@0: 			
sl@0: /**
sl@0: */	
sl@0: inline CSqlSrvStatement::CSqlSrvStatement()
sl@0: 	{
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Initializes CSqlSrvStatement instance.
sl@0: 
sl@0: @param aDbHandle The database handle
sl@0: @param aSqlStmt 16-bit SQL statement, zero-terminated string
sl@0: 
sl@0: @leave KErrNoMemory, an out of memory condition has occurred;
sl@0: 	   KErrArgument, bad argument, for example - the SQL string contains more than one SQL statements;
sl@0:                   Note that the function may also leave with some other database specific 
sl@0:                   errors categorised as ESqlDbError.
sl@0: 
sl@0: @panic SqlDb 4 In _DEBUG mode. aDbHandle is NULL.
sl@0: */	
sl@0: inline void CSqlSrvStatement::ConstructL(sqlite3* aDbHandle, const TDesC16& aSqlStmt)
sl@0: 	{
sl@0: 	__ASSERT_DEBUG(aDbHandle != NULL, __SQLPANIC(ESqlPanicBadArgument));
sl@0: 	iStmtHandle = ::StmtPrepare16L(aDbHandle, aSqlStmt);
sl@0: 	DoCommonConstructL();
sl@0: 	}
sl@0: 	
sl@0: /**
sl@0: Initializes CSqlSrvStatement instance.
sl@0: 
sl@0: @param aDbHandle The database handle
sl@0: @param aSqlStmt 8-bit SQL statement, zero-terminated string
sl@0: 
sl@0: @leave KErrNoMemory, an out of memory condition has occurred;
sl@0: 	   KErrArgument, bad argument, for example - the SQL string contains more than one SQL statements;
sl@0:                   Note that the function may also leave with some other database specific 
sl@0:                   errors categorised as ESqlDbError.
sl@0: 
sl@0: @panic SqlDb 4 In _DEBUG mode. aDbHandle is NULL.
sl@0: */	
sl@0: inline void CSqlSrvStatement::ConstructL(sqlite3* aDbHandle, const TDesC8& aSqlStmt)
sl@0: 	{
sl@0: 	__ASSERT_DEBUG(aDbHandle != NULL, __SQLPANIC(ESqlPanicBadArgument));
sl@0: 	iStmtHandle = ::StmtPrepare8L(aDbHandle, aSqlStmt);
sl@0: 	DoCommonConstructL();
sl@0: 	}