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: // The Store-Database
sl@0: // 
sl@0: //
sl@0: 
sl@0: #ifndef __D32STOR_H__
sl@0: #define __D32STOR_H__
sl@0: #ifndef __D32TABLE_H__
sl@0: #include "D32TABLE.H"
sl@0: #endif
sl@0: #ifndef __S32STOR_H__
sl@0: #include <s32stor.h>
sl@0: #endif
sl@0: 
sl@0: // other classes referenced
sl@0: class MDbStreamFilter;
sl@0: class CDbStoreCompression;
sl@0: class CClusterCache;
sl@0: 
sl@0: // classes defined
sl@0: class CDbStoreDatabase;
sl@0: class CDbFileStoreDatabase;
sl@0: 
sl@0: /**
sl@0: @internalComponent
sl@0: */
sl@0: enum TDbStoreVersion { EDbStoreVersion2=3,EDbStoreSecure,EDbStoreCompressed };
sl@0: 
sl@0: /**
sl@0: @internalComponent
sl@0: */
sl@0: class CDbStoreDatabase : public CDbTableDatabase
sl@0: 	{
sl@0: public:
sl@0: 	enum TZipType {EDeflate,EInflate};
sl@0: 	
sl@0: private:
sl@0: 	#ifndef PAGE_CACHE_SIZE
sl@0: 		#define PAGE_CACHE_SIZE 16
sl@0: 	#else
sl@0: 		#if PAGE_CACHE_SIZE < 8
sl@0: 			#error "PAGE_CACHE_SIZE macro value can't be less than 8"
sl@0: 		#endif
sl@0: 	#endif
sl@0: 	enum {EPageCachePages=PAGE_CACHE_SIZE};
sl@0: 	enum {EModified=0x1,EDamaged=0x2,ESharedStore=0x80000000};
sl@0: 	class CCompactor;
sl@0: 	
sl@0: public:
sl@0: // factory functions for pure StoreDatabase
sl@0: 	static CDbDatabase* CreateL(CStreamStore* aStore,TStreamId& aStreamId);
sl@0: 	static CDbSource* OpenL(CStreamStore* aStore,TStreamId aStreamId);
sl@0: 	static void CompressL(CStreamStore* aStore,TStreamId aStreamId,TZipType aZip);
sl@0: // accessors
sl@0: 	inline CStreamStore& Store();
sl@0: 	inline MDbStreamFilter* Filter();
sl@0: 	CClusterCache& ClusterCacheL();
sl@0: 	MPagePool& PagePoolL();
sl@0: // user-class's transaction protocol
sl@0: 	void MarkL();
sl@0: 	void IndexRecoveredL();
sl@0: 	
sl@0: protected:
sl@0: 	IMPORT_C CDbStoreDatabase();
sl@0: 	IMPORT_C ~CDbStoreDatabase();
sl@0: // phase 2 c'tors
sl@0: 	IMPORT_C TStreamId ConstructL();
sl@0: // framework: authentication
sl@0: 	IMPORT_C void AuthenticateL();
sl@0: 	IMPORT_C void RestoreL(TStreamId aStreamId);
sl@0: // framework: pure delegated functions
sl@0: 	IMPORT_C TInt Property(CDbDatabase::TProperty aProperty);
sl@0: 	IMPORT_C void DestroyL();
sl@0: // framework: transaction protocol
sl@0: 	IMPORT_C void LoadSchemaL();
sl@0: 	IMPORT_C void SynchL(TDbLockType aLock);
sl@0: 	IMPORT_C void Revert(TDbLockType aLock);
sl@0: 	IMPORT_C void Idle();
sl@0: // framework: object factory
sl@0: 	IMPORT_C CDbTableDef* CreateTableL(const TDesC& aName,const CDbColSet& aColSet,const CDbKey* aPrimaryKey);
sl@0: 	IMPORT_C CDbTableIndexDef* CreateIndexL(const CDbTableDef& aTable,const TDesC& aName,const CDbKey& aKey);
sl@0: 	IMPORT_C CDbTable* TableL(const CDbTableDef& aDef);
sl@0: // framework: incremental factory
sl@0: 	IMPORT_C CStepper* TableAlterL(CDbTableDef& aTable,const HDbColumnSet& aNewSet,TInt& aStep);
sl@0: 	IMPORT_C CStepper* RecordDiscarderL(const CDbTableDef& aTable,TInt& aStep);
sl@0: 	IMPORT_C CStepper* IndexDiscarderL(const CDbTableDef& aTable,const CDbTableIndexDef& anIndex,TInt& aStep);
sl@0: 	IMPORT_C CStepper* UtilityL(CDbDatabase::TUtility aType,TInt& aStep);
sl@0: 	
sl@0: private:
sl@0: // framework: reserved
sl@0: 	IMPORT_C void Reserved_1();
sl@0: 	IMPORT_C void Reserved_2();
sl@0: // implementationp functions
sl@0: 	static CDbStoreDatabase* NewLC(CStreamStore* aStore);
sl@0: //
sl@0: 	void CompressTablesL();
sl@0: 	void CompressL(TStreamId aStreamId,TZipType aZip);
sl@0: //
sl@0: 	void ReadHeaderL(RReadStream& aStream);
sl@0: 	void InitPagePoolL();
sl@0: 	void ReplaceSchemaL();
sl@0: 	void ReplaceTokenL(TUint aFlags);
sl@0: 	void SynchStoreL(TDbLockType aLock);
sl@0: 	CDbStoreCompression& CompressionL();
sl@0: 	CStepper* RecoverL(TInt& aStep);
sl@0: 	
sl@0: protected:
sl@0: 	CStreamStore* iStore;
sl@0: 	TInt iReclaim;
sl@0: 	
sl@0: private:
sl@0: 	TUint8 iVersion;
sl@0: 	TUint8 iFlags;
sl@0: 	TUint8 iSharedStore;
sl@0: 	TStreamId iSchemaId;
sl@0: 	TStreamId iTokenId;
sl@0: 	TStorePagePoolToken iPoolToken;
sl@0: 	RStorePagePool* iPagePool;
sl@0: 	CPageCache* iPageCache;
sl@0: 	CClusterCache* iClusterCache;
sl@0: 	MDbStreamFilter* iFilter;
sl@0: 	CDbStoreCompression* iCompression;
sl@0: 	
sl@0: 	};
sl@0: 
sl@0: /**
sl@0: The general file-store database class
sl@0: @internalComponent
sl@0: */
sl@0: const TInt32 KDbmsFileDatabaseUidValue=0x10000EBE;
sl@0: const TUid KDbmsFileDatabaseUid={KDbmsFileDatabaseUidValue};
sl@0: 
sl@0: /**
sl@0: @internalComponent
sl@0: */
sl@0: class CDbFileStoreDatabase : public CDbStoreDatabase
sl@0: 	{
sl@0: public:
sl@0: 	IMPORT_C static CDbDatabase* CreateL(RFs& aFs, const TDesC& aName, TDbFormat::TCreate aMode,
sl@0:                                          const TUidType& aType);
sl@0: 	IMPORT_C static CDbSource* OpenL(RFs& aFs,const TDesC& aName,TDbFormat::TOpen aMode);
sl@0: 	
sl@0: protected:
sl@0: 	IMPORT_C CDbFileStoreDatabase(RFs& aFs);
sl@0: 	IMPORT_C ~CDbFileStoreDatabase();
sl@0: //
sl@0: 	IMPORT_C void CreateL(const TDesC& aName, TDbFormat::TCreate aMode, const TUidType& aType);
sl@0: 	IMPORT_C virtual TStreamId CreateRootL(TStreamId aDatabaseId);
sl@0: //
sl@0: 	IMPORT_C void OpenL(const TDesC& aName,TDbFormat::TOpen aMode);
sl@0: 	IMPORT_C virtual TStreamId DatabaseIdL(TStreamId aRootId);
sl@0: // from CDbStoreDatabase
sl@0: 	IMPORT_C TInt Property(CDbDatabase::TProperty aProperty);
sl@0: 	IMPORT_C void DestroyL();
sl@0: 	
sl@0: private:
sl@0: 	static CDbFileStoreDatabase* NewLC(RFs& aFs);
sl@0: 	
sl@0: private:
sl@0: 	RFs& iFs;
sl@0: 	HBufC* iName;
sl@0: 	TBool iDelete;
sl@0: 	
sl@0: 	};
sl@0: 
sl@0: #endif