refactor: use bool for Get/SetCompartmentBOOL

saschanaz · saschanaz · commit 2f9a34b4aba3 · 2021-11-15T18:14:00.000+01:00
diff --git a/cpp/SampleIME/Compartment.cpp b/cpp/SampleIME/Compartment.cpp
@@ -61,7 +61,7 @@ HRESULT CCompartment::_GetCompartment(_Outptr_ ITfCompartment **ppCompartment)
 // _GetCompartmentBOOL
 //----------------------------------------------------------------------------
 
-HRESULT CCompartment::_GetCompartmentBOOL(_Out_ BOOL &flag)
+HRESULT CCompartment::_GetCompartmentBOOL(bool& flag)
 {
     uint32_t dwValue = 0;
     HRESULT hr = _GetCompartmentU32(dwValue);
@@ -73,7 +73,7 @@ HRESULT CCompartment::_GetCompartmentBOOL(_Out_ BOOL &flag)
 // _SetCompartmentBOOL
 //----------------------------------------------------------------------------
 
-HRESULT CCompartment::_SetCompartmentBOOL(_In_ BOOL flag)
+HRESULT CCompartment::_SetCompartmentBOOL(bool flag)
 {
     return _SetCompartmentU32(flag);
 }
diff --git a/cpp/SampleIME/Compartment.h b/cpp/SampleIME/Compartment.h
@@ -16,8 +16,8 @@ class CCompartment
     ~CCompartment();
 
     HRESULT _GetCompartment(_Outptr_ ITfCompartment **ppCompartment);
-    HRESULT _GetCompartmentBOOL(_Out_ BOOL &flag);
-    HRESULT _SetCompartmentBOOL(_In_ BOOL flag);
+    HRESULT _GetCompartmentBOOL(bool& flag);
+    HRESULT _SetCompartmentBOOL(bool flag);
     HRESULT _GetCompartmentU32(uint32_t &dw);
     HRESULT _SetCompartmentU32(uint32_t dw);
     HRESULT _ClearCompartment();
diff --git a/cpp/SampleIME/CompositionProcessorEngine.cpp b/cpp/SampleIME/CompositionProcessorEngine.cpp
@@ -466,27 +466,27 @@ void CCompositionProcessorEngine::OnPreservedKey(REFGUID rguid, _Out_ BOOL *pIsE
             *pIsEaten = FALSE;
             return;
         }
-        BOOL isOpen = FALSE;
+        bool isOpen = false;
         CCompartment CompartmentKeyboardOpen(pThreadMgr, tfClientId, GUID_COMPARTMENT_KEYBOARD_OPENCLOSE);
         CompartmentKeyboardOpen._GetCompartmentBOOL(isOpen);
-        CompartmentKeyboardOpen._SetCompartmentBOOL(isOpen ? FALSE : TRUE);
+        CompartmentKeyboardOpen._SetCompartmentBOOL(!isOpen);
 
         *pIsEaten = TRUE;
     }
     else if (IsEqualGUID(rguid, _PreservedKey_DoubleSingleByte.Guid))
     {
-        BOOL isDouble = FALSE;
+        bool isDouble = false;
         CCompartment CompartmentDoubleSingleByte(pThreadMgr, tfClientId, SAMPLEIME_GUID_COMPARTMENT_DOUBLE_SINGLE_BYTE);
         CompartmentDoubleSingleByte._GetCompartmentBOOL(isDouble);
-        CompartmentDoubleSingleByte._SetCompartmentBOOL(isDouble ? FALSE : TRUE);
+        CompartmentDoubleSingleByte._SetCompartmentBOOL(!isDouble);
         *pIsEaten = TRUE;
     }
     else if (IsEqualGUID(rguid, _PreservedKey_Punctuation.Guid))
     {
-        BOOL isPunctuation = FALSE;
+        bool isPunctuation = false;
         CCompartment CompartmentPunctuation(pThreadMgr, tfClientId, SAMPLEIME_GUID_COMPARTMENT_PUNCTUATION);
         CompartmentPunctuation._GetCompartmentBOOL(isPunctuation);
-        CompartmentPunctuation._SetCompartmentBOOL(isPunctuation ? FALSE : TRUE);
+        CompartmentPunctuation._SetCompartmentBOOL(!isPunctuation);
         *pIsEaten = TRUE;
     }
     else
