Merge pull request sakura-editor#877 from berryzplus/feature/implemen…

…ts_MyDEVMODE_equals

構造体比較にmemcmpを使うのをやめる

sakura_core/print/CPrint.h

@@ -61,6 +61,40 @@ struct	MYDEVMODE {
 	DWORD	dmPelsHeight;
 	DWORD	dmDisplayFlags;
 	DWORD	dmDisplayFrequency;
+
+	//! 等価比較演算子
+	bool operator == (const MYDEVMODE& rhs) const noexcept {
+		if (this == &rhs) return true;
+		return m_bPrinterNotFound == rhs.m_bPrinterNotFound
+			&& 0 == _tcsncmp(m_szPrinterDriverName, rhs.m_szPrinterDriverName, _countof(m_szPrinterDriverName) - 1)
+			&& 0 == _tcsncmp(m_szPrinterDeviceName, rhs.m_szPrinterDeviceName, _countof(m_szPrinterDeviceName) - 1)
+			&& 0 == _tcsncmp(m_szPrinterOutputName, rhs.m_szPrinterOutputName, _countof(m_szPrinterOutputName) - 1)
+			&& dmFields == rhs.dmFields
+			&& dmOrientation == rhs.dmOrientation
+			&& dmPaperSize == rhs.dmPaperSize
+			&& dmPaperLength == rhs.dmPaperLength
+			&& dmPaperWidth == rhs.dmPaperWidth
+			&& dmScale == rhs.dmScale
+			&& dmCopies == rhs.dmCopies
+			&& dmDefaultSource == rhs.dmDefaultSource
+			&& dmPrintQuality == rhs.dmPrintQuality
+			&& dmColor == rhs.dmColor
+			&& dmDuplex == rhs.dmDuplex
+			&& dmYResolution == rhs.dmYResolution
+			&& dmTTOption == rhs.dmTTOption
+			&& dmCollate == rhs.dmCollate
+			&& 0 == _tcsncmp(dmFormName, rhs.dmFormName, _countof(dmFormName) - 1)
+			&& dmLogPixels == rhs.dmLogPixels
+			&& dmBitsPerPel == rhs.dmBitsPerPel
+			&& dmPelsWidth == rhs.dmPelsWidth
+			&& dmPelsHeight == rhs.dmPelsHeight
+			&& dmDisplayFlags == rhs.dmDisplayFlags
+			&& dmDisplayFrequency == rhs.dmDisplayFrequency;
+	}
+	//! 否定の等価比較演算子
+	bool operator != (const MYDEVMODE& rhs) const noexcept {
+		return !(*this == rhs);
+	}
 };
 
 // 2006.08.14 Moca 用紙情報の統合 PAPER_INFO新設

sakura_core/print/CPrintPreview.cpp

@@ -1074,7 +1074,7 @@ void CPrintPreview::OnPrint( void )
 		}
 		return;
 	}
