Display content of the annotation when mouse hover.

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 491 matching lines @@
   CFX_ByteTextBuf sDashStream;
 
   sDashStream << "[";
   for (size_t i = 0; i < pDashArrayCount; ++i)
     sDashStream << pDashArray->GetNumberAt(i) << " ";
   sDashStream << "] 0 d\n";
 
   return sDashStream.MakeString();
 }
 
+CFX_ByteString GetPopupContentsString(CPDF_Document* pDoc,
+                                      const CPDF_Dictionary& pAnnotDict,
+                                      CPDF_Font* pDefFont,
+                                      const CFX_ByteString& sFontName) {
+  CFX_WideString swValue(L"Author: ");

[jaepark, 2016/08/29 21:19:24]

I've deleted this line because "T" field stands for title of the annotation. As
a convention, it has the author of the annotation, but it may contain other
values.

+  swValue += pAnnotDict.GetUnicodeTextBy("T");

[Lei Zhang, 2016/08/27 02:16:53]

Do you care if GetUnicodeTextBy() returns an empty string?

[jaepark, 2016/08/29 21:19:24]

if GetUnicodeTextBy() returns empty string, we will have a blank line at the
top, and start displaying the contents from the next line. This is what Acrobat
Reader does.

+  swValue += L'\n';
+  swValue += pAnnotDict.GetUnicodeTextBy("Contents");

[Lei Zhang, 2016/08/27 02:16:53]

Similarly, if there's no content, do you still want the carriage return from the
line above?

[jaepark, 2016/08/29 21:19:24]

If there is no content, PopupAnnot should not be created. I've updated the CL.

+  CPVT_FontMap map(pDoc, nullptr, pDefFont, sFontName);
+
+  CPDF_VariableText vt;
+  CPDF_VariableText::Provider prd(&map);
+  vt.SetProvider(&prd);

[Lei Zhang, 2016/08/27 02:16:53]

The objects are destroyed in the reverse order of their declaration. So if |vt|
has a pointer to |prd|, then you should declare |prd| first. Otherwise, |prd|
gets destroyed first and |vt| is left with a dangling pointer.

[jaepark, 2016/08/29 21:19:24]

Done.

+  CFX_FloatRect rect = pAnnotDict.GetRectBy("Rect");

[Lei Zhang, 2016/08/27 02:16:53]

Drop the variable and merge with the next line?

[jaepark, 2016/08/29 21:19:24]

Done.

+  vt.SetPlateRect(rect);
+  vt.SetFontSize(12);
+  vt.SetAutoReturn(TRUE);
+  vt.SetMultiLine(TRUE);
+
+  vt.Initialize();
+  vt.SetText(swValue.c_str());
+  vt.RearrangeAll();
+  CFX_FloatPoint ptOffset(3.0f, -3.0f);
+  CFX_ByteString sContent = CPVT_GenerateAP::GenerateEditAP(
+      &map, vt.GetIterator(), ptOffset, FALSE, 0);
+
+  if (sContent.IsEmpty())
+    return CFX_ByteString();
+
+  CFX_ByteTextBuf sAppStream;
+  sAppStream << "BT\n"
+             << CPVT_GenerateAP::GenerateColorAP(
+                    CPVT_Color(CPVT_Color::kRGB, 0, 0, 0), PaintOperation::FILL)
+             << sContent << "ET\n"
+             << "Q\n";
+  return sAppStream.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);
   pGSDict->SetAtBoolean("AIS", false);
   pGSDict->SetAtString("BM", sBlendMode);
 
   CPDF_Dictionary* pExtGStateDict = new CPDF_Dictionary;
   pExtGStateDict->SetAt(sExtGSDictName, pGSDict);
 
   return pExtGStateDict;
 }
 
