1 /* 2 * Copyright (C) 2004 Apple Computer, 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 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. 24 */ 25 26 #ifndef VisibleUnits_h 27 #define VisibleUnits_h 28 29 #include "core/editing/EditingBoundary.h" 30 #include "platform/text/TextDirection.h" 31 32 namespace WebCore { 33 34 class Node; 35 class VisiblePosition; 36 37 enum EWordSide { RightWordIfOnBoundary = false, LeftWordIfOnBoundary = true }; 38 39 // words 40 VisiblePosition startOfWord(const VisiblePosition &, EWordSide = RightWordIfOnBoundary); 41 VisiblePosition endOfWord(const VisiblePosition &, EWordSide = RightWordIfOnBoundary); 42 VisiblePosition previousWordPosition(const VisiblePosition &); 43 VisiblePosition nextWordPosition(const VisiblePosition &); 44 VisiblePosition rightWordPosition(const VisiblePosition&, bool skipsSpaceWhenMovingRight); 45 VisiblePosition leftWordPosition(const VisiblePosition&, bool skipsSpaceWhenMovingRight); 46 47 // sentences 48 VisiblePosition startOfSentence(const VisiblePosition &); 49 VisiblePosition endOfSentence(const VisiblePosition &); 50 VisiblePosition previousSentencePosition(const VisiblePosition &); 51 VisiblePosition nextSentencePosition(const VisiblePosition &); 52 53 // lines 54 VisiblePosition startOfLine(const VisiblePosition &); 55 VisiblePosition endOfLine(const VisiblePosition &); 56 VisiblePosition previousLinePosition(const VisiblePosition&, int lineDirectionPoint, EditableType = ContentIsEditable); 57 VisiblePosition nextLinePosition(const VisiblePosition&, int lineDirectionPoint, EditableType = ContentIsEditable); 58 bool inSameLine(const VisiblePosition &, const VisiblePosition &); 59 bool isStartOfLine(const VisiblePosition &); 60 bool isEndOfLine(const VisiblePosition &); 61 VisiblePosition logicalStartOfLine(const VisiblePosition &); 62 VisiblePosition logicalEndOfLine(const VisiblePosition &); 63 VisiblePosition leftBoundaryOfLine(const VisiblePosition&, TextDirection); 64 VisiblePosition rightBoundaryOfLine(const VisiblePosition&, TextDirection); 65 66 // paragraphs (perhaps a misnomer, can be divided by line break elements) 67 VisiblePosition startOfParagraph(const VisiblePosition&, EditingBoundaryCrossingRule = CannotCrossEditingBoundary); 68 VisiblePosition endOfParagraph(const VisiblePosition&, EditingBoundaryCrossingRule = CannotCrossEditingBoundary); 69 VisiblePosition startOfNextParagraph(const VisiblePosition&); 70 VisiblePosition previousParagraphPosition(const VisiblePosition &, int x); 71 VisiblePosition nextParagraphPosition(const VisiblePosition &, int x); 72 bool isStartOfParagraph(const VisiblePosition &, EditingBoundaryCrossingRule = CannotCrossEditingBoundary); 73 bool isEndOfParagraph(const VisiblePosition &, EditingBoundaryCrossingRule = CannotCrossEditingBoundary); 74 bool inSameParagraph(const VisiblePosition &, const VisiblePosition &, EditingBoundaryCrossingRule = CannotCrossEditingBoundary); 75 76 // blocks (true paragraphs; line break elements don't break blocks) 77 VisiblePosition startOfBlock(const VisiblePosition &, EditingBoundaryCrossingRule = CannotCrossEditingBoundary); 78 VisiblePosition endOfBlock(const VisiblePosition &, EditingBoundaryCrossingRule = CannotCrossEditingBoundary); 79 bool inSameBlock(const VisiblePosition &, const VisiblePosition &); 80 bool isStartOfBlock(const VisiblePosition &); 81 bool isEndOfBlock(const VisiblePosition &); 82 83 // document 84 VisiblePosition startOfDocument(const Node*); 85 VisiblePosition endOfDocument(const Node*); 86 VisiblePosition startOfDocument(const VisiblePosition &); 87 VisiblePosition endOfDocument(const VisiblePosition &); 88 bool isStartOfDocument(const VisiblePosition &); 89 bool isEndOfDocument(const VisiblePosition &); 90 91 // editable content 92 VisiblePosition startOfEditableContent(const VisiblePosition&); 93 VisiblePosition endOfEditableContent(const VisiblePosition&); 94 bool isEndOfEditableOrNonEditableContent(const VisiblePosition&); 95 96 } // namespace WebCore 97 98 #endif // VisibleUnits_h 99