Merge to XFA: Introduce CPDFDocumentFromFPDFDocument().

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 "../../core/include/fpdfapi/fpdf_module.h"
 #include "../../core/include/fxcodec/fx_codec.h"
 #include "../../core/include/fxcrt/fx_safe_types.h"
 #include "../../public/fpdf_ext.h"
 #include "../../public/fpdf_formfill.h"
 #include "../../public/fpdf_progressive.h"
 #include "../../public/fpdfview.h"
 #include "../../third_party/base/nonstd_unique_ptr.h"
 #include "../../third_party/base/numerics/safe_conversions_impl.h"
 #include "../include/fsdk_define.h"
 #include "../include/fsdk_mgr.h"
 #include "../include/fsdk_rendercontext.h"
 #include "../include/fpdfxfa/fpdfxfa_doc.h"
 #include "../include/fpdfxfa/fpdfxfa_app.h"
 #include "../include/fpdfxfa/fpdfxfa_page.h"
 #include "../include/fpdfxfa/fpdfxfa_util.h"
 #include "../include/javascript/IJavaScript.h"
 
+CPDF_Document* CPDFDocumentFromFPDFDocument(FPDF_DOCUMENT doc) {
+  return doc ? static_cast<CPDFXFA_Document*>(doc)->GetPDFDoc() : 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() {
@@ skipping 333 matching lines @@
   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_GetFileVersion(FPDF_DOCUMENT doc,
                                                 int* fileVersion) {
-  if (!doc || !fileVersion)
+  if (!fileVersion)
     return FALSE;
+
   *fileVersion = 0;

[Lei Zhang, 2015/10/15 22:44:27]

There's a subtle behavior change, but I don't think we care since it was already
inconsistent before.

[Tom Sepez, 2015/10/15 23:18:09]

Yes, intentional, was trying to avoid an uninitialized read by callers who don't
check return status.

-  CPDFXFA_Document* pDoc = (CPDFXFA_Document*)doc;
-  CPDF_Document* pPDFDoc = pDoc->GetPDFDoc();
-  if (!pPDFDoc)
-    return (FX_DWORD)-1;

[Lei Zhang, 2015/10/15 22:44:27]

:\

-  CPDF_Parser* pParser = (CPDF_Parser*)pPDFDoc->GetParser();
+  CPDF_Document* pDoc = CPDFDocumentFromFPDFDocument(doc);
+  if (!pDoc)
+    return FALSE;
 
+  CPDF_Parser* pParser = (CPDF_Parser*)pDoc->GetParser();

[Lei Zhang, 2015/10/15 22:44:27]

Same pointless cast? More below.

[Tom Sepez, 2015/10/15 23:18:09]

And you know what we do to pointless casts.

   if (!pParser)
     return FALSE;
+
   *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) {
-  if (document == NULL)
-    return 0;
-  CPDFXFA_Document* pDoc = (CPDFXFA_Document*)document;
-  CPDF_Document* pPDFDoc = pDoc->GetPDFDoc();
-  if (!pPDFDoc)
-    return (FX_DWORD)-1;
-  CPDF_Parser* pParser = (CPDF_Parser*)pPDFDoc->GetParser();
-  CPDF_Dictionary* pDict = pParser->GetEncryptDict();
-  if (pDict == NULL)
+  CPDF_Document* pDoc = CPDFDocumentFromFPDFDocument(document);
+  if (!pDoc)
     return (FX_DWORD)-1;
 
-  return pDict->GetInteger("P");
+  CPDF_Parser* pParser = (CPDF_Parser*)pDoc->GetParser();
+  CPDF_Dictionary* pDict = pParser->GetEncryptDict();
+  return pDict ? pDict->GetInteger("P") : (FX_DWORD)-1;
 }
 
 DLLEXPORT int STDCALL FPDF_GetSecurityHandlerRevision(FPDF_DOCUMENT document) {
-  if (document == NULL)
+  CPDF_Document* pDoc = CPDFDocumentFromFPDFDocument(document);
+  if (!pDoc)
     return -1;
-  CPDF_Document* pDoc = ((CPDFXFA_Document*)document)->GetPDFDoc();
+
   CPDF_Parser* pParser = (CPDF_Parser*)pDoc->GetParser();
   CPDF_Dictionary* pDict = pParser->GetEncryptDict();
-  if (pDict == NULL)
-    return -1;
-
-  return pDict->GetInteger("R");
+  return pDict ? pDict->GetInteger("R") : -1;
 }
 
 DLLEXPORT int STDCALL FPDF_GetPageCount(FPDF_DOCUMENT document) {
-  if (document == NULL)
-    return 0;
-  CPDFXFA_Document* pDoc = (CPDFXFA_Document*)document;
-  return pDoc->GetPageCount();
-  //    return ((CPDF_Document*)document)->GetPageCount();
+  CPDF_Document* pDoc = CPDFDocumentFromFPDFDocument(document);
+  return pDoc ? pDoc->GetPageCount() : 0;
 }
 
 DLLEXPORT FPDF_PAGE STDCALL FPDF_LoadPage(FPDF_DOCUMENT document,
                                           int page_index) {
-  if (document == NULL)
-    return NULL;
-  CPDFXFA_Document* pDoc = (CPDFXFA_Document*)document;
-  if (page_index < 0 || page_index >= pDoc->GetPageCount())
-    return NULL;
-  //    CPDF_Parser* pParser = (CPDF_Parser*)document;
+  CPDF_Document* pDoc = CPDFDocumentFromFPDFDocument(document);
+  if (!pDoc)
+    return nullptr;
+
+  if (page_index < 0 || page_index >= FPDF_GetPageCount(document))
+    return nullptr;
+
   return pDoc->GetPage(page_index);
 }
 
 DLLEXPORT double STDCALL FPDF_GetPageWidth(FPDF_PAGE page) {
   if (!page)
     return 0.0;
   return ((CPDFXFA_Page*)page)->GetPageWidth();
   //    return ((CPDF_Page*)page)->GetPageWidth();
 }
 
@@ skipping 218 matching lines @@
 
 DLLEXPORT void STDCALL FPDF_ClosePage(FPDF_PAGE page) {
   if (!page)
     return;
 
   CPDFXFA_Page* pPage = (CPDFXFA_Page*)page;
   pPage->Release();
 }
 
 DLLEXPORT void STDCALL FPDF_CloseDocument(FPDF_DOCUMENT document) {
-  if (!document)
-    return;
-
-  CPDFXFA_Document* pDoc = (CPDFXFA_Document*)document;
+  CPDF_Document* pDoc = CPDFDocumentFromFPDFDocument(document);

[Lei Zhang, 2015/10/15 22:44:27]

Do we even need the variable anymore?

[Tom Sepez, 2015/10/15 23:18:09]

Done.

   delete pDoc;
 }
 
 DLLEXPORT unsigned long STDCALL FPDF_GetLastError() {
   return GetLastError();
 }
 
 DLLEXPORT void STDCALL FPDF_DeviceToPage(FPDF_PAGE page,
                                          int start_x,
                                          int start_y,
@@ skipping 202 matching lines @@
     return FALSE;
 
   *width = pPage->GetPageWidth();
   *height = pPage->GetPageHeight();
 
   return TRUE;
 }
 
 DLLEXPORT FPDF_BOOL STDCALL
 FPDF_VIEWERREF_GetPrintScaling(FPDF_DOCUMENT document) {
-  CPDFXFA_Document* pDoc = (CPDFXFA_Document*)document;
+  CPDF_Document* pDoc = CPDFDocumentFromFPDFDocument(document);
   if (!pDoc)
     return TRUE;
-  CPDF_Document* pPDFDoc = pDoc->GetPDFDoc();
-  if (!pPDFDoc)
-    return TRUE;
-  CPDF_ViewerPreferences viewRef(pPDFDoc);
+  CPDF_ViewerPreferences viewRef(pDoc);
   return viewRef.PrintScaling();
 }
 
 DLLEXPORT int STDCALL FPDF_VIEWERREF_GetNumCopies(FPDF_DOCUMENT document) {
-  CPDF_Document* pDoc = ((CPDFXFA_Document*)document)->GetPDFDoc();
+  CPDF_Document* pDoc = CPDFDocumentFromFPDFDocument(document);
   if (!pDoc)
     return 1;
   CPDF_ViewerPreferences viewRef(pDoc);
   return viewRef.NumCopies();
 }
 
 DLLEXPORT FPDF_PAGERANGE STDCALL
 FPDF_VIEWERREF_GetPrintPageRange(FPDF_DOCUMENT document) {
-  CPDF_Document* pDoc = ((CPDFXFA_Document*)document)->GetPDFDoc();
+  CPDF_Document* pDoc = CPDFDocumentFromFPDFDocument(document);
   if (!pDoc)
     return NULL;
   CPDF_ViewerPreferences viewRef(pDoc);
   return viewRef.PrintPageRange();
 }
 
 DLLEXPORT FPDF_DUPLEXTYPE STDCALL
 FPDF_VIEWERREF_GetDuplex(FPDF_DOCUMENT document) {
-  CPDF_Document* pDoc = ((CPDFXFA_Document*)document)->GetPDFDoc();
+  CPDF_Document* pDoc = CPDFDocumentFromFPDFDocument(document);
   if (!pDoc)
     return DuplexUndefined;
   CPDF_ViewerPreferences viewRef(pDoc);
   CFX_ByteString duplex = viewRef.Duplex();
   if (FX_BSTRC("Simplex") == duplex)
     return Simplex;
   if (FX_BSTRC("DuplexFlipShortEdge") == duplex)
     return DuplexFlipShortEdge;
   if (FX_BSTRC("DuplexFlipLongEdge") == duplex)
     return DuplexFlipLongEdge;
   return DuplexUndefined;
 }
 
 DLLEXPORT FPDF_DWORD STDCALL FPDF_CountNamedDests(FPDF_DOCUMENT document) {
-  if (!document)
+  CPDF_Document* pDoc = CPDFDocumentFromFPDFDocument(document);
+  if (!pDoc)
     return 0;
-  CPDF_Document* pDoc = ((CPDFXFA_Document*)document)->GetPDFDoc();
 
   CPDF_Dictionary* pRoot = pDoc->GetRoot();
   if (!pRoot)
     return 0;
 
   CPDF_NameTree nameTree(pDoc, FX_BSTRC("Dests"));
   int count = nameTree.GetCount();
   CPDF_Dictionary* pDest = pRoot->GetDict(FX_BSTRC("Dests"));
   if (pDest)
     count += pDest->GetCount();
   return count;
 }
 
 DLLEXPORT FPDF_DEST STDCALL FPDF_GetNamedDestByName(FPDF_DOCUMENT document,
                                                     FPDF_BYTESTRING name) {
-  if (!document)
-    return NULL;
   if (!name || name[0] == 0)
-    return NULL;
+    return nullptr;
 
-  CPDFXFA_Document* pDoc = (CPDFXFA_Document*)document;
-  CPDF_Document* pPDFDoc = pDoc->GetPDFDoc();
-  if (!pPDFDoc)
-    return NULL;
-  CPDF_NameTree name_tree(pPDFDoc, FX_BSTRC("Dests"));
-  return name_tree.LookupNamedDest(pPDFDoc, name);
+  CPDF_Document* pDoc = CPDFDocumentFromFPDFDocument(document);
+  if (!pDoc)
+    return nullptr;
+
+  CPDF_NameTree name_tree(pDoc, FX_BSTRC("Dests"));
+  return name_tree.LookupNamedDest(pDoc, name);
 }
 
 FPDF_RESULT FPDF_BStr_Init(FPDF_BSTR* str) {
   if (!str)
     return -1;
 
   FXSYS_memset(str, 0, sizeof(FPDF_BSTR));
   return 0;
 }
 
@@ skipping 94 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;
 }