Separate storing of user data from initialization of popup items

src/tracks/labeltrack/ui/LabelTrackControls.cpp

@@ -43,7 +43,7 @@ class LabelTrackMenuTable : public PopupMenuTable
 public:
    static LabelTrackMenuTable &Instance();
 
-   void InitMenu(Menu*, void *pUserData) override
+   void InitUserData(void *pUserData) override
    {
       mpData = static_cast<CommonTrackControls::InitMenuData*>(pUserData);
    }

src/tracks/playabletrack/notetrack/ui/NoteTrackControls.cpp

@@ -83,7 +83,7 @@ public:
    static NoteTrackMenuTable &Instance();
 
 private:
-   void InitMenu(Menu*, void *pUserData) override
+   void InitUserData(void *pUserData) override
    {
       mpData = static_cast<NoteTrackControlsBase::InitMenuData*>(pUserData);
    }

src/tracks/playabletrack/notetrack/ui/NoteTrackVZoomHandle.cpp

@@ -209,7 +209,7 @@ private:
       mpData = nullptr;
    }
 
-   virtual void InitMenu(Menu *pMenu, void *pUserData) override;
+   void InitUserData(void *pUserData) override;
 };
 
 NoteTrackVRulerMenuTable &NoteTrackVRulerMenuTable::Instance()
@@ -218,7 +218,7 @@ NoteTrackVRulerMenuTable &NoteTrackVRulerMenuTable::Instance()
    return instance;
 }
 
-void NoteTrackVRulerMenuTable::InitMenu(Menu *WXUNUSED(pMenu), void *pUserData)
+void NoteTrackVRulerMenuTable::InitUserData(void *pUserData)
 {
    mpData = static_cast<InitMenuData*>(pUserData);
 }

src/tracks/playabletrack/wavetrack/ui/SpectrumVZoomHandle.cpp

@@ -265,9 +265,9 @@ PopupMenuTable &SpectrumVRulerMenuTable::Instance()
    return instance;
 }
 
-void SpectrumVRulerMenuTable::InitMenu(Menu *pMenu, void *pUserData)
+void SpectrumVRulerMenuTable::InitMenu(Menu *pMenu)
 {
-   WaveTrackVRulerMenuTable::InitMenu(pMenu, pUserData);
+   WaveTrackVRulerMenuTable::InitMenu(pMenu);
 
    WaveTrack *const wt = mpData->pTrack;
    const int id =

src/tracks/playabletrack/wavetrack/ui/SpectrumVZoomHandle.h

@@ -83,7 +83,7 @@ public:
    static PopupMenuTable &Instance();
 
 private:
-   void InitMenu(Menu *pMenu, void *pUserData) override;
+   void InitMenu(Menu *pMenu) override;
 
    void OnSpectrumScaleType(wxCommandEvent &evt);
 };

src/tracks/playabletrack/wavetrack/ui/WaveTrackControls.cpp

@@ -155,7 +155,8 @@ public:
    static WaveColorMenuTable &Instance();
 
 private:
-   void InitMenu(Menu *pMenu, void *pUserData) override;
+   void InitUserData(void *pUserData) override;
+   void InitMenu(Menu *pMenu) override;
 
    void DestroyMenu() override
    {
@@ -174,9 +175,13 @@ WaveColorMenuTable &WaveColorMenuTable::Instance()
    return instance;
 }
 
