SubModules

addon/globalPlugins/webAccess/__init__.py

@@ -56,58 +56,48 @@
 
 import os
 import re
-import core
 import wx
 
 from NVDAObjects.IAccessible import IAccessible
 from NVDAObjects.IAccessible.MSHTML import MSHTML
 from NVDAObjects.IAccessible.ia2Web import Ia2Web
 from NVDAObjects.IAccessible.mozilla import Mozilla
-from scriptHandler import script
 import addonHandler
 import api
 import baseObject
 from buildVersion import version_detailed as NVDA_VERSION
 import controlTypes
+import core
 import eventHandler
 import globalPluginHandler
 import gui
 from logHandler import log
-import scriptHandler
-import speech
+from scriptHandler import script
 import ui
 import virtualBuffers
 
-from . import nodeHandler
-from . import overlay
-from . import webAppLib
-from .webAppLib import *
+from . import overlay, webModuleHandler
+from .webAppLib import playWebAccessSound, sleep
 from .webAppScheduler import WebAppScheduler
-from . import webModuleHandler
 
 
 addonHandler.initTranslation()
 
 
-TRACE = lambda *args, **kwargs: None  # @UnusedVariable
-#TRACE = log.info
-
 SCRIPT_CATEGORY = "WebAccess"
-
-#
-# defines sound directory
-#
-
 SOUND_DIRECTORY = os.path.join(os.path.abspath(os.path.dirname(__file__)), "..", "..", "sounds")
+SUPPORTED_HOSTS = ['brave', 'firefox', 'chrome', 'java', 'iexplore', 'microsoftedgecp', 'msedge']
+TRACE = lambda *args, **kwargs: None  # @UnusedVariable
+#TRACE = log.info
 
 
+# Currently dead code, but will likely be revived for issue #17.
+activeWebModule = None
 
-supportedWebAppHosts = ['brave', 'firefox', 'chrome', 'java', 'iexplore', 'microsoftedgecp', 'msedge']
-
-activeWebApp = None
 webAccessEnabled = True
 scheduler = None
 
+
 class DefaultBrowserScripts(baseObject.ScriptableObject):
 
 	def __init__(self, warningMessage):
@@ -118,7 +108,7 @@ def __init__(self, warningMessage):
 			self.__class__.__gestures["kb:control+shift+%s" % character] = "notAssigned"
 
 	def script_notAssigned(self, gesture):  # @UnusedVariable
-		playWebAppSound("keyError")
+		playWebAccessSound("keyError")
 		sleep(0.2)
 		ui.message(self.warningMessage)
 
@@ -202,6 +192,7 @@ def chooseNVDAObjectOverlayClasses(self, obj, clsList):
 			if cls in clsList
 		):
 			if obj.role in (
+				controlTypes.ROLE_APPLICATION,
 				controlTypes.ROLE_DIALOG,
 				controlTypes.ROLE_DOCUMENT,
 			):
@@ -220,27 +211,36 @@ def script_showWebAccessGui(self, gesture):  # @UnusedVariable
 
 	def showWebAccessGui(self):
 		obj = api.getFocusObject()
-		if obj is None or obj.appModule is None:
-			# Translators: Error message when attempting to show the Web Access GUI.
-			ui.message(_("The current object does not support Web Access."))
-			return
-		if not supportWebApp(obj):
+		if not canHaveWebAccessSupport(obj):
 			# Translators: Error message when attempting to show the Web Access GUI.
 			ui.message(_("You must be in a web browser to use Web Access."))
 			return
-		if obj.treeInterceptor is None or not isinstance(obj, overlay.WebAccessObject):
+		if not isinstance(obj.treeInterceptor, overlay.WebAccessBmdti):
 			# Translators: Error message when attempting to show the Web Access GUI.
 			ui.message(_("You must be on the web page to use Web Access."))
 			return
-
 		from .gui import menu
-		context = {}
-		context["webAccess"] = self
-		context["focusObject"] = obj
-		webModule = obj.webAccess.webModule
-		if webModule is not None:
+		context = {
+			"webAccess": self,
+			"focusObject": obj,
+		}
+		# Use the helper of the TreeInterceptor to get the WebModule at caret
+		# rather than the one where the focus is stuck.
+		webModule = obj.treeInterceptor.webAccess.webModule
+		if webModule:
 			context["webModule"] = webModule
 			context["pageTitle"] = webModule.pageTitle
