File: PDFDataDetectorOverlayController.h

package info (click to toggle)
webkit2gtk 2.48.5-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 429,764 kB
  • sloc: cpp: 3,697,587; javascript: 194,444; ansic: 169,997; python: 46,499; asm: 19,295; ruby: 18,528; perl: 16,602; xml: 4,650; yacc: 2,360; sh: 2,098; java: 1,993; lex: 1,327; pascal: 366; makefile: 298
file content (117 lines) | stat: -rw-r--r-- 5,345 bytes parent folder | download | duplicates (7)
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
/*
 * Copyright (C) 2024 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

#if ENABLE(UNIFIED_PDF_DATA_DETECTION)

#include "PDFDocumentLayout.h"
#include <WebCore/DataDetectorHighlight.h>
#include <WebCore/GraphicsLayer.h>
#include <WebCore/PageOverlay.h>
#include <wtf/Forward.h>
#include <wtf/HashMap.h>
#include <wtf/Noncopyable.h>
#include <wtf/OptionSet.h>
#include <wtf/TZoneMalloc.h>
#include <wtf/ThreadSafeWeakPtr.h>

namespace WebCore {
class GraphicsContext;
class GraphicsLayer;
class GraphicsLayerClient;
class IntRect;
class LocalFrame;
class PlatformMouseEvent;

enum class RenderingUpdateStep : uint32_t;
}

namespace WebKit {

class PDFDataDetectorItem;
class UnifiedPDFPlugin;
class WebMouseEvent;

class PDFDataDetectorOverlayController final : private WebCore::PageOverlayClient, WebCore::DataDetectorHighlightClient {
    WTF_MAKE_TZONE_ALLOCATED(PDFDataDetectorOverlayController);
    WTF_MAKE_NONCOPYABLE(PDFDataDetectorOverlayController);
public:
    explicit PDFDataDetectorOverlayController(UnifiedPDFPlugin&);
    virtual ~PDFDataDetectorOverlayController();
    void teardown();

    bool handleMouseEvent(const WebMouseEvent&, PDFDocumentLayout::PageIndex);
    RefPtr<WebCore::PageOverlay> protectedOverlay() const { return m_overlay; }

    enum class ShouldUpdatePlatformHighlightData : bool { No, Yes };
    enum class ActiveHighlightChanged : bool { No, Yes };
    void didInvalidateHighlightOverlayRects(std::optional<PDFDocumentLayout::PageIndex> = { }, ShouldUpdatePlatformHighlightData = ShouldUpdatePlatformHighlightData::Yes, ActiveHighlightChanged = ActiveHighlightChanged::No);
    void hideActiveHighlightOverlay();

private:
    // PageOverlayClient
    void willMoveToPage(WebCore::PageOverlay&, WebCore::Page*) final;
    void didMoveToPage(WebCore::PageOverlay&, WebCore::Page*) final { }
    void drawRect(WebCore::PageOverlay&, WebCore::GraphicsContext&, const WebCore::IntRect&) final { }
    bool mouseEvent(WebCore::PageOverlay&, const WebCore::PlatformMouseEvent&) final { return false; }
    void didScrollFrame(WebCore::PageOverlay&, WebCore::LocalFrame&) final { }

    // DataDetectorHighlightClient
    WebCore::DataDetectorHighlight* activeHighlight() const final { return m_activeDataDetectorItemWithHighlight.second.get(); }
    void scheduleRenderingUpdate(OptionSet<WebCore::RenderingUpdateStep>) final;
    float deviceScaleFactor() const final;
    RefPtr<WebCore::GraphicsLayer> createGraphicsLayer(WebCore::GraphicsLayerClient&) final;

    WebCore::PageOverlay& installOverlayIfNeeded();
    void uninstallOverlay();

    RetainPtr<DDHighlightRef> createPlatformDataDetectorHighlight(PDFDataDetectorItem&) const;
    void updatePlatformHighlightData(PDFDocumentLayout::PageIndex);
    void updateDataDetectorHighlightsIfNeeded(PDFDocumentLayout::PageIndex);

    bool handleDataDetectorAction(const WebCore::IntPoint&, PDFDataDetectorItem&);

    RefPtr<UnifiedPDFPlugin> protectedPlugin() const;

    ThreadSafeWeakPtr<UnifiedPDFPlugin> m_plugin;

    RefPtr<WebCore::PageOverlay> m_overlay;

    using PDFDataDetectorItemWithHighlight = std::pair<Ref<PDFDataDetectorItem>, Ref<WebCore::DataDetectorHighlight>>;
    using PDFDataDetectorItemWithHighlightPtr = std::pair<RefPtr<PDFDataDetectorItem>, RefPtr<WebCore::DataDetectorHighlight>>;
    using PDFDataDetectorItemsWithHighlights = Vector<PDFDataDetectorItemWithHighlight>;
    template <typename Key, typename Value>
    using HashMapWithUnsignedIntegralZeroKeyAllowed = HashMap<Key, Value, WTF::IntHash<Key>, WTF::UnsignedWithZeroKeyHashTraits<Key>>;
    using PDFDataDetectorItemsWithHighlightsMap = HashMapWithUnsignedIntegralZeroKeyAllowed<PDFDocumentLayout::PageIndex, PDFDataDetectorItemsWithHighlights>;

    PDFDataDetectorItemsWithHighlightsMap m_pdfDataDetectorItemsWithHighlightsMap;
    PDFDataDetectorItemWithHighlightPtr m_activeDataDetectorItemWithHighlight;
    PDFDataDetectorItemWithHighlightPtr m_staleDataDetectorItemWithHighlight;
};

} // namespace WebKit

#endif // ENABLE(UNIFIED_PDF_DATA_DETECTION)