-// Takes ownership of |pExtGStateDict|.
+CPDF_Dictionary* GenerateResourceFontDict(CPDF_Document* pDoc,
+                                          const CFX_ByteString& sFontDictName) {
+  CPDF_Dictionary* pFontDict = new CPDF_Dictionary;
+  pFontDict->SetAtName("Type", "Font");
+  pFontDict->SetAtName("Subtype", "Type1");
+  pFontDict->SetAtName("BaseFont", "Helvetica");
+  pFontDict->SetAtName("Encoding", "WinAnsiEncoding");
+  pDoc->AddIndirectObject(pFontDict);
+
+  CPDF_Dictionary* pResourceFontDict = new CPDF_Dictionary;
+  pResourceFontDict->SetAtReference(sFontDictName, pDoc, pFontDict);
+
+  return pResourceFontDict;
+}
+
+// Takes ownership of |pExtGStateDict| and |pResourceFontDict|.
+CPDF_Dictionary* GenerateResourceDict(CPDF_Dictionary* pExtGStateDict,
+                                      CPDF_Dictionary* pResourceFontDict) {
+  CPDF_Dictionary* pResourceDict = new CPDF_Dictionary;
+  if (pExtGStateDict)
+    pResourceDict->SetAt("ExtGState", pExtGStateDict);
+
+  if (pResourceFontDict)
+    pResourceDict->SetAt("Font", pResourceFontDict);
+
+  return pResourceDict;
+}
+
+// Takes ownership of |pResourceDict|.
 void GenerateAndSetAPDict(CPDF_Document* pDoc,
                           CPDF_Dictionary* pAnnotDict,
                           const CFX_ByteTextBuf& sAppStream,
-                          CPDF_Dictionary* pExtGStateDict) {
+                          CPDF_Dictionary* pResourceDict) {
   CPDF_Dictionary* pAPDict = new CPDF_Dictionary;
   pAnnotDict->SetAt("AP", pAPDict);
 
   CPDF_Stream* pNormalStream = new CPDF_Stream(nullptr, 0, nullptr);
   int32_t objnum = pDoc->AddIndirectObject(pNormalStream);
   pAnnotDict->GetDictBy("AP")->SetAtReference("N", pDoc, objnum);
 
   pNormalStream->SetData(sAppStream.GetBuffer(), sAppStream.GetSize(), FALSE,
                          FALSE);
 
   CPDF_Dictionary* pStreamDict = pNormalStream->GetDict();
   pStreamDict->SetAtInteger("FormType", 1);
   pStreamDict->SetAtString("Subtype", "Form");
   pStreamDict->SetAtMatrix("Matrix", CFX_Matrix());
 
   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";
 }
 
 CFX_ByteString GenerateTextSymbolAP(const CFX_FloatRect& rect) {
@@ skipping 168 matching lines @@
   // Fourth Bezier Curve
   sAppStream << rect.left << " " << fMiddleY + fDeltaY << " "
              << fMiddleX - fDeltaX << " " << rect.top << " " << fMiddleX << " "
              << rect.top << " c\n";
 
   bool bIsFillRect = pInteriorColor && !pInteriorColor->IsEmpty();
   sAppStream << GetPaintOperatorString(bIsStrokeRect, bIsFillRect) << "\n";
 
   CPDF_Dictionary* pExtGStateDict =
       GenerateExtGStateDict(*pAnnotDict, sExtGSDictName, "Normal");
-  GenerateAndSetAPDict(pDoc, pAnnotDict, sAppStream, pExtGStateDict);
+  CPDF_Dictionary* pResourceDict =
+      GenerateResourceDict(pExtGStateDict, nullptr);
+  GenerateAndSetAPDict(pDoc, pAnnotDict, sAppStream, pResourceDict);
   return true;
 }
 
 bool CPVT_GenerateAP::GenerateHighlightAP(CPDF_Document* pDoc,
                                           CPDF_Dictionary* pAnnotDict) {
   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);
