Generate default AP stream for square annotation.

core/fpdfdoc/cpvt_generateap.cpp

 // Copyright 2016 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.
 
 // Original code copyright 2014 Foxit Software Inc. http://www.foxitsoftware.com
 
 #include "core/fpdfdoc/cpvt_generateap.h"
 
 #include "core/fpdfapi/fpdf_font/include/cpdf_font.h"
 #include "core/fpdfapi/fpdf_parser/include/cpdf_dictionary.h"
@@ skipping 434 matching lines @@
           pStreamResFontList->SetAtReference(sFontName, pDoc, pFontDict);
       } else {
         pStreamDict->SetAt("Resources", pFormDict->GetDictBy("DR")->Clone());
         pStreamResList = pStreamDict->GetDictBy("Resources");
       }
     }
   }
   return true;
 }
 
-CFX_ByteString GetColorStringWithDefault(CPDF_Dictionary* pAnnotDict,
+CFX_ByteString GetColorStringWithDefault(CPDF_Array* pColor,

[Lei Zhang, 2016/08/05 02:01:05]

What prompted this change? Seemed fine before.

[jaepark, 2016/08/05 02:49:37]

For Square annotation, stroke color is in "C" field, and fill color is in "IC"
field. So I wanted to use this function to get the color string for both stroke
and fill color.

[Lei Zhang, 2016/08/05 17:27:29]

Another option is to change this to:

enum class ColorType {
  COLOR,
  INTERIOR_COLOR,
};

GetColorStringWithDefault(const CPDF_Dictionary& pAnnotDict, ColorType color,
...);

Whichever you think is cleaner.

[jaepark, 2016/08/05 19:02:19]

Acknowledged.

                                          const CPVT_Color& crDefaultColor,
                                          PaintOperation nOperation) {
-  if (CPDF_Array* pColor = pAnnotDict->GetArrayBy("C")) {
+  if (pColor) {
     CPVT_Color color = CPVT_Color::ParseColor(*pColor);
     return CPVT_GenerateAP::GenerateColorAP(color, nOperation);
   }
 
   return CPVT_GenerateAP::GenerateColorAP(crDefaultColor, nOperation);
 }
 
+FX_FLOAT GetBorderWidth(const CPDF_Dictionary& pAnnotDict) {
+  if (CPDF_Dictionary* pBorderStyleDict = pAnnotDict.GetDictBy("BS")) {
+    if (pBorderStyleDict->KeyExist("W"))
+      return pBorderStyleDict->GetNumberBy("W");

[Lei Zhang, 2016/08/05 02:01:05]

Do you care if this or line 473 returns 0? If a malformed PDF returns a negative
number, is that ok?

[jaepark, 2016/08/05 02:49:37]

It can be 0, in which case the border will not be drawn. However, if malformed
PDF returns a negative number, should I return 0 or the default value, which is
1? Returning default value for now.

[Lei Zhang, 2016/08/05 15:50:09]

Why don't we generate a test PDF and find out?

[jaepark, 2016/08/05 19:02:19]

Figured out that if the border width is 0 or negative number, the border should
not be drawn.

+  }
+
+  if (CPDF_Array* pBorderArray = pAnnotDict.GetArrayBy("Border"))
+    return pBorderArray->GetNumberAt(2);
+
+  return 1;
+}
+
+CFX_ByteString GetDashArrayInString(const CPDF_Dictionary& pAnnotDict) {

[Lei Zhang, 2016/08/05 02:01:05]

just GetDashArrayString?

[jaepark, 2016/08/05 02:49:38]

Done.

+  CPDF_Array* pDashArray = nullptr;
+
+  if (CPDF_Dictionary* pBorderStyleDict = pAnnotDict.GetDictBy("BS")) {
+    if (pBorderStyleDict->GetStringBy("S") == "D")
+      pDashArray = pBorderStyleDict->GetArrayBy("D");
+  } else if (CPDF_Array* pBorderArray = pAnnotDict.GetArrayBy("Border")) {
+    if (pBorderArray->GetCount() == 4)
+      pDashArray = pBorderArray->GetArrayAt(3);
+  }
+
+  CFX_ByteTextBuf sDashStream;
+  if (pDashArray) {
+    sDashStream << "[" << pDashArray->GetNumberAt(0);

[Lei Zhang, 2016/08/05 02:01:05]

If |pDashArray| is empty, you would get "[ 0 ]", is that ok?

[jaepark, 2016/08/05 02:49:37]

I changed it to return empty string when |pDashArray| is empty.

+    if (pDashArray->GetCount() == 2)
+      sDashStream << " " << pDashArray->GetNumberAt(1);
+    sDashStream << "]";
+  }
+
+  return sDashStream.MakeString();
+}
+
 CPDF_Dictionary* GenerateExtGStateDict(const CPDF_Dictionary& pAnnotDict,
                                        const CFX_ByteString& sExtGSDictName,
                                        const CFX_ByteString& sBlendMode) {
   CPDF_Dictionary* pGSDict = new CPDF_Dictionary;
   pGSDict->SetAtString("Type", "ExtGState");
 
   FX_FLOAT fOpacity =
       pAnnotDict.KeyExist("CA") ? pAnnotDict.GetNumberBy("CA") : 1;
   pGSDict->SetAtNumber("CA", fOpacity);
   pGSDict->SetAtNumber("ca", fOpacity);
@@ skipping 89 matching lines @@
                                           CPDF_Dictionary* pAnnotDict) {
   // If AP dictionary exists, we use the appearance defined in the
   // existing AP dictionary.
   if (pAnnotDict->KeyExist("AP"))
     return false;
 
   CFX_ByteTextBuf sAppStream;
   CFX_ByteString sExtGSDictName = "GS";
   sAppStream << "/" << sExtGSDictName << " gs ";
 
-  sAppStream << GetColorStringWithDefault(
-      pAnnotDict, CPVT_Color(CPVT_Color::kRGB, 1, 1, 0), PaintOperation::FILL);
+  sAppStream << GetColorStringWithDefault(pAnnotDict->GetArrayBy("C"),
+                                          CPVT_Color(CPVT_Color::kRGB, 1, 1, 0),
+                                          PaintOperation::FILL);
 
   CFX_FloatRect rect = pAnnotDict->GetRectBy("Rect");
   rect.Normalize();
 
   sAppStream << rect.left << " " << rect.top << " m " << rect.right << " "
              << rect.top << " l " << rect.right << " " << rect.bottom << " l "
              << rect.left << " " << rect.bottom << " l "
              << "h f\n";
 
   CPDF_Dictionary* pExtGStateDict =
       GenerateExtGStateDict(*pAnnotDict, sExtGSDictName, "Multiply");
   GenerateAndSetAPDict(pDoc, pAnnotDict, sAppStream, pExtGStateDict);
 
   return true;
 }
 
 bool CPVT_GenerateAP::GenerateUnderlineAP(CPDF_Document* pDoc,
                                           CPDF_Dictionary* pAnnotDict) {
   // If AP dictionary exists, we use the appearance defined in the
   // existing AP dictionary.
   if (pAnnotDict->KeyExist("AP"))
     return false;
 
   CFX_ByteTextBuf sAppStream;
   CFX_ByteString sExtGSDictName = "GS";
   sAppStream << "/" << sExtGSDictName << " gs ";
 
-  sAppStream << GetColorStringWithDefault(pAnnotDict,
+  sAppStream << GetColorStringWithDefault(pAnnotDict->GetArrayBy("C"),
                                           CPVT_Color(CPVT_Color::kRGB, 0, 0, 0),
                                           PaintOperation::STROKE);
 
   CFX_FloatRect rect = pAnnotDict->GetRectBy("Rect");
   rect.Normalize();
 
   FX_FLOAT fLineWidth = 1.0;
   sAppStream << fLineWidth << " w " << rect.left << " "
              << rect.bottom + fLineWidth << " m " << rect.right << " "
              << rect.bottom + fLineWidth << " l S\n";
 
   CPDF_Dictionary* pExtGStateDict =
       GenerateExtGStateDict(*pAnnotDict, sExtGSDictName, "Normal");
   GenerateAndSetAPDict(pDoc, pAnnotDict, sAppStream, pExtGStateDict);
   return true;
 }
 
+bool CPVT_GenerateAP::GenerateSquareAP(CPDF_Document* pDoc,
+                                       CPDF_Dictionary* pAnnotDict) {
+  // If AP dictionary exists, we use the appearance defined in the
+  // existing AP dictionary.
+  if (pAnnotDict->KeyExist("AP"))
+    return false;
+
+  CFX_ByteTextBuf sAppStream;
+  CFX_ByteString sExtGSDictName = "GS";
+  sAppStream << "/" << sExtGSDictName << " gs ";
+
+  bool isFillRect = pAnnotDict->GetArrayBy("IC") &&

[Lei Zhang, 2016/08/05 02:01:05]

bIsFillRect for consistency.

[Lei Zhang, 2016/08/05 02:01:05]

Can we save the pointer instead of calling pAnnotDict->GetArrayBy("IC") thrice?

[jaepark, 2016/08/05 02:49:38]

Done.

[jaepark, 2016/08/05 02:49:38]

Done.

+                    (pAnnotDict->GetArrayBy("IC")->GetCount() > 0);
+
+  sAppStream << GetColorStringWithDefault(pAnnotDict->GetArrayBy("C"),
+                                          CPVT_Color(CPVT_Color::kRGB, 0, 0, 0),
+                                          PaintOperation::STROKE);
+
+  sAppStream << GetColorStringWithDefault(pAnnotDict->GetArrayBy("IC"),
+                                          CPVT_Color(CPVT_Color::kTransparent),
+                                          PaintOperation::FILL);
+
+  FX_FLOAT fBorderWidth = GetBorderWidth(*pAnnotDict);
+  sAppStream << fBorderWidth << " w ";
+
+  CFX_ByteString sDashArray = GetDashArrayInString(*pAnnotDict);
+  if (!sDashArray.IsEmpty())
+    sAppStream << sDashArray << " 0 d ";
+
+  CFX_FloatRect rect = pAnnotDict->GetRectBy("Rect");
+  rect.Normalize();
+
+  // Deflating rect because stroking a path entails painting all points whose
+  // perpendicular distance from the path in user space is less than or equal go
+  // half the line width.
+  rect.Deflate(fBorderWidth / 2, fBorderWidth / 2);
+
+  sAppStream << rect.left << " " << rect.top << " m " << rect.right << " "
+             << rect.top << " l " << rect.right << " " << rect.bottom << " l "
+             << rect.left << " " << rect.bottom << " l "
+             << (isFillRect ? "b" : "s") << "\n";
+
+  CPDF_Dictionary* pExtGStateDict =
+      GenerateExtGStateDict(*pAnnotDict, sExtGSDictName, "Normal");
+  GenerateAndSetAPDict(pDoc, pAnnotDict, sAppStream, pExtGStateDict);
+  return true;
+}
+
 bool CPVT_GenerateAP::GenerateSquigglyAP(CPDF_Document* pDoc,
                                          CPDF_Dictionary* pAnnotDict) {
   // If AP dictionary exists, we use the appearance defined in the
   // existing AP dictionary.
   if (pAnnotDict->KeyExist("AP"))
     return false;
 
   CFX_ByteTextBuf sAppStream;
   CFX_ByteString sExtGSDictName = "GS";
   sAppStream << "/" << sExtGSDictName << " gs ";
 
-  sAppStream << GetColorStringWithDefault(pAnnotDict,
+  sAppStream << GetColorStringWithDefault(pAnnotDict->GetArrayBy("C"),
                                           CPVT_Color(CPVT_Color::kRGB, 0, 0, 0),
                                           PaintOperation::STROKE);
 
   CFX_FloatRect rect = pAnnotDict->GetRectBy("Rect");
   rect.Normalize();
 
   FX_FLOAT fLineWidth = 1.0;
   sAppStream << fLineWidth << " w ";
 
   const FX_FLOAT fDelta = 2.0;
@@ skipping 30 matching lines @@
                                           CPDF_Dictionary* pAnnotDict) {
   // If AP dictionary exists, we use the appearance defined in the
   // existing AP dictionary.
   if (pAnnotDict->KeyExist("AP"))
     return false;
 
   CFX_ByteTextBuf sAppStream;
   CFX_ByteString sExtGSDictName = "GS";
   sAppStream << "/" << sExtGSDictName << " gs ";
 
-  sAppStream << GetColorStringWithDefault(pAnnotDict,
+  sAppStream << GetColorStringWithDefault(pAnnotDict->GetArrayBy("C"),
                                           CPVT_Color(CPVT_Color::kRGB, 0, 0, 0),
                                           PaintOperation::STROKE);
 
   CFX_FloatRect rect = pAnnotDict->GetRectBy("Rect");
   rect.Normalize();
 
   FX_FLOAT fLineWidth = 1.0;
   FX_FLOAT fY = (rect.top + rect.bottom) / 2;
   sAppStream << fLineWidth << " w " << rect.left << " " << fY << " m "
              << rect.right << " " << fY << " l S\n";
@@ skipping 265 matching lines @@
                                                  int32_t nFontIndex,
                                                  FX_FLOAT fFontSize) {
   CFX_ByteTextBuf sRet;
   if (pFontMap) {
     CFX_ByteString sFontAlias = pFontMap->GetPDFFontAlias(nFontIndex);
     if (sFontAlias.GetLength() > 0 && fFontSize > 0)
       sRet << "/" << sFontAlias << " " << fFontSize << " Tf\n";
   }
   return sRet.MakeString();
 }