Add functionality for copying text within form text fields and form combobox text fields

pdf/pdfium/pdfium_engine.cc

 // 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.
 
 #include "pdf/pdfium/pdfium_engine.h"
 
 #include <math.h>
 #include <stddef.h>
 #include <stdint.h>
 
@@ skipping 1607 matching lines @@
       FPDF_PAGE page = FPDF_LoadPage(doc, i);
       TransformPDFPageForPrinting(page, print_settings);
       FPDF_ClosePage(page);
     }
   }
 }
 
 void PDFiumEngine::SaveSelectedFormForPrint() {
   FORM_ForceToKillFocus(form_);
   client_->FormTextFieldFocusChange(false);
+  SetInFormTextArea(false);
+}
+
+void PDFiumEngine::SetFormSelectedText(FPDF_FORMHANDLE form_handle,
+                                       FPDF_PAGE page) {
+  size_t form_sel_text_len =
+      FORM_GetSelectedText(form_handle, page, nullptr, 0);
+
+  // Initial length = 2 (not 0) because chars are two bytes and

[Lei Zhang, 2017/06/20 00:26:24]

This statement is confusing. It can be read as: char (the variable type) is two
bytes, but that's clearly not the case.

[drgage, 2017/06/20 23:14:27]

Done.

+  // NUL char is included in count.
+  if (form_sel_text_len <= 2)

[dsinclair, 2017/06/20 15:21:44]

Is this check needed? Won't we just end up creating a std::string on 1647 which
is empty and then do nothing because of the following if?

[Lei Zhang, 2017/06/20 21:21:22]

Might as well bale out early if we knows continuing onwards is going to do more
work for nothing.

[drgage, 2017/06/20 23:14:27]

Done.

[drgage, 2017/06/20 23:14:27]

Yeah, you're right. I just wasn't sure if I should be trying to return as soon
as possible, which could potentially be on 1639. I guess by that logic, that
would make the check on 1648 unnecessary, but I put it there just in case. Do
you think it's okay to remove the check on 1638 and let it go until 1648?

[dsinclair, 2017/06/21 13:03:28]

Leaving it is fine, early exiting does make it a bit clearer what's happening.

[drgage, 2017/06/23 22:16:13]

Done.

+    return;
+
+  base::string16 selected_form_text16;
+  PDFiumAPIStringBufferSizeInBytesAdapter<base::string16> string_adapter(
+      &selected_form_text16, form_sel_text_len, false);
+  string_adapter.Close(FORM_GetSelectedText(
+      form_handle, page, string_adapter.GetData(), form_sel_text_len));
+
+  std::string selected_form_text = UTF16ToUTF8(selected_form_text16);
+  if (!selected_form_text.empty()) {
+    pp::PDF::SetSelectedText(GetPluginInstance(), selected_form_text.c_str());
+  }
 }
 
 void PDFiumEngine::PrintEnd() {
   FORM_DoDocumentAAction(form_, FPDFDOC_AACTION_DP);
 }
 
 PDFiumPage::Area PDFiumEngine::GetCharIndex(const pp::MouseInputEvent& event,
                                             int* page_index,
                                             int* char_index,
                                             int* form_type,
@@ skipping 76 matching lines @@
     return false;
 
   if (page_index != -1) {
     last_page_mouse_down_ = page_index;
     double page_x, page_y;
     pp::Point point = event.GetPosition();
     DeviceToPage(page_index, point.x(), point.y(), &page_x, &page_y);
 
     FORM_OnLButtonDown(form_, pages_[page_index]->GetPage(), 0, page_x, page_y);
     if (form_type > FPDF_FORMFIELD_UNKNOWN) {  // returns -1 sometimes...
-      mouse_down_state_.Set(PDFiumPage::NONSELECTABLE_AREA, target);
+      mouse_down_state_.Set(form_type == FPDF_FORMFIELD_TEXTFIELD

[Lei Zhang, 2017/06/20 00:26:24]

What about FPDF_FORMFIELD_COMBOBOX?

[drgage, 2017/06/20 23:14:27]

I think I got confused while refactoring this yesterday, I'll fix that.

+                                ? PDFiumPage::FORM_TEXT_AREA
+                                : PDFiumPage::NONSELECTABLE_AREA,
+                            target);
+
       bool is_valid_control = (form_type == FPDF_FORMFIELD_TEXTFIELD ||
                                form_type == FPDF_FORMFIELD_COMBOBOX);
+
+// TODO(bug_62400): figure out selection and copying
+// for XFA fields
 #if defined(PDF_ENABLE_XFA)
       is_valid_control |= (form_type == FPDF_FORMFIELD_XFA);
 #endif
       client_->FormTextFieldFocusChange(is_valid_control);
+      SetInFormTextArea(is_valid_control);
       return true;  // Return now before we get into the selection code.
     }
   }
-
   client_->FormTextFieldFocusChange(false);
+  SetInFormTextArea(false);
 
   if (area != PDFiumPage::TEXT_AREA)
     return true;  // Return true so WebKit doesn't do its own highlighting.
 
   if (event.GetClickCount() == 1) {
     OnSingleClick(page_index, char_index);
   } else if (event.GetClickCount() == 2 || event.GetClickCount() == 3) {
     OnMultipleClick(event.GetClickCount(), page_index, char_index);
   }
 
@@ skipping 55 matching lines @@
       bool alt_key = !!(modifiers & PP_INPUTEVENT_MODIFIER_ALTKEY);
       bool ctrl_key = !!(modifiers & PP_INPUTEVENT_MODIFIER_CONTROLKEY);
       bool meta_key = !!(modifiers & PP_INPUTEVENT_MODIFIER_METAKEY);
       bool shift_key = !!(modifiers & PP_INPUTEVENT_MODIFIER_SHIFTKEY);
 
       WindowOpenDisposition disposition = ui::DispositionFromClick(
           middle_button, alt_key, ctrl_key, meta_key, shift_key);
 
       client_->NavigateTo(target.url, disposition);
       client_->FormTextFieldFocusChange(false);
+      SetInFormTextArea(false);
       return true;
     }
     if (area == PDFiumPage::DOCLINK_AREA) {
       client_->ScrollToPage(target.page);
       client_->FormTextFieldFocusChange(false);
+      SetInFormTextArea(false);

[dsinclair, 2017/06/20 15:21:43]

Should we add a SetFormTextAreaStatus(bool) or something that calls these two
methods as they appear to get called together with the same value?

[drgage, 2017/06/20 23:14:27]

I could do this, or I could add the line
"client_->FormTextFieldFocusChange(in_form_text_area)" to my existing function
SetInFormTextArea(). What do you think would be better?

[dsinclair, 2017/06/21 13:03:28]

Moving the FormTextFieldFocusChange into SetInFormTextArea makes sense to me.

[drgage, 2017/06/23 22:16:12]

Done.

       return true;
     }
   }
 
   // Prevent middle mouse button from selecting texts.
   if (event.GetButton() == PP_INPUTEVENT_MOUSEBUTTON_MIDDLE)
     return false;
 
   if (page_index != -1) {
     double page_x, page_y;
     pp::Point point = event.GetPosition();
     DeviceToPage(page_index, point.x(), point.y(), &page_x, &page_y);
     FORM_OnLButtonUp(form_, pages_[page_index]->GetPage(), 0, page_x, page_y);
   }
 
+  if (area == PDFiumPage::FORM_TEXT_AREA)
+    SetFormSelectedText(form_, pages_[last_page_mouse_down_]->GetPage());
+
   if (!selecting_)
     return false;
 
   SetSelecting(false);
   return true;
 }
 
 bool PDFiumEngine::OnMouseMove(const pp::MouseInputEvent& event) {
   int page_index = -1;
   int char_index = -1;
@@ skipping 11 matching lines @@
     PP_CursorType_Dev cursor;
     switch (area) {
       case PDFiumPage::TEXT_AREA:
         cursor = PP_CURSORTYPE_IBEAM;
         break;
       case PDFiumPage::WEBLINK_AREA:
       case PDFiumPage::DOCLINK_AREA:
         cursor = PP_CURSORTYPE_HAND;
         break;
       case PDFiumPage::NONSELECTABLE_AREA:
+      case PDFiumPage::FORM_TEXT_AREA:
       default:
         switch (form_type) {
           case FPDF_FORMFIELD_PUSHBUTTON:
           case FPDF_FORMFIELD_CHECKBOX:
           case FPDF_FORMFIELD_RADIOBUTTON:
           case FPDF_FORMFIELD_COMBOBOX:
           case FPDF_FORMFIELD_LISTBOX:
             cursor = PP_CURSORTYPE_HAND;
             break;
           case FPDF_FORMFIELD_TEXTFIELD:
@@ skipping 106 matching lines @@
     // http://chrome-corpsvn.mtv.corp.google.com/viewvc?view=rev&root=chrome&revision=31805
     // for more information.  So just fake one since PDFium uses it.
     std::string str;
     str.push_back(event.GetKeyCode());
     pp::KeyboardInputEvent synthesized(pp::KeyboardInputEvent(
         client_->GetPluginInstance(), PP_INPUTEVENT_TYPE_CHAR,
         event.GetTimeStamp(), event.GetModifiers(), event.GetKeyCode(), str));
     OnChar(synthesized);
   }
 
+  // If form selected text is empty and key pressed within form text area,
+  // plugin text selection should be cleared.
+  if (FORM_GetSelectedText(form_, pages_[last_page_mouse_down_]->GetPage(),

[Lei Zhang, 2017/06/20 00:26:24]

Since the conditional is evaluated from left to right, FORM_GetSelectedText()
will be called even if |in_form_text_area_| is false. Calling
FORM_GetSelectedText() is much more expensive than checking
|in_form_text_area_|. So reversing the order of the two checks means the code
will run faster when |in_form_text_area_| is false.

[drgage, 2017/06/20 23:14:27]

Done.

+                           nullptr, 0) <= 2 &&
+      in_form_text_area_)
+    pp::PDF::SetSelectedText(GetPluginInstance(), "");
+
   return rv;
 }
 
 bool PDFiumEngine::OnKeyUp(const pp::KeyboardInputEvent& event) {
   if (last_page_mouse_down_ == -1)
     return false;
 
+  if (in_form_text_area_) {
+    if (event.GetKeyCode() == ui::VKEY_SHIFT)
+      SetFormSelectedText(form_, pages_[last_page_mouse_down_]->GetPage());
+  }
+
   return !!FORM_OnKeyUp(form_, pages_[last_page_mouse_down_]->GetPage(),
                         event.GetKeyCode(), event.GetModifiers());
 }
 
 bool PDFiumEngine::OnChar(const pp::KeyboardInputEvent& event) {
   if (last_page_mouse_down_ == -1)
     return false;
 
   base::string16 str = base::UTF8ToUTF16(event.GetCharacterText().AsString());
   return !!FORM_OnChar(form_, pages_[last_page_mouse_down_]->GetPage(), str[0],
@@ skipping 1541 matching lines @@
   client_->ScrollToPage(most_visible_page);
 }
 
 void PDFiumEngine::SetSelecting(bool selecting) {
   bool was_selecting = selecting_;
   selecting_ = selecting;
   if (selecting_ != was_selecting)
     client_->IsSelectingChanged(selecting);
 }
 
+void PDFiumEngine::SetInFormTextArea(bool in_form_text_area) {
+  in_form_text_area_ = in_form_text_area;
+}
+
 void PDFiumEngine::ScheduleTouchTimer(const pp::TouchInputEvent& evt) {
   touch_timers_[++next_touch_timer_id_] = evt;
   client_->ScheduleTouchTimerCallback(next_touch_timer_id_,
                                       kTouchLongPressTimeoutMs);
 }
 
 void PDFiumEngine::KillTouchTimer(int timer_id) {
   touch_timers_.erase(timer_id);
 }
 
@@ skipping 569 matching lines @@
   FPDF_DOCUMENT doc =
       FPDF_LoadMemDocument(pdf_buffer, pdf_buffer_size, nullptr);
   if (!doc)
     return false;
   bool success = FPDF_GetPageSizeByIndex(doc, page_number, width, height) != 0;
   FPDF_CloseDocument(doc);
   return success;
 }
 
 }  // namespace chrome_pdf