Shorten FPDFPage thumbnail API names. The API names already start with "FPDFPage" to indicate they work with pages. So having "FromPage" in the API names is redundant. Bug: pdfium:1312 Change-Id: I3bdc0adddbf1adc421c9bd61f11e3b9b66a928b5 Reviewed-on: https://pdfium-review.googlesource.com/c/pdfium/+/57370 Reviewed-by: Tom Sepez <tsepez@chromium.org> Commit-Queue: Lei Zhang <thestig@chromium.org>
diff --git a/fpdfsdk/fpdf_thumbnail.cpp b/fpdfsdk/fpdf_thumbnail.cpp index e206841..f0bd4d6 100644 --- a/fpdfsdk/fpdf_thumbnail.cpp +++ b/fpdfsdk/fpdf_thumbnail.cpp
@@ -32,9 +32,9 @@ } // namespace FPDF_EXPORT unsigned long FPDF_CALLCONV -FPDFPage_GetDecodedThumbnailDataFromPage(FPDF_PAGE page, - void* buffer, - unsigned long buflen) { +FPDFPage_GetDecodedThumbnailData(FPDF_PAGE page, + void* buffer, + unsigned long buflen) { const CPDF_Stream* thumb_stream = CPDFStreamForThumbnailFromPage(page); if (!thumb_stream) return 0u; @@ -43,9 +43,9 @@ } FPDF_EXPORT unsigned long FPDF_CALLCONV -FPDFPage_GetRawThumbnailDataFromPage(FPDF_PAGE page, - void* buffer, - unsigned long buflen) { +FPDFPage_GetRawThumbnailData(FPDF_PAGE page, + void* buffer, + unsigned long buflen) { const CPDF_Stream* thumb_stream = CPDFStreamForThumbnailFromPage(page); if (!thumb_stream) return 0u; @@ -54,7 +54,7 @@ } FPDF_EXPORT FPDF_BITMAP FPDF_CALLCONV -FPDFPage_GetThumbnailAsBitmapFromPage(FPDF_PAGE page) { +FPDFPage_GetThumbnailAsBitmap(FPDF_PAGE page) { const CPDF_Stream* thumb_stream = CPDFStreamForThumbnailFromPage(page); if (!thumb_stream) return nullptr;
diff --git a/fpdfsdk/fpdf_thumbnail_embeddertest.cpp b/fpdfsdk/fpdf_thumbnail_embeddertest.cpp index 466f618..010e77d 100644 --- a/fpdfsdk/fpdf_thumbnail_embeddertest.cpp +++ b/fpdfsdk/fpdf_thumbnail_embeddertest.cpp
@@ -22,11 +22,11 @@ ASSERT_TRUE(page); unsigned long length_bytes = - FPDFPage_GetDecodedThumbnailDataFromPage(page, nullptr, 0); + FPDFPage_GetDecodedThumbnailData(page, nullptr, 0); ASSERT_EQ(kExpectedSize, length_bytes); std::vector<uint8_t> thumb_buf(length_bytes); - EXPECT_EQ(kExpectedSize, FPDFPage_GetDecodedThumbnailDataFromPage( + EXPECT_EQ(kExpectedSize, FPDFPage_GetDecodedThumbnailData( page, thumb_buf.data(), length_bytes)); EXPECT_EQ(kHashedDecodedData, GenerateMD5Base16(thumb_buf.data(), kExpectedSize)); @@ -42,11 +42,11 @@ ASSERT_TRUE(page); unsigned long length_bytes = - FPDFPage_GetDecodedThumbnailDataFromPage(page, nullptr, 0); + FPDFPage_GetDecodedThumbnailData(page, nullptr, 0); ASSERT_EQ(kExpectedSize, length_bytes); std::vector<uint8_t> thumb_buf(length_bytes); - EXPECT_EQ(kExpectedSize, FPDFPage_GetDecodedThumbnailDataFromPage( + EXPECT_EQ(kExpectedSize, FPDFPage_GetDecodedThumbnailData( page, thumb_buf.data(), length_bytes)); EXPECT_EQ(kHashedDecodedData, GenerateMD5Base16(thumb_buf.data(), kExpectedSize)); @@ -66,11 +66,11 @@ ASSERT_TRUE(page); unsigned long length_bytes = - FPDFPage_GetDecodedThumbnailDataFromPage(page, nullptr, 0); + FPDFPage_GetDecodedThumbnailData(page, nullptr, 0); ASSERT_EQ(kExpectedSize, length_bytes); std::vector<uint8_t> thumb_buf(length_bytes); - EXPECT_EQ(kExpectedSize, FPDFPage_GetDecodedThumbnailDataFromPage( + EXPECT_EQ(kExpectedSize, FPDFPage_GetDecodedThumbnailData( page, thumb_buf.data(), length_bytes)); EXPECT_EQ(kHashedDecodedData, GenerateMD5Base16(thumb_buf.data(), kExpectedSize)); @@ -85,13 +85,13 @@ FPDF_PAGE page = LoadPage(0); ASSERT_TRUE(page); - EXPECT_EQ(0u, FPDFPage_GetDecodedThumbnailDataFromPage(page, nullptr, 0)); + EXPECT_EQ(0u, FPDFPage_GetDecodedThumbnailData(page, nullptr, 0)); UnloadPage(page); } TEST_F(FPDFThumbnailEmbedderTest, GetDecodedThumbnailDataFromPageNullPage) { - EXPECT_EQ(0u, FPDFPage_GetDecodedThumbnailDataFromPage(nullptr, nullptr, 0)); + EXPECT_EQ(0u, FPDFPage_GetDecodedThumbnailData(nullptr, nullptr, 0)); } TEST_F(FPDFThumbnailEmbedderTest, GetRawThumbnailDataFromPageWithFilters) { @@ -104,12 +104,11 @@ FPDF_PAGE page = LoadPage(0); ASSERT_TRUE(page); - unsigned long length_bytes = - FPDFPage_GetRawThumbnailDataFromPage(page, nullptr, 0); + unsigned long length_bytes = FPDFPage_GetRawThumbnailData(page, nullptr, 0); ASSERT_EQ(kExpectedSize, length_bytes); std::vector<uint8_t> thumb_buf(length_bytes); - EXPECT_EQ(kExpectedSize, FPDFPage_GetRawThumbnailDataFromPage( + EXPECT_EQ(kExpectedSize, FPDFPage_GetRawThumbnailData( page, thumb_buf.data(), length_bytes)); EXPECT_EQ(kHashedRawData, GenerateMD5Base16(thumb_buf.data(), kExpectedSize)); @@ -124,12 +123,11 @@ FPDF_PAGE page = LoadPage(1); ASSERT_TRUE(page); - unsigned long length_bytes = - FPDFPage_GetRawThumbnailDataFromPage(page, nullptr, 0); + unsigned long length_bytes = FPDFPage_GetRawThumbnailData(page, nullptr, 0); ASSERT_EQ(kExpectedSize, length_bytes); std::vector<uint8_t> thumb_buf(length_bytes); - EXPECT_EQ(kExpectedSize, FPDFPage_GetRawThumbnailDataFromPage( + EXPECT_EQ(kExpectedSize, FPDFPage_GetRawThumbnailData( page, thumb_buf.data(), length_bytes)); EXPECT_EQ(kHashedRawData, GenerateMD5Base16(thumb_buf.data(), kExpectedSize)); @@ -147,13 +145,12 @@ FPDF_PAGE page = LoadPage(0); ASSERT_TRUE(page); - unsigned long length_bytes = - FPDFPage_GetRawThumbnailDataFromPage(page, nullptr, 0); + unsigned long length_bytes = FPDFPage_GetRawThumbnailData(page, nullptr, 0); ASSERT_EQ(kExpectedSize, length_bytes); std::vector<uint8_t> thumb_buf(length_bytes); - EXPECT_EQ(kExpectedSize, FPDFPage_GetRawThumbnailDataFromPage( - page, thumb_buf.data(), length_bytes)); + EXPECT_EQ(kExpectedSize, + FPDFPage_GetRawThumbnailData(page, thumb_buf.data(), length_bytes)); EXPECT_EQ(kHashedRawData, GenerateMD5Base16(thumb_buf.data(), kExpectedSize)); UnloadPage(page); @@ -165,13 +162,13 @@ FPDF_PAGE page = LoadPage(0); ASSERT_TRUE(page); - EXPECT_EQ(0u, FPDFPage_GetRawThumbnailDataFromPage(page, nullptr, 0)); + EXPECT_EQ(0u, FPDFPage_GetRawThumbnailData(page, nullptr, 0)); UnloadPage(page); } TEST_F(FPDFThumbnailEmbedderTest, GetRawThumbnailDataFromPageNullPage) { - EXPECT_EQ(0u, FPDFPage_GetRawThumbnailDataFromPage(nullptr, nullptr, 0)); + EXPECT_EQ(0u, FPDFPage_GetRawThumbnailData(nullptr, nullptr, 0)); } TEST_F(FPDFThumbnailEmbedderTest, GetThumbnailAsBitmapFromPage) { @@ -181,7 +178,7 @@ FPDF_PAGE page = LoadPage(0); ASSERT_TRUE(page); - ScopedFPDFBitmap thumb_bitmap(FPDFPage_GetThumbnailAsBitmapFromPage(page)); + ScopedFPDFBitmap thumb_bitmap(FPDFPage_GetThumbnailAsBitmap(page)); EXPECT_EQ(50, FPDFBitmap_GetWidth(thumb_bitmap.get())); EXPECT_EQ(50, FPDFBitmap_GetHeight(thumb_bitmap.get())); @@ -196,7 +193,7 @@ FPDF_PAGE page = LoadPage(1); ASSERT_TRUE(page); - ScopedFPDFBitmap thumb_bitmap(FPDFPage_GetThumbnailAsBitmapFromPage(page)); + ScopedFPDFBitmap thumb_bitmap(FPDFPage_GetThumbnailAsBitmap(page)); EXPECT_EQ(50, FPDFBitmap_GetWidth(thumb_bitmap.get())); EXPECT_EQ(50, FPDFBitmap_GetHeight(thumb_bitmap.get())); @@ -215,7 +212,7 @@ FPDF_PAGE page = LoadPage(0); ASSERT_TRUE(page); - ScopedFPDFBitmap thumb_bitmap(FPDFPage_GetThumbnailAsBitmapFromPage(page)); + ScopedFPDFBitmap thumb_bitmap(FPDFPage_GetThumbnailAsBitmap(page)); ASSERT_EQ(nullptr, thumb_bitmap.get()); UnloadPage(page); @@ -228,7 +225,7 @@ FPDF_PAGE page = LoadPage(0); ASSERT_TRUE(page); - ScopedFPDFBitmap thumb_bitmap(FPDFPage_GetThumbnailAsBitmapFromPage(page)); + ScopedFPDFBitmap thumb_bitmap(FPDFPage_GetThumbnailAsBitmap(page)); ASSERT_EQ(nullptr, thumb_bitmap.get()); UnloadPage(page); @@ -241,7 +238,7 @@ FPDF_PAGE page = LoadPage(0); ASSERT_TRUE(page); - ScopedFPDFBitmap thumb_bitmap(FPDFPage_GetThumbnailAsBitmapFromPage(page)); + ScopedFPDFBitmap thumb_bitmap(FPDFPage_GetThumbnailAsBitmap(page)); EXPECT_EQ(10, FPDFBitmap_GetWidth(thumb_bitmap.get())); EXPECT_EQ(10, FPDFBitmap_GetHeight(thumb_bitmap.get())); @@ -261,18 +258,17 @@ ASSERT_TRUE(page); // Get the raw data - unsigned long raw_size = - FPDFPage_GetRawThumbnailDataFromPage(page, nullptr, 0); + unsigned long raw_size = FPDFPage_GetRawThumbnailData(page, nullptr, 0); ASSERT_EQ(kExpectedRawSize, raw_size); std::vector<uint8_t> raw_thumb_buf(raw_size); - EXPECT_EQ(kExpectedRawSize, FPDFPage_GetRawThumbnailDataFromPage( - page, raw_thumb_buf.data(), raw_size)); + EXPECT_EQ(kExpectedRawSize, + FPDFPage_GetRawThumbnailData(page, raw_thumb_buf.data(), raw_size)); EXPECT_EQ(kHashedRawData, GenerateMD5Base16(raw_thumb_buf.data(), kExpectedRawSize)); // Get the thumbnail - ScopedFPDFBitmap thumb_bitmap(FPDFPage_GetThumbnailAsBitmapFromPage(page)); + ScopedFPDFBitmap thumb_bitmap(FPDFPage_GetThumbnailAsBitmap(page)); EXPECT_EQ(50, FPDFBitmap_GetWidth(thumb_bitmap.get())); EXPECT_EQ(50, FPDFBitmap_GetHeight(thumb_bitmap.get())); @@ -280,14 +276,13 @@ CompareBitmap(thumb_bitmap.get(), 50, 50, "312a156389470c3c69435f836e370a45"); // Get the raw data again - unsigned long new_raw_size = - FPDFPage_GetRawThumbnailDataFromPage(page, nullptr, 0); + unsigned long new_raw_size = FPDFPage_GetRawThumbnailData(page, nullptr, 0); ASSERT_EQ(kExpectedRawSize, new_raw_size); std::vector<uint8_t> new_raw_thumb_buf(new_raw_size); EXPECT_EQ(kExpectedRawSize, - FPDFPage_GetRawThumbnailDataFromPage(page, new_raw_thumb_buf.data(), - new_raw_size)); + FPDFPage_GetRawThumbnailData(page, new_raw_thumb_buf.data(), + new_raw_size)); EXPECT_EQ(kHashedRawData, GenerateMD5Base16(new_raw_thumb_buf.data(), kExpectedRawSize)); @@ -295,5 +290,5 @@ } TEST_F(FPDFThumbnailEmbedderTest, GetThumbnailAsBitmapFromPageNullPage) { - EXPECT_EQ(nullptr, FPDFPage_GetThumbnailAsBitmapFromPage(nullptr)); + EXPECT_EQ(nullptr, FPDFPage_GetThumbnailAsBitmap(nullptr)); }
diff --git a/fpdfsdk/fpdf_view_c_api_test.c b/fpdfsdk/fpdf_view_c_api_test.c index ba07f2d..73df47e 100644 --- a/fpdfsdk/fpdf_view_c_api_test.c +++ b/fpdfsdk/fpdf_view_c_api_test.c
@@ -336,9 +336,9 @@ CHK(FPDFText_LoadPage); // fpdf_thumbnail.h - CHK(FPDFPage_GetDecodedThumbnailDataFromPage); - CHK(FPDFPage_GetRawThumbnailDataFromPage); - CHK(FPDFPage_GetThumbnailAsBitmapFromPage); + CHK(FPDFPage_GetDecodedThumbnailData); + CHK(FPDFPage_GetRawThumbnailData); + CHK(FPDFPage_GetThumbnailAsBitmap); // fpdf_transformpage.h CHK(FPDFPageObj_TransformClipPath);
diff --git a/public/fpdf_thumbnail.h b/public/fpdf_thumbnail.h index dbad85a..8ee8580 100644 --- a/public/fpdf_thumbnail.h +++ b/public/fpdf_thumbnail.h
@@ -25,9 +25,9 @@ // buffer - buffer for holding the decoded image data. // buflen - length of the buffer in bytes. FPDF_EXPORT unsigned long FPDF_CALLCONV -FPDFPage_GetDecodedThumbnailDataFromPage(FPDF_PAGE page, - void* buffer, - unsigned long buflen); +FPDFPage_GetDecodedThumbnailData(FPDF_PAGE page, + void* buffer, + unsigned long buflen); // Experimental API. // Gets the raw data from the thumbnail of |page| if it exists. @@ -40,9 +40,9 @@ // buffer - buffer for holding the raw image data. // buflen - length of the buffer in bytes. FPDF_EXPORT unsigned long FPDF_CALLCONV -FPDFPage_GetRawThumbnailDataFromPage(FPDF_PAGE page, - void* buffer, - unsigned long buflen); +FPDFPage_GetRawThumbnailData(FPDF_PAGE page, + void* buffer, + unsigned long buflen); // Experimental API. // Returns the thumbnail of |page| as a FPDF_BITMAP. Returns a nullptr @@ -50,7 +50,7 @@ // // page - handle to a page. FPDF_EXPORT FPDF_BITMAP FPDF_CALLCONV -FPDFPage_GetThumbnailAsBitmapFromPage(FPDF_PAGE page); +FPDFPage_GetThumbnailAsBitmap(FPDF_PAGE page); #ifdef __cplusplus }
diff --git a/samples/pdfium_test_write_helper.cc b/samples/pdfium_test_write_helper.cc index 7dda548..1bd1b05 100644 --- a/samples/pdfium_test_write_helper.cc +++ b/samples/pdfium_test_write_helper.cc
@@ -699,7 +699,7 @@ } unsigned long decoded_data_size = - FPDFPage_GetDecodedThumbnailDataFromPage(page, nullptr, 0u); + FPDFPage_GetDecodedThumbnailData(page, nullptr, 0u); // Only continue if there actually is a thumbnail for this page if (decoded_data_size == 0) { @@ -709,7 +709,7 @@ } std::vector<uint8_t> thumb_buf(decoded_data_size); - if (FPDFPage_GetDecodedThumbnailDataFromPage( + if (FPDFPage_GetDecodedThumbnailData( page, thumb_buf.data(), decoded_data_size) != decoded_data_size) { fprintf(stderr, "Failed to get decoded thumbnail data for %s.\n", filename); return; @@ -728,8 +728,7 @@ return; } - unsigned long raw_data_size = - FPDFPage_GetRawThumbnailDataFromPage(page, nullptr, 0u); + unsigned long raw_data_size = FPDFPage_GetRawThumbnailData(page, nullptr, 0u); // Only continue if there actually is a thumbnail for this page if (raw_data_size == 0) { @@ -739,8 +738,8 @@ } std::vector<uint8_t> thumb_buf(raw_data_size); - if (FPDFPage_GetRawThumbnailDataFromPage(page, thumb_buf.data(), - raw_data_size) != raw_data_size) { + if (FPDFPage_GetRawThumbnailData(page, thumb_buf.data(), raw_data_size) != + raw_data_size) { fprintf(stderr, "Failed to get raw thumbnail data for %s.\n", filename); return; } @@ -755,7 +754,7 @@ return; } - ScopedFPDFBitmap thumb_bitmap(FPDFPage_GetThumbnailAsBitmapFromPage(page)); + ScopedFPDFBitmap thumb_bitmap(FPDFPage_GetThumbnailAsBitmap(page)); if (!thumb_bitmap) { fprintf(stderr, "Thumbnail of page #%d has an empty bitmap.\n", page_num + 1);