bug(windows): If alternative TIPs are installed, Keyman may fail to activate on first use

[mcdurdin]

Describe the bug

If alternative TIPs such as speech recognition are installed, Keyman may fail to start on first use in a newly started application. Switching the keyboard off and on again will normally work around this.

This issue was first noted in diagnostic investigation at https://community.software.sil.org/t/keyboard-shows-as-on-but-doesnt-work-until-it-is-turned-off-and-on-again/4336

The problem relates to function STDAPI CKMTipTextService::OnActivated(REFCLSID clsid, REFGUID guidProfile, BOOL fActivated) in tmgrsink.cpp:

keyman/windows/src/engine/kmtip/tmgrsink.cpp

Lines 150 to 172 in 03c230c

	STDAPI CKMTipTextService::OnActivated(REFCLSID clsid, REFGUID guidProfile, BOOL fActivated) // I3581
	{
	LogEnter();
	guidActiveProfile = GUID_NULL; // I4274
	if(IsEqualGUID(clsid, c_clsidKMTipTextService))
	{
	SendDebugMessageFormat(L"CKMTipTextService::OnActivated(c_clsidKMTipTextService, <GUID>, %d)", fActivated);
	if(fActivated) {
	guidActiveProfile = guidProfile;
	TIPNotifyActivate((GUID *)&guidProfile);
	}
	else TIPNotifyActivate(NULL);
	// --> go it!
	}
	else {
	SendDebugMessageFormat(L"CKMTipTextService::OnActivated(<other-GUID>, <GUID>, %d)", fActivated);
	TIPNotifyActivate(NULL);
	}
	return S_OK;
	}

If a non-keyboard TIP is activated, then we should be detecting that on line 167 above and ignoring the activation. Only if a keyboard-type TIP is activated should we be deactivating Keyman.

To Reproduce

Installing speech recognition may trigger this behaviour but that may not be deterministic if the activation order differs.

---

Keyman for Windows/macOS/Linux:

• OS: Windows 10
• Keyman version: 14.0.271
• Target Application: any

[mcdurdin]

Note that despite the fActivated flag being passed, it seems that this function is only ever called on activation, not on deactivation -- the logs never show any fActivated == 0.