Remove trailing whitespaces in core.
[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 = CPDF_Reference::Create(m_pDocument, dwObjNum);
35             if (pAction == NULL) {
36                 break;
37             }
38             pAnnots->InsertAt(i, pAction);
39             pAnnots->RemoveAt(i + 1);
40             pDict = pAnnots->GetDict(i);
41         }
42         CPDF_Annot* pAnnot = new CPDF_Annot(pDict, this);
43         m_AnnotList.Add(pAnnot);
44         if (bRegenerateAP && pDict->GetConstString(FX_BSTRC("Subtype")) == FX_BSTRC("Widget"))
45             if (CPDF_InterForm::UpdatingAPEnabled()) {
46                 FPDF_GenerateAP(m_pDocument, pDict);
47             }
48     }
49 }
50 CPDF_AnnotList::~CPDF_AnnotList()
51 {
52     int i = 0;
53     for (i = 0; i < m_AnnotList.GetSize(); ++i) {
54         delete (CPDF_Annot*)m_AnnotList[i];
55     }
56     for (i = 0; i < m_Borders.GetSize(); ++i) {
57         delete (CPDF_PageObjects*)m_Borders[i];
58     }
59 }
60 void CPDF_AnnotList::DisplayPass(const CPDF_Page* pPage, CFX_RenderDevice* pDevice,
61                                  CPDF_RenderContext* pContext, FX_BOOL bPrinting, CFX_AffineMatrix* pMatrix,
62                                  FX_BOOL bWidgetPass, CPDF_RenderOptions* pOptions, FX_RECT* clip_rect)
63 {
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, CPDF_Annot::Normal, pOptions)) {
103             pAnnot->DrawBorder(pDevice, &matrix, pOptions);
104         }
105     }
106 }
107 void CPDF_AnnotList::DisplayAnnots(const CPDF_Page* pPage, CFX_RenderDevice* pDevice,
108                                    CFX_AffineMatrix* pUser2Device,
109                                    FX_BOOL bShowWidget, CPDF_RenderOptions* pOptions)
110 {
111     FX_RECT clip_rect;
112     if (pDevice) {
113         clip_rect = pDevice->GetClipBox();
114     }
115     FX_BOOL bPrinting = pDevice->GetDeviceClass() == FXDC_PRINTER || (pOptions && (pOptions->m_Flags & RENDER_PRINTPREVIEW));
116     DisplayAnnots(pPage, pDevice, NULL, bPrinting, pUser2Device, bShowWidget ? 3 : 1, pOptions, &clip_rect);
117 }
118 void CPDF_AnnotList::DisplayAnnots(const CPDF_Page* pPage, CFX_RenderDevice* pDevice, CPDF_RenderContext* pContext,
119                                    FX_BOOL bPrinting, CFX_AffineMatrix* pUser2Device, FX_DWORD dwAnnotFlags,
120                                    CPDF_RenderOptions* pOptions, FX_RECT* pClipRect)
121 {
122     if (dwAnnotFlags & 0x01) {
123         DisplayPass(pPage, pDevice, pContext, bPrinting, pUser2Device, FALSE, pOptions, pClipRect);
124     }
125     if (dwAnnotFlags & 0x02) {
126         DisplayPass(pPage, pDevice, pContext, bPrinting, pUser2Device, TRUE, pOptions, pClipRect);
127     }
128 }
129 int CPDF_AnnotList::GetIndex(CPDF_Annot* pAnnot)
130 {
131     for (int i = 0; i < m_AnnotList.GetSize(); ++i)
132         if (m_AnnotList[i] == (void*)pAnnot) {
133             return i;
134         }
135     return -1;
136 }
137 CPDF_Annot::CPDF_Annot(CPDF_Dictionary* pDict, CPDF_AnnotList* pList)
138     : m_pAnnotDict(pDict),
139       m_pList(pList),
140       m_sSubtype(m_pAnnotDict->GetConstString(FX_BSTRC("Subtype")))
141 {
142 }
143 CPDF_Annot::~CPDF_Annot()
144 {
145     ClearCachedAP();
146 }
147 void CPDF_Annot::ClearCachedAP()
148 {
149     FX_POSITION pos = m_APMap.GetStartPosition();
150     while (pos) {
151         void* pForm;
152         void* pObjects;
153         m_APMap.GetNextAssoc(pos, pForm, pObjects);
154         delete (CPDF_PageObjects*)pObjects;
155     }
156     m_APMap.RemoveAll();
157 }
158 CFX_ByteString CPDF_Annot::GetSubType() const
159 {
160     return m_sSubtype;
161 }
162
163 void CPDF_Annot::GetRect(CPDF_Rect& rect) const
164 {
165     if (m_pAnnotDict == NULL) {
166         return;
167     }
168     rect = m_pAnnotDict->GetRect("Rect");
169     rect.Normalize();
170 }
171
172 FX_DWORD CPDF_Annot::GetFlags() const
173 {
174     return m_pAnnotDict->GetInteger("F");
175 }
176
177 CPDF_Dictionary* CPDF_Annot::GetAnnotDict()
178 {
179     return m_pAnnotDict;
180 }
181
182 CPDF_Stream* FPDFDOC_GetAnnotAP(CPDF_Dictionary* pAnnotDict, CPDF_Annot::AppearanceMode mode)
183 {
184     CPDF_Dictionary* pAP = pAnnotDict->GetDict("AP");
185     if (pAP == NULL) {
186         return NULL;
187     }
188     const FX_CHAR* ap_entry = "N";
189     if (mode == CPDF_Annot::Down) {
190         ap_entry = "D";
191     } else if (mode == CPDF_Annot::Rollover) {
192         ap_entry = "R";
193     }
194     if (!pAP->KeyExist(ap_entry)) {
195         ap_entry = "N";
196     }
197     CPDF_Object* psub = pAP->GetElementValue(ap_entry);
198     if (psub == NULL) {
199         return NULL;
200     }
201     CPDF_Stream* pStream = NULL;
202     if (psub->GetType() == PDFOBJ_STREAM) {
203         pStream = (CPDF_Stream*)psub;
204     } else if (psub->GetType() == PDFOBJ_DICTIONARY) {
205         CFX_ByteString as = pAnnotDict->GetString("AS");
206         if (as.IsEmpty()) {
207             CFX_ByteString value = pAnnotDict->GetString(FX_BSTRC("V"));
208             if (value.IsEmpty()) {
209                 CPDF_Dictionary* pDict = pAnnotDict->GetDict(FX_BSTRC("Parent"));
210                 value = pDict ? pDict->GetString(FX_BSTRC("V")) : CFX_ByteString();
211             }
212             if (value.IsEmpty() || !((CPDF_Dictionary*)psub)->KeyExist(value)) {
213                 as = FX_BSTRC("Off");
214             } else {
215                 as = value;
216             }
217         }
218         pStream = ((CPDF_Dictionary*)psub)->GetStream(as);
219     }
220     return pStream;
221 }
222 CPDF_Form* CPDF_Annot::GetAPForm(const CPDF_Page* pPage, AppearanceMode mode)
223 {
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, CPDF_Annot* pAnnot, CPDF_Annot::AppearanceMode mode, const CFX_AffineMatrix* pUser2Device, CFX_Matrix &matrix)
238 {
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, CFX_RenderDevice* pDevice, const CFX_AffineMatrix* pUser2Device,
253                                    AppearanceMode mode, const CPDF_RenderOptions* pOptions)
254 {
255     CFX_Matrix matrix;
256     CPDF_Form* pForm = FPDFDOC_Annot_GetMatrix(pPage, this, mode, pUser2Device, matrix);
257     if (!pForm) {
258         return FALSE;
259     }
260     CPDF_RenderContext context;
261     context.Create((CPDF_Page*)pPage);
262     context.DrawObjectList(pDevice, pForm, &matrix, pOptions);
263     return TRUE;
264 }
265 FX_BOOL CPDF_Annot::DrawInContext(const CPDF_Page* pPage, const CPDF_RenderContext* pContext, const CFX_AffineMatrix* pUser2Device, AppearanceMode mode)
266 {
267     CFX_Matrix matrix;
268     CPDF_Form* pForm = FPDFDOC_Annot_GetMatrix(pPage, this, mode, pUser2Device, matrix);
269     if (!pForm) {
270         return FALSE;
271     }
272     ((CPDF_RenderContext*)pContext)->AppendObjectList(pForm, &matrix);
273     return TRUE;
274 }
275 void CPDF_Annot::DrawBorder(CFX_RenderDevice* pDevice, const CFX_AffineMatrix* pUser2Device, const CPDF_RenderOptions* pOptions)
276 {
277     if (GetSubType() == "Popup") {
278         return;
279     }
280     FX_DWORD annot_flags = GetFlags();
281     if (annot_flags & ANNOTFLAG_HIDDEN) {
282         return;
283     }
284     FX_BOOL bPrinting = pDevice->GetDeviceClass() == FXDC_PRINTER || (pOptions && (pOptions->m_Flags & RENDER_PRINTPREVIEW));
285     if (bPrinting && (annot_flags & ANNOTFLAG_PRINT) == 0) {
286         return;
287     }
288     if (!bPrinting && (annot_flags & ANNOTFLAG_NOVIEW)) {
289         return;
290     }
291     CPDF_Dictionary* pBS = m_pAnnotDict->GetDict("BS");
292     char style_char;
293     FX_FLOAT width;
294     CPDF_Array* pDashArray = NULL;
295     if (pBS == NULL) {
296         CPDF_Array* pBorderArray = m_pAnnotDict->GetArray("Border");
297         style_char = 'S';
298         if (pBorderArray) {
299             width = pBorderArray->GetNumber(2);
300             if (pBorderArray->GetCount() == 4) {
301                 pDashArray = pBorderArray->GetArray(3);
302                 if (pDashArray == NULL) {
303                     return;
304                 }
305                 int nLen = pDashArray->GetCount();
306                 int i = 0;
307                 for (; i < nLen; ++i) {
308                     CPDF_Object*pObj = pDashArray->GetElementValue(i);
309                     if (pObj && pObj->GetInteger()) {
310                         break;
311                     }
312                 }
313                 if (i == nLen) {
314                     return;
315                 }
316                 style_char = 'D';
317             }
318         } else {
319             width = 1;
320         }
321     } else {
322         CFX_ByteString style = pBS->GetString("S");
323         pDashArray = pBS->GetArray("D");
324         style_char = style[1];
325         width = pBS->GetNumber("W");
326     }
327     if (width <= 0) {
328         return;
329     }
330     CPDF_Array* pColor = m_pAnnotDict->GetArray("C");
331     FX_DWORD argb = 0xff000000;
332     if (pColor != NULL) {
333         int R = (int32_t)(pColor->GetNumber(0) * 255);
334         int G = (int32_t)(pColor->GetNumber(1) * 255);
335         int B = (int32_t)(pColor->GetNumber(2) * 255);
336         argb = ArgbEncode(0xff, R, G, B);
337     }
338     CPDF_GraphStateData graph_state;
339     graph_state.m_LineWidth = width;
340     if (style_char == 'D') {
341         if (pDashArray) {
342             FX_DWORD dash_count = pDashArray->GetCount();
343             if (dash_count % 2) {
344                 dash_count++;
345             }
346             graph_state.m_DashArray = FX_Alloc(FX_FLOAT, dash_count);
347             graph_state.m_DashCount = dash_count;
348             FX_DWORD i;
349             for (i = 0; i < pDashArray->GetCount(); ++i) {
350                 graph_state.m_DashArray[i] = pDashArray->GetNumber(i);
351             }
352             if (i < dash_count) {
353                 graph_state.m_DashArray[i] = graph_state.m_DashArray[i - 1];
354             }
355         } else {
356             graph_state.m_DashArray = FX_Alloc(FX_FLOAT, 2);
357             graph_state.m_DashCount = 2;
358             graph_state.m_DashArray[0] = graph_state.m_DashArray[1] = 3 * 1.0f;
359         }
360     }
361     CFX_FloatRect rect;
362     GetRect(rect);
363     CPDF_PathData path;
364     width /= 2;
365     path.AppendRect(rect.left + width, rect.bottom + width, rect.right - width, rect.top - width);
366     int fill_type = 0;
367     if (pOptions && (pOptions->m_Flags & RENDER_NOPATHSMOOTH)) {
368         fill_type |= FXFILL_NOPATHSMOOTH;
369     }
370     pDevice->DrawPath(&path, pUser2Device, &graph_state, argb, argb, fill_type);
371 }