2
* Copyright (C) 2004 Apple Computer, Inc. All rights reserved.
4
* Redistribution and use in source and binary forms, with or without
5
* modification, are permitted provided that the following conditions
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.
13
* THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, 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 COMPUTER, 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.
26
#ifndef visible_units_h
27
#define visible_units_h
29
#include "EditingBehaviorTypes.h"
30
#include "EditingBoundary.h"
31
#include "TextBreakIterator.h"
32
#include "TextDirection.h"
37
class VisiblePosition;
39
enum EWordSide { RightWordIfOnBoundary = false, LeftWordIfOnBoundary = true };
42
VisiblePosition startOfWord(const VisiblePosition &, EWordSide = RightWordIfOnBoundary);
43
VisiblePosition endOfWord(const VisiblePosition &, EWordSide = RightWordIfOnBoundary);
44
VisiblePosition previousWordPosition(const VisiblePosition &);
45
VisiblePosition nextWordPosition(const VisiblePosition &);
46
VisiblePosition rightWordPosition(const VisiblePosition&, bool skipsSpaceWhenMovingRight);
47
VisiblePosition leftWordPosition(const VisiblePosition&, bool skipsSpaceWhenMovingRight);
48
bool isStartOfWord(const VisiblePosition&);
51
VisiblePosition startOfSentence(const VisiblePosition &);
52
VisiblePosition endOfSentence(const VisiblePosition &);
53
VisiblePosition previousSentencePosition(const VisiblePosition &);
54
VisiblePosition nextSentencePosition(const VisiblePosition &);
57
VisiblePosition startOfLine(const VisiblePosition &);
58
VisiblePosition endOfLine(const VisiblePosition &);
59
VisiblePosition previousLinePosition(const VisiblePosition&, int lineDirectionPoint, EditableType = ContentIsEditable);
60
VisiblePosition nextLinePosition(const VisiblePosition&, int lineDirectionPoint, EditableType = ContentIsEditable);
61
bool inSameLine(const VisiblePosition &, const VisiblePosition &);
62
bool isStartOfLine(const VisiblePosition &);
63
bool isEndOfLine(const VisiblePosition &);
64
VisiblePosition logicalStartOfLine(const VisiblePosition &);
65
VisiblePosition logicalEndOfLine(const VisiblePosition &);
66
VisiblePosition leftBoundaryOfLine(const VisiblePosition&, TextDirection);
67
VisiblePosition rightBoundaryOfLine(const VisiblePosition&, TextDirection);
69
// paragraphs (perhaps a misnomer, can be divided by line break elements)
70
VisiblePosition startOfParagraph(const VisiblePosition&, EditingBoundaryCrossingRule = CannotCrossEditingBoundary);
71
VisiblePosition endOfParagraph(const VisiblePosition&, EditingBoundaryCrossingRule = CannotCrossEditingBoundary);
72
VisiblePosition startOfNextParagraph(const VisiblePosition&);
73
VisiblePosition previousParagraphPosition(const VisiblePosition &, int x);
74
VisiblePosition nextParagraphPosition(const VisiblePosition &, int x);
75
bool isStartOfParagraph(const VisiblePosition &, EditingBoundaryCrossingRule = CannotCrossEditingBoundary);
76
bool isEndOfParagraph(const VisiblePosition &, EditingBoundaryCrossingRule = CannotCrossEditingBoundary);
77
bool inSameParagraph(const VisiblePosition &, const VisiblePosition &, EditingBoundaryCrossingRule = CannotCrossEditingBoundary);
79
// blocks (true paragraphs; line break elements don't break blocks)
80
VisiblePosition startOfBlock(const VisiblePosition &, EditingBoundaryCrossingRule = CannotCrossEditingBoundary);
81
VisiblePosition endOfBlock(const VisiblePosition &, EditingBoundaryCrossingRule = CannotCrossEditingBoundary);
82
bool inSameBlock(const VisiblePosition &, const VisiblePosition &);
83
bool isStartOfBlock(const VisiblePosition &);
84
bool isEndOfBlock(const VisiblePosition &);
87
VisiblePosition startOfDocument(const Node*);
88
VisiblePosition endOfDocument(const Node*);
89
VisiblePosition startOfDocument(const VisiblePosition &);
90
VisiblePosition endOfDocument(const VisiblePosition &);
91
bool inSameDocument(const VisiblePosition &, const VisiblePosition &);
92
bool isStartOfDocument(const VisiblePosition &);
93
bool isEndOfDocument(const VisiblePosition &);
96
VisiblePosition startOfEditableContent(const VisiblePosition&);
97
VisiblePosition endOfEditableContent(const VisiblePosition&);
98
bool isEndOfEditableOrNonEditableContent(const VisiblePosition&);
100
} // namespace WebCore
102
#endif // VisiblePosition_h