summaryrefslogtreecommitdiff
path: root/fpdfsdk
diff options
context:
space:
mode:
authorJane Liu <janeliulwq@google.com>2017-08-15 10:50:22 -0400
committerChromium commit bot <commit-bot@chromium.org>2017-08-16 17:15:02 +0000
commit0c6b07d3fdbbabda8753e6457f4323237fc5be30 (patch)
tree8b1b62186095a8a2191c60e234dfd8a63b8d30db /fpdfsdk
parentca89829775fec2968b51fe5abad86bad1b6a277b (diff)
downloadpdfium-0c6b07d3fdbbabda8753e6457f4323237fc5be30.tar.xz
Changed the return type of FPDFAnnot_Get{Rect|AttachmentPoints}()
Instead of returning structs, changed FPDFAnnot_GetRect() and FPDFAnnot_GetAttachmentPoints() to return a bool and take a struct as an out parameter. Change-Id: I380e76eb1566b2488150fb31e9dad564a3ee10d4 Reviewed-on: https://pdfium-review.googlesource.com/10470 Reviewed-by: Lei Zhang <thestig@chromium.org> Commit-Queue: Jane Liu <janeliulwq@google.com>
Diffstat (limited to 'fpdfsdk')
-rw-r--r--fpdfsdk/fpdfannot.cpp72
-rw-r--r--fpdfsdk/fpdfannot_embeddertest.cpp53
2 files changed, 68 insertions, 57 deletions
diff --git a/fpdfsdk/fpdfannot.cpp b/fpdfsdk/fpdfannot.cpp
index 9213877b0b..fee99c844b 100644
--- a/fpdfsdk/fpdfannot.cpp
+++ b/fpdfsdk/fpdfannot.cpp
@@ -590,15 +590,16 @@ FPDFAnnot_SetAttachmentPoints(FPDF_ANNOTATION annot,
return true;
}
-FPDF_EXPORT FS_QUADPOINTSF FPDF_CALLCONV
-FPDFAnnot_GetAttachmentPoints(FPDF_ANNOTATION annot) {
- if (!annot || !FPDFAnnot_HasAttachmentPoints(annot))
- return FS_QUADPOINTSF();
+FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV
+FPDFAnnot_GetAttachmentPoints(FPDF_ANNOTATION annot,
+ FS_QUADPOINTSF* quadPoints) {
+ if (!annot || !FPDFAnnot_HasAttachmentPoints(annot) || !quadPoints)
+ return false;
CPDF_Dictionary* pAnnotDict =
CPDFAnnotContextFromFPDFAnnotation(annot)->GetAnnotDict();
if (!pAnnotDict)
- return FS_QUADPOINTSF();
+ return false;
// If the annotation's appearance stream is defined, then retrieve the
// quadpoints defined by the "BBox" entry in the AP dictionary, since its
@@ -606,41 +607,40 @@ FPDFAnnot_GetAttachmentPoints(FPDF_ANNOTATION annot) {
// takes priority over "QuadPoints" when rendering. Otherwise, retrieve
// the "Quadpoints" entry from the annotation dictionary.
CPDF_Array* pArray;
- FS_QUADPOINTSF quadPoints;
CPDF_Stream* pStream =
FPDFDOC_GetAnnotAP(pAnnotDict, CPDF_Annot::AppearanceMode::Normal);
if (pStream) {
pArray = pStream->GetDict()->GetArrayFor("BBox");
if (!pArray)
- return FS_QUADPOINTSF();
+ return false;
// Convert the BBox array into quadpoint coordinates. BBox array follows the
// order of a rectangle array: (left, bottom, right, up); and quadpoints
// follows the following order: (top-left vertex, top-right vertex, bottom-
// left vertex, bottom-right vertex).
- quadPoints.x1 = pArray->GetNumberAt(0);
- quadPoints.y1 = pArray->GetNumberAt(3);
- quadPoints.x2 = pArray->GetNumberAt(2);
- quadPoints.y2 = pArray->GetNumberAt(3);
- quadPoints.x3 = pArray->GetNumberAt(0);
- quadPoints.y3 = pArray->GetNumberAt(1);
- quadPoints.x4 = pArray->GetNumberAt(2);
- quadPoints.y4 = pArray->GetNumberAt(1);
+ quadPoints->x1 = pArray->GetNumberAt(0);
+ quadPoints->y1 = pArray->GetNumberAt(3);
+ quadPoints->x2 = pArray->GetNumberAt(2);
+ quadPoints->y2 = pArray->GetNumberAt(3);
+ quadPoints->x3 = pArray->GetNumberAt(0);
+ quadPoints->y3 = pArray->GetNumberAt(1);
+ quadPoints->x4 = pArray->GetNumberAt(2);
+ quadPoints->y4 = pArray->GetNumberAt(1);
} else {
pArray = pAnnotDict->GetArrayFor("QuadPoints");
if (!pArray)
- return FS_QUADPOINTSF();
-
- quadPoints.x1 = pArray->GetNumberAt(0);
- quadPoints.y1 = pArray->GetNumberAt(1);
- quadPoints.x2 = pArray->GetNumberAt(2);
- quadPoints.y2 = pArray->GetNumberAt(3);
- quadPoints.x3 = pArray->GetNumberAt(4);
- quadPoints.y3 = pArray->GetNumberAt(5);
- quadPoints.x4 = pArray->GetNumberAt(6);
- quadPoints.y4 = pArray->GetNumberAt(7);
+ return false;
+
+ quadPoints->x1 = pArray->GetNumberAt(0);
+ quadPoints->y1 = pArray->GetNumberAt(1);
+ quadPoints->x2 = pArray->GetNumberAt(2);
+ quadPoints->y2 = pArray->GetNumberAt(3);
+ quadPoints->x3 = pArray->GetNumberAt(4);
+ quadPoints->y3 = pArray->GetNumberAt(5);
+ quadPoints->x4 = pArray->GetNumberAt(6);
+ quadPoints->y4 = pArray->GetNumberAt(7);
}
- return quadPoints;
+ return true;
}
FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV FPDFAnnot_SetRect(FPDF_ANNOTATION annot,
@@ -673,14 +673,15 @@ FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV FPDFAnnot_SetRect(FPDF_ANNOTATION annot,
return true;
}
-FPDF_EXPORT FS_RECTF FPDF_CALLCONV FPDFAnnot_GetRect(FPDF_ANNOTATION annot) {
- if (!annot)
- return FS_RECTF();
+FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV FPDFAnnot_GetRect(FPDF_ANNOTATION annot,
+ FS_RECTF* rect) {
+ if (!annot || !rect)
+ return false;
CPDF_Dictionary* pAnnotDict =
CPDFAnnotContextFromFPDFAnnotation(annot)->GetAnnotDict();
if (!pAnnotDict)
- return FS_RECTF();
+ return false;
// If the annotation's appearance stream is defined and the annotation is of
// a type that does not have quadpoints, then retrieve the rectangle defined
@@ -696,12 +697,11 @@ FPDF_EXPORT FS_RECTF FPDF_CALLCONV FPDFAnnot_GetRect(FPDF_ANNOTATION annot) {
else
rt = pStream->GetDict()->GetRectFor("BBox");
- FS_RECTF rect;
- rect.left = rt.left;
- rect.bottom = rt.bottom;
- rect.right = rt.right;
- rect.top = rt.top;
- return rect;
+ rect->left = rt.left;
+ rect->bottom = rt.bottom;
+ rect->right = rt.right;
+ rect->top = rt.top;
+ return true;
}
FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV FPDFAnnot_HasKey(FPDF_ANNOTATION annot,
diff --git a/fpdfsdk/fpdfannot_embeddertest.cpp b/fpdfsdk/fpdfannot_embeddertest.cpp
index 66260bd8ac..32edd7a503 100644
--- a/fpdfsdk/fpdfannot_embeddertest.cpp
+++ b/fpdfsdk/fpdfannot_embeddertest.cpp
@@ -108,7 +108,8 @@ TEST_F(FPDFAnnotEmbeddertest, ExtractHighlightLongContent) {
.c_str());
// Check that the quadpoints are correct.
- FS_QUADPOINTSF quadpoints = FPDFAnnot_GetAttachmentPoints(annot);
+ FS_QUADPOINTSF quadpoints;
+ ASSERT_TRUE(FPDFAnnot_GetAttachmentPoints(annot, &quadpoints));
EXPECT_EQ(115.802643f, quadpoints.x1);
EXPECT_EQ(718.913940f, quadpoints.y1);
EXPECT_EQ(157.211182f, quadpoints.x4);
@@ -152,7 +153,8 @@ TEST_F(FPDFAnnotEmbeddertest, ExtractInkMultiple) {
// Check that the rectange coordinates are correct.
// Note that upon rendering, the rectangle coordinates will be adjusted.
- FS_RECTF rect = FPDFAnnot_GetRect(annot);
+ FS_RECTF rect;
+ ASSERT_TRUE(FPDFAnnot_GetRect(annot, &rect));
EXPECT_EQ(351.820404f, rect.left);
EXPECT_EQ(583.830688f, rect.bottom);
EXPECT_EQ(475.336090f, rect.right);
@@ -223,7 +225,8 @@ TEST_F(FPDFAnnotEmbeddertest, AddFirstTextAnnotation) {
EXPECT_EQ(51u, A);
// Set the annotation rectangle.
- FS_RECTF rect = FPDFAnnot_GetRect(annot);
+ FS_RECTF rect;
+ ASSERT_TRUE(FPDFAnnot_GetRect(annot, &rect));
EXPECT_EQ(0.f, rect.left);
EXPECT_EQ(0.f, rect.right);
rect.left = 35;
@@ -232,7 +235,7 @@ TEST_F(FPDFAnnotEmbeddertest, AddFirstTextAnnotation) {
rect.top = 165;
ASSERT_TRUE(FPDFAnnot_SetRect(annot, &rect));
// Check that the annotation rectangle has been set correctly.
- rect = FPDFAnnot_GetRect(annot);
+ ASSERT_TRUE(FPDFAnnot_GetRect(annot, &rect));
EXPECT_EQ(35.f, rect.left);
EXPECT_EQ(150.f, rect.bottom);
EXPECT_EQ(53.f, rect.right);
@@ -270,7 +273,8 @@ TEST_F(FPDFAnnotEmbeddertest, AddAndSaveUnderlineAnnotation) {
EXPECT_EQ(1, FPDFPage_GetAnnotCount(page));
FPDF_ANNOTATION annot = FPDFPage_GetAnnot(page, 0);
ASSERT_TRUE(annot);
- FS_QUADPOINTSF quadpoints = FPDFAnnot_GetAttachmentPoints(annot);
+ FS_QUADPOINTSF quadpoints;
+ ASSERT_TRUE(FPDFAnnot_GetAttachmentPoints(annot, &quadpoints));
EXPECT_EQ(115.802643f, quadpoints.x1);
EXPECT_EQ(718.913940f, quadpoints.y1);
EXPECT_EQ(157.211182f, quadpoints.x4);
@@ -301,7 +305,8 @@ TEST_F(FPDFAnnotEmbeddertest, AddAndSaveUnderlineAnnotation) {
FPDF_ANNOTATION new_annot = FPDFPage_GetAnnot(m_SavedPage, 1);
ASSERT_TRUE(new_annot);
EXPECT_EQ(FPDF_ANNOT_UNDERLINE, FPDFAnnot_GetSubtype(new_annot));
- FS_QUADPOINTSF new_quadpoints = FPDFAnnot_GetAttachmentPoints(new_annot);
+ FS_QUADPOINTSF new_quadpoints;
+ ASSERT_TRUE(FPDFAnnot_GetAttachmentPoints(new_annot, &new_quadpoints));
EXPECT_NEAR(quadpoints.x1, new_quadpoints.x1, 0.001f);
EXPECT_NEAR(quadpoints.y1, new_quadpoints.y1, 0.001f);
EXPECT_NEAR(quadpoints.x4, new_quadpoints.x4, 0.001f);
@@ -329,7 +334,8 @@ TEST_F(FPDFAnnotEmbeddertest, ModifyRectQuadpointsWithAP) {
// Check that when getting the attachment points, bounding box points are
// returned since this is a markup annotation with AP defined.
- FS_QUADPOINTSF quadpoints = FPDFAnnot_GetAttachmentPoints(annot);
+ FS_QUADPOINTSF quadpoints;
+ ASSERT_TRUE(FPDFAnnot_GetAttachmentPoints(annot, &quadpoints));
EXPECT_NEAR(0.f, quadpoints.x1, 0.001f);
EXPECT_NEAR(16.9955f, quadpoints.y1, 0.001f);
EXPECT_NEAR(68.5953f, quadpoints.x4, 0.001f);
@@ -340,7 +346,8 @@ TEST_F(FPDFAnnotEmbeddertest, ModifyRectQuadpointsWithAP) {
quadpoints.x1 = 1.0f;
quadpoints.x3 = 1.0f;
ASSERT_TRUE(FPDFAnnot_SetAttachmentPoints(annot, &quadpoints));
- FS_QUADPOINTSF new_quadpoints = FPDFAnnot_GetAttachmentPoints(annot);
+ FS_QUADPOINTSF new_quadpoints;
+ ASSERT_TRUE(FPDFAnnot_GetAttachmentPoints(annot, &new_quadpoints));
EXPECT_NE(quadpoints.x1, new_quadpoints.x1);
// Check that the bounding box gets updated successfully when valid attachment
@@ -352,7 +359,7 @@ TEST_F(FPDFAnnotEmbeddertest, ModifyRectQuadpointsWithAP) {
quadpoints.x3 = 0.f;
quadpoints.x4 = 133.055f;
ASSERT_TRUE(FPDFAnnot_SetAttachmentPoints(annot, &quadpoints));
- new_quadpoints = FPDFAnnot_GetAttachmentPoints(annot);
+ ASSERT_TRUE(FPDFAnnot_GetAttachmentPoints(annot, &new_quadpoints));
EXPECT_EQ(quadpoints.x1, new_quadpoints.x1);
EXPECT_EQ(quadpoints.y1, new_quadpoints.y1);
EXPECT_EQ(quadpoints.x4, new_quadpoints.x4);
@@ -360,7 +367,8 @@ TEST_F(FPDFAnnotEmbeddertest, ModifyRectQuadpointsWithAP) {
// Check that when getting the annotation rectangle, rectangle points are
// returned, but not bounding box points.
- FS_RECTF rect = FPDFAnnot_GetRect(annot);
+ FS_RECTF rect;
+ ASSERT_TRUE(FPDFAnnot_GetRect(annot, &rect));
EXPECT_NEAR(67.7299f, rect.left, 0.001f);
EXPECT_NEAR(704.296f, rect.bottom, 0.001f);
EXPECT_NEAR(136.325f, rect.right, 0.001f);
@@ -373,9 +381,10 @@ TEST_F(FPDFAnnotEmbeddertest, ModifyRectQuadpointsWithAP) {
rect.right = 134.055f;
rect.top = 722.792f;
ASSERT_TRUE(FPDFAnnot_SetRect(annot, &rect));
- FS_RECTF new_rect = FPDFAnnot_GetRect(annot);
+ FS_RECTF new_rect;
+ ASSERT_TRUE(FPDFAnnot_GetRect(annot, &new_rect));
EXPECT_EQ(rect.right, new_rect.right);
- new_quadpoints = FPDFAnnot_GetAttachmentPoints(annot);
+ ASSERT_TRUE(FPDFAnnot_GetAttachmentPoints(annot, &new_quadpoints));
EXPECT_NE(rect.right, new_quadpoints.x2);
FPDFPage_CloseAnnot(annot);
@@ -387,10 +396,10 @@ TEST_F(FPDFAnnotEmbeddertest, ModifyRectQuadpointsWithAP) {
// Check that the rectangle and the bounding box get updated successfully when
// a valid rectangle is set, since this is not a markup annotation.
- rect = FPDFAnnot_GetRect(annot);
+ ASSERT_TRUE(FPDFAnnot_GetRect(annot, &rect));
rect.right += 1.f;
ASSERT_TRUE(FPDFAnnot_SetRect(annot, &rect));
- new_rect = FPDFAnnot_GetRect(annot);
+ ASSERT_TRUE(FPDFAnnot_GetRect(annot, &new_rect));
EXPECT_EQ(rect.right, new_rect.right);
FPDFPage_CloseAnnot(annot);
@@ -406,17 +415,18 @@ TEST_F(FPDFAnnotEmbeddertest, RemoveAnnotation) {
// Check that the annotations have the expected rectangle coordinates.
FPDF_ANNOTATION annot = FPDFPage_GetAnnot(page, 0);
- FS_RECTF rect = FPDFAnnot_GetRect(annot);
+ FS_RECTF rect;
+ ASSERT_TRUE(FPDFAnnot_GetRect(annot, &rect));
EXPECT_NEAR(86.1971f, rect.left, 0.001f);
FPDFPage_CloseAnnot(annot);
annot = FPDFPage_GetAnnot(page, 1);
- rect = FPDFAnnot_GetRect(annot);
+ ASSERT_TRUE(FPDFAnnot_GetRect(annot, &rect));
EXPECT_NEAR(149.8127f, rect.left, 0.001f);
FPDFPage_CloseAnnot(annot);
annot = FPDFPage_GetAnnot(page, 2);
- rect = FPDFAnnot_GetRect(annot);
+ ASSERT_TRUE(FPDFAnnot_GetRect(annot, &rect));
EXPECT_NEAR(351.8204f, rect.left, 0.001f);
FPDFPage_CloseAnnot(annot);
@@ -454,12 +464,12 @@ TEST_F(FPDFAnnotEmbeddertest, RemoveAnnotation) {
// Check that the remaining 2 annotations are the original 1st and 3rd ones by
// verifying their rectangle coordinates.
annot = FPDFPage_GetAnnot(new_page, 0);
- rect = FPDFAnnot_GetRect(annot);
+ ASSERT_TRUE(FPDFAnnot_GetRect(annot, &rect));
EXPECT_NEAR(86.1971f, rect.left, 0.001f);
FPDFPage_CloseAnnot(annot);
annot = FPDFPage_GetAnnot(new_page, 1);
- rect = FPDFAnnot_GetRect(annot);
+ ASSERT_TRUE(FPDFAnnot_GetRect(annot, &rect));
EXPECT_NEAR(351.8204f, rect.left, 0.001f);
FPDFPage_CloseAnnot(annot);
FPDF_ClosePage(new_page);
@@ -563,7 +573,8 @@ TEST_F(FPDFAnnotEmbeddertest, AddAndModifyPath) {
EXPECT_EQ(1, FPDFAnnot_GetObjectCount(annot));
// Check that the annotation's bounding box came from its rectangle.
- FS_RECTF new_rect = FPDFAnnot_GetRect(annot);
+ FS_RECTF new_rect;
+ ASSERT_TRUE(FPDFAnnot_GetRect(annot, &new_rect));
EXPECT_EQ(rect.left, new_rect.left);
EXPECT_EQ(rect.bottom, new_rect.bottom);
EXPECT_EQ(rect.right, new_rect.right);
@@ -584,7 +595,7 @@ TEST_F(FPDFAnnotEmbeddertest, AddAndModifyPath) {
EXPECT_EQ(1, FPDFAnnot_GetObjectCount(annot));
// Check that the new annotation's rectangle is as defined.
- new_rect = FPDFAnnot_GetRect(annot);
+ ASSERT_TRUE(FPDFAnnot_GetRect(annot, &new_rect));
EXPECT_EQ(rect.left, new_rect.left);
EXPECT_EQ(rect.bottom, new_rect.bottom);
EXPECT_EQ(rect.right, new_rect.right);