1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/persistentdata/persistentstorage/dbms/inc/D32STOR.H Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,178 @@
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 +// The Store-Database
1.18 +//
1.19 +//
1.20 +
1.21 +#ifndef __D32STOR_H__
1.22 +#define __D32STOR_H__
1.23 +#ifndef __D32TABLE_H__
1.24 +#include "D32TABLE.H"
1.25 +#endif
1.26 +#ifndef __S32STOR_H__
1.27 +#include <s32stor.h>
1.28 +#endif
1.29 +
1.30 +// other classes referenced
1.31 +class MDbStreamFilter;
1.32 +class CDbStoreCompression;
1.33 +class CClusterCache;
1.34 +
1.35 +// classes defined
1.36 +class CDbStoreDatabase;
1.37 +class CDbFileStoreDatabase;
1.38 +
1.39 +/**
1.40 +@internalComponent
1.41 +*/
1.42 +enum TDbStoreVersion { EDbStoreVersion2=3,EDbStoreSecure,EDbStoreCompressed };
1.43 +
1.44 +/**
1.45 +@internalComponent
1.46 +*/
1.47 +class CDbStoreDatabase : public CDbTableDatabase
1.48 + {
1.49 +public:
1.50 + enum TZipType {EDeflate,EInflate};
1.51 +
1.52 +private:
1.53 + #ifndef PAGE_CACHE_SIZE
1.54 + #define PAGE_CACHE_SIZE 16
1.55 + #else
1.56 + #if PAGE_CACHE_SIZE < 8
1.57 + #error "PAGE_CACHE_SIZE macro value can't be less than 8"
1.58 + #endif
1.59 + #endif
1.60 + enum {EPageCachePages=PAGE_CACHE_SIZE};
1.61 + enum {EModified=0x1,EDamaged=0x2,ESharedStore=0x80000000};
1.62 + class CCompactor;
1.63 +
1.64 +public:
1.65 +// factory functions for pure StoreDatabase
1.66 + static CDbDatabase* CreateL(CStreamStore* aStore,TStreamId& aStreamId);
1.67 + static CDbSource* OpenL(CStreamStore* aStore,TStreamId aStreamId);
1.68 + static void CompressL(CStreamStore* aStore,TStreamId aStreamId,TZipType aZip);
1.69 +// accessors
1.70 + inline CStreamStore& Store();
1.71 + inline MDbStreamFilter* Filter();
1.72 + CClusterCache& ClusterCacheL();
1.73 + MPagePool& PagePoolL();
1.74 +// user-class's transaction protocol
1.75 + void MarkL();
1.76 + void IndexRecoveredL();
1.77 +
1.78 +protected:
1.79 + IMPORT_C CDbStoreDatabase();
1.80 + IMPORT_C ~CDbStoreDatabase();
1.81 +// phase 2 c'tors
1.82 + IMPORT_C TStreamId ConstructL();
1.83 +// framework: authentication
1.84 + IMPORT_C void AuthenticateL();
1.85 + IMPORT_C void RestoreL(TStreamId aStreamId);
1.86 +// framework: pure delegated functions
1.87 + IMPORT_C TInt Property(CDbDatabase::TProperty aProperty);
1.88 + IMPORT_C void DestroyL();
1.89 +// framework: transaction protocol
1.90 + IMPORT_C void LoadSchemaL();
1.91 + IMPORT_C void SynchL(TDbLockType aLock);
1.92 + IMPORT_C void Revert(TDbLockType aLock);
1.93 + IMPORT_C void Idle();
1.94 +// framework: object factory
1.95 + IMPORT_C CDbTableDef* CreateTableL(const TDesC& aName,const CDbColSet& aColSet,const CDbKey* aPrimaryKey);
1.96 + IMPORT_C CDbTableIndexDef* CreateIndexL(const CDbTableDef& aTable,const TDesC& aName,const CDbKey& aKey);
1.97 + IMPORT_C CDbTable* TableL(const CDbTableDef& aDef);
1.98 +// framework: incremental factory
1.99 + IMPORT_C CStepper* TableAlterL(CDbTableDef& aTable,const HDbColumnSet& aNewSet,TInt& aStep);
1.100 + IMPORT_C CStepper* RecordDiscarderL(const CDbTableDef& aTable,TInt& aStep);
1.101 + IMPORT_C CStepper* IndexDiscarderL(const CDbTableDef& aTable,const CDbTableIndexDef& anIndex,TInt& aStep);
1.102 + IMPORT_C CStepper* UtilityL(CDbDatabase::TUtility aType,TInt& aStep);
1.103 +
1.104 +private:
1.105 +// framework: reserved
1.106 + IMPORT_C void Reserved_1();
1.107 + IMPORT_C void Reserved_2();
1.108 +// implementationp functions
1.109 + static CDbStoreDatabase* NewLC(CStreamStore* aStore);
1.110 +//
1.111 + void CompressTablesL();
1.112 + void CompressL(TStreamId aStreamId,TZipType aZip);
1.113 +//
1.114 + void ReadHeaderL(RReadStream& aStream);
1.115 + void InitPagePoolL();
1.116 + void ReplaceSchemaL();
1.117 + void ReplaceTokenL(TUint aFlags);
1.118 + void SynchStoreL(TDbLockType aLock);
1.119 + CDbStoreCompression& CompressionL();
1.120 + CStepper* RecoverL(TInt& aStep);
1.121 +
1.122 +protected:
1.123 + CStreamStore* iStore;
1.124 + TInt iReclaim;
1.125 +
1.126 +private:
1.127 + TUint8 iVersion;
1.128 + TUint8 iFlags;
1.129 + TUint8 iSharedStore;
1.130 + TStreamId iSchemaId;
1.131 + TStreamId iTokenId;
1.132 + TStorePagePoolToken iPoolToken;
1.133 + RStorePagePool* iPagePool;
1.134 + CPageCache* iPageCache;
1.135 + CClusterCache* iClusterCache;
1.136 + MDbStreamFilter* iFilter;
1.137 + CDbStoreCompression* iCompression;
1.138 +
1.139 + };
1.140 +
1.141 +/**
1.142 +The general file-store database class
1.143 +@internalComponent
1.144 +*/
1.145 +const TInt32 KDbmsFileDatabaseUidValue=0x10000EBE;
1.146 +const TUid KDbmsFileDatabaseUid={KDbmsFileDatabaseUidValue};
1.147 +
1.148 +/**
1.149 +@internalComponent
1.150 +*/
1.151 +class CDbFileStoreDatabase : public CDbStoreDatabase
1.152 + {
1.153 +public:
1.154 + IMPORT_C static CDbDatabase* CreateL(RFs& aFs, const TDesC& aName, TDbFormat::TCreate aMode,
1.155 + const TUidType& aType);
1.156 + IMPORT_C static CDbSource* OpenL(RFs& aFs,const TDesC& aName,TDbFormat::TOpen aMode);
1.157 +
1.158 +protected:
1.159 + IMPORT_C CDbFileStoreDatabase(RFs& aFs);
1.160 + IMPORT_C ~CDbFileStoreDatabase();
1.161 +//
1.162 + IMPORT_C void CreateL(const TDesC& aName, TDbFormat::TCreate aMode, const TUidType& aType);
1.163 + IMPORT_C virtual TStreamId CreateRootL(TStreamId aDatabaseId);
1.164 +//
1.165 + IMPORT_C void OpenL(const TDesC& aName,TDbFormat::TOpen aMode);
1.166 + IMPORT_C virtual TStreamId DatabaseIdL(TStreamId aRootId);
1.167 +// from CDbStoreDatabase
1.168 + IMPORT_C TInt Property(CDbDatabase::TProperty aProperty);
1.169 + IMPORT_C void DestroyL();
1.170 +
1.171 +private:
1.172 + static CDbFileStoreDatabase* NewLC(RFs& aFs);
1.173 +
1.174 +private:
1.175 + RFs& iFs;
1.176 + HBufC* iName;
1.177 + TBool iDelete;
1.178 +
1.179 + };
1.180 +
1.181 +#endif