Unreviewed, rolling out r121572.
[WebKit-https.git] / Source / WebCore / platform / text / TextChecking.h
1 /*
2  * Copyright (c) 2011 Google 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 are
6  * met:
7  * 
8  *     * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *     * Redistributions in binary form must reproduce the above
11  * copyright notice, this list of conditions and the following disclaimer
12  * in the documentation and/or other materials provided with the
13  * distribution.
14  *     * Neither the name of Google Inc. nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  * 
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #ifndef TextChecking_h
32 #define TextChecking_h
33
34 #include <wtf/RefCounted.h>
35 #include <wtf/Vector.h>
36 #include <wtf/text/WTFString.h>
37
38 namespace WebCore {
39
40 #define WTF_USE_GRAMMAR_CHECKING 1
41
42 #if PLATFORM(MAC) && !defined(BUILDING_ON_LEOPARD)
43 #define WTF_USE_UNIFIED_TEXT_CHECKING 1
44 #define WTF_USE_AUTOMATIC_TEXT_REPLACEMENT 1
45 #endif
46
47 #if PLATFORM(MAC) && !defined(BUILDING_ON_LEOPARD) && !defined(BUILDING_ON_SNOW_LEOPARD)
48 // Some platforms provide UI for suggesting autocorrection.
49 #define WTF_USE_AUTOCORRECTION_PANEL 1
50 // Some platforms use spelling and autocorrection markers to provide visual cue.
51 // On such platform, if word with marker is edited, we need to remove the marker.
52 #define WTF_USE_MARKER_REMOVAL_UPON_EDITING 1
53 #endif // #if PLATFORM(MAC) && !defined(BUILDING_ON_LEOPARD) && !defined(BUILDING_ON_SNOW_LEOPARD)
54
55 enum TextCheckingType {
56     TextCheckingTypeSpelling    = 1 << 1,
57     TextCheckingTypeGrammar     = 1 << 2,
58     TextCheckingTypeLink        = 1 << 5,
59     TextCheckingTypeQuote       = 1 << 6,
60     TextCheckingTypeDash        = 1 << 7,
61     TextCheckingTypeReplacement = 1 << 8,
62     TextCheckingTypeCorrection  = 1 << 9,
63     TextCheckingTypeShowCorrectionPanel = 1 << 10
64 };
65
66 typedef unsigned TextCheckingTypeMask;
67
68 enum TextCheckingProcessType {
69     TextCheckingProcessBatch,
70     TextCheckingProcessIncremental
71 };
72
73 struct GrammarDetail {
74     int location;
75     int length;
76     Vector<String> guesses;
77     String userDescription;
78 };
79
80 struct TextCheckingResult {
81     TextCheckingType type;
82     int location;
83     int length;
84     Vector<GrammarDetail> details;
85     String replacement;
86 };
87
88 class TextCheckingRequest : public RefCounted<TextCheckingRequest> {
89 public:
90     TextCheckingRequest(int sequence, const String& text, TextCheckingTypeMask mask, TextCheckingProcessType processType)
91         : m_sequence(sequence)
92         , m_text(text)
93         , m_mask(mask)
94         , m_processType(processType)
95     { }
96
97     virtual ~TextCheckingRequest() { }
98     virtual void didSucceed(const Vector<TextCheckingResult>&) = 0;
99     virtual void didCancel() = 0;
100
101     int sequence() const { return m_sequence; }
102     String text() const { return m_text; }
103     TextCheckingTypeMask mask() const { return m_mask; }
104     TextCheckingProcessType processType() const { return m_processType; }
105
106 protected:
107     int m_sequence;
108     String m_text;
109     TextCheckingTypeMask m_mask;
110     TextCheckingProcessType m_processType;
111 };
112
113 }
114
115 #endif // TextChecking_h