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
|
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim:set ts=2 sw=2 sts=2 et cindent: */
/* 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/. */
#ifndef DOM_TEXTDIRECTIVEFINDER_H_
#define DOM_TEXTDIRECTIVEFINDER_H_
#include "mozilla/RefPtr.h"
#include "mozilla/TimeStamp.h"
#include "nsTArray.h"
class nsRange;
struct TextDirective;
namespace mozilla::dom {
class Document;
/**
* @brief Finds one or more `TextDirective`s in a `Document`.
*
* This class is designed to consume the `TextDirective`s.
* Every `TextDirective` which is found is removed from the list of uninvoked
* text directives, and is returned as an `nsRange`.
*
* Internally, finding a text directive in a document uses Gecko's find-in-page
* implementation `nsFind`.
*/
class TextDirectiveFinder final {
public:
~TextDirectiveFinder();
void Traverse(nsCycleCollectionTraversalCallback& aCallback);
/**
* @brief Attempts to convert all uninvoked text directives to ranges.
*
* This method is the main entry point of this class.
*/
nsTArray<RefPtr<nsRange>> FindTextDirectivesInDocument();
/**
* Returns true if there are text directives left which were not yet found in
* the document.
*/
bool HasUninvokedDirectives() const;
/**
* Finds a range for _one_ text directive.
*/
RefPtr<nsRange> FindRangeForTextDirective(
const TextDirective& aTextDirective);
private:
friend class FragmentDirective;
TextDirectiveFinder(Document* aDocument,
nsTArray<TextDirective>&& aTextDirectives);
NotNull<RefPtr<Document>> mDocument;
nsTArray<TextDirective> mUninvokedTextDirectives;
/**
* Member variables for telemetry.
* Since measured function might called multiple times, we accumulate values
* and report them in destructor.
*/
TimeStamp::DurationType mFindTextDirectivesDuration{0};
int64_t mFoundDirectiveCount{0};
};
} // namespace mozilla::dom
inline void ImplCycleCollectionTraverse(
nsCycleCollectionTraversalCallback& aCallback,
mozilla::dom::TextDirectiveFinder& aField, const char* aName,
uint32_t aFlags = 0) {
aField.Traverse(aCallback);
}
#endif
|
