blob: 12a77146d71a276d5a344982b4e86664597776b3 [file] [log] [blame]
John Abd-El-Malek3f3b45c2014-05-23 17:28:10 -07001// 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.
Tom Sepez9857e202015-05-13 17:09:26 -07004
John Abd-El-Malek3f3b45c2014-05-23 17:28:10 -07005// Original code copyright 2014 Foxit Software Inc. http://www.foxitsoftware.com
6
Tom Sepez9857e202015-05-13 17:09:26 -07007#ifndef PUBLIC_FPDF_DATAAVAIL_H_
8#define PUBLIC_FPDF_DATAAVAIL_H_
John Abd-El-Malek3f3b45c2014-05-23 17:28:10 -07009
dan sinclairea10a0d2016-03-23 19:36:46 -040010#include <stddef.h>
John Abd-El-Malek3f3b45c2014-05-23 17:28:10 -070011
Dan Sinclair85c8e7f2016-11-21 13:50:32 -050012// NOLINTNEXTLINE(build/include)
Tom Sepez245c80e2015-04-08 16:19:33 -070013#include "fpdfview.h"
John Abd-El-Malek3f3b45c2014-05-23 17:28:10 -070014
Jun Fangdf7f3662015-11-10 18:29:18 +080015#define PDF_LINEARIZATION_UNKNOWN -1
16#define PDF_NOT_LINEARIZED 0
17#define PDF_LINEARIZED 1
Tom Sepez326a2a72015-11-20 10:47:32 -080018
Jun Fangdf7f3662015-11-10 18:29:18 +080019#define PDF_DATA_ERROR -1
20#define PDF_DATA_NOTAVAIL 0
21#define PDF_DATA_AVAIL 1
Tom Sepez326a2a72015-11-20 10:47:32 -080022
Jun Fangdf7f3662015-11-10 18:29:18 +080023#define PDF_FORM_ERROR -1
24#define PDF_FORM_NOTAVAIL 0
25#define PDF_FORM_AVAIL 1
26#define PDF_FORM_NOTEXIST 2
John Abd-El-Malek3f3b45c2014-05-23 17:28:10 -070027
28#ifdef __cplusplus
29extern "C" {
dan sinclairea10a0d2016-03-23 19:36:46 -040030#endif // __cplusplus
John Abd-El-Malek3f3b45c2014-05-23 17:28:10 -070031
dan sinclairea10a0d2016-03-23 19:36:46 -040032// Interface for checking whether sections of the file are available.
John Abd-El-Malek3f3b45c2014-05-23 17:28:10 -070033typedef struct _FX_FILEAVAIL {
dan sinclairea10a0d2016-03-23 19:36:46 -040034 // Version number of the interface. Must be 1.
Nico Weber9d8ec5a2015-08-04 13:00:21 -070035 int version;
John Abd-El-Malek3f3b45c2014-05-23 17:28:10 -070036
dan sinclairea10a0d2016-03-23 19:36:46 -040037 // Reports if the specified data section is currently available. A section is
38 // available if all bytes in the section are available.
39 //
40 // Interface Version: 1
41 // Implementation Required: Yes
42 //
43 // pThis - pointer to the interface structure.
44 // offset - the offset of the data section in the file.
45 // size - the size of the data section.
46 //
47 // Returns true if the specified data section at |offset| of |size|
48 // is available.
Dan Sinclair3ebd1212016-03-09 09:59:23 -050049 FPDF_BOOL (*IsDataAvail)(struct _FX_FILEAVAIL* pThis,
50 size_t offset,
51 size_t size);
John Abd-El-Malek3f3b45c2014-05-23 17:28:10 -070052} FX_FILEAVAIL;
John Abd-El-Malek3f3b45c2014-05-23 17:28:10 -070053typedef void* FPDF_AVAIL;
54
dan sinclairea10a0d2016-03-23 19:36:46 -040055// Create a document availability provider.
56//
57// file_avail - pointer to file availability interface.
58// file - pointer to a file access interface.
59//
60// Returns a handle to the document availability provider, or NULL on error.
61//
62// |FPDFAvail_Destroy| must be called when done with the availability provider.
Dan Sinclair00d2ad12017-08-10 14:13:02 -040063FPDF_EXPORT FPDF_AVAIL FPDF_CALLCONV FPDFAvail_Create(FX_FILEAVAIL* file_avail,
64 FPDF_FILEACCESS* file);
John Abd-El-Malek3f3b45c2014-05-23 17:28:10 -070065
dan sinclairea10a0d2016-03-23 19:36:46 -040066// Destroy the |avail| document availability provider.
67//
dsinclair860193b2016-04-25 19:44:20 -070068// avail - handle to document availability provider to be destroyed.
Dan Sinclair00d2ad12017-08-10 14:13:02 -040069FPDF_EXPORT void FPDF_CALLCONV FPDFAvail_Destroy(FPDF_AVAIL avail);
John Abd-El-Malek3f3b45c2014-05-23 17:28:10 -070070
dan sinclairea10a0d2016-03-23 19:36:46 -040071// Download hints interface. Used to receive hints for further downloading.
John Abd-El-Malek3f3b45c2014-05-23 17:28:10 -070072typedef struct _FX_DOWNLOADHINTS {
dan sinclairea10a0d2016-03-23 19:36:46 -040073 // Version number of the interface. Must be 1.
Nico Weber9d8ec5a2015-08-04 13:00:21 -070074 int version;
John Abd-El-Malek3f3b45c2014-05-23 17:28:10 -070075
dan sinclairea10a0d2016-03-23 19:36:46 -040076 // Add a section to be downloaded.
77 //
78 // Interface Version: 1
79 // Implementation Required: Yes
80 //
81 // pThis - pointer to the interface structure.
82 // offset - the offset of the hint reported to be downloaded.
83 // size - the size of the hint reported to be downloaded.
84 //
85 // The |offset| and |size| of the section may not be unique. Part of the
86 // section might be already available. The download manager must deal with
87 // overlapping sections.
Nico Weber9d8ec5a2015-08-04 13:00:21 -070088 void (*AddSegment)(struct _FX_DOWNLOADHINTS* pThis,
89 size_t offset,
90 size_t size);
John Abd-El-Malek3f3b45c2014-05-23 17:28:10 -070091} FX_DOWNLOADHINTS;
92
dan sinclairea10a0d2016-03-23 19:36:46 -040093// Checks if the document is ready for loading, if not, gets download hints.
94//
95// avail - handle to document availability provider.
96// hints - pointer to a download hints interface.
97//
98// Returns one of:
99// PDF_DATA_ERROR: A common error is returned. Data availability unknown.
100// PDF_DATA_NOTAVAIL: Data not yet available.
101// PDF_DATA_AVAIL: Data available.
102//
103// Applications should call this function whenever new data arrives, and process
104// all the generated download hints, if any, until the function returns
105// |PDF_DATA_ERROR| or |PDF_DATA_AVAIL|.
106//
107// Once all data is available, call |FPDFAvail_GetDocument| to get a document
108// handle.
Dan Sinclair00d2ad12017-08-10 14:13:02 -0400109FPDF_EXPORT int FPDF_CALLCONV FPDFAvail_IsDocAvail(FPDF_AVAIL avail,
110 FX_DOWNLOADHINTS* hints);
John Abd-El-Malek3f3b45c2014-05-23 17:28:10 -0700111
dan sinclairea10a0d2016-03-23 19:36:46 -0400112// Get document from the availability provider.
113//
114// avail - handle to document availability provider.
115// password - password for decrypting the PDF file. Optional.
116//
117// Returns a handle to the document.
118//
119// When |FPDFAvail_IsDocAvail| returns TRUE, call |FPDFAvail_GetDocument| to
120// retrieve the document handle.
Dan Sinclair00d2ad12017-08-10 14:13:02 -0400121FPDF_EXPORT FPDF_DOCUMENT FPDF_CALLCONV
122FPDFAvail_GetDocument(FPDF_AVAIL avail, FPDF_BYTESTRING password);
John Abd-El-Malek3f3b45c2014-05-23 17:28:10 -0700123
dan sinclairea10a0d2016-03-23 19:36:46 -0400124// Get the page number for the first available page in a linearized PDF.
125//
126// doc - document handle.
127//
128// Returns the zero-based index for the first available page.
129//
130// For most linearized PDFs, the first available page will be the first page,
131// however, some PDFs might make another page the first available page.
132// For non-linearized PDFs, this function will always return zero.
Dan Sinclair00d2ad12017-08-10 14:13:02 -0400133FPDF_EXPORT int FPDF_CALLCONV FPDFAvail_GetFirstPageNum(FPDF_DOCUMENT doc);
John Abd-El-Malek3f3b45c2014-05-23 17:28:10 -0700134
dan sinclairea10a0d2016-03-23 19:36:46 -0400135// Check if |page_index| is ready for loading, if not, get the
136// |FX_DOWNLOADHINTS|.
137//
138// avail - handle to document availability provider.
139// page_index - index number of the page. Zero for the first page.
140// hints - pointer to a download hints interface. Populated if
141// |page_index| is not available.
142//
143// Returns one of:
144// PDF_DATA_ERROR: A common error is returned. Data availability unknown.
145// PDF_DATA_NOTAVAIL: Data not yet available.
146// PDF_DATA_AVAIL: Data available.
147//
148// This function can be called only after |FPDFAvail_GetDocument| is called.
149// Applications should call this function whenever new data arrives and process
150// all the generated download |hints|, if any, until this function returns
151// |PDF_DATA_ERROR| or |PDF_DATA_AVAIL|. Applications can then perform page
152// loading.
Dan Sinclair00d2ad12017-08-10 14:13:02 -0400153FPDF_EXPORT int FPDF_CALLCONV FPDFAvail_IsPageAvail(FPDF_AVAIL avail,
154 int page_index,
155 FX_DOWNLOADHINTS* hints);
John Abd-El-Malek3f3b45c2014-05-23 17:28:10 -0700156
dan sinclairea10a0d2016-03-23 19:36:46 -0400157// Check if form data is ready for initialization, if not, get the
158// |FX_DOWNLOADHINTS|.
159//
160// avail - handle to document availability provider.
161// hints - pointer to a download hints interface. Populated if form is not
162// ready for initialization.
163//
164// Returns one of:
165// PDF_FORM_ERROR: A common eror, in general incorrect parameters.
166// PDF_FORM_NOTAVAIL: Data not available.
167// PDF_FORM_AVAIL: Data available.
168// PDF_FORM_NOTEXIST: No form data.
169//
170// This function can be called only after |FPDFAvail_GetDocument| is called.
171// The application should call this function whenever new data arrives and
172// process all the generated download |hints|, if any, until the function
173// |PDF_FORM_ERROR|, |PDF_FORM_AVAIL| or |PDF_FORM_NOTEXIST|.
174// Applications can then perform page loading. It is recommend to call
175// |FPDFDOC_InitFormFillEnvironment| when |PDF_FORM_AVAIL| is returned.
Dan Sinclair00d2ad12017-08-10 14:13:02 -0400176FPDF_EXPORT int FPDF_CALLCONV FPDFAvail_IsFormAvail(FPDF_AVAIL avail,
177 FX_DOWNLOADHINTS* hints);
John Abd-El-Malek3f3b45c2014-05-23 17:28:10 -0700178
dan sinclairea10a0d2016-03-23 19:36:46 -0400179// Check whether a document is a linearized PDF.
180//
181// avail - handle to document availability provider.
182//
183// Returns one of:
184// PDF_LINEARIZED
185// PDF_NOT_LINEARIZED
186// PDF_LINEARIZATION_UNKNOWN
187//
188// |FPDFAvail_IsLinearized| will return |PDF_LINEARIZED| or |PDF_NOT_LINEARIZED|
189// when we have 1k of data. If the files size less than 1k, it returns
190// |PDF_LINEARIZATION_UNKNOWN| as there is insufficient information to determine
191// if the PDF is linearlized.
Dan Sinclair00d2ad12017-08-10 14:13:02 -0400192FPDF_EXPORT int FPDF_CALLCONV FPDFAvail_IsLinearized(FPDF_AVAIL avail);
John Abd-El-Malek3f3b45c2014-05-23 17:28:10 -0700193
194#ifdef __cplusplus
dan sinclairea10a0d2016-03-23 19:36:46 -0400195} // extern "C"
196#endif // __cplusplus
John Abd-El-Malek3f3b45c2014-05-23 17:28:10 -0700197
Tom Sepez9857e202015-05-13 17:09:26 -0700198#endif // PUBLIC_FPDF_DATAAVAIL_H_