Remove unused code in CPDFXFA_Document

fpdfsdk/fpdfxfa/fpdfxfa_doc.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 "fpdfsdk/fpdfxfa/include/fpdfxfa_doc.h"
 
 #include "core/fpdfapi/fpdf_parser/include/cpdf_array.h"
 #include "core/fpdfapi/fpdf_parser/include/cpdf_document.h"
@@ skipping 499 matching lines @@
 
   CPDFXFA_Page* pXFAPage = GetPage(pPageView);
   if (!pXFAPage)
     return;
 
   CPDFSDK_PageView* pSdkPageView = m_pSDKDoc->GetPageView(pXFAPage, true);
   if (CPDFSDK_Annot* pAnnot = pSdkPageView->GetAnnotByXFAWidget(hWidget))
     pSdkPageView->DeleteAnnot(pAnnot);
 }
 
-FX_BOOL CPDFXFA_Document::RenderCustomWidget(CXFA_FFWidget* hWidget,
-                                             CFX_Graphics* pGS,
-                                             CFX_Matrix* pMatrix,
-                                             const CFX_RectF& rtUI) {
-  return FALSE;
-}
-
 int32_t CPDFXFA_Document::CountPages(CXFA_FFDoc* hDoc) {
   if (hDoc == m_pXFADoc.get() && m_pSDKDoc)
     return GetPageCount();
   return 0;
 }
 
 int32_t CPDFXFA_Document::GetCurrentPage(CXFA_FFDoc* hDoc) {
   if (hDoc != m_pXFADoc.get() || !m_pSDKDoc)
     return -1;
   if (m_iDocType != DOCTYPE_DYNAMIC_XFA)
@@ skipping 10 matching lines @@
   if (hDoc != m_pXFADoc.get() || !m_pSDKDoc ||
       m_iDocType != DOCTYPE_DYNAMIC_XFA || iCurPage < 0 ||
       iCurPage >= m_pSDKDoc->GetPageCount()) {
     return;
   }
   CPDFDoc_Environment* pEnv = m_pSDKDoc->GetEnv();
   if (!pEnv)
     return;
   pEnv->FFI_SetCurrentPage(this, iCurPage);
 }
+
 FX_BOOL CPDFXFA_Document::IsCalculationsEnabled(CXFA_FFDoc* hDoc) {
   if (hDoc != m_pXFADoc.get() || !m_pSDKDoc)
     return FALSE;
   if (m_pSDKDoc->GetInterForm())
     return m_pSDKDoc->GetInterForm()->IsXfaCalculateEnabled();
 
   return FALSE;
 }
+
 void CPDFXFA_Document::SetCalculationsEnabled(CXFA_FFDoc* hDoc,
                                               FX_BOOL bEnabled) {
   if (hDoc != m_pXFADoc.get() || !m_pSDKDoc)
     return;
   if (m_pSDKDoc->GetInterForm())
     m_pSDKDoc->GetInterForm()->XfaEnableCalculate(bEnabled);
 }
 
 void CPDFXFA_Document::GetTitle(CXFA_FFDoc* hDoc, CFX_WideString& wsTitle) {
   if (hDoc != m_pXFADoc.get() || !m_pPDFDoc)
@@ skipping 100 matching lines @@
         pAcc->LoadAllData(pStream);
         fileWrite.WriteBlock(pAcc->GetData(), fileWrite.GetSize(),
                              pAcc->GetSize());
       }
     }
   }
   if (!fileWrite.Flush()) {
     // Ignoring flush error.
   }
 }
