Remove CFX_PtrArray usage in fpdfsdk.

core/include/fpdfdoc/fpdf_doc.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_FPDFDOC_FPDF_DOC_H_
 #define CORE_INCLUDE_FPDFDOC_FPDF_DOC_H_
 
 #include <map>
@@ skipping 26 matching lines @@
 class CPDF_NumberTree;
 class CPDF_OCContext;
 class CPDF_Page;
 class CPDF_RenderOptions;
 class CPDF_TextObject;
 class CPDF_ViewerPreferences;
 class CXML_Element;
 
 class CPDF_NameTree {
  public:
-  CPDF_NameTree(CPDF_Dictionary* pRoot) { m_pRoot = pRoot; }
+  explicit CPDF_NameTree(CPDF_Dictionary* pRoot) { m_pRoot = pRoot; }

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

nit: prefer initialization list, can m_pRoot be const member?

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

Noted, but this CL is plenty big as is. I'll make another pass later.

 
   CPDF_NameTree(CPDF_Document* pDoc, const CFX_ByteStringC& category);
 
   CPDF_Object* LookupValue(int nIndex, CFX_ByteString& csName) const;
 
   CPDF_Object* LookupValue(const CFX_ByteString& csName) const;
 
   CPDF_Array* LookupNamedDest(CPDF_Document* pDoc,
                               const CFX_ByteStringC& sName);
 
   int GetIndex(const CFX_ByteString& csName) const;
 
   int GetCount() const;
 
   CPDF_Dictionary* GetRoot() const { return m_pRoot; }
 
  protected:
   CPDF_Dictionary* m_pRoot;
 };
 class CPDF_BookmarkTree {
  public:
-  CPDF_BookmarkTree(CPDF_Document* pDoc) : m_pDocument(pDoc) {}
+  explicit CPDF_BookmarkTree(CPDF_Document* pDoc) : m_pDocument(pDoc) {}

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

nitto for m_pDocument.

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

Acknowledged.

 
   CPDF_Bookmark GetFirstChild(const CPDF_Bookmark& parent) const;
 
   CPDF_Bookmark GetNextSibling(const CPDF_Bookmark& bookmark) const;
 
   CPDF_Document* GetDocument() const { return m_pDocument; }
 
  protected:
   CPDF_Document* m_pDocument;
 };
@@ skipping 43 matching lines @@
   int GetZoomMode();
   FX_FLOAT GetParam(int index);
 
  protected:
   CPDF_Object* m_pObj;
 };
 class CPDF_OCContext : public IPDF_OCContext {
  public:
   enum UsageType { View = 0, Design, Print, Export };
 
-  CPDF_OCContext(CPDF_Document* pDoc, UsageType eUsageType = View);
+  explicit CPDF_OCContext(CPDF_Document* pDoc, UsageType eUsageType = View);
   ~CPDF_OCContext() override;
 
   CPDF_Document* GetDocument() const { return m_pDocument; }
 
   UsageType GetUsageType() const { return m_eUsageType; }
 
   FX_BOOL CheckOCGVisible(const CPDF_Dictionary* pOCGDict) override;
 
   void ResetOCContext();
 
@@ skipping 14 matching lines @@
 
   CPDF_Document* m_pDocument;
 
   UsageType m_eUsageType;
 
   std::map<const CPDF_Dictionary*, FX_BOOL> m_OCGStates;
 };
 
 class CPDF_ActionFields {
  public:
+  // TODO(thestig): Examine why this cannot be explicit.
   CPDF_ActionFields(const CPDF_Action* pAction) {

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

nit: init list, const m_pAction member?

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

Acknowledged.

     m_pAction = (CPDF_Action*)pAction;
   }
 
   operator CPDF_Action*() const { return m_pAction; }

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

nit: also todo, replace with an explicit GetAction() method.

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

Done.

 
   FX_DWORD GetFieldsCount() const;
 
-  void GetAllFields(CFX_PtrArray& fieldObjects) const;
+  std::vector<CPDF_Object*> GetAllFields() const;
 
   CPDF_Object* GetField(FX_DWORD iIndex) const;
 
   CPDF_Action* m_pAction;
 };
 
 #define PDFNAMED_NEXTPAGE 1
 #define PDFNAMED_PREVPAGE 2
 #define PDFNAMED_FIRSTPAGE 3
 #define PDFNAMED_LASTPAGE 4
