Add SPI to retrieve the set of text inputs in a given rect, and later focus one
[WebKit-https.git] / Source / WebKit / Shared / TextInputContext.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 #include "ArgumentCoders.h"
29 #include <WebCore/DocumentIdentifier.h>
30 #include <WebCore/ElementIdentifier.h>
31 #include <WebCore/FloatRect.h>
32
33 namespace WebKit {
34
35 struct TextInputContext {
36     WebCore::FloatRect boundingRect;
37
38     uint64_t webPageIdentifier;
39     WebCore::DocumentIdentifier documentIdentifier;
40     WebCore::ElementIdentifier elementIdentifier;
41
42     ~TextInputContext();
43 };
44
45 inline bool operator==(const TextInputContext& a, const TextInputContext& b)
46 {
47     return a.boundingRect == b.boundingRect
48         && a.webPageIdentifier == b.webPageIdentifier
49         && a.documentIdentifier == b.documentIdentifier
50         && a.elementIdentifier == b.elementIdentifier;
51 }
52
53 }
54
55 namespace IPC {
56 template<> struct ArgumentCoder<WebKit::TextInputContext> {
57     static void encode(Encoder&, const WebKit::TextInputContext&);
58     static Optional<WebKit::TextInputContext> decode(Decoder&);
59 };
60 }