Merge to XFA: Make conversions for CPDF_Link explicit.
[pdfium.git] / fpdfsdk / src / fpdfdoc.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 "../include/fsdk_define.h"
8 #include "../include/fpdfdoc.h"
9 #include "../include/fpdfxfa/fpdfxfa_doc.h"
10 #include "../include/fpdfxfa/fpdfxfa_page.h"
11
12 static int THISMODULE = 0;
13
14 static CPDF_Bookmark FindBookmark(const CPDF_BookmarkTree& tree, CPDF_Bookmark bookmark, const CFX_WideString& title)
15 {
16         if (bookmark && bookmark.GetTitle().CompareNoCase(title) == 0) {
17                 // First check this item
18                 return bookmark;
19         }
20         // go into children items
21         CPDF_Bookmark child = tree.GetFirstChild(bookmark);
22         while (child) {
23                 // check if this item
24                 CPDF_Bookmark found = FindBookmark(tree, child, title);
25                 if (found)
26                         return found;
27                 child = tree.GetNextSibling(child);
28         }
29         return CPDF_Bookmark();
30 }
31
32 DLLEXPORT FPDF_BOOKMARK STDCALL FPDFBookmark_GetFirstChild(FPDF_DOCUMENT document, FPDF_BOOKMARK pDict)
33 {
34     if (!document || !pDict)
35         return NULL;
36         CPDF_Document* pDoc = ((CPDFXFA_Document*)document)->GetPDFDoc();
37     CPDF_BookmarkTree tree(pDoc);
38     CPDF_Bookmark bookmark = CPDF_Bookmark((CPDF_Dictionary*)pDict);
39     return tree.GetFirstChild(bookmark).GetDict();
40 }
41
42 DLLEXPORT FPDF_BOOKMARK STDCALL FPDFBookmark_GetNextSibling(FPDF_DOCUMENT document, FPDF_BOOKMARK pDict)
43 {
44     if (!document || !pDict)
45         return NULL;
46         CPDF_Document* pDoc = ((CPDFXFA_Document*)document)->GetPDFDoc();
47     CPDF_BookmarkTree tree(pDoc);
48     CPDF_Bookmark bookmark = CPDF_Bookmark((CPDF_Dictionary*)pDict);
49     return tree.GetNextSibling(bookmark).GetDict();
50 }
51
52 DLLEXPORT unsigned long STDCALL FPDFBookmark_GetTitle(FPDF_BOOKMARK pDict, void* buffer, unsigned long buflen)
53 {
54     if (!pDict)
55         return 0;
56     CPDF_Bookmark bookmark((CPDF_Dictionary*)pDict);
57     CFX_WideString title = bookmark.GetTitle();
58     CFX_ByteString encodedTitle = title.UTF16LE_Encode();
59     unsigned long len = encodedTitle.GetLength();
60     if (buffer && buflen >= len) {
61         FXSYS_memcpy(buffer, encodedTitle.c_str(), len);
62     }
63     return len;
64 }
65
66 DLLEXPORT FPDF_BOOKMARK STDCALL FPDFBookmark_Find(FPDF_DOCUMENT document, FPDF_WIDESTRING title)
67 {
68         if (!document)
69                 return NULL;
70         if (!title || title[0] == 0)
71                 return NULL;
72         CPDF_Document* pDoc = ((CPDFXFA_Document*)document)->GetPDFDoc();
73         CPDF_BookmarkTree tree(pDoc);
74         FX_STRSIZE len = CFX_WideString::WStringLength(title);
75         CFX_WideString encodedTitle = CFX_WideString::FromUTF16LE(title, len);
76         return FindBookmark(tree, CPDF_Bookmark(), encodedTitle).GetDict();
77 }
78
79 DLLEXPORT FPDF_DEST STDCALL FPDFBookmark_GetDest(FPDF_DOCUMENT document, FPDF_BOOKMARK pDict)
80 {
81         if (!document)
82                 return NULL;
83         if (!pDict)
84                 return NULL;
85         CPDF_Bookmark bookmark((CPDF_Dictionary*)pDict);
86         CPDF_Document* pDoc = ((CPDFXFA_Document*)document)->GetPDFDoc();
87         CPDF_Dest dest = bookmark.GetDest(pDoc);
88         if (dest)
89                 return dest.GetObject();
90         // If this bookmark is not directly associated with a dest, we try to get action
91         CPDF_Action action = bookmark.GetAction();
92         if (!action)
93                 return NULL;
94         return action.GetDest(pDoc).GetObject();
95 }
96
97 DLLEXPORT FPDF_ACTION STDCALL FPDFBookmark_GetAction(FPDF_BOOKMARK pDict)
98 {
99         if (!pDict)
100                 return NULL;
101         CPDF_Bookmark bookmark((CPDF_Dictionary*)pDict);
102         return bookmark.GetAction().GetDict();
103 }
104
105 DLLEXPORT unsigned long STDCALL FPDFAction_GetType(FPDF_ACTION pDict)
106 {
107         if (!pDict)
108                 return 0;
109         CPDF_Action action((CPDF_Dictionary*)pDict);
110         CPDF_Action::ActionType type = action.GetType();
111         switch (type) {
112                 case CPDF_Action::GoTo:
113                         return PDFACTION_GOTO;
114                 case CPDF_Action::GoToR:
115                         return PDFACTION_REMOTEGOTO;
116                 case CPDF_Action::URI:
117                         return PDFACTION_URI;
118                 case CPDF_Action::Launch:
119                         return PDFACTION_LAUNCH;
120                 default:
121                         return PDFACTION_UNSUPPORTED;
122         }
123         return PDFACTION_UNSUPPORTED;
124 }
125
126 DLLEXPORT FPDF_DEST STDCALL FPDFAction_GetDest(FPDF_DOCUMENT document, FPDF_ACTION pDict)
127 {
128         if (!document)
129                 return NULL;
130         if (!pDict)
131                 return NULL;
132         CPDF_Document* pDoc = ((CPDFXFA_Document*)document)->GetPDFDoc();
133         CPDF_Action action((CPDF_Dictionary*)pDict);
134         return action.GetDest(pDoc).GetObject();
135 }
136
137 DLLEXPORT unsigned long STDCALL FPDFAction_GetURIPath(FPDF_DOCUMENT document, FPDF_ACTION pDict,
138                                                                                           void* buffer, unsigned long buflen)
139 {
140         if (!document)
141                 return 0;
142         if (!pDict)
143                 return 0;
144         CPDF_Document* pDoc = ((CPDFXFA_Document*)document)->GetPDFDoc();
145         CPDF_Action action((CPDF_Dictionary*)pDict);
146         CFX_ByteString path = action.GetURI(pDoc);
147         unsigned long len = path.GetLength() + 1;
148         if (buffer != NULL && buflen >= len)
149                 FXSYS_memcpy(buffer, path.c_str(), len);
150         return len;
151 }
152
153 DLLEXPORT unsigned long STDCALL FPDFDest_GetPageIndex(FPDF_DOCUMENT document, FPDF_DEST pDict)
154 {
155         if (!document)
156                 return 0;
157         if (!pDict)
158                 return 0;
159         CPDF_Document* pDoc = ((CPDFXFA_Document*)document)->GetPDFDoc();
160         CPDF_Dest dest((CPDF_Array*)pDict);
161         return dest.GetPageIndex(pDoc);
162 }
163
164 static void ReleaseLinkList(FX_LPVOID data)
165 {
166         delete (CPDF_LinkList*)data;
167 }
168
169 DLLEXPORT FPDF_LINK STDCALL FPDFLink_GetLinkAtPoint(FPDF_PAGE page, double x, double y)
170 {
171         if (!page)
172                 return NULL;
173     CPDF_Page* pPage = ((CPDFXFA_Page*)page)->GetPDFPage();
174         if (!pPage)
175                 return NULL;
176         // Link list is stored with the document
177         CPDF_Document* pDoc = pPage->m_pDocument;
178         CPDF_LinkList* pLinkList = (CPDF_LinkList*)pDoc->GetPrivateData(&THISMODULE);
179         if (!pLinkList) {
180                 pLinkList = FX_NEW CPDF_LinkList(pDoc);
181                 pDoc->SetPrivateData(&THISMODULE, pLinkList, ReleaseLinkList);
182         }
183         return pLinkList->GetLinkAtPoint(pPage, (FX_FLOAT)x, (FX_FLOAT)y).GetDict();
184 }
185
186 DLLEXPORT FPDF_DEST STDCALL FPDFLink_GetDest(FPDF_DOCUMENT document, FPDF_LINK pDict)
187 {
188         if (!document)
189                 return NULL;
190         if (!pDict)
191                 return NULL;
192         CPDF_Document* pDoc = ((CPDFXFA_Document*)document)->GetPDFDoc();
193         CPDF_Link link((CPDF_Dictionary*)pDict);
194         FPDF_DEST dest = link.GetDest(pDoc).GetObject();
195         if (dest)
196                 return dest;
197         // If this link is not directly associated with a dest, we try to get action
198         CPDF_Action action = link.GetAction();
199         if (!action)
200                 return NULL;
201         return action.GetDest(pDoc).GetObject();
202 }
203
204 DLLEXPORT FPDF_ACTION STDCALL FPDFLink_GetAction(FPDF_LINK pDict)
205 {
206         if (!pDict)
207                 return NULL;
208         CPDF_Link link((CPDF_Dictionary*)pDict);
209         return link.GetAction().GetDict();
210 }
211
212 DLLEXPORT FPDF_BOOL STDCALL FPDFLink_Enumerate(FPDF_PAGE page, int* startPos, FPDF_LINK* linkAnnot)
213 {
214         if(!page || !startPos || !linkAnnot)
215                 return FALSE;
216     CPDF_Page* pPage = ((CPDFXFA_Page*)page)->GetPDFPage();
217         if(!pPage->m_pFormDict)
218                 return FALSE;
219         CPDF_Array* pAnnots = pPage->m_pFormDict->GetArray("Annots");
220         if(!pAnnots)
221                 return FALSE;
222         for (int i = *startPos; i < (int)pAnnots->GetCount(); i++) {
223                 CPDF_Dictionary* pDict = (CPDF_Dictionary*)pAnnots->GetElementValue(i);
224                 if (!pDict || pDict->GetType() != PDFOBJ_DICTIONARY)
225                         continue;
226                 if(pDict->GetString(FX_BSTRC("Subtype")).Equal(FX_BSTRC("Link"))) {
227                         *startPos = i + 1;
228                         *linkAnnot = (FPDF_LINK)pDict; 
229                         return TRUE;
230                 }
231         }
232         return FALSE;
233 }
234
235 DLLEXPORT FPDF_BOOL STDCALL FPDFLink_GetAnnotRect(FPDF_LINK linkAnnot, FS_RECTF* rect)
236 {
237         if(!linkAnnot || !rect)
238                 return FALSE;
239         CPDF_Dictionary* pAnnotDict = (CPDF_Dictionary*)linkAnnot;
240         CPDF_Rect rt = pAnnotDict->GetRect(FX_BSTRC("Rect"));
241         rect->left = rt.left;
242         rect->bottom = rt.bottom;
243         rect->right = rt.right;
244         rect->top = rt.top;
245         return TRUE;
246 }
247
248 DLLEXPORT int STDCALL FPDFLink_CountQuadPoints(FPDF_LINK linkAnnot)
249 {
250         if(!linkAnnot)
251                 return 0;
252         CPDF_Dictionary* pAnnotDict = (CPDF_Dictionary*)linkAnnot;
253         CPDF_Array* pArray = pAnnotDict->GetArray(FX_BSTRC("QuadPoints"));
254         if (!pArray)
255                 return 0;
256         else
257                 return pArray->GetCount() / 8;
258 }
259
260 DLLEXPORT FPDF_BOOL STDCALL FPDFLink_GetQuadPoints(FPDF_LINK linkAnnot, int quadIndex, FS_QUADPOINTSF* quadPoints)
261 {
262         if(!linkAnnot || !quadPoints)
263                 return FALSE;
264         CPDF_Dictionary* pAnnotDict = (CPDF_Dictionary*)linkAnnot;
265         CPDF_Array* pArray = pAnnotDict->GetArray(FX_BSTRC("QuadPoints"));
266         if (pArray) {
267                 if (quadIndex < 0 || quadIndex >= (int)pArray->GetCount()/8 || ((quadIndex*8+7) >= (int)pArray->GetCount()))
268                         return FALSE;
269                 quadPoints->x1 = pArray->GetNumber(quadIndex*8);
270                 quadPoints->y1 = pArray->GetNumber(quadIndex*8+1);
271                 quadPoints->x2 = pArray->GetNumber(quadIndex*8+2);
272                 quadPoints->y2 = pArray->GetNumber(quadIndex*8+3);
273                 quadPoints->x3 = pArray->GetNumber(quadIndex*8+4);
274                 quadPoints->y3 = pArray->GetNumber(quadIndex*8+5);
275                 quadPoints->x4 = pArray->GetNumber(quadIndex*8+6);
276                 quadPoints->y4 = pArray->GetNumber(quadIndex*8+7);
277                 return TRUE;
278         } 
279         return FALSE;
280 }
281
282 DLLEXPORT unsigned long STDCALL FPDF_GetMetaText(FPDF_DOCUMENT doc, FPDF_BYTESTRING tag,
283                                                                                                  void* buffer, unsigned long buflen)
284 {
285         if (!doc || !tag)
286                 return 0;
287     CPDF_Document* pDoc = ((CPDFXFA_Document*)doc)->GetPDFDoc();
288         // Get info dictionary
289         CPDF_Dictionary* pInfo = pDoc->GetInfo();
290         if (!pInfo)
291                 return 0;
292         CFX_WideString text = pInfo->GetUnicodeText(tag);
293         // Use UTF-16LE encoding
294         CFX_ByteString encodedText = text.UTF16LE_Encode();
295         unsigned long len = encodedText.GetLength();
296         if (buffer && buflen >= len) {
297                 FXSYS_memcpy(buffer, encodedText.c_str(), len);
298         }
299         return len;
300 }