summaryrefslogtreecommitdiffstats
path: root/src/core/find_text_helper.cpp
blob: effda529f57fce18e1283efccf687eda2078a137 (plain)
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
/****************************************************************************
**
** Copyright (C) 2019 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtWebEngine module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/

#include "find_text_helper.h"
#include "qwebenginefindtextresult.h"
#include "type_conversion.h"
#include "web_contents_adapter_client.h"

#include "content/public/browser/web_contents.h"
#include "third_party/blink/public/mojom/frame/find_in_page.mojom.h"

namespace QtWebEngineCore {

// static
int FindTextHelper::m_findRequestIdCounter = -1;

FindTextHelper::FindTextHelper(content::WebContents *webContents, WebContentsAdapterClient *viewClient)
    : m_webContents(webContents)
    , m_viewClient(viewClient)
    , m_currentFindRequestId(m_findRequestIdCounter++)
    , m_lastCompletedFindRequestId(m_currentFindRequestId)
{
}

FindTextHelper::~FindTextHelper()
{
    if (isFindTextInProgress())
        stopFinding();
}

void FindTextHelper::startFinding(const QString &findText, bool caseSensitively, bool findBackward, const QWebEngineCallback<bool> resultCallback)
{
    if (findText.isEmpty()) {
        stopFinding();
        m_viewClient->findTextFinished(QWebEngineFindTextResult());
        m_widgetCallbacks.invokeEmpty(resultCallback);
        return;
    }

    startFinding(findText, caseSensitively, findBackward);
    m_widgetCallbacks.registerCallback(m_currentFindRequestId, resultCallback);
}

void FindTextHelper::startFinding(const QString &findText, bool caseSensitively, bool findBackward, const QJSValue &resultCallback)
{
    if (findText.isEmpty()) {
        stopFinding();
        m_viewClient->findTextFinished(QWebEngineFindTextResult());
        if (!resultCallback.isUndefined()) {
            QJSValueList args;
            args.append(QJSValue(0));
            const_cast<QJSValue&>(resultCallback).call(args);
        }
        return;
    }

    startFinding(findText, caseSensitively, findBackward);
    if (!resultCallback.isUndefined())
        m_quickCallbacks.insert(m_currentFindRequestId, resultCallback);
}

void FindTextHelper::startFinding(const QString &findText, bool caseSensitively, bool findBackward)
{
    if (findText.isEmpty()) {
        stopFinding();
        return;
    }

    if (m_currentFindRequestId > m_lastCompletedFindRequestId) {
        // There are cases where the render process will overwrite a previous request
        // with the new search and we'll have a dangling callback, leaving the application
        // waiting for it forever.
        // Assume that any unfinished find has been unsuccessful when a new one is started
        // to cover that case.
        m_viewClient->findTextFinished(QWebEngineFindTextResult());
        invokeResultCallback(m_currentFindRequestId, 0);
    }

    blink::mojom::FindOptionsPtr options = blink::mojom::FindOptions::New();
    options->forward = !findBackward;
    options->match_case = caseSensitively;
    options->find_next = findText == m_previousFindText;
    m_previousFindText = findText;

    m_currentFindRequestId = m_findRequestIdCounter++;
    m_webContents->Find(m_currentFindRequestId, toString16(findText), std::move(options));
}

void FindTextHelper::stopFinding()
{
    m_lastCompletedFindRequestId = m_currentFindRequestId;
    m_previousFindText = QString();
    m_webContents->StopFinding(content::STOP_FIND_ACTION_KEEP_SELECTION);
}

bool FindTextHelper::isFindTextInProgress() const
{
    return m_currentFindRequestId != m_lastCompletedFindRequestId;
}

void FindTextHelper::handleFindReply(content::WebContents *source, int requestId, int numberOfMatches,
                                     const gfx::Rect &selectionRect, int activeMatchOrdinal, bool finalUpdate)
{
    Q_UNUSED(selectionRect);

    Q_ASSERT(source == m_webContents);

    if (!finalUpdate || requestId <= m_lastCompletedFindRequestId)
        return;

    Q_ASSERT(m_currentFindRequestId == requestId);
    m_lastCompletedFindRequestId = requestId;
    m_viewClient->findTextFinished(QWebEngineFindTextResult(numberOfMatches, activeMatchOrdinal));
    invokeResultCallback(requestId, numberOfMatches);
}

void FindTextHelper::handleLoadCommitted()
{
    // Make sure that we don't set the findNext WebFindOptions on a new frame.
    m_previousFindText = QString();
}

void FindTextHelper::invokeResultCallback(int requestId, int numberOfMatches)
{
    if (m_quickCallbacks.contains(requestId)) {
        QJSValue resultCallback = m_quickCallbacks.take(requestId);
        QJSValueList args;
        args.append(QJSValue(numberOfMatches));
        resultCallback.call(args);
    } else {
        m_widgetCallbacks.invoke(requestId, numberOfMatches > 0);
    }
}

} // namespace QtWebEngineCore