1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/persistentdata/persistentstorage/dbms/inc/D32SQL.H Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,446 @@
1.4 +// Copyright (c) 1998-2009 Nokia Corporation and/or its subsidiary(-ies).
1.5 +// All rights reserved.
1.6 +// This component and the accompanying materials are made available
1.7 +// under the terms of "Eclipse Public License v1.0"
1.8 +// which accompanies this distribution, and is available
1.9 +// at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.10 +//
1.11 +// Initial Contributors:
1.12 +// Nokia Corporation - initial contribution.
1.13 +//
1.14 +// Contributors:
1.15 +//
1.16 +// Description:
1.17 +// SQL parsing engine
1.18 +//
1.19 +//
1.20 +
1.21 +#ifndef __D32SQL_H__
1.22 +#define __D32SQL_H__
1.23 +
1.24 +#ifndef __D32DBMS_H__
1.25 +#include <d32dbms.h>
1.26 +#endif
1.27 +
1.28 +// Other class referenced
1.29 +class MStreamBuf;
1.30 +class TDbBlob;
1.31 +class RDbTableRow;
1.32 +class TTextOps;
1.33 +class TSqlParser;
1.34 +class CDbTable;
1.35 +class CDbTableDatabase;
1.36 +class CDbDataSource;
1.37 +class CDbBlobSpace;
1.38 +template <class T,class D> class HMatcherPattern;
1.39 +
1.40 +// Classes defined
1.41 +class Sql;
1.42 +class RSqlLiteral;
1.43 +class CSqlValues;
1.44 +class RSqlColumnList;
1.45 +class CSqlSearchCondition;
1.46 +class CSqlMultiNode;
1.47 +class CSqlBoundNode;
1.48 +class CSqlNullPredicate;
1.49 +class CSqlLiteralNode;
1.50 +class CSqlCompPredicate;
1.51 +class CSqlLikePredicate;
1.52 +class CSqlQuery;
1.53 +class CSqlDDLStatement;
1.54 +class CSqlDMLStatement;
1.55 +class CSqlInsertStatement;
1.56 +class CSqlModifyStatement;
1.57 +
1.58 +/**
1.59 +@internalComponent
1.60 +*/
1.61 +typedef HMatcherPattern<TUint8,TDesC8> HMatcherPattern8;
1.62 +typedef HMatcherPattern<TUint16,TDesC16> HMatcherPattern16;
1.63 +
1.64 +/**
1.65 +@internalComponent
1.66 +*/
1.67 +class Sql
1.68 + {
1.69 +public:
1.70 + enum TStatementType { ENone, EDDL, EDML };
1.71 +public:
1.72 + static CSqlDDLStatement* ParseDDLStatementLC( const TDesC& aSql );
1.73 + static CSqlDMLStatement* ParseDMLStatementLC( const TDesC& aSql );
1.74 + static CSqlQuery* ParseQueryLC( const TDesC& aSql );
1.75 + static CSqlSearchCondition* ParseSearchConditionLC( const TDesC& aSql );
1.76 + //
1.77 + static TStatementType Type( const TDesC& aSql );
1.78 + };
1.79 +
1.80 +// variant data classes
1.81 +
1.82 +/**
1.83 +@internalComponent
1.84 +*/
1.85 +class RSqlLiteral
1.86 + {
1.87 +public:
1.88 + inline RSqlLiteral();
1.89 + void Close();
1.90 +// assignment
1.91 + inline void SetText( const TText* aPtr, const TText* aEnd );
1.92 + inline TInt64& SetInt();
1.93 + inline TReal64& SetReal();
1.94 + inline TTime& SetTime();
1.95 +// conversions
1.96 + void ToInt32L();
1.97 + void ToUint32L();
1.98 + void ToInt64L();
1.99 + void ToReal32L();
1.100 + void ToReal64L();
1.101 + void ToTimeL();
1.102 + void ToText8L();
1.103 + void ToText16L();
1.104 + void ToPattern8L(TBool aEscape = EFalse);
1.105 + void ToPattern16L(TBool aEscape = EFalse);
1.106 + TInt CopyText();
1.107 +// accessors
1.108 + inline TBool IsNull() const;
1.109 + inline TInt32 Int32() const;
1.110 + inline TUint32 Uint32() const;
1.111 + inline const TInt64& Int64() const;
1.112 + inline const TTime& Time() const;
1.113 + inline const TReal32& Real32() const;
1.114 + inline const TReal64& Real64() const;
1.115 + inline const TText* Ptr() const;
1.116 + inline const TText* End() const;
1.117 + inline const TPtrC DesC() const;
1.118 + inline const HBufC8& Text8() const;
1.119 + inline const HBufC16& Text16() const;
1.120 + inline const HMatcherPattern8& Pattern8() const;
1.121 + inline const HMatcherPattern16& Pattern16() const;
1.122 +private:
1.123 + inline TBool IsBasic() const;
1.124 + inline TBool IsAlloc() const;
1.125 +private:
1.126 + enum TType { EInt32, EUint32, EReal32, EInt64, ETime, EReal64, EPtr, ENull, EBuf8, EBuf16, EPattern8, EPattern16 };
1.127 +private:
1.128 + union
1.129 + {
1.130 + TInt32 iInt32;
1.131 + TUint32 iUint32;
1.132 + TUnion<TInt64> iInt64;
1.133 + TReal32 iReal32;
1.134 + TReal64 iReal64;
1.135 + TUnion<TTime> iTime;
1.136 + struct { const TText* iPtr; const TText* iEnd; } iPtr;
1.137 + TAny* iAlloc;
1.138 + } iVal;
1.139 + TType iType;
1.140 + HBufC* iBuffer;
1.141 + };
1.142 +
1.143 +/**
1.144 +@internalComponent
1.145 +*/
1.146 +NONSHARABLE_CLASS(CSqlValues) : public CBase
1.147 + {
1.148 +public:
1.149 + CSqlValues();
1.150 + ~CSqlValues();
1.151 +//
1.152 + void AddL( const RSqlLiteral& aLiteral );
1.153 + void BindL( const CDbDataSource& aSource );
1.154 + void WriteL( CDbDataSource& aSource, CDbTable& aTable ) const;
1.155 +private:
1.156 + enum { EGranularity = 8 };
1.157 + class TEntry
1.158 + {
1.159 + public:
1.160 + inline TEntry( const RSqlLiteral& aValue );
1.161 + public:
1.162 + RSqlLiteral iValue;
1.163 + TDbColType iType;
1.164 + };
1.165 +private:
1.166 + RArray<TEntry> iValues;
1.167 + };
1.168 +
1.169 +/**
1.170 +@internalComponent
1.171 +*/
1.172 +class RSqlColumnList : public RArray<TPtrC>
1.173 + {
1.174 + enum { EGranularity = 8 };
1.175 +public:
1.176 + inline RSqlColumnList();
1.177 + };
1.178 +
1.179 +// evaluation tree classes
1.180 +
1.181 +/**
1.182 +@internalComponent
1.183 +*/
1.184 +class CSqlSearchCondition : public CBase
1.185 + {
1.186 +public:
1.187 + enum TType
1.188 + {
1.189 + EAnd, EOr,
1.190 + EIsNull, EIsNotNull,
1.191 + ELike, ENotLike,
1.192 + ELess, ELessEqual, EEqual, EGreaterEqual, EGreater, ENotEqual
1.193 + };
1.194 +public:
1.195 +
1.196 + TBool iIsEscape;
1.197 +
1.198 + inline TType NodeType() const;
1.199 + inline CSqlMultiNode* MultiNode();
1.200 + inline CSqlNullPredicate* NullPredicate();
1.201 + inline CSqlCompPredicate* CompPredicate();
1.202 + inline CSqlLikePredicate* LikePredicate();
1.203 +//
1.204 + virtual void BindL( const RDbTableRow& aSource ) = 0;
1.205 + virtual TBool EvaluateL( const TTextOps& aTextOp ) const = 0;
1.206 +protected:
1.207 + CSqlSearchCondition( TType aType );
1.208 +
1.209 +private:
1.210 + TType iType;
1.211 +
1.212 + };
1.213 +
1.214 +/**
1.215 +@internalComponent
1.216 +*/
1.217 +NONSHARABLE_CLASS(CSqlMultiNode) : public CSqlSearchCondition
1.218 + {
1.219 +private:
1.220 + typedef CSqlSearchCondition* TEntry;
1.221 + enum { EGranularity = 4 * sizeof( TEntry ) };
1.222 +public:
1.223 + static CSqlSearchCondition* New( TType aType, CSqlSearchCondition* aLeft, CSqlSearchCondition* aRight );
1.224 +//
1.225 + inline TInt Count() const;
1.226 + inline CSqlSearchCondition* SubNode( TInt aIndex ) const;
1.227 + inline void SetSubNode( TInt aIndex, CSqlSearchCondition* aSearchCondition );
1.228 + void Remove( CSqlSearchCondition* aSubNode );
1.229 + static CSqlSearchCondition* Reduce( CSqlMultiNode* aNode );
1.230 +private:
1.231 + inline CSqlMultiNode( TType aType );
1.232 + ~CSqlMultiNode();
1.233 + static CSqlMultiNode* New( TType aType, TInt aSize );
1.234 + static CSqlMultiNode* Grow( CSqlMultiNode* aNode, TInt aExtraSize );
1.235 + static CSqlMultiNode* Concatenate( CSqlMultiNode* aLeft, CSqlMultiNode* aRight );
1.236 +//
1.237 + inline TInt Size() const;
1.238 + static inline TInt Size( TInt aLeaves );
1.239 + inline TBool IsFull() const;
1.240 +private:
1.241 +// from CSqlSearchCondition
1.242 + void BindL( const RDbTableRow& aSource );
1.243 + TBool EvaluateL( const TTextOps& aTextOp ) const;
1.244 +private:
1.245 + TEntry* iEnd;
1.246 + TEntry iLeaves[1];
1.247 + };
1.248 +
1.249 +/**
1.250 +@internalComponent
1.251 +*/
1.252 +NONSHARABLE_CLASS(CSqlBoundNode) : public CSqlSearchCondition
1.253 + {
1.254 +public:
1.255 + const TDesC& ColumnName() const;
1.256 + inline TDbColNo ColNo() const;
1.257 + inline TDbColType ColType() const;
1.258 +protected:
1.259 + CSqlBoundNode( TType aType, const TDesC& aColumn );
1.260 + inline TBool IsBound() const;
1.261 + inline TDbColumnC Column() const;
1.262 + MStreamBuf& StreamLC( const TDbBlob& aBlob ) const;
1.263 +// from CSqlSearchCondition
1.264 + void BindL( const RDbTableRow& aSource );
1.265 +private:
1.266 + const RDbTableRow* iSource;
1.267 + union
1.268 + {
1.269 + TUnion<TPtrC> iName;
1.270 + struct
1.271 + {
1.272 + TDbColNo iNumber;
1.273 + TDbColType iType;
1.274 + } iBound;
1.275 + } iColumn;
1.276 + };
1.277 +
1.278 +/**
1.279 +@internalComponent
1.280 +*/
1.281 +NONSHARABLE_CLASS(CSqlNullPredicate) : public CSqlBoundNode
1.282 + {
1.283 +public:
1.284 + CSqlNullPredicate( TType aType, const TDesC& aColumn );
1.285 +private:
1.286 +// from CSqlSearchCondition
1.287 + TBool EvaluateL( const TTextOps& aTextOp ) const;
1.288 + };
1.289 +
1.290 +/**
1.291 +@internalComponent
1.292 +*/
1.293 +NONSHARABLE_CLASS(CSqlLiteralNode) : public CSqlBoundNode
1.294 + {
1.295 +public:
1.296 + inline const RSqlLiteral& Value() const;
1.297 + inline RSqlLiteral& Value();
1.298 +protected:
1.299 + CSqlLiteralNode( TType aType, const TDesC& aColumn, const RSqlLiteral& aLiteral );
1.300 + ~CSqlLiteralNode();
1.301 +// from CSqlSearchCondition
1.302 + void BindL( const RDbTableRow& aSource );
1.303 +private:
1.304 + RSqlLiteral iLiteral;
1.305 + };
1.306 +
1.307 +/**
1.308 +@internalComponent
1.309 +*/
1.310 +NONSHARABLE_CLASS(CSqlCompPredicate) : public CSqlLiteralNode
1.311 + {
1.312 +public:
1.313 + CSqlCompPredicate( TType aType, const TDesC& aColumn, const RSqlLiteral& aLiteral );
1.314 +private:
1.315 + TInt CompareLongText8L( const TDbBlob& aBlob, const TTextOps& aTextOp ) const;
1.316 + TInt CompareLongText16L( const TDbBlob& aBlob, const TTextOps& aTextOp ) const;
1.317 +// from CSqlSearchCondition
1.318 + TBool EvaluateL( const TTextOps& aTextOp ) const;
1.319 + };
1.320 +
1.321 +/**
1.322 +@internalComponent
1.323 +*/
1.324 +NONSHARABLE_CLASS(CSqlLikePredicate) : public CSqlLiteralNode
1.325 + {
1.326 +public:
1.327 + CSqlLikePredicate( TType aType, const TDesC& aColumn, const RSqlLiteral& aPattern );
1.328 +private:
1.329 +// from CSqlSearchCondition
1.330 + void BindL( const RDbTableRow& aSource );
1.331 + TBool EvaluateL( const TTextOps& aTextOp ) const;
1.332 +private:
1.333 + TInt iMatchSize;
1.334 + };
1.335 +
1.336 +/**
1.337 +@internalComponent
1.338 +*/
1.339 +NONSHARABLE_CLASS(CSqlQuery) : public CBase
1.340 + {
1.341 + friend class TSqlParser;
1.342 +public:
1.343 + CSqlQuery();
1.344 + ~CSqlQuery();
1.345 +//
1.346 + inline const TDesC& Table() const;
1.347 +//
1.348 + inline TBool HasColumnList() const;
1.349 + inline const RSqlColumnList& ColumnList() const;
1.350 +//
1.351 + inline TBool HasSearchCondition() const;
1.352 + inline CSqlSearchCondition& SearchCondition();
1.353 + void RemovePredicate( CSqlCompPredicate* aNode );
1.354 + inline CSqlSearchCondition* AdoptSearchCondition();
1.355 +//
1.356 + inline TBool HasSortSpecification() const;
1.357 + inline CDbKey& SortSpecification();
1.358 +private:
1.359 + CDbKey& SortSpecificationL();
1.360 +private:
1.361 + TPtrC iTable;
1.362 + RSqlColumnList iColumns;
1.363 + CSqlSearchCondition* iSearchCondition;
1.364 + CDbKey* iSortSpecification;
1.365 + };
1.366 +
1.367 +/**
1.368 +@internalComponent
1.369 +*/
1.370 +class CSqlDDLStatement : public CBase
1.371 + {
1.372 +protected:
1.373 + inline CSqlDDLStatement() {}
1.374 +public:
1.375 + virtual CDbIncremental* ExecuteL( CDbDatabase& aDatabase, TDbTextComparison aComparison, TInt& aStep ) = 0;
1.376 + };
1.377 +
1.378 +/**
1.379 +@internalComponent
1.380 +*/
1.381 +NONSHARABLE_CLASS(CSqlDMLStatement) : public CBase
1.382 + {
1.383 + friend class TSqlParser;
1.384 +public:
1.385 + ~CSqlDMLStatement();
1.386 +//
1.387 + inline CSqlQuery& Query();
1.388 + inline CSqlValues& Values();
1.389 + inline CSqlValues* AdoptValues();
1.390 +//
1.391 + virtual CDbIncremental* ExecuteL( CDbTableDatabase& aDatabase, TDbTextComparison aComparison, TInt& aRows ) = 0;
1.392 +protected:
1.393 + inline CSqlDMLStatement() {}
1.394 + inline TBool HasValues() const;
1.395 +private:
1.396 + CSqlValues& ValuesL();
1.397 +private:
1.398 + CSqlQuery iQuery;
1.399 + CSqlValues* iValues;
1.400 + };
1.401 +
1.402 +/**
1.403 +@internalComponent
1.404 +*/
1.405 +NONSHARABLE_CLASS(CSqlInsertStatement) : public CSqlDMLStatement
1.406 + {
1.407 +public:
1.408 + static CSqlInsertStatement* NewLC();
1.409 +private:
1.410 + inline CSqlInsertStatement() {}
1.411 +// from CSqlDMLStatement
1.412 + CDbIncremental* ExecuteL( CDbTableDatabase& aDatabase, TDbTextComparison aComparison, TInt& aRows );
1.413 + };
1.414 +
1.415 +/**
1.416 +@internalComponent
1.417 +*/
1.418 +NONSHARABLE_CLASS(CSqlModifyStatement) : public CSqlDMLStatement
1.419 + {
1.420 +public:
1.421 + static CSqlModifyStatement* NewLC();
1.422 + inline TBool IsUpdate() const;
1.423 +private:
1.424 + inline CSqlModifyStatement() {}
1.425 +// from CSqlDMLStatement
1.426 + CDbIncremental* ExecuteL( CDbTableDatabase& aDatabase, TDbTextComparison aComparison, TInt& aRows );
1.427 + };
1.428 +
1.429 +/**
1.430 +TSqlParser2 class uses TSqlParser class functionality only to parse particular SQL string
1.431 +and extract SQL type and table name.
1.432 +@internalComponent
1.433 +*/
1.434 +class TSqlParser2
1.435 + {
1.436 +public:
1.437 + void ParseL(const TDesC& aSql);
1.438 + inline Sql::TStatementType StatementType() const;
1.439 + inline const TDesC& TableName() const;
1.440 +
1.441 +private:
1.442 + Sql::TStatementType iStatementType;
1.443 + TPtrC iTableName;
1.444 +
1.445 + };
1.446 +
1.447 +#include "D32SQL.INL"
1.448 +
1.449 +#endif//__D32SQL_H__