Initial commit.
[pdfium.git] / core / src / fpdfdoc / doc_formcontrol.cpp
1 // Copyright 2014 PDFium Authors. All rights reserved.\r
2 // Use of this source code is governed by a BSD-style license that can be\r
3 // found in the LICENSE file.\r
4  \r
5 // Original code copyright 2014 Foxit Software Inc. http://www.foxitsoftware.com\r
6 \r
7 #include "../../include/fpdfdoc/fpdf_doc.h"\r
8 CPDF_FormControl::CPDF_FormControl(CPDF_FormField* pField, CPDF_Dictionary* pWidgetDict)\r
9 {\r
10     m_pField = pField;\r
11     m_pWidgetDict = pWidgetDict;\r
12     m_pForm = m_pField->m_pForm;\r
13 }\r
14 CFX_FloatRect CPDF_FormControl::GetRect()\r
15 {\r
16     return m_pWidgetDict->GetRect("Rect");\r
17 }\r
18 CFX_ByteString CPDF_FormControl::GetOnStateName()\r
19 {\r
20     ASSERT(GetType() == CPDF_FormField::CheckBox || GetType() == CPDF_FormField::RadioButton);\r
21     CFX_ByteString csOn;\r
22     CPDF_Dictionary* pAP = m_pWidgetDict->GetDict("AP");\r
23     if (pAP == NULL) {\r
24         return csOn;\r
25     }\r
26     CPDF_Dictionary* pN = pAP->GetDict("N");\r
27     if (pN == NULL) {\r
28         return csOn;\r
29     }\r
30     FX_POSITION pos = pN->GetStartPos();\r
31     while (pos) {\r
32         pN->GetNextElement(pos, csOn);\r
33         if (csOn != "Off") {\r
34             return csOn;\r
35         }\r
36     }\r
37     return CFX_ByteString();\r
38 }\r
39 void CPDF_FormControl::SetOnStateName(const CFX_ByteString& csOn)\r
40 {\r
41     ASSERT(GetType() == CPDF_FormField::CheckBox || GetType() == CPDF_FormField::RadioButton);\r
42     CFX_ByteString csValue = csOn;\r
43     if (csValue.IsEmpty()) {\r
44         csValue = "Yes";\r
45     }\r
46     if (csValue == "Off") {\r
47         csValue = "Yes";\r
48     }\r
49     CFX_ByteString csAS = m_pWidgetDict->GetString("AS", "Off");\r
50     if (csAS != "Off") {\r
51         m_pWidgetDict->SetAtName("AS", csValue);\r
52     }\r
53     CPDF_Dictionary* pAP = m_pWidgetDict->GetDict("AP");\r
54     if (pAP == NULL) {\r
55         return;\r
56     }\r
57     FX_POSITION pos1 = pAP->GetStartPos();\r
58     while (pos1) {\r
59         CFX_ByteString csKey1;\r
60         CPDF_Object* pObj1 = pAP->GetNextElement(pos1, csKey1);\r
61         if (pObj1 == NULL) {\r
62             continue;\r
63         }\r
64         CPDF_Object* pObjDirect1 = pObj1->GetDirect();\r
65         if (pObjDirect1->GetType() != PDFOBJ_DICTIONARY) {\r
66             continue;\r
67         }\r
68         CPDF_Dictionary* pSubDict = (CPDF_Dictionary*)pObjDirect1;\r
69         FX_POSITION pos2 = pSubDict->GetStartPos();\r
70         while (pos2) {\r
71             CFX_ByteString csKey2;\r
72             CPDF_Object* pObj2 = pSubDict->GetNextElement(pos2, csKey2);\r
73             if (pObj2 == NULL) {\r
74                 continue;\r
75             }\r
76             if (csKey2 != "Off") {\r
77                 pSubDict->ReplaceKey(csKey2, csValue);\r
78                 break;\r
79             }\r
80         }\r
81     }\r
82 }\r
83 CFX_ByteString CPDF_FormControl::GetCheckedAPState()\r
84 {\r
85     ASSERT(GetType() == CPDF_FormField::CheckBox || GetType() == CPDF_FormField::RadioButton);\r
86     CFX_ByteString csOn = GetOnStateName();\r
87     if (GetType() == CPDF_FormField::RadioButton || GetType() == CPDF_FormField::CheckBox) {\r
88         CPDF_Object* pOpt = FPDF_GetFieldAttr(m_pField->m_pDict, "Opt");\r
89         if (pOpt != NULL && pOpt->GetType() == PDFOBJ_ARRAY) {\r
90             int iIndex = m_pField->GetControlIndex(this);\r
91             csOn.Format("%d", iIndex);\r
92         }\r
93     }\r
94     if (csOn.IsEmpty()) {\r
95         csOn = "Yes";\r
96     }\r
97     return csOn;\r
98 }\r
99 CFX_WideString CPDF_FormControl::GetExportValue()\r
100 {\r
101     ASSERT(GetType() == CPDF_FormField::CheckBox || GetType() == CPDF_FormField::RadioButton);\r
102     CFX_ByteString csOn = GetOnStateName();\r
103     if (GetType() == CPDF_FormField::RadioButton || GetType() == CPDF_FormField::CheckBox) {\r
104         CPDF_Object* pOpt = FPDF_GetFieldAttr(m_pField->m_pDict, "Opt");\r
105         if (pOpt != NULL && pOpt->GetType() == PDFOBJ_ARRAY) {\r
106             int iIndex = m_pField->GetControlIndex(this);\r
107             csOn = ((CPDF_Array*)pOpt)->GetString(iIndex);\r
108         }\r
109     }\r
110     if (csOn.IsEmpty()) {\r
111         csOn = "Yes";\r
112     }\r
113     CFX_WideString csWOn = PDF_DecodeText(csOn);\r
114     return csWOn;\r
115 }\r
116 FX_BOOL CPDF_FormControl::IsChecked()\r
117 {\r
118     ASSERT(GetType() == CPDF_FormField::CheckBox || GetType() == CPDF_FormField::RadioButton);\r
119     CFX_ByteString csOn = GetOnStateName();\r
120     CFX_ByteString csAS = m_pWidgetDict->GetString("AS");\r
121     return csAS == csOn;\r
122 }\r
123 FX_BOOL CPDF_FormControl::IsDefaultChecked()\r
124 {\r
125     ASSERT(GetType() == CPDF_FormField::CheckBox || GetType() == CPDF_FormField::RadioButton);\r
126     CPDF_Object* pDV = FPDF_GetFieldAttr(m_pField->m_pDict, "DV");\r
127     if (pDV == NULL) {\r
128         return FALSE;\r
129     }\r
130     CFX_ByteString csDV = pDV->GetString();\r
131     CFX_ByteString csOn = GetOnStateName();\r
132     return (csDV == csOn);\r
133 }\r
134 void CPDF_FormControl::CheckControl(FX_BOOL bChecked)\r
135 {\r
136     ASSERT(GetType() == CPDF_FormField::CheckBox || GetType() == CPDF_FormField::RadioButton);\r
137     CFX_ByteString csOn = GetOnStateName();\r
138     CFX_ByteString csOldAS = m_pWidgetDict->GetString("AS", "Off");\r
139     CFX_ByteString csAS = "Off";\r
140     if (bChecked) {\r
141         csAS = csOn;\r
142     }\r
143     if (csOldAS == csAS) {\r
144         return;\r
145     }\r
146     m_pWidgetDict->SetAtName("AS", csAS);\r
147     m_pForm->m_bUpdated = TRUE;\r
148 }\r
149 CPDF_Stream* FPDFDOC_GetAnnotAP(CPDF_Dictionary* pAnnotDict, CPDF_Annot::AppearanceMode mode);\r
150 void CPDF_FormControl::DrawControl(CFX_RenderDevice* pDevice, CFX_AffineMatrix* pMatrix, CPDF_Page* pPage,\r
151                                    CPDF_Annot::AppearanceMode mode, const CPDF_RenderOptions* pOptions)\r
152 {\r
153     if (m_pWidgetDict->GetInteger("F") & ANNOTFLAG_HIDDEN) {\r
154         return;\r
155     }\r
156     CPDF_Stream* pStream = FPDFDOC_GetAnnotAP(m_pWidgetDict, mode);\r
157     if (pStream == NULL) {\r
158         return;\r
159     }\r
160     CFX_FloatRect form_bbox = pStream->GetDict()->GetRect("BBox");\r
161     CFX_AffineMatrix form_matrix = pStream->GetDict()->GetMatrix("Matrix");\r
162     form_matrix.TransformRect(form_bbox);\r
163     CFX_FloatRect arect = m_pWidgetDict->GetRect("Rect");\r
164     CFX_AffineMatrix matrix;\r
165     matrix.MatchRect(arect, form_bbox);\r
166     matrix.Concat(*pMatrix);\r
167     CPDF_Form form(m_pField->m_pForm->m_pDocument, m_pField->m_pForm->m_pFormDict->GetDict("DR"), pStream);\r
168     form.ParseContent(NULL, NULL, NULL, NULL);\r
169     CPDF_RenderContext context;\r
170     context.Create(pPage);\r
171     context.DrawObjectList(pDevice, &form, &matrix, pOptions);\r
172 }\r
173 const FX_CHAR* g_sHighlightingMode[] = {"N", "I", "O", "P", "T", ""};\r
174 CPDF_FormControl::HighlightingMode CPDF_FormControl::GetHighlightingMode()\r
175 {\r
176     if (m_pWidgetDict == NULL) {\r
177         return Invert;\r
178     }\r
179     CFX_ByteString csH = m_pWidgetDict->GetString("H", "I");\r
180     int i = 0;\r
181     while (g_sHighlightingMode[i][0] != '\0') {\r
182         if (csH.Equal(g_sHighlightingMode[i])) {\r
183             return (HighlightingMode)i;\r
184         }\r
185         i ++;\r
186     }\r
187     return Invert;\r
188 }\r
189 CPDF_ApSettings CPDF_FormControl::GetMK(FX_BOOL bCreate)\r
190 {\r
191     if (!m_pWidgetDict) {\r
192         return NULL;\r
193     }\r
194     CPDF_ApSettings mk = m_pWidgetDict->GetDict(FX_BSTRC("MK"));\r
195     if (!mk && bCreate) {\r
196         mk = CPDF_Dictionary::Create();\r
197         if (mk == NULL) {\r
198             return NULL;\r
199         }\r
200         m_pWidgetDict->SetAt(FX_BSTRC("MK"), mk);\r
201     }\r
202     return mk;\r
203 }\r
204 FX_BOOL CPDF_FormControl::HasMKEntry(CFX_ByteString csEntry)\r
205 {\r
206     CPDF_ApSettings mk = GetMK(FALSE);\r
207     return mk.HasMKEntry(csEntry);\r
208 }\r
209 int CPDF_FormControl::GetRotation()\r
210 {\r
211     CPDF_ApSettings mk = GetMK(FALSE);\r
212     return mk.GetRotation();\r
213 }\r
214 FX_ARGB CPDF_FormControl::GetColor(int& iColorType, CFX_ByteString csEntry)\r
215 {\r
216     CPDF_ApSettings mk = GetMK(FALSE);\r
217     return mk.GetColor(iColorType, csEntry);\r
218 }\r
219 FX_FLOAT CPDF_FormControl::GetOriginalColor(int index, CFX_ByteString csEntry)\r
220 {\r
221     CPDF_ApSettings mk = GetMK(FALSE);\r
222     return mk.GetOriginalColor(index, csEntry);\r
223 }\r
224 void CPDF_FormControl::GetOriginalColor(int& iColorType, FX_FLOAT fc[4], CFX_ByteString csEntry)\r
225 {\r
226     CPDF_ApSettings mk = GetMK(FALSE);\r
227     mk.GetOriginalColor(iColorType, fc, csEntry);\r
228 }\r
229 CFX_WideString CPDF_FormControl::GetCaption(CFX_ByteString csEntry)\r
230 {\r
231     CPDF_ApSettings mk = GetMK(FALSE);\r
232     return mk.GetCaption(csEntry);\r
233 }\r
234 CPDF_Stream* CPDF_FormControl::GetIcon(CFX_ByteString csEntry)\r
235 {\r
236     CPDF_ApSettings mk = GetMK(FALSE);\r
237     return mk.GetIcon(csEntry);\r
238 }\r
239 CPDF_IconFit CPDF_FormControl::GetIconFit()\r
240 {\r
241     CPDF_ApSettings mk = GetMK(FALSE);\r
242     return mk.GetIconFit();\r
243 }\r
244 int CPDF_FormControl::GetTextPosition()\r
245 {\r
246     CPDF_ApSettings mk = GetMK(FALSE);\r
247     return mk.GetTextPosition();\r
248 }\r
249 CPDF_Action CPDF_FormControl::GetAction()\r
250 {\r
251     if (m_pWidgetDict == NULL) {\r
252         return NULL;\r
253     }\r
254     if (m_pWidgetDict->KeyExist("A")) {\r
255         return m_pWidgetDict->GetDict("A");\r
256     } else {\r
257         CPDF_Object* pObj = FPDF_GetFieldAttr(m_pField->m_pDict, "A");\r
258         if (pObj == NULL) {\r
259             return NULL;\r
260         }\r
261         return pObj->GetDict();\r
262     }\r
263 }\r
264 CPDF_AAction CPDF_FormControl::GetAdditionalAction()\r
265 {\r
266     if (m_pWidgetDict == NULL) {\r
267         return NULL;\r
268     }\r
269     if (m_pWidgetDict->KeyExist("AA")) {\r
270         return m_pWidgetDict->GetDict("AA");\r
271     } else {\r
272         return m_pField->GetAdditionalAction();\r
273     }\r
274 }\r
275 CPDF_DefaultAppearance CPDF_FormControl::GetDefaultAppearance()\r
276 {\r
277     if (m_pWidgetDict == NULL) {\r
278         return CFX_ByteString();\r
279     }\r
280     if (m_pWidgetDict->KeyExist("DA")) {\r
281         return m_pWidgetDict->GetString("DA");\r
282     } else {\r
283         CPDF_Object* pObj = FPDF_GetFieldAttr(m_pField->m_pDict, "DA");\r
284         if (pObj == NULL) {\r
285             return m_pField->m_pForm->GetDefaultAppearance();\r
286         }\r
287         return pObj->GetString();\r
288     }\r
289 }\r
290 CPDF_Font* CPDF_FormControl::GetDefaultControlFont()\r
291 {\r
292     CPDF_DefaultAppearance cDA = GetDefaultAppearance();\r
293     CFX_ByteString csFontNameTag;\r
294     FX_FLOAT fFontSize;\r
295     cDA.GetFont(csFontNameTag, fFontSize);\r
296     if (csFontNameTag.IsEmpty()) {\r
297         return NULL;\r
298     }\r
299     CPDF_Object* pObj = FPDF_GetFieldAttr(m_pWidgetDict, "DR");\r
300     if (pObj != NULL && pObj->GetType() == PDFOBJ_DICTIONARY) {\r
301         CPDF_Dictionary* pFonts = ((CPDF_Dictionary*)pObj)->GetDict("Font");\r
302         if (pFonts != NULL) {\r
303             CPDF_Dictionary *pElement = pFonts->GetDict(csFontNameTag);\r
304             CPDF_Font *pFont = m_pField->m_pForm->m_pDocument->LoadFont(pElement);\r
305             if (pFont != NULL) {\r
306                 return pFont;\r
307             }\r
308         }\r
309     }\r
310     CPDF_Font *pFont = m_pField->m_pForm->GetFormFont(csFontNameTag);\r
311     if (pFont != NULL) {\r
312         return pFont;\r
313     }\r
314     CPDF_Dictionary *pPageDict = m_pWidgetDict->GetDict("P");\r
315     pObj = FPDF_GetFieldAttr(pPageDict, "Resources");\r
316     if (pObj != NULL && pObj->GetType() == PDFOBJ_DICTIONARY) {\r
317         CPDF_Dictionary* pFonts = ((CPDF_Dictionary*)pObj)->GetDict("Font");\r
318         if (pFonts != NULL) {\r
319             CPDF_Dictionary *pElement = pFonts->GetDict(csFontNameTag);\r
320             CPDF_Font *pFont = m_pField->m_pForm->m_pDocument->LoadFont(pElement);\r
321             if (pFont != NULL) {\r
322                 return pFont;\r
323             }\r
324         }\r
325     }\r
326     return NULL;\r
327 }\r
328 int CPDF_FormControl::GetControlAlignment()\r
329 {\r
330     if (m_pWidgetDict == NULL) {\r
331         return 0;\r
332     }\r
333     if (m_pWidgetDict->KeyExist("Q")) {\r
334         return m_pWidgetDict->GetInteger("Q", 0);\r
335     } else {\r
336         CPDF_Object* pObj = FPDF_GetFieldAttr(m_pField->m_pDict, "Q");\r
337         if (pObj == NULL) {\r
338             return m_pField->m_pForm->GetFormAlignment();\r
339         }\r
340         return pObj->GetInteger();\r
341     }\r
342 }\r
343 FX_BOOL CPDF_ApSettings::HasMKEntry(FX_BSTR csEntry)\r
344 {\r
345     if (m_pDict == NULL) {\r
346         return FALSE;\r
347     }\r
348     return m_pDict->KeyExist(csEntry);\r
349 }\r
350 int CPDF_ApSettings::GetRotation()\r
351 {\r
352     if (m_pDict == NULL) {\r
353         return 0;\r
354     }\r
355     return m_pDict->GetInteger(FX_BSTRC("R"));\r
356 }\r
357 FX_ARGB CPDF_ApSettings::GetColor(int& iColorType, FX_BSTR csEntry)\r
358 {\r
359     iColorType = COLORTYPE_TRANSPARENT;\r
360     if (m_pDict == NULL) {\r
361         return 0;\r
362     }\r
363     FX_ARGB color = 0;\r
364     CPDF_Array* pEntry = m_pDict->GetArray(csEntry);\r
365     if (pEntry == NULL) {\r
366         return color;\r
367     }\r
368     FX_DWORD dwCount = pEntry->GetCount();\r
369     if (dwCount == 1) {\r
370         iColorType = COLORTYPE_GRAY;\r
371         FX_FLOAT g = pEntry->GetNumber(0) * 255;\r
372         color = ArgbEncode(255, (int)g, (int)g, (int)g);\r
373     } else if (dwCount == 3) {\r
374         iColorType = COLORTYPE_RGB;\r
375         FX_FLOAT r = pEntry->GetNumber(0) * 255;\r
376         FX_FLOAT g = pEntry->GetNumber(1) * 255;\r
377         FX_FLOAT b = pEntry->GetNumber(2) * 255;\r
378         color = ArgbEncode(255, (int)r, (int)g, (int)b);\r
379     } else if (dwCount == 4) {\r
380         iColorType = COLORTYPE_CMYK;\r
381         FX_FLOAT c = pEntry->GetNumber(0);\r
382         FX_FLOAT m = pEntry->GetNumber(1);\r
383         FX_FLOAT y = pEntry->GetNumber(2);\r
384         FX_FLOAT k = pEntry->GetNumber(3);\r
385         FX_FLOAT r = 1.0f - FX_MIN(1.0f, c + k);\r
386         FX_FLOAT g = 1.0f - FX_MIN(1.0f, m + k);\r
387         FX_FLOAT b = 1.0f - FX_MIN(1.0f, y + k);\r
388         color = ArgbEncode(255, (int)(r * 255), (int)(g * 255), (int)(b * 255));\r
389     }\r
390     return color;\r
391 }\r
392 FX_FLOAT CPDF_ApSettings::GetOriginalColor(int index, FX_BSTR csEntry)\r
393 {\r
394     if (m_pDict == NULL) {\r
395         return 0;\r
396     }\r
397     CPDF_Array* pEntry = m_pDict->GetArray(csEntry);\r
398     if (pEntry != NULL) {\r
399         return pEntry->GetNumber(index);\r
400     }\r
401     return 0;\r
402 }\r
403 void CPDF_ApSettings::GetOriginalColor(int& iColorType, FX_FLOAT fc[4], FX_BSTR csEntry)\r
404 {\r
405     iColorType = COLORTYPE_TRANSPARENT;\r
406     for (int i = 0; i < 4; i ++) {\r
407         fc[i] = 0;\r
408     }\r
409     if (m_pDict == NULL) {\r
410         return;\r
411     }\r
412     CPDF_Array* pEntry = m_pDict->GetArray(csEntry);\r
413     if (pEntry == NULL) {\r
414         return;\r
415     }\r
416     FX_DWORD dwCount = pEntry->GetCount();\r
417     if (dwCount == 1) {\r
418         iColorType = COLORTYPE_GRAY;\r
419         fc[0] = pEntry->GetNumber(0);\r
420     } else if (dwCount == 3) {\r
421         iColorType = COLORTYPE_RGB;\r
422         fc[0] = pEntry->GetNumber(0);\r
423         fc[1] = pEntry->GetNumber(1);\r
424         fc[2] = pEntry->GetNumber(2);\r
425     } else if (dwCount == 4) {\r
426         iColorType = COLORTYPE_CMYK;\r
427         fc[0] = pEntry->GetNumber(0);\r
428         fc[1] = pEntry->GetNumber(1);\r
429         fc[2] = pEntry->GetNumber(2);\r
430         fc[3] = pEntry->GetNumber(3);\r
431     }\r
432 }\r
433 CFX_WideString CPDF_ApSettings::GetCaption(FX_BSTR csEntry)\r
434 {\r
435     CFX_WideString csCaption;\r
436     if (m_pDict == NULL) {\r
437         return csCaption;\r
438     }\r
439     return m_pDict->GetUnicodeText(csEntry);\r
440 }\r
441 CPDF_Stream* CPDF_ApSettings::GetIcon(FX_BSTR csEntry)\r
442 {\r
443     if (m_pDict == NULL) {\r
444         return NULL;\r
445     }\r
446     return m_pDict->GetStream(csEntry);\r
447 }\r
448 CPDF_IconFit CPDF_ApSettings::GetIconFit()\r
449 {\r
450     if (m_pDict == NULL) {\r
451         return NULL;\r
452     }\r
453     return m_pDict->GetDict(FX_BSTRC("IF"));\r
454 }\r
455 int CPDF_ApSettings::GetTextPosition()\r
456 {\r
457     if (m_pDict == NULL) {\r
458         return TEXTPOS_CAPTION;\r
459     }\r
460     return m_pDict->GetInteger(FX_BSTRC("TP"), TEXTPOS_CAPTION);\r
461 }\r