Support linearized loading

core/include/fpdfapi/fpdf_parser.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 CORE_INCLUDE_FPDFAPI_FPDF_PARSER_H_
 #define CORE_INCLUDE_FPDFAPI_FPDF_PARSER_H_
 
+#include "../../../public/fpdf_macro.h"

[Tom Sepez, 2015/10/14 16:57:45]

this should just include public/fpdf_datavail.h, no need for the new file.

[jun_fang, 2015/10/15 10:22:28]

Pdfium has two parts, sdk and core. sdk has the dependency on core so sdk
includes header files from core. In contrast, core doesn't 
include any sdk header files in order not to break the rule.
For marcos used by sdk and core, currently they are defined twice.
One is defined in public for applications to use. The other is
defined in core. 

public/fpdf_datavail.h declares some APIs related to linearization. 
Usually, it's included by customer's applications to implement
linearization functionality. The purpose of including public/fpdf_datavail.h in
core/include/fpdfapi/fpdf_parser.h is only to use macros. It's not worthy to
include whole header file. I want to define all marcos used by applications, sdk
and core in this new head file to make design clear. In this way, we don't need
to define
macros twice. We don't include the whole header file if only macros
will be used.

[Tom Sepez, 2015/10/15 16:20:04]

Nah, it's much better to keep the declarations near where they are returned to
make thing more understandable for the embedders, even at the expense of
processing some additional lines when including the whole header.

As to the the core/fpdfsdk split, if you want to be really strict about
layering, then you'd have to have two definitions, with static_asserts() to
ensure they line up, along with a comment about layering.  Maybe its better to
go back to that model.

On the other hand, we already violate this, I'd presumed that public
can be included at any level, which is part of the reason I moved it from
fpdfsdk/include.

$ git grep public/ core
core/include/fpdfapi/fpdf_parser.h:#include "../../../public/fpdfview.h"
core/include/fpdfapi/fpdf_render.h:#include "../../../public/fpdf_progressive.h"
core/src/fpdfapi/fpdf_parser/fpdf_parser_decode_embeddertest.cpp:#include
"../../../../public/fpdfview.h"

[jun_fang, 2015/10/19 13:20:30]

Acknowledged.

 #include "../fxcrt/fx_system.h"
 #include "fpdf_objects.h"
 
+class CFDF_Document;
+class CFDF_Parser;
+class CFX_AffineMatrix;
+class CFX_DIBSource;
+class CFX_FloatRect;
+class CFX_Font;
+class CFX_PrivateData;
+class CPDF_ColorSpace;
+class CPDF_CryptoHandler;
+class CPDF_DocPageData;
+class CPDF_DocRenderData;
 class CPDF_Document;
+class CPDF_Font;
+class CPDF_FontEncoding;
+class CPDF_HintTables;
+class CPDF_IccProfile;
+class CPDF_Image;
+class CPDF_ModuleMgr;
+class CPDF_Object;
 class CPDF_Parser;
+class CPDF_Pattern;
+class CPDF_Point;
 class CPDF_SecurityHandler;
 class CPDF_StandardSecurityHandler;
-class CPDF_CryptoHandler;
-class CPDF_Object;
 class IFX_FileRead;
-class CFDF_Document;
-class CFDF_Parser;
-class CFX_Font;
-class CFX_AffineMatrix;
-class CFX_FloatRect;
-class CPDF_Point;
-class CPDF_DocPageData;
-class CPDF_DocRenderData;
-class CPDF_ModuleMgr;
-class CFX_DIBSource;
-class CPDF_Font;
-class CPDF_Image;
-class CPDF_ColorSpace;
-class CPDF_Pattern;
-class CPDF_FontEncoding;
-class CPDF_IccProfile;
-class CFX_PrivateData;
+
 #define FPDFPERM_PRINT 0x0004
 #define FPDFPERM_MODIFY 0x0008
 #define FPDFPERM_EXTRACT 0x0010
 #define FPDFPERM_ANNOT_FORM 0x0020
 #define FPDFPERM_FILL_FORM 0x0100
 #define FPDFPERM_EXTRACT_ACCESS 0x0200
 #define FPDFPERM_ASSEMBLE 0x0400
 #define FPDFPERM_PRINT_HIGH 0x0800
 #define FPDF_PAGE_MAX_NUM 0xFFFFF
 
@@ skipping 791 matching lines @@
 class IFX_FileAvail {
  public:
   virtual ~IFX_FileAvail() {}
   virtual FX_BOOL IsDataAvail(FX_FILESIZE offset, FX_DWORD size) = 0;
 };
 class IFX_DownloadHints {
  public:
   virtual ~IFX_DownloadHints() {}
   virtual void AddSegment(FX_FILESIZE offset, FX_DWORD size) = 0;
 };
-#define PDF_IS_LINEARIZED 1
-#define PDF_NOT_LINEARIZED 0
-#define PDF_UNKNOW_LINEARIZED -1
-#define PDFFORM_NOTAVAIL 0
-#define PDFFORM_AVAIL 1
-#define PDFFORM_NOTEXIST 2
+
 class IPDF_DataAvail {
  public:
   static IPDF_DataAvail* Create(IFX_FileAvail* pFileAvail,
                                 IFX_FileRead* pFileRead);
   virtual ~IPDF_DataAvail() {}
 
   IFX_FileAvail* GetFileAvail() const { return m_pFileAvail; }
   IFX_FileRead* GetFileRead() const { return m_pFileRead; }
 
   virtual FX_BOOL IsDocAvail(IFX_DownloadHints* pHints) = 0;
@@ skipping 36 matching lines @@
   CPDF_PageNode() : m_type(PDF_PAGENODE_UNKOWN) {}
   ~CPDF_PageNode();
   PDF_PAGENODE_TYPE m_type;
   FX_DWORD m_dwPageNo;
   CFX_PtrArray m_childNode;
 };
 enum PDF_DATAAVAIL_STATUS {
   PDF_DATAAVAIL_HEADER = 0,
   PDF_DATAAVAIL_FIRSTPAGE,
   PDF_DATAAVAIL_FIRSTPAGE_PREPARE,
+  PDF_DATAAVAIL_HINTTABLE,
   PDF_DATAAVAIL_END,
   PDF_DATAAVAIL_CROSSREF,
   PDF_DATAAVAIL_CROSSREF_ITEM,
   PDF_DATAAVAIL_CROSSREF_STREAM,
   PDF_DATAAVAIL_TRAILER,
   PDF_DATAAVAIL_LOADALLCRSOSSREF,
   PDF_DATAAVAIL_ROOT,
   PDF_DATAAVAIL_INFO,
   PDF_DATAAVAIL_ACROFORM,
   PDF_DATAAVAIL_ACROFORM_SUBOBJECT,
@@ skipping 11 matching lines @@
                        FX_DWORD src_size,
                        const CPDF_Dictionary* pDict,
                        uint8_t*& dest_buf,
                        FX_DWORD& dest_size,
                        CFX_ByteString& ImageEncoding,
                        CPDF_Dictionary*& pImageParms,
                        FX_DWORD estimated_size,
                        FX_BOOL bImageAcc);
 
 #endif  // CORE_INCLUDE_FPDFAPI_FPDF_PARSER_H_