1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/textandloc/textrendering/texthandling/ttext/T_PICRES.CPP Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,528 @@
1.4 +/*
1.5 +* Copyright (c) 1997-2010 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 <gdi.h>
1.26 +#include <conpics.h>
1.27 +#include <s32file.h>
1.28 +
1.29 +#include <txtrich.h>
1.30 +#include <txtfmlyr.h>
1.31 +#include "TXTMRTSR.H"
1.32 +
1.33 +#include "../incp/T_PMLPAR.H"
1.34 +#include "T_PICRES.h"
1.35 +
1.36 +LOCAL_D CTestStep *pTestStep = NULL;
1.37 +#define test(cond) \
1.38 + { \
1.39 + TBool __bb = (cond); \
1.40 + pTestStep->TEST(__bb); \
1.41 + if (!__bb) \
1.42 + { \
1.43 + pTestStep->ERR_PRINTF1(_L("ERROR: Test Failed")); \
1.44 + User::Leave(1); \
1.45 + } \
1.46 + }
1.47 +#undef INFO_PRINTF1
1.48 +#undef INFO_PRINTF2
1.49 +// copy from tefexportconst.h
1.50 +#define INFO_PRINTF1(p1) pTestStep->Logger().LogExtra(((TText8*)__FILE__), __LINE__, ESevrInfo, (p1))
1.51 +#define INFO_PRINTF2(p1, p2) pTestStep->Logger().LogExtra(((TText8*)__FILE__), __LINE__, ESevrInfo, (p1), (p2))
1.52 +
1.53 +
1.54 +#define UNUSED_VAR(a) a = a
1.55 +
1.56 +const TInt KTestCleanupStack=0x40;
1.57 +
1.58 +class CContainer : public CBase, public MRichTextStoreResolver
1.59 + {
1.60 +public:
1.61 + static CContainer* NewL();
1.62 + ~CContainer();
1.63 + //
1.64 + // Mixin
1.65 + //
1.66 + virtual const CStreamStore& StreamStoreL(TInt aPos)const;
1.67 + // Methods
1.68 + TStreamId StoreL(CStreamStore& aStore)const;
1.69 + void RestoreL(const CStreamStore& aStore,TStreamId aId,MPictureFactory* aFctry);
1.70 +protected:
1.71 + CContainer();
1.72 + void ConstructL();
1.73 +public:
1.74 + CRichText* iText;
1.75 + const CParaFormatLayer* iGlobalParaFormatLayer;
1.76 + const CCharFormatLayer* iGlobalCharFormatLayer;
1.77 + };
1.78 +
1.79 +LOCAL_D CTrapCleanup* TheTrapCleanup;
1.80 +LOCAL_D RFs TheFs; // the file server
1.81 +LOCAL_D RFile TheFile; // the data file
1.82 +LOCAL_D CFileStore* TheStore; // concrete CStreamStore
1.83 +LOCAL_D CParser* TheParser;
1.84 +LOCAL_D CContainer* TheContainer;
1.85 +LOCAL_D CStreamStore* TheDeferredPictureStore;
1.86 +
1.87 +CContainer* CContainer::NewL()
1.88 +// Create new container & set its components.
1.89 +//
1.90 + {
1.91 + CContainer* self=new(ELeave) CContainer;
1.92 + CleanupStack::PushL(self);
1.93 + self->ConstructL();
1.94 + CleanupStack::Pop();
1.95 + return self;
1.96 + }
1.97 +
1.98 +
1.99 +CContainer::CContainer()
1.100 + {
1.101 + }
1.102 +
1.103 +
1.104 +void CContainer::ConstructL()
1.105 + {
1.106 + TFileName theFileName = _L("z:\\test\\app-framework\\etext\\t_picres.pml");
1.107 + TheParser=CParser::NewL();
1.108 + CleanupStack::PushL(TheParser);
1.109 + iText=TheParser->ParseL(theFileName);
1.110 + CleanupStack::PopAndDestroy();
1.111 + iGlobalParaFormatLayer=iText->GlobalParaFormatLayer();
1.112 + iGlobalCharFormatLayer=iText->GlobalCharFormatLayer();
1.113 + }
1.114 +
1.115 +
1.116 +CContainer::~CContainer()
1.117 + {
1.118 + delete iText;
1.119 + delete (CParaFormatLayer*)iGlobalParaFormatLayer;
1.120 + delete (CCharFormatLayer*)iGlobalCharFormatLayer;
1.121 + }
1.122 +
1.123 +
1.124 +const CStreamStore& CContainer::StreamStoreL(TInt /*aPos*/)const
1.125 +// Return the deferred picture store.
1.126 +// In this instance, the deferred picture store does not vary with document position.
1.127 +//
1.128 + {return *TheDeferredPictureStore;}
1.129 +
1.130 +
1.131 +TStreamId CContainer::StoreL(CStreamStore& aStore)const
1.132 +// Store this component
1.133 +//
1.134 + {
1.135 + CStoreMap* map=CStoreMap::NewLC(aStore);
1.136 + iText->StoreComponentsL(aStore,*map);
1.137 + //
1.138 + RStoreWriteStream stream(*map);
1.139 + TStreamId id=stream.CreateLC(aStore);
1.140 + iGlobalParaFormatLayer->ExternalizeL(stream);
1.141 + iGlobalCharFormatLayer->ExternalizeL(stream);
1.142 + stream<< *iText;
1.143 + stream.CommitL();
1.144 + //
1.145 + map->Reset();
1.146 + CleanupStack::PopAndDestroy(2);
1.147 + return id;
1.148 + }
1.149 +
1.150 +
1.151 +void CContainer::RestoreL(const CStreamStore& aStore,TStreamId aId,MPictureFactory* aFactory)
1.152 +// Restore this component
1.153 +//
1.154 + {
1.155 + RStoreReadStream stream;
1.156 + stream.OpenLC(aStore,aId);
1.157 + iGlobalParaFormatLayer=CParaFormatLayer::NewL(stream);
1.158 + iGlobalCharFormatLayer=CCharFormatLayer::NewL(stream);
1.159 + iText=CRichText::NewL(iGlobalParaFormatLayer,iGlobalCharFormatLayer);
1.160 + iText->SetPictureFactory(aFactory,this);
1.161 + stream>> *iText;
1.162 + //
1.163 + CleanupStack::PopAndDestroy();
1.164 + //
1.165 + iText->RestoreComponentsL(aStore);
1.166 + }
1.167 +
1.168 +_LIT(KOutputFile, "c:\\etext\\t_word.doc");
1.169 +LOCAL_C void testPictureRestorer(TBool aDeferPictureLoad=ETrue)
1.170 +// Test Picture persistance.
1.171 +//
1.172 + {
1.173 + //
1.174 + TheFs.Connect();
1.175 + //
1.176 + TheFs.Delete(KOutputFile);
1.177 + TheFs.MkDirAll(KOutputFile);
1.178 + TheStore=CDirectFileStore::CreateL(TheFs,KOutputFile,EFileRead|EFileWrite);
1.179 + TheDeferredPictureStore=TheStore;
1.180 + CleanupStack::PushL(TheStore);
1.181 + TheStore->SetTypeL(KDirectFileStoreLayoutUid);
1.182 + //
1.183 + // Create concrete picture factory.
1.184 + MDemPictureFactory* factory=new(ELeave) MDemPictureFactory;
1.185 +
1.186 + TheContainer->iText->Reset();
1.187 + TheContainer->iText->InsertL(0,_L("Hello Duncan how"));
1.188 +
1.189 + TheContainer->iText->SetPictureFactory(factory,TheContainer);
1.190 + // Create some pictures.
1.191 + CXzePicture* pic1=CXzePicture::NewL('x');
1.192 + CleanupStack::PushL(pic1);
1.193 + CXzePicture* pic2=CXzePicture::NewL('z');
1.194 + CleanupStack::PushL(pic2);
1.195 + CXzePicture* pic3=CXzePicture::NewL('e');
1.196 + CleanupStack::PushL(pic3);
1.197 + //
1.198 + // Create the picture headers
1.199 + TPictureHeader hdr1;
1.200 + TPictureHeader hdr2;
1.201 + TPictureHeader hdr3;
1.202 + //
1.203 + TSize size;
1.204 + pic1->GetSizeInTwips(size);
1.205 + hdr1.iPictureType=KUidXzePictureType;
1.206 + hdr1.iPicture=pic1;
1.207 + hdr2.iPictureType=KUidXzePictureType;
1.208 + hdr2.iPicture=pic2;
1.209 + hdr3.iPictureType=KUidXzePictureType;
1.210 + hdr3.iPicture=pic3;
1.211 + //
1.212 + // Insert the pictures into the rich text
1.213 + TBool hasMarkupData=TheContainer->iText->HasMarkupData();
1.214 + test(!hasMarkupData);
1.215 + TheContainer->iText->CancelInsertCharFormat();
1.216 + TheContainer->iText->InsertL(0,hdr1);
1.217 + TheContainer->iText->InsertL(5,hdr2);
1.218 + TheContainer->iText->InsertL(7,hdr3);
1.219 + TheContainer->iText->InsertL(0,CEditableText::EParagraphDelimiter);
1.220 + TheContainer->iText->CancelInsertCharFormat();
1.221 + TheContainer->iText->InsertL(2,CEditableText::EParagraphDelimiter);
1.222 + CleanupStack::Pop(3);
1.223 + hasMarkupData=TheContainer->iText->HasMarkupData();
1.224 + test(hasMarkupData);
1.225 + //
1.226 + // High level Store context
1.227 + TStreamId id=TheContainer->StoreL(*TheStore);
1.228 +//
1.229 + delete TheContainer->iText;
1.230 + delete (CParaFormatLayer*)TheContainer->iGlobalParaFormatLayer;
1.231 + delete (CCharFormatLayer*)TheContainer->iGlobalCharFormatLayer;
1.232 +//
1.233 +//
1.234 +// Now restore the container with rich text
1.235 + TheContainer->RestoreL(*TheStore,id,factory);
1.236 + if (!aDeferPictureLoad)
1.237 + TheContainer->iText->DetachFromStoreL(CPicture::EDetachFull);
1.238 + //
1.239 + hasMarkupData=TheContainer->iText->HasMarkupData();
1.240 + test(hasMarkupData);
1.241 + test(TheContainer->iText->ParagraphCount()==3);
1.242 + test(TheContainer->iText->DocumentLength()==21);
1.243 + TPtrC view;
1.244 + TCharFormat format;
1.245 + CPicture* picture;
1.246 + //
1.247 + // TEST THE PICTURE HEADERS, DEPENDING ON WHETHER DEFERRED LOADING IS SET OR NOT
1.248 + TPictureHeader hdrA=TheContainer->iText->PictureHeader(1);
1.249 + test(hdrA.iPictureType==KUidXzePictureType);
1.250 + if (aDeferPictureLoad)
1.251 + {
1.252 + test(hdrA.iPicture.IsId());
1.253 + }
1.254 + else
1.255 + {
1.256 + test(hdrA.iPicture!=NULL);
1.257 + test(hdrA.iPicture.IsPtr());
1.258 + test(((CXzePicture*)hdrA.iPicture.AsPtr())->iLabel=='x');
1.259 + }
1.260 + TPictureHeader hdrB=TheContainer->iText->PictureHeader(7);
1.261 + test(hdrB.iPictureType==KUidXzePictureType);
1.262 + if (aDeferPictureLoad)
1.263 + {
1.264 + test(hdrB.iPicture.IsId());
1.265 + }
1.266 + else
1.267 + {
1.268 + test(hdrB.iPicture!=NULL);
1.269 + test(hdrB.iPicture.IsPtr());
1.270 + test(((CXzePicture*)hdrB.iPicture.AsPtr())->iLabel=='z');
1.271 + }
1.272 + TPictureHeader hdrC=TheContainer->iText->PictureHeader(9);
1.273 + test(hdrC.iPictureType==KUidXzePictureType);
1.274 + if (aDeferPictureLoad)
1.275 + {
1.276 + test(hdrC.iPicture.IsId());
1.277 + }
1.278 + else
1.279 + {
1.280 + test(hdrC.iPicture!=NULL);
1.281 + test(hdrC.iPicture.IsPtr());
1.282 + test(((CXzePicture*)hdrC.iPicture.AsPtr())->iLabel=='e');
1.283 + }
1.284 + TPictureHeader hdrD=TheContainer->iText->PictureHeader(0); // This is not a picture character
1.285 + test(hdrD.iPictureType==KNullUid);
1.286 + test(hdrD.iPicture==NULL);
1.287 + TSize dummySize;
1.288 + test(hdrD.iSize==dummySize);
1.289 + //
1.290 + TheContainer->iText->GetChars(view,format,1);
1.291 + test(view[0]==CEditableText::EPictureCharacter);
1.292 + picture=TheContainer->iText->PictureHandleL(1);
1.293 + test(((CXzePicture*)picture)->iLabel=='x');
1.294 +
1.295 + TheContainer->iText->GetChars(view,format,7);
1.296 + test(view[0]==CEditableText::EPictureCharacter);
1.297 + picture=TheContainer->iText->PictureHandleL(7);
1.298 + test(((CXzePicture*)picture)->iLabel=='z');
1.299 +
1.300 + TheContainer->iText->GetChars(view,format,9);
1.301 + test(view[0]==CEditableText::EPictureCharacter);
1.302 + picture=TheContainer->iText->PictureHandleL(9);
1.303 + test(((CXzePicture*)picture)->iLabel=='e');
1.304 +
1.305 + delete factory;
1.306 + CleanupStack::PopAndDestroy(); // TheStore
1.307 + TheFs.Close();
1.308 + }
1.309 +
1.310 +_LIT(KOutputFile1, "c:\\etext\\t_word1.doc");
1.311 +LOCAL_C void testPictureRestorer2(TBool aAlwaysFailToLoad=EFalse)
1.312 +// Test Picture persistance.
1.313 +//
1.314 + {
1.315 + //
1.316 + TheFs.Connect();
1.317 + //
1.318 + TheFs.Delete(KOutputFile1);
1.319 + TheFs.MkDirAll(KOutputFile1);
1.320 + TheStore=CDirectFileStore::CreateL(TheFs,KOutputFile1,EFileRead|EFileWrite);
1.321 + TheDeferredPictureStore=TheStore;
1.322 + CleanupStack::PushL(TheStore);
1.323 + TheStore->SetTypeL(KDirectFileStoreLayoutUid);
1.324 + //
1.325 + // Create concrete picture factory.
1.326 + MDemPictureFactory* factory=new(ELeave) MDemPictureFactory;
1.327 +
1.328 + TheContainer->iText->Reset();
1.329 + TheContainer->iText->InsertL(0,_L("Hello Duncan how"));
1.330 +
1.331 + TheContainer->iText->SetPictureFactory(factory,TheContainer);
1.332 + // Create some pictures.
1.333 + CXzeDoor* pic1=CXzeDoor::NewL('x',aAlwaysFailToLoad);
1.334 + CleanupStack::PushL(pic1);
1.335 + CXzeDoor* pic2=CXzeDoor::NewL('z',aAlwaysFailToLoad);
1.336 + CleanupStack::PushL(pic2);
1.337 + CXzePicture* pic3=CXzePicture::NewL('e'); // Control: will always load.
1.338 + CleanupStack::PushL(pic3);
1.339 + //
1.340 + // Create the picture headers
1.341 + TPictureHeader hdr1;
1.342 + TPictureHeader hdr2;
1.343 + TPictureHeader hdr3;
1.344 + //
1.345 + TSize size;
1.346 + pic1->GetSizeInTwips(size);
1.347 + hdr1.iPictureType=KUidXzeDoorType;
1.348 + hdr1.iPicture=pic1;
1.349 + hdr2.iPictureType=KUidXzeDoorType;
1.350 + hdr2.iPicture=pic2;
1.351 + hdr3.iPictureType=KUidXzePictureType;
1.352 + hdr3.iPicture=pic3;
1.353 + //
1.354 + // Insert the pictures into the rich text
1.355 + TBool hasMarkupData=TheContainer->iText->HasMarkupData();
1.356 + test(!hasMarkupData);
1.357 + TheContainer->iText->CancelInsertCharFormat();
1.358 + TheContainer->iText->InsertL(0,hdr1);
1.359 + TheContainer->iText->InsertL(5,hdr2);
1.360 + TheContainer->iText->InsertL(7,hdr3);
1.361 + TheContainer->iText->InsertL(0,CEditableText::EParagraphDelimiter);
1.362 + TheContainer->iText->CancelInsertCharFormat();
1.363 + TheContainer->iText->InsertL(2,CEditableText::EParagraphDelimiter);
1.364 + CleanupStack::Pop(3); // pic1,2,3 - ownership transferred to rich text
1.365 + hasMarkupData=TheContainer->iText->HasMarkupData();
1.366 + test(hasMarkupData);
1.367 + //
1.368 + // High level Store context - all pictures currently in memory
1.369 + TStreamId id=TheContainer->StoreL(*TheStore);
1.370 +//
1.371 + delete TheContainer->iText;
1.372 + delete (CParaFormatLayer*)TheContainer->iGlobalParaFormatLayer;
1.373 + delete (CCharFormatLayer*)TheContainer->iGlobalCharFormatLayer;
1.374 +//
1.375 +//
1.376 +// Now restore the container with rich text
1.377 + TheContainer->RestoreL(*TheStore,id,factory);
1.378 +//
1.379 +//
1.380 +// Now store the stuff again
1.381 + TRAPD(ret,
1.382 + TheContainer->iText->DetachFromStoreL(CPicture::EDetachFull));
1.383 + if (ret==KErrNotSupported)
1.384 + INFO_PRINTF1(_L(" SIMULATION: Some picture data is not supported by the current factory."));
1.385 +// if (aAlwaysFailToLoad)
1.386 +// test(error==KErrNotFound);
1.387 +// else
1.388 +// test(error==KErrNone);
1.389 + id=KNullStreamId;
1.390 + TRAP(ret,
1.391 + id=TheContainer->StoreL(*TheStore));
1.392 + test(ret==KErrNone);
1.393 +//
1.394 +// ...and restore it to check what we have got.
1.395 + delete TheContainer->iText;
1.396 + delete (CParaFormatLayer*)TheContainer->iGlobalParaFormatLayer;
1.397 + delete (CCharFormatLayer*)TheContainer->iGlobalCharFormatLayer;
1.398 + TheContainer->RestoreL(*TheStore,id,factory);
1.399 + TInt pictureCount=TheContainer->iText->PictureCount();
1.400 + if (aAlwaysFailToLoad)
1.401 + {
1.402 + test(pictureCount==1);
1.403 + }
1.404 + else
1.405 + {
1.406 + test(pictureCount==3);
1.407 + }
1.408 +//
1.409 + delete factory;
1.410 + CleanupStack::PopAndDestroy(); // TheStore
1.411 + TheFs.Close();
1.412 + }
1.413 +
1.414 +
1.415 +LOCAL_C void GoL()
1.416 +// Run the tests
1.417 +//
1.418 + {
1.419 + INFO_PRINTF1(_L(" @SYMTestCaseID:SYSLIB-TTEXT-LEGACY-T_PICRES-0001 RichText Storing - with pictures deferred loading "));
1.420 + TheContainer=CContainer::NewL();
1.421 + TRAPD(r,
1.422 + testPictureRestorer());
1.423 + test(r==KErrNone);
1.424 + delete TheContainer; // deletes the rich text, which deletes the contained pictures.
1.425 + //
1.426 + //
1.427 + INFO_PRINTF1(_L("RichText Storing - with pictures auto loading"));
1.428 + TheContainer=CContainer::NewL();
1.429 + TRAP(r,
1.430 + testPictureRestorer(EFalse)); // DO NOT DEFER PICTURE LOADING
1.431 + test(r==KErrNone);
1.432 + delete TheContainer; // deletes the rich text, which deletes the contained pictures.
1.433 +//
1.434 +//
1.435 +//
1.436 + INFO_PRINTF1(_L("Testing no missing picture app's"));
1.437 + TheContainer=CContainer::NewL();
1.438 + TRAP(r,
1.439 + testPictureRestorer2());
1.440 + test(r==KErrNone);
1.441 + delete TheContainer; // deletes the rich text, which deletes the contained pictures.
1.442 + //
1.443 + //
1.444 +/*
1.445 + TEST NOW REDUNDANT AS OF NEW PICTURE CONTAINMENT MECHANISM AS AT RELEASE 073
1.446 +
1.447 + INFO_PRINTF1(_L("Testing missing picture app's"));
1.448 + TheContainer=CContainer::NewL();
1.449 + TRAP(r,
1.450 + testPictureRestorer2(ETrue)); // ALWAYS FAIL TO DETACH FROM STORE
1.451 + test(r==KErrNone);
1.452 + delete TheContainer; // deletes the rich text, which deletes the contained pictures.
1.453 +*/
1.454 + }
1.455 +
1.456 +
1.457 +LOCAL_C void setupCleanup()
1.458 +//
1.459 +// Initialise the cleanup stack.
1.460 +//
1.461 + {
1.462 +
1.463 + TheTrapCleanup=CTrapCleanup::New();
1.464 + TRAPD(r,\
1.465 + {\
1.466 + for (TInt i=KTestCleanupStack;i>0;i--)\
1.467 + CleanupStack::PushL((TAny*)1);\
1.468 + test(r==KErrNone);\
1.469 + CleanupStack::Pop(KTestCleanupStack);\
1.470 + });
1.471 + }
1.472 +
1.473 +
1.474 +LOCAL_C void DeleteDataFile(const TDesC& aFullName)
1.475 + {
1.476 + RFs fsSession;
1.477 + TInt err = fsSession.Connect();
1.478 + if(err == KErrNone)
1.479 + {
1.480 + TEntry entry;
1.481 + if(fsSession.Entry(aFullName, entry) == KErrNone)
1.482 + {
1.483 + RDebug::Print(_L("Deleting \"%S\" file.\n"), &aFullName);
1.484 + err = fsSession.SetAtt(aFullName, 0, KEntryAttReadOnly);
1.485 + if(err != KErrNone)
1.486 + {
1.487 + RDebug::Print(_L("Error %d changing \"%S\" file attributes.\n"), err, &aFullName);
1.488 + }
1.489 + err = fsSession.Delete(aFullName);
1.490 + if(err != KErrNone)
1.491 + {
1.492 + RDebug::Print(_L("Error %d deleting \"%S\" file.\n"), err, &aFullName);
1.493 + }
1.494 + }
1.495 + fsSession.Close();
1.496 + }
1.497 + else
1.498 + {
1.499 + RDebug::Print(_L("Error %d connecting file session. File: %S.\n"), err, &aFullName);
1.500 + }
1.501 + }
1.502 +
1.503 +CT_PICRES::CT_PICRES()
1.504 + {
1.505 + SetTestStepName(KTestStep_T_PICRES);
1.506 + pTestStep = this;
1.507 + }
1.508 +
1.509 +TVerdict CT_PICRES::doTestStepL()
1.510 + {
1.511 + SetTestStepResult(EFail);
1.512 +
1.513 + INFO_PRINTF1(_L("Testing Picture Restorer mechanism"));
1.514 + __UHEAP_MARK;
1.515 + setupCleanup();
1.516 + TRAPD(r,GoL());
1.517 +
1.518 + delete TheTrapCleanup;
1.519 +
1.520 + __UHEAP_MARKEND;
1.521 +
1.522 + ::DeleteDataFile(KOutputFile); //deletion of data files must be before call to End() - DEF047652
1.523 + ::DeleteDataFile(KOutputFile1);
1.524 +
1.525 + if (r == KErrNone)
1.526 + {
1.527 + SetTestStepResult(EPass);
1.528 + }
1.529 +
1.530 + return TestStepResult();
1.531 + }