feat: Spellchecker Async Implementation (#14032)
* feat:Spellchecker Async Implementation * Adhere to chromium style * Updating dependency to use gh branch * Update docs and electron-typescript-definitions module * Fix lint * Update electron typescript definitions version * Update spec * Address review
This commit is contained in:
Nitish Sakhawalkar
Charles Kerr
parent
4bbb70de74
commit
a9ca152069
9 changed files with 142 additions and 112 deletions
|
|
@ -4,7 +4,7 @@
|
|||
|
||||
#include "atom/renderer/api/atom_api_spell_check_client.h"
|
||||
|
||||
#include <algorithm>
|
||||
#include <map>
|
||||
#include <vector>
|
||||
|
||||
#include "atom/common/native_mate_converters/string16_converter.h"
|
||||
|
|
@ -13,6 +13,7 @@
|
|||
#include "chrome/renderer/spellchecker/spellcheck_worditerator.h"
|
||||
#include "native_mate/converter.h"
|
||||
#include "native_mate/dictionary.h"
|
||||
#include "native_mate/function_template.h"
|
||||
#include "third_party/blink/public/web/web_text_checking_completion.h"
|
||||
#include "third_party/blink/public/web/web_text_checking_result.h"
|
||||
#include "third_party/icu/source/common/unicode/uscript.h"
|
||||
|
|
@ -40,6 +41,10 @@ bool HasWordCharacters(const base::string16& text, int index) {
|
|||
|
||||
class SpellCheckClient::SpellcheckRequest {
|
||||
public:
|
||||
// Map of individual words to list of occurrences in text
|
||||
using WordMap =
|
||||
std::map<base::string16, std::vector<blink::WebTextCheckingResult>>;
|
||||
|
||||
SpellcheckRequest(const base::string16& text,
|
||||
blink::WebTextCheckingCompletion* completion)
|
||||
: text_(text), completion_(completion) {
|
||||
|
|
@ -47,12 +52,13 @@ class SpellCheckClient::SpellcheckRequest {
|
|||
}
|
||||
~SpellcheckRequest() {}
|
||||
|
||||
base::string16 text() { return text_; }
|
||||
const base::string16& text() const { return text_; }
|
||||
blink::WebTextCheckingCompletion* completion() { return completion_; }
|
||||
WordMap& wordmap() { return word_map_; }
|
||||
|
||||
private:
|
||||
base::string16 text_; // Text to be checked in this task.
|
||||
|
||||
WordMap word_map_; // WordMap to hold distinct words in text
|
||||
// The interface to send the misspelled ranges to WebKit.
|
||||
blink::WebTextCheckingCompletion* completion_;
|
||||
|
||||
|
|
@ -60,10 +66,10 @@ class SpellCheckClient::SpellcheckRequest {
|
|||
};
|
||||
|
||||
SpellCheckClient::SpellCheckClient(const std::string& language,
|
||||
bool auto_spell_correct_turned_on,
|
||||
v8::Isolate* isolate,
|
||||
v8::Local<v8::Object> provider)
|
||||
: isolate_(isolate),
|
||||
: pending_request_param_(nullptr),
|
||||
isolate_(isolate),
|
||||
context_(isolate, isolate->GetCurrentContext()),
|
||||
provider_(isolate, provider) {
|
||||
DCHECK(!context_.IsEmpty());
|
||||
|
|
@ -79,19 +85,6 @@ SpellCheckClient::~SpellCheckClient() {
|
|||
context_.Reset();
|
||||
}
|
||||
|
||||
void SpellCheckClient::CheckSpelling(
|
||||
const blink::WebString& text,
|
||||
int& misspelling_start,
|
||||
int& misspelling_len,
|
||||
blink::WebVector<blink::WebString>* optional_suggestions) {
|
||||
std::vector<blink::WebTextCheckingResult> results;
|
||||
SpellCheckText(text.Utf16(), true, &results);
|
||||
if (results.size() == 1) {
|
||||
misspelling_start = results[0].location;
|
||||
misspelling_len = results[0].length;
|
||||
}
|
||||
}
|
||||
|
||||
void SpellCheckClient::RequestCheckingOfText(
|
||||
const blink::WebString& textToCheck,
|
||||
blink::WebTextCheckingCompletion* completionCallback) {
|
||||
|
|
@ -103,7 +96,7 @@ void SpellCheckClient::RequestCheckingOfText(
|
|||
}
|
||||
|
||||
// Clean up the previous request before starting a new request.
|
||||
if (pending_request_param_.get()) {
|
||||
if (pending_request_param_) {
|
||||
pending_request_param_->completion()->DidCancelCheckingText();
|
||||
}
|
||||
|
||||
|
|
@ -111,8 +104,7 @@ void SpellCheckClient::RequestCheckingOfText(
|
|||
|
||||
base::ThreadTaskRunnerHandle::Get()->PostTask(
|
||||
FROM_HERE,
|
||||
base::BindOnce(&SpellCheckClient::PerformSpellCheck, AsWeakPtr(),
|
||||
base::Owned(pending_request_param_.release())));
|
||||
base::BindOnce(&SpellCheckClient::SpellCheckText, AsWeakPtr()));
|
||||
}
|
||||
|
||||
bool SpellCheckClient::IsSpellCheckingEnabled() const {
|
||||
|
|
@ -128,12 +120,13 @@ bool SpellCheckClient::IsShowingSpellingUI() {
|
|||
void SpellCheckClient::UpdateSpellingUIWithMisspelledWord(
|
||||
const blink::WebString& word) {}
|
||||
|
||||
void SpellCheckClient::SpellCheckText(
|
||||
const base::string16& text,
|
||||
bool stop_at_first_result,
|
||||
std::vector<blink::WebTextCheckingResult>* results) {
|
||||
if (text.empty() || spell_check_.IsEmpty())
|
||||
void SpellCheckClient::SpellCheckText() {
|
||||
const auto& text = pending_request_param_->text();
|
||||
if (text.empty() || spell_check_.IsEmpty()) {
|
||||
pending_request_param_->completion()->DidCancelCheckingText();
|
||||
pending_request_param_ = nullptr;
|
||||
return;
|
||||
}
|
||||
|
||||
if (!text_iterator_.IsInitialized() &&
|
||||
!text_iterator_.Initialize(&character_attributes_, true)) {
|
||||
|
|
@ -153,56 +146,87 @@ void SpellCheckClient::SpellCheckText(
|
|||
|
||||
SpellCheckScope scope(*this);
|
||||
base::string16 word;
|
||||
int word_start;
|
||||
int word_length;
|
||||
for (auto status =
|
||||
text_iterator_.GetNextWord(&word, &word_start, &word_length);
|
||||
status != SpellcheckWordIterator::IS_END_OF_TEXT;
|
||||
status = text_iterator_.GetNextWord(&word, &word_start, &word_length)) {
|
||||
std::vector<base::string16> words;
|
||||
auto& word_map = pending_request_param_->wordmap();
|
||||
blink::WebTextCheckingResult result;
|
||||
for (;;) { // Run until end of text
|
||||
const auto status =
|
||||
text_iterator_.GetNextWord(&word, &result.location, &result.length);
|
||||
if (status == SpellcheckWordIterator::IS_END_OF_TEXT)
|
||||
break;
|
||||
if (status == SpellcheckWordIterator::IS_SKIPPABLE)
|
||||
continue;
|
||||
|
||||
// Found a word (or a contraction) that the spellchecker can check the
|
||||
// spelling of.
|
||||
if (SpellCheckWord(scope, word))
|
||||
continue;
|
||||
|
||||
// If the given word is a concatenated word of two or more valid words
|
||||
// (e.g. "hello:hello"), we should treat it as a valid word.
|
||||
if (IsValidContraction(scope, word))
|
||||
continue;
|
||||
|
||||
blink::WebTextCheckingResult result;
|
||||
result.location = word_start;
|
||||
result.length = word_length;
|
||||
results->push_back(result);
|
||||
|
||||
if (stop_at_first_result)
|
||||
return;
|
||||
std::vector<base::string16> contraction_words;
|
||||
if (!IsContraction(scope, word, &contraction_words)) {
|
||||
words.push_back(word);
|
||||
word_map[word].push_back(result);
|
||||
} else {
|
||||
// For a contraction, we want check the spellings of each individual
|
||||
// part, but mark the entire word incorrect if any part is misspelled
|
||||
// Hence, we use the same word_start and word_length values for every
|
||||
// part of the contraction.
|
||||
for (const auto& w : contraction_words) {
|
||||
words.push_back(w);
|
||||
word_map[w].push_back(result);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Send out all the words data to the spellchecker to check
|
||||
SpellCheckWords(scope, words);
|
||||
}
|
||||
|
||||
bool SpellCheckClient::SpellCheckWord(
|
||||
void SpellCheckClient::OnSpellCheckDone(
|
||||
const std::vector<base::string16>& misspelled_words) {
|
||||
std::vector<blink::WebTextCheckingResult> results;
|
||||
auto* const completion_handler = pending_request_param_->completion();
|
||||
|
||||
auto& word_map = pending_request_param_->wordmap();
|
||||
|
||||
// Take each word from the list of misspelled words received, find their
|
||||
// corresponding WebTextCheckingResult that's stored in the map and pass
|
||||
// all the results to blink through the completion callback.
|
||||
for (const auto& word : misspelled_words) {
|
||||
auto iter = word_map.find(word);
|
||||
if (iter != word_map.end()) {
|
||||
// Word found in map, now gather all the occurrences of the word
|
||||
// from the map value
|
||||
auto& words = iter->second;
|
||||
results.insert(results.end(), words.begin(), words.end());
|
||||
words.clear();
|
||||
}
|
||||
}
|
||||
completion_handler->DidFinishCheckingText(results);
|
||||
pending_request_param_ = nullptr;
|
||||
}
|
||||
|
||||
void SpellCheckClient::SpellCheckWords(
|
||||
const SpellCheckScope& scope,
|
||||
const base::string16& word_to_check) const {
|
||||
const std::vector<base::string16>& words) {
|
||||
DCHECK(!scope.spell_check_.IsEmpty());
|
||||
|
||||
v8::Local<v8::Value> word = mate::ConvertToV8(isolate_, word_to_check);
|
||||
v8::Local<v8::Value> result =
|
||||
scope.spell_check_->Call(scope.provider_, 1, &word);
|
||||
v8::Local<v8::FunctionTemplate> templ = mate::CreateFunctionTemplate(
|
||||
isolate_, base::Bind(&SpellCheckClient::OnSpellCheckDone, AsWeakPtr()));
|
||||
|
||||
if (!result.IsEmpty() && result->IsBoolean())
|
||||
return result->BooleanValue();
|
||||
else
|
||||
return true;
|
||||
v8::Local<v8::Value> args[] = {mate::ConvertToV8(isolate_, words),
|
||||
templ->GetFunction()};
|
||||
// Call javascript with the words and the callback function
|
||||
scope.spell_check_->Call(scope.provider_, 2, args);
|
||||
}
|
||||
|
||||
// Returns whether or not the given string is a valid contraction.
|
||||
// Returns whether or not the given string is a contraction.
|
||||
// This function is a fall-back when the SpellcheckWordIterator class
|
||||
// returns a concatenated word which is not in the selected dictionary
|
||||
// (e.g. "in'n'out") but each word is valid.
|
||||
bool SpellCheckClient::IsValidContraction(const SpellCheckScope& scope,
|
||||
const base::string16& contraction) {
|
||||
// Output variable contraction_words will contain individual
|
||||
// words in the contraction.
|
||||
bool SpellCheckClient::IsContraction(
|
||||
const SpellCheckScope& scope,
|
||||
const base::string16& contraction,
|
||||
std::vector<base::string16>* contraction_words) {
|
||||
DCHECK(contraction_iterator_.IsInitialized());
|
||||
|
||||
contraction_iterator_.SetText(contraction.c_str(), contraction.length());
|
||||
|
|
@ -210,7 +234,6 @@ bool SpellCheckClient::IsValidContraction(const SpellCheckScope& scope,
|
|||
base::string16 word;
|
||||
int word_start;
|
||||
int word_length;
|
||||
|
||||
for (auto status =
|
||||
contraction_iterator_.GetNextWord(&word, &word_start, &word_length);
|
||||
status != SpellcheckWordIterator::IS_END_OF_TEXT;
|
||||
|
|
@ -219,18 +242,9 @@ bool SpellCheckClient::IsValidContraction(const SpellCheckScope& scope,
|
|||
if (status == SpellcheckWordIterator::IS_SKIPPABLE)
|
||||
continue;
|
||||
|
||||
if (!SpellCheckWord(scope, word))
|
||||
return false;
|
||||
contraction_words->push_back(word);
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
void SpellCheckClient::PerformSpellCheck(SpellcheckRequest* param) {
|
||||
DCHECK(param);
|
||||
|
||||
std::vector<blink::WebTextCheckingResult> results;
|
||||
SpellCheckText(param->text(), false, &results);
|
||||
param->completion()->DidFinishCheckingText(results);
|
||||
return contraction_words->size() > 1;
|
||||
}
|
||||
|
||||
SpellCheckClient::SpellCheckScope::SpellCheckScope(
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue