Cover fpdftext.h API with embeddertests.

fpdfsdk/src/fpdftext_embeddertest.cpp

 // Copyright 2015 PDFium 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 "../../testing/embedder_test.h"
 #include "../../fpdfsdk/include/fpdfview.h"
 #include "../../fpdfsdk/include/fpdftext.h"
 #include "testing/gtest/include/gtest/gtest.h"
 
+namespace {
+
+static bool check_unsigned_shorts(const char* expected,
+                                  const unsigned short* actual,
+                                  size_t length) {
+  if (length > strlen(expected) + 1) {
+    return false;
+  }
+  for (size_t i = 0; i < length; ++i) {
+    if (actual[i] != static_cast<unsigned short>(expected[i])) {
+      return false;
+    }
+  }
+  return true;
+}
+
+}  // namespace
+
 class FPDFTextEmbeddertest : public EmbedderTest {
 };
 
+TEST_F(FPDFTextEmbeddertest, Text) {
+  EXPECT_TRUE(OpenDocument("testing/resources/hello_world.pdf"));
+  FPDF_FORMHANDLE form_handle = SetFormFillEnvironment();
+  FPDF_PAGE page = LoadPage(0, form_handle);
+  EXPECT_NE(nullptr, page);
+
+  FPDF_TEXTPAGE textpage = FPDFText_LoadPage(page);
+  EXPECT_NE(nullptr, textpage);
+
+  const char expected[] = "Hello, world!\r\nGoodbye, world!";
+  unsigned short fixed_buffer[128];
+  memset(fixed_buffer, 0xbd, sizeof(fixed_buffer));
+
+  // Check includes the terminating NUL that is provided.
+  EXPECT_EQ(sizeof(expected), FPDFText_GetText(textpage, 0, 128, fixed_buffer));
+  EXPECT_TRUE(check_unsigned_shorts(expected, fixed_buffer, sizeof(expected)));
+
+  // Count does not include the terminating NUL in the string literal.
+  EXPECT_EQ(sizeof(expected) - 1, FPDFText_CountChars(textpage));
+  for (size_t i = 0; i < sizeof(expected) - 1; ++i) {
+    EXPECT_EQ(expected[i], FPDFText_GetUnicode(textpage, i)) << " at " << i;
+  }
+
+  EXPECT_EQ(12.0, FPDFText_GetFontSize(textpage, 0));
+  EXPECT_EQ(16.0, FPDFText_GetFontSize(textpage, 15));
+
+  double left = 0.0;
+  double right = 0.0;
+  double bottom = 0.0;
+  double top = 0.0;
+  FPDFText_GetCharBox(textpage, 4, &left, &right, &bottom, &top);
+  EXPECT_NEAR(41.071, left, 0.001);
+  EXPECT_NEAR(46.243, right, 0.001);
+  EXPECT_NEAR(49.844, bottom, 0.001);
+  EXPECT_NEAR(55.520, top, 0.001);
+
+  EXPECT_EQ(4, FPDFText_GetCharIndexAtPos(
+      textpage, 42.0, 50.0, 1.0, 1.0));
+  EXPECT_EQ(-1, FPDFText_GetCharIndexAtPos(
+      textpage, 0.0, 0.0, 1.0, 1.0));
+  EXPECT_EQ(-1, FPDFText_GetCharIndexAtPos(
+      textpage, 199.0, 199.0, 1.0, 1.0));
+
+  // Test out of range indicies.
+  EXPECT_EQ(-1, FPDFText_GetCharIndexAtPos(
+      textpage, 42.0, 10000000.0, 1.0, 1.0));
+  EXPECT_EQ(-1, FPDFText_GetCharIndexAtPos(
+      textpage, -1.0, 50.0, 1.0, 1.0));
+
+  // Count does not include the terminating NUL in the string literal.
+  EXPECT_EQ(2, FPDFText_CountRects(textpage, 0, sizeof(expected) - 1));
+
+  left = 0.0;
+  right = 0.0;
+  bottom = 0.0;
+  top = 0.0;
+  FPDFText_GetRect(textpage, 1, &left, &top, &right, &bottom);
+  EXPECT_NEAR(20.847, left, 0.001);
+  EXPECT_NEAR(135.167, right, 0.001);
+  EXPECT_NEAR(96.655, bottom, 0.001);
+  EXPECT_NEAR(116.000, top, 0.001);
+
+  // Test out of range indicies.
+  left = 0.0;

[Lei Zhang, 2015/01/28 18:35:02]

Maybe set these to some value other than 0? Ditto below at line 341 and 352.

[Tom Sepez, 2015/01/28 18:50:34]

Sadly, I think these are left unchanged in face of error.  Do we want to enforce
that this is the case and that they are not zero'd?  Bad API design.

[Lei Zhang, 2015/01/28 19:27:18]

Right, given the API as is, I'm just saying it would be slightly more
interesting to put a non-zero value here and in EXPECT_EQ() to test that that
the out params are not touched at all in case of failure.

[Tom Sepez, 2015/01/28 20:18:03]

Done.  Fascinating thing is that this API sets them to 0, while the other one
leaves them unchanged.  We should probably inflict consistency upon them at some
point down the road.

+  right = 0.0;
+  bottom = 0.0;
+  top = 0.0;
+  FPDFText_GetRect(textpage, -1, &left, &top, &right, &bottom);
+  EXPECT_EQ(0.0, left);
+  EXPECT_EQ(0.0, right);
+  EXPECT_EQ(0.0, bottom);
+  EXPECT_EQ(0.0, top);
+
+  FPDFText_GetRect(textpage, 2, &left, &top, &right, &bottom);
+  EXPECT_EQ(0.0, left);
+  EXPECT_EQ(0.0, right);
+  EXPECT_EQ(0.0, bottom);
+  EXPECT_EQ(0.0, top);
+
+  EXPECT_EQ(9, FPDFText_GetBoundedText(
+      textpage, 41.0, 56.0, 82.0, 48.0, 0, 0));
+
+  // Extract starting at character 4 as above.
+  memset(fixed_buffer, 0xbd, sizeof(fixed_buffer));
+  EXPECT_EQ(1, FPDFText_GetBoundedText(
+      textpage, 41.0, 56.0, 82.0, 48.0, fixed_buffer, 1));
+  EXPECT_TRUE(check_unsigned_shorts(expected + 4, fixed_buffer, 1));
+  EXPECT_EQ(0xbdbd, fixed_buffer[1]);
+
+  memset(fixed_buffer, 0xbd, sizeof(fixed_buffer));
+  EXPECT_EQ(9, FPDFText_GetBoundedText(
+      textpage, 41.0, 56.0, 82.0, 48.0, fixed_buffer, 9));
+  EXPECT_TRUE(check_unsigned_shorts(expected + 4, fixed_buffer, 9));
+  EXPECT_EQ(0xbdbd, fixed_buffer[9]);
+
+  memset(fixed_buffer, 0xbd, sizeof(fixed_buffer));
+  EXPECT_EQ(10, FPDFText_GetBoundedText(
+      textpage, 41.0, 56.0, 82.0, 48.0, fixed_buffer, 128));
+  EXPECT_TRUE(check_unsigned_shorts(expected + 4, fixed_buffer, 9));
+  EXPECT_EQ(0u, fixed_buffer[9]);
+  EXPECT_EQ(0xbdbd, fixed_buffer[10]);
+
+  FPDFText_ClosePage(textpage);
+  ClearFormFillEnvironment(form_handle);
+}
+
+TEST_F(FPDFTextEmbeddertest, TextSearch) {
+  EXPECT_TRUE(OpenDocument("testing/resources/hello_world.pdf"));
+  FPDF_FORMHANDLE form_handle = SetFormFillEnvironment();
+  FPDF_PAGE page = LoadPage(0, form_handle);
+  EXPECT_NE(nullptr, page);
+
+  FPDF_TEXTPAGE textpage = FPDFText_LoadPage(page);
+  EXPECT_NE(nullptr, textpage);
+
+  // Avoid issues with system wchar_t width vs. FPDF_WideString.
+  const unsigned short nope[] = { 'n', 'o', 'p', 'e', '\0' };
+  const unsigned short world[] = { 'w', 'o', 'r', 'l', 'd', '\0' };
+  const unsigned short world_caps[] = { 'W', 'O', 'R', 'L', 'D', '\0' };
+  const unsigned short world_substr[] = { 'o', 'r', 'l', 'd', '\0' };
+
+  // No occurences of "nope" in test page.
+  FPDF_SCHHANDLE search = FPDFText_FindStart(textpage, nope, 0, 0);
+  EXPECT_NE(nullptr, search);
+  EXPECT_EQ(0, FPDFText_GetSchResultIndex(search));
+  EXPECT_EQ(0, FPDFText_GetSchCount(search));
+
+  // Advancing finds nothing.
+  EXPECT_FALSE(FPDFText_FindNext(search));
+  EXPECT_EQ(0, FPDFText_GetSchResultIndex(search));
+  EXPECT_EQ(0, FPDFText_GetSchCount(search));
+
+  // Retreating finds nothing.
+  EXPECT_FALSE(FPDFText_FindPrev(search));
+  EXPECT_EQ(0, FPDFText_GetSchResultIndex(search));
+  EXPECT_EQ(0, FPDFText_GetSchCount(search));
+  FPDFText_FindClose(search);
+
+  // Two occurences of "world" in test page.
+  search = FPDFText_FindStart(textpage, world, 0, 2);
+  EXPECT_NE(nullptr, search);
+
+  // Remains not found until advanced.
+  EXPECT_EQ(0, FPDFText_GetSchResultIndex(search));
+  EXPECT_EQ(0, FPDFText_GetSchCount(search));
+
+  // First occurence of "world" in this test page.
+  EXPECT_TRUE(FPDFText_FindNext(search));
+  EXPECT_EQ(7, FPDFText_GetSchResultIndex(search));
+  EXPECT_EQ(5, FPDFText_GetSchCount(search));
+
+  // Last occurence of "world" in this test page.
+  EXPECT_TRUE(FPDFText_FindNext(search));
+  EXPECT_EQ(24, FPDFText_GetSchResultIndex(search));
+  EXPECT_EQ(5, FPDFText_GetSchCount(search));
+
+  // Found position unchanged when fails to advance.
+  EXPECT_FALSE(FPDFText_FindNext(search));
+  EXPECT_EQ(24, FPDFText_GetSchResultIndex(search));
+  EXPECT_EQ(5, FPDFText_GetSchCount(search));
+
+  // Back to first occurence.
+  EXPECT_TRUE(FPDFText_FindPrev(search));
+  EXPECT_EQ(7, FPDFText_GetSchResultIndex(search));
+  EXPECT_EQ(5, FPDFText_GetSchCount(search));
+
+  // Found position unchanged when fails to retreat.
+  EXPECT_FALSE(FPDFText_FindPrev(search));
+  EXPECT_EQ(7, FPDFText_GetSchResultIndex(search));
+  EXPECT_EQ(5, FPDFText_GetSchCount(search));
+  FPDFText_FindClose(search);
+
+  // Exact search unaffected by case sensitiity and whole word flags.
+  search = FPDFText_FindStart(
+      textpage, world, FPDF_MATCHCASE | FPDF_MATCHWHOLEWORD, 0);
+  EXPECT_NE(nullptr, search);
+  EXPECT_TRUE(FPDFText_FindNext(search));
+  EXPECT_EQ(7, FPDFText_GetSchResultIndex(search));
+  EXPECT_EQ(5, FPDFText_GetSchCount(search));
+  FPDFText_FindClose(search);
+
+  // Default is case-insensitive, so matching agaist caps works.
+  search = FPDFText_FindStart(textpage, world_caps, 0, 0);
+  EXPECT_NE(nullptr, search);
+  EXPECT_TRUE(FPDFText_FindNext(search));
+  EXPECT_EQ(7, FPDFText_GetSchResultIndex(search));
+  EXPECT_EQ(5, FPDFText_GetSchCount(search));
+  FPDFText_FindClose(search);
+
+  // But can be made case sensitive, in which case this fails.
+  search = FPDFText_FindStart(textpage, world_caps, FPDF_MATCHCASE, 0);
+  EXPECT_FALSE(FPDFText_FindNext(search));
+  EXPECT_EQ(0, FPDFText_GetSchResultIndex(search));
+  EXPECT_EQ(0, FPDFText_GetSchCount(search));
+  FPDFText_FindClose(search);
+
+  // Default is match anywhere within word, so matching substirng works.
+  search = FPDFText_FindStart(textpage, world_substr, 0, 0);
+  EXPECT_TRUE(FPDFText_FindNext(search));
+  EXPECT_EQ(8, FPDFText_GetSchResultIndex(search));
+  EXPECT_EQ(4, FPDFText_GetSchCount(search));
+  FPDFText_FindClose(search);
+
+  // But can be made to mach word boundaries, in which case this fails.
+  search = FPDFText_FindStart(textpage, world_substr, FPDF_MATCHWHOLEWORD, 0);
+  EXPECT_FALSE(FPDFText_FindNext(search));
+  // TODO(tsepez): investigate strange index/count values in this state.
+  FPDFText_FindClose(search);
+
+  FPDFText_ClosePage(textpage);
+  ClearFormFillEnvironment(form_handle);
+}
+
 // Test that the page has characters despite a bad stream length.
 TEST_F(FPDFTextEmbeddertest, StreamLengthPastEndOfFile) {
   EXPECT_TRUE(OpenDocument("testing/resources/bug_57.pdf"));
   FPDF_FORMHANDLE form_handle = SetFormFillEnvironment();
   FPDF_PAGE page = LoadPage(0, form_handle);
   EXPECT_NE(nullptr, page);
+
   FPDF_TEXTPAGE textpage = FPDFText_LoadPage(page);
   EXPECT_NE(nullptr, textpage);
   EXPECT_EQ(13, FPDFText_CountChars(textpage));
+
+  FPDFText_ClosePage(textpage);
   ClearFormFillEnvironment(form_handle);
 }
