blob: 5e98d0eaa820195949c0429a320f4219b76e34c3 (
plain)
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
|
// Copyright 2014 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.
// NOT DEAD CODE!
// This code isn't dead, even if it isn't currently being used. Please refer to:
// https://www.chromium.org/developers/how-tos/compact-language-detector-cld-data-source-configuration
#ifndef COMPONENTS_TRANSLATE_CONTENT_RENDERER_RENDERER_CLD_DATA_PROVIDER_H_
#define COMPONENTS_TRANSLATE_CONTENT_RENDERER_RENDERER_CLD_DATA_PROVIDER_H_
#include "base/callback.h"
#include "base/macros.h"
#include "ipc/ipc_listener.h"
namespace IPC {
class Message;
}
namespace translate {
// Renderer-side interface responsible for providing CLD data.
// The embedder should set an instance as soon as feasible during startup.
// The implementation must be paired with a browser-side implementation of
// the BrowserCldDataProvider class, typically created by a
// BrowserCldDataProviderFactory:
// ../browser/browser_cld_data_provider_factory.h
// ../browser/browser_cld_data_provider.h
//
// The glue between the browser and renderer processes is typically a pair of
// request/response IPC messages using the CldDataProviderMsgStart
// "IPCMessageStart" enumerated constant from ipc_message_start.h.
class RendererCldDataProvider : public IPC::Listener {
public:
RendererCldDataProvider();
~RendererCldDataProvider() override {}
// (Inherited from IPC::Listener)
// If the specified message is a response for CLD data, attempts to
// initialize CLD2 and returns true in all cases. If initialization is
// successful and a callback has been configured via
// SetCldAvailableCallback(...), that callback is invoked from the message
// loop thread.
// This method is defined as virtual in order to force the implementation to
// define the specific IPC message(s) that it handles.
// The default implementation does nothing and returns false.
bool OnMessageReceived(const IPC::Message& message) override;
// Invoked by the renderer process to request that CLD data be obtained and
// that CLD be initialized with it. The implementation is expected to
// communicate with the paired BrowserCldDataProvider implementation on the
// browser side.
// This method must be invoked on the message loop thread.
// The default implementation does nothing.
virtual void SendCldDataRequest() {}
// Convenience method that tracks whether or not CLD data is available.
// This method can be used in the absence of a callback (i.e., if the caller
// wants a simple way to check the state of CLD data availability without
// keeping a separate boolean flag tripped by a callback).
// The default implementation always returns true.
virtual bool IsCldDataAvailable();
// Sets a callback that will be invoked when CLD data is successfully
// obtained from the paired BrowserCldDataProvider implementation on the
// browser side, after CLD has been successfully initialized.
// Both the initialization of CLD2 as well as the invocation of the callback
// must happen on the message loop thread.
// The default implementation immediately invokes the callback.
virtual void SetCldAvailableCallback(base::Callback<void(void)> callback);
private:
DISALLOW_COPY_AND_ASSIGN(RendererCldDataProvider);
};
} // namespace translate
#endif // COMPONENTS_TRANSLATE_CONTENT_RENDERER_RENDERER_CLD_DATAP_PROVIDER_H_
|
