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