-
Notifications
You must be signed in to change notification settings - Fork 2.1k
/
Copy pathSVGObserverUtils.cpp
1909 lines (1622 loc) · 64.7 KB
/
SVGObserverUtils.cpp
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
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* 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/. */
// Main header first:
#include "SVGObserverUtils.h"
// Keep others in (case-insensitive) order:
#include "mozilla/css/ImageLoader.h"
#include "mozilla/dom/CanvasRenderingContext2D.h"
#include "mozilla/dom/ReferrerInfo.h"
#include "mozilla/dom/SVGGeometryElement.h"
#include "mozilla/dom/SVGMPathElement.h"
#include "mozilla/dom/SVGTextPathElement.h"
#include "mozilla/dom/SVGUseElement.h"
#include "mozilla/PresShell.h"
#include "mozilla/RestyleManager.h"
#include "mozilla/SVGClipPathFrame.h"
#include "mozilla/SVGGeometryFrame.h"
#include "mozilla/SVGMaskFrame.h"
#include "mozilla/SVGTextFrame.h"
#include "mozilla/SVGUtils.h"
#include "nsCSSFrameConstructor.h"
#include "nsCycleCollectionParticipant.h"
#include "nsHashKeys.h"
#include "nsIContent.h"
#include "nsIContentInlines.h"
#include "nsInterfaceHashtable.h"
#include "nsIReflowCallback.h"
#include "nsISupportsImpl.h"
#include "nsLayoutUtils.h"
#include "nsNetUtil.h"
#include "nsTHashtable.h"
#include "nsURIHashKey.h"
#include "SVGFilterFrame.h"
#include "SVGMarkerFrame.h"
#include "SVGPaintServerFrame.h"
using namespace mozilla::dom;
namespace mozilla {
/*
* This class contains URL and referrer information (referrer and referrer
* policy).
* We use it to pass to svg system instead of nsIURI. The object brings referrer
* and referrer policy so we can send correct Referer headers.
*/
class SVGReference {
public:
SVGReference(const nsAString& aLocalRef, nsIURI* aBase,
nsIReferrerInfo* aReferrerInfo)
: mLocalRef(aLocalRef), mURI(aBase), mReferrerInfo(aReferrerInfo) {
MOZ_ASSERT(nsContentUtils::IsLocalRefURL(mLocalRef));
}
SVGReference(const nsACString& aLocalRef, const URLExtraData& aExtraData)
: mURI(aExtraData.BaseURI()), mReferrerInfo(aExtraData.ReferrerInfo()) {
CopyUTF8toUTF16(aLocalRef, mLocalRef);
MOZ_ASSERT(nsContentUtils::IsLocalRefURL(mLocalRef));
}
SVGReference(nsIURI* aURI, nsIReferrerInfo* aReferrerInfo)
: mURI(aURI), mReferrerInfo(aReferrerInfo) {
MOZ_ASSERT(aURI);
}
SVGReference(nsIURI* aURI, const URLExtraData& aExtraData)
: mURI(aURI), mReferrerInfo(aExtraData.ReferrerInfo()) {
MOZ_ASSERT(aURI);
}
NS_INLINE_DECL_REFCOUNTING(SVGReference)
bool IsLocalRef() const { return !mLocalRef.IsEmpty(); }
const nsAString& GetLocalRef() const { return mLocalRef; }
nsIURI* GetURI() const { return mURI; }
nsIReferrerInfo* GetReferrerInfo() const { return mReferrerInfo; }
bool operator==(const SVGReference& aRHS) const;
private:
~SVGReference() = default;
nsString mLocalRef;
// For local refs, this is the base URI that specified the URL. For non-local
// refs, this is the whole URI. This is needed so that we can distinguish URIs
// from an inner shadow tree and inherited ones.
const nsCOMPtr<nsIURI> mURI;
const nsCOMPtr<nsIReferrerInfo> mReferrerInfo;
};
bool SVGReference::operator==(const SVGReference& aRHS) const {
if (mLocalRef != aRHS.mLocalRef) {
return false;
}
bool uriEqual = false, referrerEqual = false;
mURI->Equals(aRHS.mURI, &uriEqual);
mReferrerInfo->Equals(aRHS.mReferrerInfo, &referrerEqual);
return uriEqual && referrerEqual;
}
class SVGReferenceHashKey : public PLDHashEntryHdr {
public:
using KeyType = const SVGReference*;
using KeyTypePointer = const SVGReference*;
explicit SVGReferenceHashKey(const SVGReference* aKey) noexcept : mKey(aKey) {
MOZ_COUNT_CTOR(SVGReferenceHashKey);
}
SVGReferenceHashKey(SVGReferenceHashKey&& aToMove) noexcept
: PLDHashEntryHdr(std::move(aToMove)), mKey(std::move(aToMove.mKey)) {
MOZ_COUNT_CTOR(SVGReferenceHashKey);
}
MOZ_COUNTED_DTOR(SVGReferenceHashKey)
const SVGReference* GetKey() const { return mKey; }
bool KeyEquals(const SVGReference* aKey) const {
if (!mKey) {
return !aKey;
}
return *mKey == *aKey;
}
static const SVGReference* KeyToPointer(const SVGReference* aKey) {
return aKey;
}
static PLDHashNumber HashKey(const SVGReference* aKey) {
MOZ_ASSERT(aKey);
nsAutoCString urlSpec, referrerSpec;
// nsURIHashKey ignores GetSpec() failures, so we do too:
Unused << aKey->GetURI()->GetSpec(urlSpec);
return AddToHash(
HashString(aKey->GetLocalRef()), HashString(urlSpec),
static_cast<ReferrerInfo*>(aKey->GetReferrerInfo())->Hash());
}
enum { ALLOW_MEMMOVE = true };
protected:
RefPtr<const SVGReference> mKey;
};
static already_AddRefed<SVGReference> ResolveURLUsingLocalRef(
const StyleComputedUrl& aURL) {
if (aURL.IsLocalRef()) {
return MakeAndAddRef<SVGReference>(aURL.SpecifiedSerialization(),
aURL.ExtraData());
}
nsCOMPtr<nsIURI> uri = aURL.GetURI();
if (!uri) {
return nullptr;
}
return do_AddRef(new SVGReference(uri, aURL.ExtraData()));
}
static already_AddRefed<SVGReference> ResolveURLUsingLocalRef(
nsIContent* aContent, const nsAString& aURL) {
// We want to resolve the URL against any <use> element shadow tree's source
// document. We are assuming that the URL was specified directly on mFrame's
// content (because this ResolveURLUsingLocalRef overload is used for href=""
// attributes and not CSS URL values), so there is no need to check whether
// the URL was specified / inherited from outside the shadow tree.
nsIURI* base = nullptr;
const Encoding* encoding = nullptr;
if (SVGUseElement* use = aContent->GetContainingSVGUseShadowHost()) {
base = use->GetSourceDocURI();
encoding = use->GetSourceDocCharacterSet();
}
// There's no clear refererer policy spec about non-CSS SVG resource
// references Bug 1415044 to investigate which referrer we should use
nsIReferrerInfo* referrerInfo =
aContent->OwnerDoc()->ReferrerInfoForInternalCSSAndSVGResources();
if (nsContentUtils::IsLocalRefURL(aURL)) {
return MakeAndAddRef<SVGReference>(aURL, base, referrerInfo);
}
if (!base) {
base = aContent->OwnerDoc()->GetDocumentURI();
encoding = aContent->OwnerDoc()->GetDocumentCharacterSet();
}
nsCOMPtr<nsIURI> uri;
Unused << NS_NewURI(getter_AddRefs(uri), aURL, WrapNotNull(encoding), base);
if (!uri) {
return nullptr;
}
return do_AddRef(new SVGReference(uri, referrerInfo));
}
class SVGFilterObserverList;
/**
* A class used as a member of the "observer" classes below to help them
* avoid dereferencing their frame during presshell teardown when their frame
* may have been destroyed (leaving their pointer to their frame dangling).
*
* When a presshell is torn down, the properties for each frame may not be
* deleted until after the frames are destroyed. "Observer" objects (attached
* as frame properties) must therefore check whether the presshell is being
* torn down before using their pointer to their frame.
*
* mFramePresShell may be null, but when mFrame is non-null, mFramePresShell
* is guaranteed to be non-null, too.
*/
struct SVGFrameReferenceFromProperty {
explicit SVGFrameReferenceFromProperty(nsIFrame* aFrame)
: mFrame(aFrame), mFramePresShell(aFrame->PresShell()) {}
// Clear our reference to the frame.
void Detach() {
mFrame = nullptr;
mFramePresShell = nullptr;
}
// null if the frame has become invalid
nsIFrame* Get() {
if (mFramePresShell && mFramePresShell->IsDestroying()) {
Detach(); // mFrame is no longer valid.
}
return mFrame;
}
private:
// The frame that our property is attached to (may be null).
nsIFrame* mFrame;
PresShell* mFramePresShell;
};
void SVGRenderingObserver::StartObserving() {
Element* target = GetReferencedElementWithoutObserving();
if (target) {
target->AddMutationObserver(this);
}
}
void SVGRenderingObserver::StopObserving() {
Element* target = GetReferencedElementWithoutObserving();
if (target) {
target->RemoveMutationObserver(this);
if (mInObserverSet) {
SVGObserverUtils::RemoveRenderingObserver(target, this);
mInObserverSet = false;
}
}
NS_ASSERTION(!mInObserverSet, "still in an observer set?");
}
Element* SVGRenderingObserver::GetAndObserveReferencedElement() {
#ifdef DEBUG
DebugObserverSet();
#endif
Element* referencedElement = GetReferencedElementWithoutObserving();
if (referencedElement && !mInObserverSet) {
SVGObserverUtils::AddRenderingObserver(referencedElement, this);
mInObserverSet = true;
}
return referencedElement;
}
nsIFrame* SVGRenderingObserver::GetAndObserveReferencedFrame() {
Element* referencedElement = GetAndObserveReferencedElement();
return referencedElement ? referencedElement->GetPrimaryFrame() : nullptr;
}
nsIFrame* SVGRenderingObserver::GetAndObserveReferencedFrame(
LayoutFrameType aFrameType, bool* aOK) {
nsIFrame* frame = GetAndObserveReferencedFrame();
if (frame) {
if (frame->Type() == aFrameType) {
return frame;
}
if (aOK) {
*aOK = false;
}
}
return nullptr;
}
void SVGRenderingObserver::OnNonDOMMutationRenderingChange() {
OnRenderingChange();
}
void SVGRenderingObserver::NotifyEvictedFromRenderingObserverSet() {
mInObserverSet = false; // We've been removed from rendering-obs. set.
StopObserving(); // Stop observing mutations too.
}
void SVGRenderingObserver::AttributeChanged(dom::Element* aElement,
int32_t aNameSpaceID,
nsAtom* aAttribute,
int32_t aModType,
const nsAttrValue* aOldValue) {
if (aElement->IsInNativeAnonymousSubtree()) {
// Don't observe attribute changes in native-anonymous subtrees like
// scrollbars.
return;
}
// An attribute belonging to the element that we are observing *or one of its
// descendants* has changed.
//
// In the case of observing a gradient element, say, we want to know if any
// of its 'stop' element children change, but we don't actually want to do
// anything for changes to SMIL element children, for example. Maybe it's not
// worth having logic to optimize for that, but in most cases it could be a
// small check?
//
// XXXjwatt: do we really want to blindly break the link between our
// observers and ourselves for all attribute changes? For non-ID changes
// surely that is unnecessary.
OnRenderingChange();
}
void SVGRenderingObserver::ContentAppended(nsIContent* aFirstNewContent) {
OnRenderingChange();
}
void SVGRenderingObserver::ContentInserted(nsIContent* aChild) {
OnRenderingChange();
}
void SVGRenderingObserver::ContentWillBeRemoved(
nsIContent* aChild, const BatchRemovalState* aState) {
if (aState && !aState->mIsFirst) {
return;
}
OnRenderingChange();
}
/**
* SVG elements reference supporting resources by element ID. We need to
* track when those resources change and when the document changes in ways
* that affect which element is referenced by a given ID (e.g., when
* element IDs change). The code here is responsible for that.
*
* When a frame references a supporting resource, we create a property
* object derived from SVGIDRenderingObserver to manage the relationship. The
* property object is attached to the referencing frame.
*/
class SVGIDRenderingObserver : public SVGRenderingObserver {
public:
// Callback for checking if the element being observed is valid for this
// observer. Note that this may be called during construction, before the
// deriving class is fully constructed.
using TargetIsValidCallback = bool (*)(const Element&);
SVGIDRenderingObserver(
SVGReference* aReference, Element* aObservingElement,
bool aReferenceImage,
uint32_t aCallbacks = kAttributeChanged | kContentAppended |
kContentInserted | kContentWillBeRemoved,
TargetIsValidCallback aTargetIsValidCallback = nullptr);
void Traverse(nsCycleCollectionTraversalCallback* aCB);
protected:
virtual ~SVGIDRenderingObserver() {
// This needs to call our GetReferencedElementWithoutObserving override,
// so must be called here rather than in our base class's dtor.
StopObserving();
}
void TargetChanged() {
mTargetIsValid = ([this] {
Element* observed = mObservedElementTracker.get();
if (!observed) {
return false;
}
// If the content is observing an ancestor, then return the target is not
// valid.
//
// TODO(emilio): Should we allow content observing its own descendants?
// That seems potentially-bad as well.
if (observed->OwnerDoc() == mObservingElement->OwnerDoc() &&
nsContentUtils::ContentIsHostIncludingDescendantOf(mObservingElement,
observed)) {
return false;
}
if (mTargetIsValidCallback) {
return mTargetIsValidCallback(*observed);
}
return true;
}());
}
Element* GetReferencedElementWithoutObserving() final {
return mTargetIsValid ? mObservedElementTracker.get() : nullptr;
}
void OnRenderingChange() override;
/**
* Helper that provides a reference to the element with the ID that our
* observer wants to observe, and that will invalidate our observer if the
* element that that ID identifies changes to a different element (or none).
*/
class ElementTracker final : public IDTracker {
public:
explicit ElementTracker(SVGIDRenderingObserver* aOwningObserver)
: mOwningObserver(aOwningObserver) {}
protected:
void ElementChanged(Element* aFrom, Element* aTo) override {
// Call OnRenderingChange() before the target changes, so that
// mIsTargetValid reflects the right state.
mOwningObserver->OnRenderingChange();
mOwningObserver->StopObserving();
IDTracker::ElementChanged(aFrom, aTo);
mOwningObserver->TargetChanged();
mOwningObserver->StartObserving();
// And same after the target changes, for the same reason.
mOwningObserver->OnRenderingChange();
}
/**
* Override IsPersistent because we want to keep tracking the element
* for the ID even when it changes.
*/
bool IsPersistent() override { return true; }
private:
SVGIDRenderingObserver* mOwningObserver;
};
ElementTracker mObservedElementTracker;
RefPtr<Element> mObservingElement;
bool mTargetIsValid = false;
TargetIsValidCallback mTargetIsValidCallback;
};
/**
* Note that in the current setup there are two separate observer lists.
*
* In SVGIDRenderingObserver's ctor, the new object adds itself to the
* mutation observer list maintained by the referenced element. In this way the
* SVGIDRenderingObserver is notified if there are any attribute or content
* tree changes to the element or any of its *descendants*.
*
* In SVGIDRenderingObserver::GetAndObserveReferencedElement() the
* SVGIDRenderingObserver object also adds itself to an
* SVGRenderingObserverSet object belonging to the referenced
* element.
*
* XXX: it would be nice to have a clear and concise executive summary of the
* benefits/necessity of maintaining a second observer list.
*/
SVGIDRenderingObserver::SVGIDRenderingObserver(
SVGReference* aReference, Element* aObservingElement, bool aReferenceImage,
uint32_t aCallbacks, TargetIsValidCallback aTargetIsValidCallback)
: SVGRenderingObserver(aCallbacks),
mObservedElementTracker(this),
mObservingElement(aObservingElement),
mTargetIsValidCallback(aTargetIsValidCallback) {
// Start watching the target element
if (aReference) {
if (aReference->IsLocalRef()) {
mObservedElementTracker.ResetToLocalFragmentID(
*aObservingElement, aReference->GetLocalRef(), aReference->GetURI(),
aReference->GetReferrerInfo(), aReferenceImage);
} else {
mObservedElementTracker.ResetToURIWithFragmentID(
*aObservingElement, aReference->GetURI(),
aReference->GetReferrerInfo(), aReferenceImage);
}
} else {
mObservedElementTracker.Unlink();
}
TargetChanged();
StartObserving();
}
void SVGIDRenderingObserver::Traverse(nsCycleCollectionTraversalCallback* aCB) {
NS_CYCLE_COLLECTION_NOTE_EDGE_NAME(*aCB, "mObservingElement");
aCB->NoteXPCOMChild(mObservingElement);
mObservedElementTracker.Traverse(aCB);
}
void SVGIDRenderingObserver::OnRenderingChange() {
if (mObservedElementTracker.get() && mInObserverSet) {
SVGObserverUtils::RemoveRenderingObserver(mObservedElementTracker.get(),
this);
mInObserverSet = false;
}
}
class SVGRenderingObserverProperty : public SVGIDRenderingObserver {
public:
NS_DECL_ISUPPORTS
SVGRenderingObserverProperty(
SVGReference* aReference, nsIFrame* aFrame, bool aReferenceImage,
uint32_t aCallbacks = kAttributeChanged | kContentAppended |
kContentInserted | kContentWillBeRemoved,
TargetIsValidCallback aTargetIsValidCallback = nullptr)
: SVGIDRenderingObserver(aReference, aFrame->GetContent()->AsElement(),
aReferenceImage, aCallbacks,
aTargetIsValidCallback),
mFrameReference(aFrame) {}
protected:
virtual ~SVGRenderingObserverProperty() = default; // non-public
void OnRenderingChange() override;
SVGFrameReferenceFromProperty mFrameReference;
};
NS_IMPL_ISUPPORTS(SVGRenderingObserverProperty, nsIMutationObserver)
void SVGRenderingObserverProperty::OnRenderingChange() {
SVGIDRenderingObserver::OnRenderingChange();
if (!mTargetIsValid) {
return;
}
nsIFrame* frame = mFrameReference.Get();
if (frame && frame->HasAllStateBits(NS_FRAME_SVG_LAYOUT)) {
// We need to notify anything that is observing the referencing frame or
// any of its ancestors that the referencing frame has been invalidated.
// Since walking the parent chain checking for observers is expensive we
// do that using a change hint (multiple change hints of the same type are
// coalesced).
nsLayoutUtils::PostRestyleEvent(frame->GetContent()->AsElement(),
RestyleHint{0},
nsChangeHint_InvalidateRenderingObservers);
}
}
static bool IsSVGGeometryElement(const Element& aObserved) {
return aObserved.IsSVGGeometryElement();
}
class SVGTextPathObserver final : public SVGRenderingObserverProperty {
public:
SVGTextPathObserver(SVGReference* aReference, nsIFrame* aFrame,
bool aReferenceImage)
: SVGRenderingObserverProperty(aReference, aFrame, aReferenceImage,
kAttributeChanged, IsSVGGeometryElement) {}
protected:
void OnRenderingChange() override;
};
void SVGTextPathObserver::OnRenderingChange() {
SVGRenderingObserverProperty::OnRenderingChange();
if (!mTargetIsValid) {
return;
}
nsIFrame* frame = mFrameReference.Get();
if (!frame) {
return;
}
MOZ_ASSERT(frame->IsSVGFrame() || frame->IsInSVGTextSubtree(),
"SVG frame expected");
MOZ_ASSERT(frame->GetContent()->IsSVGElement(nsGkAtoms::textPath),
"expected frame for a <textPath> element");
auto* text = static_cast<SVGTextFrame*>(
nsLayoutUtils::GetClosestFrameOfType(frame, LayoutFrameType::SVGText));
MOZ_ASSERT(text, "expected to find an ancestor SVGTextFrame");
if (text) {
text->AddStateBits(NS_STATE_SVG_POSITIONING_DIRTY);
if (SVGUtils::AnyOuterSVGIsCallingReflowSVG(text)) {
text->AddStateBits(NS_FRAME_IS_DIRTY | NS_FRAME_HAS_DIRTY_CHILDREN);
if (text->HasAnyStateBits(NS_FRAME_IS_NONDISPLAY)) {
text->ReflowSVGNonDisplayText();
} else {
text->ReflowSVG();
}
} else {
text->ScheduleReflowSVG();
}
}
}
class SVGMPathObserver final : public SVGIDRenderingObserver {
public:
NS_DECL_ISUPPORTS
SVGMPathObserver(SVGReference* aReference, SVGMPathElement* aElement)
: SVGIDRenderingObserver(aReference, aElement,
/* aReferenceImage = */ false, kAttributeChanged,
IsSVGGeometryElement) {}
protected:
virtual ~SVGMPathObserver() = default; // non-public
void OnRenderingChange() override;
};
NS_IMPL_ISUPPORTS(SVGMPathObserver, nsIMutationObserver)
void SVGMPathObserver::OnRenderingChange() {
SVGIDRenderingObserver::OnRenderingChange();
if (!mTargetIsValid) {
return;
}
auto* element = static_cast<SVGMPathElement*>(mObservingElement.get());
element->NotifyParentOfMpathChange();
}
class SVGMarkerObserver final : public SVGRenderingObserverProperty {
public:
SVGMarkerObserver(SVGReference* aReference, nsIFrame* aFrame,
bool aReferenceImage)
: SVGRenderingObserverProperty(aReference, aFrame, aReferenceImage,
kAttributeChanged | kContentAppended |
kContentInserted |
kContentWillBeRemoved) {}
protected:
void OnRenderingChange() override;
};
void SVGMarkerObserver::OnRenderingChange() {
SVGRenderingObserverProperty::OnRenderingChange();
nsIFrame* frame = mFrameReference.Get();
if (!frame) {
return;
}
MOZ_ASSERT(frame->IsSVGFrame(), "SVG frame expected");
// Don't need to request ReflowFrame if we're being reflowed.
// Because mRect for SVG frames includes the bounds of any markers
// (see the comment for nsIFrame::GetRect), the referencing frame must be
// reflowed for any marker changes.
if (!frame->HasAnyStateBits(NS_FRAME_IN_REFLOW)) {
// XXXjwatt: We need to unify SVG into standard reflow so we can just use
// nsChangeHint_NeedReflow | nsChangeHint_NeedDirtyReflow here.
// XXXSDL KILL THIS!!!
SVGUtils::ScheduleReflowSVG(frame);
}
frame->PresContext()->RestyleManager()->PostRestyleEvent(
frame->GetContent()->AsElement(), RestyleHint{0},
nsChangeHint_RepaintFrame);
}
class SVGPaintingProperty : public SVGRenderingObserverProperty {
public:
SVGPaintingProperty(SVGReference* aReference, nsIFrame* aFrame,
bool aReferenceImage)
: SVGRenderingObserverProperty(aReference, aFrame, aReferenceImage) {}
protected:
void OnRenderingChange() override;
};
void SVGPaintingProperty::OnRenderingChange() {
SVGRenderingObserverProperty::OnRenderingChange();
nsIFrame* frame = mFrameReference.Get();
if (!frame) {
return;
}
if (frame->HasAnyStateBits(NS_FRAME_SVG_LAYOUT)) {
frame->InvalidateFrameSubtree();
} else {
for (nsIFrame* f = frame; f;
f = nsLayoutUtils::GetNextContinuationOrIBSplitSibling(f)) {
f->InvalidateFrame();
}
}
}
// Observer for -moz-element(#element). Note that the observed element does not
// have to be an SVG element.
class SVGMozElementObserver final : public SVGPaintingProperty {
public:
SVGMozElementObserver(SVGReference* aReference, nsIFrame* aFrame)
: SVGPaintingProperty(aReference, aFrame, /* aReferenceImage = */ true) {}
// We only return true here because GetAndObserveBackgroundImage uses us
// to implement observing of arbitrary elements (including HTML elements)
// that may require us to repaint if the referenced element is reflowed.
// Bug 1496065 has been filed to remove that support though.
bool ObservesReflow() override { return true; }
};
/**
* For content with `background-clip: text`.
*
* This observer is unusual in that the observing frame and observed frame are
* the same frame. This is because the observing frame is observing for reflow
* of its descendant text nodes, since such reflows may not result in the
* frame's nsDisplayBackground changing. In other words, Display List Based
* Invalidation may not invalidate the frame's background, so we need this
* observer to make sure that happens.
*
* XXX: It's questionable whether we should even be [ab]using the SVG observer
* mechanism for `background-clip:text`. Since we know that the observed frame
* is the frame we need to invalidate, we could just check the computed style
* in the (one) place where we pass INVALIDATE_REFLOW and invalidate there...
*/
class BackgroundClipRenderingObserver : public SVGRenderingObserver {
public:
explicit BackgroundClipRenderingObserver(nsIFrame* aFrame) : mFrame(aFrame) {}
NS_DECL_ISUPPORTS
private:
// We do not call StopObserving() since the observing and observed element
// are the same element (and because we could crash - see bug 1556441).
virtual ~BackgroundClipRenderingObserver() = default;
Element* GetReferencedElementWithoutObserving() final {
return mFrame->GetContent()->AsElement();
}
void OnRenderingChange() final;
/**
* Observing for mutations is not enough. A new font loading and applying
* to the text content could cause it to reflow, and we need to invalidate
* for that.
*/
bool ObservesReflow() final { return true; }
// The observer and observee!
nsIFrame* mFrame;
};
NS_IMPL_ISUPPORTS(BackgroundClipRenderingObserver, nsIMutationObserver)
void BackgroundClipRenderingObserver::OnRenderingChange() {
for (nsIFrame* f = mFrame; f;
f = nsLayoutUtils::GetNextContinuationOrIBSplitSibling(f)) {
f->InvalidateFrame();
}
}
static bool IsSVGFilterElement(const Element& aObserved) {
return aObserved.IsSVGElement(nsGkAtoms::filter);
}
/**
* In a filter chain, there can be multiple SVG reference filters.
* e.g. filter: url(#svg-filter-1) blur(10px) url(#svg-filter-2);
*
* This class keeps track of one SVG reference filter in a filter chain.
* e.g. url(#svg-filter-1)
*
* It fires invalidations when the SVG filter element's id changes or when
* the SVG filter element's content changes.
*
* The SVGFilterObserverList class manages a list of SVGFilterObservers.
*/
class SVGFilterObserver final : public SVGIDRenderingObserver {
public:
SVGFilterObserver(SVGReference* aReference, Element* aObservingElement,
SVGFilterObserverList* aFilterChainObserver)
: SVGIDRenderingObserver(aReference, aObservingElement, false,
kAttributeChanged | kContentAppended |
kContentInserted | kContentWillBeRemoved,
IsSVGFilterElement),
mFilterObserverList(aFilterChainObserver) {}
void DetachFromChainObserver() { mFilterObserverList = nullptr; }
/**
* @return the filter frame, or null if there is no filter frame
*/
SVGFilterFrame* GetAndObserveFilterFrame();
// nsISupports
NS_DECL_CYCLE_COLLECTING_ISUPPORTS
NS_DECL_CYCLE_COLLECTION_CLASS(SVGFilterObserver)
// SVGIDRenderingObserver
void OnRenderingChange() override;
protected:
virtual ~SVGFilterObserver() = default; // non-public
SVGFilterObserverList* mFilterObserverList;
};
NS_IMPL_CYCLE_COLLECTING_ADDREF(SVGFilterObserver)
NS_IMPL_CYCLE_COLLECTING_RELEASE(SVGFilterObserver)
NS_INTERFACE_MAP_BEGIN_CYCLE_COLLECTION(SVGFilterObserver)
NS_INTERFACE_MAP_ENTRY(nsISupports)
NS_INTERFACE_MAP_ENTRY(nsIMutationObserver)
NS_INTERFACE_MAP_END
NS_IMPL_CYCLE_COLLECTION_CLASS(SVGFilterObserver)
NS_IMPL_CYCLE_COLLECTION_TRAVERSE_BEGIN(SVGFilterObserver)
NS_IMPL_CYCLE_COLLECTION_TRAVERSE(mObservedElementTracker)
NS_IMPL_CYCLE_COLLECTION_TRAVERSE(mObservingElement)
NS_IMPL_CYCLE_COLLECTION_TRAVERSE_END
NS_IMPL_CYCLE_COLLECTION_UNLINK_BEGIN(SVGFilterObserver)
tmp->StopObserving();
NS_IMPL_CYCLE_COLLECTION_UNLINK(mObservedElementTracker);
NS_IMPL_CYCLE_COLLECTION_UNLINK(mObservingElement)
NS_IMPL_CYCLE_COLLECTION_UNLINK_END
SVGFilterFrame* SVGFilterObserver::GetAndObserveFilterFrame() {
return static_cast<SVGFilterFrame*>(
GetAndObserveReferencedFrame(LayoutFrameType::SVGFilter, nullptr));
}
NS_IMPL_CYCLE_COLLECTION(ISVGFilterObserverList)
NS_IMPL_CYCLE_COLLECTING_ADDREF(ISVGFilterObserverList)
NS_IMPL_CYCLE_COLLECTING_RELEASE(ISVGFilterObserverList)
NS_INTERFACE_MAP_BEGIN_CYCLE_COLLECTION(ISVGFilterObserverList)
NS_INTERFACE_MAP_ENTRY(nsISupports)
NS_INTERFACE_MAP_END
/**
* This class manages a list of SVGFilterObservers, which correspond to
* reference to SVG filters in a list of filters in a given 'filter' property.
* e.g. filter: url(#svg-filter-1) blur(10px) url(#svg-filter-2);
*
* In the above example, the SVGFilterObserverList will manage two
* SVGFilterObservers, one for each of the references to SVG filters. CSS
* filters like "blur(10px)" don't reference filter elements, so they don't
* need an SVGFilterObserver. The style system invalidates changes to CSS
* filters.
*
* FIXME(emilio): Why do we need this as opposed to the individual observers we
* create in the constructor?
*/
class SVGFilterObserverList : public ISVGFilterObserverList {
public:
SVGFilterObserverList(Span<const StyleFilter> aFilters,
Element* aFilteredElement,
nsIFrame* aFilteredFrame = nullptr);
const nsTArray<RefPtr<SVGFilterObserver>>& GetObservers() const override {
return mObservers;
}
// nsISupports
NS_DECL_ISUPPORTS_INHERITED
NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(SVGFilterObserverList,
ISVGFilterObserverList)
virtual void OnRenderingChange(Element* aObservingElement) = 0;
protected:
virtual ~SVGFilterObserverList();
void DetachObservers() {
for (auto& observer : mObservers) {
observer->DetachFromChainObserver();
}
}
nsTArray<RefPtr<SVGFilterObserver>> mObservers;
};
void SVGFilterObserver::OnRenderingChange() {
SVGIDRenderingObserver::OnRenderingChange();
if (!mTargetIsValid) {
return;
}
if (mFilterObserverList) {
mFilterObserverList->OnRenderingChange(mObservingElement);
}
}
NS_IMPL_ADDREF_INHERITED(SVGFilterObserverList, ISVGFilterObserverList)
NS_IMPL_RELEASE_INHERITED(SVGFilterObserverList, ISVGFilterObserverList)
NS_IMPL_CYCLE_COLLECTION_CLASS(SVGFilterObserverList)
NS_IMPL_CYCLE_COLLECTION_TRAVERSE_BEGIN_INHERITED(SVGFilterObserverList,
ISVGFilterObserverList)
NS_IMPL_CYCLE_COLLECTION_TRAVERSE(mObservers)
NS_IMPL_CYCLE_COLLECTION_TRAVERSE_END
NS_IMPL_CYCLE_COLLECTION_UNLINK_BEGIN_INHERITED(SVGFilterObserverList,
ISVGFilterObserverList)
tmp->DetachObservers();
NS_IMPL_CYCLE_COLLECTION_UNLINK(mObservers)
NS_IMPL_CYCLE_COLLECTION_UNLINK_END
NS_INTERFACE_MAP_BEGIN_CYCLE_COLLECTION(SVGFilterObserverList)
NS_INTERFACE_MAP_ENTRY(ISVGFilterObserverList)
NS_INTERFACE_MAP_ENTRY(nsISupports)
NS_INTERFACE_MAP_END
SVGFilterObserverList::SVGFilterObserverList(Span<const StyleFilter> aFilters,
Element* aFilteredElement,
nsIFrame* aFilteredFrame) {
for (const auto& filter : aFilters) {
if (!filter.IsUrl()) {
continue;
}
const auto& url = filter.AsUrl();
// aFilteredFrame can be null if this filter belongs to a
// CanvasRenderingContext2D.
RefPtr<SVGReference> filterURL = ResolveURLUsingLocalRef(url);
auto observer =
MakeRefPtr<SVGFilterObserver>(filterURL, aFilteredElement, this);
mObservers.AppendElement(std::move(observer));
}
}
SVGFilterObserverList::~SVGFilterObserverList() { DetachObservers(); }
class SVGFilterObserverListForCSSProp final : public SVGFilterObserverList {
public:
SVGFilterObserverListForCSSProp(Span<const StyleFilter> aFilters,
nsIFrame* aFilteredFrame)
: SVGFilterObserverList(aFilters,
aFilteredFrame->GetContent()->AsElement(),
aFilteredFrame) {}
protected:
void OnRenderingChange(Element* aObservingElement) override;
};
void SVGFilterObserverListForCSSProp::OnRenderingChange(
Element* aObservingElement) {
nsIFrame* frame = aObservingElement->GetPrimaryFrame();
if (!frame) {
return;
}
// Repaint asynchronously in case the filter frame is being torn down
auto changeHint = nsChangeHint_RepaintFrame;
// Since we don't call SVGRenderingObserverProperty::
// OnRenderingChange, we have to add this bit ourselves.
if (frame->HasAnyStateBits(NS_FRAME_SVG_LAYOUT)) {
// Changes should propagate out to things that might be observing
// the referencing frame or its ancestors.
changeHint |= nsChangeHint_InvalidateRenderingObservers;
}
// Don't need to request UpdateOverflow if we're being reflowed.
if (!frame->HasAnyStateBits(NS_FRAME_IN_REFLOW)) {
changeHint |= nsChangeHint_UpdateOverflow;
}
frame->PresContext()->RestyleManager()->PostRestyleEvent(
aObservingElement, RestyleHint{0}, changeHint);
}
class SVGFilterObserverListForCanvasContext final
: public SVGFilterObserverList {
public:
SVGFilterObserverListForCanvasContext(CanvasRenderingContext2D* aContext,
Element* aCanvasElement,
Span<const StyleFilter> aFilters)
: SVGFilterObserverList(aFilters, aCanvasElement), mContext(aContext) {}
void OnRenderingChange(Element* aObservingElement) override;
void Detach() override { mContext = nullptr; }
private:
CanvasRenderingContext2D* mContext;
};
void SVGFilterObserverListForCanvasContext::OnRenderingChange(
Element* aObservingElement) {
if (!mContext) {
NS_WARNING(
"GFX: This should never be called without a context, except during "
"cycle collection (when Detach has been called)");
return;
}
// Refresh the cached FilterDescription in mContext->CurrentState().filter.
// If this filter is not at the top of the state stack, we'll refresh the
// wrong filter, but that's ok, because we'll refresh the right filter
// when we pop the state stack in CanvasRenderingContext2D::Restore().
//
// We don't need to flush, we're called by layout.
RefPtr<CanvasRenderingContext2D> kungFuDeathGrip(mContext);
kungFuDeathGrip->UpdateFilter(/* aFlushIfNeeded = */ false);