Merge 5d9b8cc into 3f89b60

SamKacer · web-flow · commit 227442160267 · 2023-06-27T19:38:20.000+01:00
diff --git a/source/config/configSpec.py b/source/config/configSpec.py
@@ -212,6 +212,7 @@
 	reportLineNumber = boolean(default=False)
 	# 0: Off, 1: Speech, 2: Tones, 3: Both Speech and Tones
 	reportLineIndentation = integer(0, 3, default=0)
+	ignoreBlankLinesForReportLineIndentation = boolean(default=False)^M                                             
 	reportParagraphIndentation = boolean(default=False)
 	reportTables = boolean(default=true)
 	includeLayoutTables = boolean(default=False)
diff --git a/source/globalCommands.py b/source/globalCommands.py
@@ -273,7 +273,7 @@ def script_reportCurrentSelection(self,gesture):
 			speech.speakMessage(_("No selection"))
 		else:
 			speech.speakTextSelected(info.text)
-
+
 	@script(
 		# Translators: Input help mode message for report date and time command.
 		description=_("If pressed once, reports the current time. If pressed twice, reports the current date"),
@@ -622,6 +622,21 @@ def script_toggleReportLineIndentation(self, gesture: inputCore.InputGesture):
 		# {mode} will be replaced with the mode; i.e. Off, Speech, Tones or Both Speech and Tones.
 		ui.message(_("Report line indentation {mode}").format(mode=state.displayString))
 
+	@script(
+		# Translators: Input help mode message for toggle ignore blank lines for line indentation reporting command.
+		description=_("Toggles on and off the ignoring of blank lines for line indentation reporting"),
+		category=SCRCAT_DOCUMENTFORMATTING
+	)
+	def script_toggleignoreBlankLinesForReportLineIndentation(self,gesture: inputCore.InputGesture) -> None:
+		ignore = config.conf['documentFormatting']['ignoreBlankLinesForReportLineIndentation']
+		config.conf['documentFormatting']['ignoreBlankLinesForReportLineIndentation'] = not ignore
+		if ignore:
+			# Translators: The message announced when toggling off the ignore blank lines for line indentation reporting document formatting setting.
+			ui.message(_("Ignore blank lines for line indentation reporting off"))
+		else:
+			# Translators: The message announced when toggling on the ignore blank lines for line indentation reporting document formatting setting.
+			ui.message(_("Ignore blank lines for line indentation reporting on"))
+
 	@script(
 		# Translators: Input help mode message for toggle report paragraph indentation command.
 		description=_("Toggles on and off the reporting of paragraph indentation"),
diff --git a/source/gui/settingsDialogs.py b/source/gui/settingsDialogs.py
@@ -2389,15 +2389,22 @@ def makeSettings(self, settingsSizer):
 			self.lineIndentationCombo
 		)
 		self.lineIndentationCombo.SetSelection(config.conf['documentFormatting']['reportLineIndentation'])
+
+		# Translators: This is the label of a checkbox in the document formatting settings panel
+		# If this option is selected, NVDA will ignore blank lines for line indentation reporting
+		ignoreBlankLinesText = _("Ignore &blank lines for line indentation reporting")
+		ignoreBlankLinesCheckBox = wx.CheckBox(pageAndSpaceBox, label=ignoreBlankLinesText)
+		self.ignoreBlankLinesForReportLineIndentationCheckbox = pageAndSpaceGroup.addItem(ignoreBlankLinesCheckBox)
+		self.ignoreBlankLinesForReportLineIndentationCheckbox.SetValue(config.conf["documentFormatting"]["ignoreBlankLinesForReportLineIndentation"])
 		
-		# Translators: This message is presented in the document formatting settings panelue
+		# Translators: This message is presented in the document formatting settings panel
 		# If this option is selected, NVDA will report paragraph indentation if available. 
 		paragraphIndentationText = _("&Paragraph indentation")
 		_paragraphIndentationCheckBox = wx.CheckBox(pageAndSpaceBox, label=paragraphIndentationText)
 		self.paragraphIndentationCheckBox = pageAndSpaceGroup.addItem(_paragraphIndentationCheckBox)
 		self.paragraphIndentationCheckBox.SetValue(config.conf["documentFormatting"]["reportParagraphIndentation"])
 
-		# Translators: This message is presented in the document formatting settings panelue
+		# Translators: This message is presented in the document formatting settings panel
 		# If this option is selected, NVDA will report line spacing if available. 
 		lineSpacingText=_("&Line spacing")
 		_lineSpacingCheckBox = wx.CheckBox(pageAndSpaceBox, label=lineSpacingText)
@@ -2541,6 +2548,7 @@ def onSave(self):
 		config.conf["documentFormatting"]["reportPage"]=self.pageCheckBox.IsChecked()
 		config.conf["documentFormatting"]["reportLineNumber"]=self.lineNumberCheckBox.IsChecked()
 		config.conf["documentFormatting"]["reportLineIndentation"] = self.lineIndentationCombo.GetSelection()
+		config.conf["documentFormatting"]["ignoreBlankLinesForReportLineIndentation"]=self.ignoreBlankLinesForReportLineIndentationCheckbox.IsChecked()
 		config.conf["documentFormatting"]["reportParagraphIndentation"]=self.paragraphIndentationCheckBox.IsChecked()
 		config.conf["documentFormatting"]["reportLineSpacing"]=self.lineSpacingCheckBox.IsChecked()
 		config.conf["documentFormatting"]["reportTables"]=self.tablesCheckBox.IsChecked()
diff --git a/source/speech/speech.py b/source/speech/speech.py
@@ -1540,7 +1540,17 @@ def getTextInfoSpeech(  # noqa: C901
 				if autoLanguageSwitching and newLanguage!=lastLanguage:
 					relativeSpeechSequence.append(LangChangeCommand(newLanguage))
 					lastLanguage=newLanguage
-	if reportIndentation and speakTextInfoState and allIndentation!=speakTextInfoState.indentationCache:
+	if (
+		reportIndentation 
+		and speakTextInfoState 
+		and(
+			# either not ignoring blank lines
+			not formatConfig['ignoreBlankLinesForReportLineIndentation']
+			# or line isn't completely blank
+			or any(isinstance(t, str) and not all(c in LINE_END_CHARS for c in t) for t in textWithFields)
+		)
+		and allIndentation!=speakTextInfoState.indentationCache
+	):
 		indentationSpeech=getIndentationSpeech(allIndentation, formatConfig)
 		if autoLanguageSwitching and speechSequence[-1].lang is not None:
 			# Indentation must be spoken in the default language,
@@ -1604,6 +1614,10 @@ def getTextInfoSpeech(  # noqa: C901
 	return True
 
 
+# for checking a line is completely blank, i.e. doesn't even contain spaces
+LINE_END_CHARS = frozenset(( '\r', '\n' ))
+
+
 def _isControlEndFieldCommand(command: Union[str, textInfos.FieldCommand]):
 	return isinstance(command, textInfos.FieldCommand) and command.command == "controlEnd"
 
diff --git a/user_docs/en/userGuide.t2t b/user_docs/en/userGuide.t2t
@@ -2076,6 +2076,7 @@ You can configure reporting of:
  - Page numbers
  - Line numbers
  - Line indentation reporting [(Off, Speech, Tones, Both Speech and Tones) #DocumentFormattingSettingsLineIndentation]
+ - Ignore blank lines for line indentation reporting
  - Paragraph indentation (e.g. hanging indent, first line indent)
  - Line spacing (single, double, etc.)
  - Alignment
@@ -2118,6 +2119,9 @@ The tone will increase in pitch every space, and for a tab, it will increase in
 - Both Speech and Tones: This option reads indentation using both of the above methods.
 -
 
+If you tick the "Ignore blank lines for line indentation reporting" checkbox, then indentation changes won't be reported for blank lines.
+This may be useful when reading a document where blank lines are used to separate indented bloks of text, such as in programming source code.
+
 +++ Document Navigation +++[DocumentNavigation]
 This category allows you to adjust various aspects of document navigation.
 
