sl@0: /*
sl@0: * Copyright (c) 1997-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: *
sl@0: */
sl@0: 
sl@0: 
sl@0: #ifndef __TXTINDEX_H__
sl@0: #define __TXTINDEX_H__
sl@0: 
sl@0: #include <e32std.h>
sl@0: #include <e32base.h>
sl@0: #include <txtmrtsr.h>
sl@0: #include <txtrich.h>
sl@0: #include "TXTSTD.H"
sl@0: 
sl@0: // forward declarations
sl@0: class CParaAttribs;
sl@0: class CPicturePhrase;
sl@0: class RReadStream;
sl@0: class RWriteStream;
sl@0: class CStoreMap;
sl@0: class CStreamStore;
sl@0: class CPicture;
sl@0: class CCharFormatLayer;
sl@0: class CParaFormatLayer;
sl@0: class CRichText;
sl@0: class MPictureFactory;
sl@0: 
sl@0: /**
sl@0: @internalComponent
sl@0: */
sl@0: enum TRichTextStylePasteMode
sl@0: 	{
sl@0: 	EAddNewStyles,
sl@0: 	EConvertNewStyles,
sl@0: 	EIgnoreNewStyles
sl@0: 	};
sl@0: 
sl@0: class TTextFragment
sl@0: /**
sl@0: Describes a fragment of text that does not conform to the ERA text model.
sl@0: @internalComponent
sl@0: */
sl@0: 	{
sl@0: public:
sl@0: 	TTextFragment();
sl@0: public:
sl@0: 	TInt iLength;  // Number of characters in text fragment
sl@0: 	TInt iPhraseCount;  // Number of distinct phrases in text fragment.
sl@0: 	};
sl@0: 
sl@0: 
sl@0: class RPhraseAttribsEntry
sl@0: /**
sl@0: Provides a full description of a phrase.
sl@0: A phrase consists of a specified number of contiguous characters [the phrase length]
sl@0: of identical character format.
sl@0: Where a picture is included as text content, it is described by its own phrase.
sl@0: @internalComponent
sl@0: */
sl@0: 	{
sl@0: public:
sl@0: 	enum {EPictureIndicator = -1};
sl@0: 	enum {EPicturePhraseLength = 1};
sl@0: public:
sl@0: 	RPhraseAttribsEntry();
sl@0: 	RPhraseAttribsEntry(CCharFormatLayer* aCharFormat, TInt aLength = 0); // Sets iLen to zero - empty text phrase
sl@0: 	RPhraseAttribsEntry(CPicturePhrase* aPicturePhrase);  // Sets iLen to EPictureIndicator
sl@0: 	inline RPhraseAttribsEntry(const RPhraseAttribsEntry& aPhrase);
sl@0: 	void Discard();
sl@0: 	inline RPhraseAttribsEntry& operator=(const RPhraseAttribsEntry& aPhrase);
sl@0: 	//
sl@0: 	// Persist
sl@0: 	void ExternalizeL(RWriteStream& aStream) const;
sl@0: 	//
sl@0: 	// General enquiry
sl@0: 	inline TBool IsPicturePhrase() const;
sl@0: 	TBool IsIdentical(const RPhraseAttribsEntry& aPhrase) const;
sl@0: 	//
sl@0: 	// Getters
sl@0: 	inline TInt Length() const;
sl@0: 	CCharFormatLayer* CharFormat() const;
sl@0: 	CCharFormatLayer* ReleaseCharFormatLayerOwnership();
sl@0: 	TInt GetPictureSizeInTwips(TSize& aSize) const;
sl@0: 	TPictureHeader* PictureHeaderPtr() const;
sl@0: 	TPictureHeader PictureHeader() const;
sl@0: 	const CPicture* PictureHandleL(const MPictureFactory* aFactory,
sl@0: 								   const MRichTextStoreResolver* aResolver,
sl@0: 								   TInt aPos,
sl@0: 								   MLayDoc::TForcePictureLoad aForceLoad) const;
sl@0: 	//
sl@0: 	// Setters
sl@0: 	void AdjustLength(TInt aIncrement);
sl@0:  	void SetLength(TInt aLength);
sl@0: private:
sl@0: 	void AssignAndRelease(const RPhraseAttribsEntry& aPhrase);
sl@0: private:
sl@0: 	TInt iLength;  // No. of characters covered by this phrase
sl@0: 	union
sl@0: 		{
sl@0: 		CCharFormatLayer* iCharFormat;  // *OWNED* format of this text phrase
sl@0: 		CPicturePhrase* iPicturePhrase;  // *OWNED* pointer to picture phrase information
sl@0: 		};
sl@0: 	__DECLARE_TEST;
sl@0: 	};
sl@0: 
sl@0: 
sl@0: NONSHARABLE_CLASS(CPicturePhrase) : public CBase
sl@0: /**
sl@0: A low-level class providing a pointer to the character format layer for this picture phrase,
sl@0: and a pointer to a picture itself.  (Which may be expressed in its persistent form).
sl@0: @internalComponent
sl@0: */
sl@0: 	{
sl@0: public:
sl@0: 	static CPicturePhrase* NewL(const TPictureHeader& aPicHdr,
sl@0: 	                            TCharFormatX& aFormat,
sl@0: 	                            TCharFormatXMask& aMask,
sl@0: 	                            CCharFormatLayer* aCharBase,
sl@0: 	                            TBool& aPictureOwnershipTaken);
sl@0: 
sl@0: 	static CPicturePhrase* NewL(const TPictureHeader& aPicHdr,
sl@0: 	                            CCharFormatLayer* aCharLayer,
sl@0: 	                            TBool& aPictureOwnershipTaken);
sl@0: 	~CPicturePhrase();
sl@0: protected:
sl@0: 	CPicturePhrase(const TPictureHeader& aPicHdr,TBool& aPictureOwnershipTaken);
sl@0: 	CPicturePhrase(const TPictureHeader& aPicHdr, CCharFormatLayer* aCharLayer,TBool& aPictureOwnershipTaken);
sl@0: 	void ConstructL(TCharFormatX& aFormat, TCharFormatXMask& aMask, CCharFormatLayer* aCharBase);
sl@0: public:
sl@0: 	CCharFormatLayer* iCharFormat;
sl@0: 	TPictureHeader iPicHdr;
sl@0: 	};
sl@0: 
sl@0: 
sl@0: class TParaAttribsEntry
sl@0: /**
sl@0: Records the length of a paragraph (no. of characters).
sl@0: and references a CParaAttributes.
sl@0: @internalComponent
sl@0: */
sl@0: 	{
sl@0: public:
sl@0: 	TParaAttribsEntry();
sl@0: 	TParaAttribsEntry(TInt aLength, CParaAttribs* aParaAttribs);
sl@0: public:
sl@0: 	TInt iLength;  // Number of characters in the paragraph (paragraph delimiter inclusive).
sl@0: 	CParaAttribs* iParaAttribs;  // Only references this, does not own it.
sl@0: 	};
sl@0: 
sl@0: 
sl@0: class TCurrentIndexRecords
sl@0: /**
sl@0: Packages current phrase & para records.
sl@0: @internalComponent
sl@0: */
sl@0: 	{
sl@0: public:
sl@0: 	TCurrentIndexRecords();
sl@0: public:
sl@0: 	TParaAttribsEntry* iParaEntry;
sl@0: 	CParaAttribs* iParaAttribs;
sl@0: 	RPhraseAttribsEntry* iPhrase;  // May be NULL.
sl@0: 	};
sl@0: 
sl@0: 
sl@0: 
sl@0: class TLogicalPosition
sl@0: /**
sl@0: Locates the current cursor position within all aspects of the index.
sl@0: @internalComponent
sl@0: */
sl@0: 	{
sl@0: public:
sl@0: 	TLogicalPosition();
sl@0: 	void Clear();
sl@0: public:
sl@0: 	TInt iDocPos;					// Absolute document position.
sl@0: 	TInt iParaElement;				// paragraph index
sl@0: 	TInt iParaElementOffset;		// position from start of paragraph
sl@0: 	TInt iParaBasePhraseElement;	// index of the first phrase in the paragraph
sl@0: 	TInt iPhraseElement;
sl@0: 	TInt iPhraseElementOffset;
sl@0: 	};
sl@0: 
sl@0: 
sl@0: 
sl@0: NONSHARABLE_CLASS(CParaAttribs) : public CBase
sl@0: /**
sl@0: Describes the attributes that apply to the paragraph.
sl@0: *owns* an iParaFormat(Layer), and *owns* an iPhraseAttribsIndex
sl@0: or charFormatLayer.
sl@0: @internalComponent
sl@0: */
sl@0: 	{
sl@0: public:
sl@0: 	enum TParaRefCount {EPrimeNonSharedCount, EPrimeSharedCount};
sl@0: 	enum {EPhraseIxGranularity = 1};
sl@0: public:
sl@0: 	// Create a CParaAttribs with constant character formatting.
sl@0: 	static CParaAttribs* NewL(const CParaFormatLayer* aParaLayer, const CCharFormatLayer* aCharLayer);
sl@0: 	// Create a CParaAttribs with specific character formatting.
sl@0: 	static CParaAttribs* NewL(const CParaFormatLayer* aParaLayer);
sl@0: 	static CParaAttribs* NewL(const CParaAttribs* aParaAttribs);
sl@0: 	void Release();
sl@0: 	void Release(TInt aCount);
sl@0: 	//
sl@0: 	// Utility functions
sl@0: 	inline TBool IsShared() const;
sl@0: 	TInt PhraseCount() const;
sl@0: protected:
sl@0: 	CParaAttribs();
sl@0: 	~CParaAttribs();
sl@0: 	CParaAttribs* CopyParaFormatL();
sl@0: private:
sl@0: public:
sl@0: 	TDblQueLink link;
sl@0: 	TInt iRefCount;  // Indicates re-use of this.
sl@0: 	CParaFormatLayer* iParaFormat;
sl@0: 	union
sl@0: 		{
sl@0: 		CCharFormatLayer* iCharFormat;	// iRefCount>0 - a single shared phrase - constant char format.
sl@0: 		TInt iPhraseCount;	// iRefCount==0 - the number of phrases in this para.
sl@0: 		};
sl@0: 	};
sl@0: 
sl@0: 
sl@0: //
sl@0: 
sl@0: class TRtPasteContext
sl@0: /**
sl@0: Provides the context for pasting of pictures from a clipboard.
sl@0: @internalComponent
sl@0: */
sl@0: 	{
sl@0: public:
sl@0: 	TRtPasteContext(const CStreamStore* aStore, const CParaFormatLayer* aGlobalParaLayer, const CCharFormatLayer* aGlobalCharLayer, const CStyleList* aStyleList);
sl@0: public:
sl@0: 	const CStreamStore* iStore;  // the clipboard store
sl@0: 	const CParaFormatLayer* iGlobalParaLayer;  // the global para layer of the target text document
sl@0: 	const CCharFormatLayer* iGlobalCharLayer;  // the global char layer of the target text document
sl@0: 	const CStyleList* iStyleList;  // style list is present
sl@0: 	TBool iParagraphStylesFlag;  // ETrue indicates presence of inline style references in index data
sl@0: 	TBool iIncompleteParaFlag;  // ETrue indicates the pasted text fragment has no final para delimiter
sl@0: 	TBool iApplyFormatToLastFlag;  // ETrue indicates that para format should be applied to last text fragment
sl@0: 	TLogicalPosition iPastePos;  // the character position at which the text is to be pasted
sl@0: 	TInt iParasPasted;  // the number of paragraphs successfully pasted
sl@0: 	TInt iStylePasteMode;
sl@0: 	};
sl@0: 
sl@0: 
sl@0: 
sl@0: class TIndexDeleteInfo
sl@0: /**
sl@0: Contains information pertaining to an index delete operation.
sl@0: Carries between a SetForDeleteL and a DeleteNow method call.
sl@0: @internalComponent
sl@0: */
sl@0: 	{
sl@0: public:
sl@0: 	enum TDeleteType
sl@0: 		{
sl@0: 		EDeleteFromParagraph,
sl@0: 		EDeleteParagraph,
sl@0: 		ENonspecificDelete
sl@0: 		};
sl@0: public:
sl@0: 	TInt iStartPara;
sl@0: 	TInt iEndPara;
sl@0: 	TLogicalPosition iDeletePos;
sl@0: 	TInt iDeleteLength;
sl@0: 	TDeleteType iDeleteType;
sl@0: 	};
sl@0: 
sl@0: 
sl@0: class TRichTextMapEntry
sl@0: /**
sl@0: A utility class for patching references to persisted shared objects
sl@0: of the specified type.
sl@0: Code at the bottom of the header
sl@0: @internalComponent
sl@0: */
sl@0: 	{
sl@0: public:
sl@0: 	TRichTextMapEntry(TInt aRefNumber, TAny* aItem);
sl@0: 	TRichTextMapEntry(TAny* aS, TAny* aT);
sl@0: public:
sl@0: 	union
sl@0: 		{// The source item - a reference to a persistent one, or the in-memory original.
sl@0: 		TInt iRefNumber;
sl@0: 		TAny* iS;  // only used in appending one rich text to another
sl@0: 		};
sl@0: 	TAny* iT;  // the newly created/restored item - the target
sl@0: 	};
sl@0: 
sl@0: 
sl@0: template <class T>
sl@0: class CRichTextStoreMap : public CBase
sl@0: /**
sl@0: //
sl@0: A utility class for patching references to persisted shared objects
sl@0: of the specified type.
sl@0: Code at the bottom of the header
sl@0: Used for clipboarding to i) patch references to paragraph styles
sl@0: ii) patch references to shared paragraph formats
sl@0: and also used in the appending of one rich text to another.
sl@0: @internalComponent
sl@0: */
sl@0: 	{
sl@0: public:
sl@0: 	static CRichTextStoreMap* NewLC(TInt aMaximumCapacity);
sl@0: 	~CRichTextStoreMap();
sl@0: 	//
sl@0: 	void Bind(TInt aRefNumber, T* aItem);
sl@0: 	void Bind(T* aS, T* aT);
sl@0: 	//
sl@0: 	T* Item(TInt aRefNo)const;
sl@0: 	T* Item(const T* aS)const;
sl@0: 	inline const TRichTextMapEntry& At(TInt aIndex)const;
sl@0: 	//
sl@0: 	inline TInt Count()const;
sl@0: 	//
sl@0: 	void __DbgTestInvariant()const;
sl@0: private:
sl@0: 	void ConstructL(TInt aMaximumCapacity);
sl@0: private:
sl@0: 	CArrayFixFlat<TRichTextMapEntry>* iMap;
sl@0: public:
sl@0: 	TInt iCapacity;
sl@0: 	};
sl@0: 
sl@0: 
sl@0: class TGlobalLayerInfoAppend
sl@0: /**
sl@0: @internalComponent
sl@0: */
sl@0: 	{
sl@0: public:
sl@0: 	TGlobalLayerInfoAppend();
sl@0: 	TGlobalLayerInfoAppend(const CParaFormatLayer* aAggParaFormatLayer, const CCharFormatLayer* aAggCharFormatLayer,
sl@0: 						   const CParaFormatLayer* aComParaFormatLayer, const CCharFormatLayer* aComCharFormatLayer);
sl@0: public:
sl@0: 	const CParaFormatLayer* iAggParaFormatLayer;
sl@0: 	const CCharFormatLayer* iAggCharFormatLayer;
sl@0: 	const CParaFormatLayer* iComParaFormatLayer;
sl@0: 	const CCharFormatLayer* iComCharFormatLayer;
sl@0: 	};
sl@0: 
sl@0: const TInt KSingleParaGranularity = 1;
sl@0: const TInt KMultiParaGranularity = 16;
sl@0: const TInt KSmallPhraseGranularity = 5;
sl@0: const TInt KLargePhraseGranularity = 16;
sl@0: const TUint32 KPhraseSplit = 0x01;
sl@0: const TUint32 KSpecificMarkupInternalized = 0x04;
sl@0: 
sl@0: /**
sl@0: @internalComponent
sl@0: */
sl@0: typedef CRichTextStoreMap<CParagraphStyle> CStyleMap;
sl@0: typedef CRichTextStoreMap<CParaAttribs> CParaAttribsMap;
sl@0: 
sl@0: /** Stores the paragraph and character formatting information for CRichText.
sl@0: 
sl@0: iParaIx stores the paragraph formatting, one entry per paragraph. Paragraphs
sl@0: are pieces of text delimited by the Unicode Paragraph Delimiter character
sl@0: U+2029.
sl@0: 
sl@0: iPhraseIx stores the character formatting.
sl@0: 
sl@0: Paragraph formatting information can be shared or not shared between
sl@0: paragraphs. Sharing is only permitted for paragraphs that do not have any
sl@0: character formatting applied to their text.
sl@0: 
sl@0: A phrase is a run of consistently formatted characters. A phrase may only
sl@0: contain a paragraph delimiter in its last character. In other words, phrases
sl@0: are not permitted to span paragraph boundaries.
sl@0: 
sl@0: iPhraseIx only stores formatting for the non-shared paragraphs. Therefore
sl@0: adding up the lengths of all the phrases in iPhraseIx will yield the sum of the
sl@0: non-shared paragraphs stored in iParaIx.
sl@0: 
sl@0: Note that the "nominal" paragraph delimiter at the end of the text which is not
sl@0: stored by CRichText is covered by both character and paragraph formatting. So
sl@0: the length of the final paragraph and final phrase (if appropriate) includes
sl@0: this character.
sl@0: 
sl@0: @internalComponent
sl@0: */
sl@0: class CRichTextIndex : public CBase
sl@0: 	{
sl@0: public:
sl@0: 	static CRichTextIndex* NewL(const CParaFormatLayer* aGlobalParaLayer, const CCharFormatLayer* aGlobalCharLayer,
sl@0: 								const CRichText& aText,
sl@0: 								TInt aParaGran,TInt aPhraseGran);
sl@0: 	static CRichTextIndex* NewL(const CStreamStore& aStore, TStreamId aId,
sl@0: 								const CParaFormatLayer* aGlobalParaLayer,
sl@0: 								const CCharFormatLayer* aGlobalCharLayer,
sl@0: 								const CRichText& aText);
sl@0: 	~CRichTextIndex();
sl@0: 	//
sl@0: 	// Store/Restore functions - Deferred loading of pictures
sl@0: 	TStreamId StoreMarkupL(CStreamStore& aStore, const CStyleList* aStyleList) const;
sl@0: 	//
sl@0: 	void RestoreL(const CStreamStore& aStore, TStreamId aId,
sl@0: 				  const CParaFormatLayer* aGlobalParaLayer, const CCharFormatLayer* aGlobalCharLayer,
sl@0: 				  const CStyleList* aStyleList);
sl@0: 	//
sl@0: 	void StorePicturesL(CStreamStore& aStore, CStoreMap& aMap) const;
sl@0: 	void StorePicturesL(CStreamStore& aStore, CStoreMap& aMap, TInt aPos, TInt aLength) const;
sl@0: 	void DetachFromStoreL(CPicture::TDetach aDegree, TInt aPos, TInt aLength);
sl@0: 	void ExternalizeL(RWriteStream& aStream) const;
sl@0: 	void InternalizeL(RReadStream& aStream, const CParaFormatLayer* aGlobalParaLayer, const CCharFormatLayer* aGlobalCharLayer,
sl@0: 					  const CStyleList* aStyleList);
sl@0: 	//
sl@0: 	// 3n Persist functions
sl@0: 	TBool HasMarkupData(const CFormatLayer* aGlobalParaFormatLayer) const;
sl@0: 	TPictureHeader PictureHeader(TInt aPos) const;
sl@0: 	TPictureHeader* PictureHeaderPtr(TInt aPos);
sl@0: 	//
sl@0: 	// Undo/CutPaste
sl@0: 	void CopyToStreamL(RWriteStream& aStream, TInt aPos, TInt aLength, TBool aCopyStyles) const;
sl@0: 	void PasteFromStreamL(const CStreamStore& aStore, RReadStream& aStream, TInt aPos, CParagraphStyle::TStylePasteMode aStylePasteMode, const CParaFormatLayer* aGlobalParaLayer, const CCharFormatLayer* aGlobalCharLayer);
sl@0: 	//
sl@0: 	// Content modifier functions
sl@0: 	void Reset(const CParaFormatLayer& aNormalParagraphStyle);
sl@0: 	void InsertL(TInt aPos, const TDesC& aBuf, const CParaFormatLayer& aGlobalParaFormatLayer);
sl@0: 	void InsertL(TInt aPos, const TPictureHeader& aPicHdr, TBool& aPictureOwnershipTaken);
sl@0: 	void SetForDeleteL(TIndexDeleteInfo& aInfo, TInt aPos, TInt aLength);
sl@0: 	TBool DeleteNow(TIndexDeleteInfo& aInfo);
sl@0: 	void DeleteFromParagraph(TInt aPos, TInt aLength);
sl@0: 	TBool DeleteParagraph(TInt aPos, TInt aLength);
sl@0: 	void Normalize(TInt aPos);
sl@0: 	//
sl@0: 	// Insert a new paragraph at position aPos, based on the 'Normal' global defaults.
sl@0: 	// Any explicit paragraph/character formatting is carried forward into this paragraph.
sl@0: 	void InsertParagraphL(TInt aPos, const CParaFormatLayer& aGlobalParaFormatLayer);
sl@0: 	//
sl@0: 	// Special behaviour format modifier functions.
sl@0: 	TBool InsertCharFormatIsActive();
sl@0: 	void SetInsertCharFormatL(const TCharFormatX& aFormat, const TCharFormatXMask& aMask, TInt aPos);
sl@0: 	void NewInsertCharFormatL(const TCharFormatX& aFormat,
sl@0: 		const TCharFormatXMask& aMask, TInt aPos);
sl@0: 	void UpdateInsertCharFormatL(const TCharFormatX& aFormat,
sl@0: 		const TCharFormatXMask& aMask);
sl@0: 	CCharFormatLayer* GetCurrentInsertCharFormat();
sl@0: 	void CancelInsertCharFormat();
sl@0: 	TBool DelSetInsertCharFormatL(TInt aPos, TInt aLength);
sl@0: 	//
sl@0: 	// Laydoc interface support
sl@0: 	void GetParagraphFormatL(CParaFormat* aFormat,TInt aPos) const;
sl@0: 	TInt GetChars(TCharFormatX& aFormat,TInt aPos) const;
sl@0: 	TInt GetPictureSizeInTwips(TSize& aSize, TInt aPos) const;
sl@0: 	CPicture* PictureHandleL(TInt aPos, MLayDoc::TForcePictureLoad aForceLoad) const;
sl@0: 	//
sl@0: 	// FormatText interface support
sl@0: 	void GetParaFormatL(CParaFormat* aFormat, TParaFormatMask& aUndeterminedMask, TInt aPos, TInt aLength,
sl@0: 						CParaFormat::TParaFormatGetMode aMode) const;
sl@0: 	void ApplyParaFormatL(const CParaFormat* aFormat, const TParaFormatMask& aMask, TInt aPos, TInt aLength);
sl@0: 	void GetCharFormat(TCharFormatX& aFormat, TCharFormatXMask& aMask,TInt aPos, TInt aLength) const;
sl@0: 	void ApplyCharFormatL(const TCharFormatX& aFormat, const TCharFormatXMask& aMask, TInt aPos, TInt aLength, TBool aRemoveSpecific = EFalse);
sl@0: 	void RemoveSpecificCharFormatL(TInt aPos, TInt aLength);
sl@0: 	void RemoveSpecificParaFormatL(TInt aPos, TInt aLength);
sl@0: 	//
sl@0: 	//
sl@0: 	void GetSpecificCharFormat(TCharFormatX& aFormat, TCharFormatXMask& aMask, TInt aPos) const;
sl@0: 	void GetSpecificCharFormatDirection(TCharFormatX& aFormat, TCharFormatXMask& aMask,
sl@0: 		TInt aPos, TBool aGetLeft) const;
sl@0: 	//
sl@0: 	// Paragraph style implementation
sl@0: 	void ApplyParagraphStyleL(const CParagraphStyle& aStyle, TInt aPos, TInt aLength, const CCharFormatLayer* aCharStyleNormal, CParagraphStyle::TApplyParaStyleMode aMode);
sl@0: 	void NotifyStyleChangedL(const CParagraphStyle* aTo, const CParagraphStyle* aFrom, const CParaFormatLayer& aGlobalParaFormatLayer, const CCharFormatLayer& aGlobalCharFormatLayer);
sl@0: 	const CParaFormatLayer* ParagraphStyle(TBool& aStylesChangesOverRange, TInt aPos, TInt aLength) const;
sl@0: 	//
sl@0: 	// Utility functions
sl@0: 	inline TInt ParagraphCount() const;
sl@0: 	TInt CharPosOfParagraph(TInt& aLength, TInt aParaOffset) const;
sl@0: 	TInt ParagraphNumberForPos(TInt& aPos) const;
sl@0: 	inline void SetSpecificMarkupInternalized(TBool aBool);
sl@0: 	inline TBool SpecificMarkupInternalized() const;
sl@0: 	void DocumentChanged()const;
sl@0: 	//
sl@0: 	// Speciality functions
sl@0: 	void AppendTakingSolePictureOwnershipL(const CRichTextIndex* aSource, const TGlobalLayerInfoAppend& aGlobalLayerInfo);
sl@0: 	void AppendParagraphL(const CParaFormatLayer* aGlobalParaFormatLayer, const CCharFormatLayer* aGlobalCharFormatLayer,
sl@0: 						  TInt aReplicas);
sl@0: 	TInt SharedParaCount(const CRichTextIndex* aSource) const;
sl@0: 	void GetSpecificParagraphFormatL(CParaFormat* aFormat,
sl@0: 									 TParaFormatMask& aMask,
sl@0: 									 TInt aPos) const;
sl@0: private:
sl@0: 	enum TScanToPositionMode {EScanToPositionMatchLeft, EScanToPositionAbsolute};
sl@0: 	enum {EInsertCharFormatReset = -1};
sl@0: 	enum TPositionOrPhrase 	{EPositionOnly, EFollowingPhrase};
sl@0: private:
sl@0: 	CRichTextIndex(const CRichText& aText);
sl@0: 	void ConstructL(const CParaFormatLayer* aGlobalParaFormat, const CCharFormatLayer* aGlobalCharFormat, TInt aParaGran, TInt aPhraseGran);
sl@0: 	//
sl@0: 	// Persistence/Copy,Paste
sl@0: 	void InternalizeRtiHeaderL(RReadStream& aStream, TRtPasteContext& aContext);
sl@0: 	void ExternalizeRtiHeaderL(RWriteStream& aStream, const TLogicalPosition& aEnd, const CStyleList* aStyleList) const;
sl@0: 	void ExternalizeReferencedStylesL(RWriteStream& aStream, const TLogicalPosition& aStart, const TLogicalPosition& aEnd) const;
sl@0: 	void InternalizeSharedFormatsL(RReadStream& aStream, const TRtPasteContext& aContext);
sl@0: 	void ExternalizeSharedFormatsL(RWriteStream& aStream, const TLogicalPosition& aStart, const TLogicalPosition& aEnd, const CStyleList* aStyleList) const;
sl@0: 	void InternalizeParaIxL(RReadStream& aStream, const TRtPasteContext& aContext);
sl@0: 	void ExternalizeParagraphFormatL(RWriteStream& aStream, const CParaFormatLayer& aSpecificParaFormatLayer, const CStyleList* aStyleList) const;
sl@0: 	CParaFormatLayer* InternalizeParagraphFormatL(RReadStream& aStream, const TRtPasteContext& aContext);
sl@0: 	CParaFormatLayer* PasteParagraphFormatL(RReadStream& aStream, const TRtPasteContext& aContext, CStyleMap* styleMap);
sl@0: 	RPhraseAttribsEntry* ExternalizeParaIxL(RWriteStream& aStream, const TLogicalPosition& aStart,
sl@0: 					const TLogicalPosition& aEnd, const CStyleList* aStyleList) const;
sl@0: 	void InternalizePhraseIxL(RReadStream& aStream, const CCharFormatLayer* aGlobalCharFormat);
sl@0: 	void ExternalizePhraseIxL(RWriteStream& aStream) const;
sl@0: 	void ExternalizePhraseIxL(RWriteStream& aStream,
sl@0: 							  const TLogicalPosition& aStartPos,
sl@0: 							  TLogicalPosition& aEndPos,
sl@0: 							  const RPhraseAttribsEntry* aVirtualTrailingText) const;
sl@0: 	inline void ExternalizePhraseCountL(RWriteStream& aStream, TInt aPhraseCount) const;
sl@0: 	void ExternalizePhrasesL(RWriteStream& aStream, TInt aStart, TInt aPhraseCount, const RPhraseAttribsEntry* aVirtualPhrase = NULL) const;
sl@0: 	TInt MarkStyleRegister(TDes8& aBuf, TInt aStartPara, TInt aEndPara) const;
sl@0: 	TInt MarkRegister(TDes8& aBuf, TInt aStartPara, TInt aEndPara) const;
sl@0: 	void GenerateAllPhraseLinksL();
sl@0: 	void GeneratePhraseLink(CCharFormatLayer* aPhraseCharFormatLayer, const CParaFormatLayer* aBase);
sl@0: 	void ExternalizeItemsPresentInStyleRegisterL(RWriteStream& aStream, TInt aRefStyleCount, const TDes8& aBuf) const;
sl@0: 	void ExternalizeItemsPresentInRegisterL(RWriteStream& aStream, TInt aParaCount, const TDes8& aBuf, const CStyleList* aStyleList) const;
sl@0: 	CParaAttribs* SharedParaAttribs(TUint8 aOrdinal);
sl@0: 	TUint8 RefNum(const CParaAttribs* aParaAttribs) const;
sl@0: 	//
sl@0: 	// Copy,Paste
sl@0: 	void PasteStylesL(RReadStream& aStream, CStyleMap& aMap, const TRtPasteContext& aContext);
sl@0: 	void PasteSharedFormatsL(RReadStream& aStream, CParaAttribsMap& aMap, const TRtPasteContext& aContext, CStyleMap* aStyleMap);
sl@0: 	void ImposeCharacterStyleL(CCharFormatLayer** aCharLayer);
sl@0: 	void PasteIxL(RReadStream& aStream, TRtPasteContext& aContext, const CParaAttribsMap& aMap, CStyleMap* aStyleMap/*,CParaAttribs* aSecondReserved*/);
sl@0: 	TInt PasteParaIxL(RReadStream& aStream, TRtPasteContext& aContext, TInt aCompleteParaCount, const CParaAttribsMap& aMap, RPhraseAttribsEntry*& aFirstParaVirtualPhrase, CStyleMap* aStyleMap);
sl@0: 	TParaAttribsEntry DoPasteIntoParaL(RReadStream& aStream, const CParaAttribsMap& aMap, const TRtPasteContext& aContext, CStyleMap* aStyleMap);
sl@0: 	TParaAttribsEntry DoPasteFirstIntoParaL(RReadStream& aStream, const CParaAttribsMap& aMap, const TRtPasteContext& aContext, RPhraseAttribsEntry*& aFirstParaVirtualPhrase, CStyleMap* aStyleMap);
sl@0: 	void DoPasteCleanup(TLogicalPosition& aNormalizePos, CParaAttribs* aReclaimed);
sl@0: 	TTextFragment GetTextFragmentL(RReadStream& aStream);
sl@0: 	void PastePhraseIxL(RReadStream& aStream, TRtPasteContext& aContext, const RPhraseAttribsEntry* aFirstParaVirtualPhrase);
sl@0: 	void DoPastePhraseL(RReadStream& aStream, const TRtPasteContext& aContext, RPhraseAttribsEntry& aPhrase);
sl@0: 	void RbPasteSharedFormatsL(TInt aRet);
sl@0: 	void NormalizeSharedList();
sl@0: 	void RbRemoveInsertedParaAttribsEntries(TInt aFirstParaInsertPos, TInt aInsertedParaCount);
sl@0: 	void RbPasteParaIxL(const TLogicalPosition& aPastePos, TInt aParaCount, TInt aRet);
sl@0: 	void RbPastePhraseIxL(const TLogicalPosition& aPos,TInt aPhraseCount, TInt aRet);
sl@0: 	void RbRemoveInsertedPhraseAttribsEntries(TInt aFirstPhraseInsertPos, TInt aInsertedPhraseCount);
sl@0: 	TUint8 ReadTUint8CountL(RReadStream& aStream) const;
sl@0: 	//
sl@0: 	// General utility
sl@0: 	void DoSoloInsertL(TInt aPos, TInt aLength);
sl@0: 	void ScanToPosition(TInt aCharPos, TScanToPositionMode aMode, TLogicalPosition* aLastUsed=NULL);  // Reset the logical position to the passed document position.
sl@0: 	inline TInt PhraseCount() const;
sl@0: 	TBool FirstPhraseOfParagraph() const;  // Interrogates current iPos record.
sl@0: 	TInt CurrentPhraseLength() const;  // Encapsulates constant/specific character formatting.
sl@0: 	TInt CurrentPhraseOffset() const;  // Encapsulates constant/specific character formatting.
sl@0: 	void CheckForUndetermined(const TCharFormatX& aFormatA, const TCharFormatX& aFormatB, TCharFormatXMask& aVaries) const;
sl@0: 	void GetCurrentRecords(TCurrentIndexRecords& aRecord) const;
sl@0: 	void GetPhraseFormat(TCurrentIndexRecords& aCurrent, TCharFormatX& aFormat, TCharFormatXMask& aMask, CCharFormatLayer*& aCharBase) const;
sl@0: 	TInt OwningParagraph(TInt aPos, TLogicalPosition* aLastUsed = NULL) const;
sl@0: 	TBool MergePhrases(TInt aPos);
sl@0: 	TBool MergePhrases(const TLogicalPosition& aPos);
sl@0: 	TBool DeleteInsertCharFormat();
sl@0: 	void ConsolidateAt(TInt aPosition, TPositionOrPhrase aPositionOrPhrase);
sl@0: 	void RemoveFromPhraseIx(TInt aPos, TInt aCount = 1);
sl@0: 	void SplitPhraseL(TInt aSplitPos);
sl@0: 	void SplitPhraseL(TInt aPhraseElement, TInt aPhraseOffset, CParaAttribs* aParaAttribs);
sl@0: 	void DoSplitPhraseL(RPhraseAttribsEntry& aCurrentPhrase, TInt aPhraseOffset, CParaAttribs* aParaAttribs);
sl@0: 	TUint8 SharedParaAttribsEntryCountL() const;
sl@0: 	void ModifySpecificFormatting(CParaFormatLayer& aPl, CCharFormatLayer& aCl, CParagraphStyle::TApplyParaStyleMode aMode);
sl@0: //
sl@0: // support for applycharformat
sl@0: 	static void ApplyCharFormatCleanup(TAny* aPtr);
sl@0: 	void ApplyCharFormatRollback();
sl@0: 	TInt MergePhrases(TInt aPhrase, RPhraseAttribsEntry& aPhraseAttribs, CParaAttribs& aParaAttribs);
sl@0: 	void SplitPhraseL(TInt aPhrase, TInt anOffset, RPhraseAttribsEntry& aPhraseAttribs, CParaAttribs& aParaAttribs);
sl@0: 	void Share(TParaAttribsEntry& aParaEntry, TInt aPhrase);
sl@0: 	//
sl@0: 	// Specific rollback
sl@0: 	void RbInsertPicture(CParaAttribs* aGoodParaAttribs);
sl@0: 	//
sl@0: 	// General implementation
sl@0: 	void NormalizeNow(const TLogicalPosition& aNormalizePos);
sl@0: 	TBool DeleteParagraphText(TInt& aLength);
sl@0: 	TBool DoDeleteFromParagraph(const TIndexDeleteInfo& aInfo);
sl@0: 	void TidyAfterDelete(const TIndexDeleteInfo& aInfo);
sl@0: 	CParaAttribs* ReserveCellL();
sl@0: 	CParaAttribs* ReserveCellLC();
sl@0: 	void DoNewInsertCharFormatL(const TCharFormatX& aFormat,
sl@0: 		const TCharFormatXMask& aMask, CCharFormatLayer* aBasedOn,
sl@0: 		CParaAttribs* aParaAttribs);
sl@0: 	TInt ParaLengthFromBuffer(TDesC& aBuf) const;
sl@0: 	inline const CStreamStore* ResolvedStreamStore(TInt aPos) const;
sl@0: 	//
sl@0: 	// Agenda functions
sl@0: 	void AppendSharedFormatsL(CParaAttribsMap& aMap, const CRichTextIndex* aSource, const TGlobalLayerInfoAppend& aGlobalLayerInfo);
sl@0: 	void AppendParaIndexL(const CRichTextIndex* aSource, const TGlobalLayerInfoAppend& aGlobalLayerInfo);
sl@0: 	void AppendPhraseIndexL(const CRichTextIndex* aSource, const TGlobalLayerInfoAppend& aGlobalLayerInfo);
sl@0: 	//
sl@0: 	// Shared list management utilities
sl@0: 	CParaAttribs* RequestReclaimShareL(CParaAttribs* aParaAttribs, TParaAttribsEntry* aParaEntry);
sl@0: 	CParaAttribs* RequestShareL(CParaAttribs* aParaAttribs, CCharFormatLayer* aCharFormat = NULL, CParaAttribs* aReservedCell = NULL);
sl@0: 	CParaAttribs* GetParaAttribsL(const CParaFormatLayer* aParaFormat, const CCharFormatLayer* aCharFormat, CParaAttribs* aReservedCell = NULL);
sl@0: 	CParaAttribs* RequestShare(const TLogicalPosition& aLogicalPosition);
sl@0: 	CParaAttribs* GetParaAttribs(const TLogicalPosition& aLogicalPosition);
sl@0: 	CParaAttribs* GetParaAttribs(CParaAttribs* aParaAttribs, CCharFormatLayer& aCharFormatLayer);
sl@0: 	CParaAttribs* FindSharedParaAttribs(const CParaFormatLayer& aParaFormatLayer, const CCharFormatLayer& aCharFormatLayer);
sl@0: 	void RebalanceIndex();
sl@0: 	void SplitParagraphAtPastePosL(TLogicalPosition& aPastePos, TLogicalPosition& aNewPos,
sl@0: 								   const CParaFormatLayer& aGlobalParaFormatLayer);
sl@0: 	//
sl@0: 	inline void SetPhraseSplit(TBool aBool);
sl@0: 	inline TBool PhraseSplit() const;
sl@0: private:
sl@0: 	const CRichText& iText;  // backward reference to owning rich text.
sl@0: 	TUint32 iFlags;
sl@0: 	TInt iPendingNewPhrasePos;  // When *INSERTSTATE* is active, this is used to place the zero-length phrase.
sl@0: 	CParaAttribs* iRollbackParaAttribsHandle;
sl@0: 	__MUTABLE TDblQue<CParaAttribs> iSharedParaQueHead;
sl@0: 	__MUTABLE TLogicalPosition iLastUsed;
sl@0: 	CCharFormatLayer* iLastCharacterStyle;
sl@0: public:
sl@0: 	CArrayFixSeg<TParaAttribsEntry>* iParaIx;  // One entry per paragraph
sl@0: 	CArrayFixSeg<RPhraseAttribsEntry>* iPhraseIx;  // One entry per phrase in the rich text
sl@0: 	__MUTABLE TLogicalPosition iPos;
sl@0: 	TInt iPictureCount;  // a count of the number of pictures contained by this text
sl@0: 
sl@0: 	__DECLARE_TEST;
sl@0: 	};
sl@0: 
sl@0: ////////////////////////////////////////
sl@0: 
sl@0: template <class T>
sl@0: void CRichTextStoreMap<T>::__DbgTestInvariant() const
sl@0: // Provides class invariants.  Explanations below:
sl@0: //
sl@0: 	{
sl@0: #ifdef _DEBUG
sl@0: 	TInt count = Count();
sl@0: 	for (TInt ii = 0; ii < count; ii++)
sl@0: 		{
sl@0: 		TInt ref = (*iMap)[ii].iRefNumber;
sl@0: 		__ASSERT_DEBUG(ref > 0, User::Invariant());
sl@0: 		}
sl@0: #endif
sl@0: 	}
sl@0: 
sl@0: 
sl@0: template <class T>
sl@0: CRichTextStoreMap<T>* CRichTextStoreMap<T>::NewLC(TInt aMaximumCapacity)
sl@0: // Return a handle to a new instance of this class.
sl@0: //
sl@0: 	{
sl@0: 	CRichTextStoreMap* self = new(ELeave) CRichTextStoreMap();
sl@0: 	CleanupStack::PushL(self);
sl@0: 	self->ConstructL(aMaximumCapacity);
sl@0: 	return self;
sl@0: 	}
sl@0: 
sl@0: 
sl@0: 
sl@0: template <class T>
sl@0: void CRichTextStoreMap<T>::ConstructL(TInt aMaximumCapacity)
sl@0: //
sl@0: //
sl@0: 	{
sl@0: 	if (aMaximumCapacity > 0)
sl@0: 		{
sl@0: 		iMap = new(ELeave) CArrayFixFlat<TRichTextMapEntry>(aMaximumCapacity);
sl@0: 		iMap->SetReserveL(aMaximumCapacity);	// never need to allocate memory
sl@0: 		}
sl@0: 	iCapacity = aMaximumCapacity;
sl@0: 	}
sl@0: 
sl@0: 
sl@0: template <class T>
sl@0: CRichTextStoreMap<T>::~CRichTextStoreMap()
sl@0: //
sl@0: //
sl@0: 	{delete iMap;}
sl@0: 
sl@0: 
sl@0: template <class T>
sl@0: void CRichTextStoreMap<T>::Bind(TInt aRef, T* aT)
sl@0: //
sl@0: //
sl@0: 	{
sl@0: 	__TEST_INVARIANT;
sl@0: 	__ASSERT_ALWAYS(Count() <= iCapacity, Panic(ESharedFormatsMapOverFlow));
sl@0: 
sl@0: 	TRichTextMapEntry entry(aRef, aT);
sl@0: 	iMap->AppendL(entry);  // will not fail: we have reserved the space
sl@0: 
sl@0: 	__TEST_INVARIANT;
sl@0: 	}
sl@0: 
sl@0: 
sl@0: 
sl@0: template <class T>
sl@0: void CRichTextStoreMap<T>::Bind(T* aS, T* aT)
sl@0: //
sl@0: //
sl@0: 	{
sl@0: 	__TEST_INVARIANT;
sl@0: 	__ASSERT_ALWAYS(Count() <= iCapacity, Panic(ESharedFormatsMapOverFlow));
sl@0: 
sl@0: 	TRichTextMapEntry entry(aS, aT);
sl@0: 	iMap->AppendL(entry);  // will not fail: we have reserved the space
sl@0: 
sl@0: 	__TEST_INVARIANT;
sl@0: 	}
sl@0: 
sl@0: 
sl@0: template <class T>
sl@0: T* CRichTextStoreMap<T>::Item(TInt aRef) const
sl@0: //
sl@0: //
sl@0: 	{
sl@0: 	TInt count = Count();
sl@0: 	if (count > 0)
sl@0: 		{
sl@0: 		const TRichTextMapEntry* entry = &(*iMap)[0];
sl@0: 		for (const TRichTextMapEntry* end = entry + count; entry < end; entry++)
sl@0: 			{
sl@0: 			if (entry->iRefNumber == aRef)
sl@0: 				return (T*)entry->iT;
sl@0: 			}
sl@0: 		}
sl@0: 	return NULL;
sl@0: 	}
sl@0: 
sl@0: 
sl@0: template <class T>
sl@0: T* CRichTextStoreMap<T>::Item(const T* aS) const
sl@0: //
sl@0: //
sl@0: 	{
sl@0: 	TInt count = Count();
sl@0: 	if (count > 0)
sl@0: 		{
sl@0: 		const TRichTextMapEntry* entry = &(*iMap)[0];
sl@0: 		for (const TRichTextMapEntry* end = entry + count; entry < end; entry++)
sl@0: 			{
sl@0: 			if (entry->iS == (TAny*)aS)
sl@0: 				return (T*)entry->iT;
sl@0: 			}
sl@0: 		}
sl@0: 	return NULL;
sl@0: 	}
sl@0: 
sl@0: 
sl@0: #include "TXTINDEX.INL"
sl@0: 
sl@0: 
sl@0: #endif