1/*
2 * Copyright (C) 2009 Google 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 are
6 * met:
7 *
8 *     * Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 *     * Redistributions in binary form must reproduce the above
11 * copyright notice, this list of conditions and the following disclaimer
12 * in the documentation and/or other materials provided with the
13 * distribution.
14 *     * Neither the name of Google Inc. nor the names of its
15 * contributors may be used to endorse or promote products derived from
16 * this software without specific prior written permission.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 */
30
31#ifndef WebRange_h
32#define WebRange_h
33
34#include "../platform/WebCommon.h"
35#include "../platform/WebVector.h"
36
37#if WEBKIT_IMPLEMENTATION
38namespace WebCore { class Range; }
39namespace WTF { template <typename T> class PassRefPtr; }
40#endif
41
42namespace WebKit {
43
44struct WebFloatQuad;
45class WebFrame;
46class WebNode;
47class WebRangePrivate;
48class WebString;
49
50// Provides readonly access to some properties of a DOM range.
51class WebRange {
52public:
53    ~WebRange() { reset(); }
54
55    WebRange() : m_private(0) { }
56    WebRange(const WebRange& r) : m_private(0) { assign(r); }
57    WebRange& operator=(const WebRange& r)
58    {
59        assign(r);
60        return *this;
61    }
62
63    WEBKIT_EXPORT void reset();
64    WEBKIT_EXPORT void assign(const WebRange&);
65
66    bool isNull() const { return !m_private; }
67
68    WEBKIT_EXPORT int startOffset() const;
69    WEBKIT_EXPORT int endOffset() const;
70    WEBKIT_EXPORT WebNode startContainer(int& exceptionCode) const;
71    WEBKIT_EXPORT WebNode endContainer(int& exceptionCode) const;
72
73    WEBKIT_EXPORT WebString toHTMLText() const;
74    WEBKIT_EXPORT WebString toPlainText() const;
75
76    WEBKIT_EXPORT WebRange expandedToParagraph() const;
77
78    WEBKIT_EXPORT static WebRange fromDocumentRange(WebFrame*, int start, int length);
79
80    WEBKIT_EXPORT WebVector<WebFloatQuad> textQuads() const;
81
82#if WEBKIT_IMPLEMENTATION
83    WebRange(const WTF::PassRefPtr<WebCore::Range>&);
84    WebRange& operator=(const WTF::PassRefPtr<WebCore::Range>&);
85    operator WTF::PassRefPtr<WebCore::Range>() const;
86#endif
87
88private:
89    void assign(WebRangePrivate*);
90    WebRangePrivate* m_private;
91};
92
93} // namespace WebKit
94
95#endif
96