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
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 .
*/
#include "ViewShellManager.hxx"
#include "ViewShell.hxx"
#include "ViewShellBase.hxx"
#include "Window.hxx"
#include "DrawDocShell.hxx"
#include "FormShellManager.hxx"
#include <sfx2/dispatch.hxx>
#include <svx/svxids.hrc>
#include <svx/fmshell.hxx>
#include <iterator>
#include <unordered_map>
namespace sd {
namespace {
/** The ShellDescriptor class is used to shells together with their ids and
the factory that was used to create the shell.
The shell pointer may be NULL. In that case the shell is created on
demand by a factory.
The factory pointer may be NULL. In that case the shell pointer is
given to the ViewShellManager.
Shell pointer and factory pointer can but should not be NULL at the same
time.
*/
class ShellDescriptor {
public:
SfxShell* mpShell;
ShellId mnId;
ViewShellManager::SharedShellFactory mpFactory;
bool mbIsListenerAddedToWindow;
ShellDescriptor ();
explicit ShellDescriptor (ShellId nId);
ShellDescriptor (const ShellDescriptor& rDescriptor);
ShellDescriptor& operator= (const ShellDescriptor& rDescriptor);
vcl::Window* GetWindow() const;
};
/** This functor can be used to search for a shell in an STL container when the
shell pointer is given.
*/
class IsShell
{
public:
explicit IsShell (const SfxShell* pShell) : mpShell(pShell) {}
bool operator() (const ShellDescriptor& rDescriptor)
{ return rDescriptor.mpShell == mpShell; }
private:
const SfxShell* mpShell;
};
/** This functor can be used to search for a shell in an STL container when the
id of the shell is given.
*/
class IsId
{
public:
explicit IsId (ShellId nId) : mnId(nId) {}
bool operator() (const ShellDescriptor& rDescriptor)
{ return rDescriptor.mnId == mnId; }
private:
ShellId mnId;
};
} // end of anonymous namespace
class ViewShellManager::Implementation
{
public:
Implementation (
ViewShellBase& rBase);
~Implementation() COVERITY_NOEXCEPT_FALSE;
void AddShellFactory (
const SfxShell* pViewShell,
const SharedShellFactory& rpFactory);
void RemoveShellFactory (
const SfxShell* pViewShell,
const SharedShellFactory& rpFactory);
void ActivateViewShell (
ViewShell* pViewShell);
void DeactivateViewShell (const ViewShell& rShell);
void ActivateShell (SfxShell& rShell);
void DeactivateShell (const SfxShell& rShell);
void ActivateShell (const ShellDescriptor& rDescriptor);
void SetFormShell (const ViewShell* pViewShell, FmFormShell* pFormShell, bool bAbove);
void ActivateSubShell (const SfxShell& rParentShell, ShellId nId);
void DeactivateSubShell (const SfxShell& rParentShell, ShellId nId);
void MoveToTop (const SfxShell& rParentShell);
SfxShell* GetShell (ShellId nId) const;
SfxShell* GetTopShell() const;
SfxShell* GetTopViewShell() const;
void Shutdown();
void InvalidateAllSubShells (const SfxShell* pParentShell);
/** Remove all shells from the SFX stack above and including the given
shell.
*/
void TakeShellsFromStack (const SfxShell* pShell);
class UpdateLock
{
public:
explicit UpdateLock (Implementation& rImpl) : mrImpl(rImpl) {mrImpl.LockUpdate();}
~UpdateLock() COVERITY_NOEXCEPT_FALSE {mrImpl.UnlockUpdate();}
private:
Implementation& mrImpl;
};
/** Prevent updates of the shell stack. While the sub shell manager is
locked it will update its internal data structures but not alter the
shell stack. Use this method when there are several modifications
to the shell stack to prevent multiple rebuilds of the shell stack
and resulting broadcasts.
*/
void LockUpdate();
/** Allow updates of the shell stack. This method has to be called the
same number of times as LockUpdate() to really allow a rebuild of
the shell stack.
*/
void UnlockUpdate();
private:
ViewShellBase& mrBase;
mutable ::osl::Mutex maMutex;
class ShellHash { public: size_t operator()(const SfxShell* p) const { return reinterpret_cast<size_t>(p);} };
typedef std::unordered_multimap<const SfxShell*,SharedShellFactory,ShellHash>
FactoryList;
FactoryList maShellFactories;
/** List of the active view shells. In order to create gather all shells
to put on the shell stack each view shell in this list is asked for
its sub-shells (typically toolbars).
*/
typedef std::list<ShellDescriptor> ActiveShellList;
ActiveShellList maActiveViewShells;
typedef std::list<ShellDescriptor> SubShellSubList;
typedef std::unordered_map<const SfxShell*,SubShellSubList,ShellHash> SubShellList;
SubShellList maActiveSubShells;
/** In this member we remember what shells we have pushed on the shell
stack.
*/
typedef ::std::vector<SfxShell*> ShellStack;
int mnUpdateLockCount;
/** The UpdateShellStack() method can be called recursively. This flag
is used to communicate between different levels of invocation: if
the stack has been updated in an inner call the outer call can (has
to) stop and return immediately.
*/
bool mbShellStackIsUpToDate;
SfxShell* mpFormShell;
const ViewShell* mpFormShellParent;
bool mbFormShellAboveParent;
SfxShell* mpTopShell;
SfxShell* mpTopViewShell;
void UpdateShellStack();
void CreateShells();
/** This method rebuilds the stack of shells that are stacked upon the
view shell base.
*/
void CreateTargetStack (ShellStack& rStack) const;
DECL_LINK(WindowEventHandler, VclWindowEvent&, void);
#if OSL_DEBUG_LEVEL >= 2
void DumpShellStack (const ShellStack& rStack);
void DumpSfxShellStack();
#endif
/** To be called before a shell is taken fom the SFX shell stack. This
method deactivates an active text editing to avoid problems with
undo managers.
Afterwards the Deactivate() of the shell is called.
*/
static void Deactivate (SfxShell* pShell);
ShellDescriptor CreateSubShell (
SfxShell const * pShell,
ShellId nShellId);
void DestroyViewShell (ShellDescriptor& rDescriptor);
static void DestroySubShell (const ShellDescriptor& rDescriptor);
};
//===== ViewShellManager ======================================================
ViewShellManager::ViewShellManager (ViewShellBase& rBase)
: mpImpl(new Implementation(rBase)),
mbValid(true)
{
}
ViewShellManager::~ViewShellManager()
{
}
void ViewShellManager::AddSubShellFactory (
ViewShell const * pViewShell,
const SharedShellFactory& rpFactory)
{
if (mbValid)
mpImpl->AddShellFactory(pViewShell, rpFactory);
}
void ViewShellManager::RemoveSubShellFactory (
ViewShell const * pViewShell,
const SharedShellFactory& rpFactory)
{
if (mbValid)
mpImpl->RemoveShellFactory(pViewShell, rpFactory);
}
void ViewShellManager::ActivateViewShell (ViewShell* pViewShell)
{
if (mbValid)
return mpImpl->ActivateViewShell(pViewShell);
}
void ViewShellManager::DeactivateViewShell (const ViewShell* pShell)
{
if (mbValid && pShell!=nullptr)
mpImpl->DeactivateViewShell(*pShell);
}
void ViewShellManager::SetFormShell (
const ViewShell* pParentShell,
FmFormShell* pFormShell,
bool bAbove)
{
if (mbValid)
mpImpl->SetFormShell(pParentShell,pFormShell,bAbove);
}
void ViewShellManager::ActivateSubShell (const ViewShell& rViewShell, ShellId nId)
{
if (mbValid)
mpImpl->ActivateSubShell(rViewShell,nId);
}
void ViewShellManager::DeactivateSubShell (const ViewShell& rViewShell, ShellId nId)
{
if (mbValid)
mpImpl->DeactivateSubShell(rViewShell,nId);
}
void ViewShellManager::InvalidateAllSubShells (ViewShell const * pViewShell)
{
if (mbValid)
mpImpl->InvalidateAllSubShells(pViewShell);
}
void ViewShellManager::ActivateShell (SfxShell* pShell)
{
if (mbValid && pShell!=nullptr)
mpImpl->ActivateShell(*pShell);
}
void ViewShellManager::DeactivateShell (const SfxShell* pShell)
{
if (mbValid && pShell!=nullptr)
mpImpl->DeactivateShell(*pShell);
}
void ViewShellManager::MoveToTop (const ViewShell& rParentShell)
{
if (mbValid)
mpImpl->MoveToTop(rParentShell);
}
SfxShell* ViewShellManager::GetShell (ShellId nId) const
{
if (mbValid)
return mpImpl->GetShell(nId);
else
return nullptr;
}
SfxShell* ViewShellManager::GetTopShell() const
{
if (mbValid)
return mpImpl->GetTopShell();
else
return nullptr;
}
SfxShell* ViewShellManager::GetTopViewShell() const
{
if (mbValid)
return mpImpl->GetTopViewShell();
else
return nullptr;
}
void ViewShellManager::Shutdown()
{
if (mbValid)
{
mpImpl->Shutdown();
mbValid = false;
}
}
void ViewShellManager::LockUpdate()
{
mpImpl->LockUpdate();
}
void ViewShellManager::UnlockUpdate()
{
mpImpl->UnlockUpdate();
}
//===== ViewShellManager::Implementation ======================================
ViewShellManager::Implementation::Implementation (
ViewShellBase& rBase)
: mrBase(rBase),
maMutex(),
maShellFactories(),
maActiveViewShells(),
mnUpdateLockCount(0),
mbShellStackIsUpToDate(true),
mpFormShell(nullptr),
mpFormShellParent(nullptr),
mbFormShellAboveParent(true),
mpTopShell(nullptr),
mpTopViewShell(nullptr)
{}
ViewShellManager::Implementation::~Implementation() COVERITY_NOEXCEPT_FALSE
{
Shutdown();
}
void ViewShellManager::Implementation::AddShellFactory (
const SfxShell* pViewShell,
const SharedShellFactory& rpFactory)
{
bool bAlreadyAdded (false);
// Check that the given factory has not already been added.
::std::pair<FactoryList::iterator,FactoryList::iterator> aRange(
maShellFactories.equal_range(pViewShell));
for (FactoryList::const_iterator iFactory=aRange.first; iFactory!=aRange.second; ++iFactory)
if (iFactory->second == rpFactory)
{
bAlreadyAdded = true;
break;
}
// Add the factory if it is not already present.
if ( ! bAlreadyAdded)
maShellFactories.emplace(pViewShell, rpFactory);
}
void ViewShellManager::Implementation::RemoveShellFactory (
const SfxShell* pViewShell,
const SharedShellFactory& rpFactory)
{
::std::pair<FactoryList::iterator,FactoryList::iterator> aRange(
maShellFactories.equal_range(pViewShell));
for (FactoryList::iterator iFactory=aRange.first; iFactory!=aRange.second; ++iFactory)
if (iFactory->second == rpFactory)
{
maShellFactories.erase(iFactory);
break;
}
}
void ViewShellManager::Implementation::ActivateViewShell (ViewShell* pViewShell)
{
::osl::MutexGuard aGuard (maMutex);
ShellDescriptor aResult;
aResult.mpShell = pViewShell;
// Register as window listener so that the shells of the current
// window can be moved to the top of the shell stack.
if (aResult.mpShell != nullptr)
{
vcl::Window* pWindow = aResult.GetWindow();
if (pWindow != nullptr)
{
pWindow->AddEventListener(
LINK(this, ViewShellManager::Implementation, WindowEventHandler));
aResult.mbIsListenerAddedToWindow = true;
}
else
{
SAL_WARN("sd.view",
"ViewShellManager::ActivateViewShell: "
"new view shell has no active window");
}
}
ActivateShell(aResult);
}
void ViewShellManager::Implementation::DeactivateViewShell (const ViewShell& rShell)
{
::osl::MutexGuard aGuard (maMutex);
ActiveShellList::iterator iShell (::std::find_if (
maActiveViewShells.begin(),
maActiveViewShells.end(),
IsShell(&rShell)));
if (iShell != maActiveViewShells.end())
{
UpdateLock aLocker (*this);
ShellDescriptor aDescriptor(*iShell);
mrBase.GetDocShell()->Disconnect(dynamic_cast<ViewShell*>(aDescriptor.mpShell));
maActiveViewShells.erase(iShell);
TakeShellsFromStack(aDescriptor.mpShell);
// Deactivate sub shells.
SubShellList::iterator iList (maActiveSubShells.find(&rShell));
if (iList != maActiveSubShells.end())
{
SubShellSubList& rList (iList->second);
while ( ! rList.empty())
DeactivateSubShell(rShell, rList.front().mnId);
}
DestroyViewShell(aDescriptor);
}
}
void ViewShellManager::Implementation::ActivateShell (SfxShell& rShell)
{
::osl::MutexGuard aGuard (maMutex);
// Create a new shell or recycle on in the cache.
ShellDescriptor aDescriptor;
aDescriptor.mpShell = &rShell;
ActivateShell(aDescriptor);
}
void ViewShellManager::Implementation::ActivateShell (const ShellDescriptor& rDescriptor)
{
// Put shell on top of the active view shells.
if (rDescriptor.mpShell != nullptr)
{
maActiveViewShells.insert( maActiveViewShells.begin(), rDescriptor);
}
}
void ViewShellManager::Implementation::DeactivateShell (const SfxShell& rShell)
{
::osl::MutexGuard aGuard (maMutex);
ActiveShellList::iterator iShell (::std::find_if (
maActiveViewShells.begin(),
maActiveViewShells.end(),
IsShell(&rShell)));
if (iShell != maActiveViewShells.end())
{
UpdateLock aLocker (*this);
ShellDescriptor aDescriptor(*iShell);
mrBase.GetDocShell()->Disconnect(dynamic_cast<ViewShell*>(aDescriptor.mpShell));
maActiveViewShells.erase(iShell);
TakeShellsFromStack(aDescriptor.mpShell);
// Deactivate sub shells.
SubShellList::iterator iList (maActiveSubShells.find(&rShell));
if (iList != maActiveSubShells.end())
{
SubShellSubList& rList (iList->second);
while ( ! rList.empty())
DeactivateSubShell(rShell, rList.front().mnId);
}
DestroyViewShell(aDescriptor);
}
}
void ViewShellManager::Implementation::ActivateSubShell (
const SfxShell& rParentShell,
ShellId nId)
{
::osl::MutexGuard aGuard (maMutex);
// Check that the given view shell is active.
ActiveShellList::iterator iShell (::std::find_if (
maActiveViewShells.begin(),
maActiveViewShells.end(),
IsShell(&rParentShell)));
if (iShell == maActiveViewShells.end())
return;
// Create the sub shell list if it does not yet exist.
SubShellList::iterator iList (maActiveSubShells.find(&rParentShell));
if (iList == maActiveSubShells.end())
iList = maActiveSubShells.emplace(&rParentShell,SubShellSubList()).first;
// Do not activate an object bar that is already active. Requesting
// this is not exactly an error but may be an indication of one.
SubShellSubList& rList (iList->second);
if (::std::find_if(rList.begin(),rList.end(), IsId(nId)) != rList.end())
return;
// Add just the id of the sub shell. The actual shell is created
// later in CreateShells().
UpdateLock aLock (*this);
rList.push_back(ShellDescriptor(nId));
}
void ViewShellManager::Implementation::DeactivateSubShell (
const SfxShell& rParentShell,
ShellId nId)
{
::osl::MutexGuard aGuard (maMutex);
// Check that the given view shell is active.
SubShellList::iterator iList (maActiveSubShells.find(&rParentShell));
if (iList == maActiveSubShells.end())
return;
// Look up the sub shell.
SubShellSubList& rList (iList->second);
SubShellSubList::iterator iShell (
::std::find_if(rList.begin(),rList.end(), IsId(nId)));
if (iShell == rList.end())
return;
SfxShell* pShell = iShell->mpShell;
if (pShell == nullptr)
return;
UpdateLock aLock (*this);
ShellDescriptor aDescriptor(*iShell);
// Remove the sub shell from both the internal structure as well as the
// SFX shell stack above and including the sub shell.
rList.erase(iShell);
TakeShellsFromStack(pShell);
DestroySubShell(aDescriptor);
}
void ViewShellManager::Implementation::MoveToTop (const SfxShell& rShell)
{
::osl::MutexGuard aGuard (maMutex);
// Check that we have access to a dispatcher. If not, then we are
// (probably) called while the view shell is still being created or
// initialized. Without dispatcher we can not rebuild the shell stack
// to move the requested shell to the top. So return right away instead
// of making a mess without being able to clean up afterwards.
if (mrBase.GetDispatcher() == nullptr)
return;
ActiveShellList::iterator iShell (::std::find_if (
maActiveViewShells.begin(),
maActiveViewShells.end(),
IsShell(&rShell)));
bool bMove = true;
if (iShell != maActiveViewShells.end())
{
// Is the shell already at the top of the stack? We have to keep
// the case in mind that mbKeepMainViewShellOnTop is true. Shells
// that are not the main view shell are placed on the second-to-top
// position in this case.
if (iShell == maActiveViewShells.begin())
{
// The shell is at the top position and is either a) the main
// view shell or b) another shell but the main view shell is not
// kept at the top position. We do not have to move the shell.
bMove = false;
}
}
else
{
// The shell is not on the stack. Therefore it can not be moved.
// We could insert it but we don't. Use ActivateViewShell() for
// that.
bMove = false;
}
// When the shell is not at the right position it is removed from the
// internal list of shells and inserted at the correct position.
if (bMove)
{
UpdateLock aLock (*this);
ShellDescriptor aDescriptor(*iShell);
TakeShellsFromStack(&rShell);
maActiveViewShells.erase(iShell);
maActiveViewShells.insert(maActiveViewShells.begin(), aDescriptor);
}
}
SfxShell* ViewShellManager::Implementation::GetShell (ShellId nId) const
{
::osl::MutexGuard aGuard (maMutex);
SfxShell* pShell = nullptr;
// First search the active view shells.
ActiveShellList::const_iterator iShell (
::std::find_if (
maActiveViewShells.begin(),
maActiveViewShells.end(),
IsId(nId)));
if (iShell != maActiveViewShells.end())
pShell = iShell->mpShell;
else
{
// Now search the active sub shells of every active view shell.
SubShellList::const_iterator iList;
for (iList=maActiveSubShells.begin(); iList!=maActiveSubShells.end(); ++iList)
{
const SubShellSubList& rList (iList->second);
SubShellSubList::const_iterator iSubShell(
::std::find_if(rList.begin(),rList.end(), IsId(nId)));
if (iSubShell != rList.end())
{
pShell = iSubShell->mpShell;
break;
}
}
}
return pShell;
}
SfxShell* ViewShellManager::Implementation::GetTopShell() const
{
OSL_ASSERT(mpTopShell == mrBase.GetSubShell(0));
return mpTopShell;
}
SfxShell* ViewShellManager::Implementation::GetTopViewShell() const
{
return mpTopViewShell;
}
void ViewShellManager::Implementation::LockUpdate()
{
mnUpdateLockCount++;
}
void ViewShellManager::Implementation::UnlockUpdate()
{
::osl::MutexGuard aGuard (maMutex);
mnUpdateLockCount--;
if (mnUpdateLockCount < 0)
{
// This should not happen.
OSL_ASSERT (mnUpdateLockCount>=0);
mnUpdateLockCount = 0;
}
if (mnUpdateLockCount == 0)
UpdateShellStack();
}
/** Update the SFX shell stack (the portion that is visible to us) so that
it matches the internal shell stack. This is done in six steps:
1. Create the missing view shells and sub shells.
2. Set up the internal shell stack.
3. Get the SFX shell stack.
4. Find the lowest shell in which the two stacks differ.
5. Remove all shells above and including that shell from the SFX stack.
6. Push all shells of the internal stack on the SFX shell stack that are
not already present on the later.
*/
void ViewShellManager::Implementation::UpdateShellStack()
{
::osl::MutexGuard aGuard (maMutex);
// Remember the undo manager from the top-most shell on the stack.
SfxShell* pTopMostShell = mrBase.GetSubShell(0);
::svl::IUndoManager* pUndoManager = (pTopMostShell!=nullptr)
? pTopMostShell->GetUndoManager()
: nullptr;
// 1. Create the missing shells.
CreateShells();
// Update the pointer to the top-most active view shell.
mpTopViewShell = (maActiveViewShells.empty())
? nullptr : maActiveViewShells.begin()->mpShell;
// 2. Create the internal target stack.
ShellStack aTargetStack;
CreateTargetStack(aTargetStack);
// 3. Get SFX shell stack.
ShellStack aSfxShellStack;
sal_uInt16 nIndex (0);
while (mrBase.GetSubShell(nIndex)!=nullptr)
++nIndex;
aSfxShellStack.reserve(nIndex);
while (nIndex-- > 0)
aSfxShellStack.push_back(mrBase.GetSubShell(nIndex));
#if OSL_DEBUG_LEVEL >= 2
SAL_INFO("sd.view", OSL_THIS_FUNC << ": Current SFX Stack");
DumpShellStack(aSfxShellStack);
SAL_INFO("sd.view", OSL_THIS_FUNC << ": Target Stack");
DumpShellStack(aTargetStack);
#endif
// 4. Find the lowest shell in which the two stacks differ.
ShellStack::iterator iSfxShell (aSfxShellStack.begin());
ShellStack::iterator iTargetShell (aTargetStack.begin());
while (iSfxShell != aSfxShellStack.end()
&& iTargetShell!=aTargetStack.end()
&& (*iSfxShell)==(*iTargetShell))
{
++iSfxShell;
++iTargetShell;
}
// 5. Remove all shells above and including the differing shell from the
// SFX stack starting with the shell on top of the stack.
for (std::reverse_iterator<ShellStack::const_iterator> i(aSfxShellStack.end()), iLast(iSfxShell);
i != iLast; ++i)
{
SfxShell* const pShell = *i;
SAL_INFO("sd.view", OSL_THIS_FUNC << ": removing shell " << pShell << " from stack");
mrBase.RemoveSubShell(pShell);
}
aSfxShellStack.erase(iSfxShell, aSfxShellStack.end());
// 6. Push shells from the given stack onto the SFX stack.
mbShellStackIsUpToDate = false;
while (iTargetShell != aTargetStack.end())
{
SAL_INFO("sd.view", OSL_THIS_FUNC << ": pushing shell " << *iTargetShell << " on stack");
mrBase.AddSubShell(**iTargetShell);
++iTargetShell;
// The pushing of the shell on to the shell stack may have lead to
// another invocation of this method. In this case we have to abort
// pushing shells on the stack and return immediately.
if (mbShellStackIsUpToDate)
break;
}
if (mrBase.GetDispatcher() != nullptr)
mrBase.GetDispatcher()->Flush();
// Update the pointer to the top-most shell and set its undo manager
// to the one of the previous top-most shell.
mpTopShell = mrBase.GetSubShell(0);
if (mpTopShell!=nullptr && pUndoManager!=nullptr && mpTopShell->GetUndoManager()==nullptr)
mpTopShell->SetUndoManager(pUndoManager);
// Finally tell an invocation of this method on a higher level that it can (has
// to) abort and return immediately.
mbShellStackIsUpToDate = true;
#if OSL_DEBUG_LEVEL >= 2
SAL_INFO("sd.view", OSL_THIS_FUNC << ": New current stack");
DumpSfxShellStack();
#endif
}
void ViewShellManager::Implementation::TakeShellsFromStack (const SfxShell* pShell)
{
::osl::MutexGuard aGuard (maMutex);
// Remember the undo manager from the top-most shell on the stack.
SfxShell* pTopMostShell = mrBase.GetSubShell(0);
::svl::IUndoManager* pUndoManager = (pTopMostShell!=nullptr)
? pTopMostShell->GetUndoManager()
: nullptr;
#if OSL_DEBUG_LEVEL >= 2
SAL_INFO("sd.view", OSL_THIS_FUNC << "TakeShellsFromStack( " << pShell << ")");
DumpSfxShellStack();
#endif
// 0.Make sure that the given shell is on the stack. This is a
// preparation for the following assertion.
for (sal_uInt16 nIndex=0; true; nIndex++)
{
SfxShell* pShellOnStack = mrBase.GetSubShell(nIndex);
if (pShellOnStack == nullptr)
{
// Set pShell to NULL to indicate the following code that the
// shell is not on the stack.
pShell = nullptr;
break;
}
else if (pShellOnStack == pShell)
break;
}
if (pShell != nullptr)
{
// 1. Deactivate our shells on the stack before they are removed so
// that during the Deactivation() calls the stack is still intact.
for (sal_uInt16 nIndex=0; true; nIndex++)
{
SfxShell* pShellOnStack = mrBase.GetSubShell(nIndex);
Deactivate(pShellOnStack);
if (pShellOnStack == pShell)
break;
}
// 2. Remove the shells from the stack.
while (true)
{
SfxShell* pShellOnStack = mrBase.GetSubShell(0);
SAL_INFO("sd.view", OSL_THIS_FUNC << "removing shell " << pShellOnStack << " from stack");
mrBase.RemoveSubShell(pShellOnStack);
if (pShellOnStack == pShell)
break;
}
// 3. Update the stack.
if (mrBase.GetDispatcher() != nullptr)
mrBase.GetDispatcher()->Flush();
// Update the pointer to the top-most shell and set its undo manager
// to the one of the previous top-most shell.
mpTopShell = mrBase.GetSubShell(0);
if (mpTopShell!=nullptr && pUndoManager!=nullptr && mpTopShell->GetUndoManager()==nullptr)
mpTopShell->SetUndoManager(pUndoManager);
}
#if OSL_DEBUG_LEVEL >= 2
SAL_INFO("sd.view", OSL_THIS_FUNC << "Sfx shell stack is:");
DumpSfxShellStack();
#endif
}
void ViewShellManager::Implementation::CreateShells()
{
::osl::MutexGuard aGuard (maMutex);
// Iterate over all view shells.
ActiveShellList::reverse_iterator iShell;
for (iShell=maActiveViewShells.rbegin(); iShell!=maActiveViewShells.rend(); ++iShell)
{
// Get the list of associated sub shells.
SubShellList::iterator iList (maActiveSubShells.find(iShell->mpShell));
if (iList != maActiveSubShells.end())
{
SubShellSubList& rList (iList->second);
// Iterate over all sub shells of the current view shell.
SubShellSubList::iterator iSubShell;
for (iSubShell=rList.begin(); iSubShell!=rList.end(); ++iSubShell)
{
if (iSubShell->mpShell == nullptr)
{
*iSubShell = CreateSubShell(iShell->mpShell,iSubShell->mnId);
}
}
}
}
}
void ViewShellManager::Implementation::CreateTargetStack (ShellStack& rStack) const
{
// Create a local stack of the shells that are to push on the shell
// stack. We can thus safely create the required shells wile still
// having a valid shell stack.
for (ActiveShellList::const_reverse_iterator iViewShell (maActiveViewShells.rbegin());
iViewShell != maActiveViewShells.rend();
++iViewShell)
{
// Possibly place the form shell below the current view shell.
if ( ! mbFormShellAboveParent
&& mpFormShell!=nullptr
&& iViewShell->mpShell==mpFormShellParent)
{
rStack.push_back(mpFormShell);
}
// Put the view shell itself on the local stack.
rStack.push_back (iViewShell->mpShell);
// Possibly place the form shell above the current view shell.
if (mbFormShellAboveParent
&& mpFormShell!=nullptr
&& iViewShell->mpShell==mpFormShellParent)
{
rStack.push_back(mpFormShell);
}
// Add all other sub shells.
SubShellList::const_iterator iList (maActiveSubShells.find(iViewShell->mpShell));
if (iList != maActiveSubShells.end())
{
const SubShellSubList& rList (iList->second);
SubShellSubList::const_reverse_iterator iSubShell;
for (iSubShell=rList.rbegin(); iSubShell!=rList.rend(); ++iSubShell)
if (iSubShell->mpShell != mpFormShell)
rStack.push_back(iSubShell->mpShell);
}
}
}
IMPL_LINK(ViewShellManager::Implementation, WindowEventHandler, VclWindowEvent&, rEvent, void)
{
vcl::Window* pEventWindow = rEvent.GetWindow();
switch (rEvent.GetId())
{
case VclEventId::WindowGetFocus:
{
for (ActiveShellList::iterator aI(maActiveViewShells.begin());
aI!=maActiveViewShells.end();
++aI)
{
if (pEventWindow == aI->GetWindow())
{
MoveToTop(*aI->mpShell);
break;
}
}
}
break;
case VclEventId::WindowLoseFocus:
break;
case VclEventId::ObjectDying:
// Remember that we do not have to remove the window
// listener for this window.
for (ActiveShellList::iterator
iShell(maActiveViewShells.begin()),
iEnd(maActiveViewShells.end());
iShell!=iEnd;
++iShell)
{
if (iShell->GetWindow() == pEventWindow)
{
iShell->mbIsListenerAddedToWindow = false;
break;
}
}
break;
default: break;
}
}
ShellDescriptor ViewShellManager::Implementation::CreateSubShell (
SfxShell const * pParentShell,
ShellId nShellId)
{
::osl::MutexGuard aGuard (maMutex);
ShellDescriptor aResult;
// Look up the factories for the parent shell.
::std::pair<FactoryList::iterator,FactoryList::iterator> aRange(
maShellFactories.equal_range(pParentShell));
// Try all factories to create the shell.
for (FactoryList::const_iterator iFactory=aRange.first; iFactory!=aRange.second; ++iFactory)
{
SharedShellFactory pFactory = iFactory->second;
if (pFactory != nullptr)
aResult.mpShell = pFactory->CreateShell(nShellId);
// Exit the loop when the shell has been successfully created.
if (aResult.mpShell != nullptr)
{
aResult.mpFactory = pFactory;
aResult.mnId = nShellId;
break;
}
}
return aResult;
}
void ViewShellManager::Implementation::DestroyViewShell (
ShellDescriptor& rDescriptor)
{
OSL_ASSERT(rDescriptor.mpShell != nullptr);
if (rDescriptor.mbIsListenerAddedToWindow)
{
rDescriptor.mbIsListenerAddedToWindow = false;
vcl::Window* pWindow = rDescriptor.GetWindow();
if (pWindow != nullptr)
{
pWindow->RemoveEventListener(
LINK(this, ViewShellManager::Implementation, WindowEventHandler));
}
}
// Destroy the sub shell factories.
::std::pair<FactoryList::iterator,FactoryList::iterator> aRange(
maShellFactories.equal_range(rDescriptor.mpShell));
if (aRange.first != maShellFactories.end())
maShellFactories.erase(aRange.first, aRange.second);
// Release the shell.
if (rDescriptor.mpFactory.get() != nullptr)
rDescriptor.mpFactory->ReleaseShell(rDescriptor.mpShell);
}
void ViewShellManager::Implementation::DestroySubShell (
const ShellDescriptor& rDescriptor)
{
OSL_ASSERT(rDescriptor.mpFactory.get() != nullptr);
rDescriptor.mpFactory->ReleaseShell(rDescriptor.mpShell);
}
void ViewShellManager::Implementation::InvalidateAllSubShells (const SfxShell* pParentShell)
{
::osl::MutexGuard aGuard (maMutex);
SubShellList::iterator iList (maActiveSubShells.find(pParentShell));
if (iList != maActiveSubShells.end())
{
SubShellSubList& rList (iList->second);
SubShellSubList::iterator iShell;
for (iShell=rList.begin(); iShell!=rList.end(); ++iShell)
if (iShell->mpShell != nullptr)
iShell->mpShell->Invalidate();
}
}
void ViewShellManager::Implementation::Shutdown()
{
::osl::MutexGuard aGuard (maMutex);
// Take stacked shells from stack.
if ( ! maActiveViewShells.empty())
{
UpdateLock aLock (*this);
while ( ! maActiveViewShells.empty())
{
SfxShell* pShell = maActiveViewShells.front().mpShell;
if (pShell != nullptr)
{
ViewShell* pViewShell = dynamic_cast<ViewShell*>(pShell);
if (pViewShell != nullptr)
DeactivateViewShell(*pViewShell);
else
DeactivateShell(*pShell);
}
else
{
SAL_WARN("sd.view",
"ViewShellManager::Implementation::Shutdown(): empty active shell descriptor");
maActiveViewShells.pop_front();
}
}
}
mrBase.RemoveSubShell ();
maShellFactories.clear();
}
#if OSL_DEBUG_LEVEL >= 2
void ViewShellManager::Implementation::DumpShellStack (const ShellStack& rStack)
{
ShellStack::const_reverse_iterator iEntry;
for (iEntry=rStack.rbegin(); iEntry!=rStack.rend(); ++iEntry)
if (*iEntry != NULL)
SAL_INFO("sd.view", OSL_THIS_FUNC << ": " <<
*iEntry << " : " <<
(*iEntry)->GetName());
else
SAL_INFO("sd.view", OSL_THIS_FUNC << " null");
}
void ViewShellManager::Implementation::DumpSfxShellStack()
{
ShellStack aSfxShellStack;
sal_uInt16 nIndex (0);
while (mrBase.GetSubShell(nIndex)!=NULL)
++nIndex;
aSfxShellStack.reserve(nIndex);
while (nIndex-- > 0)
aSfxShellStack.push_back(mrBase.GetSubShell(nIndex));
DumpShellStack(aSfxShellStack);
}
#endif
void ViewShellManager::Implementation::Deactivate (SfxShell* pShell)
{
OSL_ASSERT(pShell!=nullptr);
// We have to end a text edit for view shells that are to be taken from
// the shell stack.
ViewShell* pViewShell = dynamic_cast<ViewShell*>(pShell);
if (pViewShell != nullptr)
{
sd::View* pView = pViewShell->GetView();
if (pView!=nullptr && pView->IsTextEdit())
{
pView->SdrEndTextEdit();
pView->UnmarkAll();
pViewShell->GetViewFrame()->GetDispatcher()->Execute(
SID_OBJECT_SELECT,
SfxCallMode::ASYNCHRON);
}
}
// Now we can deactivate the shell.
pShell->Deactivate(true);
}
void ViewShellManager::Implementation::SetFormShell (
const ViewShell* pFormShellParent,
FmFormShell* pFormShell,
bool bFormShellAboveParent)
{
::osl::MutexGuard aGuard (maMutex);
mpFormShellParent = pFormShellParent;
mpFormShell = pFormShell;
mbFormShellAboveParent = bFormShellAboveParent;
}
namespace {
ShellDescriptor::ShellDescriptor()
: mpShell(nullptr),
mnId(ToolbarId::None),
mpFactory(),
mbIsListenerAddedToWindow(false)
{
}
ShellDescriptor::ShellDescriptor (
ShellId nId)
: mpShell(nullptr),
mnId(nId),
mpFactory(),
mbIsListenerAddedToWindow(false)
{
}
ShellDescriptor::ShellDescriptor (const ShellDescriptor& rDescriptor)
: mpShell(rDescriptor.mpShell),
mnId(rDescriptor.mnId),
mpFactory(rDescriptor.mpFactory),
mbIsListenerAddedToWindow(rDescriptor.mbIsListenerAddedToWindow)
{
}
ShellDescriptor& ShellDescriptor::operator= (const ShellDescriptor& rDescriptor)
{
if (this != &rDescriptor)
{
mpShell = rDescriptor.mpShell;
mnId = rDescriptor.mnId;
mpFactory = rDescriptor.mpFactory;
mbIsListenerAddedToWindow = rDescriptor.mbIsListenerAddedToWindow;
}
return *this;
}
vcl::Window* ShellDescriptor::GetWindow() const
{
ViewShell* pViewShell = dynamic_cast<ViewShell*>(mpShell);
if (pViewShell != nullptr)
return pViewShell->GetActiveWindow();
else
return nullptr;
}
} // end of anonymous namespace
} // end of namespace sd
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|