+  CPDF_Dictionary* pResourceDict =
+      GenerateResourceDict(pExtGStateDict, nullptr);
+  GenerateAndSetAPDict(pDoc, pAnnotDict, sAppStream, pResourceDict);
 
   return true;
 }
 
 bool CPVT_GenerateAP::GenerateInkAP(CPDF_Document* pDoc,
                                     CPDF_Dictionary* pAnnotDict) {
   if (!ShouldGenerateAPForAnnotation(pAnnotDict))
     return false;
 
   FX_FLOAT fBorderWidth = GetBorderWidth(*pAnnotDict);
@@ skipping 34 matching lines @@
     for (size_t j = 0; j < pInkCoordList->GetCount() - 1; j += 2) {
       sAppStream << pInkCoordList->GetNumberAt(j) << " "
                  << pInkCoordList->GetNumberAt(j + 1) << " l ";
     }
 
     sAppStream << "S\n";
   }
 
   CPDF_Dictionary* pExtGStateDict =
       GenerateExtGStateDict(*pAnnotDict, sExtGSDictName, "Normal");
-  GenerateAndSetAPDict(pDoc, pAnnotDict, sAppStream, pExtGStateDict);
+  CPDF_Dictionary* pResourceDict =
+      GenerateResourceDict(pExtGStateDict, nullptr);
+  GenerateAndSetAPDict(pDoc, pAnnotDict, sAppStream, pResourceDict);
   return true;
 }
 
 bool CPVT_GenerateAP::GenerateTextAP(CPDF_Document* pDoc,
                                      CPDF_Dictionary* pAnnotDict) {
   if (!ShouldGenerateAPForAnnotation(pAnnotDict))
     return false;
 
   CFX_ByteTextBuf sAppStream;
   CFX_ByteString sExtGSDictName = "GS";
   sAppStream << "/" << sExtGSDictName << " gs ";
 
   CFX_FloatRect rect = pAnnotDict->GetRectBy("Rect");
   const FX_FLOAT fNoteLength = 20;
   CFX_FloatRect noteRect(rect.left, rect.bottom, rect.left + fNoteLength,
                          rect.bottom + fNoteLength);
   pAnnotDict->SetAtRect("Rect", noteRect);
 
   sAppStream << GenerateTextSymbolAP(noteRect);
 
   CPDF_Dictionary* pExtGStateDict =
       GenerateExtGStateDict(*pAnnotDict, sExtGSDictName, "Normal");
-  GenerateAndSetAPDict(pDoc, pAnnotDict, sAppStream, pExtGStateDict);
-
+  CPDF_Dictionary* pResourceDict =
+      GenerateResourceDict(pExtGStateDict, nullptr);
+  GenerateAndSetAPDict(pDoc, pAnnotDict, sAppStream, pResourceDict);
   return true;
 }
 
 bool CPVT_GenerateAP::GenerateUnderlineAP(CPDF_Document* pDoc,
                                           CPDF_Dictionary* pAnnotDict) {
   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);
+  CPDF_Dictionary* pResourceDict =
+      GenerateResourceDict(pExtGStateDict, nullptr);
+  GenerateAndSetAPDict(pDoc, pAnnotDict, sAppStream, pResourceDict);
   return true;
 }
 
