Support linearized loading

public/fpdf_dataavail.h

 // Copyright 2014 PDFium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 // Original code copyright 2014 Foxit Software Inc. http://www.foxitsoftware.com
 
 #ifndef PUBLIC_FPDF_DATAAVAIL_H_
 #define PUBLIC_FPDF_DATAAVAIL_H_
 
 #include <stddef.h>  // For size_t.
 
 #include "fpdfview.h"
 
-/** The result of the process which check linearized PDF. */
-#define FSDK_IS_LINEARIZED 1
-#define FSDK_NOT_LINEARIZED 0
-#define FSDK_UNKNOW_LINEARIZED -1
+#define PDF_LINEARIZATION_UNKNOWN -1
+#define PDF_NOT_LINEARIZED 0
+#define PDF_LINEARIZED 1
+#define PDF_DATA_ERROR -1
+#define PDF_DATA_NOTAVAIL 0
+#define PDF_DATA_AVAIL 1
+#define PDF_FORM_NOTAVAIL 0
+#define PDF_FORM_AVAIL 1
+#define PDF_FORM_NOTEXIST 2
 
 #ifdef __cplusplus
 extern "C" {
 #endif
 
 /**
  * Interface: FX_FILEAVAIL
  *          Interface for checking whether the section of the file is available.
  */
 typedef struct _FX_FILEAVAIL {
@@ skipping 95 matching lines @@
 * Function: FPDFAvail_IsDocAvail
 *           Check whether the document is ready for loading, if not, get
 * download hints.
 *
 * Parameters:
 *           avail       -   Handle to document availability provider returned by
 * FPDFAvail_Create
 *           hints       -   Pointer to a download hints interface, receiving
 * generated hints
 * Return value:
-*           Non-zero for page is fully available, 0 for page not yet available.
+*           PDF_DATA_ERROR: A common error is returned. It can't tell

[Tom Sepez, 2015/10/21 17:53:08]

Public API change. Can we do what we need to do without breaking compatibliity?

[jun_fang, 2015/10/22 00:50:06]

This public API was designed for linearization functionality.
Before this CL, this functionality wasn't implemented correctly.
This is the first time that applications can call this API 
in the right way. So this API is almost a new API.

In the other hand, I define PDF_DATA_ERROR as -1. It follows the
legacy logic. Before this CL, it returns true even this are any
errors. So there are two possibilities for 'true', data available or error. Both
of them are non-zero.

+*                           whehter data are availabe or not.
+*           PDF_DATA_NOTAVAIL: Data are not yet available.
+*           PDF_DATA_AVAIL: Data are available.
 * Comments:
 *           The application should call this function whenever new data arrived,
 * and process all the
-*           generated download hints if any, until the function returns non-zero
-* value. Then the
-*           application can call FPDFAvail_GetDocument() to get a document
+*           generated download hints if any, until the function returns true.
+* Then the application can call FPDFAvail_GetDocument() to get a document
 * handle.
 */
-DLLEXPORT int STDCALL FPDFAvail_IsDocAvail(FPDF_AVAIL avail,
-                                           FX_DOWNLOADHINTS* hints);
+DLLEXPORT int STDCALL
+FPDFAvail_IsDocAvail(FPDF_AVAIL avail, FX_DOWNLOADHINTS* hints);
 
 /**
 * Function: FPDFAvail_GetDocument
 *           Get document from the availability provider.
 *
 * Parameters:
 *           avail       -   Handle to document availability provider returned by
 * FPDFAvail_Create
 *     password  -   Optional password for decrypting the PDF file.
 * Return value:
@@ skipping 28 matching lines @@
 *           Check whether a page is ready for loading, if not, get download
 * hints.
 *
 * Parameters:
 *           avail       -   Handle to document availability provider returned by
 * FPDFAvail_Create
 *           page_index  -   Index number of the page. 0 for the first page.
 *           hints       -   Pointer to a download hints interface, receiving
 * generated hints
 * Return value:
-*           Non-zero for page is fully available, 0 for page not yet available.
+*           PDF_DATA_ERROR: A common error is returned. It can't tell
+*                           whehter data are availabe or not.
+*           PDF_DATA_NOTAVAIL: Data are not yet available.
+*           PDF_DATA_AVAIL: Data are available.
 * Comments:
 *           This function call be called only after FPDFAvail_GetDocument if
 * called.
 *           The application should call this function whenever new data arrived,
 * and process all the
-*           generated download hints if any, until the function returns non-zero
-* value. Then the
-*           application can perform page loading.
+*           generated download hints if any, until the function returns true.
+* Then the application can perform page loading.
 */
 DLLEXPORT int STDCALL FPDFAvail_IsPageAvail(FPDF_AVAIL avail,
                                             int page_index,
                                             FX_DOWNLOADHINTS* hints);
 
 /**
 * Function: FPDFAvail_ISFormAvail
 *           Check whether Form data is ready for init, if not, get download
 * hints.
 *
@@ skipping 25 matching lines @@
                                             FX_DOWNLOADHINTS* hints);
 
 /**
 * Function: FPDFAvail_IsLinearized
 *           To check whether a document is Linearized PDF file.
 *
 * Parameters:
 *           avail       -   Handle to document availability provider returned by
 * FPDFAvail_Create
 * Return value:
-*           return TRUE means the document is linearized PDF else not.
-*           FSDK_IS_LINEARIZED is a linearize file.
-*           FSDK_NOT_LINEARIZED is not a linearize file.
-*           FSDK_UNKNOW_LINEARIZED don't know whether the file is a linearize
-* file.
+*           PDF_LINEARIZED is a linearize file.
+*           PDF_NOT_LINEARIZED is not a linearize file.
+*           PDF_LINEARIZATION_UNKNOWN doesn't know whether the file is a
+*linearize file.
+*
 * Comments:
-*           It return TRUE/FALSE as soon as we have first 1K data.  If the
-* file's size less than
-*           1K,we don't known whether the PDF is a linearized file.
+*           It return PDF_LINEARIZED or PDF_NOT_LINEARIZED as soon as
+*           we have first 1K data.  If the file's size less than 1K, it returns
+*           PDF_LINEARIZATION_UNKNOWN because there is not enough information to
+*           tell whether a PDF file is a linearized file or not.
 *
 */
-DLLEXPORT FPDF_BOOL STDCALL FPDFAvail_IsLinearized(FPDF_AVAIL avail);
+DLLEXPORT int STDCALL FPDFAvail_IsLinearized(FPDF_AVAIL avail);
 
 #ifdef __cplusplus
 }
 #endif
 
 #endif  // PUBLIC_FPDF_DATAAVAIL_H_