1/*
2 * Copyright (C) 2006, 2007 Apple Inc. All rights reserved.
3 * Copyright (C) 2008 Nokia Corporation and/or its subsidiary(-ies)
4 * Copyright (C) 2010 Google Inc. All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 * 1. Redistributions of source code must retain the above copyright
10 *    notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 *    notice, this list of conditions and the following disclaimer in the
13 *    documentation and/or other materials provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
17 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
18 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
19 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
20 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
21 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
25 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 */
27
28#ifndef TextCheckerClient_h
29#define TextCheckerClient_h
30
31#include "TextChecking.h"
32
33#include <wtf/Forward.h>
34#include <wtf/Vector.h>
35#include <wtf/text/WTFString.h>
36
37namespace WebCore {
38
39class SpellChecker;
40
41struct GrammarDetail {
42    int location;
43    int length;
44    Vector<String> guesses;
45    String userDescription;
46};
47
48struct TextCheckingResult {
49    TextCheckingType type;
50    int location;
51    int length;
52    Vector<GrammarDetail> details;
53    String replacement;
54};
55
56class TextCheckerClient {
57public:
58    virtual ~TextCheckerClient() {}
59
60    virtual void ignoreWordInSpellDocument(const String&) = 0;
61    virtual void learnWord(const String&) = 0;
62    virtual void checkSpellingOfString(const UChar*, int length, int* misspellingLocation, int* misspellingLength) = 0;
63    virtual String getAutoCorrectSuggestionForMisspelledWord(const String& misspelledWord) = 0;
64    virtual void checkGrammarOfString(const UChar*, int length, Vector<GrammarDetail>&, int* badGrammarLocation, int* badGrammarLength) = 0;
65
66#if USE(UNIFIED_TEXT_CHECKING)
67    virtual void checkTextOfParagraph(const UChar* text, int length, TextCheckingTypeMask checkingTypes, Vector<TextCheckingResult>& results) = 0;
68#endif
69
70    // For spellcheckers that support multiple languages, it's often important to be able to identify the language in order to
71    // provide more accurate correction suggestions. Caller can pass in more text in "context" to aid such spellcheckers on language
72    // identification. Noramlly it's the text surrounding the "word" for which we are getting correction suggestions.
73    virtual void getGuessesForWord(const String& word, const String& context, Vector<String>& guesses) = 0;
74    virtual void requestCheckingOfString(SpellChecker*, int, TextCheckingTypeMask, const String&) = 0;
75};
76
77}
78
79#endif // TextCheckerClient_h
80