-void CPDFXFA_Document::ImportData(CXFA_FFDoc* hDoc,
-                                  const CFX_WideString& wsFilePath) {}
 
 void CPDFXFA_Document::GotoURL(CXFA_FFDoc* hDoc,
                                const CFX_WideString& bsURL,
                                FX_BOOL bAppend) {
   if (hDoc != m_pXFADoc.get())
     return;
 
   if (m_iDocType != DOCTYPE_DYNAMIC_XFA)
     return;
 
   CPDFDoc_Environment* pEnv = m_pSDKDoc->GetEnv();
   if (!pEnv)
     return;
 
   CFX_WideStringC str(bsURL.c_str());
 
   pEnv->FFI_GotoURL(this, str, bAppend);
 }
 
 FX_BOOL CPDFXFA_Document::IsValidationsEnabled(CXFA_FFDoc* hDoc) {
   if (hDoc != m_pXFADoc.get() || !m_pSDKDoc)
     return FALSE;
   if (m_pSDKDoc->GetInterForm())
     return m_pSDKDoc->GetInterForm()->IsXfaValidationsEnabled();
 
   return TRUE;
 }
+
 void CPDFXFA_Document::SetValidationsEnabled(CXFA_FFDoc* hDoc,
                                              FX_BOOL bEnabled) {
   if (hDoc != m_pXFADoc.get() || !m_pSDKDoc)
     return;
   if (m_pSDKDoc->GetInterForm())
     m_pSDKDoc->GetInterForm()->XfaSetValidationsEnabled(bEnabled);
 }
+
 void CPDFXFA_Document::SetFocusWidget(CXFA_FFDoc* hDoc,
                                       CXFA_FFWidget* hWidget) {
   if (hDoc != m_pXFADoc.get())
     return;
 
   if (!hWidget) {
     m_pSDKDoc->SetFocusAnnot(nullptr);
     return;
   }
 
   int pageViewCount = m_pSDKDoc->GetPageViewCount();
   for (int i = 0; i < pageViewCount; i++) {
     CPDFSDK_PageView* pPageView = m_pSDKDoc->GetPageView(i);
     if (!pPageView)
       continue;
     CPDFSDK_Annot* pAnnot = pPageView->GetAnnotByXFAWidget(hWidget);
     if (pAnnot) {
       m_pSDKDoc->SetFocusAnnot(pAnnot);
       break;
     }
   }
 }
+
 void CPDFXFA_Document::Print(CXFA_FFDoc* hDoc,
                              int32_t nStartPage,
                              int32_t nEndPage,
                              uint32_t dwOptions) {
   if (hDoc != m_pXFADoc.get())
     return;
 
   CPDFDoc_Environment* pEnv = m_pSDKDoc->GetEnv();
   if (!pEnv || !pEnv->GetFormFillInfo() ||
       !pEnv->GetFormFillInfo()->m_pJsPlatform ||
       !pEnv->GetFormFillInfo()->m_pJsPlatform->Doc_print) {
     return;
   }
 
   pEnv->GetFormFillInfo()->m_pJsPlatform->Doc_print(
       pEnv->GetFormFillInfo()->m_pJsPlatform,
       dwOptions & XFA_PRINTOPT_ShowDialog, nStartPage, nEndPage,
       dwOptions & XFA_PRINTOPT_CanCancel, dwOptions & XFA_PRINTOPT_ShrinkPage,
       dwOptions & XFA_PRINTOPT_AsImage, dwOptions & XFA_PRINTOPT_ReverseOrder,
       dwOptions & XFA_PRINTOPT_PrintAnnot);
 }
 