+
+TEST_F(FPDFTextEmbeddertest, WebLinks) {
+  EXPECT_TRUE(OpenDocument("testing/resources/weblinks.pdf"));
+  FPDF_FORMHANDLE form_handle = SetFormFillEnvironment();
+  FPDF_PAGE page = LoadPage(0, form_handle);
+  EXPECT_NE(nullptr, page);
+
+  FPDF_TEXTPAGE textpage = FPDFText_LoadPage(page);
+  EXPECT_NE(nullptr, textpage);
+
+  FPDF_PAGELINK pagelink = FPDFLink_LoadWebLinks(textpage);
+  EXPECT_NE(nullptr, pagelink);
+
+  // Page contains two HTTP-style URLs.
+  EXPECT_EQ(2, FPDFLink_CountWebLinks(pagelink));
+
+  // Only a terminating NUL required for bogus links.
+  EXPECT_EQ(1, FPDFLink_GetURL(pagelink, 2, nullptr, 0));
+  EXPECT_EQ(1, FPDFLink_GetURL(pagelink, 1400, nullptr, 0));
+  EXPECT_EQ(1, FPDFLink_GetURL(pagelink, -1, nullptr, 0));
+
+  // Query the number of characters required for each link (incl NUL).
+  EXPECT_EQ(25, FPDFLink_GetURL(pagelink, 0, nullptr, 0));
+  EXPECT_EQ(26, FPDFLink_GetURL(pagelink, 1, nullptr, 0));
+
+  const char expected_url[] = "http://example.com?q=foo";
+  unsigned short fixed_buffer[128];
+
+  // Retrieve a link with too small a buffer.  Buffer will not be
+  // NUL-terminated, but must not be modified past indicated length,
+  // so pre-fill with a pattern to check write bounds.
+  memset(fixed_buffer, 0xbd, sizeof(fixed_buffer));
+  EXPECT_EQ(1, FPDFLink_GetURL(pagelink, 0, fixed_buffer, 1));
+  EXPECT_TRUE(check_unsigned_shorts(expected_url, fixed_buffer, 1));
+  EXPECT_EQ(0xbdbd, fixed_buffer[1]);
+
+  // Check buffer that doesn't have space for a terminating NUL.
+  memset(fixed_buffer, 0xbd, sizeof(fixed_buffer));
+  EXPECT_EQ(sizeof(expected_url) - 1, FPDFLink_GetURL(
+      pagelink, 0, fixed_buffer, sizeof(expected_url) - 1));
+  EXPECT_TRUE(check_unsigned_shorts(
+      expected_url, fixed_buffer, sizeof(expected_url) - 1));
+  EXPECT_EQ(0xbdbd, fixed_buffer[sizeof(expected_url) - 1]);
+
+  // Retreive link with exactly-sized buffer.
+  memset(fixed_buffer, 0xbd, sizeof(fixed_buffer));
+  EXPECT_EQ(sizeof(expected_url), FPDFLink_GetURL(
+      pagelink, 0, fixed_buffer, sizeof(expected_url)));
+  EXPECT_TRUE(check_unsigned_shorts(
+      expected_url, fixed_buffer, sizeof(expected_url)));
+  EXPECT_EQ(0u, fixed_buffer[sizeof(expected_url) - 1]);
+  EXPECT_EQ(0xbdbd, fixed_buffer[sizeof(expected_url)]);
+
+  // Retreive link with ample-sized-buffer.
+  memset(fixed_buffer, 0xbd, sizeof(fixed_buffer));
+  EXPECT_EQ(sizeof(expected_url), FPDFLink_GetURL(
+      pagelink, 0, fixed_buffer, 128));
+  EXPECT_TRUE(check_unsigned_shorts(
+      expected_url, fixed_buffer, sizeof(expected_url)));
+  EXPECT_EQ(0u, fixed_buffer[sizeof(expected_url) - 1]);
+  EXPECT_EQ(0xbdbd, fixed_buffer[sizeof(expected_url)]);
+
+  // Each link rendered in a single rect in this test page.
+  EXPECT_EQ(1, FPDFLink_CountRects(pagelink, 0));
+  EXPECT_EQ(1, FPDFLink_CountRects(pagelink, 1));
+
+  // Each link rendered in a single rect in this test page.
+  EXPECT_EQ(0, FPDFLink_CountRects(pagelink, -1));
+  EXPECT_EQ(0, FPDFLink_CountRects(pagelink, 2));
+  EXPECT_EQ(0, FPDFLink_CountRects(pagelink, 10000));
+
+  // Check boundary of valid link with valid rect index.
+  double left = 0.0;
+  double right = 0.0;
+  double top = 0.0;
+  double bottom = 0.0;
+  FPDFLink_GetRect(pagelink, 0, 0, &left, &top, &right, &bottom);
+  EXPECT_NEAR(50.791, left, 0.001);
+  EXPECT_NEAR(187.963, right, 0.001);
+  EXPECT_NEAR(97.624, bottom, 0.001);
+  EXPECT_NEAR(108.736, top, 0.001);
+
+  // Check boundary of valid link with invalid rect index.
+  left = 0.0;
+  right = 0.0;
+  top = 0.0;
+  bottom = 0.0;
+  FPDFLink_GetRect(pagelink, 0, 1, &left, &top, &right, &bottom);
+  EXPECT_EQ(0.0, left);
+  EXPECT_EQ(0.0, right);
+  EXPECT_EQ(0.0, bottom);
+  EXPECT_EQ(0.0, top);
+
+  // Check bounardy of invalid link.
+  left = 0.0;
+  right = 0.0;
+  top = 0.0;
+  bottom = 0.0;
+  FPDFLink_GetRect(pagelink, -1, 0, &left, &top, &right, &bottom);
+  EXPECT_EQ(0.0, left);
+  EXPECT_EQ(0.0, right);
+  EXPECT_EQ(0.0, bottom);
+  EXPECT_EQ(0.0, top);
+
+  FPDFLink_CloseWebLinks(pagelink);
+  FPDFText_ClosePage(textpage);
+  ClearFormFillEnvironment(form_handle);
+}