Move the EnsureValidDockState function to the CMergeFrameCommon class.

Author: sdottaka

Src/ImgMergeFrm.cpp

@@ -585,38 +585,6 @@ int CImgMergeFrame::OnCreate(LPCREATESTRUCT lpCreateStruct)
 	return 0;
 }
 
-/**
-* @brief We must use this function before a call to SetDockState
-*
-* @note Without this, SetDockState will assert or crash if a bar from the
-* CDockState is missing in the current CMergeEditFrame.
-* The bars are identified with their ID. This means the missing bar bug is triggered
-* when we run WinMerge after changing the ID of a bar.
-*/
-bool CImgMergeFrame::EnsureValidDockState(CDockState& state)
-{
-	for (int i = (int)state.m_arrBarInfo.GetSize() - 1; i >= 0; i--)
-	{
-		bool barIsCorrect = true;
-		CControlBarInfo* pInfo = (CControlBarInfo*)state.m_arrBarInfo[i];
-		if (pInfo == nullptr)
-			barIsCorrect = false;
-		else
-		{
-			if (!pInfo->m_bFloating)
-			{
-				pInfo->m_pBar = GetControlBar(pInfo->m_nBarID);
-				if (pInfo->m_pBar == nullptr)
-					barIsCorrect = false; //toolbar id's probably changed	
-			}
-		}
-
-		if (!barIsCorrect)
-			state.m_arrBarInfo.RemoveAt(i);
-	}
-	return true;
-}
-
 /**
  * @brief Save the window's position, free related resources, and destroy the window
  */

Src/ImgMergeFrm.h

@@ -97,7 +97,6 @@ class CImgMergeFrame : public CMergeFrameCommon,public IMergeDoc
 
 // Implementation
 private:
-	bool EnsureValidDockState(CDockState& state);
 	void LoadOptions();
 	void SaveOptions();
 	void SavePosition();

Src/MergeEditFrm.cpp

@@ -231,38 +231,6 @@ BOOL CMergeEditFrame::OnBarCheck(UINT nID)
 	return result;
 }
 
