Return annotated text checking strings via UIWKDocumentContext
[WebKit-https.git] / Source / WebKit / WebProcess / WebPage / Cocoa / TextCheckingControllerProxy.h
1 /*
2  * Copyright (C) 2019 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #if ENABLE(PLATFORM_DRIVEN_TEXT_CHECKING)
29
30 #include "AttributedString.h"
31 #include "Connection.h"
32 #include "EditingRange.h"
33 #include "MessageReceiver.h"
34 #include <wtf/Vector.h>
35
36 namespace IPC {
37 class Decoder;
38 class Encoder;
39 }
40
41 namespace WebCore {
42 class VisiblePosition;
43 }
44
45 namespace WebKit {
46
47 class WebPage;
48
49 class TextCheckingControllerProxy : public IPC::MessageReceiver {
50 public:
51     TextCheckingControllerProxy(WebPage&);
52     ~TextCheckingControllerProxy();
53
54     AttributedString annotatedSubstringBetweenPositions(const WebCore::VisiblePosition&, const WebCore::VisiblePosition&);
55
56 private:
57     // IPC::MessageReceiver
58     void didReceiveMessage(IPC::Connection&, IPC::Decoder&) override;
59
60     struct RangeAndOffset {
61         RefPtr<WebCore::Range> range;
62         size_t locationInRoot;    
63     };
64     Optional<RangeAndOffset> rangeAndOffsetRelativeToSelection(int64_t offset, uint64_t length);
65
66     // Message handlers.
67     void replaceRelativeToSelection(AttributedString, int64_t selectionOffset, uint64_t length, bool textChanged);
68     void removeAnnotationRelativeToSelection(String annotationName, int64_t selectionOffset, uint64_t length);
69
70     WebPage& m_page;
71 };
72
73 } // namespace WebKit
74
75 #endif // ENABLE(PLATFORM_DRIVEN_TEXT_CHECKING)