1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
|
/*************************************************************************
*
* $RCSfile: grfcache.cxx,v $
*
* $Revision: 1.15 $
*
* last change: $Author: vg $ $Date: 2004-01-06 15:07:33 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
*
* - GNU Lesser General Public License Version 2.1
* - Sun Industry Standards Source License Version 1.1
*
* Sun Microsystems Inc., October, 2000
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2000 by Sun Microsystems, Inc.
* 901 San Antonio Road, Palo Alto, CA 94303, USA
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software Foundation.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
*
* Sun Industry Standards Source License Version 1.1
* =================================================
* The contents of this file are subject to the Sun Industry Standards
* Source License Version 1.1 (the "License"); You may not use this file
* except in compliance with the License. You may obtain a copy of the
* License at http://www.openoffice.org/license.html.
*
* Software provided under this License is provided on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
* See the License for the specific provisions governing your rights and
* obligations concerning the Software.
*
* The Initial Developer of the Original Code is: Sun Microsystems, Inc.
*
* Copyright: 2000 by Sun Microsystems, Inc.
*
* All Rights Reserved.
*
* Contributor(s): _______________________________________
*
*
************************************************************************/
#include <vos/timer.hxx>
#include <tools/debug.hxx>
#include <vcl/outdev.hxx>
#include <tools/poly.hxx>
#include "grfcache.hxx"
// -----------
// - Defines -
// -----------
#define RELEASE_TIMEOUT 10000
#define MAX_BMP_EXTENT 4096
// -----------
// - statics -
// -----------
static const char aHexData[] = { '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'A', 'B', 'C', 'D', 'E', 'F' };
// -------------
// - GraphicID -
// -------------
class GraphicID
{
private:
sal_uInt32 mnID1;
sal_uInt32 mnID2;
sal_uInt32 mnID3;
sal_uInt32 mnID4;
GraphicID();
public:
GraphicID( const GraphicObject& rObj );
~GraphicID() {}
BOOL operator==( const GraphicID& rID ) const
{
return( rID.mnID1 == mnID1 && rID.mnID2 == mnID2 &&
rID.mnID3 == mnID3 && rID.mnID4 == mnID4 );
}
ByteString GetIDString() const;
BOOL IsEmpty() const { return( 0 == mnID4 ); }
};
// -----------------------------------------------------------------------------
GraphicID::GraphicID( const GraphicObject& rObj )
{
const Graphic& rGraphic = rObj.GetGraphic();
mnID1 = ( (ULONG) rGraphic.GetType() ) << 28;
switch( rGraphic.GetType() )
{
case( GRAPHIC_BITMAP ):
{
if( rGraphic.IsAnimated() )
{
const Animation aAnimation( rGraphic.GetAnimation() );
mnID1 |= ( aAnimation.Count() & 0x0fffffff );
mnID2 = aAnimation.GetDisplaySizePixel().Width();
mnID3 = aAnimation.GetDisplaySizePixel().Height();
mnID4 = rGraphic.GetChecksum();
}
else
{
const BitmapEx aBmpEx( rGraphic.GetBitmapEx() );
mnID1 |= ( ( ( (ULONG) aBmpEx.GetTransparentType() << 8 ) | ( aBmpEx.IsAlpha() ? 1 : 0 ) ) & 0x0fffffff );
mnID2 = aBmpEx.GetSizePixel().Width();
mnID3 = aBmpEx.GetSizePixel().Height();
mnID4 = rGraphic.GetChecksum();
}
}
break;
case( GRAPHIC_GDIMETAFILE ):
{
const GDIMetaFile aMtf( rGraphic.GetGDIMetaFile() );
mnID1 |= ( aMtf.GetActionCount() & 0x0fffffff );
mnID2 = aMtf.GetPrefSize().Width();
mnID3 = aMtf.GetPrefSize().Height();
mnID4 = rGraphic.GetChecksum();
}
break;
default:
mnID2 = mnID3 = mnID4 = 0;
break;
}
}
// -----------------------------------------------------------------------------
ByteString GraphicID::GetIDString() const
{
ByteString aHexStr;
sal_Char* pStr = aHexStr.AllocBuffer( 32 );
sal_Int32 nShift;
for( nShift = 28; nShift >= 0; nShift -= 4 )
*pStr++ = aHexData[ ( mnID1 >> (sal_uInt32) nShift ) & 0xf ];
for( nShift = 28; nShift >= 0; nShift -= 4 )
*pStr++ = aHexData[ ( mnID2 >> (sal_uInt32) nShift ) & 0xf ];
for( nShift = 28; nShift >= 0; nShift -= 4 )
*pStr++ = aHexData[ ( mnID3 >> (sal_uInt32) nShift ) & 0xf ];
for( nShift = 28; nShift >= 0; nShift -= 4 )
*pStr++ = aHexData[ ( mnID4 >> (sal_uInt32) nShift ) & 0xf ];
return aHexStr;
}
// ---------------------
// - GraphicCacheEntry -
// ---------------------
class GraphicCacheEntry
{
private:
List maGraphicObjectList;
GraphicID maID;
GfxLink maGfxLink;
BitmapEx* mpBmpEx;
GDIMetaFile* mpMtf;
Animation* mpAnimation;
BOOL mbSwappedAll;
BOOL ImplInit( const GraphicObject& rObj );
BOOL ImplMatches( const GraphicObject& rObj ) const { return( GraphicID( rObj ) == maID ); }
void ImplFillSubstitute( Graphic& rSubstitute );
public:
GraphicCacheEntry( const GraphicObject& rObj );
~GraphicCacheEntry();
const GraphicID& GetID() const { return maID; }
void AddGraphicObjectReference( const GraphicObject& rObj, Graphic& rSubstitute );
BOOL ReleaseGraphicObjectReference( const GraphicObject& rObj );
ULONG GetGraphicObjectReferenceCount() { return maGraphicObjectList.Count(); }
BOOL HasGraphicObjectReference( const GraphicObject& rObj );
void TryToSwapIn();
void GraphicObjectWasSwappedOut( const GraphicObject& rObj );
BOOL FillSwappedGraphicObject( const GraphicObject& rObj, Graphic& rSubstitute );
void GraphicObjectWasSwappedIn( const GraphicObject& rObj );
};
// -----------------------------------------------------------------------------
GraphicCacheEntry::GraphicCacheEntry( const GraphicObject& rObj ) :
maID ( rObj ),
mpBmpEx ( NULL ),
mpMtf ( NULL ),
mpAnimation ( NULL ),
mbSwappedAll ( !ImplInit( rObj ) )
{
maGraphicObjectList.Insert( (void*) &rObj, LIST_APPEND );
}
// -----------------------------------------------------------------------------
GraphicCacheEntry::~GraphicCacheEntry()
{
DBG_ASSERT( !maGraphicObjectList.Count(), "GraphicCacheEntry::~GraphicCacheEntry(): Not all GraphicObjects are removed from this entry" );
delete mpBmpEx;
delete mpMtf;
delete mpAnimation;
}
// -----------------------------------------------------------------------------
BOOL GraphicCacheEntry::ImplInit( const GraphicObject& rObj )
{
BOOL bRet;
if( !rObj.IsSwappedOut() )
{
const Graphic& rGraphic = rObj.GetGraphic();
if( mpBmpEx )
delete mpBmpEx, mpBmpEx = NULL;
if( mpMtf )
delete mpMtf, mpMtf = NULL;
if( mpAnimation )
delete mpAnimation, mpAnimation = NULL;
switch( rGraphic.GetType() )
{
case( GRAPHIC_BITMAP ):
{
if( rGraphic.IsAnimated() )
mpAnimation = new Animation( rGraphic.GetAnimation() );
else
mpBmpEx = new BitmapEx( rGraphic.GetBitmapEx() );
}
break;
case( GRAPHIC_GDIMETAFILE ):
{
mpMtf = new GDIMetaFile( rGraphic.GetGDIMetaFile() );
}
break;
default:
DBG_ASSERT( GetID().IsEmpty(), "GraphicCacheEntry::ImplInit: Could not initialize graphic! (=>KA)" );
break;
}
if( rGraphic.IsLink() )
maGfxLink = ( (Graphic&) rGraphic ).GetLink();
else
maGfxLink = GfxLink();
bRet = TRUE;
}
else
bRet = FALSE;
return bRet;
}
// -----------------------------------------------------------------------------
void GraphicCacheEntry::ImplFillSubstitute( Graphic& rSubstitute )
{
// create substitute for graphic;
const Size aPrefSize( rSubstitute.GetPrefSize() );
const MapMode aPrefMapMode( rSubstitute.GetPrefMapMode() );
const Link aAnimationNotifyHdl( rSubstitute.GetAnimationNotifyHdl() );
const String aDocFileName( rSubstitute.GetDocFileName() );
const ULONG nDocFilePos = rSubstitute.GetDocFilePos();
const GraphicType eOldType = rSubstitute.GetType();
const BOOL bDefaultType = ( rSubstitute.GetType() == GRAPHIC_DEFAULT );
if( rSubstitute.IsLink() && ( GFX_LINK_TYPE_NONE == maGfxLink.GetType() ) )
maGfxLink = rSubstitute.GetLink();
if( mpBmpEx )
rSubstitute = *mpBmpEx;
else if( mpAnimation )
rSubstitute = *mpAnimation;
else if( mpMtf )
rSubstitute = *mpMtf;
else
rSubstitute.Clear();
if( eOldType != GRAPHIC_NONE )
{
rSubstitute.SetPrefSize( aPrefSize );
rSubstitute.SetPrefMapMode( aPrefMapMode );
rSubstitute.SetAnimationNotifyHdl( aAnimationNotifyHdl );
rSubstitute.SetDocFileName( aDocFileName, nDocFilePos );
}
if( GFX_LINK_TYPE_NONE != maGfxLink.GetType() )
rSubstitute.SetLink( maGfxLink );
if( bDefaultType )
rSubstitute.SetDefaultType();
}
// -----------------------------------------------------------------------------
void GraphicCacheEntry::AddGraphicObjectReference( const GraphicObject& rObj, Graphic& rSubstitute )
{
if( mbSwappedAll )
mbSwappedAll = !ImplInit( rObj );
ImplFillSubstitute( rSubstitute );
maGraphicObjectList.Insert( (void*) &rObj, LIST_APPEND );
}
// -----------------------------------------------------------------------------
BOOL GraphicCacheEntry::ReleaseGraphicObjectReference( const GraphicObject& rObj )
{
BOOL bRet = FALSE;
for( void* pObj = maGraphicObjectList.First(); !bRet && pObj; pObj = maGraphicObjectList.Next() )
{
if( &rObj == (GraphicObject*) pObj )
{
maGraphicObjectList.Remove( pObj );
bRet = TRUE;
}
}
return bRet;
}
// -----------------------------------------------------------------------------
BOOL GraphicCacheEntry::HasGraphicObjectReference( const GraphicObject& rObj )
{
BOOL bRet = FALSE;
for( void* pObj = maGraphicObjectList.First(); !bRet && pObj; pObj = maGraphicObjectList.Next() )
if( &rObj == (GraphicObject*) pObj )
bRet = TRUE;
return bRet;
}
// -----------------------------------------------------------------------------
void GraphicCacheEntry::TryToSwapIn()
{
if( mbSwappedAll && maGraphicObjectList.Count() )
( (GraphicObject*) maGraphicObjectList.First() )->FireSwapInRequest();
}
// -----------------------------------------------------------------------------
void GraphicCacheEntry::GraphicObjectWasSwappedOut( const GraphicObject& rObj )
{
mbSwappedAll = TRUE;
for( void* pObj = maGraphicObjectList.First(); mbSwappedAll && pObj; pObj = maGraphicObjectList.Next() )
if( !( (GraphicObject*) pObj )->IsSwappedOut() )
mbSwappedAll = FALSE;
if( mbSwappedAll )
{
delete mpBmpEx, mpBmpEx = NULL;
delete mpMtf, mpMtf = NULL;
delete mpAnimation, mpAnimation = NULL;
}
}
// -----------------------------------------------------------------------------
BOOL GraphicCacheEntry::FillSwappedGraphicObject( const GraphicObject& rObj, Graphic& rSubstitute )
{
BOOL bRet;
if( !mbSwappedAll && rObj.IsSwappedOut() )
{
ImplFillSubstitute( rSubstitute );
bRet = TRUE;
}
else
bRet = FALSE;
return bRet;
}
// -----------------------------------------------------------------------------
void GraphicCacheEntry::GraphicObjectWasSwappedIn( const GraphicObject& rObj )
{
if( mbSwappedAll )
mbSwappedAll = !ImplInit( rObj );
}
// ----------------------------
// - GraphicDisplayCacheEntry -
// ----------------------------
class GraphicDisplayCacheEntry
{
private:
::vos::TTimeValue maReleaseTime;
const GraphicCacheEntry* mpRefCacheEntry;
GDIMetaFile* mpMtf;
BitmapEx* mpBmpEx;
GraphicAttr maAttr;
Size maOutSizePix;
ULONG mnCacheSize;
public:
static ULONG GetNeededSize( OutputDevice* pOut, const Point& rPt, const Size& rSz,
const GraphicObject& rObj, const GraphicAttr& rAttr );
public:
GraphicDisplayCacheEntry( const GraphicCacheEntry* pRefCacheEntry,
OutputDevice* pOut, const Point& rPt, const Size& rSz,
const GraphicObject& rObj, const GraphicAttr& rAttr,
const BitmapEx& rBmpEx ) :
mpRefCacheEntry( pRefCacheEntry ),
mpMtf( NULL ), mpBmpEx( new BitmapEx( rBmpEx ) ),
maAttr( rAttr ), maOutSizePix( pOut->LogicToPixel( rSz ) ),
mnCacheSize( GetNeededSize( pOut, rPt, rSz, rObj, rAttr ) )
{
}
GraphicDisplayCacheEntry( const GraphicCacheEntry* pRefCacheEntry,
OutputDevice* pOut, const Point& rPt, const Size& rSz,
const GraphicObject& rObj, const GraphicAttr& rAttr,
const GDIMetaFile& rMtf ) :
mpRefCacheEntry( pRefCacheEntry ),
mpMtf( new GDIMetaFile( rMtf ) ), mpBmpEx( NULL ),
maAttr( rAttr ), maOutSizePix( pOut->LogicToPixel( rSz ) ),
mnCacheSize( GetNeededSize( pOut, rPt, rSz, rObj, rAttr ) )
{
}
~GraphicDisplayCacheEntry();
const GraphicAttr& GetAttr() const { return maAttr; }
const Size& GetOutputSizePixel() const { return maOutSizePix; }
const ULONG GetCacheSize() const { return mnCacheSize; }
const GraphicCacheEntry* GetReferencedCacheEntry() const { return mpRefCacheEntry; }
void SetReleaseTime( const ::vos::TTimeValue& rReleaseTime ) { maReleaseTime = rReleaseTime; }
const ::vos::TTimeValue& GetReleaseTime() const { return maReleaseTime; }
BOOL Matches( OutputDevice* pOut, const Point& rPtPixel, const Size& rSzPixel,
const GraphicCacheEntry* pCacheEntry, const GraphicAttr& rAttr ) const
{
return( ( pCacheEntry == mpRefCacheEntry ) &&
( maAttr == rAttr ) &&
( ( maOutSizePix == rSzPixel ) || ( !maOutSizePix.Width() && !maOutSizePix.Height() ) ) );
}
void Draw( OutputDevice* pOut, const Point& rPt, const Size& rSz ) const;
};
// -----------------------------------------------------------------------------
ULONG GraphicDisplayCacheEntry::GetNeededSize( OutputDevice* pOut, const Point& rPt, const Size& rSz,
const GraphicObject& rObj, const GraphicAttr& rAttr )
{
const GraphicType eType = rObj.GetGraphic().GetType();
ULONG nNeededSize;
if( GRAPHIC_BITMAP == eType )
{
const Size aOutSizePix( pOut->LogicToPixel( rSz ) );
const long nBitCount = pOut->GetBitCount();
if( ( aOutSizePix.Width() > MAX_BMP_EXTENT ) ||
( aOutSizePix.Height() > MAX_BMP_EXTENT ) )
{
nNeededSize = ULONG_MAX;
}
else if( nBitCount )
{
nNeededSize = aOutSizePix.Width() * aOutSizePix.Height() * nBitCount / 8;
if( rObj.IsTransparent() || ( rAttr.GetRotation() % 3600 ) )
nNeededSize += nNeededSize / nBitCount;
}
else
{
DBG_ERROR( "GraphicDisplayCacheEntry::GetNeededSize(): pOut->GetBitCount() == 0" );
nNeededSize = 256000;
}
}
else if( GRAPHIC_GDIMETAFILE == eType )
nNeededSize = 65535;
else
nNeededSize = 0;
return nNeededSize;
}
// -----------------------------------------------------------------------------
GraphicDisplayCacheEntry::~GraphicDisplayCacheEntry()
{
if( mpMtf )
delete mpMtf;
if( mpBmpEx )
delete mpBmpEx;
}
// -----------------------------------------------------------------------------
void GraphicDisplayCacheEntry::Draw( OutputDevice* pOut, const Point& rPt, const Size& rSz ) const
{
if( mpMtf )
GraphicManager::ImplDraw( pOut, rPt, rSz, *mpMtf, maAttr );
else if( mpBmpEx )
{
if( maAttr.IsRotated() )
{
Polygon aPoly( Rectangle( rPt, rSz ) );
aPoly.Rotate( rPt, maAttr.GetRotation() % 3600 );
const Rectangle aRotBoundRect( aPoly.GetBoundRect() );
pOut->DrawBitmapEx( aRotBoundRect.TopLeft(), aRotBoundRect.GetSize(), *mpBmpEx );
}
else
pOut->DrawBitmapEx( rPt, rSz, *mpBmpEx );
}
}
// -----------------------
// - GraphicCache -
// -----------------------
GraphicCache::GraphicCache( GraphicManager& rMgr, ULONG nDisplayCacheSize, ULONG nMaxObjDisplayCacheSize ) :
mrMgr ( rMgr ),
mnMaxDisplaySize ( nDisplayCacheSize ),
mnMaxObjDisplaySize ( nMaxObjDisplayCacheSize ),
mnUsedDisplaySize ( 0UL ),
mnReleaseTimeoutSeconds ( 0UL )
{
maReleaseTimer.SetTimeoutHdl( LINK( this, GraphicCache, ReleaseTimeoutHdl ) );
maReleaseTimer.SetTimeout( RELEASE_TIMEOUT );
maReleaseTimer.Start();
}
// -----------------------------------------------------------------------------
GraphicCache::~GraphicCache()
{
DBG_ASSERT( !maGraphicCache.Count(), "GraphicCache::~GraphicCache(): there are some GraphicObjects in cache" );
DBG_ASSERT( !maDisplayCache.Count(), "GraphicCache::~GraphicCache(): there are some GraphicObjects in display cache" );
}
// -----------------------------------------------------------------------------
void GraphicCache::AddGraphicObject( const GraphicObject& rObj, Graphic& rSubstitute, const ByteString* pID )
{
BOOL bInserted = FALSE;
if( !rObj.IsSwappedOut() && ( ( rObj.GetType() != GRAPHIC_NONE ) || pID ) )
{
GraphicCacheEntry* pEntry = (GraphicCacheEntry*) maGraphicCache.First();
const GraphicID aID( rObj );
while( !bInserted && pEntry )
{
const GraphicID& rID = pEntry->GetID();
if( pID )
{
if( rID.GetIDString() == *pID )
{
pEntry->TryToSwapIn();
// since pEntry->TryToSwapIn can modify our current list, we have to
// iterate from beginning to add a reference to the appropriate
// CacheEntry object; after this, quickly jump out of the outer iteration
for( pEntry = (GraphicCacheEntry*) maGraphicCache.First(); !bInserted && pEntry; pEntry = (GraphicCacheEntry*) maGraphicCache.Next() )
{
const GraphicID& rID = pEntry->GetID();
if( rID.GetIDString() == *pID )
{
pEntry->AddGraphicObjectReference( rObj, rSubstitute );
bInserted = TRUE;
}
}
if( !bInserted )
{
maGraphicCache.Insert( new GraphicCacheEntry( rObj ), LIST_APPEND );
bInserted = TRUE;
}
}
}
else if( rID == aID )
{
pEntry->AddGraphicObjectReference( rObj, rSubstitute );
bInserted = TRUE;
}
if( !bInserted )
pEntry = (GraphicCacheEntry*) maGraphicCache.Next();
}
}
if( !bInserted )
maGraphicCache.Insert( new GraphicCacheEntry( rObj ), LIST_APPEND );
}
// -----------------------------------------------------------------------------
void GraphicCache::ReleaseGraphicObject( const GraphicObject& rObj )
{
// Release cached object
GraphicCacheEntry* pEntry = (GraphicCacheEntry*) maGraphicCache.First();
BOOL bRemoved = FALSE;
while( !bRemoved && pEntry )
{
bRemoved = pEntry->ReleaseGraphicObjectReference( rObj );
if( bRemoved )
{
if( 0 == pEntry->GetGraphicObjectReferenceCount() )
{
// if graphic cache entry has no more references,
// the corresponding display cache object can be removed
GraphicDisplayCacheEntry* pDisplayEntry = (GraphicDisplayCacheEntry*) maDisplayCache.First();
while( pDisplayEntry )
{
if( pDisplayEntry->GetReferencedCacheEntry() == pEntry )
{
mnUsedDisplaySize -= pDisplayEntry->GetCacheSize();
maDisplayCache.Remove( pDisplayEntry );
delete pDisplayEntry;
pDisplayEntry = (GraphicDisplayCacheEntry*) maDisplayCache.GetCurObject();
}
else
pDisplayEntry = (GraphicDisplayCacheEntry*) maDisplayCache.Next();
}
// delete graphic cache entry
maGraphicCache.Remove( (void*) pEntry );
delete pEntry;
}
}
else
pEntry = (GraphicCacheEntry*) maGraphicCache.Next();
}
DBG_ASSERT( bRemoved, "GraphicCache::ReleaseGraphicObject(...): GraphicObject not found in cache" );
}
// -----------------------------------------------------------------------------
void GraphicCache::GraphicObjectWasSwappedOut( const GraphicObject& rObj )
{
ImplGetCacheEntry( rObj )->GraphicObjectWasSwappedOut( rObj );
}
// -----------------------------------------------------------------------------
BOOL GraphicCache::FillSwappedGraphicObject( const GraphicObject& rObj, Graphic& rSubstitute )
{
return( ImplGetCacheEntry( rObj )->FillSwappedGraphicObject( rObj, rSubstitute ) );
}
// -----------------------------------------------------------------------------
void GraphicCache::GraphicObjectWasSwappedIn( const GraphicObject& rObj )
{
GraphicCacheEntry* pEntry = ImplGetCacheEntry( rObj );
if( pEntry )
{
if( pEntry->GetID().IsEmpty() )
{
ReleaseGraphicObject( rObj );
AddGraphicObject( rObj, (Graphic&) rObj.GetGraphic(), NULL );
}
else
pEntry->GraphicObjectWasSwappedIn( rObj );
}
}
// -----------------------------------------------------------------------------
void GraphicCache::SetMaxDisplayCacheSize( ULONG nNewCacheSize )
{
mnMaxDisplaySize = nNewCacheSize;
if( GetMaxDisplayCacheSize() < GetUsedDisplayCacheSize() )
ImplFreeDisplayCacheSpace( GetUsedDisplayCacheSize() - GetMaxDisplayCacheSize() );
}
// -----------------------------------------------------------------------------
void GraphicCache::SetMaxObjDisplayCacheSize( ULONG nNewMaxObjSize, BOOL bDestroyGreaterCached )
{
const BOOL bDestroy = ( bDestroyGreaterCached && ( nNewMaxObjSize < mnMaxObjDisplaySize ) );
mnMaxObjDisplaySize = Min( nNewMaxObjSize, mnMaxDisplaySize );
if( bDestroy )
{
GraphicDisplayCacheEntry* pCacheObj = (GraphicDisplayCacheEntry*) maDisplayCache.First();
while( pCacheObj )
{
if( pCacheObj->GetCacheSize() > mnMaxObjDisplaySize )
{
mnUsedDisplaySize -= pCacheObj->GetCacheSize();
maDisplayCache.Remove( pCacheObj );
delete pCacheObj;
pCacheObj = (GraphicDisplayCacheEntry*) maDisplayCache.GetCurObject();
}
else
pCacheObj = (GraphicDisplayCacheEntry*) maDisplayCache.Next();
}
}
}
// -----------------------------------------------------------------------------
void GraphicCache::SetCacheTimeout( ULONG nTimeoutSeconds )
{
if( mnReleaseTimeoutSeconds != nTimeoutSeconds )
{
GraphicDisplayCacheEntry* pDisplayEntry = (GraphicDisplayCacheEntry*) maDisplayCache.First();
::vos::TTimeValue aReleaseTime;
if( ( mnReleaseTimeoutSeconds = nTimeoutSeconds ) != 0 )
{
osl_getSystemTime( &aReleaseTime );
aReleaseTime.addTime( ::vos::TTimeValue( nTimeoutSeconds, 0 ) );
}
while( pDisplayEntry )
{
pDisplayEntry->SetReleaseTime( aReleaseTime );
pDisplayEntry = (GraphicDisplayCacheEntry*) maDisplayCache.Next();
}
}
}
// -----------------------------------------------------------------------------
void GraphicCache::ClearDisplayCache()
{
for( void* pObj = maDisplayCache.First(); pObj; pObj = maDisplayCache.Next() )
delete (GraphicDisplayCacheEntry*) pObj;
maDisplayCache.Clear();
mnUsedDisplaySize = 0UL;
}
// -----------------------------------------------------------------------------
BOOL GraphicCache::IsDisplayCacheable( OutputDevice* pOut, const Point& rPt, const Size& rSz,
const GraphicObject& rObj, const GraphicAttr& rAttr ) const
{
return( GraphicDisplayCacheEntry::GetNeededSize( pOut, rPt, rSz, rObj, rAttr ) <=
GetMaxObjDisplayCacheSize() );
}
// -----------------------------------------------------------------------------
BOOL GraphicCache::IsInDisplayCache( OutputDevice* pOut, const Point& rPt, const Size& rSz,
const GraphicObject& rObj, const GraphicAttr& rAttr ) const
{
const Point aPtPixel( pOut->LogicToPixel( rPt ) );
const Size aSzPixel( pOut->LogicToPixel( rSz ) );
const GraphicCacheEntry* pCacheEntry = ( (GraphicCache*) this )->ImplGetCacheEntry( rObj );
GraphicDisplayCacheEntry* pDisplayEntry = (GraphicDisplayCacheEntry*) ( (GraphicCache*) this )->maDisplayCache.First();
BOOL bFound = FALSE;
for( long i = 0, nCount = maDisplayCache.Count(); !bFound && ( i < nCount ); i++ )
if( ( (GraphicDisplayCacheEntry*) maDisplayCache.GetObject( i ) )->Matches( pOut, aPtPixel, aSzPixel, pCacheEntry, rAttr ) )
bFound = TRUE;
return bFound;
}
// -----------------------------------------------------------------------------
ByteString GraphicCache::GetUniqueID( const GraphicObject& rObj ) const
{
ByteString aRet;
GraphicCacheEntry* pEntry = ( (GraphicCache*) this )->ImplGetCacheEntry( rObj );
// ensure that the entry is correctly initialized (it has to be read at least once)
if( pEntry && pEntry->GetID().IsEmpty() )
pEntry->TryToSwapIn();
// do another call to ImplGetCacheEntry in case of modified entry list
pEntry = ( (GraphicCache*) this )->ImplGetCacheEntry( rObj );
if( pEntry )
aRet = pEntry->GetID().GetIDString();
return aRet;
}
// -----------------------------------------------------------------------------
BOOL GraphicCache::CreateDisplayCacheObj( OutputDevice* pOut, const Point& rPt, const Size& rSz,
const GraphicObject& rObj, const GraphicAttr& rAttr,
const BitmapEx& rBmpEx )
{
const ULONG nNeededSize = GraphicDisplayCacheEntry::GetNeededSize( pOut, rPt, rSz, rObj, rAttr );
BOOL bRet = FALSE;
if( nNeededSize <= GetMaxObjDisplayCacheSize() )
{
if( nNeededSize > GetFreeDisplayCacheSize() )
ImplFreeDisplayCacheSpace( nNeededSize - GetFreeDisplayCacheSize() );
GraphicDisplayCacheEntry* pNewEntry = new GraphicDisplayCacheEntry( ImplGetCacheEntry( rObj ),
pOut, rPt, rSz, rObj, rAttr, rBmpEx );
if( GetCacheTimeout() )
{
::vos::TTimeValue aReleaseTime;
osl_getSystemTime( &aReleaseTime );
aReleaseTime.addTime( ::vos::TTimeValue( GetCacheTimeout(), 0 ) );
pNewEntry->SetReleaseTime( aReleaseTime );
}
maDisplayCache.Insert( pNewEntry, LIST_APPEND );
mnUsedDisplaySize += pNewEntry->GetCacheSize();
bRet = TRUE;
}
return bRet;
}
// -----------------------------------------------------------------------------
BOOL GraphicCache::CreateDisplayCacheObj( OutputDevice* pOut, const Point& rPt, const Size& rSz,
const GraphicObject& rObj, const GraphicAttr& rAttr,
const GDIMetaFile& rMtf )
{
const ULONG nNeededSize = GraphicDisplayCacheEntry::GetNeededSize( pOut, rPt, rSz, rObj, rAttr );
BOOL bRet = FALSE;
if( nNeededSize <= GetMaxObjDisplayCacheSize() )
{
if( nNeededSize > GetFreeDisplayCacheSize() )
ImplFreeDisplayCacheSpace( nNeededSize - GetFreeDisplayCacheSize() );
GraphicDisplayCacheEntry* pNewEntry = new GraphicDisplayCacheEntry( ImplGetCacheEntry( rObj ),
pOut, rPt, rSz, rObj, rAttr, rMtf );
if( GetCacheTimeout() )
{
::vos::TTimeValue aReleaseTime;
osl_getSystemTime( &aReleaseTime );
aReleaseTime.addTime( ::vos::TTimeValue( GetCacheTimeout(), 0 ) );
pNewEntry->SetReleaseTime( aReleaseTime );
}
maDisplayCache.Insert( pNewEntry, LIST_APPEND );
mnUsedDisplaySize += pNewEntry->GetCacheSize();
bRet = TRUE;
}
return bRet;
}
// -----------------------------------------------------------------------------
BOOL GraphicCache::DrawDisplayCacheObj( OutputDevice* pOut, const Point& rPt, const Size& rSz,
const GraphicObject& rObj, const GraphicAttr& rAttr )
{
const Point aPtPixel( pOut->LogicToPixel( rPt ) );
const Size aSzPixel( pOut->LogicToPixel( rSz ) );
const GraphicCacheEntry* pCacheEntry = ImplGetCacheEntry( rObj );
GraphicDisplayCacheEntry* pDisplayCacheEntry = (GraphicDisplayCacheEntry*) maDisplayCache.First();
BOOL bRet = FALSE;
while( !bRet && pDisplayCacheEntry )
{
if( pDisplayCacheEntry->Matches( pOut, aPtPixel, aSzPixel, pCacheEntry, rAttr ) )
{
::vos::TTimeValue aReleaseTime;
// put found object at last used position
maDisplayCache.Insert( maDisplayCache.Remove( pDisplayCacheEntry ), LIST_APPEND );
if( GetCacheTimeout() )
{
osl_getSystemTime( &aReleaseTime );
aReleaseTime.addTime( ::vos::TTimeValue( GetCacheTimeout(), 0 ) );
}
pDisplayCacheEntry->SetReleaseTime( aReleaseTime );
bRet = TRUE;
}
else
pDisplayCacheEntry = (GraphicDisplayCacheEntry*) maDisplayCache.Next();
}
if( bRet )
pDisplayCacheEntry->Draw( pOut, rPt, rSz );
return bRet;
}
// -----------------------------------------------------------------------------
BOOL GraphicCache::ImplFreeDisplayCacheSpace( ULONG nSizeToFree )
{
ULONG nFreedSize = 0UL;
if( nSizeToFree )
{
void* pObj = maDisplayCache.First();
if( nSizeToFree > mnUsedDisplaySize )
nSizeToFree = mnUsedDisplaySize;
while( pObj )
{
GraphicDisplayCacheEntry* pCacheObj = (GraphicDisplayCacheEntry*) pObj;
nFreedSize += pCacheObj->GetCacheSize();
mnUsedDisplaySize -= pCacheObj->GetCacheSize();
maDisplayCache.Remove( pObj );
delete pCacheObj;
if( nFreedSize >= nSizeToFree )
break;
else
pObj = maDisplayCache.GetCurObject();
}
}
return( nFreedSize >= nSizeToFree );
}
// -----------------------------------------------------------------------------
GraphicCacheEntry* GraphicCache::ImplGetCacheEntry( const GraphicObject& rObj )
{
GraphicCacheEntry* pRet = NULL;
for( void* pObj = maGraphicCache.First(); !pRet && pObj; pObj = maGraphicCache.Next() )
if( ( (GraphicCacheEntry*) pObj )->HasGraphicObjectReference( rObj ) )
pRet = (GraphicCacheEntry*) pObj;
return pRet;
}
// -----------------------------------------------------------------------------
IMPL_LINK( GraphicCache, ReleaseTimeoutHdl, Timer*, pTimer )
{
pTimer->Stop();
::vos::TTimeValue aCurTime;
GraphicDisplayCacheEntry* pDisplayEntry = (GraphicDisplayCacheEntry*) maDisplayCache.First();
osl_getSystemTime( &aCurTime );
while( pDisplayEntry )
{
const ::vos::TTimeValue& rReleaseTime = pDisplayEntry->GetReleaseTime();
if( !rReleaseTime.isEmpty() && ( rReleaseTime < aCurTime ) )
{
mnUsedDisplaySize -= pDisplayEntry->GetCacheSize();
maDisplayCache.Remove( pDisplayEntry );
delete pDisplayEntry;
pDisplayEntry = (GraphicDisplayCacheEntry*) maDisplayCache.GetCurObject();
}
else
pDisplayEntry = (GraphicDisplayCacheEntry*) maDisplayCache.Next();
}
pTimer->Start();
return 0;
}
|