Merge 468d002 into c00a14f

LeonarddeR · web-flow · commit a318b80cac74 · 2025-02-15T10:59:23.000Z
diff --git a/source/config/configSpec.py b/source/config/configSpec.py
@@ -27,6 +27,7 @@
 	#possible log levels are DEBUG, IO, DEBUGWARNING, INFO
 	loggingLevel = string(default="INFO")
 	showWelcomeDialogAtStartup = boolean(default=true)
+	preventDisplayTurnOff = featureFlag(optionsEnum="BoolFlag", behaviorOfDefault="enabled")
 
 # Speech settings
 [speech]
diff --git a/source/gui/settingsDialogs.py b/source/gui/settingsDialogs.py
@@ -983,6 +983,19 @@ def makeSettings(self, settingsSizer):
 			if globalVars.appArgs.secure:
 				mirrorBox.Disable()
 
+		self.preventDisplayTurnOffCombo: nvdaControls.FeatureFlagCombo = (
+			settingsSizerHelper.addLabeledControl(
+				labelText=_(
+					# Translators: This is a label for a combo-box in the general settings panel.
+					"Prevent &display from turning off during say all or reading with braille",
+				),
+				wxCtrlClass=nvdaControls.FeatureFlagCombo,
+				keyPath=["general", "preventDisplayTurnOff"],
+				conf=config.conf,
+			)
+		)
+		self.bindHelpEvent("PreventDisplayTurnOff", self.preventDisplayTurnOffCombo)
+
 	def onChangeMirrorURL(self, evt: wx.CommandEvent | wx.KeyEvent):
 		"""Show the dialog to change the update mirror URL, and refresh the dialog in response to the URL being changed."""
 		# Import late to avoid circular dependency.
@@ -1104,6 +1117,8 @@ def onSave(self):
 			updateCheck.terminate()
 			updateCheck.initialize()
 
+		self.preventDisplayTurnOffCombo.saveCurrentValueToConf()
+
 	def onPanelActivated(self):
 		if updateCheck:
 			self._updateCurrentMirrorURL()
diff --git a/source/inputCore.py b/source/inputCore.py
@@ -1,7 +1,7 @@
 # A part of NonVisual Desktop Access (NVDA)
 # This file is covered by the GNU General Public License.
 # See the file COPYING for more details.