-int32_t CPDFXFA_Document::AbsPageCountInBatch(CXFA_FFDoc* hDoc) {
-  return 0;
-}
-
-int32_t CPDFXFA_Document::AbsPageInBatch(CXFA_FFDoc* hDoc,
-                                         CXFA_FFWidget* hWidget) {
-  return 0;
-}
-
-int32_t CPDFXFA_Document::SheetCountInBatch(CXFA_FFDoc* hDoc) {
-  return 0;
-}
-
-int32_t CPDFXFA_Document::SheetInBatch(CXFA_FFDoc* hDoc,
-                                       CXFA_FFWidget* hWidget) {
-  return 0;
-}
-
-int32_t CPDFXFA_Document::Verify(CXFA_FFDoc* hDoc,
-                                 CXFA_Node* pSigNode,
-                                 FX_BOOL bUsed) {
-  return 0;
-}
-
-FX_BOOL CPDFXFA_Document::Sign(CXFA_FFDoc* hDoc,
-                               CXFA_NodeList* pNodeList,
-                               const CFX_WideStringC& wsExpression,
-                               const CFX_WideStringC& wsXMLIdent,
-                               const CFX_WideStringC& wsValue,
-                               FX_BOOL bUsed) {
-  return 0;
-}
-
-CXFA_NodeList* CPDFXFA_Document::Enumerate(CXFA_FFDoc* hDoc) {
-  return 0;
-}
-
-FX_BOOL CPDFXFA_Document::Clear(CXFA_FFDoc* hDoc,
-                                CXFA_Node* pSigNode,
-                                FX_BOOL bCleared) {
-  return 0;
-}
-
 void CPDFXFA_Document::GetURL(CXFA_FFDoc* hDoc, CFX_WideString& wsDocURL) {
   if (hDoc != m_pXFADoc.get())
     return;
 
   CPDFDoc_Environment* pEnv = m_pSDKDoc->GetEnv();
   if (!pEnv)
     return;
 
   pEnv->FFI_GetURL(this, wsDocURL);
 }
 
 FX_ARGB CPDFXFA_Document::GetHighlightColor(CXFA_FFDoc* hDoc) {
   if (hDoc != m_pXFADoc.get())
     return 0;
   if (m_pSDKDoc) {
     if (CPDFSDK_InterForm* pInterForm = m_pSDKDoc->GetInterForm()) {
       FX_COLORREF color = pInterForm->GetHighlightColor(FPDF_FORMFIELD_XFA);
       uint8_t alpha = pInterForm->GetHighlightAlpha();
       FX_ARGB argb = ArgbEncode((int)alpha, color);
       return argb;
     }
   }
   return 0;
 }
 
-FX_BOOL CPDFXFA_Document::_NotifySubmit(FX_BOOL bPrevOrPost) {
+FX_BOOL CPDFXFA_Document::NotifySubmit(FX_BOOL bPrevOrPost) {
   if (bPrevOrPost)
-    return _OnBeforeNotifySumbit();
+    return OnBeforeNotifySubmit();
 
-  _OnAfterNotifySumbit();
+  OnAfterNotifySubmit();
   return TRUE;
 }
 
-FX_BOOL CPDFXFA_Document::_OnBeforeNotifySumbit() {
+FX_BOOL CPDFXFA_Document::OnBeforeNotifySubmit() {
   if (m_iDocType != DOCTYPE_DYNAMIC_XFA && m_iDocType != DOCTYPE_STATIC_XFA)
     return TRUE;
 
   if (!m_pXFADocView)
     return TRUE;
 
   CXFA_FFWidgetHandler* pWidgetHandler = m_pXFADocView->GetWidgetHandler();
   if (!pWidgetHandler)
     return TRUE;
 
@@ skipping 26 matching lines @@
         bs.ReleaseBuffer(len * sizeof(unsigned short));
         return FALSE;
       }
       pWidgetAcc = pWidgetAccIterator->MoveToNext();
     }
     m_pXFADocView->UpdateDocView();
   }
   return TRUE;
 }
 
