Revert "Revert "Add type cast definitions for CPDF_Dictionary.""
[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   }
195   if (!pAP->KeyExist(ap_entry)) {
196     ap_entry = "N";
197   }
198   CPDF_Object* psub = pAP->GetElementValue(ap_entry);
199   if (psub == NULL) {
200     return NULL;
201   }
202   CPDF_Stream* pStream = NULL;
203   if (psub->GetType() == PDFOBJ_STREAM) {
204     pStream = (CPDF_Stream*)psub;
205   } else if (CPDF_Dictionary* pDict = psub->AsDictionary()) {
206     CFX_ByteString as = pAnnotDict->GetString("AS");
207     if (as.IsEmpty()) {
208       CFX_ByteString value = pAnnotDict->GetString(FX_BSTRC("V"));
209       if (value.IsEmpty()) {
210         CPDF_Dictionary* pDict = pAnnotDict->GetDict(FX_BSTRC("Parent"));
211         value = pDict ? pDict->GetString(FX_BSTRC("V")) : CFX_ByteString();
212       }
213       if (value.IsEmpty() || !pDict->KeyExist(value)) {
214         as = FX_BSTRC("Off");
215       } else {
216         as = value;
217       }
218     }
219     pStream = pDict->GetStream(as);
220   }
221   return pStream;
222 }
223 CPDF_Form* CPDF_Annot::GetAPForm(const CPDF_Page* pPage, AppearanceMode mode) {
224   CPDF_Stream* pStream = FPDFDOC_GetAnnotAP(m_pAnnotDict, mode);
225   if (pStream == NULL) {
226     return NULL;
227   }
228   CPDF_Form* pForm;
229   if (m_APMap.Lookup(pStream, (void*&)pForm)) {
230     return pForm;
231   }
232   pForm = new CPDF_Form(m_pList->m_pDocument, pPage->m_pResources, pStream);
233   pForm->ParseContent(NULL, NULL, NULL, NULL);
234   m_APMap.SetAt(pStream, pForm);
235   return pForm;
236 }
237 static CPDF_Form* FPDFDOC_Annot_GetMatrix(const CPDF_Page* pPage,
238                                           CPDF_Annot* pAnnot,
239                                           CPDF_Annot::AppearanceMode mode,
240                                           const CFX_AffineMatrix* pUser2Device,
241                                           CFX_Matrix& matrix) {
242   CPDF_Form* pForm = pAnnot->GetAPForm(pPage, mode);
243   if (!pForm) {
244     return NULL;
245   }
246   CFX_FloatRect form_bbox = pForm->m_pFormDict->GetRect(FX_BSTRC("BBox"));
247   CFX_Matrix form_matrix = pForm->m_pFormDict->GetMatrix(FX_BSTRC("Matrix"));
248   form_matrix.TransformRect(form_bbox);
249   CPDF_Rect arect;
250   pAnnot->GetRect(arect);
251   matrix.MatchRect(arect, form_bbox);
252   matrix.Concat(*pUser2Device);
253   return pForm;
254 }
255 FX_BOOL CPDF_Annot::DrawAppearance(const CPDF_Page* pPage,
256                                    CFX_RenderDevice* pDevice,
257                                    const CFX_AffineMatrix* pUser2Device,
258                                    AppearanceMode mode,
259                                    const CPDF_RenderOptions* pOptions) {
260   CFX_Matrix matrix;
261   CPDF_Form* pForm =
262       FPDFDOC_Annot_GetMatrix(pPage, this, mode, pUser2Device, matrix);
263   if (!pForm) {
264     return FALSE;
265   }
266   CPDF_RenderContext context;
267   context.Create((CPDF_Page*)pPage);
268   context.DrawObjectList(pDevice, pForm, &matrix, pOptions);
269   return TRUE;
270 }
271 FX_BOOL CPDF_Annot::DrawInContext(const CPDF_Page* pPage,
272                                   const CPDF_RenderContext* pContext,
273                                   const CFX_AffineMatrix* pUser2Device,
274                                   AppearanceMode mode) {
275   CFX_Matrix matrix;
276   CPDF_Form* pForm =
277       FPDFDOC_Annot_GetMatrix(pPage, this, mode, pUser2Device, matrix);
278   if (!pForm) {
279     return FALSE;
280   }
281   ((CPDF_RenderContext*)pContext)->AppendObjectList(pForm, &matrix);
282   return TRUE;
283 }
284 void CPDF_Annot::DrawBorder(CFX_RenderDevice* pDevice,
285                             const CFX_AffineMatrix* pUser2Device,
286                             const CPDF_RenderOptions* pOptions) {
287   if (GetSubType() == "Popup") {
288     return;
289   }
290   FX_DWORD annot_flags = GetFlags();
291   if (annot_flags & ANNOTFLAG_HIDDEN) {
292     return;
293   }
294   FX_BOOL bPrinting = pDevice->GetDeviceClass() == FXDC_PRINTER ||
295                       (pOptions && (pOptions->m_Flags & RENDER_PRINTPREVIEW));
296   if (bPrinting && (annot_flags & ANNOTFLAG_PRINT) == 0) {
297     return;
298   }
299   if (!bPrinting && (annot_flags & ANNOTFLAG_NOVIEW)) {
300     return;
301   }
302   CPDF_Dictionary* pBS = m_pAnnotDict->GetDict("BS");
303   char style_char;
304   FX_FLOAT width;
305   CPDF_Array* pDashArray = NULL;
306   if (pBS == NULL) {
307     CPDF_Array* pBorderArray = m_pAnnotDict->GetArray("Border");
308     style_char = 'S';
309     if (pBorderArray) {
310       width = pBorderArray->GetNumber(2);
311       if (pBorderArray->GetCount() == 4) {
312         pDashArray = pBorderArray->GetArray(3);
313         if (pDashArray == NULL) {
314           return;
315         }
316         int nLen = pDashArray->GetCount();
317         int i = 0;
318         for (; i < nLen; ++i) {
319           CPDF_Object* pObj = pDashArray->GetElementValue(i);
320           if (pObj && pObj->GetInteger()) {
321             break;
322           }
323         }
324         if (i == nLen) {
325           return;
326         }
327         style_char = 'D';
328       }
329     } else {
330       width = 1;
331     }
332   } else {
333     CFX_ByteString style = pBS->GetString("S");
334     pDashArray = pBS->GetArray("D");
335     style_char = style[1];
336     width = pBS->GetNumber("W");
337   }
338   if (width <= 0) {
339     return;
340   }
341   CPDF_Array* pColor = m_pAnnotDict->GetArray("C");
342   FX_DWORD argb = 0xff000000;
343   if (pColor != NULL) {
344     int R = (int32_t)(pColor->GetNumber(0) * 255);
345     int G = (int32_t)(pColor->GetNumber(1) * 255);
346     int B = (int32_t)(pColor->GetNumber(2) * 255);
347     argb = ArgbEncode(0xff, R, G, B);
348   }
349   CPDF_GraphStateData graph_state;
350   graph_state.m_LineWidth = width;
351   if (style_char == 'D') {
352     if (pDashArray) {
353       FX_DWORD dash_count = pDashArray->GetCount();
354       if (dash_count % 2) {
355         dash_count++;
356       }
357       graph_state.m_DashArray = FX_Alloc(FX_FLOAT, dash_count);
358       graph_state.m_DashCount = dash_count;
359       FX_DWORD i;
360       for (i = 0; i < pDashArray->GetCount(); ++i) {
361         graph_state.m_DashArray[i] = pDashArray->GetNumber(i);
362       }
363       if (i < dash_count) {
364         graph_state.m_DashArray[i] = graph_state.m_DashArray[i - 1];
365       }
366     } else {
367       graph_state.m_DashArray = FX_Alloc(FX_FLOAT, 2);
368       graph_state.m_DashCount = 2;
369       graph_state.m_DashArray[0] = graph_state.m_DashArray[1] = 3 * 1.0f;
370     }
371   }
372   CFX_FloatRect rect;
373   GetRect(rect);
374   CPDF_PathData path;
375   width /= 2;
376   path.AppendRect(rect.left + width, rect.bottom + width, rect.right - width,
377                   rect.top - width);
378   int fill_type = 0;
379   if (pOptions && (pOptions->m_Flags & RENDER_NOPATHSMOOTH)) {
380     fill_type |= FXFILL_NOPATHSMOOTH;
381   }
382   pDevice->DrawPath(&path, pUser2Device, &graph_state, argb, argb, fill_type);
383 }