Add back-pointer to "Associated widget" to CFWL_WidgetImp.

xfa/fwl/core/ifwl_widget.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 XFA_FWL_CORE_IFWL_WIDGET_H_
 #define XFA_FWL_CORE_IFWL_WIDGET_H_
 
 #include <memory>
 
 #include "core/fxcrt/include/fx_basic.h"
 #include "core/fxcrt/include/fx_coordinates.h"
 #include "core/fxcrt/include/fx_system.h"
 #include "xfa/fwl/core/fwl_error.h"
 #include "xfa/fwl/core/fwl_widgetimp.h"
 
 // FWL contains three parallel inheritance hierarchies, which reference each
 // other via pointers as follows:
 //
-//                   m_pIface                m_pImpl
+//                              m_pAssociate

[Tom Sepez, 2016/05/26 18:13:52]

Let me know if you can think of a better term that doesn't also connotate a
widget in the same hierarchy or a parent widget in a tree.

[Lei Zhang, 2016/05/26 23:06:07]

Nope.

+//                  <----------------------------------
 //      CFWL_Widget ----------> IFWL_Widget ----------> CFWL_WidgetImp
-//           |                       |                       |
+//           |       m_pIface        |       m_pImpl         |
 //           A                       A                       A
 //           |                       |                       |
 //      CFWL_...                IFWL_...                CFWL_...Imp
 //
+// TODO(tsepez): Collapse these into a single hierarchy.
+//
 
 enum class FWL_Type {
   Unknown = 0,
 
   Barcode,
   Caret,
   CheckBox,
   ComboBox,
   DateTimePicker,
   Edit,
@@ skipping 34 matching lines @@
   FWL_Error ModifyStyles(uint32_t dwStylesAdded, uint32_t dwStylesRemoved);
   uint32_t GetStylesEx();
   FWL_Error ModifyStylesEx(uint32_t dwStylesExAdded,
                            uint32_t dwStylesExRemoved);
   uint32_t GetStates();
   void SetStates(uint32_t dwStates, FX_BOOL bSet = TRUE);
   uint32_t GetEventKey() const;
   void SetEventKey(uint32_t key);
   void* GetLayoutItem() const;
   void SetLayoutItem(void* pItem);
-  FWL_Error SetPrivateData(void* module_id,
-                           void* pData,
-                           PD_CALLBACK_FREEDATA callback);
-  void* GetPrivateData(void* module_id);
+  void* GetAssociateWidget() const;
+  void SetAssociateWidget(void* pAssociate);
   FWL_Error Update();
   FWL_Error LockUpdate();
   FWL_Error UnlockUpdate();
   FWL_WidgetHit HitTest(FX_FLOAT fx, FX_FLOAT fy);
   FWL_Error TransformTo(IFWL_Widget* pWidget, FX_FLOAT& fx, FX_FLOAT& fy);
   FWL_Error TransformTo(IFWL_Widget* pWidget, CFX_RectF& rt);
   FWL_Error GetMatrix(CFX_Matrix& matrix, FX_BOOL bGlobal = FALSE);
   FWL_Error SetMatrix(const CFX_Matrix& matrix);
   FWL_Error DrawWidget(CFX_Graphics* pGraphics,
                        const CFX_Matrix* pMatrix = NULL);
@@ skipping 16 matching lines @@
 
  protected:
   // Takes ownership of |pImpl|.
   void SetImpl(CFWL_WidgetImp* pImpl) { m_pImpl.reset(pImpl); }
 
  private:
   std::unique_ptr<CFWL_WidgetImp> m_pImpl;
 };
 
 #endif  // XFA_FWL_CORE_IFWL_WIDGET_H_