Port https://codereview.chromium.org/398163006 to gn.
[pdfium.git] / core / src / fpdfdoc / doc_annot.cpp
1 // Copyright 2014 PDFium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
4
5 // Original code copyright 2014 Foxit Software Inc. http://www.foxitsoftware.com
6
7 #include "../../../third_party/base/nonstd_unique_ptr.h"
8 #include "../../include/fpdfdoc/fpdf_doc.h"
9 #include "../../include/fpdfapi/fpdf_pageobj.h"
10
11 CPDF_AnnotList::CPDF_AnnotList(CPDF_Page* pPage) {
12   ASSERT(pPage != NULL);
13   m_pPageDict = pPage->m_pFormDict;
14   if (m_pPageDict == NULL) {
15     return;
16   }
17   m_pDocument = pPage->m_pDocument;
18   CPDF_Array* pAnnots = m_pPageDict->GetArray("Annots");
19   if (pAnnots == NULL) {
20     return;
21   }
22   CPDF_Dictionary* pRoot = m_pDocument->GetRoot();
23   CPDF_Dictionary* pAcroForm = pRoot->GetDict("AcroForm");
24   FX_BOOL bRegenerateAP = pAcroForm && pAcroForm->GetBoolean("NeedAppearances");
25   for (FX_DWORD i = 0; i < pAnnots->GetCount(); ++i) {
26     CPDF_Dictionary* pDict = ToDictionary(pAnnots->GetElementValue(i));
27     if (!pDict) {
28       continue;
29     }
30     FX_DWORD dwObjNum = pDict->GetObjNum();
31     if (dwObjNum == 0) {
32       dwObjNum = m_pDocument->AddIndirectObject(pDict);
33       CPDF_Reference* pAction = new CPDF_Reference(m_pDocument, dwObjNum);
34       pAnnots->InsertAt(i, pAction);
35       pAnnots->RemoveAt(i + 1);
36       pDict = pAnnots->GetDict(i);
37     }
38     CPDF_Annot* pAnnot = new CPDF_Annot(pDict, this);
39     m_AnnotList.Add(pAnnot);
40     if (bRegenerateAP &&
41         pDict->GetConstString(FX_BSTRC("Subtype")) == FX_BSTRC("Widget"))
42       if (CPDF_InterForm::UpdatingAPEnabled()) {
43         FPDF_GenerateAP(m_pDocument, pDict);
44       }
45   }
46 }
47 CPDF_AnnotList::~CPDF_AnnotList() {
48   int i = 0;
49   for (i = 0; i < m_AnnotList.GetSize(); ++i) {
50     delete (CPDF_Annot*)m_AnnotList[i];
51   }
52   for (i = 0; i < m_Borders.GetSize(); ++i) {
53     delete (CPDF_PageObjects*)m_Borders[i];
54   }
55 }
56 void CPDF_AnnotList::DisplayPass(const CPDF_Page* pPage,
57                                  CFX_RenderDevice* pDevice,
58                                  CPDF_RenderContext* pContext,
59                                  FX_BOOL bPrinting,
60                                  CFX_AffineMatrix* pMatrix,
61                                  FX_BOOL bWidgetPass,
62                                  CPDF_RenderOptions* pOptions,
63                                  FX_RECT* clip_rect) {
64   for (int i = 0; i < m_AnnotList.GetSize(); ++i) {
65     CPDF_Annot* pAnnot = (CPDF_Annot*)m_AnnotList[i];
66     FX_BOOL bWidget = pAnnot->GetSubType() == "Widget";
67     if ((bWidgetPass && !bWidget) || (!bWidgetPass && bWidget)) {
68       continue;
69     }
70     FX_DWORD annot_flags = pAnnot->GetFlags();
71     if (annot_flags & ANNOTFLAG_HIDDEN) {
72       continue;
73     }
74     if (bPrinting && (annot_flags & ANNOTFLAG_PRINT) == 0) {
75       continue;
76     }
77     if (!bPrinting && (annot_flags & ANNOTFLAG_NOVIEW)) {
78       continue;
79     }
80     if (pOptions != NULL) {
81       IPDF_OCContext* pOCContext = pOptions->m_pOCContext;
82       CPDF_Dictionary* pAnnotDict = pAnnot->GetAnnotDict();
83       if (pOCContext != NULL && pAnnotDict != NULL &&
84           !pOCContext->CheckOCGVisible(pAnnotDict->GetDict(FX_BSTRC("OC")))) {
85         continue;
86       }
87     }
88     CPDF_Rect annot_rect_f;
89     pAnnot->GetRect(annot_rect_f);
90     CFX_Matrix matrix;
91     matrix = *pMatrix;
92     if (clip_rect) {
93       annot_rect_f.Transform(&matrix);
94       FX_RECT annot_rect = annot_rect_f.GetOutterRect();
95       annot_rect.Intersect(*clip_rect);
96       if (annot_rect.IsEmpty()) {
97         continue;
98       }
99     }
100     if (pContext) {
101       pAnnot->DrawInContext(pPage, pContext, &matrix, CPDF_Annot::Normal);
102     } else if (!pAnnot->DrawAppearance(pPage, pDevice, &matrix,
103                                        CPDF_Annot::Normal, pOptions)) {
104       pAnnot->DrawBorder(pDevice, &matrix, pOptions);
105     }
106   }
107 }
108 void CPDF_AnnotList::DisplayAnnots(const CPDF_Page* pPage,
109                                    CFX_RenderDevice* pDevice,
110                                    CFX_AffineMatrix* pUser2Device,
111                                    FX_BOOL bShowWidget,
112                                    CPDF_RenderOptions* pOptions) {
113   FX_RECT clip_rect;
114   if (pDevice) {
115     clip_rect = pDevice->GetClipBox();
116   }
117   FX_BOOL bPrinting = pDevice->GetDeviceClass() == FXDC_PRINTER ||
118                       (pOptions && (pOptions->m_Flags & RENDER_PRINTPREVIEW));
119   DisplayAnnots(pPage, pDevice, NULL, bPrinting, pUser2Device,
120                 bShowWidget ? 3 : 1, pOptions, &clip_rect);
121 }
122 void CPDF_AnnotList::DisplayAnnots(const CPDF_Page* pPage,
123                                    CFX_RenderDevice* pDevice,
124                                    CPDF_RenderContext* pContext,
125                                    FX_BOOL bPrinting,
126                                    CFX_AffineMatrix* pUser2Device,
127                                    FX_DWORD dwAnnotFlags,
128                                    CPDF_RenderOptions* pOptions,
129                                    FX_RECT* pClipRect) {
130   if (dwAnnotFlags & 0x01) {
131     DisplayPass(pPage, pDevice, pContext, bPrinting, pUser2Device, FALSE,
132                 pOptions, pClipRect);
133   }
134   if (dwAnnotFlags & 0x02) {
135     DisplayPass(pPage, pDevice, pContext, bPrinting, pUser2Device, TRUE,
136                 pOptions, pClipRect);
137   }
138 }
139 int CPDF_AnnotList::GetIndex(CPDF_Annot* pAnnot) {
140   for (int i = 0; i < m_AnnotList.GetSize(); ++i)
141     if (m_AnnotList[i] == (void*)pAnnot) {
142       return i;
143     }
144   return -1;
145 }
146 CPDF_Annot::CPDF_Annot(CPDF_Dictionary* pDict, CPDF_AnnotList* pList)
147     : m_pAnnotDict(pDict),
148       m_pList(pList),
149       m_sSubtype(m_pAnnotDict->GetConstString(FX_BSTRC("Subtype"))) {}
150 CPDF_Annot::~CPDF_Annot() {
151   ClearCachedAP();
152 }
153 void CPDF_Annot::ClearCachedAP() {
154   FX_POSITION pos = m_APMap.GetStartPosition();
155   while (pos) {
156     void* pForm;
157     void* pObjects;
158     m_APMap.GetNextAssoc(pos, pForm, pObjects);
159     delete (CPDF_PageObjects*)pObjects;
160   }
161   m_APMap.RemoveAll();
162 }
163 CFX_ByteString CPDF_Annot::GetSubType() const {
164   return m_sSubtype;
165 }
166
167 void CPDF_Annot::GetRect(CPDF_Rect& rect) const {
168   if (m_pAnnotDict == NULL) {
169     return;
170   }
171   rect = m_pAnnotDict->GetRect("Rect");
172   rect.Normalize();
173 }
174
175 FX_DWORD CPDF_Annot::GetFlags() const {
176   return m_pAnnotDict->GetInteger("F");
177 }
178
179 CPDF_Dictionary* CPDF_Annot::GetAnnotDict() {
180   return m_pAnnotDict;
181 }
182
183 CPDF_Stream* FPDFDOC_GetAnnotAP(CPDF_Dictionary* pAnnotDict,
184                                 CPDF_Annot::AppearanceMode mode) {
185   CPDF_Dictionary* pAP = pAnnotDict->GetDict("AP");
186   if (pAP == NULL) {
187     return NULL;
188   }
189   const FX_CHAR* ap_entry = "N";
190   if (mode == CPDF_Annot::Down)
191     ap_entry = "D";
192   else if (mode == CPDF_Annot::Rollover)
193     ap_entry = "R";
194   if (!pAP->KeyExist(ap_entry))
195     ap_entry = "N";
196
197   CPDF_Object* psub = pAP->GetElementValue(ap_entry);
198   if (!psub)
199     return nullptr;
200   if (CPDF_Stream* pStream = psub->AsStream())
201     return pStream;
202
203   if (CPDF_Dictionary* pDict = psub->AsDictionary()) {
204     CFX_ByteString as = pAnnotDict->GetString("AS");
205     if (as.IsEmpty()) {
206       CFX_ByteString value = pAnnotDict->GetString(FX_BSTRC("V"));
207       if (value.IsEmpty()) {
208         CPDF_Dictionary* pDict = pAnnotDict->GetDict(FX_BSTRC("Parent"));
209         value = pDict ? pDict->GetString(FX_BSTRC("V")) : CFX_ByteString();
210       }
211       if (value.IsEmpty() || !pDict->KeyExist(value))
212         as = FX_BSTRC("Off");
213       else
214         as = value;
215     }
216     return pDict->GetStream(as);
217   }
218   return nullptr;
219 }
220 CPDF_Form* CPDF_Annot::GetAPForm(const CPDF_Page* pPage, AppearanceMode mode) {
221   CPDF_Stream* pStream = FPDFDOC_GetAnnotAP(m_pAnnotDict, mode);
222   if (pStream == NULL) {
223     return NULL;
224   }
225   CPDF_Form* pForm;
226   if (m_APMap.Lookup(pStream, (void*&)pForm)) {
227     return pForm;
228   }
229   pForm = new CPDF_Form(m_pList->m_pDocument, pPage->m_pResources, pStream);
230   pForm->ParseContent(NULL, NULL, NULL, NULL);
231   m_APMap.SetAt(pStream, pForm);
232   return pForm;
233 }
234 static CPDF_Form* FPDFDOC_Annot_GetMatrix(const CPDF_Page* pPage,
235                                           CPDF_Annot* pAnnot,
236                                           CPDF_Annot::AppearanceMode mode,
237                                           const CFX_AffineMatrix* pUser2Device,
238                                           CFX_Matrix& matrix) {
239   CPDF_Form* pForm = pAnnot->GetAPForm(pPage, mode);
240   if (!pForm) {
241     return NULL;
242   }
243   CFX_FloatRect form_bbox = pForm->m_pFormDict->GetRect(FX_BSTRC("BBox"));
244   CFX_Matrix form_matrix = pForm->m_pFormDict->GetMatrix(FX_BSTRC("Matrix"));
245   form_matrix.TransformRect(form_bbox);
246   CPDF_Rect arect;
247   pAnnot->GetRect(arect);
248   matrix.MatchRect(arect, form_bbox);
249   matrix.Concat(*pUser2Device);
250   return pForm;
251 }
252 FX_BOOL CPDF_Annot::DrawAppearance(const CPDF_Page* pPage,
253                                    CFX_RenderDevice* pDevice,
254                                    const CFX_AffineMatrix* pUser2Device,
255                                    AppearanceMode mode,
256                                    const CPDF_RenderOptions* pOptions) {
257   CFX_Matrix matrix;
258   CPDF_Form* pForm =
259       FPDFDOC_Annot_GetMatrix(pPage, this, mode, pUser2Device, matrix);
260   if (!pForm) {
261     return FALSE;
262   }
263   CPDF_RenderContext context;
264   context.Create((CPDF_Page*)pPage);
265   context.DrawObjectList(pDevice, pForm, &matrix, pOptions);
266   return TRUE;
267 }
268 FX_BOOL CPDF_Annot::DrawInContext(const CPDF_Page* pPage,
269                                   const CPDF_RenderContext* pContext,
270                                   const CFX_AffineMatrix* pUser2Device,
271                                   AppearanceMode mode) {
272   CFX_Matrix matrix;
273   CPDF_Form* pForm =
274       FPDFDOC_Annot_GetMatrix(pPage, this, mode, pUser2Device, matrix);
275   if (!pForm) {
276     return FALSE;
277   }
278   ((CPDF_RenderContext*)pContext)->AppendObjectList(pForm, &matrix);
279   return TRUE;
280 }
281 void CPDF_Annot::DrawBorder(CFX_RenderDevice* pDevice,
282                             const CFX_AffineMatrix* pUser2Device,
283                             const CPDF_RenderOptions* pOptions) {
284   if (GetSubType() == "Popup") {
285     return;
286   }
287   FX_DWORD annot_flags = GetFlags();
288   if (annot_flags & ANNOTFLAG_HIDDEN) {
289     return;
290   }
291   FX_BOOL bPrinting = pDevice->GetDeviceClass() == FXDC_PRINTER ||
292                       (pOptions && (pOptions->m_Flags & RENDER_PRINTPREVIEW));
293   if (bPrinting && (annot_flags & ANNOTFLAG_PRINT) == 0) {
294     return;
295   }
296   if (!bPrinting && (annot_flags & ANNOTFLAG_NOVIEW)) {
297     return;
298   }
299   CPDF_Dictionary* pBS = m_pAnnotDict->GetDict("BS");
300   char style_char;
301   FX_FLOAT width;
302   CPDF_Array* pDashArray = NULL;
303   if (pBS == NULL) {
304     CPDF_Array* pBorderArray = m_pAnnotDict->GetArray("Border");
305     style_char = 'S';
306     if (pBorderArray) {
307       width = pBorderArray->GetNumber(2);
308       if (pBorderArray->GetCount() == 4) {
309         pDashArray = pBorderArray->GetArray(3);
310         if (pDashArray == NULL) {
311           return;
312         }
313         int nLen = pDashArray->GetCount();
314         int i = 0;
315         for (; i < nLen; ++i) {
316           CPDF_Object* pObj = pDashArray->GetElementValue(i);
317           if (pObj && pObj->GetInteger()) {
318             break;
319           }
320         }
321         if (i == nLen) {
322           return;
323         }
324         style_char = 'D';
325       }
326     } else {
327       width = 1;
328     }
329   } else {
330     CFX_ByteString style = pBS->GetString("S");
331     pDashArray = pBS->GetArray("D");
332     style_char = style[1];
333     width = pBS->GetNumber("W");
334   }
335   if (width <= 0) {
336     return;
337   }
338   CPDF_Array* pColor = m_pAnnotDict->GetArray("C");
339   FX_DWORD argb = 0xff000000;
340   if (pColor != NULL) {
341     int R = (int32_t)(pColor->GetNumber(0) * 255);
342     int G = (int32_t)(pColor->GetNumber(1) * 255);
343     int B = (int32_t)(pColor->GetNumber(2) * 255);
344     argb = ArgbEncode(0xff, R, G, B);
345   }
346   CPDF_GraphStateData graph_state;
347   graph_state.m_LineWidth = width;
348   if (style_char == 'D') {
349     if (pDashArray) {
350       FX_DWORD dash_count = pDashArray->GetCount();
351       if (dash_count % 2) {
352         dash_count++;
353       }
354       graph_state.m_DashArray = FX_Alloc(FX_FLOAT, dash_count);
355       graph_state.m_DashCount = dash_count;
356       FX_DWORD i;
357       for (i = 0; i < pDashArray->GetCount(); ++i) {
358         graph_state.m_DashArray[i] = pDashArray->GetNumber(i);
359       }
360       if (i < dash_count) {
361         graph_state.m_DashArray[i] = graph_state.m_DashArray[i - 1];
362       }
363     } else {
364       graph_state.m_DashArray = FX_Alloc(FX_FLOAT, 2);
365       graph_state.m_DashCount = 2;
366       graph_state.m_DashArray[0] = graph_state.m_DashArray[1] = 3 * 1.0f;
367     }
368   }
369   CFX_FloatRect rect;
370   GetRect(rect);
371   CPDF_PathData path;
372   width /= 2;
373   path.AppendRect(rect.left + width, rect.bottom + width, rect.right - width,
374                   rect.top - width);
375   int fill_type = 0;
376   if (pOptions && (pOptions->m_Flags & RENDER_NOPATHSMOOTH)) {
377     fill_type |= FXFILL_NOPATHSMOOTH;
378   }
379   pDevice->DrawPath(&path, pUser2Device, &graph_state, argb, argb, fill_type);
380 }