-/**
- * @brief We must use this function before a call to SetDockState
- *
- * @note Without this, SetDockState will assert or crash if a bar from the 
- * CDockState is missing in the current CMergeEditFrame.
- * The bars are identified with their ID. This means the missing bar bug is triggered
- * when we run WinMerge after changing the ID of a bar. 
- */
-bool CMergeEditFrame::EnsureValidDockState(CDockState& state) 
-{
-	for (int i = (int) state.m_arrBarInfo.GetSize()-1 ; i >= 0; i--) 
-	{
-		bool barIsCorrect = true;
-		CControlBarInfo* pInfo = (CControlBarInfo*)state.m_arrBarInfo[i];
-		if (pInfo == nullptr) 
-			barIsCorrect = false;
-		else
-		{
-			if (! pInfo->m_bFloating) 
-			{
-				pInfo->m_pBar = GetControlBar(pInfo->m_nBarID);
-				if (pInfo->m_pBar == nullptr) 
-					barIsCorrect = false; //toolbar id's probably changed	
-			}
-		}
-
-		if (! barIsCorrect)
-			state.m_arrBarInfo.RemoveAt(i);
-	}
-	return true;
-}
-
 void CMergeEditFrame::ActivateFrame(int nCmdShow) 
 {
 	CMergeFrameCommon::ActivateFrame(nCmdShow);

Src/MergeEditFrm.h

@@ -68,7 +68,6 @@ class CMergeEditFrame : public CMergeFrameCommon
 
 // Implementation
 private:
-	bool EnsureValidDockState(CDockState& state);
 	void SavePosition();
 	void SaveActivePane();
 	virtual ~CMergeEditFrame();

Src/MergeFrameCommon.cpp

@@ -365,6 +365,38 @@ std::pair<int, int> CMergeFrameCommon::MenuIDtoXY(UINT nID, int nActivePane, int
 	return { srcPane, dstPane };
 }
 
+/**
+ * @brief We must use this function before a call to SetDockState
+ *
+ * @note Without this, SetDockState will assert or crash if a bar from the 
+ * CDockState is missing in the current CMergeEditFrame.
+ * The bars are identified with their ID. This means the missing bar bug is triggered
+ * when we run WinMerge after changing the ID of a bar. 
+ */
+bool CMergeFrameCommon::EnsureValidDockState(CDockState& state)
+{
+	for (int i = (int) state.m_arrBarInfo.GetSize()-1 ; i >= 0; i--) 
+	{
+		bool barIsCorrect = true;
+		CControlBarInfo* pInfo = (CControlBarInfo*)state.m_arrBarInfo[i];
+		if (pInfo == nullptr) 
+			barIsCorrect = false;
+		else
+		{
+			if (! pInfo->m_bFloating) 
+			{
+				pInfo->m_pBar = GetControlBar(pInfo->m_nBarID);
+				if (pInfo->m_pBar == nullptr) 
+					barIsCorrect = false; //toolbar id's probably changed	
+			}
+		}
+
+		if (! barIsCorrect)
+			state.m_arrBarInfo.RemoveAt(i);
+	}
+	return true;
+}
+
 void CMergeFrameCommon::OnGetMinMaxInfo(MINMAXINFO* lpMMI)
 {
 	__super::OnGetMinMaxInfo(lpMMI);

Src/MergeFrameCommon.h

@@ -25,6 +25,7 @@ class CMergeFrameCommon: public CMDIChildWnd
 	static String GetTooltipString(const PathContext& paths, const String desc[], const PackingInfo *pInfoUnpacker, const PrediffingInfo *pInfoPrediffer, bool hasTrivialDiffs = false);
 	static void ChangeMergeMenuText(int srcPane, int dstPane, CCmdUI* pCmdUI);
 	static std::pair<int, int> MenuIDtoXY(UINT nID, int nActivePane, int nBuffers);
+	bool EnsureValidDockState(CDockState& state);
 	void SaveWindowState();
 	void SetSharedMenu(HMENU hMenu) { m_hMenuShared = hMenu; }
 	void RemoveBarBorder();

Src/WebPageDiffFrm.cpp

@@ -553,38 +553,6 @@ int CWebPageDiffFrame::OnCreate(LPCREATESTRUCT lpCreateStruct)
 	return 0;
 }
 
-/**
-* @brief We must use this function before a call to SetDockState
-*
-* @note Without this, SetDockState will assert or crash if a bar from the
-* CDockState is missing in the current CMergeEditFrame.
-* The bars are identified with their ID. This means the missing bar bug is triggered
-* when we run WinMerge after changing the ID of a bar.
-*/
-bool CWebPageDiffFrame::EnsureValidDockState(CDockState& state)
-{
-	for (int i = (int)state.m_arrBarInfo.GetSize() - 1; i >= 0; i--)
-	{
-		bool barIsCorrect = true;
-		CControlBarInfo* pInfo = (CControlBarInfo*)state.m_arrBarInfo[i];
-		if (pInfo == nullptr)
-			barIsCorrect = false;
-		else
-		{
-			if (!pInfo->m_bFloating)
-			{
-				pInfo->m_pBar = GetControlBar(pInfo->m_nBarID);
-				if (pInfo->m_pBar == nullptr)
-					barIsCorrect = false; //toolbar id's probably changed	
-			}
-		}
-
-		if (!barIsCorrect)
-			state.m_arrBarInfo.RemoveAt(i);
-	}
-	return true;
-}
-
 /**
  * @brief Save the window's position, free related resources, and destroy the window
  */

Src/WebPageDiffFrm.h

@@ -90,7 +90,6 @@ class CWebPageDiffFrame : public CMergeFrameCommon,public IMergeDoc
 
 // Implementation
 private:
-	bool EnsureValidDockState(CDockState& state);
 	void LoadOptions();
 	void SaveOptions();
 	void SavePosition();