1/*
2 * Copyright (C) 2014 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 <wtf/EnumTraits.h>
30#include <wtf/RefPtr.h>
31
32namespace WebCore {
33class Frame;
34class Range;
35}
36
37namespace WebKit {
38
39enum class EditingRangeIsRelativeTo : uint8_t {
40 EditableRoot,
41 Paragraph,
42};
43
44struct EditingRange {
45 EditingRange()
46 : location(notFound)
47 , length(0)
48 {
49 }
50
51 EditingRange(uint64_t location, uint64_t length)
52 : location(location)
53 , length(length)
54 {
55 }
56
57 // (notFound, 0) is notably valid.
58 bool isValid() const { return location + length >= location; }
59
60 static RefPtr<WebCore::Range> toRange(WebCore::Frame&, const EditingRange&, EditingRangeIsRelativeTo = EditingRangeIsRelativeTo::EditableRoot);
61 static EditingRange fromRange(WebCore::Frame&, const WebCore::Range*, EditingRangeIsRelativeTo = EditingRangeIsRelativeTo::EditableRoot);
62
63#if defined(__OBJC__)
64 EditingRange(NSRange range)
65 {
66 if (range.location != NSNotFound) {
67 location = range.location;
68 length = range.length;
69 } else {
70 location = notFound;
71 length = 0;
72 }
73 }
74
75 operator NSRange() const
76 {
77 if (location == notFound)
78 return NSMakeRange(NSNotFound, 0);
79 return NSMakeRange(location, length);
80 }
81#endif
82
83 uint64_t location;
84 uint64_t length;
85};
86
87}
88
89namespace IPC {
90template<> struct ArgumentCoder<WebKit::EditingRange> {
91 static void encode(Encoder&, const WebKit::EditingRange&);
92 static Optional<WebKit::EditingRange> decode(Decoder&);
93};
94}
95
96namespace WTF {
97template<> struct EnumTraits<WebKit::EditingRangeIsRelativeTo> {
98 using values = EnumValues<WebKit::EditingRangeIsRelativeTo, WebKit::EditingRangeIsRelativeTo::EditableRoot, WebKit::EditingRangeIsRelativeTo::Paragraph>;
99};
100}
101