Cleanup: Make CPDF_Annot::m_pAnnotDict private.

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 "../fpdfapi/fpdf_parser.h"
 #include "../fpdfapi/fpdf_render.h"
 
+class CFieldTree;
+class CPDF_AAction;
 class CPDF_Action;
+class CPDF_ActionFields;
 class CPDF_Annot;
 class CPDF_AnnotList;
+class CPDF_ApSettings;
 class CPDF_Bookmark;
 class CPDF_BookmarkTree;
+class CPDF_DefaultAppearance;
 class CPDF_Dest;
+class CPDF_DocJSActions;
+class CPDF_FileSpec;
+class CPDF_FormControl;
+class CPDF_FormField;
+class CPDF_FormNotify;
+class CPDF_IconFit;
+class CPDF_InterForm;
 class CPDF_Link;
 class CPDF_LinkList;
+class CPDF_LWinParam;
 class CPDF_Metadata;
-class CPDF_NameTree;
 class CPDF_NumberTree;
+class CPDF_OCContext;
+class CPDF_Page;
+class CPDF_RenderOptions;
 class CPDF_TextObject;
 class CPDF_ViewerPreferences;
-class CPDF_Page;
-class CPDF_RenderOptions;
 class CXML_Element;
-class CPDF_OCContext;
-class CPDF_DocJSActions;
-class CPDF_ActionFields;
-class CPDF_AAction;
-class CPDF_FileSpec;
-class CPDF_IconFit;
-class CPDF_DefaultAppearance;
-class CPDF_InterForm;
-class CPDF_FormField;
-class CPDF_FormNotify;
-class CPDF_FormControl;
-class CPDF_LWinParam;
-class CFieldTree;
-class CPDF_ApSettings;
-class CPDF_NameTree 
+
+class CPDF_NameTree
 {
 public:
 
     CPDF_NameTree(CPDF_Dictionary* pRoot)
     {
         m_pRoot = pRoot;
     }
 
     CPDF_NameTree(CPDF_Document* pDoc, FX_BSTR category);
 
@@ skipping 10 matching lines @@
 
     CPDF_Dictionary*    GetRoot() const
     {
         return m_pRoot;
     }
 
 protected:
 
     CPDF_Dictionary*            m_pRoot;
 };
-class CPDF_BookmarkTree 
+class CPDF_BookmarkTree
 {
 public:
     CPDF_BookmarkTree(CPDF_Document* pDoc) : m_pDocument(pDoc) {}
 
     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;
 };
 #define PDFBOOKMARK_ITALIC                      1
 #define PDFBOOKMARK_BOLD                        2
-class CPDF_Bookmark 
+class CPDF_Bookmark
 {
 public:
 
     CPDF_Bookmark() : m_pDict(NULL) {}
 
     explicit CPDF_Bookmark(CPDF_Dictionary* pDict) : m_pDict(pDict) {}
 
     CPDF_Dictionary* GetDict() const { return m_pDict; }
 
     operator bool() const { return m_pDict != NULL; }
@@ skipping 11 matching lines @@
     CPDF_Dictionary*    m_pDict;
 };
 #define PDFZOOM_XYZ                                     1
 #define PDFZOOM_FITPAGE                         2
 #define PDFZOOM_FITHORZ                         3
 #define PDFZOOM_FITVERT                         4
 #define PDFZOOM_FITRECT                         5
 #define PDFZOOM_FITBBOX                         6
 #define PDFZOOM_FITBHORZ                        7
 #define PDFZOOM_FITBVERT                        8
-class CPDF_Dest 
+class CPDF_Dest
 {
 public:
     CPDF_Dest() : m_pObj(nullptr) { }
     explicit CPDF_Dest(CPDF_Object* pObj) : m_pObj(pObj) { }
 
     operator bool () const { return m_pObj != NULL; }
     CPDF_Object* GetObject() const { return m_pObj; }
 
     CFX_ByteString              GetRemoteName();
     int                                 GetPageIndex(CPDF_Document* pDoc);
@@ skipping 43 matching lines @@
     FX_BOOL                     GetOCGVE(CPDF_Array *pExpression, FX_BOOL bFromConfig, int nLevel = 0);
 
     FX_BOOL                     LoadOCMDState(const CPDF_Dictionary *pOCMDDict, FX_BOOL bFromConfig);
 
     CPDF_Document               *m_pDocument;
 
     UsageType                   m_eUsageType;
 
     CFX_MapPtrTemplate<const CPDF_Dictionary*, void*>   m_OCGStates;
 };
