File: platform_spell_checker.h

package info (click to toggle)
chromium 90.0.4430.212-1~deb10u1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 3,450,632 kB
  • sloc: cpp: 19,832,434; javascript: 2,948,838; ansic: 2,312,399; python: 1,464,622; xml: 584,121; java: 514,189; asm: 470,557; objc: 83,463; perl: 77,861; sh: 77,030; cs: 70,789; fortran: 24,137; tcl: 18,916; php: 18,872; makefile: 16,848; ruby: 16,721; pascal: 13,150; sql: 10,199; yacc: 7,507; lex: 1,313; lisp: 840; awk: 329; jsp: 39; sed: 19
file content (45 lines) | stat: -rw-r--r-- 2,096 bytes parent folder | download | duplicates (7)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
// Copyright 2020 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 COMPONENTS_SPELLCHECK_BROWSER_PLATFORM_SPELL_CHECKER_H_
#define COMPONENTS_SPELLCHECK_BROWSER_PLATFORM_SPELL_CHECKER_H_

#include "components/spellcheck/browser/spellcheck_platform.h"

// An interface that lets SpellcheckService own an instance of a platform-
// specific spell check object. Platform-specific spell check objects are
// meant to interact directly with native APIs.
//
// This is needed for platforms where platform-specific spell check objects must
// hold a state based on the user's profile, such as on Windows where
// WindowsSpellChecker holds native COM objects for each of the profile's spell
// check languages.
//
// For platforms where a per-profile, platform-specific spell check object is
// not needed, like on Mac and Android, this interface doesn't need to be
// implemented, since the native APIs will be invoked directly.
//
// In summary:
// - Each platform has its own native APIs
// - The functions inside the spellcheck_platform:: namespace are responsible
//     for knowing how to interact with the native APIs, either directly or via
//     a platform-specific spell check object
// - If a platform-specific spell check object is required, then its instance is
//     owned by SpellcheckService, and a pointer to it is passed to each
//     function of the spellcheck_platform:: namespace
// - If the platform doesn't need a per-profile, platform-specific spell check
//     object, then the pointer passed to the functions in the
//     spellcheck_platform:: namespace is null and the functions can ignore it
//     (since they use other means to invoke native APIs)
class PlatformSpellChecker {
 public:
  virtual ~PlatformSpellChecker() = default;

  virtual void RequestTextCheck(
      int document_tag,
      const base::string16& text,
      spellcheck_platform::TextCheckCompleteCallback callback) = 0;
};

#endif  // COMPONENTS_SPELLCHECK_BROWSER_PLATFORM_SPELL_CHECKER_H_