@@ skipping 69 matching lines @@
 
   FX_DWORD GetSubActionsCount() const;
 
   CPDF_Action GetSubAction(FX_DWORD iIndex) const;
 
  protected:
   CPDF_Dictionary* m_pDict;
 };
 class CPDF_AAction {
  public:
+  // TODO(thestig): Examine why this cannot be explicit.
   CPDF_AAction(CPDF_Dictionary* pDict = NULL) { m_pDict = pDict; }

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

nit: prefer two methods and no default param, also init list and const member if
possible (yeah yeah yeah).

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

Acknowledged.

 
   operator CPDF_Dictionary*() const { return m_pDict; }
 
   enum AActionType {
     CursorEnter = 0,
     CursorExit,
     ButtonDown,
     ButtonUp,
     GetFocus,
     LoseFocus,
@@ skipping 19 matching lines @@
   CPDF_Action GetAction(AActionType eType) const;
 
   FX_POSITION GetStartPos() const;
 
   CPDF_Action GetNextAction(FX_POSITION& pos, AActionType& eType) const;
 
   CPDF_Dictionary* m_pDict;
 };
 class CPDF_DocJSActions {
  public:
-  CPDF_DocJSActions(CPDF_Document* pDoc);
+  explicit CPDF_DocJSActions(CPDF_Document* pDoc);
 
   int CountJSActions() const;
 
   CPDF_Action GetJSAction(int index, CFX_ByteString& csName) const;
 
   CPDF_Action GetJSAction(const CFX_ByteString& csName) const;
 
   int FindJSAction(const CFX_ByteString& csName) const;
 
   CPDF_Document* GetDocument() const { return m_pDocument; }
 
  protected:
   CPDF_Document* m_pDocument;

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

nit: maybe const?

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

Done.

 };
 class CPDF_FileSpec {
  public:
   CPDF_FileSpec();
 
-  CPDF_FileSpec(CPDF_Object* pObj) { m_pObj = pObj; }
+  explicit CPDF_FileSpec(CPDF_Object* pObj) { m_pObj = pObj; }

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

nitto.

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

Acknowledged.

 
   operator CPDF_Object*() const { return m_pObj; }
 
   FX_BOOL IsURL() const;
 
   FX_BOOL GetFileName(CFX_WideString& wsFileName) const;
 
   CPDF_Stream* GetFileStream() const;
 
   void SetFileName(const CFX_WideStringC& wsFileName, FX_BOOL bURL = FALSE);
@@ skipping 130 matching lines @@
   CPDF_Document* const m_pDocument;
   std::vector<CPDF_Annot*> m_AnnotList;
 };
 
 #define COLORTYPE_TRANSPARENT 0
 #define COLORTYPE_GRAY 1
 #define COLORTYPE_RGB 2
 #define COLORTYPE_CMYK 3
 class CPDF_DefaultAppearance {
  public:
+  // TODO(thestig): Examine why this cannot be explicit.
   CPDF_DefaultAppearance(const CFX_ByteString& csDA = "") { m_csDA = csDA; }

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

nit: two methods, no default args.

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

Acknowledged.

 
   CPDF_DefaultAppearance(const CPDF_DefaultAppearance& cDA) {
     m_csDA = (CFX_ByteString)(CPDF_DefaultAppearance&)cDA;
   }
 
   operator CFX_ByteString() const { return m_csDA; }
 
   const CPDF_DefaultAppearance& operator=(const CFX_ByteString& csDA) {
     m_csDA = csDA;
     return *this;
@@ skipping 85 matching lines @@
   FX_BOOL ValidateFieldName(const CPDF_FormControl* pControl,
                             CFX_WideString& csNewFieldName);
 
   FX_DWORD CountFields(const CFX_WideString& csFieldName = L"");
 
   CPDF_FormField* GetField(FX_DWORD index,
                            const CFX_WideString& csFieldName = L"");
 
   void GetAllFieldNames(CFX_WideStringArray& allFieldNames);
 
-  FX_BOOL IsValidFormField(const void* pField);

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

Is dead?

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

It cannot ever return true AFAICT. Please double check.

-
   CPDF_FormField* GetFieldByDict(CPDF_Dictionary* pFieldDict) const;
 
   CPDF_FormControl* GetControlAtPoint(CPDF_Page* pPage,
                                       FX_FLOAT pdf_x,
                                       FX_FLOAT pdf_y,
                                       int* z_order) const;
 
   CPDF_FormControl* GetControlByDict(const CPDF_Dictionary* pWidgetDict) const;
 
   CPDF_Document* GetDocument() const { return m_pDocument; }
@@ skipping 43 matching lines @@
   void RemoveFormFont(const CPDF_Font* pFont);
 
   void RemoveFormFont(CFX_ByteString csNameTag);
 
   CPDF_DefaultAppearance GetDefaultAppearance();
 
   CPDF_Font* GetDefaultFormFont();
 
   int GetFormAlignment();
 
-  CPDF_FormField* CheckRequiredFields(const CFX_PtrArray* fields = NULL,
-                                      FX_BOOL bIncludeOrExclude = TRUE) const;
+  CPDF_FormField* CheckRequiredFields(
+      const std::vector<CPDF_FormField*>* fields,

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

nit: const reference.

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

Some callers pass in a nullptr.

+      FX_BOOL bIncludeOrExclude) const;

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

nit: bool.

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

Done.

 
   CFDF_Document* ExportToFDF(const CFX_WideStringC& pdf_path,
-                             FX_BOOL bSimpleFileSpec = FALSE) const;
+                             bool bSimpleFileSpec = false) const;
 
   CFDF_Document* ExportToFDF(const CFX_WideStringC& pdf_path,
-                             CFX_PtrArray& fields,
-                             FX_BOOL bIncludeOrExclude = TRUE,
-                             FX_BOOL bSimpleFileSpec = FALSE) const;
+                             const std::vector<CPDF_FormField*>& fields,
+                             bool bIncludeOrExclude = true,
+                             bool bSimpleFileSpec = false) const;
 
   FX_BOOL ImportFromFDF(const CFDF_Document* pFDFDoc, FX_BOOL bNotify = FALSE);
 
-  FX_BOOL ResetForm(const CFX_PtrArray& fields,
-                    FX_BOOL bIncludeOrExclude = TRUE,
-                    FX_BOOL bNotify = FALSE);
+  bool ResetForm(const std::vector<CPDF_FormField*>& fields,
+                 bool bIncludeOrExclude = true,
+                 bool bNotify = false);
 
-  FX_BOOL ResetForm(FX_BOOL bNotify = FALSE);
+  bool ResetForm(bool bNotify = false);
 
   CPDF_FormNotify* GetFormNotify() const { return m_pFormNotify; }
 
   void SetFormNotify(const CPDF_FormNotify* pNotify);
 
   FX_BOOL IsUpdated() { return m_bUpdated; }
 
   void ClearUpdatedFlag() { m_bUpdated = FALSE; }
 
   FX_BOOL HasXFAForm() const;
@@ skipping 203 matching lines @@
 
   FX_FLOAT m_FontSize;
 
   CPDF_Font* m_pFont;
 };
 CPDF_Object* FPDF_GetFieldAttr(CPDF_Dictionary* pFieldDict,
                                const FX_CHAR* name,
                                int nLevel = 0);
 class CPDF_IconFit {
  public:
+  // TODO(thestig): Examine why this cannot be explicit.
   CPDF_IconFit(CPDF_Dictionary* pDict = NULL) { m_pDict = pDict; }

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

nitto: two methods, const member, no default args, etc.

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

Acknowledged.

 
   operator CPDF_Dictionary*() const { return m_pDict; }
 
   enum ScaleMethod { Always = 0, Bigger, Smaller, Never };
 
   ScaleMethod GetScaleMethod();
 
   FX_BOOL IsProportionalScale();
 
   void GetIconPosition(FX_FLOAT& fLeft, FX_FLOAT& fBottom);
@@ skipping 152 matching lines @@
 
   virtual int AfterFormReset(const CPDF_InterForm* pForm) { return 0; }
 
   virtual int BeforeFormImportData(const CPDF_InterForm* pForm) { return 0; }
 
   virtual int AfterFormImportData(const CPDF_InterForm* pForm) { return 0; }
 };
 FX_BOOL FPDF_GenerateAP(CPDF_Document* pDoc, CPDF_Dictionary* pAnnotDict);
 class CPDF_PageLabel {
  public:
-  CPDF_PageLabel(CPDF_Document* pDocument) { m_pDocument = pDocument; }
+  explicit CPDF_PageLabel(CPDF_Document* pDocument) { m_pDocument = pDocument; }

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

nitto

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

Acknowledged.

 
   CFX_WideString GetLabel(int nPage) const;
 
   int32_t GetPageByLabel(const CFX_ByteStringC& bsLabel) const;
 
   int32_t GetPageByLabel(const CFX_WideStringC& wsLabel) const;
 
  protected:
   CPDF_Document* m_pDocument;
 };
 
 class CPDF_Metadata {
  public:
   explicit CPDF_Metadata(CPDF_Document* pDoc);
   ~CPDF_Metadata();
 
   const CXML_Element* GetRoot() const;
 
  private:
   nonstd::unique_ptr<CXML_Element> m_pXmlElement;
 };
 
 class CPDF_ViewerPreferences {
  public:
-  CPDF_ViewerPreferences(CPDF_Document* pDoc);
+  explicit CPDF_ViewerPreferences(CPDF_Document* pDoc);
 
   ~CPDF_ViewerPreferences();
 
   FX_BOOL IsDirectionR2L() const;
 
   FX_BOOL PrintScaling() const;
 
   int32_t NumCopies() const;
 
   CPDF_Array* PrintPageRange() const;
 
   CFX_ByteString Duplex() const;
 
  protected:
   CPDF_Document* m_pDoc;

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

nit: const member?

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

Done.

 };
 class CPDF_ApSettings {
  public:
+  // TODO(thestig): Examine why this cannot be explicit.
   CPDF_ApSettings(CPDF_Dictionary* pDict = NULL) { m_pDict = pDict; }

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

nitto

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

Acknowledged.

 
   operator CPDF_Dictionary*() const { return m_pDict; }
 
   FX_BOOL HasMKEntry(const CFX_ByteStringC& csEntry);
 
   int GetRotation();
 
   inline FX_ARGB GetBorderColor(int& iColorType) {
     return GetColor(iColorType, FX_BSTRC("BC"));
   }
@@ skipping 49 matching lines @@
                         FX_FLOAT fc[4],
                         const CFX_ByteStringC& csEntry);
 
   CFX_WideString GetCaption(const CFX_ByteStringC& csEntry);
 
   CPDF_Stream* GetIcon(const CFX_ByteStringC& csEntry);
   friend class CPDF_FormControl;
 };
 
 #endif  // CORE_INCLUDE_FPDFDOC_FPDF_DOC_H_