1/*
2 * Copyright (C) 2012 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
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'' AND ANY
14 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
15 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
16 * DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY
17 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
18 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
19 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
20 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
21 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
22 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
23 */
24
25#ifndef WebSurroundingText_h
26#define WebSurroundingText_h
27
28#include "../platform/WebPrivateOwnPtr.h"
29#include "../platform/WebString.h"
30#include "WebNode.h"
31#include "WebRange.h"
32
33namespace WebCore {
34class SurroundingText;
35}
36
37namespace blink {
38
39class WebHitTestResult;
40class WebNode;
41struct WebPoint;
42
43class WebSurroundingText {
44public:
45    WebSurroundingText() { }
46    ~WebSurroundingText() { reset(); }
47
48    BLINK_EXPORT bool isNull() const;
49    BLINK_EXPORT void reset();
50
51    // Initializes the object to get the surrounding text centered in the position relative to a provided node.
52    // The maximum length of the contents retrieved is defined by maxLength.
53    BLINK_EXPORT void initialize(const WebNode&, const WebPoint&, size_t maxLength);
54
55    // Surrounding text content retrieved.
56    BLINK_EXPORT WebString textContent() const;
57
58    // Offset in the text content of the initial hit position (or provided offset in the node).
59    BLINK_EXPORT size_t hitOffsetInTextContent() const;
60
61    // Convert start/end positions in the content text string into a WebKit text range.
62    BLINK_EXPORT WebRange rangeFromContentOffsets(size_t startOffsetInContent, size_t endOffsetInContent);
63
64protected:
65    WebPrivateOwnPtr<WebCore::SurroundingText> m_private;
66};
67
68} // namespace blink
69
70#endif
71