Merge 0976433 into 544ccb1

Author: SaschaCowley

source/braille.py

@@ -45,6 +45,7 @@
 	TetherTo,
 	BrailleMode,
 	ReportTableHeaders,
+	OutputMode,
 )
 from config.featureFlagEnums import ReviewRoutingMovesSystemCaretFlag
 from logHandler import log
@@ -1148,7 +1149,7 @@ def _setCursor(self, info: textInfos.TextInfo):
 
 	def _getTypeformFromFormatField(self, field, formatConfig):
 		typeform = louis.plain_text
-		if not formatConfig["reportFontAttributes"]:
+		if not formatConfig["reportFontAttributes"] & OutputMode.BRAILLE:
 			return typeform
 		if field.get("bold", False):
 			typeform |= louis.bold

source/config/configFlags.py

@@ -220,3 +220,23 @@ def _displayStringLabels(self):
 			# Translators: This is a label for the automatic update behaviour for add-ons.
 			self.DISABLED: _("Disabled"),
 		}
+
+@unique
+class OutputMode(DisplayStringIntEnum):
+	OFF = 0
+	SPEECH = 1
+	BRAILLE = 2
+	SPEECH_AND_BRAILLE = 3
+
+	@property
+	def _displayStringLabels(self):
+		return {
+			# Translators: This is a way of reporting information.
+			self.OFF: _("Off"),
+			# Translators: This is a way of reporting information.
+			self.SPEECH: _("Speech"),
+			# Translators: This is a way of reporting information.
+			self.BRAILLE: _("Braille"),
+			# Translators: This is a way of reporting information.
+			self.SPEECH_AND_BRAILLE: _("Speech and braille"),
+		}

source/config/configSpec.py

@@ -13,7 +13,7 @@
 #: provide an upgrade step (@see profileUpgradeSteps.py). An upgrade step does not need to be added when
 #: just adding a new element to (or removing from) the schema, only when old versions of the config
 #: (conforming to old schema versions) will not work correctly with the new schema.
-latestSchemaVersion = 11
+latestSchemaVersion = 12
 
 #: The configuration specification string
 #: @type: String
@@ -205,7 +205,8 @@
 	detectFormatAfterCursor = boolean(default=false)
 	reportFontName = boolean(default=false)
 	reportFontSize = boolean(default=false)
-	reportFontAttributes = boolean(default=false)
+	# 0: Off, 1: Speech, 2: Braille, 3: Speech and Braille
+	reportFontAttributes = integer(0, 3, default=0)
 	reportRevisions = boolean(default=true)
 	reportEmphasis = boolean(default=false)
 	reportHighlight = boolean(default=true)

source/config/profileUpgradeSteps.py

@@ -22,6 +22,7 @@
 	ReportLineIndentation,
 	ReportTableHeaders,
 	ReportCellBorders,
+	OutputMode,
 )
 import configobj.validate
 from configobj import ConfigObj
@@ -376,3 +377,18 @@ def upgradeConfigFrom_10_to_11(profile: ConfigObj) -> None:
 			"hidBrailleStandard added to braille display auto detection excluded displays. "
 			f"List is now: {profile['braille']['auto']['excludedDisplays']}"
 		)
+
+
+def upgradeConfigFrom_11_to_12(profile: ConfigObj) -> None:
+	"""Convert reportFontAttributes from a boolean to a choice of speech and/or braille."""
+	try:
+		reportFontAttributes: bool = profile["documentFormatting"].as_bool("reportFontAttributes")
+	except KeyError:
+		log.debug("reportFontAttributes not present in config, no action taken.")
+		return
+	except ValueError:
+		log.debug("reportFontAttributes is not a boolean, deleting from config.")
+		del profile["documentFormatting"]["reportFontAttributes"]
+		return
+	profile['documentFormatting']['reportFontAttributes'] = OutputMode.SPEECH_AND_BRAILLE if reportFontAttributes else OutputMode.OFF
+	log.debug(f"documentFormatting.reportFontAttributes converted to {profile['documentFormatting']['reportFontAttributes']}.")

