1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/persistentdata/persistentstorage/sql/SRC/Server/SqlSrvCollation.cpp Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,229 @@
1.4 +// Copyright (c) 2006-2010 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 +// SqlSrvStatementCollation.cpp
1.18 +//
1.19 +//
1.20 +
1.21 +#include "SqlSrvCollation.h"
1.22 +#include "SqlAssert.h"
1.23 +#include "SqlUtil.h"
1.24 +#include "sqlite3.h"
1.25 +#include "SqliteSymbian.h" //sqlite3SymbianLastOsError()
1.26 +
1.27 +///////////////////////////////////////////////////////////////////////////////////////////////////////////////
1.28 +///////////////////////////// Local const data ///////////////////////////////////////////////////////
1.29 +///////////////////////////////////////////////////////////////////////////////////////////////////////////////
1.30 +
1.31 +//4 collated comparisons + 1 folded comparison
1.32 +const TInt KCollationMethodCount = 4 + 1;
1.33 +
1.34 +//Names of the user defined collations (zero-terminated 16-bit strings)
1.35 +const TUint16* KCollationMethodName[KCollationMethodCount] =
1.36 + {
1.37 + (const TUint16*)L"CompareC0",
1.38 + (const TUint16*)L"CompareC1",
1.39 + (const TUint16*)L"CompareC2",
1.40 + (const TUint16*)L"CompareC3",
1.41 + (const TUint16*)L"CompareF"
1.42 + };
1.43 +
1.44 +///////////////////////////////////////////////////////////////////////////////////////////////////////////////
1.45 +///////////////////////////// Local functions /////////////////////////////////////////////////////
1.46 +///////////////////////////////////////////////////////////////////////////////////////////////////////////////
1.47 +
1.48 +//User-defined collation function prototype, accepted by SQLITE
1.49 +typedef TInt (*TCollationMethodPtr)(void* aUserDefinedData, TInt aByteSize1, const void* aPtr1, TInt aByteSize2, const void* aPtr2);
1.50 +
1.51 +/**
1.52 +This function is used for collated/folded string comparisons,
1.53 +{aByteSize1, aPtr1} - string 1, UTF16 encoded. aByteSize1 - length in bytes.
1.54 +{aByteSize2, aPtr2} - string 2, UTF16 encoded. aByteSize2 - length in bytes.
1.55 +aLevel - 0,1,2,3 - collation level; -1 - folded string comparison;
1.56 +The function returns negative, zero or positive if the first string is less than, equal to, or
1.57 +greater than the second string.
1.58 +
1.59 +@internalComponent
1.60 +*/
1.61 +static TInt Compare(TInt aLevel, TInt aByteSize1, const void* aPtr1, TInt aByteSize2, const void* aPtr2)
1.62 + {
1.63 + TPtrC16 ptr1(static_cast <const TUint16*> (aPtr1), (TUint)aByteSize1 /sizeof(TUint16));
1.64 + TPtrC16 ptr2(static_cast <const TUint16*> (aPtr2), (TUint)aByteSize2 /sizeof(TUint16));
1.65 +
1.66 + return aLevel >= 0 ? ptr1.CompareC(ptr2, aLevel, NULL) : ptr1.CompareF(ptr2);
1.67 + }
1.68 +
1.69 +/**
1.70 +User defined function which will be used by SQLITE engine for collated string comparisons,
1.71 +collation level 0.
1.72 +{aByteSize1, aPtr1} - string 1, UTF16 encoded. aByteSize1 - length in bytes.
1.73 +{aByteSize2, aPtr2} - string 2, UTF16 encoded. aByteSize2 - length in bytes.
1.74 +The function returns negative, zero or positive if the first string is less than, equal to, or
1.75 +greater than the second string.
1.76 +
1.77 +@internalComponent
1.78 +*/
1.79 +static TInt CompareC0(void*, TInt aByteSize1, const void* aPtr1, TInt aByteSize2, const void* aPtr2)
1.80 + {
1.81 + return Compare(0, aByteSize1, aPtr1, aByteSize2, aPtr2);
1.82 + }
1.83 +
1.84 +/**
1.85 +User defined function which will be used by SQLITE engine for collated string comparisons,
1.86 +collation level 1.
1.87 +{aByteSize1, aPtr1} - string 1, UTF16 encoded. aByteSize1 - length in bytes.
1.88 +{aByteSize2, aPtr2} - string 2, UTF16 encoded. aByteSize2 - length in bytes.
1.89 +The function returns negative, zero or positive if the first string is less than, equal to, or
1.90 +greater than the second string.
1.91 +
1.92 +@internalComponent
1.93 +*/
1.94 +static TInt CompareC1(void*, TInt aByteSize1, const void* aPtr1, TInt aByteSize2, const void* aPtr2)
1.95 + {
1.96 + return Compare(1, aByteSize1, aPtr1, aByteSize2, aPtr2);
1.97 + }
1.98 +
1.99 +/**
1.100 +User defined function which will be used by SQLITE engine for collated string comparisons,
1.101 +collation level 2.
1.102 +{aByteSize1, aPtr1} - string 1, UTF16 encoded. aByteSize1 - length in bytes.
1.103 +{aByteSize2, aPtr2} - string 2, UTF16 encoded. aByteSize2 - length in bytes.
1.104 +The function returns negative, zero or positive if the first string is less than, equal to, or
1.105 +greater than the second string.
1.106 +
1.107 +@internalComponent
1.108 +*/
1.109 +static TInt CompareC2(void*, TInt aByteSize1, const void* aPtr1, TInt aByteSize2, const void* aPtr2)
1.110 + {
1.111 + return Compare(2, aByteSize1, aPtr1, aByteSize2, aPtr2);
1.112 + }
1.113 +
1.114 +/**
1.115 +User defined function which will be used by SQLITE engine for collated string comparisons,
1.116 +collation level 3.
1.117 +{aByteSize1, aPtr1} - string 1, UTF16 encoded. aByteSize1 - length in bytes.
1.118 +{aByteSize2, aPtr2} - string 2, UTF16 encoded. aByteSize2 - length in bytes.
1.119 +The function returns negative, zero or positive if the first string is less than, equal to, or
1.120 +greater than the second string.
1.121 +
1.122 +@internalComponent
1.123 +*/
1.124 +static TInt CompareC3(void*, TInt aByteSize1, const void* aPtr1, TInt aByteSize2, const void* aPtr2)
1.125 + {
1.126 + return Compare(3, aByteSize1, aPtr1, aByteSize2, aPtr2);
1.127 + }
1.128 +
1.129 +/**
1.130 +User defined function which will be used by SQLITE engine for folded string comparisons,
1.131 +{aByteSize1, aPtr1} - string 1, UTF16 encoded. aByteSize1 - length in bytes.
1.132 +{aByteSize2, aPtr2} - string 2, UTF16 encoded. aByteSize2 - length in bytes.
1.133 +The function returns negative, zero or positive if the first string is less than, equal to, or
1.134 +greater than the second string.
1.135 +
1.136 +@internalComponent
1.137 +*/
1.138 +static TInt CompareF(void*, TInt aByteSize1, const void* aPtr1, TInt aByteSize2, const void* aPtr2)
1.139 + {
1.140 + return Compare(-1, aByteSize1, aPtr1, aByteSize2, aPtr2);
1.141 + }
1.142 +
1.143 +//KCollationMethodPtr array contains function pointers to all user-defined collation functions
1.144 +const TCollationMethodPtr KCollationMethodPtr[KCollationMethodCount] =
1.145 + {
1.146 + &CompareC0, &CompareC1, &CompareC2, &CompareC3, &CompareF
1.147 + };
1.148 +
1.149 +///////////////////////////////////////////////////////////////////////////////////////////////////////////////
1.150 +///////////////////////////// TSqlCollationUtil class definition //////////////////////////////////
1.151 +///////////////////////////////////////////////////////////////////////////////////////////////////////////////
1.152 +
1.153 +/**
1.154 +Initializes TSqlCollationUtil data members.
1.155 +
1.156 +@panic SqlDb 4 In _DEBUG mode. aDbHandle is NULL.
1.157 +*/
1.158 +TSqlCollationUtil::TSqlCollationUtil(sqlite3* aDbHandle) :
1.159 + iDbHandle(aDbHandle)
1.160 + {
1.161 + __ASSERT_DEBUG(iDbHandle != NULL, __SQLPANIC(ESqlPanicBadArgument));
1.162 + }
1.163 +
1.164 +/**
1.165 +Installs user defined collations.
1.166 +
1.167 +At the moment 5 user defined collations with the following names are installed:
1.168 +- CompareC0 - 16-bit strings collated comaprison at level 0;
1.169 +- CompareC1 - 16-bit strings collated comaprison at level 1;
1.170 +- CompareC2 - 16-bit strings collated comaprison at level 2;
1.171 +- CompareC3 - 16-bit strings collated comaprison at level 3;
1.172 +- CompareF - 16-bit strings folded comaprison;
1.173 +
1.174 +These user defined collations can be used in the following cases:
1.175 +
1.176 +- as column constraint in "CREATE TABLE" SQL statements. For example:
1.177 +@code
1.178 + CREATE TABLE A(Col1 TEXT COLLATE CompareC1)
1.179 +@endcode
1.180 +In this case every time when Col1 values have to be compared, the SQL server will use CompareC1 collation.
1.181 +
1.182 +- as column constraint in "CREATE INDEX" SQL statements. For example:
1.183 +@code
1.184 + CREATE INDEX I ON A(Col1 COLLATE CompareC2)
1.185 +@endcode
1.186 +In this case SQL server will use CompareC2 collation to compare Col1 values when using the index.
1.187 +
1.188 +- In "ORDER BY" clause of "SELECT" SQL statements. For example:
1.189 +@code
1.190 + SELECT * FROM A ORDER BY Col1 COLLATE CompareC3
1.191 +@endcode
1.192 +In this case SQL server will use CompareC3 collation to compare Col1 values when building the result set.
1.193 +
1.194 +@leave The function may leave with some database specific errors categorised as ESqlDbError.
1.195 +
1.196 +@panic SqlDb 2 In _DEBUG mode. iDbHandle is NULL.
1.197 +*/
1.198 +void TSqlCollationUtil::InstallCollationsL()
1.199 + {
1.200 + __ASSERT_DEBUG(iDbHandle != NULL, __SQLPANIC(ESqlPanicInvalidObj));
1.201 + (void)sqlite3SymbianLastOsError();//clear last OS error
1.202 + //Register user defined collations
1.203 + for(TInt i=0;i<KCollationMethodCount;++i)
1.204 + {
1.205 + TInt err = sqlite3_create_collation16(iDbHandle, reinterpret_cast <const char*> (KCollationMethodName[i]),
1.206 + SQLITE_UTF16 | SQLITE_UTF16_ALIGNED, 0, KCollationMethodPtr[i]);
1.207 + __SQLLEAVE_IF_ERROR(::Sql2OsErrCode(err, sqlite3SymbianLastOsError()));
1.208 + }
1.209 + }
1.210 +
1.211 +/**
1.212 +@return User-defined collation methods count.
1.213 +
1.214 +@see TSqlCollationUtil::CollationName()
1.215 +*/
1.216 +TInt TSqlCollationUtil::CollationCount() const
1.217 + {
1.218 + return KCollationMethodCount;
1.219 + }
1.220 +
1.221 +/**
1.222 +@return The name of the collation method, identified by aIndex.
1.223 +
1.224 +@panic SqlDb 4 In _DEBUG mode. aIndex >= CollationMethodCount().
1.225 +
1.226 +@see TSqlCollationUtil::CollationsCount()
1.227 +*/
1.228 +TPtrC TSqlCollationUtil::CollationName(TInt aIndex) const
1.229 + {
1.230 + __ASSERT_DEBUG((TUint)aIndex < KCollationMethodCount, __SQLPANIC(ESqlPanicBadArgument));
1.231 + return TPtrC(KCollationMethodName[aIndex]);
1.232 + }