51caab31ad7abade19f5efae912b851dde628958
[WebKit-https.git] / WebCore / dom / Position.h
1 /*
2  * Copyright (C) 2004, 2006 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 Position_H
27 #define Position_H
28
29 #include "Node.h"
30 #include "TextAffinity.h"
31
32 namespace WebCore {
33
34 class CSSComputedStyleDeclaration;
35 class Element;
36 class Range;
37
38 enum EUsingComposedCharacters { NotUsingComposedCharacters = false, UsingComposedCharacters = true };
39
40 class Position
41 {
42 public:
43     Position() : m_node(0), m_offset(0) { }
44     Position(Node*, int offset);
45
46     void clear();
47
48     Node *node() const { return m_node.get(); }
49     Element* documentElement() const;
50     int offset() const { return m_offset; }
51
52     bool isNull() const { return m_node == 0; }
53     bool isNotNull() const { return m_node != 0; }
54
55     Element* element() const;
56     PassRefPtr<CSSComputedStyleDeclaration> computedStyle() const;
57
58     // Move up or down the DOM by one position
59     Position previous(EUsingComposedCharacters usingComposedCharacters=NotUsingComposedCharacters) const;
60     Position next(EUsingComposedCharacters usingComposedCharacters=NotUsingComposedCharacters) const;
61     bool atStart() const;
62     bool atEnd() const;
63     
64     // FIXME: Make these non-member functions and put them somewhere in the editing directory.
65     // These aren't really basic "position" operations. More high level editing helper functions.
66     Position leadingWhitespacePosition(EAffinity, bool considerNonCollapsibleWhitespace = false) const;
67     Position trailingWhitespacePosition(EAffinity, bool considerNonCollapsibleWhitespace = false) const;
68
69     // p.upstream() through p.downstream() is the range of positions that map to the same VisiblePosition as p.
70     Position upstream() const;
71     Position downstream() const;
72     
73     Position equivalentRangeCompliantPosition() const;
74     bool inRenderedContent() const;
75     bool isRenderedCharacter() const;
76     bool rendersInDifferentPosition(const Position &pos) const;
77     
78     void debugPosition(const char* msg = "") const;
79
80 #ifndef NDEBUG
81     void formatForDebugger(char* buffer, unsigned length) const;
82     void showTreeForThis() const;
83 #endif
84     
85 private:
86     int renderedOffset() const;
87
88     bool inRenderedText() const;
89
90     Position previousCharacterPosition(EAffinity) const;
91     Position nextCharacterPosition(EAffinity) const;
92     
93     RefPtr<Node> m_node;
94     int m_offset;
95 };
96
97 inline bool operator==(const Position &a, const Position &b)
98 {
99     return a.node() == b.node() && a.offset() == b.offset();
100 }
101
102 inline bool operator!=(const Position &a, const Position &b)
103 {
104     return !(a == b);
105 }
106
107 Position startPosition(const Range*);
108 Position endPosition(const Range*);
109
110 } // namespace WebCore
111
112 #ifndef NDEBUG
113 // Outside the WebCore namespace for ease of invocation from gdb.
114 void showTree(const WebCore::Position&);
115 void showTree(const WebCore::Position*);
116 #endif
117
118 #endif // Position_H