+			mgr = webModule.ruleManager
+			context["result"] = mgr.getResultAtCaret()
+			stack = []
+			while True:
+				stack.append(webModule)
+				try:
+					webModule = webModule.ruleManager.parentRuleManager.webModule
+				except AttributeError:
+					break
+			if len(stack) > 1:
+				context["webModuleStackAtCaret"] = stack
 		menu.show(context)
 
 	@script(
@@ -262,125 +262,6 @@ def script_showWebAccessSettings(self, gesture):  # @UnusedVariable
 			# Now part of the public API as of NVDA PR #15121
 			gui.mainFrame.popupSettingsDialog(WebAccessSettingsDialog)
 
-	@script(
-		# Translators: Input help mode message for a command.
-		description=_("Toggle debug mode."),
-		category=SCRIPT_CATEGORY,
-		gesture="kb:nvda+control+shift+w"
-	)
-	def script_debugWebModule(self, gesture):  # @UnusedVariable
-		global activeWebApp
-		focus = api.getFocusObject()
-		if \
-				activeWebApp is None \
-				and not hasattr(focus, "_webApp") \
-				and not hasattr(focus, "treeInterceptor") \
-				and not hasattr(focus.treeInterceptor, "_webApp") \
-				and not hasattr(focus.treeInterceptor, "nodeManager"):
-			ui.message("Pas de WebModule actif")
-			return
-
-		diverged = False
-		focusModule = None
-		treeModule = None
-		msg = "Divergence :"
-		msg += os.linesep
-		msg += "activeWebApp = {webModule}".format(
-			webModule=activeWebApp.storeRef
-				if hasattr(activeWebApp, "storeRef")
-				else activeWebApp
-			)
-		if activeWebApp is not None:
-			msg += " ({id})".format(id=id(activeWebApp))
-		if not hasattr(focus, "_webApp"):
-			msg += os.linesep
-			msg += "focus._webApp absent"
-		else:
-			focusModule = focus._webApp
-			if activeWebApp is not focusModule:
-				diverged = True
-			msg += os.linesep
-			msg += "focus._webApp = {webModule}".format(
-				webModule=
-					focusModule.storeRef
-					if hasattr(focusModule, "storeRef")
-					else focusModule
-				)
-			if focusModule is not None:
-				msg += " ({id})".format(id=id(focusModule))
-		if not hasattr(focus, "treeInterceptor"):
-			diverged = True
-			msg += os.linesep
-			msg += "focus.treeInterceptor absent"
-		else:
-			if focus.treeInterceptor is None:
-				diverged = True
-				msg += os.linesep
-				msg += "focus.treeInterceptor None"
-# 			if not hasattr(focusModule, "treeInterceptor"):
-# 				diverged = True
-# 				msg += os.linesep
-# 				msg += u"focus._webApp.treeInterceptor absent"
-# 			elif focusModule.treeInterceptor is None:
-# 				diverged = True
-# 				msg += os.linesep
-# 				msg += u"focus._webApp.treeInterceptor None"
-# 			elif focus.treeInterceptor is not focusModule.treeInterceptor:
-# 				diverged = True
-# 				msg += os.linesep
-# 				msg += u"TreeInterceptors différents"
-			if hasattr(focus.treeInterceptor, "_webApp"):
-				treeModule = focus.treeInterceptor._webApp
-				if \
-						treeModule is not focusModule \
-						or treeModule is not activeWebApp:
-					diverged = True
-				msg += os.linesep
-				msg += "treeInterceptor._webApp = {webModule}".format(
-					webModule=
-						treeModule.storeRef
-						if hasattr(treeModule, "storeRef")
-						else treeModule
-					)
-				if treeModule is not None:
-					msg += " ({id})".format(id=id(treeModule))
-			if hasattr(focus.treeInterceptor, "nodeManager"):
-				if focusModule is None:
-					diverged = True
-					msg += "treeInterceptor.nodeManager "
-					if focus.treeInterceptor.nodeManager is None:
-						msg += "est None"
-					else:
-						msg += "n'est pas None"
-				elif \
-						focusModule.ruleManager.nodeManager is not \
-						focus.treeInterceptor.nodeManager:
-					diverged = True
-					msg += os.linesep
-					msg += "NodeManagers différents"
-				elif focusModule.ruleManager.nodeManager is None:
-					msg += os.linesep
-					msg += "NodeManagers None"
-
-
-		allMsg = ""
-
-		if not diverged:
-			try:
-				from six import text_type
-			except ImportError:
-				# NVDA version < 2018.3
-				text_type = str
-			msg = text_type(focusModule.storeRef)
-		speech.speakMessage(msg)
-		allMsg += msg + os.linesep
-
-		treeInterceptor = html.getTreeInterceptor()
-		msg = "nodeManager %d caractères, %s, %s" % (treeInterceptor.nodeManager.treeInterceptorSize, treeInterceptor.nodeManager.isReady, treeInterceptor.nodeManager.mainNode is not None)
-		speech.speakMessage(msg)
-		allMsg += msg + os.linesep
-		api.copyToClip(allMsg)
-
 	@script(
 		# Translators: Input help mode message for show Web Access menu command.
 		description=_("Show the element description."),
@@ -417,23 +298,23 @@ def script_toggleWebAccessSupport(self, gesture):  # @UnusedVariable
 			ui.message(_("Web Access support enabled."))  # FR: u"Support Web Access activé."
 
 
-def getActiveWebApp():
-	global activeWebApp
-	return activeWebApp
+def getActiveWebModule():
+	global activeWebModule
+	return activeWebModule
 
 
-def webAppLoseFocus(obj):
-	global activeWebApp
-	if activeWebApp is not None:
-		sendWebAppEvent('webApp_loseFocus', obj, activeWebApp)
-		activeWebApp = None
-		#log.info("Losing webApp focus for object:\n%s\n" % ("\n".join(obj.devInfo)))
+def webModuleLoseFocus(obj):
+	global activeWebModule
+	if activeWebModule is not None:
+		sendWebModuleEvent('webModule_loseFocus', obj, activeWebModule)
+		activeWebModule = None
+		#log.info("Losing webModule focus for object:\n%s\n" % ("\n".join(obj.devInfo)))
 
 
-def supportWebApp(obj):
+def canHaveWebAccessSupport(obj):
 	if obj is None or obj.appModule is None:
-		return None
-	return  obj.appModule.appName in supportedWebAppHosts
+		return False
+	return obj.appModule.appName in SUPPORTED_HOSTS
 
 
 def VirtualBuffer_changeNotify(cls, rootDocHandle, rootID):
@@ -448,10 +329,10 @@ def virtualBuffer_loadBufferDone(self, success=True):
 	virtualBuffer_loadBufferDone.super.__get__(self)(success=success)
 
 
-def sendWebAppEvent(eventName, obj, webApp=None):
-	if webApp is None:
+def sendWebModuleEvent(eventName, obj, webModule=None):
+	if webModule is None:
 		return
-	scheduler.send(eventName="webApp", name=eventName, obj=obj, webApp=webApp)
+	scheduler.send(eventName="webModule", name=eventName, obj=obj, webModule=webModule)
 
 
 def eventExecuter_gen(self, eventName, obj):
@@ -465,21 +346,18 @@ def eventExecuter_gen(self, eventName, obj):
 		if func:
 			yield func, (obj, self.next)
 
-	# webApp level
-	if  not supportWebApp(obj) and eventName in ["gainFocus"] and activeWebApp is not None:
-		# log.info("Received event %s on a non-hosted object" % eventName)
-		webAppLoseFocus(obj)
+	# WebModule level.
+	webModule = obj.webAccess.webModule if isinstance(obj, overlay.WebAccessObject) else None
+	if webModule is None:
+		# Currently dead code, but will likely be revived for issue #17.
+		if activeWebModule is not None and obj.hasFocus:
+			#log.info("Disabling active webApp event %s" % eventName)
+			webAppLoseFocus(obj)
 	else:
-		webApp = obj.webAccess.webModule if isinstance(obj, overlay.WebAccessObject) else None
-		if webApp is None:
-			if activeWebApp is not None and obj.hasFocus:
-				#log.info("Disabling active webApp event %s" % eventName)
-				webAppLoseFocus(obj)
-		else:
-			# log.info("Getting method %s -> %s" %(webApp.name, funcName))
-			func = getattr(webApp, funcName, None)
-			if func:
-				yield func,(obj, self.next)
+		# log.info("Getting method %s -> %s" %(webApp.name, funcName))
+		func = getattr(webModule, funcName, None)
+		if func:
+			yield func, (obj, self.next)
 
 	# App module level.
 	app = obj.appModule