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