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
|
/*
* Copyright (C) 2025 Apple Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
* THE POSSIBILITY OF SUCH DAMAGE.
*/
#pragma once
#include "TextExtractionURLCache.h"
#include <wtf/CompletionHandler.h>
#include <wtf/NativePromise.h>
#include <wtf/OptionSet.h>
#include <wtf/RefCounted.h>
#include <wtf/text/WTFString.h>
namespace WebCore {
namespace TextExtraction {
struct Item;
} // namespace TextExtraction
struct NodeIdentifierType;
using NodeIdentifier = ObjectIdentifier<NodeIdentifierType>;
} // namespace WebCore
namespace WebKit {
using TextExtractionVersion = unsigned;
enum class TextExtractionOptionFlag : uint8_t {
IncludeURLs = 1 << 0,
IncludeRects = 1 << 1,
OnlyIncludeText = 1 << 2,
ShortenURLs = 1 << 3,
};
enum class TextExtractionOutputFormat : uint8_t {
TextTree,
HTMLMarkup,
Markdown,
MinifiedJSON,
};
using TextExtractionOptionFlags = OptionSet<TextExtractionOptionFlag>;
using TextExtractionFilterPromise = NativePromise<String, void>;
using TextExtractionFilterCallback = Function<Ref<TextExtractionFilterPromise>(const String&, std::optional<WebCore::FrameIdentifier>&&, std::optional<WebCore::NodeIdentifier>&&)>;
struct TextExtractionOptions {
TextExtractionOptions(TextExtractionOptions&& other)
: mainFrameIdentifier(WTF::move(other.mainFrameIdentifier))
, filterCallbacks(WTF::move(other.filterCallbacks))
, nativeMenuItems(WTF::move(other.nativeMenuItems))
, replacementStrings(WTF::move(other.replacementStrings))
, version(other.version)
, flags(other.flags)
, outputFormat(other.outputFormat)
, urlCache(WTF::move(other.urlCache))
{
}
TextExtractionOptions(WebCore::FrameIdentifier&& mainFrameIdentifier, Vector<TextExtractionFilterCallback>&& filters, Vector<String>&& items, HashMap<String, String>&& replacementStrings, std::optional<TextExtractionVersion> version, TextExtractionOptionFlags flags, TextExtractionOutputFormat outputFormat, TextExtractionURLCache* urlCache = nullptr)
: mainFrameIdentifier(WTF::move(mainFrameIdentifier))
, filterCallbacks(WTF::move(filters))
, nativeMenuItems(WTF::move(items))
, replacementStrings(WTF::move(replacementStrings))
, version(version)
, flags(flags)
, outputFormat(outputFormat)
, urlCache(urlCache)
{
}
WebCore::FrameIdentifier mainFrameIdentifier;
Vector<TextExtractionFilterCallback> filterCallbacks;
Vector<String> nativeMenuItems;
HashMap<String, String> replacementStrings;
std::optional<TextExtractionVersion> version;
TextExtractionOptionFlags flags;
TextExtractionOutputFormat outputFormat { TextExtractionOutputFormat::TextTree };
RefPtr<TextExtractionURLCache> urlCache;
};
struct TextExtractionResult {
String textContent;
bool filteredOutAnyText { false };
Vector<String> shortenedURLStrings;
};
void convertToText(WebCore::TextExtraction::Item&&, TextExtractionOptions&&, CompletionHandler<void(TextExtractionResult&&)>&&);
struct FrameAndNodeIdentifiers {
std::optional<WebCore::FrameIdentifier> frameIdentifier;
WebCore::NodeIdentifier nodeIdentifier;
};
std::optional<FrameAndNodeIdentifiers> parseFrameAndNodeIdentifiers(StringView);
} // namespace WebKit
|