source/globalCommands.py

@@ -44,6 +44,7 @@
 	TetherTo,
 	ShowMessages,
 	BrailleMode,
+	OutputMode,
 )
 from config.featureFlag import FeatureFlag
 from config.featureFlagEnums import BoolFlag
@@ -558,19 +559,26 @@ def script_toggleReportFontSize(self,gesture):
 
 	@script(
 		# Translators: Input help mode message for toggle report font attributes command.
-		description=_("Toggles on and off the reporting of font attributes"),
+		description=_("Toggles between speaking, brailling, speaking and brailling, and not reporting font attributes."),
 		category=SCRCAT_DOCUMENTFORMATTING
 	)
 	def script_toggleReportFontAttributes(self,gesture):
-		if config.conf["documentFormatting"]["reportFontAttributes"]:
-			# Translators: The message announced when toggling the report font attributes document formatting setting.
-			state = _("report font attributes off")
-			config.conf["documentFormatting"]["reportFontAttributes"]=False
-		else:
-			# Translators: The message announced when toggling the report font attributes document formatting setting.
-			state = _("report font attributes on")
-			config.conf["documentFormatting"]["reportFontAttributes"]=True
-		ui.message(state)
+		currentValue = config.conf["documentFormatting"]["reportFontAttributes"]
+		nextValue = OutputMode((currentValue + 1) % len(OutputMode))
+		if nextValue == OutputMode.OFF:
+			# Translators: A state in which font attributes are not reported.
+			status = _("Do not report font attributes")
+		if nextValue == OutputMode.SPEECH:
+			# Translators: A state in which font attributes are only spoken.
+			status = _("Speak font attributes")
+		if nextValue == OutputMode.BRAILLE:
+			# Translators: A state in which font attributes are only brailled.
+			status = _("Braille font attributes")
+		if nextValue == OutputMode.SPEECH_AND_BRAILLE:
+			# Translators: A state in which font attributes are both spoken and brailled.
+			status = _("Speak and braille font attributes")
+		config.conf["documentFormatting"]["reportFontAttributes"]=nextValue
+		ui.message(status)
 
 	@script(
 		# Translators: Input help mode message for toggle superscripts and subscripts command.

source/gui/settingsDialogs.py

@@ -2392,8 +2392,11 @@ def makeSettings(self, settingsSizer):
 		# Translators: This is the label for a checkbox in the
 		# document formatting settings panel.
 		fontAttributesText = _("Font attrib&utes")
-		self.fontAttrsCheckBox = fontGroup.addItem(wx.CheckBox(fontGroupBox, label=fontAttributesText))
-		self.fontAttrsCheckBox.SetValue(config.conf["documentFormatting"]["reportFontAttributes"])
+		from config.configFlags import OutputMode
+		fontAttributesOptions = [i.displayString for i in OutputMode]
+		self.fontAttrsCheckBox = fontGroup.addLabeledControl(fontAttributesText, wx.Choice, choices=fontAttributesOptions)
+		# self.fontAttrsCheckBox = fontGroup.addItem(wx.CheckBox(fontGroupBox, label=fontAttributesText))
+		self.fontAttrsCheckBox.SetSelection(config.conf["documentFormatting"]["reportFontAttributes"])
 
 		# Translators: This is the label for a checkbox in the
 		# document formatting settings panel.
@@ -2657,7 +2660,7 @@ def onSave(self):
 		config.conf["documentFormatting"]["detectFormatAfterCursor"]=self.detectFormatAfterCursorCheckBox.IsChecked()
 		config.conf["documentFormatting"]["reportFontName"]=self.fontNameCheckBox.IsChecked()
 		config.conf["documentFormatting"]["reportFontSize"]=self.fontSizeCheckBox.IsChecked()
-		config.conf["documentFormatting"]["reportFontAttributes"]=self.fontAttrsCheckBox.IsChecked()
+		config.conf["documentFormatting"]["reportFontAttributes"]=self.fontAttrsCheckBox.GetSelection()
 		config.conf["documentFormatting"]["reportSuperscriptsAndSubscripts"] = (
 			self.superscriptsAndSubscriptsCheckBox.IsChecked()
 		)

source/speech/speech.py

@@ -67,6 +67,7 @@
 	ReportLineIndentation,
 	ReportTableHeaders,
 	ReportCellBorders,
+	OutputMode,
 )
 import aria
 from .priorities import Spri
