Reviewed by Ryosuke Niwa.
[WebKit-https.git] / Source / WebCore / dom / DocumentMarker.h
1 /*
2  * This file is part of the DOM implementation for WebCore.
3  *
4  * Copyright (C) 2006 Apple Computer, Inc.
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Library General Public
8  * License as published by the Free Software Foundation; either
9  * version 2 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Library General Public License for more details.
15  *
16  * You should have received a copy of the GNU Library General Public License
17  * along with this library; see the file COPYING.LIB.  If not, write to
18  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
19  * Boston, MA 02110-1301, USA.
20  *
21  */
22
23 #ifndef DocumentMarker_h
24 #define DocumentMarker_h
25
26 #include "PlatformString.h"
27 #include <wtf/Forward.h>
28 #include <wtf/RefCounted.h>
29 #include <wtf/RefPtr.h>
30
31
32 namespace WebCore {
33
34 class DocumentMarkerDetails;
35
36 // A range of a node within a document that is "marked", such as the range of a misspelled word.
37 // It optionally includes a description that could be displayed in the user interface.
38 // It also optionally includes a flag specifying whether the match is active, which is ignored
39 // for all types other than type TextMatch.
40 class DocumentMarker {
41 public:
42     enum MarkerType {
43         Spelling = 1 << 0,
44         Grammar = 1 << 1,
45         TextMatch = 1 << 2,
46         // Text has been modified by spell correction, reversion of spell correction or other type of substitution. 
47         // On some platforms, this prevents the text from being autocorrected again. On post Snow Leopard Mac OS X, 
48         // if a Replacement marker contains non-empty description, a reversion UI will be shown.
49         Replacement = 1 << 3,
50         // Renderer needs to add underline indicating that the text has been modified by spell
51         // correction. Text with Replacement marker doesn't necessarily has CorrectionIndicator
52         // marker. For instance, after some text has been corrected, it will have both Replacement
53         // and CorrectionIndicator. However, if user further modifies such text, we would remove
54         // CorrectionIndicator marker, but retain Replacement marker.
55         CorrectionIndicator = 1 << 4,
56         // Correction suggestion has been offered, but got rejected by user.
57         RejectedCorrection = 1 << 5,
58         // Text has been modified by autocorrection. The description of this marker is the original text before autocorrection.
59         Autocorrected = 1 << 6,
60         // On some platforms, this prevents the text from being spellchecked again.
61         SpellCheckingExemption = 1 << 7,
62         // This marker indicates user has deleted an autocorrection starting at the end of the
63         // range that bears this marker. In some platforms, if the user later inserts the same original
64         // word again at this position, it will not be autocorrected again. The description of this
65         // marker is the original word before autocorrection was applied.
66         DeletedAutocorrection = 1 << 8
67     };
68
69     class MarkerTypes {
70     public:
71         // The constructor is intentionally implicit to allow conversion from the bit-wise sum of above types
72         MarkerTypes(unsigned mask) : m_mask(mask) { }
73
74         bool contains(MarkerType type) const { return m_mask & type; }
75         bool intersects(const MarkerTypes& types) const { return (m_mask & types.m_mask); }
76         bool operator==(const MarkerTypes& other) const { return m_mask == other.m_mask; }
77
78         void add(const MarkerTypes& types) { m_mask |= types.m_mask; }
79         void remove(const MarkerTypes& types) { m_mask &= ~types.m_mask; }
80
81     private:
82         unsigned m_mask;
83     };
84
85     class AllMarkers : public MarkerTypes {
86     public:
87         AllMarkers()
88             : MarkerTypes(Spelling | Grammar | TextMatch | Replacement | CorrectionIndicator | RejectedCorrection | Autocorrected | SpellCheckingExemption | DeletedAutocorrection)
89         {
90         }
91     };
92
93     DocumentMarker();
94     DocumentMarker(MarkerType, unsigned startOffset, unsigned endOffset);
95     DocumentMarker(MarkerType, unsigned startOffset, unsigned endOffset, const String& description);
96     DocumentMarker(unsigned startOffset, unsigned endOffset, bool activeMatch);
97
98     MarkerType type() const { return m_type; }
99     unsigned startOffset() const { return m_startOffset; }
100     unsigned endOffset() const { return m_endOffset; }
101
102     const String& description() const;
103     bool activeMatch() const;
104     DocumentMarkerDetails* details() const;
105
106     void setActiveMatch(bool);
107     void clearDetails() { m_details.clear(); }
108
109     // Offset modifications are done by DocumentMarkerController.
110     // Other classes should not call following setters.
111     void setStartOffset(unsigned offset) { m_startOffset = offset; }
112     void setEndOffset(unsigned offset) { m_endOffset = offset; }
113     void shiftOffsets(int delta);
114
115     bool operator==(const DocumentMarker& o) const
116     {
117         return type() == o.type() && startOffset() == o.startOffset() && endOffset() == o.endOffset();
118     }
119
120     bool operator!=(const DocumentMarker& o) const
121     {
122         return !(*this == o);
123     }
124
125 private:
126     MarkerType m_type;
127     unsigned m_startOffset;
128     unsigned m_endOffset;
129     RefPtr<DocumentMarkerDetails> m_details;
130 };
131
132 inline DocumentMarkerDetails* DocumentMarker::details() const
133 {
134     return m_details.get();
135 }
136
137 class DocumentMarkerDetails : public RefCounted<DocumentMarkerDetails>
138 {
139 public:
140     DocumentMarkerDetails() { }
141     virtual ~DocumentMarkerDetails();
142     virtual bool isDescription() const { return false; }
143     virtual bool isTextMatch() const { return false; }
144 };
145
146 } // namespace WebCore
147
148 #endif // DocumentMarker_h