-void WaveColorMenuTable::InitMenu(Menu *pMenu, void *pUserData)
+void WaveColorMenuTable::InitUserData(void *pUserData)
 {
    mpData = static_cast<PlayableTrackControls::InitMenuData*>(pUserData);
+}
+
+void WaveColorMenuTable::InitMenu(Menu *pMenu)
+{
    WaveTrack *const pTrack = static_cast<WaveTrack*>(mpData->pTrack);
    auto WaveColorId = IdOfWaveColor( pTrack->GetWaveColorIndex());
    SetMenuChecks(*pMenu, [=](int id){ return id == WaveColorId; });
@@ -247,7 +252,8 @@ public:
    static FormatMenuTable &Instance();
 
 private:
-   void InitMenu(Menu *pMenu, void *pUserData) override;
+   void InitUserData(void *pUserData) override;
+   void InitMenu(Menu *pMenu) override;
 
    void DestroyMenu() override
    {
@@ -267,9 +273,13 @@ FormatMenuTable &FormatMenuTable::Instance()
    return instance;
 }
 
-void FormatMenuTable::InitMenu(Menu *pMenu, void *pUserData)
+void FormatMenuTable::InitUserData(void *pUserData)
 {
    mpData = static_cast<PlayableTrackControls::InitMenuData*>(pUserData);
+}
+
+void FormatMenuTable::InitMenu(Menu *pMenu)
+{
    WaveTrack *const pTrack = static_cast<WaveTrack*>(mpData->pTrack);
    auto formatId = IdOfFormat(pTrack->GetSampleFormat());
    SetMenuChecks(*pMenu, [=](int id){ return id == formatId; });
@@ -363,7 +373,8 @@ public:
    static RateMenuTable &Instance();
 
 private:
-   void InitMenu(Menu *pMenu, void *pUserData) override;
+   void InitUserData(void *pUserData) override;
+   void InitMenu(Menu *pMenu) override;
 
    void DestroyMenu() override
    {
@@ -385,9 +396,13 @@ RateMenuTable &RateMenuTable::Instance()
    return instance;
 }
 
-void RateMenuTable::InitMenu(Menu *pMenu, void *pUserData)
+void RateMenuTable::InitUserData(void *pUserData)
 {
    mpData = static_cast<PlayableTrackControls::InitMenuData*>(pUserData);
+}
+
+void RateMenuTable::InitMenu(Menu *pMenu)
+{
    WaveTrack *const pTrack = static_cast<WaveTrack*>(mpData->pTrack);
    const auto rateId = IdOfRate((int)pTrack->GetRate());
    SetMenuChecks(*pMenu, [=](int id){ return id == rateId; });
@@ -557,7 +572,8 @@ public:
 protected:
    WaveTrackMenuTable() : mpData(NULL) {mpTrack=NULL;}
 
-   void InitMenu(Menu *pMenu, void *pUserData) override;
+   void InitUserData(void *pUserData) override;
+   void InitMenu(Menu *pMenu) override;
 
    void DestroyMenu() override
    {
@@ -597,9 +613,13 @@ WaveTrackMenuTable &WaveTrackMenuTable::Instance( Track * pTrack )
    return instance;
 }
 
-void WaveTrackMenuTable::InitMenu(Menu *pMenu, void *pUserData)
+void WaveTrackMenuTable::InitUserData(void *pUserData)
 {
    mpData = static_cast<PlayableTrackControls::InitMenuData*>(pUserData);
+}
+
+void WaveTrackMenuTable::InitMenu(Menu *pMenu)
+{
    WaveTrack *const pTrack = static_cast<WaveTrack*>(mpData->pTrack);
 
    std::vector<int> checkedIds;
@@ -637,7 +657,6 @@ void WaveTrackMenuTable::InitMenu(Menu *pMenu, void *pUserData)
 
    if ( isMono )
    {
-      mpData = static_cast<PlayableTrackControls::InitMenuData*>(pUserData);
       WaveTrack *const pTrack2 = static_cast<WaveTrack*>(mpData->pTrack);
 
       auto next = * ++ tracks.Find(pTrack2);

src/tracks/playabletrack/wavetrack/ui/WaveTrackVZoomHandle.cpp

@@ -34,7 +34,7 @@ bool WaveTrackVZoomHandle::IsDragZooming(int zoomStart, int zoomEnd)
 ///////////////////////////////////////////////////////////////////////////////
 // Table class
 
-void WaveTrackVRulerMenuTable::InitMenu(Menu *, void *pUserData)
+void WaveTrackVRulerMenuTable::InitUserData(void *pUserData)
 {
    mpData = static_cast<InitMenuData*>(pUserData);
 }

src/tracks/playabletrack/wavetrack/ui/WaveTrackVZoomHandle.h

@@ -69,7 +69,7 @@ public:
 protected:
    WaveTrackVRulerMenuTable() {}
 
-   void InitMenu(Menu *pMenu, void *pUserData) override;
+   void InitUserData(void *pUserData) override;
 
 private:
    void DestroyMenu() override

src/tracks/playabletrack/wavetrack/ui/WaveformVZoomHandle.cpp

@@ -266,9 +266,9 @@ PopupMenuTable &WaveformVRulerMenuTable::Instance()
    return instance;
 }
 
-void WaveformVRulerMenuTable::InitMenu(Menu *pMenu, void *pUserData)
+void WaveformVRulerMenuTable::InitMenu(Menu *pMenu)
 {
-   WaveTrackVRulerMenuTable::InitMenu(pMenu, pUserData);
+   WaveTrackVRulerMenuTable::InitMenu(pMenu);
 
 // DB setting is already on track drop down.
    WaveTrack *const wt = mpData->pTrack;

src/tracks/playabletrack/wavetrack/ui/WaveformVZoomHandle.h

@@ -83,7 +83,7 @@ public:
    static PopupMenuTable &Instance();
 
 private:
-   virtual void InitMenu(Menu *pMenu, void *pUserData) override;
+   virtual void InitMenu(Menu *pMenu) override;
 
    void OnWaveformScaleType(wxCommandEvent &evt);
 };

src/tracks/timetrack/ui/TimeTrackControls.cpp

@@ -47,9 +47,13 @@ public:
    static TimeTrackMenuTable &Instance();
 
 private:
-   void InitMenu(Menu *pMenu, void *pUserData) override
+   void InitUserData(void *pUserData) override
    {
       mpData = static_cast<CommonTrackControls::InitMenuData*>(pUserData);
+   }
+
+   void InitMenu(Menu *pMenu) override
+   {
       TimeTrack *const pTrack = static_cast<TimeTrack*>(mpData->pTrack);
 
       pMenu->Check(OnTimeTrackLogIntID, pTrack->GetInterpolateLog());

src/tracks/ui/CommonTrackControls.cpp

@@ -90,7 +90,8 @@ private:
    void OnSetName(wxCommandEvent &);
    void OnMoveTrack(wxCommandEvent &event);
 
-   void InitMenu(Menu *pMenu, void *pUserData) override;
+   void InitUserData(void *pUserData) override;
+   void InitMenu(Menu *pMenu) override;
 
    void DestroyMenu() override
    {
@@ -106,9 +107,13 @@ TrackMenuTable &TrackMenuTable::Instance()
    return instance;
 }
 
-void TrackMenuTable::InitMenu(Menu *pMenu, void *pUserData)
+void TrackMenuTable::InitUserData(void *pUserData)
 {
    mpData = static_cast<CommonTrackControls::InitMenuData*>(pUserData);
+}
+
+void TrackMenuTable::InitMenu(Menu *pMenu)
+{
    Track *const pTrack = mpData->pTrack;
 
    const auto &tracks = TrackList::Get( *GetActiveProject() );

src/tracks/ui/CommonTrackControls.h

@@ -28,7 +28,7 @@ class CommonTrackControls /* not final */ : public TrackControls
 public:
    using TrackControls::TrackControls;
 
-   // This is passed to the InitMenu() methods of the PopupMenuTable
+   // This is passed to the InitUserData() methods of the PopupMenuTable
    // objects returned by GetMenuExtension:
    struct InitMenuData
    {

src/widgets/PopupMenuTable.cpp

@@ -20,6 +20,8 @@ PopupMenuTable::Menu::~Menu()
 
 void PopupMenuTable::Menu::Extend(PopupMenuTable *pTable)
 {
+   pTable->InitUserData(pUserData);
+
    auto connect = [&]( const PopupMenuTable::Entry *pEntry ) {
       this->pParent->Bind
          (wxEVT_COMMAND_MENU_SELECTED,
@@ -61,7 +63,7 @@ void PopupMenuTable::Menu::Extend(PopupMenuTable *pTable)
       }
    }
 
-   pTable->InitMenu(this, pUserData);
+   pTable->InitMenu(this);
 }
 
 void PopupMenuTable::Menu::DisconnectTable(PopupMenuTable *pTable)
@@ -85,6 +87,10 @@ void PopupMenuTable::Menu::Disconnect()
       DisconnectTable(pTable);
 }
 
+void PopupMenuTable::InitMenu(Menu *)
+{
+}
+
 // static
 std::unique_ptr<PopupMenuTable::Menu> PopupMenuTable::BuildMenu
 ( wxEvtHandler *pParent, PopupMenuTable *pTable, void *pUserData )

src/widgets/PopupMenuTable.h

@@ -79,14 +79,19 @@ public:
       void *pUserData;
    };
 
+   // Called before the menu items are appended.
+   // Store user data, if needed.
+   virtual void InitUserData(void *pUserData) = 0;
+
    // Called when the menu is about to pop up.
    // Your chance to enable and disable items.
-   virtual void InitMenu(Menu *pMenu, void *pUserData) = 0;
+   // Default implementation does nothing.
+   virtual void InitMenu(Menu *pMenu);
 
    // Called when menu is destroyed.
    virtual void DestroyMenu() = 0;
 
-   // Optional pUserData gets passed to the InitMenu routines of tables.
+   // Optional pUserData gets passed to the InitUserData routines of tables.
    // No memory management responsibility is assumed by this function.
    static std::unique_ptr<Menu> BuildMenu
       (wxEvtHandler *pParent, PopupMenuTable *pTable, void *pUserData = NULL);
@@ -101,14 +106,19 @@ In class MyTable (maybe in the private section),
 which inherits from PopupMenuTable,
 
 DECLARE_POPUP_MENU(MyTable);
-virtual void InitMenu(Menu *pMenu, void *pUserData);
+virtual void InitUserData(void *pUserData);
+virtual void InitMenu(Menu *pMenu);
 virtual void DestroyMenu();
 
 Then in MyTable.cpp,
 
-void MyTable::InitMenu(Menu *pMenu, void *pUserData)
+void MyTable::InitUserData(void *pUserData)
 {
    auto pData = static_cast<MyData*>(pUserData);
+}
+
+void MyTable::InitMenu(Menu *pMenu)
+{
    // Remember pData, enable or disable menu items
 }