+bool CPVT_GenerateAP::GeneratePopupAP(CPDF_Document* pDoc,
+                                      CPDF_Dictionary* pAnnotDict) {
+  CFX_ByteTextBuf sAppStream;
+  CFX_ByteString sExtGSDictName = "GS";
+  sAppStream << "/" << sExtGSDictName << " gs\n";
+
+  sAppStream << GenerateColorAP(CPVT_Color(CPVT_Color::kRGB, 1, 1, 0),
+                                PaintOperation::FILL);
+  sAppStream << GenerateColorAP(CPVT_Color(CPVT_Color::kRGB, 0, 0, 0),
+                                PaintOperation::STROKE);
+
+  CFX_FloatRect rect = pAnnotDict->GetRectBy("Rect");
+  rect.Normalize();
+
+  sAppStream << rect.left << " " << rect.bottom << " " << rect.Width() << " "
+             << rect.Height() << " re "
+             << "b\n";

[Lei Zhang, 2016/08/27 02:16:53]

merge into previous line? i.e. << " re b\n";

[jaepark, 2016/08/29 21:19:24]

Done.

+
+  CFX_ByteString sFontName = "FONT";
+  CPDF_Dictionary* pExtGStateDict =
+      GenerateExtGStateDict(*pAnnotDict, sExtGSDictName, "Normal");
+  CPDF_Dictionary* pResourceFontDict =
+      GenerateResourceFontDict(pDoc, sFontName);
+  CPDF_Dictionary* pResourceDict =
+      GenerateResourceDict(pResourceFontDict, pExtGStateDict);
+
+  CPDF_Font* pDefFont = pDoc->LoadFont(pResourceFontDict);
+  if (!pDefFont)
+    return false;
+
+  sAppStream << GetPopupContentsString(pDoc, *pAnnotDict, pDefFont, sFontName);
+  GenerateAndSetAPDict(pDoc, pAnnotDict, sAppStream, pResourceDict);
+  return true;
+}
+
 bool CPVT_GenerateAP::GenerateSquareAP(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");
@@ skipping 24 matching lines @@
   }
 
   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);
+  CPDF_Dictionary* pResourceDict =
+      GenerateResourceDict(pExtGStateDict, nullptr);
+  GenerateAndSetAPDict(pDoc, pAnnotDict, sAppStream, pResourceDict);
   return true;
 }
 
 bool CPVT_GenerateAP::GenerateSquigglyAP(CPDF_Document* pDoc,
                                          CPDF_Dictionary* pAnnotDict) {
   if (!ShouldGenerateAPForAnnotation(pAnnotDict))
     return false;
 
   CFX_ByteTextBuf sAppStream;
   CFX_ByteString sExtGSDictName = "GS";
@@ skipping 28 matching lines @@
   FX_FLOAT fRemainder = rect.right - (fX - fDelta);
   if (isUpwards)
     sAppStream << rect.right << " " << fBottom + fRemainder << " l ";
   else
     sAppStream << rect.right << " " << fTop - fRemainder << " l ";
 
   sAppStream << "S\n";
 
   CPDF_Dictionary* pExtGStateDict =
       GenerateExtGStateDict(*pAnnotDict, sExtGSDictName, "Normal");
-  GenerateAndSetAPDict(pDoc, pAnnotDict, sAppStream, pExtGStateDict);
+  CPDF_Dictionary* pResourceDict =
+      GenerateResourceDict(pExtGStateDict, nullptr);
+  GenerateAndSetAPDict(pDoc, pAnnotDict, sAppStream, pResourceDict);
   return true;
 }
 
 bool CPVT_GenerateAP::GenerateStrikeOutAP(CPDF_Document* pDoc,
                                           CPDF_Dictionary* pAnnotDict) {
   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;
   FX_FLOAT fY = (rect.top + rect.bottom) / 2;
   sAppStream << fLineWidth << " w " << rect.left << " " << fY << " m "
              << rect.right << " " << fY << " l S\n";
 
   CPDF_Dictionary* pExtGStateDict =
       GenerateExtGStateDict(*pAnnotDict, sExtGSDictName, "Normal");
-  GenerateAndSetAPDict(pDoc, pAnnotDict, sAppStream, pExtGStateDict);
+  CPDF_Dictionary* pResourceDict =
+      GenerateResourceDict(pExtGStateDict, nullptr);
+  GenerateAndSetAPDict(pDoc, pAnnotDict, sAppStream, pResourceDict);
   return true;
 }
 
 // Static.
 CFX_ByteString CPVT_GenerateAP::GenerateEditAP(
     IPVT_FontMap* pFontMap,
     CPDF_VariableText::Iterator* pIterator,
     const CFX_FloatPoint& ptOffset,
     FX_BOOL bContinuous,
     uint16_t SubWord) {
@@ skipping 251 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();
 }