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