c8151bfa04b6581157e008d8cc25d9c2037b22bd
[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 = FX_NEW CPDF_Annot(pDict);
43         if (pAnnot == NULL) {
44             break;
45         }
46         pAnnot->m_pList = this;
47         m_AnnotList.Add(pAnnot);
48         if (bRegenerateAP && pDict->GetConstString(FX_BSTRC("Subtype")) == FX_BSTRC("Widget"))
49             if (CPDF_InterForm::UpdatingAPEnabled()) {
50                 FPDF_GenerateAP(m_pDocument, pDict);
51             }
52     }
53 }
54 CPDF_AnnotList::~CPDF_AnnotList()
55 {
56     int i = 0;
57     for (i = 0; i < m_AnnotList.GetSize(); i ++) {
58         delete (CPDF_Annot*)m_AnnotList[i];
59     }
60     for (i = 0; i < m_Borders.GetSize(); ++i) {
61         delete (CPDF_PageObjects*)m_Borders[i];
62     }
63 }
64 void CPDF_AnnotList::DisplayPass(const CPDF_Page* pPage, CFX_RenderDevice* pDevice,
65                                  CPDF_RenderContext* pContext, FX_BOOL bPrinting, CFX_AffineMatrix* pMatrix,
66                                  FX_BOOL bWidgetPass, CPDF_RenderOptions* pOptions, FX_RECT* clip_rect)
67 {
68     for (int i = 0; i < m_AnnotList.GetSize(); i ++) {
69         CPDF_Annot* pAnnot = (CPDF_Annot*)m_AnnotList[i];
70         FX_BOOL bWidget = pAnnot->GetSubType() == "Widget";
71         if ((bWidgetPass && !bWidget) || (!bWidgetPass && bWidget)) {
72             continue;
73         }
74         FX_DWORD annot_flags = pAnnot->GetFlags();
75         if (annot_flags & ANNOTFLAG_HIDDEN) {
76             continue;
77         }
78         if (bPrinting && (annot_flags & ANNOTFLAG_PRINT) == 0) {
79             continue;
80         }
81         if (!bPrinting && (annot_flags & ANNOTFLAG_NOVIEW)) {
82             continue;
83         }
84         if (pOptions != NULL) {
85             IPDF_OCContext* pOCContext = pOptions->m_pOCContext;
86             CPDF_Dictionary* pAnnotDict = pAnnot->m_pAnnotDict;
87             if (pOCContext != NULL && pAnnotDict != NULL &&
88                     !pOCContext->CheckOCGVisible(pAnnotDict->GetDict(FX_BSTRC("OC")))) {
89                 continue;
90             }
91         }
92         CPDF_Rect annot_rect_f;
93         pAnnot->GetRect(annot_rect_f);
94         CFX_Matrix matrix;
95         matrix = *pMatrix;
96         if (clip_rect) {
97             annot_rect_f.Transform(&matrix);
98             FX_RECT annot_rect = annot_rect_f.GetOutterRect();
99             annot_rect.Intersect(*clip_rect);
100             if (annot_rect.IsEmpty()) {
101                 continue;
102             }
103         }
104         if (pContext) {
105             pAnnot->DrawInContext(pPage, pContext, &matrix, CPDF_Annot::Normal);
106         } else if (!pAnnot->DrawAppearance(pPage, pDevice, &matrix, CPDF_Annot::Normal, pOptions)) {
107             pAnnot->DrawBorder(pDevice, &matrix, pOptions);
108         }
109     }
110 }
111 void CPDF_AnnotList::DisplayAnnots(const CPDF_Page* pPage, CFX_RenderDevice* pDevice,
112                                    CFX_AffineMatrix* pUser2Device,
113                                    FX_BOOL bShowWidget, CPDF_RenderOptions* pOptions)
114 {
115     FX_RECT clip_rect;
116     if (pDevice) {
117         clip_rect = pDevice->GetClipBox();
118     }
119     FX_BOOL bPrinting = pDevice->GetDeviceClass() == FXDC_PRINTER || (pOptions && (pOptions->m_Flags & RENDER_PRINTPREVIEW));
120     DisplayAnnots(pPage, pDevice, NULL, bPrinting, pUser2Device, bShowWidget ? 3 : 1, pOptions, &clip_rect);
121 }
122 void CPDF_AnnotList::DisplayAnnots(const CPDF_Page* pPage, CFX_RenderDevice* pDevice, CPDF_RenderContext* pContext,
123                                    FX_BOOL bPrinting, CFX_AffineMatrix* pUser2Device, FX_DWORD dwAnnotFlags,
124                                    CPDF_RenderOptions* pOptions, FX_RECT* pClipRect)
125 {
126     if (dwAnnotFlags & 0x01) {
127         DisplayPass(pPage, pDevice, pContext, bPrinting, pUser2Device, FALSE, pOptions, pClipRect);
128     }
129     if (dwAnnotFlags & 0x02) {
130         DisplayPass(pPage, pDevice, pContext, bPrinting, pUser2Device, TRUE, pOptions, pClipRect);
131     }
132 }
133 int CPDF_AnnotList::GetIndex(CPDF_Annot* pAnnot)
134 {
135     for (int i = 0; i < m_AnnotList.GetSize(); i ++)
136         if (m_AnnotList[i] == (FX_LPVOID)pAnnot) {
137             return i;
138         }
139     return -1;
140 }
141 CPDF_Annot::CPDF_Annot(CPDF_Dictionary* pDict)
142 {
143     m_pList = NULL;
144     m_pAnnotDict = pDict;
145 }
146 CPDF_Annot::~CPDF_Annot()
147 {
148     ClearCachedAP();
149 }
150 CPDF_Reference* CPDF_Annot::NewAnnotRef()
151 {
152     if (m_pAnnotDict->GetObjNum() == 0) {
153         m_pList->m_pDocument->AddIndirectObject(m_pAnnotDict);
154     }
155     return CPDF_Reference::Create(m_pList->m_pDocument, m_pAnnotDict->GetObjNum());
156 }
157 void CPDF_Annot::ClearCachedAP()
158 {
159     FX_POSITION pos = m_APMap.GetStartPosition();
160     while (pos) {
161         void* pForm;
162         void* pObjects;
163         m_APMap.GetNextAssoc(pos, pForm, pObjects);
164         delete (CPDF_PageObjects*)pObjects;
165     }
166     m_APMap.RemoveAll();
167 }
168 CFX_ByteString CPDF_Annot::GetSubType() const
169 {
170     return m_pAnnotDict ? m_pAnnotDict->GetConstString(FX_BSTRC("Subtype")) : CFX_ByteStringC();
171 }
172 void CPDF_Annot::GetRect(CPDF_Rect& rect) const
173 {
174     if (m_pAnnotDict == NULL) {
175         return;
176     }
177     rect = m_pAnnotDict->GetRect("Rect");
178     rect.Normalize();
179 }
180 CPDF_Stream* FPDFDOC_GetAnnotAP(CPDF_Dictionary* pAnnotDict, CPDF_Annot::AppearanceMode mode)
181 {
182     CPDF_Dictionary* pAP = pAnnotDict->GetDict("AP");
183     if (pAP == NULL) {
184         return NULL;
185     }
186     const FX_CHAR* ap_entry = "N";
187     if (mode == CPDF_Annot::Down) {
188         ap_entry = "D";
189     } else if (mode == CPDF_Annot::Rollover) {
190         ap_entry = "R";
191     }
192     if (!pAP->KeyExist(ap_entry)) {
193         ap_entry = "N";
194     }
195     CPDF_Object* psub = pAP->GetElementValue(ap_entry);
196     if (psub == NULL) {
197         return NULL;
198     }
199     CPDF_Stream* pStream = NULL;
200     if (psub->GetType() == PDFOBJ_STREAM) {
201         pStream = (CPDF_Stream*)psub;
202     } else if (psub->GetType() == PDFOBJ_DICTIONARY) {
203         CFX_ByteString as = pAnnotDict->GetString("AS");
204         if (as.IsEmpty()) {
205             CFX_ByteString value = pAnnotDict->GetString(FX_BSTRC("V"));
206             if (value.IsEmpty()) {
207                 CPDF_Dictionary* pDict = pAnnotDict->GetDict(FX_BSTRC("Parent"));
208                 value = pDict ? pDict->GetString(FX_BSTRC("V")) : CFX_ByteString();
209             }
210             if (value.IsEmpty() || !((CPDF_Dictionary*)psub)->KeyExist(value)) {
211                 as = FX_BSTRC("Off");
212             } else {
213                 as = value;
214             }
215         }
216         pStream = ((CPDF_Dictionary*)psub)->GetStream(as);
217     }
218     return pStream;
219 }
220 CPDF_Form* CPDF_Annot::GetAPForm(const CPDF_Page* pPage, AppearanceMode mode)
221 {
222     CPDF_Stream* pStream = FPDFDOC_GetAnnotAP(m_pAnnotDict, mode);
223     if (pStream == NULL) {
224         return NULL;
225     }
226     CPDF_Form* pForm;
227     if (m_APMap.Lookup(pStream, (void*&)pForm)) {
228         return pForm;
229     }
230     pForm = FX_NEW CPDF_Form(m_pList->m_pDocument, pPage->m_pResources, pStream);
231     if (pForm == NULL) {
232         return NULL;
233     }
234     pForm->ParseContent(NULL, NULL, NULL, NULL);
235     m_APMap.SetAt(pStream, pForm);
236     return pForm;
237 }
238 static CPDF_Form* FPDFDOC_Annot_GetMatrix(const CPDF_Page* pPage, CPDF_Annot* pAnnot, CPDF_Annot::AppearanceMode mode, const CFX_AffineMatrix* pUser2Device, CFX_Matrix &matrix)
239 {
240     CPDF_Form* pForm = pAnnot->GetAPForm(pPage, mode);
241     if (!pForm) {
242         return NULL;
243     }
244     CFX_FloatRect form_bbox = pForm->m_pFormDict->GetRect(FX_BSTRC("BBox"));
245     CFX_Matrix form_matrix = pForm->m_pFormDict->GetMatrix(FX_BSTRC("Matrix"));
246     form_matrix.TransformRect(form_bbox);
247     CPDF_Rect arect;
248     pAnnot->GetRect(arect);
249     matrix.MatchRect(arect, form_bbox);
250     matrix.Concat(*pUser2Device);
251     return pForm;
252 }
253 FX_BOOL CPDF_Annot::DrawAppearance(const CPDF_Page* pPage, CFX_RenderDevice* pDevice, const CFX_AffineMatrix* pUser2Device,
254                                    AppearanceMode mode, const CPDF_RenderOptions* pOptions)
255 {
256     CFX_Matrix matrix;
257     CPDF_Form* pForm = FPDFDOC_Annot_GetMatrix(pPage, this, mode, pUser2Device, matrix);
258     if (!pForm) {
259         return FALSE;
260     }
261     CPDF_RenderContext context;
262     context.Create((CPDF_Page*)pPage);
263     context.DrawObjectList(pDevice, pForm, &matrix, pOptions);
264     return TRUE;
265 }
266 FX_BOOL CPDF_Annot::DrawInContext(const CPDF_Page* pPage, const CPDF_RenderContext* pContext, const CFX_AffineMatrix* pUser2Device, AppearanceMode mode)
267 {
268     CFX_Matrix matrix;
269     CPDF_Form* pForm = FPDFDOC_Annot_GetMatrix(pPage, this, mode, pUser2Device, matrix);
270     if (!pForm) {
271         return FALSE;
272     }
273     ((CPDF_RenderContext*)pContext)->AppendObjectList(pForm, &matrix);
274     return TRUE;
275 }
276 CPDF_PageObject* CPDF_Annot::GetBorder(FX_BOOL bPrint, const CPDF_RenderOptions* pOptions)
277 {
278     if (GetSubType() == "Popup") {
279         return NULL;
280     }
281     FX_DWORD annot_flags = GetFlags();
282     if (annot_flags & ANNOTFLAG_HIDDEN) {
283         return NULL;
284     }
285     FX_BOOL bPrinting = bPrint || (pOptions && (pOptions->m_Flags & RENDER_PRINTPREVIEW));
286     if (bPrinting && (annot_flags & ANNOTFLAG_PRINT) == 0) {
287         return NULL;
288     }
289     if (!bPrinting && (annot_flags & ANNOTFLAG_NOVIEW)) {
290         return NULL;
291     }
292     CPDF_Dictionary* pBS = m_pAnnotDict->GetDict("BS");
293     char style_char;
294     FX_FLOAT width;
295     CPDF_Array* pDashArray = NULL;
296     if (pBS == NULL) {
297         CPDF_Array* pBorderArray = m_pAnnotDict->GetArray("Border");
298         style_char = 'S';
299         if (pBorderArray) {
300             width = pBorderArray->GetNumber(2);
301             if (pBorderArray->GetCount() == 4) {
302                 pDashArray = pBorderArray->GetArray(3);
303                 if (pDashArray == NULL) {
304                     return NULL;
305                 }
306                 style_char = 'D';
307             }
308         } else {
309             width = 1;
310         }
311     } else {
312         CFX_ByteString style = pBS->GetString("S");
313         pDashArray = pBS->GetArray("D");
314         style_char = style[1];
315         width = pBS->GetNumber("W");
316     }
317     if (width <= 0) {
318         return NULL;
319     }
320     CPDF_Array* pColor = m_pAnnotDict->GetArray("C");
321     FX_DWORD argb = 0xff000000;
322     if (pColor != NULL) {
323         int R = (FX_INT32)(pColor->GetNumber(0) * 255);
324         int G = (FX_INT32)(pColor->GetNumber(1) * 255);
325         int B = (FX_INT32)(pColor->GetNumber(2) * 255);
326         argb = ArgbEncode(0xff, R, G, B);
327     }
328     nonstd::unique_ptr<CPDF_PathObject> pPathObject(new CPDF_PathObject());
329     CPDF_GraphStateData *pGraphState = pPathObject->m_GraphState.GetModify();
330     if (!pGraphState) {
331         return NULL;
332     }
333     pGraphState->m_LineWidth = width;
334     CPDF_ColorStateData *pColorData = pPathObject->m_ColorState.GetModify();
335     if (!pColorData) {
336         return NULL;
337     }
338     pColorData->m_StrokeRGB = argb;
339     pPathObject->m_bStroke = TRUE;
340     pPathObject->m_FillType = 0;
341     if (style_char == 'D') {
342         if (pDashArray) {
343             FX_DWORD dash_count = pDashArray->GetCount();
344             if (dash_count % 2) {
345                 dash_count ++;
346             }
347             pGraphState->m_DashArray = FX_Alloc(FX_FLOAT, dash_count);
348             pGraphState->m_DashCount = dash_count;
349             FX_DWORD i;
350             for (i = 0; i < pDashArray->GetCount(); i ++) {
351                 pGraphState->m_DashArray[i] = pDashArray->GetNumber(i);
352             }
353             if (i < dash_count) {
354                 pGraphState->m_DashArray[i] = pGraphState->m_DashArray[i - 1];
355             }
356         } else {
357             pGraphState->m_DashArray = FX_Alloc(FX_FLOAT, 2);
358             pGraphState->m_DashCount = 2;
359             pGraphState->m_DashArray[0] = pGraphState->m_DashArray[1] = 3 * 1.0f;
360         }
361     }
362     CFX_FloatRect rect;
363     GetRect(rect);
364     width /= 2;
365     CPDF_PathData *pPathData = pPathObject->m_Path.GetModify();
366     if (pPathData) {
367         pPathData->AppendRect(rect.left + width, rect.bottom + width, rect.right - width, rect.top - width);
368     }
369     pPathObject->CalcBoundingBox();
370     return pPathObject.release();
371 }
372 void CPDF_Annot::DrawBorder(CFX_RenderDevice* pDevice, const CFX_AffineMatrix* pUser2Device, const CPDF_RenderOptions* pOptions)
373 {
374     if (GetSubType() == "Popup") {
375         return;
376     }
377     FX_DWORD annot_flags = GetFlags();
378     if (annot_flags & ANNOTFLAG_HIDDEN) {
379         return;
380     }
381     FX_BOOL bPrinting = pDevice->GetDeviceClass() == FXDC_PRINTER || (pOptions && (pOptions->m_Flags & RENDER_PRINTPREVIEW));
382     if (bPrinting && (annot_flags & ANNOTFLAG_PRINT) == 0) {
383         return;
384     }
385     if (!bPrinting && (annot_flags & ANNOTFLAG_NOVIEW)) {
386         return;
387     }
388     CPDF_Dictionary* pBS = m_pAnnotDict->GetDict("BS");
389     char style_char;
390     FX_FLOAT width;
391     CPDF_Array* pDashArray = NULL;
392     if (pBS == NULL) {
393         CPDF_Array* pBorderArray = m_pAnnotDict->GetArray("Border");
394         style_char = 'S';
395         if (pBorderArray) {
396             width = pBorderArray->GetNumber(2);
397             if (pBorderArray->GetCount() == 4) {
398                 pDashArray = pBorderArray->GetArray(3);
399                 if (pDashArray == NULL) {
400                     return;
401                 }
402                 int nLen = pDashArray->GetCount();
403                 int i = 0;
404                 for (; i < nLen; ++i) {
405                     CPDF_Object*pObj = pDashArray->GetElementValue(i);
406                     if (pObj && pObj->GetInteger()) {
407                         break;
408                     }
409                 }
410                 if (i == nLen) {
411                     return;
412                 }
413                 style_char = 'D';
414             }
415         } else {
416             width = 1;
417         }
418     } else {
419         CFX_ByteString style = pBS->GetString("S");
420         pDashArray = pBS->GetArray("D");
421         style_char = style[1];
422         width = pBS->GetNumber("W");
423     }
424     if (width <= 0) {
425         return;
426     }
427     CPDF_Array* pColor = m_pAnnotDict->GetArray("C");
428     FX_DWORD argb = 0xff000000;
429     if (pColor != NULL) {
430         int R = (FX_INT32)(pColor->GetNumber(0) * 255);
431         int G = (FX_INT32)(pColor->GetNumber(1) * 255);
432         int B = (FX_INT32)(pColor->GetNumber(2) * 255);
433         argb = ArgbEncode(0xff, R, G, B);
434     }
435     CPDF_GraphStateData graph_state;
436     graph_state.m_LineWidth = width;
437     if (style_char == 'D') {
438         if (pDashArray) {
439             FX_DWORD dash_count = pDashArray->GetCount();
440             if (dash_count % 2) {
441                 dash_count ++;
442             }
443             graph_state.m_DashArray = FX_Alloc(FX_FLOAT, dash_count);
444             graph_state.m_DashCount = dash_count;
445             FX_DWORD i;
446             for (i = 0; i < pDashArray->GetCount(); i ++) {
447                 graph_state.m_DashArray[i] = pDashArray->GetNumber(i);
448             }
449             if (i < dash_count) {
450                 graph_state.m_DashArray[i] = graph_state.m_DashArray[i - 1];
451             }
452         } else {
453             graph_state.m_DashArray = FX_Alloc(FX_FLOAT, 2);
454             graph_state.m_DashCount = 2;
455             graph_state.m_DashArray[0] = graph_state.m_DashArray[1] = 3 * 1.0f;
456         }
457     }
458     CFX_FloatRect rect;
459     GetRect(rect);
460     CPDF_PathData path;
461     width /= 2;
462     path.AppendRect(rect.left + width, rect.bottom + width, rect.right - width, rect.top - width);
463     int fill_type = 0;
464     if (pOptions && (pOptions->m_Flags & RENDER_NOPATHSMOOTH)) {
465         fill_type |= FXFILL_NOPATHSMOOTH;
466     }
467     pDevice->DrawPath(&path, pUser2Device, &graph_state, argb, argb, fill_type);
468 }
469 int CPDF_Annot::CountIRTNotes()
470 {
471     int count = 0;
472     for (int i = 0; i < m_pList->Count(); i ++) {
473         CPDF_Annot* pAnnot = m_pList->GetAt(i);
474         if (pAnnot == NULL) {
475             continue;
476         }
477         CPDF_Dictionary* pIRT = pAnnot->m_pAnnotDict->GetDict("IRT");
478         if (pIRT != m_pAnnotDict) {
479             continue;
480         }
481         count ++;
482     }
483     return count;
484 }
485 CPDF_Annot* CPDF_Annot::GetIRTNote(int index)
486 {
487     int count = 0;
488     for (int i = 0; i < m_pList->Count(); i ++) {
489         CPDF_Annot* pAnnot = m_pList->GetAt(i);
490         if (pAnnot == NULL) {
491             continue;
492         }
493         CPDF_Dictionary* pIRT = pAnnot->m_pAnnotDict->GetDict("IRT");
494         if (pIRT != m_pAnnotDict) {
495             continue;
496         }
497         if (count == index) {
498             return pAnnot;
499         }
500         count ++;
501     }
502     return NULL;
503 }