Remove CFX_PtrArray usage in fpdfsdk.

core/src/fpdfdoc/doc_form.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 "../../include/fpdfdoc/fpdf_doc.h"
 #include "doc_utils.h"
 
 const int nMaxRecursion = 32;
 
-class _CFieldNameExtractor {
+class CFieldNameExtractor {
  public:
-  _CFieldNameExtractor(const CFX_WideString& full_name) {
+  explicit CFieldNameExtractor(const CFX_WideString& full_name) {
     m_pStart = full_name.c_str();
     m_pEnd = m_pStart + full_name.GetLength();
     m_pCur = m_pStart;
   }
   void GetNext(const FX_WCHAR*& pSubName, FX_STRSIZE& size) {
     pSubName = m_pCur;
     while (m_pCur < m_pEnd && m_pCur[0] != L'.') {
       m_pCur++;
     }
     size = (FX_STRSIZE)(m_pCur - pSubName);
@@ skipping 119 matching lines @@
   for (int i = 0; i < ptr_array.GetSize(); i++) {
     _Node* pNode = (_Node*)ptr_array[i];
     RemoveNode(pNode);
   }
 }
 void CFieldTree::SetField(const CFX_WideString& full_name,
                           CPDF_FormField* field_ptr) {
   if (full_name == L"") {
     return;
   }
-  _CFieldNameExtractor name_extractor(full_name);
+  CFieldNameExtractor name_extractor(full_name);
   const FX_WCHAR* pName;
   FX_STRSIZE nLength;
   name_extractor.GetNext(pName, nLength);
   _Node *pNode = &m_Root, *pLast = NULL;
   while (nLength > 0) {
     pLast = pNode;
     CFX_WideString name = CFX_WideString(pName, nLength);
     pNode = _Lookup(pLast, name);
     if (pNode == NULL) {
       pNode = AddChild(pLast, name, NULL);
     }
     name_extractor.GetNext(pName, nLength);
   }
   if (pNode != &m_Root) {
     pNode->field_ptr = field_ptr;
   }
 }
 CPDF_FormField* CFieldTree::GetField(const CFX_WideString& full_name) {
   if (full_name == L"") {
     return NULL;
   }
-  _CFieldNameExtractor name_extractor(full_name);
+  CFieldNameExtractor name_extractor(full_name);
   const FX_WCHAR* pName;
   FX_STRSIZE nLength;
   name_extractor.GetNext(pName, nLength);
   _Node *pNode = &m_Root, *pLast = NULL;
   while (nLength > 0 && pNode) {
     pLast = pNode;
     CFX_WideString name = CFX_WideString(pName, nLength);
     pNode = _Lookup(pLast, name);
     name_extractor.GetNext(pName, nLength);
   }
   return pNode ? pNode->field_ptr : NULL;
 }
 CPDF_FormField* CFieldTree::RemoveField(const CFX_WideString& full_name) {
   if (full_name == L"") {
     return NULL;
   }
-  _CFieldNameExtractor name_extractor(full_name);
+  CFieldNameExtractor name_extractor(full_name);
   const FX_WCHAR* pName;
   FX_STRSIZE nLength;
   name_extractor.GetNext(pName, nLength);
   _Node *pNode = &m_Root, *pLast = NULL;
   while (nLength > 0 && pNode) {
     pLast = pNode;
     CFX_WideString name = CFX_WideString(pName, nLength);
     pNode = _Lookup(pLast, name);
     name_extractor.GetNext(pName, nLength);
   }
   if (pNode && pNode != &m_Root) {
     CFX_PtrArray& ptr_array = pLast->children;
     for (int i = 0; i < ptr_array.GetSize(); i++) {
       if (pNode == (_Node*)ptr_array[i]) {
         ptr_array.RemoveAt(i);
         break;
       }
     }
     CPDF_FormField* pField = pNode->field_ptr;
     RemoveNode(pNode);
     return pField;
   }
   return NULL;
 }
 CFieldTree::_Node* CFieldTree::FindNode(const CFX_WideString& full_name) {
   if (full_name == L"") {
     return NULL;
   }
-  _CFieldNameExtractor name_extractor(full_name);
+  CFieldNameExtractor name_extractor(full_name);
   const FX_WCHAR* pName;
   FX_STRSIZE nLength;
   name_extractor.GetNext(pName, nLength);
   _Node *pNode = &m_Root, *pLast = NULL;
   while (nLength > 0 && pNode) {
     pLast = pNode;
     CFX_WideString name = CFX_WideString(pName, nLength);
     pNode = _Lookup(pLast, name);
     name_extractor.GetNext(pName, nLength);
   }
@@ skipping 525 matching lines @@
   allFieldNames.RemoveAll();
   int nCount = m_pFieldTree->m_Root.CountFields();
   for (int i = 0; i < nCount; i++) {
     CPDF_FormField* pField = m_pFieldTree->m_Root.GetField(i);
     if (pField) {
       CFX_WideString full_name = GetFullName(pField->GetFieldDict());
       allFieldNames.Add(full_name);
     }
   }
 }
-FX_BOOL CPDF_InterForm::IsValidFormField(const void* pField) {
-  if (pField == NULL) {
-    return FALSE;
-  }
-  int nCount = m_pFieldTree->m_Root.CountFields();
-  for (int i = 0; i < nCount; i++) {
-    CPDF_FormField* pFormField = m_pFieldTree->m_Root.GetField(i);
-    if (pField == pFormField) {
-      return TRUE;
-    }
-  }
-  return FALSE;
-}
+
 CPDF_FormField* CPDF_InterForm::GetFieldByDict(
     CPDF_Dictionary* pFieldDict) const {
   if (pFieldDict == NULL) {
     return NULL;
   }
   CFX_WideString csWName = GetFullName(pFieldDict);
   return m_pFieldTree->GetField(csWName);
 }
 
 CPDF_FormControl* CPDF_InterForm::GetControlAtPoint(CPDF_Page* pPage,
@@ skipping 148 matching lines @@
 }
 CPDF_Font* CPDF_InterForm::GetDefaultFormFont() {
   return GetDefaultInterFormFont(m_pFormDict, m_pDocument);
 }
 int CPDF_InterForm::GetFormAlignment() {
   if (m_pFormDict == NULL) {
     return 0;
   }
   return m_pFormDict->GetInteger("Q", 0);
 }
-FX_BOOL CPDF_InterForm::ResetForm(const CFX_PtrArray& fields,
-                                  FX_BOOL bIncludeOrExclude,
-                                  FX_BOOL bNotify) {
-  if (bNotify && m_pFormNotify != NULL) {
+
+bool CPDF_InterForm::ResetForm(const std::vector<CPDF_FormField*>& fields,
+                               bool bIncludeOrExclude,
+                               bool bNotify) {
+  if (bNotify && m_pFormNotify) {
+    int iRet = m_pFormNotify->BeforeFormReset(this);

[Tom Sepez, 2015/11/09 21:25:31]

nit: local not needed.  This returns an int, right?

[Lei Zhang, 2015/11/09 22:45:28]

Done.

+    if (iRet < 0) {
+      return false;
+    }
+  }
+  int nCount = m_pFieldTree->m_Root.CountFields();
+  for (int i = 0; i < nCount; ++i) {
+    CPDF_FormField* pField = m_pFieldTree->m_Root.GetField(i);
+    if (!pField)
+      continue;
+
+    auto it = std::find(fields.begin(), fields.end(), pField);
+    if (bIncludeOrExclude == (it != fields.end()))
+      pField->ResetField(bNotify);
+  }
+  if (bNotify && m_pFormNotify)
+    m_pFormNotify->AfterFormReset(this);
+  return true;
+}
+
+bool CPDF_InterForm::ResetForm(bool bNotify) {
+  if (bNotify && m_pFormNotify) {
     int iRet = m_pFormNotify->BeforeFormReset(this);

[Tom Sepez, 2015/11/09 21:25:31]

ditto

[Lei Zhang, 2015/11/09 22:45:28]

Done. return false, even.

     if (iRet < 0) {
       return FALSE;
     }
   }
   int nCount = m_pFieldTree->m_Root.CountFields();
-  for (int i = 0; i < nCount; i++) {
+  for (int i = 0; i < nCount; ++i) {
     CPDF_FormField* pField = m_pFieldTree->m_Root.GetField(i);
-    if (pField == NULL) {
+    if (!pField)
       continue;
-    }
-    FX_BOOL bFind = FALSE;
-    int iCount = fields.GetSize();
-    for (int i = 0; i < iCount; i++) {
-      if (pField == (CPDF_FormField*)fields[i]) {
-        bFind = TRUE;
-        break;
-      }
-    }
-    if ((bIncludeOrExclude && bFind) || (!bIncludeOrExclude && !bFind)) {
-      pField->ResetField(bNotify);
-    }
-  }
-  if (bNotify && m_pFormNotify != NULL) {
-    m_pFormNotify->AfterFormReset(this);
-  }
-  return TRUE;
-}
-FX_BOOL CPDF_InterForm::ResetForm(FX_BOOL bNotify) {
-  if (bNotify && m_pFormNotify != NULL) {
-    int iRet = m_pFormNotify->BeforeFormReset(this);
-    if (iRet < 0) {
-      return FALSE;
-    }
-  }
-  int nCount = m_pFieldTree->m_Root.CountFields();
-  for (int i = 0; i < nCount; i++) {
-    CPDF_FormField* pField = m_pFieldTree->m_Root.GetField(i);
-    if (pField == NULL) {
-      continue;
-    }
+
     pField->ResetField(bNotify);
   }
-  if (bNotify && m_pFormNotify != NULL) {
+  if (bNotify && m_pFormNotify)
     m_pFormNotify->AfterFormReset(this);
-  }
-  return TRUE;
+  return true;
 }
+
 void CPDF_InterForm::LoadField(CPDF_Dictionary* pFieldDict, int nLevel) {
   if (nLevel > nMaxRecursion) {
     return;
   }
   if (pFieldDict == NULL) {
     return;
   }
   FX_DWORD dwParentObjNum = pFieldDict->GetObjNum();
   CPDF_Array* pKids = pFieldDict->GetArray("Kids");
   if (!pKids) {
@@ skipping 108 matching lines @@
   const auto it = m_ControlMap.find(pWidgetDict);
   if (it != m_ControlMap.end())
     return it->second;
 
   CPDF_FormControl* pControl =
       new CPDF_FormControl((CPDF_FormField*)pField, pWidgetDict);
   m_ControlMap[pWidgetDict] = pControl;
   ((CPDF_FormField*)pField)->m_ControlList.Add(pControl);
   return pControl;
 }
+
 CPDF_FormField* CPDF_InterForm::CheckRequiredFields(
-    const CFX_PtrArray* fields,
+    const std::vector<CPDF_FormField*>* fields,
     FX_BOOL bIncludeOrExclude) const {
   int nCount = m_pFieldTree->m_Root.CountFields();
-  for (int i = 0; i < nCount; i++) {
+  for (int i = 0; i < nCount; ++i) {
     CPDF_FormField* pField = m_pFieldTree->m_Root.GetField(i);
-    if (pField == NULL) {
+    if (!pField)
       continue;
-    }
+
     int32_t iType = pField->GetType();
     if (iType == CPDF_FormField::PushButton ||
         iType == CPDF_FormField::CheckBox || iType == CPDF_FormField::ListBox) {
       continue;
     }
     FX_DWORD dwFlags = pField->GetFieldFlags();
-    if (dwFlags & 0x04) {
+    if (dwFlags & 0x04)

[Tom Sepez, 2015/11/09 21:25:31]

nit: magic number.

[Lei Zhang, 2015/11/09 22:45:28]

Added a TODO.

       continue;
+
+    bool bFind = true;
+    if (fields) {
+      auto it = std::find(fields->begin(), fields->end(), pField);
+      bFind = (it != fields->end());
     }
-    FX_BOOL bFind = TRUE;
-    if (fields != NULL) {
-      bFind = fields->Find(pField, 0) >= 0;
-    }
-    if ((bIncludeOrExclude && bFind) || (!bIncludeOrExclude && !bFind)) {
+    if (bIncludeOrExclude == bFind) {
       CPDF_Dictionary* pFieldDict = pField->m_pDict;
       if ((dwFlags & 0x02) != 0 && pFieldDict->GetString("V").IsEmpty()) {
         return pField;
       }
     }
   }
-  return NULL;
+  return nullptr;
 }
+
 CFDF_Document* CPDF_InterForm::ExportToFDF(const CFX_WideStringC& pdf_path,
-                                           FX_BOOL bSimpleFileSpec) const {
-  CFX_PtrArray fields;
+                                           bool bSimpleFileSpec) const {
+  std::vector<CPDF_FormField*> fields;
   int nCount = m_pFieldTree->m_Root.CountFields();
-  for (int i = 0; i < nCount; i++) {
+  for (int i = 0; i < nCount; ++i) {
     CPDF_FormField* pField = m_pFieldTree->m_Root.GetField(i);

[Tom Sepez, 2015/11/09 21:25:31]

nit: local not needed.

[Lei Zhang, 2015/11/09 22:45:28]

Done.

-    fields.Add(pField);
+    fields.push_back(pField);
   }
-  return ExportToFDF(pdf_path, fields, TRUE, bSimpleFileSpec);
+  return ExportToFDF(pdf_path, fields, true, bSimpleFileSpec);
 }
+
+// TODO(thestig): Fix this.

[Tom Sepez, 2015/11/09 21:25:31]

nit: by fix this, you mean "move to header"?

[Lei Zhang, 2015/11/09 22:45:28]

Yes, another day.

 CFX_WideString FILESPEC_EncodeFileName(const CFX_WideStringC& filepath);
-CFDF_Document* CPDF_InterForm::ExportToFDF(const CFX_WideStringC& pdf_path,
-                                           CFX_PtrArray& fields,
-                                           FX_BOOL bIncludeOrExclude,
-                                           FX_BOOL bSimpleFileSpec) const {
+
+CFDF_Document* CPDF_InterForm::ExportToFDF(
+    const CFX_WideStringC& pdf_path,
+    const std::vector<CPDF_FormField*>& fields,
+    bool bIncludeOrExclude,
+    bool bSimpleFileSpec) const {
   CFDF_Document* pDoc = CFDF_Document::CreateNewDoc();
   if (pDoc == NULL) {
     return NULL;
   }
   CPDF_Dictionary* pMainDict = pDoc->GetRoot()->GetDict("FDF");
   if (!pdf_path.IsEmpty()) {
     if (bSimpleFileSpec) {
       CFX_WideString wsFilePath = FILESPEC_EncodeFileName(pdf_path);
       pMainDict->SetAtString(FX_BSTRC("F"),
                              CFX_ByteString::FromUnicode(wsFilePath));
@@ skipping 12 matching lines @@
   int nCount = m_pFieldTree->m_Root.CountFields();
   for (int i = 0; i < nCount; i++) {
     CPDF_FormField* pField = m_pFieldTree->m_Root.GetField(i);
     if (pField == NULL || pField->GetType() == CPDF_FormField::PushButton) {
       continue;
     }
     FX_DWORD dwFlags = pField->GetFieldFlags();
     if (dwFlags & 0x04) {
       continue;
     }
-    FX_BOOL bFind = fields.Find(pField, 0) >= 0;
-    if ((bIncludeOrExclude && bFind) || (!bIncludeOrExclude && !bFind)) {
+    auto it = std::find(fields.begin(), fields.end(), pField);
+    if (bIncludeOrExclude == (it != fields.end())) {
       if ((dwFlags & 0x02) != 0 && pField->m_pDict->GetString("V").IsEmpty()) {

[Tom Sepez, 2015/11/09 21:25:31]

nit: magic number.

[Lei Zhang, 2015/11/09 22:45:28]

Acknowledged.

         continue;
       }
       CFX_WideString fullname = GetFullName(pField->GetFieldDict());
       CPDF_Dictionary* pFieldDict = CPDF_Dictionary::Create();
       if (pFieldDict == NULL) {
         return NULL;
       }
       CPDF_String* pString = CPDF_String::Create(fullname);
       if (pString == NULL) {
         pFieldDict->Release();
@@ skipping 150 matching lines @@
     FDF_ImportField(pField, L"", bNotify);
   }
   if (bNotify && m_pFormNotify != NULL) {
     m_pFormNotify->AfterFormImportData(this);
   }
   return TRUE;
 }
 void CPDF_InterForm::SetFormNotify(const CPDF_FormNotify* pNotify) {
   m_pFormNotify = (CPDF_FormNotify*)pNotify;
 }