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
|
// Copyright (c) 2010 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_TRANSLATE_HELPER_H_
#define CHROME_RENDERER_TRANSLATE_HELPER_H_
#include <string>
#include "base/task.h"
#include "chrome/common/translate_errors.h"
class RenderView;
namespace WebKit {
class WebFrame;
}
// This class deals with page translation.
// There is one TranslateHelper per RenderView.
class TranslateHelper {
public:
explicit TranslateHelper(RenderView* render_view);
virtual ~TranslateHelper() {}
// Translates the page contents from |source_lang| to |target_lang|.
// Does nothing if |page_id| is not the current page id.
// If the library is not ready, it will post a task to try again after 50ms.
void TranslatePage(int page_id,
const std::string& source_lang,
const std::string& target_lang,
const std::string& translate_script);
// Reverts the page's text to its original contents.
void RevertTranslation(int page_id);
// Cancels any translation that is currently being performed. This does not
// revert existing translations.
void CancelPendingTranslation();
protected:
// The following methods are protected so they can be overridden in
// unit-tests.
// Returns true if the translate library is available, meaning the JavaScript
// has already been injected in that page.
virtual bool IsTranslateLibAvailable();
// Returns true if the translate library has been initialized successfully.
virtual bool IsTranslateLibReady();
// Returns true if the translation script has finished translating the page.
virtual bool HasTranslationFinished();
// Returns true if the translation script has reported an error performing the
// translation.
virtual bool HasTranslationFailed();
// Starts the translation by calling the translate library. This method
// should only be called when the translate script has been injected in the
// page. Returns false if the call failed immediately.
virtual bool StartTranslation();
// Asks the Translate element in the page what the language of the page is.
// Can only be called if a translation has happened and was successful.
// Returns the language code on success, an empty string on failure.
virtual std::string GetOriginalPageLanguage();
// Used in unit-tests. Makes the various tasks be posted immediately so that
// the tests don't have to wait before checking states.
virtual bool DontDelayTasks() { return false; }
private:
// Checks if the current running page translation is finished or errored and
// notifies the browser accordingly. If the translation has not terminated,
// posts a task to check again later.
void CheckTranslateStatus();
// Executes the JavaScript code in |script| in the main frame of
// |render_view_host_|.
// Returns true if the code was executed successfully.
bool ExecuteScript(const std::string& script);
// Executes the JavaScript code in |script| in the main frame of
// |render_view_host_|, and sets |value| to the boolean returned by the script
// evaluation. Returns true if the script was run successfully and returned
// a boolean, false otherwise
bool ExecuteScriptAndGetBoolResult(const std::string& script, bool* value);
// Executes the JavaScript code in |script| in the main frame of
// |render_view_host_|, and sets |value| to the string returned by the script
// evaluation. Returns true if the script was run successfully and returned
// a string, false otherwise
bool ExecuteScriptAndGetStringResult(const std::string& script,
std::string* value);
// Called by TranslatePage to do the actual translation. |count| is used to
// limit the number of retries.
void TranslatePageImpl(int count);
// Sends a message to the browser to notify it that the translation failed
// with |error|.
void NotifyBrowserTranslationFailed(TranslateErrors::Type error);
// Convenience method to access the main frame. Can return NULL, typically
// if the page is being closed.
WebKit::WebFrame* GetMainFrame();
// The RenderView we are performing translations for.
RenderView* render_view_;
// The states associated with the current translation.
bool translation_pending_;
int page_id_;
std::string source_lang_;
std::string target_lang_;
// Method factory used to make calls to TranslatePageImpl.
ScopedRunnableMethodFactory<TranslateHelper> method_factory_;
DISALLOW_COPY_AND_ASSIGN(TranslateHelper);
};
#endif // CHROME_RENDERER_TRANSLATE_HELPER_H_
|
