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 578 matching lines @@
                                         CPDF_Dictionary* pAnnotDict) {
   return GenerateWidgetAP(pDoc, pAnnotDict, 2);
 }
 
 // Static.
 bool CPVT_GenerateAP::GenerateTextFieldAP(CPDF_Document* pDoc,
                                           CPDF_Dictionary* pAnnotDict) {
   return GenerateWidgetAP(pDoc, pAnnotDict, 0);
 }
 
-bool CPVT_GenerateAP::GenerateCircleAP(CPDF_Document* pDoc,
-                                       CPDF_Dictionary* pAnnotDict) {
+static bool ShouldGenerateAPForAnnotation(CPDF_Dictionary* pAnnotDict) {

[Lei Zhang, 2016/08/15 19:02:10]

Move this into the anonymous namespace above and drop the "static ".

We like to group all the anonymous functions together at the top of the file,
rather than scatter them all over.

   // If AP dictionary exists, we use the appearance defined in the
   // existing AP dictionary.
   if (pAnnotDict->KeyExist("AP"))
     return false;
 
+  return !CPDF_Annot::IsAnnotationHidden(pAnnotDict);
+}
+
+bool CPVT_GenerateAP::GenerateCircleAP(CPDF_Document* pDoc,
+                                       CPDF_Dictionary* pAnnotDict) {
+  if (!ShouldGenerateAPForAnnotation(pAnnotDict))
+    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 51 matching lines @@
   sAppStream << GetPaintOperatorString(bIsStrokeRect, bIsFillRect) << "\n";
 
   CPDF_Dictionary* pExtGStateDict =
       GenerateExtGStateDict(*pAnnotDict, sExtGSDictName, "Normal");
   GenerateAndSetAPDict(pDoc, pAnnotDict, sAppStream, pExtGStateDict);
   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"))
+  if (!ShouldGenerateAPForAnnotation(pAnnotDict))
     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();
 
   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::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"))
+  if (!ShouldGenerateAPForAnnotation(pAnnotDict))
     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())
@@ skipping 33 matching lines @@
   }
 
   CPDF_Dictionary* pExtGStateDict =
       GenerateExtGStateDict(*pAnnotDict, sExtGSDictName, "Normal");
   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"))
+  if (!ShouldGenerateAPForAnnotation(pAnnotDict))
     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"))
+  if (!ShouldGenerateAPForAnnotation(pAnnotDict))
     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);
@@ skipping 27 matching lines @@
              << 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"))
+  if (!ShouldGenerateAPForAnnotation(pAnnotDict))
     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);
 
@@ skipping 28 matching lines @@
   sAppStream << "S\n";
 
   CPDF_Dictionary* pExtGStateDict =
       GenerateExtGStateDict(*pAnnotDict, sExtGSDictName, "Normal");
   GenerateAndSetAPDict(pDoc, pAnnotDict, sAppStream, pExtGStateDict);
   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"))
+  if (!ShouldGenerateAPForAnnotation(pAnnotDict))
     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);
 
@@ skipping 272 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();
 }