1/*
2 * Copyright (C) 2010 Apple 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 INC. AND ITS CONTRIBUTORS ``AS IS''
14 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23 * THE POSSIBILITY OF SUCH DAMAGE.
24 */
25
26#pragma once
27
28#include "TextCheckerCompletion.h"
29#include <WebCore/EditorClient.h>
30#include <WebCore/TextCheckerClient.h>
31
32namespace WebKit {
33
34class WebPageProxy;
35struct TextCheckerState;
36
37using SpellDocumentTag = int64_t;
38
39class TextChecker {
40public:
41 static const TextCheckerState& state();
42 static bool isContinuousSpellCheckingAllowed();
43
44 static void setContinuousSpellCheckingEnabled(bool);
45 static void setGrammarCheckingEnabled(bool);
46
47 static void setTestingMode(bool);
48 static bool isTestingMode();
49
50#if PLATFORM(COCOA)
51 static void setAutomaticSpellingCorrectionEnabled(bool);
52 static void setAutomaticQuoteSubstitutionEnabled(bool);
53 static void setAutomaticDashSubstitutionEnabled(bool);
54 static void setAutomaticLinkDetectionEnabled(bool);
55 static void setAutomaticTextReplacementEnabled(bool);
56
57 static void didChangeAutomaticTextReplacementEnabled();
58 static void didChangeAutomaticSpellingCorrectionEnabled();
59 static void didChangeAutomaticQuoteSubstitutionEnabled();
60 static void didChangeAutomaticDashSubstitutionEnabled();
61
62 static bool isSmartInsertDeleteEnabled();
63 static void setSmartInsertDeleteEnabled(bool);
64
65 static bool substitutionsPanelIsShowing();
66 static void toggleSubstitutionsPanelIsShowing();
67#endif
68
69#if PLATFORM(GTK)
70 static void setSpellCheckingLanguages(const Vector<String>&);
71 static Vector<String> loadedSpellCheckingLanguages();
72#endif
73
74 static void continuousSpellCheckingEnabledStateChanged(bool);
75 static void grammarCheckingEnabledStateChanged(bool);
76
77 static SpellDocumentTag uniqueSpellDocumentTag(WebPageProxy*);
78 static void closeSpellDocumentWithTag(SpellDocumentTag);
79#if USE(UNIFIED_TEXT_CHECKING)
80 static Vector<WebCore::TextCheckingResult> checkTextOfParagraph(SpellDocumentTag, StringView, int32_t insertionPoint, OptionSet<WebCore::TextCheckingType>, bool initialCapitalizationEnabled);
81#endif
82 static void checkSpellingOfString(SpellDocumentTag, StringView text, int32_t& misspellingLocation, int32_t& misspellingLength);
83 static void checkGrammarOfString(SpellDocumentTag, StringView text, Vector<WebCore::GrammarDetail>&, int32_t& badGrammarLocation, int32_t& badGrammarLength);
84 static bool spellingUIIsShowing();
85 static void toggleSpellingUIIsShowing();
86 static void updateSpellingUIWithMisspelledWord(SpellDocumentTag, const String& misspelledWord);
87 static void updateSpellingUIWithGrammarString(SpellDocumentTag, const String& badGrammarPhrase, const WebCore::GrammarDetail&);
88 static void getGuessesForWord(SpellDocumentTag, const String& word, const String& context, int32_t insertionPoint, Vector<String>& guesses, bool initialCapitalizationEnabled);
89 static void learnWord(SpellDocumentTag, const String& word);
90 static void ignoreWord(SpellDocumentTag, const String& word);
91 static void requestCheckingOfString(Ref<TextCheckerCompletion>&&, int32_t insertionPoint);
92};
93
94} // namespace WebKit
95