[WIP][DO NOT LAND] Componentize spellcheck

chrome/renderer/spellchecker/spellcheck_language.h

-// Copyright (c) 2012 The Chromium Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style license that can be
-// found in the LICENSE file.
-
-#ifndef CHROME_RENDERER_SPELLCHECKER_SPELLCHECK_LANGUAGE_H_
-#define CHROME_RENDERER_SPELLCHECKER_SPELLCHECK_LANGUAGE_H_
-
-#include <memory>
-#include <queue>
-#include <string>
-#include <vector>
-
-#include "base/files/file.h"
-#include "base/macros.h"
-#include "base/strings/string16.h"
-#include "chrome/renderer/spellchecker/spellcheck_worditerator.h"
-
-class SpellingEngine;
-
-class SpellcheckLanguage {
- public:
-  enum SpellcheckWordResult {
-    // Denotes that every recognized word is spelled correctly, from the point
-    // of spellchecking to the end of the text.
-    IS_CORRECT,
-    // A sequence of skippable characters, such as punctuation, spaces, or
-    // characters not recognized by the current spellchecking language.
-    IS_SKIPPABLE,
-    // A misspelled word has been found in the text.
-    IS_MISSPELLED
-  };
-
-  SpellcheckLanguage();
-  ~SpellcheckLanguage();
-
-  void Init(base::File file, const std::string& language);
-
-  // Spellcheck a sequence of text.
-  // |text_length| is the length of the text being spellchecked. The |tag|
-  // parameter should either be a unique identifier for the document that the
-  // word came from (if the current platform requires it), or 0.
-  //
-  // - Returns IS_CORRECT if every word from |position_in_text| to the end of
-  //   the text is recognized and spelled correctly. Also, returns IS_CORRECT if
-  //   the spellchecker failed to initialize.
-  //
-  // - Returns IS_SKIPPABLE if a sequence of skippable characters, such as
-  //   punctuation, spaces, or unrecognized characters, is found.
-  //   |skip_or_misspelling_start| and |skip_or_misspelling_len| are then set to
-  //   the position and the length of the sequence of skippable characters.
-  //
-  // - Returns IS_MISSPELLED if a misspelled word is found.
-  //   |skip_or_misspelling_start| and |skip_or_misspelling_len| are then set to
-  //   the position and length of the misspelled word. In addition, finds the
-  //   suggested words for a given misspelled word and puts them into
-  //   |*optional_suggestions|. If optional_suggestions is NULL, suggested words
-  //   will not be looked up. Note that doing suggest lookups can be slow.
-  SpellcheckWordResult SpellCheckWord(
-      const base::char16* text_begin,
-      int position_in_text,
-      int text_length,
-      int tag,
-      int* skip_or_misspelling_start,
-      int* skip_or_misspelling_len,
-      std::vector<base::string16>* optional_suggestions);
-
-  // Initialize |spellcheck_| if that hasn't happened yet.
-  bool InitializeIfNeeded();
-
-  // Return true if the underlying spellcheck engine is enabled.
-  bool IsEnabled();
-
- private:
-  friend class SpellCheckTest;
-
-  // Returns whether or not the given word is a contraction of valid words
-  // (e.g. "word:word").
-  bool IsValidContraction(const base::string16& word, int tag);
-
-  // 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_;
-
-  // Pointer to a platform-specific spelling engine, if it is in use. This
-  // should only be set if hunspell is not used. (I.e. on OSX, for now)
-  std::unique_ptr<SpellingEngine> platform_spelling_engine_;
-
-  DISALLOW_COPY_AND_ASSIGN(SpellcheckLanguage);
-};
-
-#endif  // CHROME_RENDERER_SPELLCHECKER_SPELLCHECK_LANGUAGE_H_