Modularize Compact Language Detector 2 (CLD2) data sources

chrome/renderer/translate/translate_helper.h

 // Copyright (c) 2011 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_TRANSLATE_HELPER_H_
 #define CHROME_RENDERER_TRANSLATE_TRANSLATE_HELPER_H_
 
 #include <string>
 
 #include "base/gtest_prod_util.h"
+#include "base/memory/scoped_ptr.h"
 #include "base/memory/weak_ptr.h"
 #include "base/strings/string16.h"
 #include "base/time/time.h"
+#include "components/translate/content/renderer/renderer_cld_data_provider.h"
 #include "components/translate/core/common/translate_errors.h"
 #include "content/public/renderer/render_view_observer.h"
-
-#if defined(CLD2_DYNAMIC_MODE)
-#include "base/files/file.h"
-#include "base/files/memory_mapped_file.h"
-#include "base/lazy_instance.h"
-#include "ipc/ipc_platform_file.h"
 #include "url/gurl.h"
-#endif
 
 namespace blink {
 class WebDocument;
 class WebFrame;
 }
 
+namespace content {
+class RendererCldDataProvider;
+}
+
 // This class deals with page translation.
 // There is one TranslateHelper per RenderView.
 
 class TranslateHelper : public content::RenderViewObserver {
  public:
   explicit TranslateHelper(content::RenderView* render_view);
   virtual ~TranslateHelper();
 
   // Informs us that the page's text has been extracted.
   void PageCaptured(int page_id, const base::string16& contents);
@@ skipping 115 matching lines @@
   std::string source_lang_;
   std::string target_lang_;
 
   // Time when a page langauge is determined. This is used to know a duration
   // time from showing infobar to requesting translation.
   base::TimeTicks language_determined_time_;
 
   // Method factory used to make calls to TranslatePageImpl.
   base::WeakPtrFactory<TranslateHelper> weak_method_factory_;
 
-#if defined(CLD2_DYNAMIC_MODE)
   // Do not ask for CLD data any more.

[Takashi Toyoshima, 2014/06/23 08:50:01]

Now that following methods and members are free from the ifdef block, we may
want to follow the C++ style guide. It means that methods would be better to be
defined before variables.

http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml#Declaration_Order

[Andrew Hayden (chromium.org), 2014/06/23 13:20:36]

Yes, good catch. Done. Die, ifdefs, die!

-  void CancelCLD2DataFilePolling();
+  void CancelCldDataPolling();
 
   // Invoked when PageCaptured is called prior to obtaining CLD data. This
   // method stores the page ID into deferred_page_id_ and COPIES the contents
   // of the page, then sets deferred_page_capture_ to true. When CLD data is
-  // eventually received (in OnCLDDataAvailable), any deferred request will be
+  // eventually received (in OnCldDataAvailable), any deferred request will be
   // "resurrected" and allowed to proceed automatically, assuming that the
   // page ID has not changed.
   void DeferPageCaptured(const int page_id, const base::string16& contents);
 
-  // Immediately send an IPC request to the browser process to get the CLD
-  // data file. In most cases, the file will already exist and we will only
-  // poll once; but since the file might need to be downloaded first, poll
-  // indefinitely until a ChromeViewMsg_CLDDataAvailable message is received
-  // from the browser process.
+  // Start polling for CLD data.
   // Polling will automatically halt as soon as the renderer obtains a
   // reference to the data file.
-  void SendCLD2DataFileRequest(const int delay_millis,
-                               const int next_delay_millis);
+  void SendCldDataRequest(const int delay_millis,
+                          const int next_delay_millis);
 
-  // Invoked when a ChromeViewMsg_CLDDataAvailable message is received from
-  // the browser process, providing a file handle for the CLD data file. If a
-  // PageCaptured request was previously deferred with DeferPageCaptured and
-  // the page ID has not yet changed, the PageCaptured is reinvoked to
-  // "resurrect" the language detection pathway.
-  void OnCLDDataAvailable(const IPC::PlatformFileForTransit ipc_file_handle,
-                          const uint64 data_offset,
-                          const uint64 data_length);
+  // Callback triggered when CLD data becomes available.
+  void OnCldDataAvailable();
 
-  // After receiving data in OnCLDDataAvailable, loads the data into CLD2.
-  void LoadCLDDData(base::File file,
-                    const uint64 data_offset,
-                    const uint64 data_length);
-
-  // A struct that contains the pointer to the CLD mmap. Used so that we can
-  // leverage LazyInstance:Leaky to properly scope the lifetime of the mmap.
-  struct CLDMmapWrapper {
-    CLDMmapWrapper() {
-      value = NULL;
-    }
-    base::MemoryMappedFile* value;
-  };
-  static base::LazyInstance<CLDMmapWrapper>::Leaky s_cld_mmap_;
+  // Provides CLD data for this process.
+  scoped_ptr<translate::RendererCldDataProvider> cld_data_provider_;
 
   // Whether or not polling for CLD2 data has started.
-  bool cld2_data_file_polling_started_;
+  bool cld_data_polling_started_;
 
-  // Whether or not CancelCLD2DataFilePolling has been called.
-  bool cld2_data_file_polling_canceled_;
+  // Whether or not CancelCldDataPolling has been called.
+  bool cld_data_polling_canceled_;
 
   // Whether or not a PageCaptured event arrived prior to CLD data becoming
   // available. If true, deferred_page_id_ contains the most recent page ID
   // and deferred_contents_ contains the most recent contents.
   bool deferred_page_capture_;
 
   // The ID of the page most recently reported to PageCaptured if
   // deferred_page_capture_ is true.
   int deferred_page_id_;
 
   // The contents of the page most recently reported to PageCaptured if
   // deferred_page_capture_ is true.
   base::string16 deferred_contents_;
 
-#endif
-
   DISALLOW_COPY_AND_ASSIGN(TranslateHelper);
 };
 
 #endif  // CHROME_RENDERER_TRANSLATE_TRANSLATE_HELPER_H_