fpdfsdk/ differences with XFA (for didactic purposes only).

fpdfsdk/src/fpdfview.cpp

 // 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
 
 #include "public/fpdfview.h"
 
+#ifdef PDF_ENABLE_XFA
+#include "../include/fpdfxfa/fpdfxfa_app.h"
+#include "../include/fpdfxfa/fpdfxfa_doc.h"
+#include "../include/fpdfxfa/fpdfxfa_page.h"
+#include "../include/fpdfxfa/fpdfxfa_util.h"
+#include "core/include/fpdfapi/fpdf_module.h"
+#endif
 #include "core/include/fxcodec/fx_codec.h"
 #include "core/include/fxcrt/fx_safe_types.h"
 #include "fpdfsdk/include/fsdk_define.h"
 #include "fpdfsdk/include/fsdk_mgr.h"
 #include "fpdfsdk/include/fsdk_rendercontext.h"
 #include "fpdfsdk/include/javascript/IJavaScript.h"
 #include "public/fpdf_ext.h"
+#ifdef PDF_ENABLE_XFA
+#include "public/fpdf_formfill.h"
+#endif
 #include "public/fpdf_progressive.h"
 #include "third_party/base/nonstd_unique_ptr.h"
 #include "third_party/base/numerics/safe_conversions_impl.h"
 
 UnderlyingDocumentType* UnderlyingFromFPDFDocument(FPDF_DOCUMENT doc) {
   return static_cast<UnderlyingDocumentType*>(doc);
 }
 
 FPDF_DOCUMENT FPDFDocumentFromUnderlying(UnderlyingDocumentType* doc) {
   return static_cast<FPDF_DOCUMENT>(doc);
 }
 
 UnderlyingPageType* UnderlyingFromFPDFPage(FPDF_PAGE page) {
   return static_cast<UnderlyingPageType*>(page);
 }
 
 CPDF_Document* CPDFDocumentFromFPDFDocument(FPDF_DOCUMENT doc) {
+#ifndef PDF_ENABLE_XFA
   return UnderlyingFromFPDFDocument(doc);
+#else
+  return doc ? UnderlyingFromFPDFDocument(doc)->GetPDFDoc() : nullptr;
+#endif
 }
 
 FPDF_DOCUMENT FPDFDocumentFromCPDFDocument(CPDF_Document* doc) {
+#ifndef PDF_ENABLE_XFA
   return FPDFDocumentFromUnderlying(doc);
+#else
+  return doc ? FPDFDocumentFromUnderlying(
+                   new CPDFXFA_Document(doc, CPDFXFA_App::GetInstance()))
+             : nullptr;
+#endif
 }
 
 CPDF_Page* CPDFPageFromFPDFPage(FPDF_PAGE page) {
+#ifndef PDF_ENABLE_XFA
   return UnderlyingFromFPDFPage(page);
+#else
+  return page ? UnderlyingFromFPDFPage(page)->GetPDFPage() : nullptr;
+}
+
+CFPDF_FileStream::CFPDF_FileStream(FPDF_FILEHANDLER* pFS) {
+  m_pFS = pFS;
+  m_nCurPos = 0;
+}
+
+IFX_FileStream* CFPDF_FileStream::Retain() {
+  return this;
+}
+
+void CFPDF_FileStream::Release() {
+  if (m_pFS && m_pFS->Release)
+    m_pFS->Release(m_pFS->clientData);
+  delete this;
+}
+
+FX_FILESIZE CFPDF_FileStream::GetSize() {
+  if (m_pFS && m_pFS->GetSize)
+    return (FX_FILESIZE)m_pFS->GetSize(m_pFS->clientData);
+  return 0;
+}
+
+FX_BOOL CFPDF_FileStream::IsEOF() {
+  return m_nCurPos >= GetSize();
+}
+
+FX_BOOL CFPDF_FileStream::ReadBlock(void* buffer,
+                                    FX_FILESIZE offset,
+                                    size_t size) {
+  if (!buffer || !size || !m_pFS->ReadBlock)
+    return FALSE;
+
+  if (m_pFS->ReadBlock(m_pFS->clientData, (FPDF_DWORD)offset, buffer,
+                       (FPDF_DWORD)size) == 0) {
+    m_nCurPos = offset + size;
+    return TRUE;
+  }
+  return FALSE;
+}
+
+size_t CFPDF_FileStream::ReadBlock(void* buffer, size_t size) {
+  if (!buffer || !size || !m_pFS->ReadBlock)
+    return 0;
+
+  FX_FILESIZE nSize = GetSize();
+  if (m_nCurPos >= nSize)
+    return 0;
+  FX_FILESIZE dwAvail = nSize - m_nCurPos;
+  if (dwAvail < (FX_FILESIZE)size)
+    size = (size_t)dwAvail;
+  if (m_pFS->ReadBlock(m_pFS->clientData, (FPDF_DWORD)m_nCurPos, buffer,
+                       (FPDF_DWORD)size) == 0) {
+    m_nCurPos += size;
+    return size;
+  }
+
+  return 0;
+}
+
+FX_BOOL CFPDF_FileStream::WriteBlock(const void* buffer,
+                                     FX_FILESIZE offset,
+                                     size_t size) {
+  if (!m_pFS || !m_pFS->WriteBlock)
+    return FALSE;
+
+  if (m_pFS->WriteBlock(m_pFS->clientData, (FPDF_DWORD)offset, buffer,
+                        (FPDF_DWORD)size) == 0) {
+    m_nCurPos = offset + size;
+    return TRUE;
+  }
+  return FALSE;
+}
+
+FX_BOOL CFPDF_FileStream::Flush() {
+  if (!m_pFS || !m_pFS->Flush)
+    return TRUE;
+
+  return m_pFS->Flush(m_pFS->clientData) == 0;
+#endif
 }
 
 CPDF_CustomAccess::CPDF_CustomAccess(FPDF_FILEACCESS* pFileAccess) {
   m_FileAccess = *pFileAccess;
+#ifdef PDF_ENABLE_XFA
+  m_BufferOffset = (FX_DWORD)-1;
+}
+
+FX_BOOL CPDF_CustomAccess::GetByte(FX_DWORD pos, uint8_t& ch) {
+  if (pos >= m_FileAccess.m_FileLen)
+    return FALSE;
+  if (m_BufferOffset == (FX_DWORD)-1 || pos < m_BufferOffset ||
+      pos >= m_BufferOffset + 512) {
+    // Need to read from file access
+    m_BufferOffset = pos;
+    int size = 512;
+    if (pos + 512 > m_FileAccess.m_FileLen)
+      size = m_FileAccess.m_FileLen - pos;
+    if (!m_FileAccess.m_GetBlock(m_FileAccess.m_Param, m_BufferOffset, m_Buffer,
+                                 size))
+      return FALSE;
+  }
+  ch = m_Buffer[pos - m_BufferOffset];
+  return TRUE;
+}
+
+FX_BOOL CPDF_CustomAccess::GetBlock(FX_DWORD pos,
+                                    uint8_t* pBuf,
+                                    FX_DWORD size) {
+  if (pos + size > m_FileAccess.m_FileLen)
+    return FALSE;
+  return m_FileAccess.m_GetBlock(m_FileAccess.m_Param, pos, pBuf, size);
+#endif
 }
 
 FX_BOOL CPDF_CustomAccess::ReadBlock(void* buffer,
                                      FX_FILESIZE offset,
                                      size_t size) {
   if (offset < 0) {
     return FALSE;
   }
   FX_SAFE_FILESIZE newPos =
       pdfium::base::checked_cast<FX_FILESIZE, size_t>(size);
@@ skipping 41 matching lines @@
   g_pCodecModule = new CCodec_ModuleMgr();
 
   CFX_GEModule::Create(cfg ? cfg->m_pUserFontPaths : nullptr);
   CFX_GEModule::Get()->SetCodecModule(g_pCodecModule);
 
   CPDF_ModuleMgr::Create();
   CPDF_ModuleMgr* pModuleMgr = CPDF_ModuleMgr::Get();
   pModuleMgr->SetCodecModule(g_pCodecModule);
   pModuleMgr->InitPageModule();
   pModuleMgr->InitRenderModule();
+#ifndef PDF_ENABLE_XFA
   pModuleMgr->LoadEmbeddedGB1CMaps();
   pModuleMgr->LoadEmbeddedJapan1CMaps();
   pModuleMgr->LoadEmbeddedCNS1CMaps();
   pModuleMgr->LoadEmbeddedKorea1CMaps();
+#else
+  CPDFXFA_App::GetInstance()->Initialize();
+#endif
   if (cfg && cfg->version >= 2)
     IJS_Runtime::Initialize(cfg->m_v8EmbedderSlot, cfg->m_pIsolate);
 }
 
 DLLEXPORT void STDCALL FPDF_DestroyLibrary() {
+#ifdef PDF_ENABLE_XFA
+  CPDFXFA_App::ReleaseInstance();
+#endif
   CPDF_ModuleMgr::Destroy();
   CFX_GEModule::Destroy();
 
   delete g_pCodecModule;
   g_pCodecModule = nullptr;
 }
 
 #ifndef _WIN32
 int g_LastError;
 void SetLastError(int err) {
@@ skipping 40 matching lines @@
 
   CPDF_Parser* pParser = new CPDF_Parser;
   pParser->SetPassword(password);
 
   FX_DWORD err_code = pParser->StartParse(pFileAccess);
   if (err_code) {
     delete pParser;
     ProcessParseError(err_code);
     return NULL;
   }
+#ifndef PDF_ENABLE_XFA
   return pParser->GetDocument();
+#else
+  CPDF_Document* pPDFDoc = pParser->GetDocument();
+  if (!pPDFDoc)
+    return NULL;
+
+  CPDFXFA_App* pProvider = CPDFXFA_App::GetInstance();
+  return new CPDFXFA_Document(pPDFDoc, pProvider);
+}
+
+DLLEXPORT FPDF_BOOL STDCALL FPDF_HasXFAField(FPDF_DOCUMENT document,
+                                             int* docType) {
+  if (!document)
+    return FALSE;
+
+  CPDF_Document* pdfDoc =
+      (static_cast<CPDFXFA_Document*>(document))->GetPDFDoc();
+  if (!pdfDoc)
+    return FALSE;
+
+  CPDF_Dictionary* pRoot = pdfDoc->GetRoot();
+  if (!pRoot)
+    return FALSE;
+
+  CPDF_Dictionary* pAcroForm = pRoot->GetDict("AcroForm");
+  if (!pAcroForm)
+    return FALSE;
+
+  CPDF_Object* pXFA = pAcroForm->GetElement("XFA");
+  if (!pXFA)
+    return FALSE;
+
+  FX_BOOL bDynamicXFA = pRoot->GetBoolean("NeedsRendering", FALSE);
+
+  if (bDynamicXFA)
+    *docType = DOCTYPE_DYNAMIC_XFA;
+  else
+    *docType = DOCTYPE_STATIC_XFA;
+
+  return TRUE;
+}
+
+DLLEXPORT FPDF_BOOL STDCALL FPDF_LoadXFA(FPDF_DOCUMENT document) {
+  return document && (static_cast<CPDFXFA_Document*>(document))->LoadXFADoc();
+#endif
 }
 
 class CMemFile final : public IFX_FileRead {
  public:
   CMemFile(uint8_t* pBuf, FX_FILESIZE size) : m_pBuf(pBuf), m_size(size) {}
 
   void Release() override { delete this; }
   FX_FILESIZE GetSize() override { return m_size; }
   FX_BOOL ReadBlock(void* buffer, FX_FILESIZE offset, size_t size) override {
     if (offset < 0) {
@@ skipping 68 matching lines @@
 
   *fileVersion = pParser->GetFileVersion();
   return TRUE;
 }
 
 // jabdelmalek: changed return type from FX_DWORD to build on Linux (and match
 // header).
 DLLEXPORT unsigned long STDCALL FPDF_GetDocPermissions(FPDF_DOCUMENT document) {
   CPDF_Document* pDoc = CPDFDocumentFromFPDFDocument(document);
   if (!pDoc)
+#ifndef PDF_ENABLE_XFA
     return 0;
+#else
+    return (FX_DWORD)-1;
+#endif
 
   CPDF_Dictionary* pDict = pDoc->GetParser()->GetEncryptDict();
   return pDict ? pDict->GetInteger("P") : (FX_DWORD)-1;
 }
 
 DLLEXPORT int STDCALL FPDF_GetSecurityHandlerRevision(FPDF_DOCUMENT document) {
   CPDF_Document* pDoc = CPDFDocumentFromFPDFDocument(document);
   if (!pDoc)
     return -1;
 
   CPDF_Dictionary* pDict = pDoc->GetParser()->GetEncryptDict();
   return pDict ? pDict->GetInteger("R") : -1;
 }
 
 DLLEXPORT int STDCALL FPDF_GetPageCount(FPDF_DOCUMENT document) {
   UnderlyingDocumentType* pDoc = UnderlyingFromFPDFDocument(document);
   return pDoc ? pDoc->GetPageCount() : 0;
 }
 
 DLLEXPORT FPDF_PAGE STDCALL FPDF_LoadPage(FPDF_DOCUMENT document,
                                           int page_index) {
   UnderlyingDocumentType* pDoc = UnderlyingFromFPDFDocument(document);
   if (!pDoc)
     return nullptr;
 
   if (page_index < 0 || page_index >= pDoc->GetPageCount())
     return nullptr;
 
+#ifndef PDF_ENABLE_XFA
   CPDF_Dictionary* pDict = pDoc->GetPage(page_index);
   if (pDict == NULL)
     return NULL;
   CPDF_Page* pPage = new CPDF_Page;
   pPage->Load(pDoc, pDict);
   pPage->ParseContent();
   return pPage;
+#else
+  return pDoc->GetPage(page_index);
+#endif
 }
 
 DLLEXPORT double STDCALL FPDF_GetPageWidth(FPDF_PAGE page) {
   UnderlyingPageType* pPage = UnderlyingFromFPDFPage(page);
   return pPage ? pPage->GetPageWidth() : 0.0;
 }
 
 DLLEXPORT double STDCALL FPDF_GetPageHeight(FPDF_PAGE page) {
   UnderlyingPageType* pPage = UnderlyingFromFPDFPage(page);
   return pPage ? pPage->GetPageHeight() : 0.0;
@@ skipping 204 matching lines @@
   FPDF_RenderPage_Retail(pContext, page, start_x, start_y, size_x, size_y,
                          rotate, flags, TRUE, NULL);
 
   delete pContext;
   pPage->RemovePrivateData((void*)1);
 }
 
 DLLEXPORT void STDCALL FPDF_ClosePage(FPDF_PAGE page) {
   if (!page)
     return;
+#ifndef PDF_ENABLE_XFA
   CPDFSDK_PageView* pPageView =
       (CPDFSDK_PageView*)(((CPDF_Page*)page))->GetPrivateData((void*)page);
   if (pPageView && pPageView->IsLocked()) {
     pPageView->TakeOverPage();
     return;
   }
   delete (CPDF_Page*)page;
+#else
+
+  CPDFXFA_Page* pPage = (CPDFXFA_Page*)page;
+  pPage->Release();
+#endif
 }
 
 DLLEXPORT void STDCALL FPDF_CloseDocument(FPDF_DOCUMENT document) {
+#ifndef PDF_ENABLE_XFA
   CPDF_Document* pDoc = CPDFDocumentFromFPDFDocument(document);
   if (!pDoc)
     return;
 
   CPDF_Parser* pParser = (CPDF_Parser*)pDoc->GetParser();
   if (!pParser) {
     delete pDoc;
     return;
   }
   delete pParser;
+#else
+  delete CPDFDocumentFromFPDFDocument(document);
+#endif
 }
 
 DLLEXPORT unsigned long STDCALL FPDF_GetLastError() {
   return GetLastError();
 }
 
 DLLEXPORT void STDCALL FPDF_DeviceToPage(FPDF_PAGE page,
                                          int start_x,
                                          int start_y,
                                          int size_x,
                                          int size_y,
                                          int rotate,
                                          int device_x,
                                          int device_y,
                                          double* page_x,
                                          double* page_y) {
   if (page == NULL || page_x == NULL || page_y == NULL)
     return;
   UnderlyingPageType* pPage = UnderlyingFromFPDFPage(page);
+#ifndef PDF_ENABLE_XFA
 
   CPDF_Matrix page2device;
   pPage->GetDisplayMatrix(page2device, start_x, start_y, size_x, size_y,
                           rotate);
   CPDF_Matrix device2page;
   device2page.SetReverse(page2device);
 
   FX_FLOAT page_x_f, page_y_f;
   device2page.Transform((FX_FLOAT)(device_x), (FX_FLOAT)(device_y), page_x_f,
                         page_y_f);
 
   *page_x = (page_x_f);
   *page_y = (page_y_f);
+#else
+  pPage->DeviceToPage(start_x, start_y, size_x, size_y, rotate, device_x,
+                      device_y, page_x, page_y);
+#endif
 }
 
 DLLEXPORT void STDCALL FPDF_PageToDevice(FPDF_PAGE page,
                                          int start_x,
                                          int start_y,
                                          int size_x,
                                          int size_y,
                                          int rotate,
                                          double page_x,
                                          double page_y,
                                          int* device_x,
                                          int* device_y) {
   if (!device_x || !device_y)
     return;
   UnderlyingPageType* pPage = UnderlyingFromFPDFPage(page);
   if (!pPage)
     return;
+#ifndef PDF_ENABLE_XFA
   CPDF_Matrix page2device;
   pPage->GetDisplayMatrix(page2device, start_x, start_y, size_x, size_y,
                           rotate);
 
   FX_FLOAT device_x_f, device_y_f;
   page2device.Transform(((FX_FLOAT)page_x), ((FX_FLOAT)page_y), device_x_f,
                         device_y_f);
 
   *device_x = FXSYS_round(device_x_f);
   *device_y = FXSYS_round(device_y_f);
+#else
+  pPage->PageToDevice(start_x, start_y, size_x, size_y, rotate, page_x, page_y,
+                      device_x, device_y);
+#endif
 }
 
 DLLEXPORT FPDF_BITMAP STDCALL FPDFBitmap_Create(int width,
                                                 int height,
                                                 int alpha) {
   nonstd::unique_ptr<CFX_DIBitmap> pBitmap(new CFX_DIBitmap);
   if (!pBitmap->Create(width, height, alpha ? FXDIB_Argb : FXDIB_Rgb32)) {
     return NULL;
   }
   return pBitmap.release();
@@ skipping 94 matching lines @@
   if (flags & FPDF_LCD_TEXT)
     pContext->m_pOptions->m_Flags |= RENDER_CLEARTYPE;
   else
     pContext->m_pOptions->m_Flags &= ~RENDER_CLEARTYPE;
   if (flags & FPDF_NO_NATIVETEXT)
     pContext->m_pOptions->m_Flags |= RENDER_NO_NATIVETEXT;
   if (flags & FPDF_RENDER_LIMITEDIMAGECACHE)
     pContext->m_pOptions->m_Flags |= RENDER_LIMITEDIMAGECACHE;
   if (flags & FPDF_RENDER_FORCEHALFTONE)
     pContext->m_pOptions->m_Flags |= RENDER_FORCE_HALFTONE;
+#ifndef PDF_ENABLE_XFA
   if (flags & FPDF_RENDER_NO_SMOOTHTEXT)
     pContext->m_pOptions->m_Flags |= RENDER_NOTEXTSMOOTH;
   if (flags & FPDF_RENDER_NO_SMOOTHIMAGE)
     pContext->m_pOptions->m_Flags |= RENDER_NOIMAGESMOOTH;
   if (flags & FPDF_RENDER_NO_SMOOTHPATH)
     pContext->m_pOptions->m_Flags |= RENDER_NOPATHSMOOTH;
+#endif
   // Grayscale output
   if (flags & FPDF_GRAYSCALE) {
     pContext->m_pOptions->m_ColorMode = RENDER_COLOR_GRAY;
     pContext->m_pOptions->m_ForeColor = 0;
     pContext->m_pOptions->m_BackColor = 0xffffff;
   }
   const CPDF_OCContext::UsageType usage =
       (flags & FPDF_PRINTING) ? CPDF_OCContext::Print : CPDF_OCContext::View;
   pContext->m_pOptions->m_AddFlags = flags >> 8;
   pContext->m_pOptions->m_pOCContext =
@@ skipping 29 matching lines @@
 }
 
 DLLEXPORT int STDCALL FPDF_GetPageSizeByIndex(FPDF_DOCUMENT document,
                                               int page_index,
                                               double* width,
                                               double* height) {
   UnderlyingDocumentType* pDoc = UnderlyingFromFPDFDocument(document);
   if (!pDoc)
     return FALSE;
 
+#ifndef PDF_ENABLE_XFA
   CPDF_Dictionary* pDict = pDoc->GetPage(page_index);
   if (!pDict)
+#else
+  int count = pDoc->GetPageCount();
+  if (page_index < 0 || page_index >= count)
     return FALSE;
 
+  CPDFXFA_Page* pPage = pDoc->GetPage(page_index);
+  if (!pPage)
+#endif
+    return FALSE;
+
+#ifndef PDF_ENABLE_XFA
   CPDF_Page page;
   page.Load(pDoc, pDict);
   *width = page.GetPageWidth();
   *height = page.GetPageHeight();
+#else
+  *width = pPage->GetPageWidth();
+  *height = pPage->GetPageHeight();
+#endif
 
   return TRUE;
 }
 
 DLLEXPORT FPDF_BOOL STDCALL
 FPDF_VIEWERREF_GetPrintScaling(FPDF_DOCUMENT document) {
   CPDF_Document* pDoc = CPDFDocumentFromFPDFDocument(document);
   if (!pDoc)
     return TRUE;
   CPDF_ViewerPreferences viewRef(pDoc);
@@ skipping 56 matching lines @@
     return nullptr;
 
   CPDF_Document* pDoc = CPDFDocumentFromFPDFDocument(document);
   if (!pDoc)
     return nullptr;
 
   CPDF_NameTree name_tree(pDoc, FX_BSTRC("Dests"));
   return name_tree.LookupNamedDest(pDoc, name);
 }
 
+#ifdef PDF_ENABLE_XFA
+FPDF_RESULT FPDF_BStr_Init(FPDF_BSTR* str) {
+  if (!str)
+    return -1;
+
+  FXSYS_memset(str, 0, sizeof(FPDF_BSTR));
+  return 0;
+}
+
+FPDF_RESULT FPDF_BStr_Set(FPDF_BSTR* str, FPDF_LPCSTR bstr, int length) {
+  if (!str)
+    return -1;
+  if (!bstr || !length)
+    return -1;
+  if (length == -1)
+    length = FXSYS_strlen(bstr);
+
+  if (length == 0) {
+    if (str->str) {
+      FX_Free(str->str);
+      str->str = NULL;
+    }
+    str->len = 0;
+    return 0;
+  }
+
+  if (str->str && str->len < length)
+    str->str = FX_Realloc(char, str->str, length + 1);
+  else if (!str->str)
+    str->str = FX_Alloc(char, length + 1);
+
+  str->str[length] = 0;
+  if (str->str == NULL)
+    return -1;
+
+  FXSYS_memcpy(str->str, bstr, length);
+  str->len = length;
+
+  return 0;
+}
+
+FPDF_RESULT FPDF_BStr_Clear(FPDF_BSTR* str) {
+  if (!str)
+    return -1;
+
+  if (str->str) {
+    FX_Free(str->str);
+    str->str = NULL;
+  }
+  str->len = 0;
+  return 0;
+}
+
+#endif
 DLLEXPORT FPDF_DEST STDCALL FPDF_GetNamedDest(FPDF_DOCUMENT document,
                                               int index,
                                               void* buffer,
                                               long* buflen) {
   if (!buffer)
     *buflen = 0;
 
   if (index < 0)
     return nullptr;
 
@@ skipping 45 matching lines @@
   if (!buffer) {
     *buflen = len;
   } else if (*buflen >= len) {
     memcpy(buffer, utf16Name.c_str(), len);
     *buflen = len;
   } else {
     *buflen = -1;
   }
   return (FPDF_DEST)pDestObj;
 }