Reviewed by Ken.
[WebKit-https.git] / WebCore / khtml / editing / selection.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_SELECTION_H
27 #define KHTML_EDITING_SELECTION_H
28
29 #include <qrect.h>
30 #include "xml/dom_position.h"
31 #include "text_granularity.h"
32
33 class KHTMLPart;
34 class QPainter;
35
36 namespace khtml {
37
38 class RenderObject;
39 class VisiblePosition;
40
41 class Selection
42 {
43 public:
44     enum EState { NONE, CARET, RANGE };
45     enum EAlter { MOVE, EXTEND };
46     enum EDirection { FORWARD, BACKWARD, RIGHT, LEFT };
47
48     typedef DOM::EAffinity EAffinity;
49     typedef DOM::Range Range;
50     typedef DOM::Position Position;
51
52     Selection();
53     Selection(const Range &);
54     Selection(const VisiblePosition &);
55     Selection(const VisiblePosition &, const VisiblePosition &);
56     Selection(const Position &);
57     Selection(const Position &, const Position &);
58     Selection(const Selection &);
59
60     Selection &operator=(const Selection &o);
61     Selection &operator=(const Range &r) { moveTo(r); return *this; }
62     Selection &operator=(const VisiblePosition &r) { moveTo(r); return *this; }
63     Selection &operator=(const Position &r) { moveTo(r); return *this; }
64     
65     void moveTo(const Range &);
66     void moveTo(const VisiblePosition &);
67     void moveTo(const VisiblePosition &, const VisiblePosition &);
68     void moveTo(const Position &);
69     void moveTo(const Position &, const Position &);
70     void moveTo(const Selection &);
71
72     EState state() const { return m_state; }
73     EAffinity affinity() const { return m_affinity; }
74     void setAffinity(EAffinity);
75
76     bool modify(EAlter, EDirection, ETextGranularity);
77     bool modify(EAlter, int verticalDistance);
78     bool expandUsingGranularity(ETextGranularity);
79     void clear();
80
81     void setBase(const VisiblePosition &);
82     void setExtent(const VisiblePosition &);
83     void setBaseAndExtent(const VisiblePosition &base, const VisiblePosition &extent);
84
85     void setBase(const Position &pos);
86     void setExtent(const Position &pos);
87     void setBaseAndExtent(const Position &base, const Position &extent);
88
89     Position base() const { return m_base; }
90     Position extent() const { return m_extent; }
91     Position start() const { return m_start; }
92     Position end() const { return m_end; }
93
94     QRect caretRect() const;
95     void setNeedsLayout(bool flag = true);
96
97     void clearModifyBias() { m_modifyBiasSet = false; }
98     void setModifyBias(EAlter, EDirection);
99     
100     bool isNone() const { return state() == NONE; }
101     bool isCaret() const { return state() == CARET; }
102     bool isRange() const { return state() == RANGE; }
103     bool isCaretOrRange() const { return state() != NONE; }
104
105     Range toRange() const;
106
107     void debugPosition() const;
108     void debugRenderer(khtml::RenderObject *r, bool selected) const;
109
110     friend class KHTMLPart;
111
112 #ifndef NDEBUG
113     void formatForDebugger(char *buffer, unsigned length) const;
114 #endif
115
116 private:
117     enum EPositionType { START, END, BASE, EXTENT };
118
119     void init();
120     void validate(ETextGranularity granularity = CHARACTER);
121
122     VisiblePosition modifyExtendingRightForward(ETextGranularity);
123     VisiblePosition modifyMovingRightForward(ETextGranularity);
124     VisiblePosition modifyExtendingLeftBackward(ETextGranularity);
125     VisiblePosition modifyMovingLeftBackward(ETextGranularity);
126
127     void layoutCaret();
128     void needsCaretRepaint();
129     void paintCaret(QPainter *p, const QRect &rect);
130     QRect caretRepaintRect() const;
131
132     int xPosForVerticalArrowNavigation(EPositionType, bool recalc = false) const;
133
134     Position m_base;              // base position for the selection
135     Position m_extent;            // extent position for the selection
136     Position m_start;             // start position for the selection
137     Position m_end;               // end position for the selection
138
139     EState m_state;               // the state of the selection
140     EAffinity m_affinity;         // the upstream/downstream affinity of the selection
141
142     QRect m_caretRect;            // caret coordinates, size, and position
143     
144     bool m_baseIsStart : 1;       // true if base node is before the extent node
145     bool m_needsCaretLayout : 1;  // true if the caret position needs to be calculated
146     bool m_modifyBiasSet : 1;     // true if the selection has been horizontally 
147                                   // modified with EAlter::EXTEND
148 };
149
150 inline bool operator==(const Selection &a, const Selection &b)
151 {
152     return a.start() == b.start() && a.end() == b.end();
153 }
154
155 inline bool operator!=(const Selection &a, const Selection &b)
156 {
157     return !(a == b);
158 }
159
160 } // namespace khtml
161
162 #endif // KHTML_EDITING_SELECTION_H