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