Combine event and touch action regions into a single class
[WebKit-https.git] / Source / WebCore / rendering / MarkedText.h
1 /*
2  * Copyright (C) 2017 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 <wtf/Vector.h>
29
30 namespace WebCore {
31
32 class RenderedDocumentMarker;
33
34 struct MarkedText {
35     // Sorted by paint order
36     enum Type {
37         Unmarked,
38         GrammarError,
39         Correction,
40         SpellingError,
41         TextMatch,
42         DictationAlternatives,
43 #if PLATFORM(IOS_FAMILY)
44         // FIXME: See <rdar://problem/8933352>. Also, remove the PLATFORM(IOS_FAMILY)-guard.
45         DictationPhraseWithAlternatives,
46 #endif
47         Selection,
48         DraggedContent,
49     };
50     unsigned startOffset;
51     unsigned endOffset;
52     Type type;
53     const RenderedDocumentMarker* marker { nullptr };
54
55     bool isEmpty() const { return endOffset <= startOffset; }
56     bool operator!=(const MarkedText& other) const { return !(*this == other); }
57     bool operator==(const MarkedText& other) const
58     {
59         return startOffset == other.startOffset && endOffset == other.endOffset && type == other.type && marker == other.marker;
60     }
61 };
62
63 enum class OverlapStrategy { None, Frontmost };
64 WEBCORE_EXPORT Vector<MarkedText> subdivide(const Vector<MarkedText>&, OverlapStrategy = OverlapStrategy::None);
65
66 }
67