@@ -650,44 +650,44 @@ void CCompositionProcessorEngine::ConversionModeCompartmentUpdated(_In_ ITfThrea
         return;
     }
 
-    BOOL isDouble = FALSE;
+    bool isDouble = false;
     CCompartment CompartmentDoubleSingleByte(pThreadMgr, _tfClientId, SAMPLEIME_GUID_COMPARTMENT_DOUBLE_SINGLE_BYTE);
     if (SUCCEEDED(CompartmentDoubleSingleByte._GetCompartmentBOOL(isDouble)))
     {
         if (!isDouble && (conversionMode & TF_CONVERSIONMODE_FULLSHAPE))
         {
-            CompartmentDoubleSingleByte._SetCompartmentBOOL(TRUE);
+            CompartmentDoubleSingleByte._SetCompartmentBOOL(true);
         }
         else if (isDouble && !(conversionMode & TF_CONVERSIONMODE_FULLSHAPE))
         {
-            CompartmentDoubleSingleByte._SetCompartmentBOOL(FALSE);
+            CompartmentDoubleSingleByte._SetCompartmentBOOL(false);
         }
     }
-    BOOL isPunctuation = FALSE;
+    bool isPunctuation = false;
     CCompartment CompartmentPunctuation(pThreadMgr, _tfClientId, SAMPLEIME_GUID_COMPARTMENT_PUNCTUATION);
     if (SUCCEEDED(CompartmentPunctuation._GetCompartmentBOOL(isPunctuation)))
     {
         if (!isPunctuation && (conversionMode & TF_CONVERSIONMODE_SYMBOL))
         {
-            CompartmentPunctuation._SetCompartmentBOOL(TRUE);
+            CompartmentPunctuation._SetCompartmentBOOL(true);
         }
         else if (isPunctuation && !(conversionMode & TF_CONVERSIONMODE_SYMBOL))
         {
-            CompartmentPunctuation._SetCompartmentBOOL(FALSE);
+            CompartmentPunctuation._SetCompartmentBOOL(false);
         }
     }
 
-    BOOL fOpen = FALSE;
+    bool fOpen = false;
     CCompartment CompartmentKeyboardOpen(pThreadMgr, _tfClientId, GUID_COMPARTMENT_KEYBOARD_OPENCLOSE);
     if (SUCCEEDED(CompartmentKeyboardOpen._GetCompartmentBOOL(fOpen)))
     {
         if (fOpen && !(conversionMode & TF_CONVERSIONMODE_NATIVE))
         {
-            CompartmentKeyboardOpen._SetCompartmentBOOL(FALSE);
+            CompartmentKeyboardOpen._SetCompartmentBOOL(false);
         }
         else if (!fOpen && (conversionMode & TF_CONVERSIONMODE_NATIVE))
         {
-            CompartmentKeyboardOpen._SetCompartmentBOOL(TRUE);
+            CompartmentKeyboardOpen._SetCompartmentBOOL(true);
         }
     }
 }
