1/*
2 * Copyright (C) 2004 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. ``AS IS'' AND ANY
14 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24 */
25
26#ifndef VisibleUnits_h
27#define VisibleUnits_h
28
29#include "EditingBoundary.h"
30#include "TextDirection.h"
31#include "VisibleSelection.h"
32
33namespace WebCore {
34
35class Node;
36class VisiblePosition;
37
38enum EWordSide { RightWordIfOnBoundary = false, LeftWordIfOnBoundary = true };
39
40// words
41VisiblePosition startOfWord(const VisiblePosition &, EWordSide = RightWordIfOnBoundary);
42VisiblePosition endOfWord(const VisiblePosition &, EWordSide = RightWordIfOnBoundary);
43VisiblePosition previousWordPosition(const VisiblePosition &);
44VisiblePosition nextWordPosition(const VisiblePosition &);
45VisiblePosition rightWordPosition(const VisiblePosition&, bool skipsSpaceWhenMovingRight);
46VisiblePosition leftWordPosition(const VisiblePosition&, bool skipsSpaceWhenMovingRight);
47bool isStartOfWord(const VisiblePosition&);
48
49// sentences
50VisiblePosition startOfSentence(const VisiblePosition &);
51VisiblePosition endOfSentence(const VisiblePosition &);
52VisiblePosition previousSentencePosition(const VisiblePosition &);
53VisiblePosition nextSentencePosition(const VisiblePosition &);
54
55// lines
56VisiblePosition startOfLine(const VisiblePosition &);
57VisiblePosition endOfLine(const VisiblePosition &);
58VisiblePosition previousLinePosition(const VisiblePosition&, int lineDirectionPoint, EditableType = ContentIsEditable);
59VisiblePosition nextLinePosition(const VisiblePosition&, int lineDirectionPoint, EditableType = ContentIsEditable);
60bool inSameLine(const VisiblePosition &, const VisiblePosition &);
61bool isStartOfLine(const VisiblePosition &);
62bool isEndOfLine(const VisiblePosition &);
63VisiblePosition logicalStartOfLine(const VisiblePosition &);
64VisiblePosition logicalEndOfLine(const VisiblePosition &);
65VisiblePosition leftBoundaryOfLine(const VisiblePosition&, TextDirection);
66VisiblePosition rightBoundaryOfLine(const VisiblePosition&, TextDirection);
67
68// paragraphs (perhaps a misnomer, can be divided by line break elements)
69VisiblePosition startOfParagraph(const VisiblePosition&, EditingBoundaryCrossingRule = CannotCrossEditingBoundary);
70VisiblePosition endOfParagraph(const VisiblePosition&, EditingBoundaryCrossingRule = CannotCrossEditingBoundary);
71VisiblePosition startOfNextParagraph(const VisiblePosition&);
72VisiblePosition previousParagraphPosition(const VisiblePosition &, int x);
73VisiblePosition nextParagraphPosition(const VisiblePosition &, int x);
74bool isStartOfParagraph(const VisiblePosition &, EditingBoundaryCrossingRule = CannotCrossEditingBoundary);
75bool isEndOfParagraph(const VisiblePosition &, EditingBoundaryCrossingRule = CannotCrossEditingBoundary);
76bool inSameParagraph(const VisiblePosition &, const VisiblePosition &, EditingBoundaryCrossingRule = CannotCrossEditingBoundary);
77
78// blocks (true paragraphs; line break elements don't break blocks)
79VisiblePosition startOfBlock(const VisiblePosition &, EditingBoundaryCrossingRule = CannotCrossEditingBoundary);
80VisiblePosition endOfBlock(const VisiblePosition &, EditingBoundaryCrossingRule = CannotCrossEditingBoundary);
81bool inSameBlock(const VisiblePosition &, const VisiblePosition &);
82bool isStartOfBlock(const VisiblePosition &);
83bool isEndOfBlock(const VisiblePosition &);
84
85// document
86VisiblePosition startOfDocument(const Node*);
87VisiblePosition endOfDocument(const Node*);
88VisiblePosition startOfDocument(const VisiblePosition &);
89VisiblePosition endOfDocument(const VisiblePosition &);
90bool inSameDocument(const VisiblePosition &, const VisiblePosition &);
91bool isStartOfDocument(const VisiblePosition &);
92bool isEndOfDocument(const VisiblePosition &);
93
94// editable content
95VisiblePosition startOfEditableContent(const VisiblePosition&);
96VisiblePosition endOfEditableContent(const VisiblePosition&);
97bool isEndOfEditableOrNonEditableContent(const VisiblePosition&);
98
99#if PLATFORM(IOS)
100bool atBoundaryOfGranularity(const VisiblePosition&, TextGranularity, SelectionDirection);
101bool withinTextUnitOfGranularity(const VisiblePosition&, TextGranularity, SelectionDirection);
102VisiblePosition positionOfNextBoundaryOfGranularity(const VisiblePosition&, TextGranularity, SelectionDirection);
103PassRefPtr<Range> enclosingTextUnitOfGranularity(const VisiblePosition&, TextGranularity, SelectionDirection);
104int distanceBetweenPositions(const VisiblePosition&, const VisiblePosition&);
105PassRefPtr<Range> wordRangeFromPosition(const VisiblePosition& position);
106VisiblePosition closestWordBoundaryForPosition(const VisiblePosition& position);
107void charactersAroundPosition(const VisiblePosition&, UChar32& oneAfter, UChar32& oneBefore, UChar32& twoBefore);
108#endif
109} // namespace WebCore
110
111#endif // VisibleUnits_h
112