-	if( 0 != memcmp(&m_pPrintSettingOrg->m_mdmDevMode, &m_pPrintSetting->m_mdmDevMode, sizeof(m_pPrintSetting->m_mdmDevMode)) ){
+	if( m_pPrintSettingOrg->m_mdmDevMode != m_pPrintSetting->m_mdmDevMode ){
 		m_pPrintSettingOrg->m_mdmDevMode = m_pPrintSetting->m_mdmDevMode;
 		// 自分はLockで更新しない
 		CAppNodeGroupHandle(0).PostMessageToAllEditors(

tests/unittests/test-mydevmode.cpp

@@ -0,0 +1,318 @@
+/*! @file */
+/*
+	Copyright (C) 2018-2019 Sakura Editor Organization
+
+	This software is provided 'as-is', without any express or implied
+	warranty. In no event will the authors be held liable for any damages
+	arising from the use of this software.
+
+	Permission is granted to anyone to use this software for any purpose,
+	including commercial applications, and to alter it and redistribute it
+	freely, subject to the following restrictions:
+
+		1. The origin of this software must not be misrepresented;
+		   you must not claim that you wrote the original software.
+		   If you use this software in a product, an acknowledgment
+		   in the product documentation would be appreciated but is
+		   not required.
+
+		2. Altered source versions must be plainly marked as such,
+		   and must not be misrepresented as being the original software.
+
+		3. This notice may not be removed or altered from any source
+		   distribution.
+*/
+
+#include <gtest/gtest.h>
+
+#ifndef NOMINMAX
+#define NOMINMAX
+#endif NOMINMAX
+
+#include <tchar.h>
+#include <Windows.h>
+
+#include "basis/primitive.h"
+#include "print/CPrint.h"
+
+#include <cassert>
+#include <limits>
+#include <string>
+
+/*! テストのベースとなる値 */
+static constexpr MYDEVMODE myDevMode = {
+	FALSE, //BOOL	m_bPrinterNotFound;
+	{_T("m_szPrinterDriverName")}, //TCHAR	m_szPrinterDriverName[_MAX_PATH + 1];
+	{_T("m_szPrinterDeviceName")}, //TCHAR	m_szPrinterDeviceName[_MAX_PATH + 1];
+	{_T("m_szPrinterOutputName")}, //TCHAR	m_szPrinterOutputName[_MAX_PATH + 1];
+	std::numeric_limits<DWORD>::min(), //DWORD	dmFields;
+	std::numeric_limits<short>::min(), //short	dmOrientation;
+	std::numeric_limits<short>::min(), //short	dmPaperSize;
+	std::numeric_limits<short>::min(), //short	dmPaperLength;
+	std::numeric_limits<short>::min(), //short	dmPaperWidth;
+	std::numeric_limits<short>::min(), //short	dmScale;
+	std::numeric_limits<short>::min(), //short	dmCopies;
+	std::numeric_limits<short>::min(), //short	dmDefaultSource;
+	std::numeric_limits<short>::min(), //short	dmPrintQuality;
+	std::numeric_limits<short>::min(), //short	dmColor;
+	std::numeric_limits<short>::min(), //short	dmDuplex;
+	std::numeric_limits<short>::min(), //short	dmYResolution;
+	std::numeric_limits<short>::min(), //short	dmTTOption;
+	std::numeric_limits<short>::min(), //short	dmCollate;
+	{_T("dmFormName")}, //BCHAR	dmFormName[CCHFORMNAME];
+	std::numeric_limits<WORD>::min(), //WORD	dmLogPixels;
+	std::numeric_limits<DWORD>::min(), //DWORD	dmBitsPerPel;
+	std::numeric_limits<DWORD>::min(), //DWORD	dmPelsWidth;
+	std::numeric_limits<DWORD>::min(), //DWORD	dmPelsHeight;
+	std::numeric_limits<DWORD>::min(), //DWORD	dmDisplayFlags;
+	std::numeric_limits<DWORD>::min(), //DWORD	dmDisplayFrequency;
+};
+
+/*!
+ * @brief 等価演算子のテスト
+ *  コピーコンストラクタ(trivial)でインスタンスを生成し、等価比較を行う
+ */
+TEST(MYDEVMODETest, operatorEqualByCopy)
+{
+	// コピーコンストラクタ経由で初期化
+	MYDEVMODE value = myDevMode;
+
+	EXPECT_TRUE(value == myDevMode);
+	EXPECT_FALSE(value != myDevMode);
+	ASSERT_EQ(myDevMode, value);
+}
+
+/*!
+ * @brief 等価演算子のテスト
+ *  自分自身との等価比較を行う
+ */
+TEST(MYDEVMODETest, operatorEqualBySelf)
+{
+	// 初期値はなんでもよいが一応指定しておく
+	MYDEVMODE value = myDevMode;
+
+	EXPECT_TRUE(value == value);
+	EXPECT_FALSE(value != value);
+	ASSERT_EQ(value, value);
+}
+
+/*!
+ * @brief 等価演算子のテスト
+ *  memcpyでメンバが割当たっていない領域を含めてコピーし、等価比較を行う
+ */
+TEST(MYDEVMODETest, operatorEqualByMemCpy)
+{
+	// デフォルトで初期化
+	MYDEVMODE value;
+
+	// メモリ領域全体をコピーしてまったく同じにする
+	assert(sizeof(value) == sizeof(myDevMode));
+	::memcpy_s(&value, sizeof(value), &myDevMode, sizeof(myDevMode));
+
+	EXPECT_TRUE(value == myDevMode);
+	EXPECT_FALSE(value != myDevMode);
+	ASSERT_EQ(myDevMode, value);
+}
+
+/*!
+ * @brief 否定の等価演算子のテスト
+ *  メンバの値を変えて、等価比較を行う
+ *
+ *  合格条件：メンバの値が1つでも違ったら不一致を検出できること。
+ */
+TEST(MYDEVMODETest, operatorNotEqual)
+{
+	// デフォルトで初期化
+	MYDEVMODE value;
+
+	// メモリ領域全体をコピーしてまったく同じにする
+	assert(sizeof(value) == sizeof(myDevMode));
+	::memcpy_s(&value, sizeof(value), &myDevMode, sizeof(myDevMode));
+
+	EXPECT_TRUE(value == myDevMode);
+	EXPECT_EQ(myDevMode, value);
+
+	value.m_bPrinterNotFound = TRUE;
+	EXPECT_NE(myDevMode, value);
+	value.m_bPrinterNotFound = myDevMode.m_bPrinterNotFound;
+	EXPECT_EQ(myDevMode, value);
+
+	::_tcscpy_s(value.m_szPrinterDriverName, _T("PrinterDriverName"));
+	EXPECT_NE(myDevMode, value);
+	::_tcscpy_s(value.m_szPrinterDriverName, myDevMode.m_szPrinterDriverName);
+	EXPECT_EQ(myDevMode, value);
+
+	::_tcscpy_s(value.m_szPrinterDeviceName, _T("PrinterDeviceName"));
+	EXPECT_NE(myDevMode, value);
+	::_tcscpy_s(value.m_szPrinterDeviceName, myDevMode.m_szPrinterDeviceName);
+	EXPECT_EQ(myDevMode, value);
+
+	::_tcscpy_s(value.m_szPrinterOutputName, _T("PrinterOutputName"));
+	EXPECT_NE(myDevMode, value);
+	::_tcscpy_s(value.m_szPrinterOutputName, myDevMode.m_szPrinterOutputName);
+	EXPECT_EQ(myDevMode, value);
+
+	value.dmFields = std::numeric_limits<decltype(value.dmFields)>::max();
+	EXPECT_NE(myDevMode, value);
+	value.dmFields = myDevMode.dmFields;
+	EXPECT_EQ(myDevMode, value);
+
+	value.dmOrientation = std::numeric_limits<decltype(value.dmOrientation)>::max();
+	EXPECT_NE(myDevMode, value);
+	value.dmOrientation = myDevMode.dmOrientation;
+	EXPECT_EQ(myDevMode, value);
+
+	value.dmPaperSize = std::numeric_limits<decltype(value.dmPaperSize)>::max();
+	EXPECT_NE(myDevMode, value);
+	value.dmPaperSize = myDevMode.dmPaperSize;
+	EXPECT_EQ(myDevMode, value);
+
+	value.dmPaperLength = std::numeric_limits<decltype(value.dmPaperLength)>::max();
+	EXPECT_NE(myDevMode, value);
+	value.dmPaperLength = myDevMode.dmPaperLength;
+	EXPECT_EQ(myDevMode, value);
+
+	value.dmPaperWidth = std::numeric_limits<decltype(value.dmPaperWidth)>::max();
+	EXPECT_NE(myDevMode, value);
+	value.dmPaperWidth = myDevMode.dmPaperWidth;
+	EXPECT_EQ(myDevMode, value);
+
+	value.dmScale = std::numeric_limits<decltype(value.dmScale)>::max();
+	EXPECT_NE(myDevMode, value);
+	value.dmScale = myDevMode.dmScale;
+	EXPECT_EQ(myDevMode, value);
+
+	value.dmCopies = std::numeric_limits<decltype(value.dmCopies)>::max();
+	EXPECT_NE(myDevMode, value);
+	value.dmCopies = myDevMode.dmCopies;
+	EXPECT_EQ(myDevMode, value);
+
+	value.dmDefaultSource = std::numeric_limits<decltype(value.dmDefaultSource)>::max();
+	EXPECT_NE(myDevMode, value);
+	value.dmDefaultSource = myDevMode.dmDefaultSource;
+	EXPECT_EQ(myDevMode, value);
+
+	value.dmPrintQuality = std::numeric_limits<decltype(value.dmPrintQuality)>::max();
+	EXPECT_NE(myDevMode, value);
+	value.dmPrintQuality = myDevMode.dmPrintQuality;
+	EXPECT_EQ(myDevMode, value);
+
+	value.dmColor = std::numeric_limits<decltype(value.dmColor)>::max();
+	EXPECT_NE(myDevMode, value);
+	value.dmColor = myDevMode.dmColor;
+	EXPECT_EQ(myDevMode, value);
+
+	value.dmDuplex = std::numeric_limits<decltype(value.dmDuplex)>::max();
+	EXPECT_NE(myDevMode, value);
+	value.dmDuplex = myDevMode.dmDuplex;
+	EXPECT_EQ(myDevMode, value);
+
+	value.dmYResolution = std::numeric_limits<decltype(value.dmYResolution)>::max();
+	EXPECT_NE(myDevMode, value);
+	value.dmYResolution = myDevMode.dmYResolution;
+	EXPECT_EQ(myDevMode, value);
+
+	value.dmTTOption = std::numeric_limits<decltype(value.dmTTOption)>::max();
+	EXPECT_NE(myDevMode, value);
+	value.dmTTOption = myDevMode.dmTTOption;
+	EXPECT_EQ(myDevMode, value);
+
+	value.dmCollate = std::numeric_limits<decltype(value.dmCollate)>::max();
+	EXPECT_NE(myDevMode, value);
+	value.dmCollate = myDevMode.dmCollate;
+	EXPECT_EQ(myDevMode, value);
+
+	::_tcscpy_s(value.dmFormName, _T("FormName"));
+	EXPECT_NE(myDevMode, value);
+	::_tcscpy_s(value.dmFormName, myDevMode.dmFormName);
+	EXPECT_EQ(myDevMode, value);
+
+	value.dmLogPixels = std::numeric_limits<decltype(value.dmLogPixels)>::max();
+	EXPECT_NE(myDevMode, value);
+	value.dmLogPixels = myDevMode.dmLogPixels;
+	EXPECT_EQ(myDevMode, value);
+
+	value.dmBitsPerPel = std::numeric_limits<decltype(value.dmBitsPerPel)>::max();
+	EXPECT_NE(myDevMode, value);
+	value.dmBitsPerPel = myDevMode.dmBitsPerPel;
+	EXPECT_EQ(myDevMode, value);
+
+	value.dmPelsWidth = std::numeric_limits<decltype(value.dmPelsWidth)>::max();
+	EXPECT_NE(myDevMode, value);
+	value.dmPelsWidth = myDevMode.dmPelsWidth;
+	EXPECT_EQ(myDevMode, value);
+
+	value.dmPelsHeight = std::numeric_limits<decltype(value.dmPelsHeight)>::max();
+	EXPECT_NE(myDevMode, value);
+	value.dmPelsHeight = myDevMode.dmPelsHeight;
+	EXPECT_EQ(myDevMode, value);
+
+	value.dmDisplayFlags = std::numeric_limits<decltype(value.dmDisplayFlags)>::max();
+	EXPECT_NE(myDevMode, value);
+	value.dmDisplayFlags = myDevMode.dmDisplayFlags;
+	EXPECT_EQ(myDevMode, value);
+
+	value.dmDisplayFrequency = std::numeric_limits<decltype(value.dmDisplayFrequency)>::max();
+	EXPECT_NE(myDevMode, value);
+	value.dmDisplayFrequency = myDevMode.dmDisplayFrequency;
+	EXPECT_EQ(myDevMode, value);
+}
+
+/* アクセス不可のメモリ領域にアクセスしても、例外が発生しない事象があるので、
+ * 当面MSVCのリリース版では以下のテストを実行しない。
+ */
+#if defined(_DEBUG) || defined(__MINGW64__)
+/*!
+ * @brief 等価比較演算子が一般保護違反を犯さないことを保証する非機能要件テスト
+ *
+ *  通常、ここまでやる必要はないが、修正の理由が「安全のため」なので、
+ *  実際にどういうケースで一般保護例外違反となるか、コード的に発生させる方法の共有を兼ねて実装したもの。
+ */
+TEST(MYDEVMODETest, StrategyForSegmentationFault)
+{
+	// システムのページサイズを取得する
+	SYSTEM_INFO systemInfo = { 0 };
+	::GetSystemInfo(&systemInfo);
+
+	// システムページサイズ
+	const auto pageSize = systemInfo.dwPageSize;
+	// 確保領域サイズ(2ページ分)
+	const auto allocSize = pageSize * 2;
+
+	// 仮想メモリ範囲を予約する。予約時点では全体をNOACCESS指定にしておく。
+	LPVOID memBlock1 = ::VirtualAlloc(NULL, allocSize, MEM_RESERVE, PAGE_NOACCESS);
+	assert(memBlock1);
+
+	// 仮想メモリを1ページ分だけコミット(=確保)する。2ページ目はNOACCESSのまま。
+	wchar_t* buf1 = static_cast<wchar_t*>(::VirtualAlloc(memBlock1, pageSize, MEM_COMMIT, PAGE_READWRITE));
+	assert(buf1);
+
+	// 確保したメモリ領域をASCII文字'a'で埋める
+	::wmemset(buf1, L'a', pageSize / sizeof(wchar_t));
+
+	// メモリデータをテスト対象型にマップする。実態として配列のように扱えるポインタを取得している。
+	MYDEVMODE* pValues = reinterpret_cast<MYDEVMODE*>(buf1);
+
+	// 例外判定用の巨大な文字列を作る。これは2ページ分のサイズを持つ巨大データ。
+	std::wstring largeString(pageSize, L'a');
+	const auto pLargeStr = largeString.c_str();
+
+	/* DEATHテストで例外ケースの判定を行う。
+	 * pLargeStrには、コミットサイズの倍のデータが入っているので、
+	 * 単純にstrcmpするとreserveしただけの領域にアクセスしてしまい一般保護違反(access violation)が起きる。
+	 *
+	 * 想定結果：一般保護違反で落ちる
+	 * 備考：例外メッセージは無視する(例外が起きたことが検知できればよいから。)
+	 */
+	ASSERT_DEATH({ ::_tcscmp(pValues[0].m_szPrinterDeviceName, pLargeStr); }, ".*");
+
+	// 等価比較演算子を使った場合には落ちないことを確認する
+	EXPECT_TRUE(pValues[0] == pValues[1]);
+	EXPECT_FALSE(pValues[0] != pValues[1]);
+
+	// 仮想メモリをデコミット(=解放)する。
+	::VirtualFree((LPVOID)buf1, pageSize, MEM_DECOMMIT);
+	// 仮想メモリ範囲を解放する。
+	::VirtualFree(memBlock1, 0, MEM_RELEASE);
+}
+#endif /* if defined(_DEBUG) || defined(__MINGW64__) */