@@ -2717,7 +2718,7 @@ def getFormatFieldSpeech(  # noqa: C901
 				# Translators: Reported when text is no longer marked as emphasised 
 				else _("not emphasised"))
 			textList.append(text)
-	if  formatConfig["reportFontAttributes"]:
+	if  formatConfig["reportFontAttributes"] & OutputMode.SPEECH:
 		bold=attrs.get("bold")
 		oldBold=attrsCache.get("bold") if attrsCache is not None else None
 		if (bold or oldBold is not None) and bold!=oldBold:

tests/unit/test_config.py

@@ -29,13 +29,15 @@
 	_upgradeConfigFrom_8_to_9_showMessages,
 	_upgradeConfigFrom_8_to_9_tetherTo,
 	upgradeConfigFrom_9_to_10,
+	upgradeConfigFrom_11_to_12,
 )
 from config.configFlags import (
 	NVDAKey,
 	ShowMessages,
 	ReportLineIndentation,
 	ReportCellBorders,
 	TetherTo,
+	OutputMode,
 )
 from utils.displayString import (
 	DisplayStringEnum
@@ -782,6 +784,46 @@ def test_ManualProfile_setNumpadInsertFalseExtendedInsertFalse(self):
 			NVDAKey.CAPS_LOCK.value,
 		)
 
+class Config_upgradeProfileSteps_upgradeProfileFrom_11_to_12(unittest.TestCase):
+	def test_DefaultProfile_Unmodified(self):
+		"""reportFontAttributes unmodified."""
+		configString = "[documentFormatting]"
+		profile = _loadProfile(configString)
+		upgradeConfigFrom_11_to_12(profile)
+		with self.assertRaises(KeyError):
+			profile['documentFormatting']['reportFontAttributes']
+	
+	def test_defaultProfile_reportFontAttributes_false(self):
+		"""reportFontAttributes unmodified set to False."""
+		configString = """
+		[documentFormatting]
+		reportFontAttributes = False
+		"""
+		profile = _loadProfile(configString)
+		upgradeConfigFrom_11_to_12(profile)
+		self.assertEqual(profile['documentFormatting']['reportFontAttributes'], OutputMode.OFF.value)
+	
+	def test_defaultProfile_reportFontAttributes_true(self):
+		"""reportFontAttributes set to True."""
+		configString = """
+		[documentFormatting]
+		reportFontAttributes = True
+		"""
+		profile = _loadProfile(configString)
+		upgradeConfigFrom_11_to_12(profile)
+		self.assertEqual(profile['documentFormatting']['reportFontAttributes'], OutputMode.SPEECH_AND_BRAILLE.value)
+
+	def test_defaultProfile_reportFontAttributes_invalid(self):
+		"""reportFontAttributes set to a non-boolean value."""
+		configString = """
+		[documentFormatting]
+		reportFontAttributes = notABool
+		"""
+		profile = _loadProfile(configString)
+		upgradeConfigFrom_11_to_12(profile)
+		with self.assertRaises(KeyError):
+			profile['documentFormatting']['reportFontAttributes']
+
 
 class Config_AggregatedSection_getitem(unittest.TestCase):
 	def setUp(self):