Pepper IME API for surrounding text retrieval.

webkit/plugins/ppapi/ppapi_plugin_instance.h

 // 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 WEBKIT_PLUGINS_PPAPI_PPAPI_PLUGIN_INSTANCE_H_
 #define WEBKIT_PLUGINS_PPAPI_PPAPI_PLUGIN_INSTANCE_H_
 
 #include <set>
 #include <string>
 #include <vector>
 
 #include "base/basictypes.h"
 #include "base/compiler_specific.h"
 #include "base/memory/ref_counted.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/string16.h"
 #include "googleurl/src/gurl.h"
 #include "ppapi/c/dev/pp_cursor_type_dev.h"
 #include "ppapi/c/dev/ppb_gamepad_dev.h"
 #include "ppapi/c/dev/ppp_printing_dev.h"
 #include "ppapi/c/dev/ppp_find_dev.h"
 #include "ppapi/c/dev/ppp_selection_dev.h"
+#include "ppapi/c/dev/ppp_text_input_dev.h"
 #include "ppapi/c/dev/ppp_zoom_dev.h"
 #include "ppapi/c/pp_completion_callback.h"
 #include "ppapi/c/pp_instance.h"
 #include "ppapi/c/pp_resource.h"
 #include "ppapi/c/pp_var.h"
 #include "ppapi/c/ppb_audio_config.h"
 #include "ppapi/c/ppb_input_event.h"
 #include "ppapi/c/ppp_graphics_3d.h"
 #include "ppapi/c/ppp_input_event.h"
 #include "ppapi/c/ppp_messaging.h"
@@ skipping 24 matching lines @@
 struct WebCompositionUnderline;
 struct WebCursorInfo;
 }
 
 namespace ppapi {
 struct InputEventData;
 struct PPP_Instance_Combined;
 class Resource;
 }
 
+namespace ui {
+class Range;
+}
+
 namespace webkit {
 namespace ppapi {
 
 class FullscreenContainer;
 class MessageChannel;
 class PluginDelegate;
 class PluginModule;
 class PluginObject;
 class PPB_Graphics2D_Impl;
 class PPB_Graphics3D_Impl;
@@ skipping 96 matching lines @@
       const std::vector<WebKit::WebCompositionUnderline>& underlines,
       int selection_start,
       int selection_end);
   bool HandleCompositionEnd(const string16& text);
   bool HandleTextInput(const string16& text);
 
   // Implementation of composition API.
   void UpdateCaretPosition(const gfx::Rect& caret,
                            const gfx::Rect& bounding_box);
   void SetTextInputType(ui::TextInputType type);
+  void SelectionChanged();
+  void UpdateSurroundingText(const std::string& text,
+                             size_t caret, size_t anchor);
 
   // Gets the current text input status.
   ui::TextInputType text_input_type() const { return text_input_type_; }
   gfx::Rect GetCaretBounds() const;
   bool IsPluginAcceptingCompositionEvents() const;
+  void GetSurroundingText(string16* text, ui::Range* range) const;
 
   // Notifications about focus changes, see has_webkit_focus_ below.
   void SetWebKitFocus(bool has_focus);
   void SetContentAreaFocus(bool has_focus);
 
   // Notification about page visibility. The default is "visible".
   void PageVisibilityChanged(bool is_visible);
 
   // Notifications that the view is about to paint, has started painting, and
   // has flushed the painted content to the screen. These messages are used to
@@ skipping 11 matching lines @@
       TransportDIB** dib,
       gfx::Rect* dib_bounds,
       gfx::Rect* clip);
 
   // Tracks all live PluginObjects.
   void AddPluginObject(PluginObject* plugin_object);
   void RemovePluginObject(PluginObject* plugin_object);
 
   string16 GetSelectedText(bool html);
   string16 GetLinkAtPosition(const gfx::Point& point);
+  bool RequestSurroundingText(size_t desired_number_of_characters);
   void Zoom(double factor, bool text_only);
   bool StartFind(const string16& search_text,
                  bool case_sensitive,
                  int identifier);
   void SelectFindResult(bool forward);
   void StopFind();
 
   bool SupportsPrintInterface();
   bool IsPrintScalingDisabled();
   int PrintBegin(const gfx::Rect& printable_area, int printer_dpi);
@@ skipping 160 matching lines @@
                  ::ppapi::PPP_Instance_Combined* instance_interface);
 
   bool LoadFindInterface();
   bool LoadInputEventInterface();
   bool LoadMessagingInterface();
   bool LoadMouseLockInterface();
   bool LoadPdfInterface();
   bool LoadPrintInterface();
   bool LoadPrivateInterface();
   bool LoadSelectionInterface();
+  bool LoadTextInputInterface();
   bool LoadZoomInterface();
 
   // Determines if we think the plugin has focus, both content area and webkit
   // (see has_webkit_focus_ below).
   bool PluginHasFocus() const;
 
   void ScheduleAsyncDidChangeView(const ::ppapi::ViewData& previous_view);
   void SendAsyncDidChangeView(const ::ppapi::ViewData& previous_view);
   void SendDidChangeView(const ::ppapi::ViewData& previous_view);
 
@@ skipping 108 matching lines @@
   int find_identifier_;
 
   // The plugin-provided interfaces.
   const PPP_Find_Dev* plugin_find_interface_;
   const PPP_Messaging* plugin_messaging_interface_;
   const PPP_MouseLock* plugin_mouse_lock_interface_;
   const PPP_InputEvent* plugin_input_event_interface_;
   const PPP_Instance_Private* plugin_private_interface_;
   const PPP_Pdf* plugin_pdf_interface_;
   const PPP_Selection_Dev* plugin_selection_interface_;
+  const PPP_TextInput_Dev* plugin_textinput_interface_;
   const PPP_Zoom_Dev* plugin_zoom_interface_;
 
   // Flags indicating whether we have asked this plugin instance for the
   // corresponding interfaces, so that we can ask only once.
   bool checked_for_plugin_input_event_interface_;
   bool checked_for_plugin_messaging_interface_;
 
   // This is only valid between a successful PrintBegin call and a PrintEnd
   // call.
   PP_PrintSettings_Dev current_print_settings_;
@@ skipping 74 matching lines @@
   // and not. The bits are PP_INPUTEVENT_CLASS_*.
   uint32_t input_event_mask_;
   uint32_t filtered_input_event_mask_;
 
   // Text composition status.
   ui::TextInputType text_input_type_;
   gfx::Rect text_input_caret_;
   gfx::Rect text_input_caret_bounds_;
   bool text_input_caret_set_;
 
+  // Text selection status.
+  std::string surrounding_text_;
+  size_t selection_caret_;
+  size_t selection_anchor_;
+
   PP_CompletionCallback lock_mouse_callback_;
 
   DISALLOW_COPY_AND_ASSIGN(PluginInstance);
 };
 
 }  // namespace ppapi
 }  // namespace webkit
 
 #endif  // WEBKIT_PLUGINS_PPAPI_PPAPI_PLUGIN_INSTANCE_H_