-void CPDFXFA_Document::_OnAfterNotifySumbit() {
+void CPDFXFA_Document::OnAfterNotifySubmit() {
   if (m_iDocType != DOCTYPE_DYNAMIC_XFA && m_iDocType != DOCTYPE_STATIC_XFA)
     return;
 
   if (!m_pXFADocView)
     return;
 
   CXFA_FFWidgetHandler* pWidgetHandler = m_pXFADocView->GetWidgetHandler();
   if (!pWidgetHandler)
     return;
 
   std::unique_ptr<CXFA_WidgetAccIterator> pWidgetAccIterator(
       m_pXFADocView->CreateWidgetAccIterator());
   if (!pWidgetAccIterator)
     return;
 
   CXFA_EventParam Param;
   Param.m_eType = XFA_EVENT_PostSubmit;
   CXFA_WidgetAcc* pWidgetAcc = pWidgetAccIterator->MoveToNext();
   while (pWidgetAcc) {
     pWidgetHandler->ProcessEvent(pWidgetAcc, &Param);
     pWidgetAcc = pWidgetAccIterator->MoveToNext();
   }
   m_pXFADocView->UpdateDocView();
 }
 
 FX_BOOL CPDFXFA_Document::SubmitData(CXFA_FFDoc* hDoc, CXFA_Submit submit) {
-  if (!_NotifySubmit(TRUE) || !m_pXFADocView)
+  if (!NotifySubmit(TRUE) || !m_pXFADocView)
     return FALSE;
   m_pXFADocView->UpdateDocView();
 
-  FX_BOOL ret = _SubmitData(hDoc, submit);
-  _NotifySubmit(FALSE);
+  FX_BOOL ret = SubmitDataInternal(hDoc, submit);
+  NotifySubmit(FALSE);
   return ret;
 }
 
-FX_BOOL CPDFXFA_Document::CheckWord(CXFA_FFDoc* hDoc,
-                                    const CFX_ByteStringC& sWord) {
-  return FALSE;
-}
-
-FX_BOOL CPDFXFA_Document::GetSuggestWords(
-    CXFA_FFDoc* hDoc,
-    const CFX_ByteStringC& sWord,
-    std::vector<CFX_ByteString>& sSuggest) {
-  return FALSE;
-}
-
 IFX_FileRead* CPDFXFA_Document::OpenLinkedFile(CXFA_FFDoc* hDoc,
                                                const CFX_WideString& wsLink) {
   CPDFDoc_Environment* pEnv = m_pSDKDoc->GetEnv();
   if (!pEnv)
     return FALSE;
   CFX_ByteString bs = wsLink.UTF16LE_Encode();
   int len = bs.GetLength() / sizeof(unsigned short);
   FPDF_FILEHANDLER* pFileHandler = pEnv->FFI_OpenFile(
       0, (FPDF_WIDESTRING)bs.GetBuffer(len * sizeof(unsigned short)), "rb");
   bs.ReleaseBuffer(len * sizeof(unsigned short));
 
   if (!pFileHandler)
     return nullptr;
   return new CFPDF_FileStream(pFileHandler);
 }
-FX_BOOL CPDFXFA_Document::_ExportSubmitFile(FPDF_FILEHANDLER* pFileHandler,
-                                            int fileType,
-                                            FPDF_DWORD encodeType,
-                                            FPDF_DWORD flag) {
+
+FX_BOOL CPDFXFA_Document::ExportSubmitFile(FPDF_FILEHANDLER* pFileHandler,
+                                           int fileType,
+                                           FPDF_DWORD encodeType,
+                                           FPDF_DWORD flag) {
   if (!m_pXFADocView)
     return FALSE;
 
   CFX_ByteString content;
   CPDFDoc_Environment* pEnv = m_pSDKDoc->GetEnv();
   if (!pEnv)
     return FALSE;
 
   CFPDF_FileStream fileStream(pFileHandler);
 
@@ skipping 60 matching lines @@
       m_pXFADoc->SavePackage(XFA_HASHCODE_Form, &fileStream, nullptr);
     } else if (pPrePDFObj->GetString() == "datasets") {
       m_pXFADoc->SavePackage(XFA_HASHCODE_Datasets, &fileStream, nullptr);
     } else {
       // PDF,creator.
     }
   }
   return TRUE;
 }
 
