diff -r 000000000000 -r bde4ae8d615e os/textandloc/textrendering/texthandling/inc/FLDSET.H --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/os/textandloc/textrendering/texthandling/inc/FLDSET.H Fri Jun 15 03:10:57 2012 +0200 @@ -0,0 +1,151 @@ +/* +* Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies). +* All rights reserved. +* This component and the accompanying materials are made available +* under the terms of "Eclipse Public License v1.0" +* which accompanies this distribution, and is available +* at the URL "http://www.eclipse.org/legal/epl-v10.html". +* +* Initial Contributors: +* Nokia Corporation - initial contribution. +* +* Contributors: +* +* Description: +* +*/ + + +#ifndef __FLDSET_H__ +#define __FLDSET_H__ + +#include +#include +#include +#include +#include + +// +// Classes declared in this file +class CTextFieldSet; +// +// Classes referenced +class RReadStream; +class RWriteStream; +class TTextFieldEntry; +class CStreamStore; +class CStoreMap; +class TRollbackInfo; + +/** +@internalComponent +*/ +const TInt KFieldArrayGranularity=1; + + +class CTextFieldSet : public CBase +/** +The engine that keeps the field table up to date +@internalComponent +*/ + { +public: + enum {ENoPasteLimit=-1}; +public: + IMPORT_C static CTextFieldSet* NewL(TInt aDocumentLength=0); + IMPORT_C static CTextFieldSet* NewL(const MTextFieldFactory* aFactory,const CStreamStore& aStore,TStreamId aStreamId); + IMPORT_C ~CTextFieldSet(); + // + // Factory functions + IMPORT_C void SetFieldFactory(MTextFieldFactory* aFactory); + IMPORT_C MTextFieldFactory* FieldFactory()const; + // + IMPORT_C void Reset(); // removes all fields from the array and reinitialises field array + // + // Persistence + IMPORT_C TStreamId StoreL(CStreamStore& aStore)const; + IMPORT_C void RestoreL(const CStreamStore& aFieldStore,TStreamId aStreamId); + // + // Component persistence + IMPORT_C void StoreFieldsL(CStreamStore& aStore,CStoreMap& aMap)const; + IMPORT_C void RestoreFieldsL(const CStreamStore& aFieldStore); + // + // Headstream persistence + IMPORT_C void InternalizeL(RReadStream& aStream); + IMPORT_C void ExternalizeL(RWriteStream& aStream)const; + // Cut/Paste + IMPORT_C TStreamId CopyToStoreL(CStreamStore& aStore,TInt aPos,TInt aLength)const; + IMPORT_C void CopyComponentsL(CStreamStore& aStore,CStoreMap& aMap,TInt aPos,TInt aLength)const; + IMPORT_C void CopyToStreamL(RWriteStream& aStream,TInt aPos,TInt aLength)const; + IMPORT_C void PasteFromStoreL(const CStreamStore& aFieldStore,TStreamId aStreamId,TInt aPos,TInt aMaxLen=ENoPasteLimit); + IMPORT_C void PasteComponentsL(const CStreamStore& aFieldStore,TInt aPos); + IMPORT_C void PasteFromStreamL(RReadStream& aStream,TInt aPos,TInt aMaxLen=ENoPasteLimit); + // Insert/Remove field + IMPORT_C CTextField* NewFieldL(TUid aFieldType); + IMPORT_C TInt InsertFieldL(TInt aPos,CTextField* aField,TUid aFieldType); // inserts a field (including text) into doc (returns error num if it fails) + IMPORT_C TInt RemoveField(TInt aPos); // remove the field aPos is in + IMPORT_C TInt NewFieldValueL(HBufC*& aBuf, TInt aPos); // returns new value of the field in aBuf (or returns false if aPos not in field) + // Update field set + IMPORT_C void NotifyInsertion(TInt aPos, TInt aNumberAdded); + IMPORT_C void NotifyDeletion(TInt aPos, TInt aNumberRemoved); + IMPORT_C void NotifyFieldUpdate(TInt aPos, TInt aNewFieldValueLength); + // Utilities + IMPORT_C TInt FieldCount() const; // returns total number of fields in document + IMPORT_C TInt CharCount() const; // returns num characters in the document (according to fields) + IMPORT_C TBool FindFields(TInt aPos) const; // Returns ETrue if aPos is in a field + IMPORT_C TBool FindFields(TFindFieldInfo& aInfo,TInt aPos,TInt aRange=0) const; // finds num fields at least partly in range. Returns true if aPos is in field, and returns info on the first field in aRange + IMPORT_C const CTextField* TextField(TInt aPos)const; + // Rollback + IMPORT_C void RollbackPaste(); // call to carry out rollback if a paste goes wrong +protected: + CTextFieldSet(); + void ConstructL(TInt aDocumentLength); + void ConstructL(const CStreamStore& aFieldStore,TStreamId aStreamId); +private: + // persistence + void StoreFieldsL(CStreamStore& aStore,CStoreMap& aMap,CArrayFixSeg* aArray)const; + void DoRestoreL(const CStreamStore& aFieldStore,TStreamId aStreamId); + void DoRestoreFieldsL(CArrayFixSeg* aArray,const CStreamStore& aFieldStore,TInt aStartIndex=0); + void InternalizeL(CArrayFixSeg* aArray,RReadStream& aStream); + void ExternalizeL(RWriteStream& aStream,CArrayFixSeg* aArray)const; + void DoPasteL(CArrayFixSeg* aSourceArray,TInt aPos); + // utility functions + void AddInitialFieldEntryL(CArrayFixSeg* aArray,TInt aDocumentLength); // used to initialise the array + void InsertEntryL(TInt aIndex,TTextFieldEntry& aEntry); // inserts into iFieldArray + void InsertEntryL(TInt aIndex,TTextFieldEntry& aEntry,CArrayFixSeg* aArray); + void AppendEntryL(TTextFieldEntry& aEntry); // appends into iFieldArray + void AppendEntryL(TTextFieldEntry& aEntry,CArrayFixSeg* aArray); + void CopyToArrayL(CArrayFixSeg* aArray,TInt aPos,TInt aLength)const; + TBool InField(const TInt aPos, TInt& anIndex, TInt& anOffset) const; // anOffset set to distance into field or gap + void DeleteFieldEntry(TInt anIndex); + void DeleteFieldEntry(CArrayFixSeg* aArray,TInt anIndex); + TTextFieldEntry SplitEntry(TInt aIndex,TInt aOffset,TInt aRange)const; + TInt EntryLen(const TTextFieldEntry& aEntry)const; + TInt EntryLen(TInt aIndex)const; + // rollback + void RecordRollbackInfoL(TInt aPastePos); +private: + MTextFieldFactory* iFieldFactory; + CArrayFixSeg* iFieldArray; // Array of fields in the document + TRollbackInfo* iRollbackInfo; + __DECLARE_TEST; + }; + +class TFieldMapExternalizer : public MExternalizer +/** +Allows NULL streams id's to be written out +when no reference is found in a store map. +@internalComponent +*/ + { +private: + friend class CPlainText; + friend class CTextFieldSet; +private: + IMPORT_C TFieldMapExternalizer(const CStoreMap& aMap); + IMPORT_C void ExternalizeL(const TStreamRef& anObject,RWriteStream& aStream) const; +private: + const CStoreMap* iMap; + }; + +#endif