Reviewed by Darin
[WebKit-https.git] / WebCore / khtml / editing / visible_position.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 KHTML_EDITING_VISIBLE_POSITION_H
27 #define KHTML_EDITING_VISIBLE_POSITION_H
28
29 #include "xml/dom_position.h"
30 #include "text_affinity.h"
31
32 namespace DOM {
33     class Range;
34     class RangeImpl;
35 }
36
37 namespace khtml {
38
39 class VisiblePosition
40 {
41 public:
42     typedef DOM::NodeImpl NodeImpl;
43     typedef DOM::Position Position;
44
45     VisiblePosition() { }
46     VisiblePosition(NodeImpl *, long offset, EAffinity affinity=DOWNSTREAM);
47     explicit VisiblePosition(const Position &, EAffinity affinity=DOWNSTREAM);
48
49     void clear() { m_deepPosition.clear(); }
50
51     bool isNull() const { return m_deepPosition.isNull(); }
52     bool isNotNull() const { return m_deepPosition.isNotNull(); }
53
54     Position position() const { return rangeCompliantEquivalent(m_deepPosition); }
55     Position deepEquivalent() const { return m_deepPosition; }
56     
57     Position upstreamDeepEquivalent() const;
58
59     friend bool operator==(const VisiblePosition &a, const VisiblePosition &b);
60
61     VisiblePosition next() const;
62     VisiblePosition previous() const;
63
64     bool isLastInBlock() const;
65
66     void debugPosition(const char *msg = "") const;
67
68 #ifndef NDEBUG
69     void formatForDebugger(char *buffer, unsigned length) const;
70 #endif
71     
72 private:
73     void initUpstream(const Position &);
74     void initDownstream(const Position &);
75
76     static Position deepEquivalent(const Position &);
77     static Position rangeCompliantEquivalent(const Position &);
78
79     static long maxOffset(const NodeImpl *);
80     static bool isAtomicNode(const NodeImpl *);
81     
82     static Position previousVisiblePosition(const Position &);
83     static Position nextVisiblePosition(const Position &);
84
85     static Position previousPosition(const Position &);
86     static Position nextPosition(const Position &);
87
88     static bool atStart(const Position &);
89     static bool atEnd(const Position &);
90
91     static bool isCandidate(const Position &);
92     
93     Position m_deepPosition;
94 };
95
96 inline bool operator==(const VisiblePosition &a, const VisiblePosition &b)
97 {
98     return a.m_deepPosition == b.m_deepPosition;
99 }
100
101 inline bool operator!=(const VisiblePosition &a, const VisiblePosition &b)
102 {
103     return !(a == b);
104 }
105
106 DOM::Range makeRange(const VisiblePosition &start, const VisiblePosition &end);
107 bool setStart(DOM::Range &, const VisiblePosition &start);
108 bool setStart(DOM::RangeImpl *, const VisiblePosition &start);
109 bool setEnd(DOM::Range &, const VisiblePosition &start);
110 bool setEnd(DOM::RangeImpl *, const VisiblePosition &start);
111 VisiblePosition startVisiblePosition(const DOM::Range &);
112 VisiblePosition startVisiblePosition(const DOM::RangeImpl *);
113 VisiblePosition endVisiblePosition(const DOM::Range &);
114 VisiblePosition endVisiblePosition(const DOM::RangeImpl *);
115
116 } // namespace khtml
117
118 #endif // KHTML_EDITING_VISIBLE_POSITION_H