Merge to XFA: Cleanup: Make CPDF_Annot::m_pAnnotDict private.
[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] == (FX_LPVOID)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 {
141 }
142 CPDF_Annot::~CPDF_Annot()
143 {
144     ClearCachedAP();
145 }
146 void CPDF_Annot::ClearCachedAP()
147 {
148     FX_POSITION pos = m_APMap.GetStartPosition();
149     while (pos) {
150         void* pForm;
151         void* pObjects;
152         m_APMap.GetNextAssoc(pos, pForm, pObjects);
153         delete (CPDF_PageObjects*)pObjects;
154     }
155     m_APMap.RemoveAll();
156 }
157 CFX_ByteString CPDF_Annot::GetSubType() const
158 {
159     return m_pAnnotDict ? m_pAnnotDict->GetConstString(FX_BSTRC("Subtype")) : CFX_ByteStringC();
160 }
161
162 void CPDF_Annot::GetRect(CPDF_Rect& rect) const
163 {
164     if (m_pAnnotDict == NULL) {
165         return;
166     }
167     rect = m_pAnnotDict->GetRect("Rect");
168     rect.Normalize();
169 }
170
171 FX_DWORD CPDF_Annot::GetFlags() const
172 {
173     return m_pAnnotDict->GetInteger("F");
174 }
175
176 CPDF_Dictionary* CPDF_Annot::GetAnnotDict()
177 {
178     return m_pAnnotDict;
179 }
180
181 CPDF_Stream* FPDFDOC_GetAnnotAP(CPDF_Dictionary* pAnnotDict, CPDF_Annot::AppearanceMode mode)
182 {
183     CPDF_Dictionary* pAP = pAnnotDict->GetDict("AP");
184     if (pAP == NULL) {
185         return NULL;
186     }
187     const FX_CHAR* ap_entry = "N";
188     if (mode == CPDF_Annot::Down) {
189         ap_entry = "D";
190     } else if (mode == CPDF_Annot::Rollover) {
191         ap_entry = "R";
192     }
193     if (!pAP->KeyExist(ap_entry)) {
194         ap_entry = "N";
195     }
196     CPDF_Object* psub = pAP->GetElementValue(ap_entry);
197     if (psub == NULL) {
198         return NULL;
199     }
200     CPDF_Stream* pStream = NULL;
201     if (psub->GetType() == PDFOBJ_STREAM) {
202         pStream = (CPDF_Stream*)psub;
203     } else if (psub->GetType() == PDFOBJ_DICTIONARY) {
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() || !((CPDF_Dictionary*)psub)->KeyExist(value)) {
212                 as = FX_BSTRC("Off");
213             } else {
214                 as = value;
215             }
216         }
217         pStream = ((CPDF_Dictionary*)psub)->GetStream(as);
218     }
219     return pStream;
220 }
221 CPDF_Form* CPDF_Annot::GetAPForm(const CPDF_Page* pPage, AppearanceMode mode)
222 {
223     CPDF_Stream* pStream = FPDFDOC_GetAnnotAP(m_pAnnotDict, mode);
224     if (pStream == NULL) {
225         return NULL;
226     }
227     CPDF_Form* pForm;
228     if (m_APMap.Lookup(pStream, (void*&)pForm)) {
229         return pForm;
230     }
231     pForm = FX_NEW CPDF_Form(m_pList->m_pDocument, pPage->m_pResources, pStream);
232     if (pForm == NULL) {
233         return NULL;
234     }
235     pForm->ParseContent(NULL, NULL, NULL, NULL);
236     m_APMap.SetAt(pStream, pForm);
237     return pForm;
238 }
239 static CPDF_Form* FPDFDOC_Annot_GetMatrix(const CPDF_Page* pPage, CPDF_Annot* pAnnot, CPDF_Annot::AppearanceMode mode, const CFX_AffineMatrix* pUser2Device, CFX_Matrix &matrix)
240 {
241     CPDF_Form* pForm = pAnnot->GetAPForm(pPage, mode);
242     if (!pForm) {
243         return NULL;
244     }
245     CFX_FloatRect form_bbox = pForm->m_pFormDict->GetRect(FX_BSTRC("BBox"));
246     CFX_Matrix form_matrix = pForm->m_pFormDict->GetMatrix(FX_BSTRC("Matrix"));
247     form_matrix.TransformRect(form_bbox);
248     CPDF_Rect arect;
249     pAnnot->GetRect(arect);
250     matrix.MatchRect(arect, form_bbox);
251     matrix.Concat(*pUser2Device);
252     return pForm;
253 }
254 FX_BOOL CPDF_Annot::DrawAppearance(const CPDF_Page* pPage, CFX_RenderDevice* pDevice, const CFX_AffineMatrix* pUser2Device,
255                                    AppearanceMode mode, const CPDF_RenderOptions* pOptions)
256 {
257     CFX_Matrix matrix;
258     CPDF_Form* pForm = FPDFDOC_Annot_GetMatrix(pPage, this, mode, pUser2Device, matrix);
259     if (!pForm) {
260         return FALSE;
261     }
262     CPDF_RenderContext context;
263     context.Create((CPDF_Page*)pPage);
264     context.DrawObjectList(pDevice, pForm, &matrix, pOptions);
265     return TRUE;
266 }
267 FX_BOOL CPDF_Annot::DrawInContext(const CPDF_Page* pPage, const CPDF_RenderContext* pContext, const CFX_AffineMatrix* pUser2Device, AppearanceMode mode)
268 {
269     CFX_Matrix matrix;
270     CPDF_Form* pForm = FPDFDOC_Annot_GetMatrix(pPage, this, mode, pUser2Device, matrix);
271     if (!pForm) {
272         return FALSE;
273     }
274     ((CPDF_RenderContext*)pContext)->AppendObjectList(pForm, &matrix);
275     return TRUE;
276 }
277 void CPDF_Annot::DrawBorder(CFX_RenderDevice* pDevice, const CFX_AffineMatrix* pUser2Device, const CPDF_RenderOptions* pOptions)
278 {
279     if (GetSubType() == "Popup") {
280         return;
281     }
282     FX_DWORD annot_flags = GetFlags();
283     if (annot_flags & ANNOTFLAG_HIDDEN) {
284         return;
285     }
286     FX_BOOL bPrinting = pDevice->GetDeviceClass() == FXDC_PRINTER || (pOptions && (pOptions->m_Flags & RENDER_PRINTPREVIEW));
287     if (bPrinting && (annot_flags & ANNOTFLAG_PRINT) == 0) {
288         return;
289     }
290     if (!bPrinting && (annot_flags & ANNOTFLAG_NOVIEW)) {
291         return;
292     }
293     CPDF_Dictionary* pBS = m_pAnnotDict->GetDict("BS");
294     char style_char;
295     FX_FLOAT width;
296     CPDF_Array* pDashArray = NULL;
297     if (pBS == NULL) {
298         CPDF_Array* pBorderArray = m_pAnnotDict->GetArray("Border");
299         style_char = 'S';
300         if (pBorderArray) {
301             width = pBorderArray->GetNumber(2);
302             if (pBorderArray->GetCount() == 4) {
303                 pDashArray = pBorderArray->GetArray(3);
304                 if (pDashArray == NULL) {
305                     return;
306                 }
307                 int nLen = pDashArray->GetCount();
308                 int i = 0;
309                 for (; i < nLen; ++i) {
310                     CPDF_Object*pObj = pDashArray->GetElementValue(i);
311                     if (pObj && pObj->GetInteger()) {
312                         break;
313                     }
314                 }
315                 if (i == nLen) {
316                     return;
317                 }
318                 style_char = 'D';
319             }
320         } else {
321             width = 1;
322         }
323     } else {
324         CFX_ByteString style = pBS->GetString("S");
325         pDashArray = pBS->GetArray("D");
326         style_char = style[1];
327         width = pBS->GetNumber("W");
328     }
329     if (width <= 0) {
330         return;
331     }
332     CPDF_Array* pColor = m_pAnnotDict->GetArray("C");
333     FX_DWORD argb = 0xff000000;
334     if (pColor != NULL) {
335         int R = (FX_INT32)(pColor->GetNumber(0) * 255);
336         int G = (FX_INT32)(pColor->GetNumber(1) * 255);
337         int B = (FX_INT32)(pColor->GetNumber(2) * 255);
338         argb = ArgbEncode(0xff, R, G, B);
339     }
340     CPDF_GraphStateData graph_state;
341     graph_state.m_LineWidth = width;
342     if (style_char == 'D') {
343         if (pDashArray) {
344             FX_DWORD dash_count = pDashArray->GetCount();
345             if (dash_count % 2) {
346                 dash_count++;
347             }
348             graph_state.m_DashArray = FX_Alloc(FX_FLOAT, dash_count);
349             graph_state.m_DashCount = dash_count;
350             FX_DWORD i;
351             for (i = 0; i < pDashArray->GetCount(); ++i) {
352                 graph_state.m_DashArray[i] = pDashArray->GetNumber(i);
353             }
354             if (i < dash_count) {
355                 graph_state.m_DashArray[i] = graph_state.m_DashArray[i - 1];
356             }
357         } else {
358             graph_state.m_DashArray = FX_Alloc(FX_FLOAT, 2);
359             graph_state.m_DashCount = 2;
360             graph_state.m_DashArray[0] = graph_state.m_DashArray[1] = 3 * 1.0f;
361         }
362     }
363     CFX_FloatRect rect;
364     GetRect(rect);
365     CPDF_PathData path;
366     width /= 2;
367     path.AppendRect(rect.left + width, rect.bottom + width, rect.right - width, rect.top - width);
368     int fill_type = 0;
369     if (pOptions && (pOptions->m_Flags & RENDER_NOPATHSMOOTH)) {
370         fill_type |= FXFILL_NOPATHSMOOTH;
371     }
372     pDevice->DrawPath(&path, pUser2Device, &graph_state, argb, argb, fill_type);
373 }