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,
                                          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");
+  }
+
+  if (CPDF_Array* pBorderArray = pAnnotDict.GetArrayBy("Border")) {
+    if (pBorderArray->GetCount() > 2)
+      return pBorderArray->GetNumberAt(2);
+  }
+
+  return 1;
+}
+
+CFX_ByteString GetDashPatternString(const CPDF_Dictionary& pAnnotDict) {
+  CPDF_Array* pDashArray = nullptr;
+
+  if (CPDF_Array* pBorderArray = pAnnotDict.GetArrayBy("Border")) {
+    if (pBorderArray->GetCount() == 4)
+      pDashArray = pBorderArray->GetArrayAt(3);
+  }
+
+  if (CPDF_Dictionary* pBorderStyleDict = pAnnotDict.GetDictBy("BS")) {
+    if (pBorderStyleDict->GetStringBy("S") == "D")
+      pDashArray = pBorderStyleDict->GetArrayBy("D");

[Lei Zhang, 2016/08/06 00:10:37]

Now "BS" has priority over "Border" if they both exist.

[jaepark, 2016/08/08 17:17:27]

I might be mistaken, but isn't this what we wanted? For GetBorderWidth, "BS"
also has priority over "Border" if they both exist.

[Lei Zhang, 2016/08/08 22:24:45]

Oh, I missed the part where you checked "Border" first here.

So this function checks "Border" first and throws away the result if "BS" has
the entry with priority. Can we instead write:

CPDF_Array* pDashArray = nullptr;
// Check "BS"
if (!pDashArray) {
  // Check "Border"
}

so it does not have to check both dictionaries if they are both present?

[jaepark, 2016/08/08 23:07:39]

I've modified it to use GetDashArray, a new function similar to GetBorderWidth.
How's this?

+  }
+
+  if (!pDashArray)
+    return CFX_ByteString();
+
+  size_t pDashArrayCount = pDashArray->GetCount();
+  if (pDashArrayCount == 0 || pDashArrayCount > 10)
+    return CFX_ByteString();
+
+  CFX_ByteTextBuf sDashStream;
+  sDashStream << "[";
+  for (size_t i = 0; i < pDashArrayCount; ++i)
+    sDashStream << pDashArray->GetNumberAt(i) << " ";
+  sDashStream << "] 0 d\n";
+
+  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 28 matching lines @@
 
   CFX_FloatRect rect = pAnnotDict->GetRectBy("Rect");
   pStreamDict->SetAtRect("BBox", rect);
 
   CPDF_Dictionary* pResourceDict = new CPDF_Dictionary;
   pResourceDict->SetAt("ExtGState", pExtGStateDict);
 
   pStreamDict->SetAt("Resources", pResourceDict);
 }
 
+CFX_ByteString GetPaintOperatorString(bool bIsStrokeRect, bool bIsFillRect) {
+  if (bIsStrokeRect)
+    return bIsFillRect ? "b" : "s";
+  return bIsFillRect ? "f" : "n";
+}
+
 }  // namespace
 
 bool FPDF_GenerateAP(CPDF_Document* pDoc, CPDF_Dictionary* pAnnotDict) {
   if (!pAnnotDict || pAnnotDict->GetStringBy("Subtype") != "Widget")
     return false;
 
   CFX_ByteString field_type = FPDF_GetFieldAttr(pAnnotDict, "FT")->GetString();
   uint32_t flags = FPDF_GetFieldAttr(pAnnotDict, "Ff")
                        ? FPDF_GetFieldAttr(pAnnotDict, "Ff")->GetInteger()
                        : 0;
@@ skipping 41 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 ";
+
+  CPDF_Array* pInteriorColor = pAnnotDict->GetArrayBy("IC");
+  sAppStream << GetColorStringWithDefault(pInteriorColor,
+                                          CPVT_Color(CPVT_Color::kTransparent),
+                                          PaintOperation::FILL);
+
+  sAppStream << GetColorStringWithDefault(pAnnotDict->GetArrayBy("C"),
+                                          CPVT_Color(CPVT_Color::kRGB, 0, 0, 0),
+                                          PaintOperation::STROKE);
+
+  FX_FLOAT fBorderWidth = GetBorderWidth(*pAnnotDict);
+  sAppStream << fBorderWidth << " w ";
+
+  sAppStream << GetDashPatternString(*pAnnotDict);
+
+  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);
+
+  bool bIsStrokeRect = fBorderWidth > 0;
+  bool bIsFillRect = pInteriorColor && (pInteriorColor->GetCount() > 0);
+
+  sAppStream << rect.left << " " << rect.bottom << " " << rect.Width() << " "
+             << rect.Height() << " re "
+             << GetPaintOperatorString(bIsStrokeRect, bIsFillRect) << "\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();
 }