116 lines
4.2 KiB
C++
116 lines
4.2 KiB
C++
// Copyright (c) 2014 GitHub, Inc.
|
|
// Use of this source code is governed by the MIT license that can be
|
|
// found in the LICENSE file.
|
|
|
|
#ifndef ELECTRON_SHELL_RENDERER_API_ELECTRON_API_SPELL_CHECK_CLIENT_H_
|
|
#define ELECTRON_SHELL_RENDERER_API_ELECTRON_API_SPELL_CHECK_CLIENT_H_
|
|
|
|
#include <memory>
|
|
#include <set>
|
|
#include <string>
|
|
#include <vector>
|
|
|
|
#include "base/callback.h"
|
|
#include "base/memory/weak_ptr.h"
|
|
#include "components/spellcheck/renderer/spellcheck_worditerator.h"
|
|
#include "third_party/blink/public/platform/web_spell_check_panel_host_client.h"
|
|
#include "third_party/blink/public/platform/web_vector.h"
|
|
#include "third_party/blink/public/web/web_text_check_client.h"
|
|
#include "v8/include/v8.h"
|
|
|
|
namespace blink {
|
|
struct WebTextCheckingResult;
|
|
class WebTextCheckingCompletion;
|
|
} // namespace blink
|
|
|
|
namespace electron {
|
|
|
|
namespace api {
|
|
|
|
class SpellCheckClient : public blink::WebSpellCheckPanelHostClient,
|
|
public blink::WebTextCheckClient,
|
|
public base::SupportsWeakPtr<SpellCheckClient> {
|
|
public:
|
|
SpellCheckClient(const std::string& language,
|
|
v8::Isolate* isolate,
|
|
v8::Local<v8::Object> provider);
|
|
~SpellCheckClient() override;
|
|
|
|
// disable copy
|
|
SpellCheckClient(const SpellCheckClient&) = delete;
|
|
SpellCheckClient& operator=(const SpellCheckClient&) = delete;
|
|
|
|
private:
|
|
class SpellcheckRequest;
|
|
// blink::WebTextCheckClient:
|
|
void RequestCheckingOfText(const blink::WebString& textToCheck,
|
|
std::unique_ptr<blink::WebTextCheckingCompletion>
|
|
completionCallback) override;
|
|
bool IsSpellCheckingEnabled() const override;
|
|
|
|
// blink::WebSpellCheckPanelHostClient:
|
|
void ShowSpellingUI(bool show) override;
|
|
bool IsShowingSpellingUI() override;
|
|
void UpdateSpellingUIWithMisspelledWord(
|
|
const blink::WebString& word) override;
|
|
|
|
struct SpellCheckScope {
|
|
v8::HandleScope handle_scope_;
|
|
v8::Context::Scope context_scope_;
|
|
v8::Local<v8::Object> provider_;
|
|
v8::Local<v8::Function> spell_check_;
|
|
|
|
explicit SpellCheckScope(const SpellCheckClient& client);
|
|
~SpellCheckScope();
|
|
};
|
|
|
|
// Run through the word iterator and send out requests
|
|
// to the JS API for checking spellings of words in the current
|
|
// request.
|
|
void SpellCheckText();
|
|
|
|
// Call JavaScript to check spelling a word.
|
|
// The javascript function will callback OnSpellCheckDone
|
|
// with the results of all the misspelled words.
|
|
void SpellCheckWords(const SpellCheckScope& scope,
|
|
const std::set<std::u16string>& words);
|
|
|
|
// Returns whether or not the given word is a contraction of valid words
|
|
// (e.g. "word:word").
|
|
// Output variable contraction_words will contain individual
|
|
// words in the contraction.
|
|
bool IsContraction(const SpellCheckScope& scope,
|
|
const std::u16string& contraction,
|
|
std::vector<std::u16string>* contraction_words);
|
|
|
|
// Callback for the JS API which returns the list of misspelled words.
|
|
void OnSpellCheckDone(const std::vector<std::u16string>& misspelled_words);
|
|
|
|
// Represents character attributes used for filtering out characters which
|
|
// are not supported by this SpellCheck object.
|
|
SpellcheckCharAttribute character_attributes_;
|
|
|
|
// Represents word iterators used in this spellchecker. The |text_iterator_|
|
|
// splits text provided by WebKit into words, contractions, or concatenated
|
|
// words. The |contraction_iterator_| splits a concatenated word extracted by
|
|
// |text_iterator_| into word components so we can treat a concatenated word
|
|
// consisting only of correct words as a correct word.
|
|
SpellcheckWordIterator text_iterator_;
|
|
SpellcheckWordIterator contraction_iterator_;
|
|
|
|
// The parameters of a pending background-spellchecking request.
|
|
// (When WebKit sends two or more requests, we cancel the previous
|
|
// requests so we do not have to use vectors.)
|
|
std::unique_ptr<SpellcheckRequest> pending_request_param_;
|
|
|
|
v8::Isolate* isolate_;
|
|
v8::Global<v8::Context> context_;
|
|
v8::Global<v8::Object> provider_;
|
|
v8::Global<v8::Function> spell_check_;
|
|
};
|
|
|
|
} // namespace api
|
|
|
|
} // namespace electron
|
|
|
|
#endif // ELECTRON_SHELL_RENDERER_API_ELECTRON_API_SPELL_CHECK_CLIENT_H_
|