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