1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/textandloc/textrendering/texthandling/stext/TXTRTSTR.CPP Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,511 @@
1.4 +/*
1.5 +* Copyright (c) 2003-2009 Nokia Corporation and/or its subsidiary(-ies).
1.6 +* All rights reserved.
1.7 +* This component and the accompanying materials are made available
1.8 +* under the terms of "Eclipse Public License v1.0"
1.9 +* which accompanies this distribution, and is available
1.10 +* at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.11 +*
1.12 +* Initial Contributors:
1.13 +* Nokia Corporation - initial contribution.
1.14 +*
1.15 +* Contributors:
1.16 +*
1.17 +* Description:
1.18 +*
1.19 +*/
1.20 +
1.21 +
1.22 +#include <e32std.h>
1.23 +#include <e32base.h>
1.24 +
1.25 +#include "TXTRICH.H"
1.26 +
1.27 +#include "TXTINDEX.H"
1.28 +#include "TXTSTD.H"
1.29 +#include "TXTRTPFL.H"
1.30 +#include "ParseLst.h"
1.31 +
1.32 +#include "OstTraceDefinitions.h"
1.33 +#ifdef OST_TRACE_COMPILER_IN_USE
1.34 +#include "TXTRTSTRTraces.h"
1.35 +#endif
1.36 +
1.37 +#ifdef SYMBIAN_ENABLE_SPLIT_HEADERS
1.38 +#include "TXTETEXT_INTERNAL.H"
1.39 +#include "TXTRICH_INTERNAL.H"
1.40 +#endif
1.41 +
1.42 +///////////////////////////////////////////////////////////
1.43 +//
1.44 +// Default persist functions - Deferred loading of pictures
1.45 +//
1.46 +///////////////////////////////////////////////////////////
1.47 +
1.48 +
1.49 +EXPORT_C void CRichText::RestoreWithStyleListL(const CStreamStore& aStore, TStreamId aStreamId, const CStyleList& aExternalStyleList)
1.50 +/** Restores a rich text object, including all of its components and an
1.51 +externally owned style list, from a stream store.
1.52 +
1.53 +@param aStore Stream store from which the object is restored.
1.54 +@param aStreamId ID of the stream store.
1.55 +@param aExternalStyleList An externally owned style list. */
1.56 + {
1.57 + RStoreReadStream stream;
1.58 + stream.OpenLC(aStore,aStreamId);
1.59 + //
1.60 + InternalizeL(stream,&aExternalStyleList);
1.61 + CleanupStack::PopAndDestroy(); // stream
1.62 + RestoreComponentsL(aStore);
1.63 + }
1.64 +
1.65 +EXPORT_C void CRichText::StoreComponentsL(CStreamStore& aStore, CStoreMap& aMap) const
1.66 +/** Stores the rich text object's components (field set, style list, formatting
1.67 +and pictures) to the stream store specified.
1.68 +
1.69 +@param aStore Stream store to which the text components are written.
1.70 +@param aMap A store map. This binds the address of text components to the
1.71 +stream ID of aStore. This is needed to support the deferred loading of pictures
1.72 +in rich text. */
1.73 + {
1.74 + CGlobalText::StoreComponentsL(aStore,aMap);
1.75 + StoreStylesL(aStore,aMap);
1.76 + StoreMarkupL(aStore,aMap);
1.77 + }
1.78 +
1.79 +EXPORT_C void CRichText::RestoreComponentsL(const CStreamStore& aStore)
1.80 +/** Restores the rich text object's components (field set, style list,
1.81 + formatting and pictures) from a stream store.
1.82 +
1.83 +@param aStore The stream store from which the text object's components are
1.84 +restored. */
1.85 + {
1.86 + CPlainText::RestoreComponentsL(aStore); // field components
1.87 + if (iStyleList.IsId() && iStyleList.AsId()!=KNullStreamId)
1.88 + RestoreStylesL(aStore,iStyleList.AsId(),iGlobalParaFormatLayer,iGlobalCharFormatLayer);
1.89 + if (iIndex.AsId()!=KNullStreamId)
1.90 + iIndex=CRichTextIndex::NewL(aStore,iIndex.AsId(),iGlobalParaFormatLayer,iGlobalCharFormatLayer,*this);
1.91 + }
1.92 +
1.93 +
1.94 +
1.95 +EXPORT_C void CRichText::ExternalizeL(RWriteStream& aStream)const
1.96 +/** Externalises the rich text object and all of its components (field set,
1.97 +style list, rich text formatting, pictures) to a read stream. The presence
1.98 +of this function means that the standard templated operator<<() (defined in
1.99 +s32strm.h) is available to externalise objects of this class.
1.100 +
1.101 +Notes:
1.102 +
1.103 +Any "insert pending" state is cancelled (calls CancelInsertCharFormat()).
1.104 +
1.105 +The global format layers are not owned by the object; they are supplied by
1.106 +the owner of the object and not saved when the object is externalised or loaded
1.107 +when it is internalized.
1.108 +
1.109 +StoreComponentsL() must be called before calling this function. This is necessary to set
1.110 +up the the stream store needed to externalize rich text objects. It is not possible to get
1.111 +a stream store into a stream and a rich text object cannot be externalized to an arbitrary
1.112 +stream thus StoreComponentsL() will set up this stream store before externalizing.
1.113 +
1.114 +The inherited function CEditableText::StoreL() combines both calling of StoreComponentsL()
1.115 +to set up the stream store and externalizing the rich text object to this stream store.
1.116 +
1.117 +@param aStream Stream to which to write the rich text object. */
1.118 + {
1.119 + __TEST_INVARIANT;
1.120 +
1.121 + CONST_CAST(CRichText*,this)->CancelInsertCharFormat();
1.122 + CEditableText::ExternalizeL(aStream);
1.123 + DoExternalizeFieldDataL(aStream);
1.124 + DoExternalizeStyleDataL(aStream);
1.125 + DoExternalizeMarkupDataL(aStream);
1.126 + DoExternalizePlainTextL(aStream);
1.127 + }
1.128 +
1.129 +
1.130 +EXPORT_C void CRichText::InternalizeL(RReadStream& aStream)
1.131 +/** Internalises the rich text object and all of its components (field set,
1.132 +style list, rich text formatting and pictures) from a read stream. The
1.133 +presence of this function means that the standard templated operator>>()
1.134 +(defined in s32strm.h) is available to internalise objects of this class.
1.135 +
1.136 +Note: The global format layers are not owned by the object; they are supplied by
1.137 +the owner of the object and not saved when the object is externalised or loaded
1.138 +when it is internalized.
1.139 +
1.140 +@param aStream Stream from which to read the rich text object. */
1.141 + {InternalizeL(aStream,NULL);}
1.142 +
1.143 +
1.144 +void CRichText::InternalizeL(RReadStream& aStream,const CStyleList* aExternalStyleList)
1.145 +// Restore this rich text object.
1.146 +// The global format layers are not present in this persistent state.
1.147 +//
1.148 + {
1.149 + CEditableText::InternalizeL(aStream);
1.150 + DoInternalizeFieldDataL(aStream);
1.151 + DoInternalizeStyleDataL(aStream,aExternalStyleList);
1.152 + DoInternalizeMarkupDataL(aStream);
1.153 + DoInternalizePlainTextL(aStream);
1.154 + if (iParserData == NULL)
1.155 + iParserData = new(ELeave) CParserData(DocumentLength());
1.156 + iParserData->KillRange();
1.157 + iParserData->MergeRange(0,0,DocumentLength());
1.158 + CallEditObserver(0,DocumentLength());
1.159 + }
1.160 +
1.161 +
1.162 +void CRichText::StoreStylesL(CStreamStore& aStore,CStoreMap& aMap)const
1.163 +// Write the style list, if present, out of line.
1.164 +//
1.165 + {
1.166 + if (StyleListPresent() && !StyleListExternallyOwned())
1.167 + {
1.168 + TStreamId id=iStyleList->StoreL(aStore);
1.169 + aMap.BindL(iStyleList,id);
1.170 + }
1.171 + }
1.172 +
1.173 +
1.174 +void CRichText::RestoreStylesL(const CStreamStore& aStore,TStreamId aId,const CParaFormatLayer* aParaFormatLayer,const CCharFormatLayer* aCharFormatLayer)
1.175 +// Restore the style list
1.176 +//
1.177 + {
1.178 + RStoreReadStream stream;
1.179 + stream.OpenLC(aStore,aId);
1.180 + //
1.181 + iStyleList=CStyleList::NewL(stream,aParaFormatLayer,aCharFormatLayer);
1.182 + CleanupStack::PopAndDestroy(); // stream
1.183 + }
1.184 +
1.185 +
1.186 +void CRichText::StoreMarkupL(CStreamStore& aStore,CStoreMap& aMap)const
1.187 +// Write the index/markup data, if present, out of line.
1.188 +//
1.189 + {
1.190 + if (IndexPresent())
1.191 + {
1.192 + TStreamId id=iIndex->StoreMarkupL(aStore,iStyleList);
1.193 + aMap.BindL(iIndex,id);
1.194 + }
1.195 + }
1.196 +
1.197 +
1.198 +EXPORT_C void CRichText::DoExternalizeStyleDataL(RWriteStream& aStream)const
1.199 +// Write to the stream, the T.V. representing the style definitions.
1.200 +//
1.201 + {
1.202 + aStream<< KRichTextStyleDataUid;
1.203 + if (StyleListPresent() && !StyleListExternallyOwned())
1.204 + aStream<< iStyleList;
1.205 + else
1.206 + aStream<< KNullStreamId;
1.207 + }
1.208 +
1.209 +
1.210 +EXPORT_C void CRichText::DoInternalizeStyleDataL(RReadStream& aStream)
1.211 +// Load the out-of-line component representing the style list.
1.212 +//
1.213 + {DoInternalizeStyleDataL(aStream,NULL);}
1.214 +
1.215 +
1.216 +void CRichText::DoInternalizeStyleDataL(RReadStream& aStream,const CStyleList* aExternalStyleList)
1.217 +// Load the out-of-line component representing the style list.
1.218 +//
1.219 + {
1.220 + TUid uid=UidFromStreamL(aStream);
1.221 + while (uid!=KRichTextStyleDataUid)
1.222 + {
1.223 + if (uid==KPlainTextCharacterDataUid)
1.224 + User::Leave(KErrCorrupt); // There is no style or markup Data !!!!!
1.225 + CPlainText::ConsumeAdornmentL(aStream);
1.226 + uid=UidFromStreamL(aStream);
1.227 + }
1.228 + aStream>> iStyleList;
1.229 + if (aExternalStyleList)
1.230 + iStyleList=CONST_CAST(CStyleList*,aExternalStyleList);
1.231 + }
1.232 +
1.233 +
1.234 +
1.235 +EXPORT_C void CRichText::DoExternalizeMarkupDataL(RWriteStream& aStream)const
1.236 +// Write to the stream, the T.V. representing the markup.
1.237 +//
1.238 + {
1.239 + aStream<< KRichTextMarkupDataUid;
1.240 + aStream<< iIndex; // the specific markup
1.241 + }
1.242 +
1.243 +
1.244 +EXPORT_C void CRichText::DoInternalizeMarkupDataL(RReadStream& aStream)
1.245 +// Load the out-of-line component representing the markup data.
1.246 + {
1.247 + TUid uid=UidFromStreamL(aStream);
1.248 + while (uid!=KRichTextMarkupDataUid)
1.249 + {
1.250 + if (uid==KPlainTextCharacterDataUid)
1.251 + User::Leave(KErrCorrupt); // There is no style or markup Data !!!!!
1.252 + CPlainText::ConsumeAdornmentL(aStream);
1.253 + uid=UidFromStreamL(aStream);
1.254 + }
1.255 + KillIndex(); // prevent alloc heaven when current index handle is lost to internalized swizzle
1.256 + aStream>> iIndex;
1.257 + }
1.258 +
1.259 +
1.260 +///////////////////////////////////////////////////////////
1.261 +//
1.262 +// Custom persist functions
1.263 +//
1.264 +///////////////////////////////////////////////////////////
1.265 +
1.266 +
1.267 +
1.268 +
1.269 +EXPORT_C void CRichText::ExternalizeStyleDataL(RWriteStream& aStream)const
1.270 +/** Externalises the style list owned by the rich text object.
1.271 +
1.272 +@param aStream Stream to which to write the style list. */
1.273 + {
1.274 + __TEST_INVARIANT;
1.275 +
1.276 + if (StyleListPresent() && !StyleListExternallyOwned())
1.277 + {
1.278 + aStream.WriteUint8L((TUint8)1); // there follows a style list
1.279 + aStream<< *iStyleList;
1.280 + }
1.281 + else
1.282 + aStream.WriteUint8L((TUint8)0); // there are no paragraph styles
1.283 + }
1.284 +
1.285 +EXPORT_C void CRichText::InternalizeStyleDataL(RReadStream& aStream)
1.286 +/** Internalises the style list owned by the rich text object from a read stream,
1.287 +if one is present in the stream.
1.288 +
1.289 +@param aStream Stream from which to read the style list. */
1.290 + {
1.291 + TUint8 styleListPresent=aStream.ReadUint8L();
1.292 + if (styleListPresent)
1.293 + {
1.294 + CStyleList* styleList=CStyleList::NewL(aStream,iGlobalParaFormatLayer,iGlobalCharFormatLayer);
1.295 + //coverity[leave_without_push]
1.296 + delete iStyleList.AsPtr();
1.297 + iStyleList=styleList;
1.298 + }
1.299 + }
1.300 +
1.301 +EXPORT_C void CRichText::ExternalizeMarkupDataL(RWriteStream& aStream)const
1.302 +/** Externalises the rich text object's markup (specific formatting, styles and
1.303 +pictures). CRichText::HasMarkupData() can be used to test whether the object
1.304 +has any markup information.
1.305 +
1.306 +@param aStream Stream to which to store the rich text markup information. */
1.307 + {
1.308 + __TEST_INVARIANT;
1.309 +
1.310 + CONST_CAST(CRichText*,this)->CancelInsertCharFormat();
1.311 + if (!IndexPresent())
1.312 + CONST_CAST(CRichText*,this)->CreateAndGenerateMarkupComponentL();
1.313 + aStream<< *iIndex;
1.314 + }
1.315 +
1.316 +EXPORT_C void CRichText::InternalizeMarkupDataL(RReadStream& aStream)
1.317 +/** Internalises the rich text object's markup (specific formatting, styles and
1.318 +pictures).
1.319 +
1.320 +@param aStream Stream from which to internalise the rich text markup. */
1.321 + {
1.322 + KillIndex();
1.323 + CreateEmptyMarkupComponentL(); // set iIndex::iStyleList
1.324 + iIndex->InternalizeL(aStream,iGlobalParaFormatLayer,iGlobalCharFormatLayer,iStyleList.AsPtr());
1.325 + }
1.326 +
1.327 +EXPORT_C void CRichText::StoreMarkupComponentsL(CStreamStore& aStore,CStoreMap& aMap)const
1.328 +/** Stores all pictures in the rich text object to a stream store.
1.329 +
1.330 +@param aStore Stream store to which the pictures are to be stored.
1.331 +@param aMap A store map. This binds the address of pictures to the stream ID
1.332 +of aStore. This is needed to support the deferred loading of pictures. */
1.333 + {
1.334 + __TEST_INVARIANT;
1.335 +
1.336 + if (!IndexPresent())
1.337 + CONST_CAST(CRichText*,this)->CreateAndGenerateMarkupComponentL();
1.338 + iIndex->StorePicturesL(aStore,aMap);
1.339 + }
1.340 +
1.341 +
1.342 +///////////////////////////////////////////////////////////
1.343 +//
1.344 +// Utility persist functions
1.345 +//
1.346 +///////////////////////////////////////////////////////////
1.347 +
1.348 +EXPORT_C TBool CRichText::HasMarkupData()const
1.349 +/** Tests whether the rich text object has any markup, or owns a style list.
1.350 +
1.351 +Markup is rich text-specific information, for instance specific formatting,
1.352 +styles and pictures. It may be stored in a separate stream from the text.
1.353 +
1.354 +@return ETrue if the rich text object has markup, or owns a style list. EFalse
1.355 +if not. */
1.356 + {
1.357 + if (StyleListPresent() && !StyleListExternallyOwned())
1.358 + return ETrue;
1.359 + if (IndexPresent())
1.360 + return iIndex->HasMarkupData(iGlobalParaFormatLayer);
1.361 + else
1.362 + return EFalse;
1.363 + }
1.364 +
1.365 +
1.366 +
1.367 +
1.368 +EXPORT_C void CRichText::DetachFromStoreL(CPicture::TDetach aDegree)
1.369 +/** Loads pictures not already present in memory overloaded function.
1.370 +Either loads all pictures in the document, or just the pictures located within
1.371 +a specified range. Note: In order to load pictures, a picture factory and a
1.372 +store resolver must have been set.
1.373 +
1.374 +@param aDegree There are two possible values: EDetachFull and EDetachDraw.
1.375 +If you detach using EDetachFull then you can both draw and edit the picture(s),
1.376 +but if you detach with EDetachDraw then you can only draw them any attempt
1.377 +at editing them causes a panic.
1.378 +@param aPos The start of the range of characters to search.
1.379 +@param aLength The number of characters in the range. */
1.380 + {
1.381 + __ETEXT_WATCH(DETACH);
1.382 +
1.383 + __TEST_INVARIANT;
1.384 +
1.385 + if (IndexPresent())
1.386 + iIndex->DetachFromStoreL(aDegree,0,DocumentLength());
1.387 +
1.388 + __TEST_INVARIANT;
1.389 +
1.390 + __ETEXT_WATCH_END(DETACH);
1.391 + }
1.392 +
1.393 +
1.394 +EXPORT_C void CRichText::DetachFromStoreL(CPicture::TDetach aDegree,TInt aPos,TInt aLength)
1.395 +/** Loads pictures not already present in memory overloaded function. Either
1.396 +loads all pictures in the document, or just the pictures located within a
1.397 +specified range.
1.398 +
1.399 +Note: In order to load pictures, a picture factory and a store resolver must have
1.400 +been set.
1.401 +
1.402 +@param aDegree There are two possible values: EDetachFull and EDetachDraw.
1.403 +If you detach using EDetachFull then you can both draw and edit the picture(s),
1.404 +but if you detach with EDetachDraw then you can only draw them any attempt
1.405 +at editing them causes a panic.
1.406 +@param aPos The start of the range of characters to search.
1.407 +@param aLength The number of characters in the range. */
1.408 + {
1.409 + __ETEXT_WATCH(DETACH_POS_LENGTH);
1.410 +
1.411 + __TEST_INVARIANT;
1.412 + TInt documentLength = DocumentLength();
1.413 + if (aPos < 0 || aPos > documentLength)
1.414 + {
1.415 + OstTrace0( TRACE_FATAL, DUP1_CRICHTEXT_DETACHFROMSTOREL, "ECharPosBeyondDocument" );
1.416 + }
1.417 + __ASSERT_ALWAYS(aPos >= 0 && aPos <= documentLength,Panic(ECharPosBeyondDocument));
1.418 + if (aLength < 0)
1.419 + {
1.420 + OstTrace0( TRACE_FATAL, CRICHTEXT_DETACHFROMSTOREL, "ECopyToStreamNegativeLength" );
1.421 + }
1.422 + __ASSERT_ALWAYS(aLength >= 0,Panic(ECopyToStreamNegativeLength));
1.423 + if (aPos + aLength > documentLength)
1.424 + {
1.425 + OstTrace0( TRACE_FATAL, DUP2_CRICHTEXT_DETACHFROMSTOREL, "ECharPosBeyondDocument" );
1.426 + }
1.427 + __ASSERT_ALWAYS(aPos + aLength <= documentLength,Panic(ECharPosBeyondDocument));
1.428 +
1.429 + if (aLength > 0 && IndexPresent())
1.430 + iIndex->DetachFromStoreL(aDegree,aPos,aLength);
1.431 +
1.432 + __TEST_INVARIANT;
1.433 +
1.434 + __ETEXT_WATCH_END(DETACH_POS_LENGTH);
1.435 + }
1.436 +
1.437 +EXPORT_C void CRichText::SetPictureFactory(MPictureFactory* aPictureFactory,MRichTextStoreResolver* aStoreResolver)
1.438 +// Sets up a callback for the index.
1.439 +// Only called if the owner of this rich text component knows they will wanting to restore pictures
1.440 +// into this rich text.
1.441 +// If the index component is not yet present, the callbacks are preserved until required.
1.442 +//
1.443 +/** Sets the picture factory.
1.444 +
1.445 +Pictures in a rich text object may be represented as picture headers, or by
1.446 +the picture data itself. CRichText supports the deferred loading of picture
1.447 +data, so that it is only loaded when it is needed to be displayed, thus
1.448 +economising on memory use. A rich text object which supports the deferred
1.449 +loading of pictures needs to be supplied with a picture factory. It can either
1.450 +be set using this function, or during construction.
1.451 +
1.452 +Note: A panic occurs if the factory is NULL, but the store resolver is not NULL.
1.453 +
1.454 +@param aPictureFactory The picture factory.
1.455 +@param aStoreResolver The store resolver. This determines which file store
1.456 +the picture is stored in. */
1.457 + {
1.458 + __TEST_INVARIANT;
1.459 + if (!aPictureFactory && aStoreResolver)
1.460 + {
1.461 + OstTrace0( TRACE_FATAL, CRICHTEXT_SETPICTUREFACTORY, "EInvalidPictureFactorySettings" );
1.462 + }
1.463 + __ASSERT_ALWAYS(!(!aPictureFactory && aStoreResolver),Panic(EInvalidPictureFactorySettings));
1.464 +
1.465 + iPictureFactory=aPictureFactory;
1.466 + iStoreResolver=aStoreResolver;
1.467 + }
1.468 +
1.469 +EXPORT_C TPictureHeader CRichText::PictureHeader(TInt aPos)const
1.470 +/** Gets the picture header which describes the picture located at a specified
1.471 +document position. If no picture header is located at the position, the function
1.472 +constructs and returns a default one.
1.473 +
1.474 +@param aPos The document position. Must be valid.
1.475 +@return The picture header located at document position aPos, or a default
1.476 +picture header. */
1.477 + {
1.478 + __TEST_INVARIANT;
1.479 + if (aPos<0 || aPos>DocumentLength())
1.480 + {
1.481 + OstTrace0( TRACE_FATAL, CRICHTEXT_PICTUREHEADER, "ECharPosBeyondDocument" );
1.482 + }
1.483 + __ASSERT_ALWAYS(aPos>=0 && aPos<=DocumentLength(),Panic(ECharPosBeyondDocument));
1.484 +
1.485 + return (IndexPresent())
1.486 + ? iIndex->PictureHeader(aPos)
1.487 + : TPictureHeader();
1.488 + }
1.489 +
1.490 +EXPORT_C void CRichText::DropPictureOwnership(TInt aPos)
1.491 +/** Removes ownership from this rich text object of the picture located at a
1.492 +document position. The picture character is deleted from the document and
1.493 +ownership of the picture passes to the caller of this function.
1.494 +Use PictureHandleL() beforehand to get a pointer to the picture.
1.495 +
1.496 +@param aPos The document position of the picture character. Must be valid
1.497 +or a panic occurs.
1.498 +@see CRichText::PictureHandleL() */
1.499 + {
1.500 + __TEST_INVARIANT;
1.501 + if (aPos<0 || aPos>DocumentLength())
1.502 + {
1.503 + OstTrace0( TRACE_FATAL, CRICHTEXT_DROPPICTUREOWNERSHIP, "ECharPosBeyondDocument" );
1.504 + }
1.505 + __ASSERT_ALWAYS(aPos>=0 && aPos<=DocumentLength(),Panic(ECharPosBeyondDocument));
1.506 +
1.507 + TPictureHeader* p = IndexPresent()? iIndex->PictureHeaderPtr(aPos) : 0;
1.508 + if (!p)
1.509 + return;
1.510 +
1.511 + p->iPicture = 0;
1.512 + DeleteFromParagraph(aPos, 1);
1.513 + }
1.514 +