Added network components for blimp text input feature

blimp/client/app/android/web_input_box.h

 // Copyright 2016 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 BLIMP_CLIENT_APP_ANDROID_WEB_INPUT_BOX_H_
 #define BLIMP_CLIENT_APP_ANDROID_WEB_INPUT_BOX_H_
 
 #include <string>
 
 #include "base/android/jni_android.h"
 #include "base/macros.h"
+#include "blimp/client/feature/ime_feature.h"
+#include "ui/base/ime/text_input_type.h"
 
 namespace blimp {
 namespace client {
 
 // The native component of org.chromium.blimp.input.WebInputBox.
-class WebInputBox {
+class WebInputBox : public ImeFeature::ImeFeatureDelegate {
  public:
   static bool RegisterJni(JNIEnv* env);
 
-  WebInputBox(JNIEnv* env, const base::android::JavaParamRef<jobject>& jobj);
+  WebInputBox(JNIEnv* env,
+              const base::android::JavaParamRef<jobject>& jobj,
+              ImeFeature* ime_feature);
 
-  // Brings up or hides the IME for user to enter text.
-  void OnImeRequested(bool show);
+  // Brings up IME for user to enter text.
+  void OnShowImeRequested(ui::TextInputType input_type,
+                          const std::string& text) override;
+
+  // Hides IME.
+  void OnHideImeRequested() override;
 
   // Methods called from Java via JNI.
   void Destroy(JNIEnv* env, const base::android::JavaParamRef<jobject>& jobj);
 
   // Sends the text entered from IME to the blimp engine
   void OnImeTextEntered(JNIEnv* env,
                         const base::android::JavaParamRef<jobject>& jobj,
                         const base::android::JavaParamRef<jstring>& text);
 
  private:
   virtual ~WebInputBox();
 
   // Reference to the Java object which owns this class.
   base::android::ScopedJavaGlobalRef<jobject> java_obj_;
 
+  // A bridge to the network layer which does the work of (de)serializing the
+  // outgoing and incoming BlimpMessage::IME messages from the engine. Life time
+  // of |ime_feature_| is managed by the BlimpClientSession which is expected to
+  // outlive the WebInputBox.

[Wez, 2016/03/22 21:43:38]

nit: Lifetime comment belongs w/ the constructor, since that's the interface
through which |ime_feature_| is received.

[shaktisahu, 2016/03/22 23:45:42]

Hmm.. I would prefer to keep it here, since it provides all the description of
the |ime_feature_| at one place. Few other header files also do the same.

[Wez, 2016/03/23 00:10:53]

I disagree; the point at which constraints need to be documented is the
interface between the caller and the implementation, which in this case is the
constructor. In general comments on private class members are there to help you
understand the implementation (how it works), while the comments in the public
section are on the interface (how to use it).

I'd also note that the comment shouldn't refer to BlimpClientSession in talking
about the lifetime, since WebInputBox doesn't really "know about" that class;
all WebInputBox cares about is that the delegate outlives it.

+  ImeFeature* ime_feature_;
+
   DISALLOW_COPY_AND_ASSIGN(WebInputBox);
 };
 
 }  // namespace client
 }  // namespace blimp
 
 #endif  // BLIMP_CLIENT_APP_ANDROID_WEB_INPUT_BOX_H_