Merge branch 'master' into addonChangelog

Author: nvdaes

.github/workflows/testAndPublish.yml

@@ -500,10 +500,13 @@ jobs:
     # Used to protect branches/tags as a general status check so we can check a single job for all rulesets.
     name: Check if all tests pass
     runs-on: ubuntu-latest
+    if: always()
     needs: [buildNVDA, typeCheck, checkPo, checkPot, licenseCheck, unitTests, createLauncher, systemTests, createSymbols]
     steps:
     - name: Check if all tests pass
-      run: echo "All tests passed successfully."
+      uses: re-actors/[email protected]
+      with:
+        jobs: ${{ toJSON(needs) }}
 
   uploadSymbols:
     name: Upload symbols

source/IAccessibleHandler/__init__.py

@@ -23,7 +23,6 @@
 import weakref
 from ctypes import (
 	wintypes,
-	windll,
 	byref,
 	c_void_p,
 	c_char,
@@ -1307,6 +1306,6 @@ def isMarshalledIAccessible(IAccessibleObject):
 		.contents.value
 	)
 	handle = HANDLE()
-	windll.kernel32.GetModuleHandleExW(6, addr, byref(handle))
+	winBindings.kernel32.GetModuleHandleEx(6, addr, byref(handle))
 	winBindings.kernel32.GetModuleFileName(handle, buf, 1024)
 	return not buf.value.lower().endswith("oleacc.dll")

source/NVDAHelper/__init__.py

@@ -606,7 +606,7 @@ def nvdaControllerInternal_inputLangChangeNotify(threadID, hkl, layoutString):
 	import ui
 
 	buf = create_unicode_buffer(1024)
-	res = windll.kernel32.GetLocaleInfoW(languageID, 2, buf, 1024)
+	res = winBindings.kernel32.GetLocaleInfo(languageID, 2, buf, 1024)
 	# Translators: the label for an unknown language when switching input methods.
 	inputLanguageName = buf.value if res else _("unknown language")
 	layoutStringCodes = []

source/NVDAObjects/IAccessible/winword.py

@@ -4,10 +4,10 @@
 # See the file COPYING for more details.
 
 from comtypes import COMError
-import ctypes
 import operator
 import uuid
 from logHandler import log
+import winBindings.kernel32
 from winBindings import user32
 import speech
 import controlTypes
@@ -585,7 +585,7 @@ def event_gainFocus(self):
 			return
 		document = next((x for x in self.children if isinstance(x, WordDocument)), None)
 		if document:
-			curThreadID = ctypes.windll.kernel32.GetCurrentThreadId()
+			curThreadID = winBindings.kernel32.GetCurrentThreadId()
 			user32.AttachThreadInput(curThreadID, document.windowThreadID, True)
 			user32.SetFocus(document.windowHandle)
 			user32.AttachThreadInput(curThreadID, document.windowThreadID, False)

source/UIAHandler/__init__.py

