Make code compile with clang_use_chrome_plugin (part VI)

xfa/fwl/core/cfwl_event.h

 // Copyright 2016 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_CFWL_EVENT_H_
 #define XFA_FWL_CORE_CFWL_EVENT_H_
 
 #include "core/fxcrt/include/fx_coordinates.h"
@@ skipping 48 matching lines @@
   FWL_EVENT_IDLE_MASK = 1 << 7,
   FWL_EVENT_CONTROL_MASK = 1 << 8,
   FWL_EVENT_ALL_MASK = 0xFF
 };
 
 class CFX_Graphics;
 class IFWL_Widget;
 
 class CFWL_Event {
  public:
-  CFWL_Event()
-      : m_pSrcTarget(nullptr), m_pDstTarget(nullptr), m_dwRefCount(1) {}
-  virtual ~CFWL_Event() {}
+  CFWL_Event();
+  virtual ~CFWL_Event();
 
-  virtual FWL_Error GetClassName(CFX_WideString& wsClass) const {
-    return FWL_Error::Succeeded;
-  }
-  virtual CFWL_EventType GetClassID() const { return CFWL_EventType::None; }
+  virtual FWL_Error GetClassName(CFX_WideString& wsClass) const;
+  virtual CFWL_EventType GetClassID() const;
 
-  uint32_t Release() {
-    m_dwRefCount--;
-    uint32_t dwRefCount = m_dwRefCount;
-    if (!m_dwRefCount)
-      delete this;
-    return dwRefCount;
-  }
+  uint32_t Release();
 
   IFWL_Widget* m_pSrcTarget;
   IFWL_Widget* m_pDstTarget;
 
  private:
   uint32_t m_dwRefCount;
 };
 
-#define BEGIN_FWL_EVENT_DEF(classname, eventType)                   \
+inline CFWL_Event::CFWL_Event()
+    : m_pSrcTarget(nullptr), m_pDstTarget(nullptr), m_dwRefCount(1) {}
+
+inline CFWL_Event::~CFWL_Event() {}
+
+inline FWL_Error CFWL_Event::GetClassName(CFX_WideString& wsClass) const {
+  return FWL_Error::Succeeded;
+}
+
+inline CFWL_EventType CFWL_Event::GetClassID() const {
+  return CFWL_EventType::None;
+}
+
+inline uint32_t CFWL_Event::Release() {
+  m_dwRefCount--;
+  uint32_t dwRefCount = m_dwRefCount;
+  if (!m_dwRefCount)
+    delete this;
+  return dwRefCount;
+}
+
+#define FWL_EVENT_DEF(classname, eventType, ...)                    \
   class classname : public CFWL_Event {                             \
    public:                                                          \
-    classname() : CFWL_Event() {}                                   \
-    virtual FWL_Error GetClassName(CFX_WideString& wsClass) const { \
-      wsClass = L## #classname;                                     \
-      return FWL_Error::Succeeded;                                  \
-    }                                                               \
-    virtual CFWL_EventType GetClassID() const { return eventType; }
+    classname();                                                    \
+    ~classname() override;                                          \
+    FWL_Error GetClassName(CFX_WideString& wsClass) const override; \
+    CFWL_EventType GetClassID() const override;                     \
+    __VA_ARGS__                                                     \

[dsinclair, 2016/06/16 17:35:19]

That's frighteningly awesome.

[Wei Li, 2016/06/16 18:16:33]

thanks :)

+  };  // NOLINT

[dsinclair, 2016/06/16 17:35:20]

Does this need a nolint? It was there before because the ; was on its own line.

[Wei Li, 2016/06/16 18:16:33]

Done.

 
-#define END_FWL_EVENT_DEF \
-  }                       \
-  ;  // NOLINT
+#define FWL_EVENT_FUNCTION_DEF(classname, eventType)                        \

[dsinclair, 2016/06/16 17:35:19]

Do we ever doe the above without doing this macro? If not, can we just combine
them and have one call?

[Wei Li, 2016/06/16 18:16:33]

This is the price we have to pay for using clang_use_chrome_plugin. The plugins
complain when
we inline those virtual functions in the class.
However, the plugins makes an exception for explicitly inlined functions.

I have not found a better way to work around this.

