sl@0: // Copyright (c) 1998-2009 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: // SQL parsing engine
sl@0: // 
sl@0: //
sl@0: 
sl@0: #ifndef __D32SQL_H__
sl@0: #define __D32SQL_H__
sl@0: 
sl@0: #ifndef __D32DBMS_H__
sl@0: #include <d32dbms.h>
sl@0: #endif
sl@0: 
sl@0: // Other class referenced
sl@0: class MStreamBuf;
sl@0: class TDbBlob;
sl@0: class RDbTableRow;
sl@0: class TTextOps;
sl@0: class TSqlParser;
sl@0: class CDbTable;
sl@0: class CDbTableDatabase;
sl@0: class CDbDataSource;
sl@0: class CDbBlobSpace;
sl@0: template <class T,class D> class HMatcherPattern;
sl@0: 
sl@0: // Classes defined
sl@0: class Sql;
sl@0: class RSqlLiteral;
sl@0: class CSqlValues;
sl@0: class RSqlColumnList;
sl@0: class CSqlSearchCondition;
sl@0: class CSqlMultiNode;
sl@0: class CSqlBoundNode;
sl@0: class CSqlNullPredicate;
sl@0: class CSqlLiteralNode;
sl@0: class CSqlCompPredicate;
sl@0: class CSqlLikePredicate;
sl@0: class CSqlQuery;
sl@0: class CSqlDDLStatement;
sl@0: class CSqlDMLStatement;
sl@0: class CSqlInsertStatement;
sl@0: class CSqlModifyStatement;
sl@0: 
sl@0: /**
sl@0: @internalComponent
sl@0: */
sl@0: typedef HMatcherPattern<TUint8,TDesC8> HMatcherPattern8;
sl@0: typedef HMatcherPattern<TUint16,TDesC16> HMatcherPattern16;
sl@0: 
sl@0: /**
sl@0: @internalComponent
sl@0: */
sl@0: class Sql
sl@0: 	{
sl@0: public:
sl@0: 	enum TStatementType { ENone, EDDL, EDML };
sl@0: public:
sl@0: 	static CSqlDDLStatement* ParseDDLStatementLC( const TDesC& aSql );
sl@0: 	static CSqlDMLStatement* ParseDMLStatementLC( const TDesC& aSql );
sl@0: 	static CSqlQuery* ParseQueryLC( const TDesC& aSql );
sl@0: 	static CSqlSearchCondition* ParseSearchConditionLC( const TDesC& aSql );
sl@0: 	//
sl@0: 	static TStatementType Type( const TDesC& aSql );
sl@0: 	};
sl@0: 
sl@0: // variant data classes
sl@0: 
sl@0: /**
sl@0: @internalComponent
sl@0: */
sl@0: class RSqlLiteral
sl@0: 	{
sl@0: public:
sl@0: 	inline RSqlLiteral();
sl@0: 	void Close();
sl@0: // assignment
sl@0: 	inline void SetText( const TText* aPtr, const TText* aEnd );
sl@0: 	inline TInt64& SetInt();
sl@0: 	inline TReal64& SetReal();
sl@0: 	inline TTime& SetTime();
sl@0: // conversions
sl@0: 	void ToInt32L();
sl@0: 	void ToUint32L();
sl@0: 	void ToInt64L();
sl@0: 	void ToReal32L();
sl@0: 	void ToReal64L();
sl@0: 	void ToTimeL();
sl@0: 	void ToText8L();
sl@0: 	void ToText16L();
sl@0: 	void ToPattern8L(TBool aEscape = EFalse);
sl@0: 	void ToPattern16L(TBool aEscape = EFalse);
sl@0: 	TInt CopyText();
sl@0: // accessors
sl@0: 	inline TBool IsNull() const;
sl@0: 	inline TInt32 Int32() const;
sl@0: 	inline TUint32 Uint32() const;
sl@0: 	inline const TInt64& Int64() const;
sl@0: 	inline const TTime& Time() const;
sl@0: 	inline const TReal32& Real32() const;
sl@0: 	inline const TReal64& Real64() const;
sl@0: 	inline const TText* Ptr() const;
sl@0: 	inline const TText* End() const;
sl@0: 	inline const TPtrC DesC() const;
sl@0: 	inline const HBufC8& Text8() const;
sl@0: 	inline const HBufC16& Text16() const;
sl@0: 	inline const HMatcherPattern8& Pattern8() const;
sl@0: 	inline const HMatcherPattern16& Pattern16() const;
sl@0: private:
sl@0: 	inline TBool IsBasic() const;
sl@0: 	inline TBool IsAlloc() const;
sl@0: private:
sl@0: 	enum TType { EInt32, EUint32, EReal32, EInt64, ETime, EReal64, EPtr, ENull, EBuf8, EBuf16, EPattern8, EPattern16 };
sl@0: private:
sl@0: 	union
sl@0: 		{
sl@0: 		TInt32 iInt32;
sl@0: 		TUint32 iUint32;
sl@0: 		TUnion<TInt64> iInt64;
sl@0: 		TReal32 iReal32;
sl@0: 		TReal64 iReal64;
sl@0: 		TUnion<TTime> iTime;
sl@0: 		struct { const TText* iPtr; const TText* iEnd; } iPtr;
sl@0: 		TAny* iAlloc;
sl@0: 		} iVal;
sl@0: 	TType iType;
sl@0: 	HBufC* iBuffer;
sl@0: 	};
sl@0: 
sl@0: /**
sl@0: @internalComponent
sl@0: */
sl@0: NONSHARABLE_CLASS(CSqlValues) : public CBase
sl@0: 	{
sl@0: public:
sl@0: 	CSqlValues();
sl@0: 	~CSqlValues();
sl@0: //
sl@0: 	void AddL( const RSqlLiteral& aLiteral );
sl@0: 	void BindL( const CDbDataSource& aSource );
sl@0: 	void WriteL( CDbDataSource& aSource, CDbTable& aTable ) const;
sl@0: private:
sl@0: 	enum { EGranularity = 8 };
sl@0: 	class TEntry
sl@0: 		{
sl@0: 	public:
sl@0: 		inline TEntry( const RSqlLiteral& aValue );
sl@0: 	public:
sl@0: 		RSqlLiteral iValue;
sl@0: 		TDbColType iType;
sl@0: 		};
sl@0: private:
sl@0: 	RArray<TEntry> iValues;
sl@0: 	};
sl@0: 
sl@0: /**
sl@0: @internalComponent
sl@0: */
sl@0: class RSqlColumnList : public RArray<TPtrC>
sl@0: 	{
sl@0: 	enum { EGranularity = 8 };
sl@0: public:
sl@0: 	inline RSqlColumnList();
sl@0: 	};
sl@0: 
sl@0: // evaluation tree classes
sl@0: 
sl@0: /**
sl@0: @internalComponent
sl@0: */
sl@0: class CSqlSearchCondition : public CBase
sl@0: 	{
sl@0: public:
sl@0: 	enum TType
sl@0: 		{
sl@0: 		EAnd, EOr,
sl@0: 		EIsNull, EIsNotNull,
sl@0: 		ELike, ENotLike,
sl@0: 		ELess, ELessEqual, EEqual, EGreaterEqual, EGreater, ENotEqual
sl@0: 		};
sl@0: public:
sl@0: 
sl@0: 	TBool iIsEscape; 
sl@0: 	
sl@0: 	inline TType NodeType() const;
sl@0: 	inline CSqlMultiNode* MultiNode();
sl@0: 	inline CSqlNullPredicate* NullPredicate();
sl@0: 	inline CSqlCompPredicate* CompPredicate();
sl@0: 	inline CSqlLikePredicate* LikePredicate();
sl@0: //
sl@0: 	virtual void BindL( const RDbTableRow& aSource ) = 0;
sl@0: 	virtual TBool EvaluateL( const TTextOps& aTextOp ) const = 0;
sl@0: protected:
sl@0: 	CSqlSearchCondition( TType aType );
sl@0: 		
sl@0: private:
sl@0: 	TType iType;
sl@0: 	
sl@0: 	};
sl@0: 
sl@0: /**
sl@0: @internalComponent
sl@0: */
sl@0: NONSHARABLE_CLASS(CSqlMultiNode) : public CSqlSearchCondition
sl@0: 	{
sl@0: private:
sl@0: 	typedef CSqlSearchCondition* TEntry;
sl@0: 	enum { EGranularity = 4 * sizeof( TEntry ) };
sl@0: public:
sl@0: 	static CSqlSearchCondition* New( TType aType, CSqlSearchCondition* aLeft, CSqlSearchCondition* aRight );
sl@0: //
sl@0: 	inline TInt Count() const;
sl@0: 	inline CSqlSearchCondition* SubNode( TInt aIndex ) const;
sl@0: 	inline void SetSubNode( TInt aIndex, CSqlSearchCondition* aSearchCondition ); 
sl@0: 	void Remove( CSqlSearchCondition* aSubNode );
sl@0: 	static CSqlSearchCondition* Reduce( CSqlMultiNode* aNode );
sl@0: private:
sl@0: 	inline CSqlMultiNode( TType aType );
sl@0: 	~CSqlMultiNode();
sl@0: 	static CSqlMultiNode* New( TType aType, TInt aSize );
sl@0: 	static CSqlMultiNode* Grow( CSqlMultiNode* aNode, TInt aExtraSize );
sl@0: 	static CSqlMultiNode* Concatenate( CSqlMultiNode* aLeft, CSqlMultiNode* aRight );
sl@0: //
sl@0: 	inline TInt Size() const;
sl@0: 	static inline TInt Size( TInt aLeaves );
sl@0: 	inline TBool IsFull() const;
sl@0: private:
sl@0: // from CSqlSearchCondition
sl@0: 	void BindL( const RDbTableRow& aSource );
sl@0: 	TBool EvaluateL( const TTextOps& aTextOp ) const;
sl@0: private:
sl@0: 	TEntry* iEnd;
sl@0: 	TEntry iLeaves[1];
sl@0: 	};
sl@0: 
sl@0: /**
sl@0: @internalComponent
sl@0: */
sl@0: NONSHARABLE_CLASS(CSqlBoundNode) : public CSqlSearchCondition
sl@0: 	{
sl@0: public:
sl@0: 	const TDesC& ColumnName() const;
sl@0: 	inline TDbColNo ColNo() const;
sl@0: 	inline TDbColType ColType() const;
sl@0: protected:
sl@0: 	CSqlBoundNode( TType aType, const TDesC& aColumn );
sl@0: 	inline TBool IsBound() const;
sl@0: 	inline TDbColumnC Column() const;
sl@0: 	MStreamBuf& StreamLC( const TDbBlob& aBlob ) const;
sl@0: // from CSqlSearchCondition
sl@0: 	void BindL( const RDbTableRow& aSource );
sl@0: private:
sl@0: 	const RDbTableRow* iSource;
sl@0: 	union
sl@0: 		{
sl@0: 		TUnion<TPtrC> iName;
sl@0: 		struct
sl@0: 			{
sl@0: 			TDbColNo iNumber;
sl@0: 			TDbColType iType;
sl@0: 			} iBound;
sl@0: 		} iColumn;
sl@0: 	};
sl@0: 
sl@0: /**
sl@0: @internalComponent
sl@0: */
sl@0: NONSHARABLE_CLASS(CSqlNullPredicate) : public CSqlBoundNode
sl@0: 	{
sl@0: public:
sl@0: 	CSqlNullPredicate( TType aType, const TDesC& aColumn );
sl@0: private:
sl@0: // from CSqlSearchCondition
sl@0: 	TBool EvaluateL( const TTextOps& aTextOp ) const;
sl@0: 	};
sl@0: 
sl@0: /**
sl@0: @internalComponent
sl@0: */
sl@0: NONSHARABLE_CLASS(CSqlLiteralNode) : public CSqlBoundNode
sl@0: 	{
sl@0: public:
sl@0: 	inline const RSqlLiteral& Value() const;
sl@0: 	inline RSqlLiteral& Value();
sl@0: protected:
sl@0: 	CSqlLiteralNode( TType aType, const TDesC& aColumn, const RSqlLiteral& aLiteral );
sl@0: 	~CSqlLiteralNode();
sl@0: // from CSqlSearchCondition
sl@0: 	void BindL( const RDbTableRow& aSource );
sl@0: private:
sl@0: 	RSqlLiteral iLiteral;
sl@0: 	};
sl@0: 
sl@0: /**
sl@0: @internalComponent
sl@0: */
sl@0: NONSHARABLE_CLASS(CSqlCompPredicate) : public CSqlLiteralNode
sl@0: 	{
sl@0: public:
sl@0: 	CSqlCompPredicate( TType aType, const TDesC& aColumn, const RSqlLiteral& aLiteral );
sl@0: private:
sl@0: 	TInt CompareLongText8L( const TDbBlob& aBlob, const TTextOps& aTextOp ) const;
sl@0: 	TInt CompareLongText16L( const TDbBlob& aBlob, const TTextOps& aTextOp ) const;
sl@0: // from CSqlSearchCondition
sl@0: 	TBool EvaluateL( const TTextOps& aTextOp ) const;
sl@0: 	};
sl@0: 
sl@0: /**
sl@0: @internalComponent
sl@0: */
sl@0: NONSHARABLE_CLASS(CSqlLikePredicate) : public CSqlLiteralNode 
sl@0: 	{
sl@0: public:
sl@0: 	CSqlLikePredicate( TType aType, const TDesC& aColumn, const RSqlLiteral& aPattern );
sl@0: private:
sl@0: // from CSqlSearchCondition
sl@0: 	void BindL( const RDbTableRow& aSource );
sl@0: 	TBool EvaluateL( const TTextOps& aTextOp ) const;
sl@0: private:
sl@0: 	TInt iMatchSize;
sl@0: 	};
sl@0: 
sl@0: /**
sl@0: @internalComponent
sl@0: */
sl@0: NONSHARABLE_CLASS(CSqlQuery) : public CBase
sl@0: 	{
sl@0: 	friend class TSqlParser;
sl@0: public:
sl@0: 	CSqlQuery();
sl@0: 	~CSqlQuery();
sl@0: //
sl@0: 	inline const TDesC& Table() const;
sl@0: //
sl@0: 	inline TBool HasColumnList() const;
sl@0: 	inline const RSqlColumnList& ColumnList() const;
sl@0: //
sl@0: 	inline TBool HasSearchCondition() const;
sl@0: 	inline CSqlSearchCondition& SearchCondition();
sl@0: 	void RemovePredicate( CSqlCompPredicate* aNode );
sl@0: 	inline CSqlSearchCondition* AdoptSearchCondition();
sl@0: //
sl@0: 	inline TBool HasSortSpecification() const;
sl@0: 	inline CDbKey& SortSpecification();
sl@0: private:
sl@0: 	CDbKey& SortSpecificationL();
sl@0: private:
sl@0: 	TPtrC iTable;
sl@0: 	RSqlColumnList iColumns;
sl@0: 	CSqlSearchCondition* iSearchCondition;
sl@0: 	CDbKey* iSortSpecification;
sl@0: 	};
sl@0: 
sl@0: /**
sl@0: @internalComponent
sl@0: */
sl@0: class CSqlDDLStatement : public CBase
sl@0: 	{
sl@0: protected:
sl@0: 	inline CSqlDDLStatement() {}
sl@0: public:
sl@0: 	virtual CDbIncremental* ExecuteL( CDbDatabase& aDatabase, TDbTextComparison aComparison, TInt& aStep ) = 0;
sl@0: 	};
sl@0: 
sl@0: /**
sl@0: @internalComponent
sl@0: */
sl@0: NONSHARABLE_CLASS(CSqlDMLStatement) : public CBase
sl@0: 	{
sl@0: 	friend class TSqlParser;
sl@0: public:
sl@0: 	~CSqlDMLStatement();
sl@0: //
sl@0: 	inline CSqlQuery& Query();
sl@0: 	inline CSqlValues& Values();
sl@0: 	inline CSqlValues* AdoptValues();
sl@0: //
sl@0: 	virtual CDbIncremental* ExecuteL( CDbTableDatabase& aDatabase, TDbTextComparison aComparison, TInt& aRows ) = 0;
sl@0: protected:
sl@0: 	inline CSqlDMLStatement() {}
sl@0: 	inline TBool HasValues() const;
sl@0: private:
sl@0: 	CSqlValues& ValuesL();
sl@0: private:
sl@0: 	CSqlQuery iQuery;
sl@0: 	CSqlValues* iValues;
sl@0: 	};
sl@0: 
sl@0: /**
sl@0: @internalComponent
sl@0: */
sl@0: NONSHARABLE_CLASS(CSqlInsertStatement) : public CSqlDMLStatement
sl@0: 	{
sl@0: public:
sl@0: 	static CSqlInsertStatement* NewLC();
sl@0: private:
sl@0: 	inline CSqlInsertStatement() {}
sl@0: // from CSqlDMLStatement
sl@0: 	CDbIncremental* ExecuteL( CDbTableDatabase& aDatabase, TDbTextComparison aComparison, TInt& aRows );
sl@0: 	};
sl@0: 
sl@0: /**
sl@0: @internalComponent
sl@0: */
sl@0: NONSHARABLE_CLASS(CSqlModifyStatement) : public CSqlDMLStatement
sl@0: 	{
sl@0: public:
sl@0: 	static CSqlModifyStatement* NewLC();
sl@0: 	inline TBool IsUpdate() const;
sl@0: private:
sl@0: 	inline CSqlModifyStatement() {}
sl@0: // from CSqlDMLStatement
sl@0: 	CDbIncremental* ExecuteL( CDbTableDatabase& aDatabase, TDbTextComparison aComparison, TInt& aRows );
sl@0: 	};
sl@0: 
sl@0: /**
sl@0: TSqlParser2 class uses TSqlParser class functionality only to parse particular SQL string
sl@0: and extract SQL type and table name.
sl@0: @internalComponent
sl@0: */
sl@0: class TSqlParser2
sl@0: 	{
sl@0: public:
sl@0: 	void ParseL(const TDesC& aSql);
sl@0: 	inline Sql::TStatementType StatementType() const;
sl@0: 	inline const TDesC& TableName() const;
sl@0: 
sl@0: private:
sl@0: 	Sql::TStatementType	iStatementType;
sl@0: 	TPtrC				iTableName;
sl@0: 
sl@0: 	};
sl@0: 
sl@0: #include "D32SQL.INL"
sl@0: 
sl@0: #endif//__D32SQL_H__