-# Copyright (C) 2010-2023 NV Access Limited, Babbage B.V., Mozilla Corporation, Cyrille Bougot,
+# Copyright (C) 2010-2025 NV Access Limited, Babbage B.V., Mozilla Corporation, Cyrille Bougot,
 # Leonard de Ruijter
 
 """Core framework for handling input from the user.
@@ -36,12 +36,12 @@
 import characterProcessing
 import config
 from fileUtils import FaultTolerantFile
+import systemUtils
 import watchdog
 from logHandler import log
 import globalVars
 import languageHandler
 import controlTypes
-import winKernel
 import extensionPoints
 from NVDAState import WritePaths
 
@@ -577,7 +577,7 @@ def suppressCancelSpeech():
 			)
 
 		if gesture.shouldPreventSystemIdle:
-			winKernel.SetThreadExecutionState(winKernel.ES_SYSTEM_REQUIRED)
+			systemUtils.preventSystemIdle()
 
 		if log.isEnabledFor(log.IO) and not gesture.isModifier:
 			self._lastInputTime = time.time()
diff --git a/source/speech/sayAll.py b/source/speech/sayAll.py
@@ -1,8 +1,8 @@
 # A part of NonVisual Desktop Access (NVDA)
 # This file is covered by the GNU General Public License.
 # See the file COPYING for more details.
-# Copyright (C) 2006-2024 NV Access Limited, Peter Vágner, Aleksey Sadovoy, Babbage B.V., Bill Dengler,
-# Julien Cochuyt, Cyrille Bougot
+# Copyright (C) 2006-2025 NV Access Limited, Peter Vágner, Aleksey Sadovoy, Babbage B.V., Bill Dengler,
+# Julien Cochuyt, Cyrille Bougot, Leonard de Ruijter
 
 from abc import ABCMeta, abstractmethod
 from enum import IntEnum
@@ -13,9 +13,9 @@
 import config
 import controlTypes
 import api
+import systemUtils
 import textInfos
 import queueHandler
-import winKernel
 from utils.security import objectBelowLockScreenAndWindowsIsLocked
 
 from .commands import CallbackCommand, EndUtteranceCommand
@@ -137,12 +137,33 @@ def readText(
 			log.debugWarning("Unable to make reader", exc_info=True)
 			return
 		self._getActiveSayAll = weakref.ref(reader)
-		reader.nextLine()
+		reader.next()
 
 
-class _ObjectsReader(garbageHandler.TrackedObject):
-	def __init__(self, handler: _SayAllHandler, root: "NVDAObjects.NVDAObject"):
+class _Reader(garbageHandler.TrackedObject, metaclass=ABCMeta):
+	"""Base class for readers in say all."""
+
+	def __init__(self, handler: _SayAllHandler):
 		self.handler = handler
+		systemUtils.preventSystemIdle(persistent=True)
+
+	@abstractmethod
+	def next(self): ...
+
+	@abstractmethod
+	def stop(self):
+		"""Stops the reader."""
+		systemUtils.resetThreadExecutionState()
+
+	def __del__(self):
+		self.stop()
+
+
+class _ObjectsReader(_Reader):
+	"""Manages continuous reading of objects."""
+
+	def __init__(self, handler: _SayAllHandler, root: "NVDAObjects.NVDAObject"):
+		super().__init__(handler)
 		self.walker = self.walk(root)
 		self.prevObj = None
 
@@ -165,7 +186,6 @@ def next(self):
 				isFocus=self.handler.lastSayAllMode == CURSOR.CARET,
 			):
 				return
-			winKernel.SetThreadExecutionState(winKernel.ES_SYSTEM_REQUIRED)
 		# Move onto the next object.
 		self.prevObj = obj = next(self.walker, None)
 		if not obj:
@@ -179,10 +199,13 @@ def next(self):
 		)
 
 	def stop(self):
+		if not self.walker:
+			return
 		self.walker = None
+		super().stop()
 
 
-class _TextReader(garbageHandler.TrackedObject, metaclass=ABCMeta):
+class _TextReader(_Reader):
 	"""Manages continuous reading of text.
 	This is intended for internal use only.
 
@@ -207,7 +230,7 @@ class _TextReader(garbageHandler.TrackedObject, metaclass=ABCMeta):
 
 	def __init__(self, handler: _SayAllHandler):
 		self.reader = None
-		self.handler = handler
+		super().__init__(handler)
 		self.trigger = SayAllProfileTrigger()
 		self.reader = self.getInitialTextInfo()
 		# #10899: SayAll profile can't be activated earlier because they may not be anything to read
@@ -263,6 +286,9 @@ def collapseLineImpl(self) -> bool:
 			self.finish()
 			return False
 
+	def next(self):
+		self.nextLine()
+
 	def nextLine(self):
 		if not self.reader:
 			log.debug("no self.reader")
@@ -339,7 +365,6 @@ def lineReached(self, obj, bookmark, state):
 		state.updateObj()
 		updater = obj.makeTextInfo(bookmark)
 		self.updateCaret(updater)
-		winKernel.SetThreadExecutionState(winKernel.ES_SYSTEM_REQUIRED)
 		if self.numBufferedLines == 0:
 			# This was the last line spoken, so move on.
 			self.nextLine()
@@ -378,9 +403,7 @@ def stop(self):
 		self.reader = None
 		self.trigger.exit()
 		self.trigger = None
-
-	def __del__(self):
-		self.stop()
+		super().stop()
 
 
 class _CaretTextReader(_TextReader):
diff --git a/source/systemUtils.py b/source/systemUtils.py
@@ -1,6 +1,5 @@
-# -*- coding: UTF-8 -*-
 # A part of NonVisual Desktop Access (NVDA)
