Merge e28d007 into 23b4992

SamKacer · web-flow · commit 85bf451aa577 · 2023-06-26T21:17:55.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/gui/settingsDialogs.py b/source/gui/settingsDialogs.py
@@ -2389,6 +2389,13 @@ 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
 		# If this option is selected, NVDA will report paragraph indentation if available. 
@@ -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 identically indented bloks of text, such as in programming source code.
+
 +++ Document Navigation +++[DocumentNavigation]
 This category allows you to adjust various aspects of document navigation.
 
