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
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
|
// 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_BROWSER_SPELLCHECKER_SPELLCHECK_SERVICE_H_
#define CHROME_BROWSER_SPELLCHECKER_SPELLCHECK_SERVICE_H_
#include "base/compiler_specific.h"
#include "base/gtest_prod_util.h"
#include "base/memory/scoped_ptr.h"
#include "base/memory/weak_ptr.h"
#include "base/prefs/pref_change_registrar.h"
#include "chrome/browser/spellchecker/spellcheck_custom_dictionary.h"
#include "chrome/browser/spellchecker/spellcheck_hunspell_dictionary.h"
#include "chrome/browser/spellchecker/spelling_service_feedback.h"
#include "chrome/common/spellcheck_common.h"
#include "components/browser_context_keyed_service/browser_context_keyed_service.h"
#include "content/public/browser/notification_observer.h"
#include "content/public/browser/notification_registrar.h"
class Profile;
class SpellCheckHostMetrics;
namespace base {
class WaitableEvent;
}
namespace content {
class RenderProcessHost;
}
// Encapsulates the browser side spellcheck service. There is one of these per
// profile and each is created by the SpellCheckServiceFactory. The
// SpellcheckService maintains any per-profile information about spellcheck.
class SpellcheckService : public ProfileKeyedService,
public content::NotificationObserver,
public SpellcheckCustomDictionary::Observer,
public SpellcheckHunspellDictionary::Observer {
public:
// Event types used for reporting the status of this class and its derived
// classes to browser tests.
enum EventType {
BDICT_NOTINITIALIZED,
BDICT_CORRUPTED,
};
// Dictionary format used for loading an external dictionary.
enum DictionaryFormat {
DICT_HUNSPELL,
DICT_TEXT,
DICT_UNKNOWN,
};
explicit SpellcheckService(Profile* profile);
virtual ~SpellcheckService();
// This function computes a vector of strings which are to be displayed in
// the context menu over a text area for changing spell check languages. It
// returns the index of the current spell check language in the vector.
// TODO(port): this should take a vector of string16, but the implementation
// has some dependencies in l10n util that need porting first.
static int GetSpellCheckLanguages(Profile* profile,
std::vector<std::string>* languages);
// Computes a vector of strings which are to be displayed in the context
// menu from |accept_languages| and |dictionary_language|.
static void GetSpellCheckLanguagesFromAcceptLanguages(
const std::vector<std::string>& accept_languages,
const std::string& dictionary_language,
std::vector<std::string>* languages);
// Signals the event attached by AttachTestEvent() to report the specified
// event to browser tests. This function is called by this class and its
// derived classes to report their status. This function does not do anything
// when we do not set an event to |status_event_|.
static bool SignalStatusEvent(EventType type);
// Instantiates SpellCheckHostMetrics object and makes it ready for recording
// metrics. This should be called only if the metrics recording is active.
void StartRecordingMetrics(bool spellcheck_enabled);
// Pass the renderer some basic initialization information. Note that the
// renderer will not load Hunspell until it needs to.
void InitForRenderer(content::RenderProcessHost* process);
// Returns a metrics counter associated with this object,
// or null when metrics recording is disabled.
SpellCheckHostMetrics* GetMetrics() const;
// Returns the instance of the custom dictionary.
SpellcheckCustomDictionary* GetCustomDictionary();
// Returns the instance of the Hunspell dictionary.
SpellcheckHunspellDictionary* GetHunspellDictionary();
// Returns the instance of the spelling service feedback sender.
SpellingServiceFeedback* GetFeedbackSender();
// Load a dictionary from a given path. Format specifies how the dictionary
// is stored. Return value is true if successful.
bool LoadExternalDictionary(std::string language,
std::string locale,
std::string path,
DictionaryFormat format);
// Unload a dictionary. The path is given to identify the dictionary.
// Return value is true if successful.
bool UnloadExternalDictionary(std::string path);
// NotificationProfile implementation.
virtual void Observe(int type,
const content::NotificationSource& source,
const content::NotificationDetails& details) OVERRIDE;
// SpellcheckCustomDictionary::Observer implementation.
virtual void OnCustomDictionaryLoaded() OVERRIDE;
virtual void OnCustomDictionaryChanged(
const SpellcheckCustomDictionary::Change& dictionary_change) OVERRIDE;
// SpellcheckHunspellDictionary::Observer implementation.
virtual void OnHunspellDictionaryInitialized() OVERRIDE;
virtual void OnHunspellDictionaryDownloadBegin() OVERRIDE;
virtual void OnHunspellDictionaryDownloadSuccess() OVERRIDE;
virtual void OnHunspellDictionaryDownloadFailure() OVERRIDE;
private:
FRIEND_TEST_ALL_PREFIXES(SpellcheckServiceBrowserTest, DeleteCorruptedBDICT);
// Attaches an event so browser tests can listen the status events.
static void AttachStatusEvent(base::WaitableEvent* status_event);
// Returns the status event type.
static EventType GetStatusEvent();
// Pass all renderers some basic initialization information.
void InitForAllRenderers();
// Reacts to a change in user preferences on whether auto-spell-correct should
// be enabled.
void OnEnableAutoSpellCorrectChanged();
// Reacts to a change in user preference on which language should be used for
// spellchecking.
void OnSpellCheckDictionaryChanged();
// Notification handler for changes to prefs::kSpellCheckUseSpellingService.
void OnUseSpellingServiceChanged();
PrefChangeRegistrar pref_change_registrar_;
content::NotificationRegistrar registrar_;
// A pointer to the profile which this service refers to.
Profile* profile_;
scoped_ptr<SpellCheckHostMetrics> metrics_;
scoped_ptr<SpellcheckCustomDictionary> custom_dictionary_;
scoped_ptr<SpellcheckHunspellDictionary> hunspell_dictionary_;
SpellingServiceFeedback feedback_sender_;
base::WeakPtrFactory<SpellcheckService> weak_ptr_factory_;
DISALLOW_COPY_AND_ASSIGN(SpellcheckService);
};
#endif // CHROME_BROWSER_SPELLCHECKER_SPELLCHECK_SERVICE_H_
|
