Use "= default" to denote default constructor or destructor
[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 enum TextCheckingType {
41     TextCheckingTypeNone        = 0,
42     TextCheckingTypeSpelling    = 1 << 1,
43     TextCheckingTypeGrammar     = 1 << 2,
44     TextCheckingTypeLink        = 1 << 5,
45     TextCheckingTypeQuote       = 1 << 6,
46     TextCheckingTypeDash        = 1 << 7,
47     TextCheckingTypeReplacement = 1 << 8,
48     TextCheckingTypeCorrection  = 1 << 9,
49     TextCheckingTypeShowCorrectionPanel = 1 << 10
50 };
51
52 typedef unsigned TextCheckingTypeMask;
53
54 enum TextCheckingProcessType {
55     TextCheckingProcessBatch,
56     TextCheckingProcessIncremental
57 };
58
59 struct GrammarDetail {
60     int location;
61     int length;
62     Vector<String> guesses;
63     String userDescription;
64 };
65
66 struct TextCheckingResult {
67     TextCheckingType type;
68     int location;
69     int length;
70     Vector<GrammarDetail> details;
71     String replacement;
72 };
73
74 const int unrequestedTextCheckingSequence = -1;
75
76 class TextCheckingRequestData {
77     friend class SpellCheckRequest; // For access to m_sequence.
78 public:
79     TextCheckingRequestData()
80         : m_sequence(unrequestedTextCheckingSequence)
81         , m_mask(TextCheckingTypeNone)
82         , m_processType(TextCheckingProcessIncremental)
83     { }
84     TextCheckingRequestData(int sequence, const String& text, TextCheckingTypeMask mask, TextCheckingProcessType processType)
85         : m_sequence(sequence)
86         , m_text(text)
87         , m_mask(mask)
88         , m_processType(processType)
89     { }
90
91     int sequence() const { return m_sequence; }
92     String text() const { return m_text; }
93     TextCheckingTypeMask mask() const { return m_mask; }
94     TextCheckingProcessType processType() const { return m_processType; }
95
96 private:
97     int m_sequence;
98     String m_text;
99     TextCheckingTypeMask m_mask;
100     TextCheckingProcessType m_processType;
101 };
102
103 class TextCheckingRequest : public RefCounted<TextCheckingRequest> {
104 public:
105     virtual ~TextCheckingRequest() = default;
106
107     virtual const TextCheckingRequestData& data() const = 0;
108     virtual void didSucceed(const Vector<TextCheckingResult>&) = 0;
109     virtual void didCancel() = 0;
110 };
111
112 }
113
114 #endif // TextChecking_h