-void CPDFXFA_Document::_ClearChangeMark() {
+void CPDFXFA_Document::ClearChangeMark() {
   if (m_pSDKDoc)
     m_pSDKDoc->ClearChangeMark();
 }
 
-void CPDFXFA_Document::_ToXFAContentFlags(CFX_WideString csSrcContent,
-                                          FPDF_DWORD& flag) {
+void CPDFXFA_Document::ToXFAContentFlags(CFX_WideString csSrcContent,
+                                         FPDF_DWORD& flag) {
   if (csSrcContent.Find(L" config ", 0) != -1)
     flag |= FXFA_CONFIG;
   if (csSrcContent.Find(L" template ", 0) != -1)
     flag |= FXFA_TEMPLATE;
   if (csSrcContent.Find(L" localeSet ", 0) != -1)
     flag |= FXFA_LOCALESET;
   if (csSrcContent.Find(L" datasets ", 0) != -1)
     flag |= FXFA_DATASETS;
   if (csSrcContent.Find(L" xmpmeta ", 0) != -1)
     flag |= FXFA_XMPMETA;
   if (csSrcContent.Find(L" xfdf ", 0) != -1)
     flag |= FXFA_XFDF;
   if (csSrcContent.Find(L" form ", 0) != -1)
     flag |= FXFA_FORM;
   if (flag == 0)
     flag = FXFA_CONFIG | FXFA_TEMPLATE | FXFA_LOCALESET | FXFA_DATASETS |
            FXFA_XMPMETA | FXFA_XFDF | FXFA_FORM;
 }
-FX_BOOL CPDFXFA_Document::_MailToInfo(CFX_WideString& csURL,
-                                      CFX_WideString& csToAddress,
-                                      CFX_WideString& csCCAddress,
-                                      CFX_WideString& csBCCAddress,
-                                      CFX_WideString& csSubject,
-                                      CFX_WideString& csMsg) {
+
+FX_BOOL CPDFXFA_Document::MailToInfo(CFX_WideString& csURL,
+                                     CFX_WideString& csToAddress,
+                                     CFX_WideString& csCCAddress,
+                                     CFX_WideString& csBCCAddress,
+                                     CFX_WideString& csSubject,
+                                     CFX_WideString& csMsg) {
   CFX_WideString srcURL = csURL;
   srcURL.TrimLeft();
   if (0 != srcURL.Left(7).CompareNoCase(L"mailto:"))
     return FALSE;
   int pos = srcURL.Find(L'?', 0);
   CFX_WideString tmp;
   if (pos == -1) {
     pos = srcURL.Find(L'@', 0);
     if (pos == -1)
       return FALSE;
@@ skipping 47 matching lines @@
       srcURL = L"";
     else
       srcURL = srcURL.Right(csURL.GetLength() - (pos + 1));
   }
   csToAddress.Replace(L",", L";");
   csCCAddress.Replace(L",", L";");
   csBCCAddress.Replace(L",", L";");
   return TRUE;
 }
 
-FX_BOOL CPDFXFA_Document::_SubmitData(CXFA_FFDoc* hDoc, CXFA_Submit submit) {
+FX_BOOL CPDFXFA_Document::SubmitDataInternal(CXFA_FFDoc* hDoc,
+                                             CXFA_Submit submit) {
   CPDFDoc_Environment* pEnv = m_pSDKDoc->GetEnv();
   if (!pEnv)
     return FALSE;
   CFX_WideStringC csURLC;
   submit.GetSubmitTarget(csURLC);
   CFX_WideString csURL(csURLC);
   if (csURL.IsEmpty()) {
     CFX_WideString ws;
     ws.FromLocal("Submit cancelled.");
     CFX_ByteString bs = ws.UTF16LE_Encode();
@@ skipping 13 matching lines @@
       CFX_WideString csContent;
       csContent = csContentC;
       csContent.TrimLeft();
       csContent.TrimRight();
       CFX_WideString space;
       space.FromLocal(" ");
       csContent = space + csContent + space;
       FPDF_DWORD flag = 0;
       if (submit.IsSubmitEmbedPDF())
         flag |= FXFA_PDF;
-      _ToXFAContentFlags(csContent, flag);
+      ToXFAContentFlags(csContent, flag);
       pFileHandler = pEnv->FFI_OpenFile(FXFA_SAVEAS_XDP, nullptr, "wb");
       fileFlag = FXFA_SAVEAS_XDP;
-      _ExportSubmitFile(pFileHandler, FXFA_SAVEAS_XDP, 0, flag);
+      ExportSubmitFile(pFileHandler, FXFA_SAVEAS_XDP, 0, flag);
       break;
     }
     case XFA_ATTRIBUTEENUM_Xml:
       pFileHandler = pEnv->FFI_OpenFile(FXFA_SAVEAS_XML, nullptr, "wb");
       fileFlag = FXFA_SAVEAS_XML;
-      _ExportSubmitFile(pFileHandler, FXFA_SAVEAS_XML, 0);
+      ExportSubmitFile(pFileHandler, FXFA_SAVEAS_XML, 0, 0x01111111);

[Wei Li, 2016/09/13 21:31:20]

Why change this value? passing in 0 as the default, the flag will be set
properly in ExportSubmitFile(). If you really want to make this explicit, how
about define a constant?

[dsinclair, 2016/09/14 01:06:07]

This was the value of the default parameter, I just removed the default from the
header:

    FX_BOOL _ExportSubmitFile(FPDF_FILEHANDLER* ppFileHandler,	
                              int fileType,	
                              FPDF_DWORD encodeType,	
                              FPDF_DWORD flag = 0x01111111);

I'll see if I can figure out what the flags represent and make constants for
them.

       break;
     case XFA_ATTRIBUTEENUM_Pdf:
       break;
     case XFA_ATTRIBUTEENUM_Urlencoded:
       pFileHandler = pEnv->FFI_OpenFile(FXFA_SAVEAS_XML, nullptr, "wb");
       fileFlag = FXFA_SAVEAS_XML;
-      _ExportSubmitFile(pFileHandler, FXFA_SAVEAS_XML, 0);
+      ExportSubmitFile(pFileHandler, FXFA_SAVEAS_XML, 0, 0x01111111);
       break;
     default:
       return false;
   }
   if (!pFileHandler)
     return FALSE;
   if (0 == csURL.Left(7).CompareNoCase(L"mailto:")) {
     CFX_WideString csToAddress;
     CFX_WideString csCCAddress;
     CFX_WideString csBCCAddress;
     CFX_WideString csSubject;
     CFX_WideString csMsg;
-    bRet = _MailToInfo(csURL, csToAddress, csCCAddress, csBCCAddress, csSubject,
-                       csMsg);
+    bRet = MailToInfo(csURL, csToAddress, csCCAddress, csBCCAddress, csSubject,
+                      csMsg);
     if (!bRet)
       return FALSE;
     CFX_ByteString bsTo = CFX_WideString(csToAddress).UTF16LE_Encode();
     CFX_ByteString bsCC = CFX_WideString(csCCAddress).UTF16LE_Encode();
     CFX_ByteString bsBcc = CFX_WideString(csBCCAddress).UTF16LE_Encode();
     CFX_ByteString bsSubject = CFX_WideString(csSubject).UTF16LE_Encode();
     CFX_ByteString bsMsg = CFX_WideString(csMsg).UTF16LE_Encode();
     FPDF_WIDESTRING pTo = (FPDF_WIDESTRING)bsTo.GetBuffer(bsTo.GetLength());
     FPDF_WIDESTRING pCC = (FPDF_WIDESTRING)bsCC.GetBuffer(bsCC.GetLength());
     FPDF_WIDESTRING pBcc = (FPDF_WIDESTRING)bsBcc.GetBuffer(bsBcc.GetLength());
@@ skipping 55 matching lines @@
     return FALSE;
 
   if (!m_pJSContext) {
     m_pSDKDoc->GetEnv()->GetJSRuntime()->SetReaderDocument(m_pSDKDoc.get());
     m_pJSContext = m_pSDKDoc->GetEnv()->GetJSRuntime()->NewContext();
   }
 
   return m_pSDKDoc->GetEnv()->GetJSRuntime()->GetValueByName(szPropName,
                                                              pValue);
 }
-
-CPDF_Document* CPDFXFA_Document::OpenPDF(CXFA_FFDoc* hDoc,
-                                         IFX_FileRead* pFile,
-                                         FX_BOOL bTakeOverFile) {
-  return nullptr;
-}