@@ -714,7 +714,7 @@ void CCompositionProcessorEngine::PrivateCompartmentsUpdated(_In_ ITfThreadMgr *
 
     conversionModePrev = conversionMode;
 
-    BOOL isDouble = FALSE;
+    bool isDouble = false;
     CCompartment CompartmentDoubleSingleByte(pThreadMgr, _tfClientId, SAMPLEIME_GUID_COMPARTMENT_DOUBLE_SINGLE_BYTE);
     if (SUCCEEDED(CompartmentDoubleSingleByte._GetCompartmentBOOL(isDouble)))
     {
@@ -728,7 +728,7 @@ void CCompositionProcessorEngine::PrivateCompartmentsUpdated(_In_ ITfThreadMgr *
         }
     }
 
-    BOOL isPunctuation = FALSE;
+    bool isPunctuation = false;
     CCompartment CompartmentPunctuation(pThreadMgr, _tfClientId, SAMPLEIME_GUID_COMPARTMENT_PUNCTUATION);
     if (SUCCEEDED(CompartmentPunctuation._GetCompartmentBOOL(isPunctuation)))
     {
@@ -770,7 +770,7 @@ void CCompositionProcessorEngine::KeyboardOpenCompartmentUpdated(_In_ ITfThreadM
 
     conversionModePrev = conversionMode;
 
-    BOOL isOpen = FALSE;
+    bool isOpen = false;
     CCompartment CompartmentKeyboardOpen(pThreadMgr, _tfClientId, GUID_COMPARTMENT_KEYBOARD_OPENCLOSE);
     if (SUCCEEDED(CompartmentKeyboardOpen._GetCompartmentBOOL(isOpen)))
     {
diff --git a/cpp/SampleIME/KeyEventSink.cpp b/cpp/SampleIME/KeyEventSink.cpp
@@ -65,15 +65,15 @@ BOOL CSampleIME::_IsKeyEaten(_In_ ITfContext *pContext, UINT codeIn, _Out_ UINT
 
     *pCodeOut = codeIn;
 
-    BOOL isOpen = FALSE;
+    bool isOpen = false;
     CCompartment CompartmentKeyboardOpen(_pThreadMgr, _tfClientId, GUID_COMPARTMENT_KEYBOARD_OPENCLOSE);
     CompartmentKeyboardOpen._GetCompartmentBOOL(isOpen);
 
-    BOOL isDoubleSingleByte = FALSE;
+    bool isDoubleSingleByte = false;
     CCompartment CompartmentDoubleSingleByte(_pThreadMgr, _tfClientId, SAMPLEIME_GUID_COMPARTMENT_DOUBLE_SINGLE_BYTE);
     CompartmentDoubleSingleByte._GetCompartmentBOOL(isDoubleSingleByte);
 
-    BOOL isPunctuation = FALSE;
+    bool isPunctuation = false;
     CCompartment CompartmentPunctuation(_pThreadMgr, _tfClientId, SAMPLEIME_GUID_COMPARTMENT_PUNCTUATION);
     CompartmentPunctuation._GetCompartmentBOOL(isPunctuation);
 
@@ -209,20 +209,20 @@ BOOL CSampleIME::_IsKeyboardDisabled()
 {
     ITfDocumentMgr* pDocMgrFocus = nullptr;
     ITfContext* pContext = nullptr;
-    BOOL isDisabled = FALSE;
+    bool isDisabled = false;
 
     if ((_pThreadMgr->GetFocus(&pDocMgrFocus) != S_OK) ||
         (pDocMgrFocus == nullptr))
     {
         // if there is no focus document manager object, the keyboard
         // is disabled.
-        isDisabled = TRUE;
+        isDisabled = true;
     }
     else if ((pDocMgrFocus->GetTop(&pContext) != S_OK) ||
         (pContext == nullptr))
     {
         // if there is no context object, the keyboard is disabled.
-        isDisabled = TRUE;
+        isDisabled = true;
     }
     else
     {
diff --git a/cpp/SampleIME/LanguageBar.cpp b/cpp/SampleIME/LanguageBar.cpp
@@ -361,10 +361,10 @@ STDAPI CLangBarItemButton::OnClick(TfLBIClick click, POINT pt, _In_ const RECT *
     click;pt;
     prcArea;
 
-    BOOL isOn = FALSE;
+    bool isOn = false;
 
     _pCompartment->_GetCompartmentBOOL(isOn);
-    _pCompartment->_SetCompartmentBOOL(isOn ? FALSE : TRUE);
+    _pCompartment->_SetCompartmentBOOL(!isOn);
 
     return S_OK;
 }
@@ -403,7 +403,7 @@ STDAPI CLangBarItemButton::OnMenuSelect(UINT wID)
 
 STDAPI CLangBarItemButton::GetIcon(_Out_ HICON *phIcon)
 {
-    BOOL isOn = FALSE;
+    bool isOn = false;
 
     if (!_pCompartment)
     {

Original file line number	Diff line number	Diff line change
`@@ -61,7 +61,7 @@ HRESULT CCompartment::_GetCompartment(_Outptr_ ITfCompartment **ppCompartment)`
`61`	`61`	`// _GetCompartmentBOOL`
`62`	`62`	`//----------------------------------------------------------------------------`
`63`	`63`
`64`		`-HRESULT CCompartment::_GetCompartmentBOOL(_Out_ BOOL &flag)`
	`64`	`+HRESULT CCompartment::_GetCompartmentBOOL(bool& flag)`
`65`	`65`	`{`
`66`	`66`	`uint32_t dwValue = 0;`
`67`	`67`	`HRESULT hr = _GetCompartmentU32(dwValue);`
`@@ -73,7 +73,7 @@ HRESULT CCompartment::_GetCompartmentBOOL(_Out_ BOOL &flag)`
`73`	`73`	`// _SetCompartmentBOOL`
`74`	`74`	`//----------------------------------------------------------------------------`
`75`	`75`
`76`		`-HRESULT CCompartment::_SetCompartmentBOOL(_In_ BOOL flag)`
	`76`	`+HRESULT CCompartment::_SetCompartmentBOOL(bool flag)`
`77`	`77`	`{`
`78`	`78`	`return _SetCompartmentU32(flag);`
`79`	`79`	`}`
Original file line number	Diff line number	Diff line change
`@@ -466,27 +466,27 @@ void CCompositionProcessorEngine::OnPreservedKey(REFGUID rguid, _Out_ BOOL *pIsE`
`466`	`466`	`*pIsEaten = FALSE;`
`467`	`467`	`return;`
`468`	`468`	`}`
`469`		`- BOOL isOpen = FALSE;`
	`469`	`+ bool isOpen = false;`
`470`	`470`	`CCompartment CompartmentKeyboardOpen(pThreadMgr, tfClientId, GUID_COMPARTMENT_KEYBOARD_OPENCLOSE);`
`471`	`471`	`CompartmentKeyboardOpen._GetCompartmentBOOL(isOpen);`
`472`		`- CompartmentKeyboardOpen._SetCompartmentBOOL(isOpen ? FALSE : TRUE);`
	`472`	`+ CompartmentKeyboardOpen._SetCompartmentBOOL(!isOpen);`
`473`	`473`
`474`	`474`	`*pIsEaten = TRUE;`
`475`	`475`	`}`
`476`	`476`	`else if (IsEqualGUID(rguid, _PreservedKey_DoubleSingleByte.Guid))`
`477`	`477`	`{`
`478`		`- BOOL isDouble = FALSE;`
	`478`	`+ bool isDouble = false;`
`479`	`479`	`CCompartment CompartmentDoubleSingleByte(pThreadMgr, tfClientId, SAMPLEIME_GUID_COMPARTMENT_DOUBLE_SINGLE_BYTE);`
`480`	`480`	`CompartmentDoubleSingleByte._GetCompartmentBOOL(isDouble);`
`481`		`- CompartmentDoubleSingleByte._SetCompartmentBOOL(isDouble ? FALSE : TRUE);`
	`481`	`+ CompartmentDoubleSingleByte._SetCompartmentBOOL(!isDouble);`
`482`	`482`	`*pIsEaten = TRUE;`
`483`	`483`	`}`
`484`	`484`	`else if (IsEqualGUID(rguid, _PreservedKey_Punctuation.Guid))`
`485`	`485`	`{`
`486`		`- BOOL isPunctuation = FALSE;`
	`486`	`+ bool isPunctuation = false;`
`487`	`487`	`CCompartment CompartmentPunctuation(pThreadMgr, tfClientId, SAMPLEIME_GUID_COMPARTMENT_PUNCTUATION);`
`488`	`488`	`CompartmentPunctuation._GetCompartmentBOOL(isPunctuation);`
`489`		`- CompartmentPunctuation._SetCompartmentBOOL(isPunctuation ? FALSE : TRUE);`
	`489`	`+ CompartmentPunctuation._SetCompartmentBOOL(!isPunctuation);`
`490`	`490`	`*pIsEaten = TRUE;`
`491`	`491`	`}`
`492`	`492`	`else`
`@@ -650,44 +650,44 @@ void CCompositionProcessorEngine::ConversionModeCompartmentUpdated(_In_ ITfThrea`
`650`	`650`	`return;`
`651`	`651`	`}`
`652`	`652`
`653`		`- BOOL isDouble = FALSE;`
	`653`	`+ bool isDouble = false;`
`654`	`654`	`CCompartment CompartmentDoubleSingleByte(pThreadMgr, _tfClientId, SAMPLEIME_GUID_COMPARTMENT_DOUBLE_SINGLE_BYTE);`
`655`	`655`	`if (SUCCEEDED(CompartmentDoubleSingleByte._GetCompartmentBOOL(isDouble)))`
`656`	`656`	`{`
`657`	`657`	`if (!isDouble && (conversionMode & TF_CONVERSIONMODE_FULLSHAPE))`
`658`	`658`	`{`
`659`		`- CompartmentDoubleSingleByte._SetCompartmentBOOL(TRUE);`
	`659`	`+ CompartmentDoubleSingleByte._SetCompartmentBOOL(true);`
`660`	`660`	`}`
`661`	`661`	`else if (isDouble && !(conversionMode & TF_CONVERSIONMODE_FULLSHAPE))`
`662`	`662`	`{`
`663`		`- CompartmentDoubleSingleByte._SetCompartmentBOOL(FALSE);`
	`663`	`+ CompartmentDoubleSingleByte._SetCompartmentBOOL(false);`
`664`	`664`	`}`
`665`	`665`	`}`
`666`		`- BOOL isPunctuation = FALSE;`
	`666`	`+ bool isPunctuation = false;`
`667`	`667`	`CCompartment CompartmentPunctuation(pThreadMgr, _tfClientId, SAMPLEIME_GUID_COMPARTMENT_PUNCTUATION);`
`668`	`668`	`if (SUCCEEDED(CompartmentPunctuation._GetCompartmentBOOL(isPunctuation)))`
`669`	`669`	`{`
`670`	`670`	`if (!isPunctuation && (conversionMode & TF_CONVERSIONMODE_SYMBOL))`
`671`	`671`	`{`
`672`		`- CompartmentPunctuation._SetCompartmentBOOL(TRUE);`
	`672`	`+ CompartmentPunctuation._SetCompartmentBOOL(true);`
`673`	`673`	`}`
`674`	`674`	`else if (isPunctuation && !(conversionMode & TF_CONVERSIONMODE_SYMBOL))`
`675`	`675`	`{`
`676`		`- CompartmentPunctuation._SetCompartmentBOOL(FALSE);`
	`676`	`+ CompartmentPunctuation._SetCompartmentBOOL(false);`
`677`	`677`	`}`
`678`	`678`	`}`
`679`	`679`
`680`		`- BOOL fOpen = FALSE;`
	`680`	`+ bool fOpen = false;`
`681`	`681`	`CCompartment CompartmentKeyboardOpen(pThreadMgr, _tfClientId, GUID_COMPARTMENT_KEYBOARD_OPENCLOSE);`
`682`	`682`	`if (SUCCEEDED(CompartmentKeyboardOpen._GetCompartmentBOOL(fOpen)))`
`683`	`683`	`{`
`684`	`684`	`if (fOpen && !(conversionMode & TF_CONVERSIONMODE_NATIVE))`
`685`	`685`	`{`
`686`		`- CompartmentKeyboardOpen._SetCompartmentBOOL(FALSE);`
	`686`	`+ CompartmentKeyboardOpen._SetCompartmentBOOL(false);`
`687`	`687`	`}`
`688`	`688`	`else if (!fOpen && (conversionMode & TF_CONVERSIONMODE_NATIVE))`
`689`	`689`	`{`
`690`		`- CompartmentKeyboardOpen._SetCompartmentBOOL(TRUE);`
	`690`	`+ CompartmentKeyboardOpen._SetCompartmentBOOL(true);`
`691`	`691`	`}`
`692`	`692`	`}`
`693`	`693`	`}`
`@@ -714,7 +714,7 @@ void CCompositionProcessorEngine::PrivateCompartmentsUpdated(_In_ ITfThreadMgr *`
`714`	`714`
`715`	`715`	`conversionModePrev = conversionMode;`
`716`	`716`
`717`		`- BOOL isDouble = FALSE;`
	`717`	`+ bool isDouble = false;`
`718`	`718`	`CCompartment CompartmentDoubleSingleByte(pThreadMgr, _tfClientId, SAMPLEIME_GUID_COMPARTMENT_DOUBLE_SINGLE_BYTE);`
`719`	`719`	`if (SUCCEEDED(CompartmentDoubleSingleByte._GetCompartmentBOOL(isDouble)))`
`720`	`720`	`{`
`@@ -728,7 +728,7 @@ void CCompositionProcessorEngine::PrivateCompartmentsUpdated(_In_ ITfThreadMgr *`
`728`	`728`	`}`
`729`	`729`	`}`
`730`	`730`
`731`		`- BOOL isPunctuation = FALSE;`
	`731`	`+ bool isPunctuation = false;`
`732`	`732`	`CCompartment CompartmentPunctuation(pThreadMgr, _tfClientId, SAMPLEIME_GUID_COMPARTMENT_PUNCTUATION);`
`733`	`733`	`if (SUCCEEDED(CompartmentPunctuation._GetCompartmentBOOL(isPunctuation)))`
`734`	`734`	`{`
`@@ -770,7 +770,7 @@ void CCompositionProcessorEngine::KeyboardOpenCompartmentUpdated(_In_ ITfThreadM`
`770`	`770`
`771`	`771`	`conversionModePrev = conversionMode;`
`772`	`772`
`773`		`- BOOL isOpen = FALSE;`
	`773`	`+ bool isOpen = false;`
`774`	`774`	`CCompartment CompartmentKeyboardOpen(pThreadMgr, _tfClientId, GUID_COMPARTMENT_KEYBOARD_OPENCLOSE);`
`775`	`775`	`if (SUCCEEDED(CompartmentKeyboardOpen._GetCompartmentBOOL(isOpen)))`
`776`	`776`	`{`
Original file line number	Diff line number	Diff line change
`@@ -361,10 +361,10 @@ STDAPI CLangBarItemButton::OnClick(TfLBIClick click, POINT pt, _In_ const RECT *`
`361`	`361`	`click;pt;`
`362`	`362`	`prcArea;`
`363`	`363`
`364`		`- BOOL isOn = FALSE;`
	`364`	`+ bool isOn = false;`
`365`	`365`
`366`	`366`	`_pCompartment->_GetCompartmentBOOL(isOn);`
`367`		`- _pCompartment->_SetCompartmentBOOL(isOn ? FALSE : TRUE);`
	`367`	`+ _pCompartment->_SetCompartmentBOOL(!isOn);`
`368`	`368`
`369`	`369`	`return S_OK;`
`370`	`370`	`}`
`@@ -403,7 +403,7 @@ STDAPI CLangBarItemButton::OnMenuSelect(UINT wID)`
`403`	`403`
`404`	`404`	`STDAPI CLangBarItemButton::GetIcon(_Out_ HICON *phIcon)`
`405`	`405`	`{`
`406`		`- BOOL isOn = FALSE;`
	`406`	`+ bool isOn = false;`
`407`	`407`
`408`	`408`	`if (!_pCompartment)`
`409`	`409`	`{`