-class CPDF_LWinParam 
+class CPDF_LWinParam
 {
 public:
 
     CPDF_LWinParam(CPDF_Dictionary* pDict)
     {
         m_pDict = pDict;
     }
 
     operator CPDF_Dictionary* () const
     {
@@ skipping 18 matching lines @@
     }
 
 
     inline CFX_ByteString       GetParameter()
     {
         return m_pDict->GetString("P");
     }
 
     CPDF_Dictionary*            m_pDict;
 };
-class CPDF_ActionFields 
+class CPDF_ActionFields
 {
 public:
 
     CPDF_ActionFields(const CPDF_Action* pAction)
     {
         m_pAction = (CPDF_Action*)pAction;
     }
 
     operator CPDF_Action*() const
     {
         return m_pAction;
     }
 
     FX_DWORD                            GetFieldsCount() const;
 
     void                                        GetAllFields(CFX_PtrArray& fieldObjects) 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
 #define PDFJS_MAXLENGTH                 64
-class CPDF_Action 
+class CPDF_Action
 {
 public:
     enum ActionType {
         Unknown = 0,
         GoTo,
         GoToR,
         GoToE,
         Launch,
         Thread,
         URI,
@@ skipping 18 matching lines @@
 
     CPDF_Dictionary* GetDict() const { return m_pDict; }
 
     CFX_ByteString              GetTypeName() const
     {
         return m_pDict->GetString("S");
     }
 
     ActionType                  GetType() const;
 
-
-
     CPDF_Dest                   GetDest(CPDF_Document* pDoc) const;
 
-
-
-
-
     CFX_WideString              GetFilePath() const;
 
-
-
-
     FX_BOOL                             GetNewWindow() const
     {
         return m_pDict->GetBoolean("NewWindow");
     }
 
-
-
-
     CPDF_LWinParam              GetWinParam() const;
 
-
-
-
     CFX_ByteString              GetURI(CPDF_Document* pDoc) const;
 
-
-
-
     FX_BOOL                             GetMouseMap() const
     {
         return m_pDict->GetBoolean("IsMap");
     }
 
-
-
-
     CPDF_ActionFields   GetWidgets() const
     {
         return this;
     }
 
-
-
-
     FX_BOOL                             GetHideStatus() const
     {
         return m_pDict->GetBoolean("H", TRUE);
     }
 
-
-
-
     CFX_ByteString              GetNamedAction() const
     {
         return m_pDict->GetString("N");
     }
 
-
-
-
     FX_DWORD                    GetFlags() const
     {
         return m_pDict->GetInteger("Flags");
     }
 
-
-
-
     CFX_WideString              GetJavaScript() const;
 
-
-
-
     CPDF_Dictionary*    GetAnnot() const;
 
-
-
-
     FX_INT32                    GetOperationType() const;
 
-
-
-
     CPDF_Stream*                GetSoundStream() const
     {
         return m_pDict->GetStream("Sound");
     }
 
     FX_FLOAT                    GetVolume() const
     {
         return m_pDict->GetNumber("Volume");
     }
 
     FX_BOOL                             IsSynchronous() const
     {
         return m_pDict->GetBoolean("Synchronous");
     }
 
     FX_BOOL                             IsRepeat() const
     {
         return m_pDict->GetBoolean("Repeat");
     }
 
     FX_BOOL                             IsMixPlay() const
     {
         return m_pDict->GetBoolean("Mix");
     }
 
-
-
-
     FX_DWORD                    GetSubActionsCount() const;
 
     CPDF_Action                 GetSubAction(FX_DWORD iIndex) const;
 
 protected:
     CPDF_Dictionary*    m_pDict;
 };
-class CPDF_AAction 
+class CPDF_AAction
 {
 public:
 
     CPDF_AAction(CPDF_Dictionary* pDict = NULL)
     {
         m_pDict = pDict;
     }
 
     operator CPDF_Dictionary*() const
     {
@@ skipping 27 matching lines @@
     FX_BOOL                             ActionExist(AActionType eType) const;
 
     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 
+class CPDF_DocJSActions
 {
 public:
     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;
 };
-class CPDF_FileSpec 
+class CPDF_FileSpec
 {
 public:
 
     CPDF_FileSpec();
 
     CPDF_FileSpec(CPDF_Object *pObj)
     {
         m_pObj = pObj;
     }
 
     operator CPDF_Object*() const
     {
         return m_pObj;
     }
 
     FX_BOOL                     IsURL() const;
 
     FX_BOOL                     GetFileName(CFX_WideString &wsFileName) const;
 
     CPDF_Stream*        GetFileStream() const;
 
     void                        SetFileName(FX_WSTR wsFileName, FX_BOOL bURL = FALSE);
 protected:
 
     CPDF_Object         *m_pObj;
 };
-class CPDF_LinkList 
+class CPDF_LinkList
 {
 public:
 
     CPDF_LinkList(CPDF_Document* pDoc)
     {
         m_pDocument = pDoc;
     }
 
     ~CPDF_LinkList();
 
@@ skipping 10 matching lines @@
 protected:
 
     CPDF_Document*              m_pDocument;
 
     CFX_MapPtrToPtr             m_PageMap;
 
     CFX_PtrArray*               GetPageLinks(CPDF_Page* pPage);
 
     void                                LoadPageLinks(CPDF_Page* pPage, CFX_PtrArray* pList);
 };
-class CPDF_Link 
+class CPDF_Link
 {
 public:
     CPDF_Link() : m_pDict(nullptr) { }
     explicit CPDF_Link(CPDF_Dictionary* pDict) : m_pDict(pDict) { }
 
     CPDF_Dictionary* GetDict() const { return m_pDict; }
 
     CFX_FloatRect               GetRect();
     CPDF_Dest                   GetDest(CPDF_Document* pDoc);
     CPDF_Action                 GetAction();
 
 protected:
     CPDF_Dictionary*    m_pDict;
 };
-#define ANNOTFLAG_INVISIBLE                     1
-#define ANNOTFLAG_HIDDEN                        2
-#define ANNOTFLAG_PRINT                         4
-#define ANNOTFLAG_NOZOOM                        8
-#define ANNOTFLAG_NOROTATE                      0x10
-#define ANNOTFLAG_NOVIEW                        0x20
-#define ANNOTFLAG_READONLY                      0x40
-#define ANNOTFLAG_LOCKED                        0x80
-#define ANNOTFLAG_TOGGLENOVIEW          0x100
+
+#define ANNOTFLAG_INVISIBLE     1

[Tom Sepez, 2015/06/05 21:26:18]

nit: as long as you're going to make these line up, I'd be tempted to pad them
with 0x0 to four digits so that they all line up.

[Lei Zhang, 2015/06/05 22:25:47]

Done.

+#define ANNOTFLAG_HIDDEN        2
+#define ANNOTFLAG_PRINT         4
+#define ANNOTFLAG_NOZOOM        8
+#define ANNOTFLAG_NOROTATE      0x10
+#define ANNOTFLAG_NOVIEW        0x20
+#define ANNOTFLAG_READONLY      0x40
+#define ANNOTFLAG_LOCKED        0x80
+#define ANNOTFLAG_TOGGLENOVIEW  0x100

[Tom Sepez, 2015/06/05 21:15:29]

nit: blank line following, so long as you're at it.

[Lei Zhang, 2015/06/05 22:25:47]

Done.

 class CPDF_Annot : public CFX_PrivateData
 {
-public:
-
-    CPDF_Annot(CPDF_Dictionary* pDict);
-
-    ~CPDF_Annot();
-
-    CPDF_Dictionary*    m_pAnnotDict;
-
-    CFX_ByteString              GetSubType() const;
-
-    FX_DWORD                    GetFlags() const
-    {
-        return m_pAnnotDict->GetInteger("F");
-    }
-
-    void                                GetRect(CFX_FloatRect& rect) const;
-
-    enum AppearanceMode {
+  public:
+    enum AppearanceMode {
         Normal,
         Rollover,
         Down
     };
 
-    FX_BOOL                             DrawAppearance(const CPDF_Page* pPage, CFX_RenderDevice* pDevice, const CFX_AffineMatrix* pUser2Device,
-                                       AppearanceMode mode, const CPDF_RenderOptions* pOptions);
+    CPDF_Annot(CPDF_Dictionary* pDict, CPDF_AnnotList* pList);
+    ~CPDF_Annot();
 
-    FX_BOOL                             DrawInContext(const CPDF_Page* pPage, const CPDF_RenderContext* pContext,
-                                      const CFX_AffineMatrix* pUser2Device, AppearanceMode mode);
+    CFX_ByteString GetSubType() const;
 
-    void                                ClearCachedAP();
+    FX_DWORD GetFlags() const;
 
+    void GetRect(CFX_FloatRect& rect) const;
 
-    void                                DrawBorder(CFX_RenderDevice* pDevice, const CFX_AffineMatrix* pUser2Device,
-                                   const CPDF_RenderOptions* pOptions);
+    CPDF_Dictionary* GetAnnotDict();
 
-    CPDF_PageObject*    GetBorder(FX_BOOL bPrint, const CPDF_RenderOptions* pOptions);
+    FX_BOOL DrawAppearance(const CPDF_Page* pPage,
+                           CFX_RenderDevice* pDevice,
+                           const CFX_AffineMatrix* pUser2Device,
+                           AppearanceMode mode,
+                           const CPDF_RenderOptions* pOptions);
 
+    FX_BOOL DrawInContext(const CPDF_Page* pPage,
+                          const CPDF_RenderContext* pContext,
+                          const CFX_AffineMatrix* pUser2Device,
+                          AppearanceMode mode);
 
+    void ClearCachedAP();
 
-    int                                 CountIRTNotes();
+    void DrawBorder(CFX_RenderDevice* pDevice,
+                    const CFX_AffineMatrix* pUser2Device,
+                    const CPDF_RenderOptions* pOptions);
 
-    CPDF_Annot*                 GetIRTNote(int index);
+    CPDF_Form* GetAPForm(const CPDF_Page* pPage, AppearanceMode mode);
 
+  private:
+    CPDF_Dictionary* const m_pAnnotDict;
 
-    CPDF_Form*                  GetAPForm(const CPDF_Page* pPage, AppearanceMode mode);
-private:
+    CPDF_AnnotList* const m_pList;
 
-    CFX_MapPtrToPtr             m_APMap;
-protected:
-    friend class                CPDF_AnnotList;
+    CFX_MapPtrToPtr m_APMap;
+};
 
-    CPDF_AnnotList*             m_pList;
-
-    CPDF_Reference*             NewAnnotRef();
-};
-class CPDF_AnnotList 
+class CPDF_AnnotList
 {
 public:
 
     CPDF_AnnotList(CPDF_Page* pPage);
 
     ~CPDF_AnnotList();
 
     void        GetAnnotMatrix(const CPDF_Dictionary* pAnnotDict, const CFX_Matrix* pUser2Device, CFX_Matrix &matrix) const;
 
     void        GetAnnotRect(const CPDF_Dictionary* pAnnotDict, const CFX_Matrix* pUser2Device, CPDF_Rect &rtAnnot) const;
@@ skipping 51 matching lines @@
 
     void                                DisplayPass(const CPDF_Page* pPage, CFX_RenderDevice* pDevice,
                                     CPDF_RenderContext* pContext, FX_BOOL bPrinting, CFX_AffineMatrix* pMatrix,
                                     FX_BOOL bWidget, CPDF_RenderOptions* pOptions, FX_RECT* clip_rect);
     friend class                CPDF_Annot;
 };
 #define COLORTYPE_TRANSPARENT   0
 #define COLORTYPE_GRAY                  1
 #define COLORTYPE_RGB                   2
 #define COLORTYPE_CMYK                  3
-class CPDF_DefaultAppearance 
+class CPDF_DefaultAppearance
 {
 public:
 
     CPDF_DefaultAppearance(const CFX_ByteString& csDA = "")
     {
         m_csDA = csDA;
     }
 
     CPDF_DefaultAppearance(const CPDF_DefaultAppearance& cDA)
     {
@@ skipping 309 matching lines @@
 #define FORMFIELD_REQUIRED              0x02
 #define FORMFIELD_NOEXPORT              0x04
 #define FORMRADIO_NOTOGGLEOFF   0x100
 #define FORMRADIO_UNISON                0x200
 #define FORMTEXT_MULTILINE              0x100
 #define FORMTEXT_PASSWORD               0x200
 #define FORMTEXT_NOSCROLL               0x400
 #define FORMTEXT_COMB                   0x800
 #define FORMCOMBO_EDIT                  0x100
 #define FORMLIST_MULTISELECT    0x100
-class CPDF_FormField 
+class CPDF_FormField
 {
 public:
 
     enum Type {
         Unknown,
         PushButton,
         RadioButton,
         CheckBox,
         Text,
         RichText,
@@ skipping 201 matching lines @@
     CFX_WideString                      GetCheckValue(FX_BOOL bDefault);
 
     FX_BOOL                                     SetCheckValue(const CFX_WideString& value, FX_BOOL bDefault, FX_BOOL bNotify);
 
 
     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 
+class CPDF_IconFit
 {
 public:
 
     CPDF_IconFit(CPDF_Dictionary* pDict = NULL)
     {
         m_pDict = pDict;
     }
 
     operator CPDF_Dictionary*() const
     {
@@ skipping 31 matching lines @@
     CPDF_Dictionary*            m_pDict;
 };
 
 #define TEXTPOS_CAPTION         0
 #define TEXTPOS_ICON            1
 #define TEXTPOS_BELOW           2
 #define TEXTPOS_ABOVE           3
 #define TEXTPOS_RIGHT           4
 #define TEXTPOS_LEFT            5
 #define TEXTPOS_OVERLAID        6
-class CPDF_FormControl 
+class CPDF_FormControl
 {
 public:
 
     CPDF_FormField::Type        GetType()
     {
         return m_pField->GetType();
     }
 
     CPDF_InterForm*                     GetInterForm() const
     {
@@ skipping 187 matching lines @@
     CPDF_ApSettings                     GetMK(FX_BOOL bCreate);
 
     CPDF_InterForm*                     m_pForm;
 
     CPDF_FormField*                     m_pField;
 
     CPDF_Dictionary*            m_pWidgetDict;
     friend class                        CPDF_InterForm;
     friend class                        CPDF_FormField;
 };
-class CPDF_FormNotify 
+class CPDF_FormNotify
 {
 public:
 
     virtual ~CPDF_FormNotify() {}
 
     virtual int         BeforeValueChange(const CPDF_FormField* pField, CFX_WideString& csValue)
     {
         return 0;
     }
 
@@ skipping 31 matching lines @@
     {
         return 0;
     }
 
     virtual int         AfterFormImportData(const CPDF_InterForm* pForm)
     {
         return 0;
     }
 };
 FX_BOOL         FPDF_GenerateAP(CPDF_Document* pDoc, CPDF_Dictionary* pAnnotDict);
-class CPDF_PageLabel 
+class CPDF_PageLabel
 {
 public:
 
     CPDF_PageLabel(CPDF_Document* pDocument)
     {
         m_pDocument = pDocument;
     }
 
 
     CFX_WideString                                      GetLabel(int nPage) const;
@@ skipping 43 matching lines @@
 
     FX_INT32 NumCopies() const;
 
     CPDF_Array* PrintPageRange() const;
 
     CFX_ByteString Duplex() const;
 
 protected:
     CPDF_Document*      m_pDoc;
 };
-class CPDF_ApSettings 
+class CPDF_ApSettings
 {
 public:
 
     CPDF_ApSettings(CPDF_Dictionary* pDict = NULL)
     {
         m_pDict = pDict;
     }
 
     operator CPDF_Dictionary* () const
     {
@@ skipping 109 matching lines @@
 
     void                                        GetOriginalColor(int& iColorType, FX_FLOAT fc[4], FX_BSTR csEntry);
 
     CFX_WideString                      GetCaption(FX_BSTR csEntry);
 
     CPDF_Stream*                        GetIcon(FX_BSTR csEntry);
     friend class                        CPDF_FormControl;
 };
 
 #endif  // CORE_INCLUDE_FPDFDOC_FPDF_DOC_H_