Add an option to use Word's native math speech in Word documents (#19700)

Closes #19670
Summary of the issue:

A bug in Microsoft Word is causing math objects to be spoken inconsistently, sometimes using MathCAT and at other times using Word's native math speech.
Description of user facing changes:

An option is added to the math settings panel to use native math speech while in Word. When checked, MathCAT is disabled while in Word and re-enabled when another application gains focus.
Description of developer facing changes:

N/A
Description of development approach:

    Handlers were added in winword.py for the gainFocus, loseFocus, and terminate events that disable and re-enable MathCAT.
    Two new functions were added to mathPres/__init__.py: disable and enable, which save and restore the three global provider objects.

Author: RyanMcCleary

source/appModules/winword.py

@@ -9,9 +9,11 @@
 """
 
 import appModuleHandler
+import config
 from scriptHandler import script
 import ui
 from logHandler import log
+import mathPres
 from NVDAObjects.IAccessible.winword import WordDocument as IAccessibleWordDocument
 from NVDAObjects.UIA.wordDocument import WordDocument as UIAWordDocument
 from NVDAObjects.window.winword import (
@@ -57,6 +59,17 @@ def chooseNVDAObjectOverlayClasses(self, obj, clsList):
 		if UIAWordDocument in clsList or IAccessibleWordDocument in clsList:
 			clsList.insert(0, WinwordWordDocument)
 
+	def event_appModule_gainFocus(self):
+		if config.conf["math"]["other"]["useWordNativeMath"]:
+			mathPres.terminate()
+
+	def event_appModule_loseFocus(self):
+		mathPres.initialize()
+
+	def terminate(self):
+		mathPres.initialize()
+		super().terminate()
+
 
 class WinwordWordDocument(WordDocument):
 	def _get_description(self) -> str:

source/config/configSpec.py

@@ -525,6 +525,8 @@
 		blockSeparators = string(default=", \u00a0\u202f")
 		# Auto, '.', ',', Custom
 		decimalSeparator = string(default="Auto")
+		# Use native math speech instead of MathCAT in Word and Outlook
+		useWordNativeMath = boolean(default=false)
 
 [screenCurtain]
 	enabled = boolean(default=false)

source/gui/settingsDialogs.py

@@ -2891,6 +2891,14 @@ def makeSettings(self, settingsSizer: wx.BoxSizer) -> None:
 		else:
 			self.navSpeechList.SetSelection(0)
 
+		# Translators: label for checkbox to use native math speech instead of MathCAT in Word and Outlook
+		useWordNativeMathText = pgettext("math", "Use native math speech in Word and Outlook")
+		self.useWordNativeMathCheckBox = speechGroup.addItem(
+			wx.CheckBox(speechGroupBox, label=useWordNativeMathText),
+		)
+		self.bindHelpEvent("MathUseWordNative", self.useWordNativeMathCheckBox)
+		self.useWordNativeMathCheckBox.SetValue(config.conf["math"]["other"]["useWordNativeMath"])
+
 		# Translators: Text for the navigation group.
 		navGroupText = pgettext("math", "Navigation")
 		navGroupSizer = wx.StaticBoxSizer(wx.VERTICAL, self, label=navGroupText)
@@ -3080,6 +3088,7 @@ def onSave(self):
 		)
 		selectedBrailleIndex = self.brailleMathCodeList.GetSelection()
 		mathConf["braille"]["brailleCode"] = self._brailleCodeIds[selectedBrailleIndex]
+		mathConf["other"]["useWordNativeMath"] = self.useWordNativeMathCheckBox.GetValue()
 		mcPrefs = MathCATUserPreferences.fromNVDAConfig()
 		mcPrefs.apply()
 

source/mathPres/__init__.py

@@ -79,6 +79,14 @@ def registerProvider(
 		interactionProvider = provider
 
 
+def terminate() -> None:
+	"""Terminate the mathPres module."""
+	global speechProvider, brailleProvider, interactionProvider
+	speechProvider = None
+	brailleProvider = None
+	interactionProvider = None
+
+
 def initialize() -> None:
 	# Register builtin providers if a plugin hasn't registered others.
 	if not speechProvider or not brailleProvider or not interactionProvider:

user_docs/en/userGuide.md

@@ -3329,6 +3329,15 @@ Whether to speak the expression after moving to it or give an overview.
 | Options | Speak, Describe overview |
 | Default | Speak |
 
+###### Use native math speech in Word and Outlook {#MathUseWordNative}
+
+When enabled, NVDA uses Microsoft Word's built-in math presentation (speech, braille, and interaction) instead of MathCAT when reading and interacting with equations in Word documents.
+
+| . {.hideHeaderRow} | . |
+|---|---|
+| Options | Checked, Unchecked |
+| Default | Unchecked |
+
 ##### Navigation Options {#MathNavigation}
 
 ###### Default navigation mode {#MathNavMode}