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 blink {
34
35class SurroundingText;
36class WebHitTestResult;
37class WebNode;
38class WebRange;
39struct WebPoint;
40
41// WebSurroundingText is a Blink API that gives access to the SurroundingText
42// API. It allows caller to know the text surrounding a point or a range.
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
52    // position relative to a provided node.
53    // The maximum length of the contents retrieved is defined by maxLength.
54    BLINK_EXPORT void initialize(const WebNode&, const WebPoint&, size_t maxLength);
55
56    // Initializes the object to get the text surrounding a given range.
57    // The maximum length of the contents retrieved is defined by maxLength.
58    // It does not include the text inside the range.
59    BLINK_EXPORT void initialize(const WebRange&, size_t maxLength);
60
61    // Surrounding text content retrieved.
62    BLINK_EXPORT WebString textContent() const;
63
64    // Offset in the text content of the initial hit position (or provided
65    // offset in the node).
66    // This should only be called when WebSurroundingText has been initialized
67    // with a WebPoint.
68    // DEPRECATED: use startOffsetInTextContent() or endOffsetInTextContent().
69    BLINK_EXPORT size_t hitOffsetInTextContent() const;
70
71    // Start offset of the initial text in the text content.
72    BLINK_EXPORT size_t startOffsetInTextContent() const;
73
74    // End offset of the initial text in the text content.
75    BLINK_EXPORT size_t endOffsetInTextContent() const;
76
77    // Convert start/end positions in the content text string into a WebKit text
78    // range.
79    BLINK_EXPORT WebRange rangeFromContentOffsets(size_t startOffsetInContent, size_t endOffsetInContent);
80
81protected:
82    WebPrivateOwnPtr<SurroundingText> m_private;
83};
84
85} // namespace blink
86
87#endif
88