Reviewed by Ken.
[WebKit-https.git] / WebCore / khtml / editing / visible_range.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_RANGE_H
27 #define KHTML_EDITING_VISIBLE_RANGE_H
28
29 #include "visible_position.h"
30
31 namespace khtml {
32
33 class VisibleRange
34 {
35 public:
36     typedef DOM::NodeImpl NodeImpl;
37     typedef DOM::Position Position;
38     typedef DOM::Range Range;
39
40     VisibleRange() { }
41     VisibleRange(NodeImpl *startContainer, long startOffset, NodeImpl *endContainer, long endOffset);
42     VisibleRange(const VisiblePosition &);
43     VisibleRange(const VisiblePosition &, const VisiblePosition &);
44     VisibleRange(const Range &);
45     VisibleRange(const Position &);
46     VisibleRange(const Position &, const Position &);
47
48     VisibleRange &operator=(const VisiblePosition &);
49     VisibleRange &operator=(const Range &);
50     VisibleRange &operator=(const Position &);
51
52     VisiblePosition start() const { return m_start; }
53     VisiblePosition end() const { return m_end; }
54
55     Range range() const;
56
57     void clear() { m_start.clear(); m_end.clear(); }
58
59     bool isNull() const { return m_start.isNull(); }
60     bool isCollapsed() const { return m_start == m_end; }
61
62     friend inline bool operator==(const VisiblePosition &a, const VisiblePosition &b);
63
64 private:
65     VisiblePosition m_start;
66     VisiblePosition m_end;
67 };
68
69 inline bool operator==(const VisibleRange &a, const VisibleRange &b)
70 {
71     return a.start() == b.start() && a.end() == b.end();
72 }
73
74 inline bool operator!=(const VisibleRange &a, const VisibleRange &b)
75 {
76     return !(a == b);
77 }
78
79 } // namespace khtml
80
81 #endif