@@ -6,7 +6,6 @@
 import ctypes
 import ctypes.wintypes
 from ctypes import (
-	windll,
 	POINTER,
 	CFUNCTYPE,  # noqa: F401
 	c_voidp,  # noqa: F401
@@ -456,7 +455,7 @@ def terminate(self):
 
 		# Terminate the MTA thread
 		MTAThreadHandle = ctypes.wintypes.HANDLE(
-			windll.kernel32.OpenThread(
+			winBindings.kernel32.OpenThread(
 				winKernel.SYNCHRONIZE,
 				False,
 				self.MTAThread.ident,

source/addonAPIVersion.py

@@ -6,7 +6,7 @@
 
 import buildVersion
 import re
-from logHandler import log
+
 
 """
 This module contains add-on API version information for this build of NVDA. This file provides information on
@@ -83,5 +83,7 @@ def formatForGUI(versionTuple: AddonApiVersionT) -> str:
 		# than an exception and unusable dialog.
 		# Translators: shown when an addon API version string is unknown
 		default = _("unknown")
+		from logHandler import log
+
 		log.error("Unable to format versionTuple: {}".format(repr(versionTuple)), exc_info=True)
 		return default

source/addonHandler/__init__.py

@@ -34,7 +34,7 @@
 import config
 import languageHandler
 from logHandler import log
-import winKernel
+import winBindings.kernel32
 import addonAPIVersion
 import importlib
 import NVDAState
@@ -950,7 +950,8 @@ def extract(self, addonPath: Optional[str] = None):
 					# #2505: Handle non-Unicode file names.
 					# Most archivers seem to use the local OEM code page, even though the spec says only cp437.
 					# HACK: Overriding info.filename is a bit ugly, but it avoids a lot of code duplication.
-					info.filename = info.filename.decode("cp%d" % winKernel.kernel32.GetOEMCP())
+					oemcp = winBindings.kernel32.GetOEMCP()
+					info.filename = info.filename.decode(f"cp{oemcp}")
 				z.extract(info, addonPath)
 
 	@property

source/appModuleHandler.py

@@ -16,13 +16,13 @@
 import sys
 from types import ModuleType
 from typing import (
-	Any,
 	Dict,
 	List,
 	Optional,
 	Tuple,
 )
 
+import winBindings.kernel32
 import winVersion
 import importlib
 import importlib.util
@@ -32,7 +32,6 @@
 import baseObject
 from logHandler import log
 import NVDAHelper
-import NVDAState
 import winKernel
 import config
 import NVDAObjects  # Catches errors before loading default appModule
@@ -50,6 +49,24 @@
 )
 from comInterfaces import UIAutomationClient as UIA
 import winBindings.rpcrt4
+from utils import _deprecate
+
+
+__getattr__ = _deprecate.handleDeprecations(
+	_deprecate.MovedSymbol(
+		"processEntry32W",
+		"winBindings.kernel32",
+	),
+	_deprecate.MovedSymbol(
+		"_PROCESS_MACHINE_INFORMATION",
+		"winBindings.kernel32",
+	),
+	_deprecate.MovedSymbol(
+		"NVDAProcessID",
+		"globalVars",
+		"appPid",
+	),
+)
 
 
 # Dictionary of processID:appModule pairs used to hold the currently running modules
@@ -69,47 +86,6 @@
 """
 
 
-class processEntry32W(ctypes.Structure):
-	"""See https://learn.microsoft.com/en-us/windows/win32/api/tlhelp32/ns-tlhelp32-processentry32w"""
-
-	_fields_ = [
-		("dwSize", ctypes.wintypes.DWORD),
-		("cntUsage", ctypes.wintypes.DWORD),
-		("th32ProcessID", ctypes.wintypes.DWORD),
-		("th32DefaultHeapID", ctypes.wintypes.PULONG),
-		("th32ModuleID", ctypes.wintypes.DWORD),
-		("cntThreads", ctypes.wintypes.DWORD),
-		("th32ParentProcessID", ctypes.wintypes.DWORD),
-		("pcPriClassBase", ctypes.c_long),
-		("dwFlags", ctypes.wintypes.DWORD),
-		("szExeFile", ctypes.c_wchar * 260),
-	]
-
-
-class _PROCESS_MACHINE_INFORMATION(ctypes.Structure):
-	_fields_ = [
-		("ProcessMachine", ctypes.wintypes.USHORT),
-		("Res0", ctypes.wintypes.USHORT),
-		("MachineAttributes", ctypes.wintypes.DWORD),
-	]
-
-
-def __getattr__(attrName: str) -> Any:
-	"""Module level `__getattr__` used to preserve backward compatibility.
-	The module level variable `NVDAProcessID` is deprecated
-	and usages should be replaced with `globalVars.appPid`.
-	We cannot simply assign the value from `globalVars` to the old attribute
-	since add-ons are initialized before `appModuleHandler`
-	and when `appModuleHandler` was not yet initialized the variable was set to `None`.
-	"""
-	if attrName == "NVDAProcessID" and NVDAState._allowDeprecatedAPI():
-		log.warning("appModuleHandler.NVDAProcessID is deprecated, use globalVars.appPid instead.")
-		if initialize._alreadyInitialized:
-			return globalVars.appPid
-		return None
-	raise AttributeError(f"module {repr(__name__)} has no attribute {repr(attrName)}")
-
-
 def registerExecutableWithAppModule(executableName: str, appModName: str) -> None:
 	"""Registers appModule to be used for a given executable."""
 	_executableNamesToAppModsAddons[executableName] = appModName
@@ -181,17 +157,17 @@ def getAppNameFromProcessID(processID: int, includeExt: bool = False) -> str:
 	"""
 	if processID == globalVars.appPid:
 		return "nvda.exe" if includeExt else "nvda"
-	FSnapshotHandle = winKernel.kernel32.CreateToolhelp32Snapshot(2, 0)
-	FProcessEntry32 = processEntry32W()
-	FProcessEntry32.dwSize = ctypes.sizeof(processEntry32W)
-	ContinueLoop = winKernel.kernel32.Process32FirstW(FSnapshotHandle, ctypes.byref(FProcessEntry32))
+	FSnapshotHandle = winBindings.kernel32.CreateToolhelp32Snapshot(2, 0)
+	FProcessEntry32 = winBindings.kernel32.PROCESSENTRY32W()
+	FProcessEntry32.dwSize = ctypes.sizeof(FProcessEntry32)
+	ContinueLoop = winBindings.kernel32.Process32First(FSnapshotHandle, ctypes.byref(FProcessEntry32))
 	appName = str()
 	while ContinueLoop:
 		if FProcessEntry32.th32ProcessID == processID:
 			appName = FProcessEntry32.szExeFile
 			break
-		ContinueLoop = winKernel.kernel32.Process32NextW(FSnapshotHandle, ctypes.byref(FProcessEntry32))
-	winKernel.kernel32.CloseHandle(FSnapshotHandle)
+		ContinueLoop = winBindings.kernel32.Process32Next(FSnapshotHandle, ctypes.byref(FProcessEntry32))
+	winBindings.kernel32.CloseHandle(FSnapshotHandle)
 	if not includeExt:
 		appName = os.path.splitext(appName)[0].lower()
 	if not appName:
@@ -548,7 +524,7 @@ def _get_processExecutablePath(self) -> str:
 		# Create the buffer to get the executable name
 		exeFileName = ctypes.create_unicode_buffer(ctypes.wintypes.MAX_PATH)
 		length = ctypes.wintypes.DWORD(ctypes.wintypes.MAX_PATH)
-		if not ctypes.windll.Kernel32.QueryFullProcessImageNameW(
+		if not winBindings.kernel32.QueryFullProcessImageName(
 			self.processHandle,
 			0,
 			exeFileName,
@@ -571,10 +547,10 @@ def _getImmersivePackageInfo(self):
 		# Some apps such as File Explorer says it is an immersive process but error 15700 is shown.
 		# Others such as Store version of Office are not truly hosted apps but are distributed via Store.
 		length = ctypes.c_uint()
-		ctypes.windll.kernel32.GetPackageFullName(self.processHandle, ctypes.byref(length), None)
+		winBindings.kernel32.GetPackageFullName(self.processHandle, ctypes.byref(length), None)
 		packageFullName = ctypes.create_unicode_buffer(length.value)
 		if (
-			ctypes.windll.kernel32.GetPackageFullName(
+			winBindings.kernel32.GetPackageFullName(
 				self.processHandle,
 				ctypes.byref(length),
 				packageFullName,
@@ -675,7 +651,7 @@ def _get_appPath(self):
 		"""
 		size = ctypes.wintypes.DWORD(ctypes.wintypes.MAX_PATH)
 		path = ctypes.create_unicode_buffer(size.value)
-		winKernel.kernel32.QueryFullProcessImageNameW(self.processHandle, 0, path, ctypes.byref(size))
+		winBindings.kernel32.QueryFullProcessImageName(self.processHandle, 0, path, ctypes.byref(size))
 		self.appPath = path.value if path else None
 		return self.appPath
 
@@ -691,7 +667,7 @@ def _get_is64BitProcess(self) -> bool:
 			# We need IsWow64Process2 to detect WOW64 on ARM64.
 			processMachine = ctypes.wintypes.USHORT()
 			if (
-				ctypes.windll.kernel32.IsWow64Process2(
+				winBindings.kernel32.IsWow64Process2(
 					self.processHandle,
 					ctypes.byref(processMachine),
 					None,
@@ -706,7 +682,7 @@ def _get_is64BitProcess(self) -> bool:
 			# IsWow64Process2 is only supported on Windows 10 version 1511 and later.
 			# Fall back to IsWow64Process.
 			res = ctypes.wintypes.BOOL()
-			if ctypes.windll.kernel32.IsWow64Process(self.processHandle, ctypes.byref(res)) == 0:
+			if winBindings.kernel32.IsWow64Process(self.processHandle, ctypes.byref(res)) == 0:
 				self.is64BitProcess = False
 				return False
 			self.is64BitProcess = not res
@@ -764,15 +740,15 @@ def _get_appArchitecture(self) -> str:
 		}
 		# #14403: GetProcessInformation can be called from Windows 11 and later to obtain process machine.
 		if winVersion.getWinVer() >= winVersion.WIN11:
-			processMachineInfo = _PROCESS_MACHINE_INFORMATION()
+			processMachineInfo = winBindings.kernel32._PROCESS_MACHINE_INFORMATION()
 			# Constant comes from PROCESS_INFORMATION_CLASS enumeration.
 			ProcessMachineTypeInfo = 9
 			# Sometimes getProcessInformation may fail, so say "unknown".
-			if not ctypes.windll.kernel32.GetProcessInformation(
+			if not winBindings.kernel32.GetProcessInformation(
 				self.processHandle,
 				ProcessMachineTypeInfo,
 				ctypes.byref(processMachineInfo),
-				ctypes.sizeof(_PROCESS_MACHINE_INFORMATION),
+				ctypes.sizeof(processMachineInfo),
 			):
 				self.appArchitecture = "unknown"
 			else:
@@ -784,7 +760,7 @@ def _get_appArchitecture(self) -> str:
 			try:
 				# If a native app is running (such as x64 app on x64 machines), app architecture value is not set.
 				processMachine = ctypes.wintypes.USHORT()
-				ctypes.windll.kernel32.IsWow64Process2(self.processHandle, ctypes.byref(processMachine), None)
+				winBindings.kernel32.IsWow64Process2(self.processHandle, ctypes.byref(processMachine), None)
 				if not processMachine.value:
 					self.appArchitecture = winVersion.getWinVer().processorArchitecture
 				else:

source/appModules/outlook.py

@@ -10,6 +10,7 @@
 import comtypes.automation
 import ctypes
 from scriptHandler import script
+import winBindings.kernel32
 import winKernel
 import comHelper
 import NVDAHelper
@@ -430,7 +431,7 @@ def _generateCategoriesText(appointment):
 		bufLength = 4
 		separatorBuf = ctypes.create_unicode_buffer(bufLength)
 		if (
-			ctypes.windll.kernel32.GetLocaleInfoW(
+			winBindings.kernel32.GetLocaleInfo(
 				languageHandler.LOCALE_USER_DEFAULT,
 				languageHandler.LOCALE.SLIST,
 				separatorBuf,

source/appModules/wwahost.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) 2012-2020 NV Access Limited, Joseph Lee
+# Copyright (C) 2012-2025 NV Access Limited, Joseph Lee
 
 """App module host for Windows 8.x and 10 apps hosted by wwahost.exe.
 In Windows 8, apps written in Javascript are executed inside WWAHost, including some WinRT apps.
@@ -11,6 +11,7 @@
 
 import ctypes
 import appModuleHandler
+import winBindings.kernel32
 import winKernel
 
 
@@ -23,9 +24,9 @@ def getAppNameFromHost(processId):
 		processId,
 	)
 	length = ctypes.c_uint()
-	winKernel.kernel32.GetApplicationUserModelId(processHandle, ctypes.byref(length), None)
+	winBindings.kernel32.GetApplicationUserModelId(processHandle, ctypes.byref(length), None)
 	appModel = ctypes.create_unicode_buffer(length.value)
-	winKernel.kernel32.GetApplicationUserModelId(processHandle, ctypes.byref(length), appModel)
+	winBindings.kernel32.GetApplicationUserModelId(processHandle, ctypes.byref(length), appModel)
 	winKernel.closeHandle(processHandle)
 	# Sometimes app model might be empty, so raise errors and fall back to wwahost.
 	if not appModel.value: