Hidden annotations should not be drawn

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"
 #include "core/fpdfapi/fpdf_parser/include/cpdf_document.h"
 #include "core/fpdfapi/fpdf_parser/include/cpdf_simple_parser.h"
 #include "core/fpdfapi/fpdf_parser/include/cpdf_stream.h"
 #include "core/fpdfapi/fpdf_parser/include/fpdf_parser_decode.h"
 #include "core/fpdfdoc/cpvt_color.h"
 #include "core/fpdfdoc/cpvt_fontmap.h"
+#include "core/fpdfdoc/include/cpdf_annot.h"
 #include "core/fpdfdoc/include/cpdf_formfield.h"
 #include "core/fpdfdoc/include/cpvt_word.h"
 
 namespace {
 
 bool GenerateWidgetAP(CPDF_Document* pDoc,
                       CPDF_Dictionary* pAnnotDict,
                       const int32_t& nWidgetType) {
   CPDF_Dictionary* pFormDict = nullptr;
   if (CPDF_Dictionary* pRootDict = pDoc->GetRoot())
@@ skipping 585 matching lines @@
   return GenerateWidgetAP(pDoc, pAnnotDict, 0);
 }
 
 bool CPVT_GenerateAP::GenerateCircleAP(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;
 
+  uint32_t flags = pAnnotDict->GetIntegerBy("F");
+  if (flags & ANNOTFLAG_HIDDEN)
+    return false;
+

[jaepark, 2016/08/11 21:39:20]

Wouldn't the annotation still be drawn if it has an existing AP dictionary?

   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"),
@@ skipping 56 matching lines @@
   return true;
 }
 
 bool CPVT_GenerateAP::GenerateHighlightAP(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;
 
+  uint32_t flags = pAnnotDict->GetIntegerBy("F");
+  if (flags & ANNOTFLAG_HIDDEN)
+    return false;
+
   CFX_ByteTextBuf sAppStream;
   CFX_ByteString sExtGSDictName = "GS";
   sAppStream << "/" << sExtGSDictName << " gs ";
 
   sAppStream << GetColorStringWithDefault(pAnnotDict->GetArrayBy("C"),
                                           CPVT_Color(CPVT_Color::kRGB, 1, 1, 0),
                                           PaintOperation::FILL);
 
   CFX_FloatRect rect = pAnnotDict->GetRectBy("Rect");
   rect.Normalize();
@@ skipping 10 matching lines @@
   return true;
 }
 
 bool CPVT_GenerateAP::GenerateInkAP(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;
 
+  uint32_t flags = pAnnotDict->GetIntegerBy("F");
+  if (flags & ANNOTFLAG_HIDDEN)
+    return false;
+
   FX_FLOAT fBorderWidth = GetBorderWidth(*pAnnotDict);
   bool bIsStroke = fBorderWidth > 0;
 
   if (!bIsStroke)
     return false;
 
   CPDF_Array* pInkList = pAnnotDict->GetArrayBy("InkList");
   if (!pInkList || pInkList->IsEmpty())
     return false;
 
@@ skipping 36 matching lines @@
   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;
 
+  uint32_t flags = pAnnotDict->GetIntegerBy("F");
+  if (flags & ANNOTFLAG_HIDDEN)

[dsinclair, 2016/08/12 03:06:58]

if flags is just used in the if no need to store it to a temporary.

if (pAnnotDict->GetIntegerBy("F") & ANNOTFLAG_HIDDEN).

Actually, it maybe worth adding a short helper so these just become

if (!AnnotationsVisible(pAnnotDict))

or something like that.

+    return false;
+
   CFX_ByteTextBuf sAppStream;
   CFX_ByteString sExtGSDictName = "GS";
   sAppStream << "/" << sExtGSDictName << " gs ";
 
   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;
 
+  uint32_t flags = pAnnotDict->GetIntegerBy("F");
+  if (flags & ANNOTFLAG_HIDDEN)
+    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"),
@@ skipping 30 matching lines @@
   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;
 
+  uint32_t flags = pAnnotDict->GetIntegerBy("F");
+  if (flags & ANNOTFLAG_HIDDEN)
+    return false;
+
   CFX_ByteTextBuf sAppStream;
   CFX_ByteString sExtGSDictName = "GS";
   sAppStream << "/" << sExtGSDictName << " gs ";
 
   sAppStream << GetColorStringWithDefault(pAnnotDict->GetArrayBy("C"),
                                           CPVT_Color(CPVT_Color::kRGB, 0, 0, 0),
                                           PaintOperation::STROKE);
 
   CFX_FloatRect rect = pAnnotDict->GetRectBy("Rect");
   rect.Normalize();
@@ skipping 31 matching lines @@
   return true;
 }
 
 bool CPVT_GenerateAP::GenerateStrikeOutAP(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;
 
+  uint32_t flags = pAnnotDict->GetIntegerBy("F");
+  if (flags & ANNOTFLAG_HIDDEN)
+    return false;
+
   CFX_ByteTextBuf sAppStream;
   CFX_ByteString sExtGSDictName = "GS";
   sAppStream << "/" << sExtGSDictName << " gs ";
 
   sAppStream << GetColorStringWithDefault(pAnnotDict->GetArrayBy("C"),
                                           CPVT_Color(CPVT_Color::kRGB, 0, 0, 0),
                                           PaintOperation::STROKE);
 
   CFX_FloatRect rect = pAnnotDict->GetRectBy("Rect");
   rect.Normalize();
@@ skipping 270 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();
 }