[dsinclair, 2016/06/16 18:21:13]

Right, but could the macro be:

#define FWL_EVENT_DEF(classname, eventType, ...)\
  class classname : public CFWL_Event { \
   public: \
    classname(); \
    ... \
  }; \ 
  inline classname::classname() {} \
  inline classname::~classname() {} \
  ...

This won't work for the message macros because you use VA_ARGS in both macros,
but should work with this one, no?

[Wei Li, 2016/06/17 18:11:18]

oh, since customized function implementation is not needed for this macro, I can
directly merge them.

+  inline classname::classname() {}                                          \
+  inline classname::~classname() {}                                         \
+  inline FWL_Error classname::GetClassName(CFX_WideString& wsClass) const { \
+    wsClass = L## #classname;                                               \
+    return FWL_Error::Succeeded;                                            \
+  }                                                                         \
+  inline CFWL_EventType classname::GetClassID() const { return eventType; }
 
-BEGIN_FWL_EVENT_DEF(CFWL_EvtMouse, CFWL_EventType::Mouse)
-FX_FLOAT m_fx;
-FX_FLOAT m_fy;
-uint32_t m_dwFlags;
-FWL_MouseCommand m_dwCmd;
-END_FWL_EVENT_DEF
+FWL_EVENT_DEF(CFWL_EvtMouse, CFWL_EventType::Mouse, FX_FLOAT m_fx;
+              FX_FLOAT m_fy;
+              uint32_t m_dwFlags;
+              FWL_MouseCommand m_dwCmd;)
+FWL_EVENT_FUNCTION_DEF(CFWL_EvtMouse, CFWL_EventType::Mouse)
 
-BEGIN_FWL_EVENT_DEF(CFWL_EvtMouseWheel, CFWL_EventType::MouseWheel)
-FX_FLOAT m_fx;
-FX_FLOAT m_fy;
-FX_FLOAT m_fDeltaX;
-FX_FLOAT m_fDeltaY;
-uint32_t m_dwFlags;
-END_FWL_EVENT_DEF
+FWL_EVENT_DEF(CFWL_EvtMouseWheel, CFWL_EventType::MouseWheel, FX_FLOAT m_fx;
+              FX_FLOAT m_fy;
+              FX_FLOAT m_fDeltaX;
+              FX_FLOAT m_fDeltaY;
+              uint32_t m_dwFlags;)
+FWL_EVENT_FUNCTION_DEF(CFWL_EvtMouseWheel, CFWL_EventType::MouseWheel)
 
-BEGIN_FWL_EVENT_DEF(CFWL_EvtKey, CFWL_EventType::Key)
-uint32_t m_dwKeyCode;
-uint32_t m_dwFlags;
-FWL_KeyCommand m_dwCmd;
-END_FWL_EVENT_DEF
+FWL_EVENT_DEF(CFWL_EvtKey, CFWL_EventType::Key, uint32_t m_dwKeyCode;
+              uint32_t m_dwFlags;
+              FWL_KeyCommand m_dwCmd;)
+FWL_EVENT_FUNCTION_DEF(CFWL_EvtKey, CFWL_EventType::Key)
 
-BEGIN_FWL_EVENT_DEF(CFWL_EvtSetFocus, CFWL_EventType::SetFocus)
-IFWL_Widget* m_pSetFocus;
-END_FWL_EVENT_DEF
+FWL_EVENT_DEF(CFWL_EvtSetFocus,
+              CFWL_EventType::SetFocus,
+              IFWL_Widget* m_pSetFocus;)
+FWL_EVENT_FUNCTION_DEF(CFWL_EvtSetFocus, CFWL_EventType::SetFocus)
 
-BEGIN_FWL_EVENT_DEF(CFWL_EvtKillFocus, CFWL_EventType::KillFocus)
-IFWL_Widget* m_pKillFocus;
-END_FWL_EVENT_DEF
+FWL_EVENT_DEF(CFWL_EvtKillFocus,
+              CFWL_EventType::KillFocus,
+              IFWL_Widget* m_pKillFocus;)
+FWL_EVENT_FUNCTION_DEF(CFWL_EvtKillFocus, CFWL_EventType::KillFocus)
 
-BEGIN_FWL_EVENT_DEF(CFWL_EvtDraw, CFWL_EventType::Draw)
-CFX_Graphics* m_pGraphics;
-IFWL_Widget* m_pWidget;
-END_FWL_EVENT_DEF
+FWL_EVENT_DEF(CFWL_EvtDraw, CFWL_EventType::Draw, CFX_Graphics* m_pGraphics;
+              IFWL_Widget * m_pWidget;)
+FWL_EVENT_FUNCTION_DEF(CFWL_EvtDraw, CFWL_EventType::Draw)
 
-BEGIN_FWL_EVENT_DEF(CFWL_EvtClick, CFWL_EventType::Click)
-END_FWL_EVENT_DEF
+FWL_EVENT_DEF(CFWL_EvtClick, CFWL_EventType::Click)
+FWL_EVENT_FUNCTION_DEF(CFWL_EvtClick, CFWL_EventType::Click)
 
-BEGIN_FWL_EVENT_DEF(CFWL_EvtScroll, CFWL_EventType::Scroll)
-uint32_t m_iScrollCode;
-FX_FLOAT m_fPos;
-FX_BOOL* m_pRet;
-END_FWL_EVENT_DEF
+FWL_EVENT_DEF(CFWL_EvtScroll, CFWL_EventType::Scroll, uint32_t m_iScrollCode;
+              FX_FLOAT m_fPos;
+              FX_BOOL * m_pRet;)
+FWL_EVENT_FUNCTION_DEF(CFWL_EvtScroll, CFWL_EventType::Scroll)
 
-BEGIN_FWL_EVENT_DEF(CFWL_EvtClose, CFWL_EventType::Close)
-END_FWL_EVENT_DEF
+FWL_EVENT_DEF(CFWL_EvtClose, CFWL_EventType::Close)
+FWL_EVENT_FUNCTION_DEF(CFWL_EvtClose, CFWL_EventType::Close)
 
-BEGIN_FWL_EVENT_DEF(CFWL_EvtContextMenu, CFWL_EventType::ContextMenu)
-FX_FLOAT m_fPosX;
-FX_FLOAT m_fPosY;
-IFWL_Widget* m_pOwner;
-END_FWL_EVENT_DEF
+FWL_EVENT_DEF(CFWL_EvtContextMenu,
+              CFWL_EventType::ContextMenu,
+              FX_FLOAT m_fPosX;
+              FX_FLOAT m_fPosY;
+              IFWL_Widget * m_pOwner;)
+FWL_EVENT_FUNCTION_DEF(CFWL_EvtContextMenu, CFWL_EventType::ContextMenu)
 
-BEGIN_FWL_EVENT_DEF(CFWL_EvtMenuCommand, CFWL_EventType::MenuCommand)
-int32_t m_iCommand;
-void* m_pData;
-END_FWL_EVENT_DEF
+FWL_EVENT_DEF(CFWL_EvtMenuCommand,
+              CFWL_EventType::MenuCommand,
+              int32_t m_iCommand;
+              void* m_pData;)
+FWL_EVENT_FUNCTION_DEF(CFWL_EvtMenuCommand, CFWL_EventType::MenuCommand)
 
-BEGIN_FWL_EVENT_DEF(CFWL_EvtSizeChanged, CFWL_EventType::SizeChanged)
-IFWL_Widget* m_pWidget;
-CFX_RectF m_rtOld;
-CFX_RectF m_rtNew;
-END_FWL_EVENT_DEF
+FWL_EVENT_DEF(CFWL_EvtSizeChanged,
+              CFWL_EventType::SizeChanged,
+              IFWL_Widget* m_pWidget;
+              CFX_RectF m_rtOld;
+              CFX_RectF m_rtNew;)
+FWL_EVENT_FUNCTION_DEF(CFWL_EvtSizeChanged, CFWL_EventType::SizeChanged)
 
-BEGIN_FWL_EVENT_DEF(CFWL_EvtIdle, CFWL_EventType::Idle)
-END_FWL_EVENT_DEF
+FWL_EVENT_DEF(CFWL_EvtIdle, CFWL_EventType::Idle)
+FWL_EVENT_FUNCTION_DEF(CFWL_EvtIdle, CFWL_EventType::Idle)
 
 #endif  // XFA_FWL_CORE_CFWL_EVENT_H_