-# Copyright (C) 2020-2025 NV Access Limited, Łukasz Golonka, Luke Davis
+# Copyright (C) 2020-2025 NV Access Limited, Łukasz Golonka, Luke Davis, Leonard de Ruijter
 # This file may be used under the terms of the GNU General Public License, version 2 or later.
 # For more details see: https://www.gnu.org/licenses/gpl-2.0.html
 
@@ -246,3 +245,27 @@ def run(self):
 		except Exception as e:
 			self.threadExc = e
 			log.debugWarning("task had errors", exc_info=True)
+
+
+def preventSystemIdle(preventDisplayTurnOff: bool | None = None, persistent: bool = False) -> None:
+	"""
+	Prevent the system from locking the screen or going to sleep.
+	:param preventDisplayTurnOff: If `True`, keep the display awake as well.
+		if `False`, only avoid system sleep.
+		if `None`, the general setting "prevent display turn off" will be used.
+	:param persistent: If `True`, the state will be maintained until calling :func:`resetThreadExecutionState` is called.
+	"""
+	if preventDisplayTurnOff is None:
+		import config
+
+		preventDisplayTurnOff = bool(config.conf["general"]["preventDisplayTurnOff"])
+	windll.kernel32.SetThreadExecutionState(
+		winKernel.ES_SYSTEM_REQUIRED
+		| (winKernel.ES_DISPLAY_REQUIRED if preventDisplayTurnOff else 0)
+		| (winKernel.ES_CONTINUOUS if persistent else 0),
+	)
+
+
+def resetThreadExecutionState() -> None:
+	"""Reset the thread execution state to the default."""
+	windll.kernel32.SetThreadExecutionState(winKernel.ES_CONTINUOUS)
diff --git a/user_docs/en/changes.md b/user_docs/en/changes.md
@@ -36,6 +36,9 @@ As a consequence, announcement of first line indent is now supported for LibreOf
 * In Word, the selection update is now reported when using Word commands to extend or reduce the selection (`f8` or `shift+f8`). (#3293, @CyrilleB79)
 * In Microsoft Word 16.0.18226 and higher or when using Word object model, NVDA will now report if a heading is collapsed in both speech and braille. (#17499)
 * NVDA is now able to report caret changes when pressing `alt+upArrow` or `alt+downArrow` gestures, for example in Visual Studio. (#17652, @LeonarddeR)
+* Added a general setting to prevent the display turning off during say all or reading with braille.
+This option is enabled by default, but can possibly result in shorter battery life.
+If you suspect this option is negatively impacting your battery life, you're advised to disable it. (#17649, @LeonarddeR)
 * Rate boost is now supported when using Microsoft Speech API version 5 (SAPI5) and Microsoft Speech Platform voices, which supports up to 6X speed. (#17606, @gexgd0419)
 
 ### Changes
diff --git a/user_docs/en/userGuide.md b/user_docs/en/userGuide.md
@@ -1846,6 +1846,18 @@ If you wish to change the update mirror, press the "Change..." button to open th
 Please note that when using an update mirror, the operator of the mirror has access to all [information sent with update checks](#GeneralSettingsCheckForUpdates).
 Contact the operator of the update mirror for details of their data handling policies to ensure you are comfortable with the way your information will be handled before setting an update mirror.
 
+##### Prevent display from turning off during say all or reading with braille {#PreventDisplayTurnOff}
+
+This option ensures that the display stays on when reading with say all or with braille (e.g. when pressing scroll buttons).
+This avoids the situation where the screen unexpectedly locks during a say all.
+This option is enabled by default.
+Consider disabling this option if you are suffering from a shorter battery life.
+
+| . {.hideHeaderRow} |.|
+|---|---|
+|Options |Default (Enabled), Disabled, Enabled|
+|Default |Enabled|
+
 #### Speech Settings {#SpeechSettings}
 
 <!-- KC:setting -->
