src/third_party/WebKit/Source/core/editing/VisibleUnits.h

   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 blink {
  33
  34 class LayoutRect;
  35 class PositionWithAffinity;
  36 class RenderObject;
  37 class Node;
  38 class VisiblePosition;
  39
  40 enum EWordSide { RightWordIfOnBoundary = false, LeftWordIfOnBoundary = true };
  41
  42 // words
  43 VisiblePosition startOfWord(const VisiblePosition &, EWordSide = RightWordIfOnBoundary);
  44 VisiblePosition endOfWord(const VisiblePosition &, EWordSide = RightWordIfOnBoundary);
  45 VisiblePosition previousWordPosition(const VisiblePosition &);
  46 VisiblePosition nextWordPosition(const VisiblePosition &);
  47 VisiblePosition rightWordPosition(const VisiblePosition&, bool skipsSpaceWhenMovingRight);
  48 VisiblePosition leftWordPosition(const VisiblePosition&, bool skipsSpaceWhenMovingRight);
  49
  50 // sentences
  51 VisiblePosition startOfSentence(const VisiblePosition &);
  52 VisiblePosition endOfSentence(const VisiblePosition &);
  53 VisiblePosition previousSentencePosition(const VisiblePosition &);
  54 VisiblePosition nextSentencePosition(const VisiblePosition &);
  55
  56 // lines
  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 bool isLogicalEndOfLine(const VisiblePosition &);
  67 VisiblePosition leftBoundaryOfLine(const VisiblePosition&, TextDirection);
  68 VisiblePosition rightBoundaryOfLine(const VisiblePosition&, TextDirection);
  69
  70 // paragraphs (perhaps a misnomer, can be divided by line break elements)
  71 VisiblePosition startOfParagraph(const VisiblePosition&, EditingBoundaryCrossingRule = CannotCrossEditingBoundary);
  72 VisiblePosition endOfParagraph(const VisiblePosition&, EditingBoundaryCrossingRule = CannotCrossEditingBoundary);
  73 VisiblePosition startOfNextParagraph(const VisiblePosition&);
  74 VisiblePosition previousParagraphPosition(const VisiblePosition &, int x);
  75 VisiblePosition nextParagraphPosition(const VisiblePosition &, int x);
  76 bool isStartOfParagraph(const VisiblePosition &, EditingBoundaryCrossingRule = CannotCrossEditingBoundary);
  77 bool isEndOfParagraph(const VisiblePosition &, EditingBoundaryCrossingRule = CannotCrossEditingBoundary);
  78 bool inSameParagraph(const VisiblePosition &, const VisiblePosition &, EditingBoundaryCrossingRule = CannotCrossEditingBoundary);
  79
  80 // blocks (true paragraphs; line break elements don't break blocks)
  81 VisiblePosition startOfBlock(const VisiblePosition &, EditingBoundaryCrossingRule = CannotCrossEditingBoundary);
  82 VisiblePosition endOfBlock(const VisiblePosition &, EditingBoundaryCrossingRule = CannotCrossEditingBoundary);
  83 bool inSameBlock(const VisiblePosition &, const VisiblePosition &);
  84 bool isStartOfBlock(const VisiblePosition &);
  85 bool isEndOfBlock(const VisiblePosition &);
  86
  87 // document
  88 VisiblePosition startOfDocument(const Node*);
  89 VisiblePosition endOfDocument(const Node*);
  90 VisiblePosition startOfDocument(const VisiblePosition &);
  91 VisiblePosition endOfDocument(const VisiblePosition &);
  92 bool isStartOfDocument(const VisiblePosition &);
  93 bool isEndOfDocument(const VisiblePosition &);
  94
  95 // editable content
  96 VisiblePosition startOfEditableContent(const VisiblePosition&);
  97 VisiblePosition endOfEditableContent(const VisiblePosition&);
  98 bool isEndOfEditableOrNonEditableContent(const VisiblePosition&);
  99
 100 // Rect is local to the returned renderer
 101 LayoutRect localCaretRectOfPosition(const PositionWithAffinity&, RenderObject*&);
 102
 103 } // namespace blink
 104
 105 #endif // VisibleUnits_h