コメントを追加

Author: hpmy-dev

sakura_core/_os/CClipboard.cpp

@@ -25,6 +25,11 @@ namespace {
 #define STATUS_NO_MEMORY ((DWORD)0xC0000017L)
 #endif
 
+/**
+ * IWBuffer::Append を SEH 例外 STATUS_NO_MEMORY から保護して呼び出す。
+ *
+ * C++ 例外ではなく Windows SEH を直接拾うためのラッパ。
+ */
 static bool SafeAppend(IWBuffer* cmemBuf, const wchar_t* pData, size_t nLen)
 {
 	__try {
@@ -336,7 +341,7 @@ bool CClipboard::GetText(IWBuffer* cmemBuf, bool* pbColumnSelect, bool* pbLineSe
 		}
 	}
 
-	//サクラ形式のデータがあれば取得
+	// SAKURAClipW は破損データを検出したら拒否し、既定取得では次の形式へフォールバックする。
 	CLIPFORMAT uFormatSakuraClip = CClipboard::GetSakuraFormat();
 	if( (uGetFormat == -1 || uGetFormat == uFormatSakuraClip)
 		&& IsClipboardFormatAvailable( uFormatSakuraClip ) ){
@@ -362,6 +367,7 @@ bool CClipboard::GetText(IWBuffer* cmemBuf, bool* pbColumnSelect, bool* pbLineSe
 				}else{
 					const size_t cchData = static_cast<size_t>(cchRaw);
 					const size_t cchMax = (cbData - sizeof(SSakuraClipHeader)) / sizeof(wchar_t);
+					// ヘッダの自己申告値が実メモリを超える場合は破損データとして扱う。
 					if( cchData > cchMax ){
 						::GlobalUnlock(hSakura);
 						if( uGetFormat == uFormatSakuraClip ){
@@ -371,6 +377,7 @@ bool CClipboard::GetText(IWBuffer* cmemBuf, bool* pbColumnSelect, bool* pbLineSe
 						bool bSakuraCopied = true;
 						if( cchData > 0 ){
 							const wchar_t* szData = reinterpret_cast<const wchar_t*>(pData + sizeof(SSakuraClipHeader));
+							// SAKURAClipW の貼り付けも SEH 経由で保護する。
 							bSakuraCopied = SafeAppend(cmemBuf, szData, cchData);
 						}
 						::GlobalUnlock(hSakura);
@@ -397,6 +404,7 @@ bool CClipboard::GetText(IWBuffer* cmemBuf, bool* pbColumnSelect, bool* pbLineSe
 		if (szData) {
 			const SIZE_T cbGlobal = ::GlobalSize(hUnicode);
 			const size_t cchTotal = wcsnlen(szData, cbGlobal / sizeof(wchar_t));
+			// 文字数上限で切り詰めたうえで、SEH 例外を SafeAppend で拾う。
 			const size_t cchSafe = std::min(cchTotal, CLIPBOARD_MAX_CHARS);
 			if( !SafeAppend(cmemBuf, szData, cchSafe) ){
 				::GlobalUnlock(hUnicode);
@@ -418,6 +426,7 @@ bool CClipboard::GetText(IWBuffer* cmemBuf, bool* pbColumnSelect, bool* pbLineSe
 		if( szData ){
 			const SIZE_T cbGlobal = ::GlobalSize(hText);
 			const SIZE_T cbLimit = static_cast<SIZE_T>(CLIPBOARD_MAX_CHARS) * sizeof(wchar_t);
+			// SJIS バイト列の上限も設けてから Unicode 変換する。
 			const SIZE_T cbSafe = std::min(cbGlobal, cbLimit);
 			//SJIS→UNICODE
 			CMemory cmemSjis( szData, cbSafe );
@@ -692,6 +701,7 @@ bool CClipboard::GetClipboardByFormat(CNativeW& mem, const wchar_t* pFormatName,
 
 		// 長さオプションの解釈
 		size_t nLength = GetLengthByMode(hClipData, pData, nMode, nEndMode);
+		// バイナリモードは文字数、それ以外はバイト数で上限を適用する。
 		const size_t nLimit = (nMode == -1)
 			? CLIPBOARD_MAX_CHARS
 			: static_cast<size_t>(CLIPBOARD_MAX_CHARS) * sizeof(wchar_t);

sakura_core/_os/CClipboard.h

@@ -49,8 +49,17 @@ struct StdWStringBuffer : public IWBuffer {
 };
 
 #pragma pack(push, 1)
+/**
+ * SAKURAClipW 独自クリップボード形式のバイナリヘッダ。
+ *
+ * メモリレイアウト:
+ *   [SSakuraClipHeader (4bytes)] [wchar_t szData[cchData]] [wchar_t L'\0']
+ *
+ * int32_t 固定にすることで 32bit/64bit 間のレイアウト不一致を避ける。
+ * フォーマット名 "SAKURAClipW" 自体は変更しない。
+ */
 struct SSakuraClipHeader {
-	int32_t cchData;
+	int32_t cchData;  //!< データの文字数（wchar_t 単位、負値は不正データ）
 };
 #pragma pack(pop)
 static_assert(sizeof(SSakuraClipHeader) == 4, "SSakuraClipHeader must be exactly 4 bytes");
@@ -88,6 +97,7 @@ class CClipboard{
 	// OpenClipboard retry constants (public for testing)
 	static constexpr int CLIPBOARD_RETRY_COUNT = 10;
 	static constexpr int CLIPBOARD_RETRY_DELAY_MS = 10;
+	//! クリップボード読み込み時の安全な上限（文字数）。INT32_MAX に合わせる。
 	static constexpr size_t CLIPBOARD_MAX_CHARS = static_cast<size_t>(INT32_MAX);
 
 private:
@@ -116,5 +126,6 @@ class CClipboard{
 	virtual HGLOBAL GlobalAlloc(UINT uFlags, SIZE_T dwBytes) const;
 	virtual LPVOID GlobalLock(HGLOBAL hMem) const;
 };
+//! CClipboard::CLIPBOARD_MAX_CHARS のグローバルスコープ別名。
 static constexpr size_t CLIPBOARD_MAX_CHARS = CClipboard::CLIPBOARD_MAX_CHARS;
 #endif /* SAKURA_CCLIPBOARD_4E783022_214C_4E51_A2E0_54EC343500F6_H_ */

sakura_core/_os/CDropTarget.cpp

@@ -27,6 +27,9 @@ namespace {
 #define STATUS_NO_MEMORY ((DWORD)0xC0000017L)
 #endif
 
+/**
+ * new BYTE[] を SEH 例外 STATUS_NO_MEMORY から保護して呼び出す。
+ */
 static bool SafeNewBytes(BYTE** ppOut, size_t nSize)
 {
 	__try {
@@ -212,9 +215,11 @@ void CDataObject::SetText( LPCWSTR lpszText, size_t nTextLen, BOOL bColumnSelect
 		m_nFormat = 0;
 	}
 	if( lpszText != nullptr ){
+		// SAKURAClipW は int32_t 範囲に収まる場合だけ作る。
 		const bool bUseSakuraFormat = (nTextLen <= static_cast<size_t>(INT32_MAX));
 		m_nFormat = (bUseSakuraFormat ? 3 : 2) + (bColumnSelect ? 1 : 0);	// 矩形を含めるか
 		m_pData = new DATA[m_nFormat];
+		// goto fail 時に未初期化ポインタを delete[] しないようにする。
 		for( i = 0; i < m_nFormat; i++ ){
 			m_pData[i].data = nullptr;
 		}
@@ -243,6 +248,7 @@ void CDataObject::SetText( LPCWSTR lpszText, size_t nTextLen, BOOL bColumnSelect
 			if( !SafeNewBytes(&m_pData[i].data, m_pData[i].size) ){
 				goto fail;
 			}
+			// SAKURAClipW のヘッダは固定幅の int32_t で書き込む。
 			const int32_t cchData = static_cast<int32_t>(nTextLen);
 			memcpy_raw( m_pData[i].data, &cchData, sizeof(cchData) );
 			memcpy_raw( m_pData[i].data + sizeof(SSakuraClipHeader), lpszText, nTextLen * sizeof( wchar_t ) );

sakura_core/view/CEditView_Mouse.cpp

@@ -52,6 +52,9 @@ namespace {
 #define STATUS_NO_MEMORY ((DWORD)0xC0000017L)
 #endif
 
+/**
+ * CNativeW::SetString を SEH 例外 STATUS_NO_MEMORY から保護して呼び出す。
+ */
 static bool SafeSetString(CNativeW& buf, const wchar_t* pData, size_t nLen)
 {
 	__try {
@@ -1857,16 +1860,19 @@ STDMETHODIMP CEditView::Drop( LPDATAOBJECT pDataObject, DWORD dwKeyState, POINTL
 			return E_INVALIDARG;
 		pData = ::GlobalLock( hData );
 		nSize = ::GlobalSize( hData );
+		// SAKURAClipW は壊れたヘッダを検出したら拒否し、次の形式へフォールバックする。
 		if( cf == CClipboard::GetSakuraFormat() ){
 			if( pData == nullptr || nSize < sizeof(SSakuraClipHeader) ){
 			}else{
 				SSakuraClipHeader header;
+				// エイリアシング安全な読み取り。
 				memcpy_raw(&header, pData, sizeof(header));
 				if( header.cchData >= 0 ){
 					const size_t cchData = static_cast<size_t>(header.cchData);
 					const size_t cchMax = (nSize - sizeof(SSakuraClipHeader)) / sizeof(wchar_t);
 					if( cchData <= cchMax ){
 						const wchar_t* pszData = reinterpret_cast<const wchar_t*>((BYTE*)pData + sizeof(SSakuraClipHeader));
+						// 途中の NUL 文字も含めて貼り付ける。
 						cmemBuf.SetString( pszData, cchData );	// 途中のNUL文字も含める
 						break;
 					}
@@ -1889,6 +1895,7 @@ STDMETHODIMP CEditView::Drop( LPDATAOBJECT pDataObject, DWORD dwKeyState, POINTL
 			}
 			continue;
 		}
+		// CF_UNICODETEXT は文字数を上限で切り詰めたうえで SetString する。
 		if( cf == CF_UNICODETEXT ){
 			const size_t cchTotal = wcsnlen( (wchar_t*)pData, nSize / sizeof(wchar_t) );
 			const size_t cchSafe = (cchTotal > CClipboard::CLIPBOARD_MAX_CHARS)
@@ -1904,6 +1911,7 @@ STDMETHODIMP CEditView::Drop( LPDATAOBJECT pDataObject, DWORD dwKeyState, POINTL
 				return E_OUTOFMEMORY;
 			}
 		}else{
+			// CF_TEXT は SJIS とみなして Unicode へ変換する。
 			const SIZE_T cbLimit = static_cast<SIZE_T>(CClipboard::CLIPBOARD_MAX_CHARS) * sizeof(wchar_t);
 			const SIZE_T cbSafe = (nSize > cbLimit) ? cbLimit : nSize;
 			CNativeA binary;

src/test/cpp/tests1/test-cclipboard.cpp

@@ -46,7 +46,8 @@ MATCHER_P(AnsiStringInGlobalMemory, expected_string, "") {
 	return match;
 }
 
-// グローバルメモリに書き込まれたサクラ独自形式データにマッチする述語関数
+// グローバルメモリに書き込まれた SAKURAClipW 独自形式データにマッチする述語関数。
+// SSakuraClipHeader から int32_t でデータ長を読み取り、負値を不正として扱う。
 MATCHER_P(SakuraFormatInGlobalMemory, expected_string, "") {
 	char* p = (char*)::GlobalLock(arg);
 	if (!p) return false;
@@ -196,15 +197,17 @@ TEST(CClipboard, SetText6) {
 	EXPECT_FALSE(clipboard.SetText(text.data(), text.length(), false, true, 0));
 }
 
-// SetText のテスト。SAKURAClipW のヘッダが int32_t 範囲を超える場合。
+// SetText のテスト。nDataLen > INT32_MAX でサクラ形式を指定した場合、
+// SAKURAClipW のヘッダに収まらないため SetClipboardData は呼ばれず false を返す。
 TEST(CClipboard, SetText7) {
 	const wchar_t text[] = L"x";
 	MockCClipboard clipboard;
 	EXPECT_CALL(clipboard, SetClipboardData(_, _)).Times(0);
 	EXPECT_FALSE(clipboard.SetText(text, static_cast<size_t>(INT32_MAX) + 1, false, false, CClipboard::GetSakuraFormat()));
 }
 
-// SetText のテスト。nDataLen > INT32_MAX でも矩形選択フラグは書き込まれる。
+// SetText のテスト。nDataLen > INT32_MAX でもフォーマット未指定（-1）の場合、
+// SAKURAClipW はスキップされるが CF_UNICODETEXT と矩形選択フラグは書き込まれ true を返す。
 TEST(CClipboard, SetText8) {
 	const wchar_t text[] = L"x";
 	const size_t hugeLen = static_cast<size_t>(INT32_MAX) + 1;
@@ -215,7 +218,8 @@ TEST(CClipboard, SetText8) {
 	EXPECT_TRUE(clipboard.SetText(text, hugeLen, true, false, -1));
 }
 
-// SetText のテスト。nDataLen + 1 が size_t を超える場合は失敗する。
+// SetText のテスト。nDataLen + 1 が size_t をオーバーフローする場合、
+// CF_UNICODETEXT の GlobalAlloc サイズ計算段階で検出されスキップ、false を返す。
 TEST(CClipboard, SetTextSizeTOverflow) {
 	const wchar_t text[] = L"x";
 	MockCClipboard clipboard;
@@ -336,7 +340,8 @@ TEST_F(CClipboardGetText, NoSpecifiedFormat6) {
 	EXPECT_FALSE(clipboard.GetText(&buffer, nullptr, nullptr, eol, -1));
 }
 
-// サクラ形式のヘッダが負値の場合は失敗する。
+// GetText のテスト。SAKURAClipW ヘッダの cchData が負値（-1）の場合、
+// 第2段階フェイルセーフにより不正データとして拒否される（フォーマット未指定で false）。
 TEST_F(CClipboardGetText, SakuraFormatNegativeLength) {
 	GlobalMemory mem(GMEM_MOVEABLE, sizeof(SSakuraClipHeader) + (sakuraText.size() + 1) * sizeof(wchar_t));
 	mem.Lock<unsigned char>([=](unsigned char* p) {
@@ -348,7 +353,8 @@ TEST_F(CClipboardGetText, SakuraFormatNegativeLength) {
 	EXPECT_FALSE(clipboard.GetText(&buffer, nullptr, nullptr, eol, -1));
 }
 
-// サクラ形式のヘッダが実データ長を超えている場合は失敗する。
+// GetText のテスト。SAKURAClipW ヘッダの cchData（= 2）が実データ長（1文字分）を超過する場合、
+// 第3段階フェイルセーフにより破損データとして拒否される。
 TEST_F(CClipboardGetText, SakuraFormatOverflowLength) {
 	constexpr std::wstring_view shortText = L"x";
 	GlobalMemory mem(GMEM_MOVEABLE, sizeof(SSakuraClipHeader) + shortText.size() * sizeof(wchar_t));
@@ -361,7 +367,8 @@ TEST_F(CClipboardGetText, SakuraFormatOverflowLength) {
 	EXPECT_FALSE(clipboard.GetText(&buffer, nullptr, nullptr, eol, -1));
 }
 
-// 壊れたサクラ形式があっても、既定取得では Unicode にフォールバックする。
+// GetText のテスト。SAKURAClipW が破損（ヘッダ負値）していても、
+// フォーマット未指定の既定取得では CF_UNICODETEXT にフォールバックし true を返す。
 TEST_F(CClipboardGetText, CorruptedSakuraFallsBackToUnicode) {
 	GlobalMemory mem(GMEM_MOVEABLE, sizeof(SSakuraClipHeader) + (sakuraText.size() + 1) * sizeof(wchar_t));
 	mem.Lock<unsigned char>([=](unsigned char* p) {