[orca] Remove redundant method



commit 5a25f0fe0197efb11387886bc6b9b87faffddf41
Author: Joanmarie Diggs <jdiggs igalia com>
Date:   Tue Mar 17 11:37:06 2020 -0400

    Remove redundant method
    
    The default script utility getContainingDocument() is doing essentially
    the same work that the web script utility getDocumentForObject is doing.
    The only difference is that the latter checks if something is a document
    first, which callers of the former were in some cases doing. So move the
    latter to the default script and remove the former.

 src/orca/mouse_review.py                            |  2 +-
 src/orca/script_utilities.py                        | 17 ++++++++++-------
 src/orca/scripts/apps/soffice/script_utilities.py   |  6 +-----
 src/orca/scripts/default.py                         |  2 +-
 src/orca/scripts/toolkits/Gecko/script_utilities.py |  7 +------
 src/orca/scripts/toolkits/WebKitGtk/script.py       |  5 +----
 src/orca/scripts/web/script_utilities.py            |  9 ---------
 7 files changed, 15 insertions(+), 33 deletions(-)
---
diff --git a/src/orca/mouse_review.py b/src/orca/mouse_review.py
index b3945facc..2c064e200 100644
--- a/src/orca/mouse_review.py
+++ b/src/orca/mouse_review.py
@@ -515,7 +515,7 @@ class MouseReviewer:
                 debug.println(debug.LEVEL_INFO, msg, True)
                 return
 
-        objDocument = script.utilities.getContainingDocument(obj)
+        objDocument = script.utilities.getDocumentForObject(obj)
         if objDocument and script.utilities.inDocumentContent():
             document = script.utilities.activeDocument()
             if document != objDocument:
diff --git a/src/orca/script_utilities.py b/src/orca/script_utilities.py
index fccef8c35..c0987960a 100644
--- a/src/orca/script_utilities.py
+++ b/src/orca/script_utilities.py
@@ -1204,15 +1204,18 @@ class Utilities:
 
     def inDocumentContent(self, obj=None):
         obj = obj or orca_state.locusOfFocus
-        return self.getContainingDocument(obj) is not None
+        return self.getDocumentForObject(obj) is not None
 
     def activeDocument(self, window=None):
-        return self.getContainingDocument(orca_state.locusOfFocus)
+        return self.getDocumentForObject(orca_state.locusOfFocus)
 
-    def getContainingDocument(self, obj):
+    def getDocumentForObject(self, obj):
         if not obj:
             return None
 
+        if self.isDocument(obj):
+            return obj
+
         try:
             doc = pyatspi.findAncestor(obj, self.isDocument)
         except:
@@ -1246,7 +1249,7 @@ class Utilities:
         if not (obj and obj.getRole() == pyatspi.ROLE_TABLE):
             return False
 
-        doc = self.getContainingDocument(obj)
+        doc = self.getDocumentForObject(obj)
         if not doc:
             return False
 
@@ -1256,7 +1259,7 @@ class Utilities:
         if not (obj and obj.getRole() == pyatspi.ROLE_TABLE):
             return False
 
-        return self.getContainingDocument(obj) is None
+        return self.getDocumentForObject(obj) is None
 
     def isSpreadSheetTable(self, obj):
         if not obj:
@@ -1272,7 +1275,7 @@ class Utilities:
         if not role == pyatspi.ROLE_TABLE:
             return False
 
-        doc = self.getContainingDocument(obj)
+        doc = self.getDocumentForObject(obj)
         if not doc:
             return False
 
@@ -1358,7 +1361,7 @@ class Utilities:
         if not table:
             return False
 
-        if not self.getContainingDocument(table):
+        if not self.getDocumentForObject(table):
             return _settingsManager.getSetting('readFullRowInGUITable')
 
         if self.isSpreadSheetTable(table):
diff --git a/src/orca/scripts/apps/soffice/script_utilities.py 
b/src/orca/scripts/apps/soffice/script_utilities.py
index c7f9e314c..d9559ed20 100644
--- a/src/orca/scripts/apps/soffice/script_utilities.py
+++ b/src/orca/scripts/apps/soffice/script_utilities.py
@@ -562,11 +562,7 @@ class Utilities(script_utilities.Utilities):
         Returns a (title, position, count) tuple.
         """
 
-        if self.isDocument(obj):
-            dv = obj
-        else:
-            dv = self.getContainingDocument(obj)
-
+        dv = self.getDocumentForObject(obj)
         if not dv or not self.isDrawingView(dv):
             return "", 0, 0
 
diff --git a/src/orca/scripts/default.py b/src/orca/scripts/default.py
index 331c19910..40681ad6a 100644
--- a/src/orca/scripts/default.py
+++ b/src/orca/scripts/default.py
@@ -2006,7 +2006,7 @@ class Script(script.Script):
             self.presentMessage(messages.TABLE_NOT_IN_A)
             return True
 
-        if not self.utilities.getContainingDocument(table):
+        if not self.utilities.getDocumentForObject(table):
             settingName = 'readFullRowInGUITable'
         elif self.utilities.isSpreadSheetTable(table):
             settingName = 'readFullRowInSpreadSheet'
diff --git a/src/orca/scripts/toolkits/Gecko/script_utilities.py 
b/src/orca/scripts/toolkits/Gecko/script_utilities.py
index 1b344a25b..dbf5b9f87 100644
--- a/src/orca/scripts/toolkits/Gecko/script_utilities.py
+++ b/src/orca/scripts/toolkits/Gecko/script_utilities.py
@@ -146,12 +146,7 @@ class Utilities(web.Utilities):
         if not obj.getState().contains(pyatspi.STATE_EDITABLE):
             return False
 
-        if self.isDocument(obj):
-            msg = "GECKO: %s is believed to be an editable message" % obj
-            debug.println(debug.LEVEL_INFO, msg, True)
-            return True
-
-        document = self.getContainingDocument(obj)
+        document = self.getDocumentForObject(obj)
         if document and document.getState().contains(pyatspi.STATE_EDITABLE):
             msg = "GECKO: %s is in an editable document: %s" % (obj, document)
             debug.println(debug.LEVEL_INFO, msg, True)
diff --git a/src/orca/scripts/toolkits/WebKitGtk/script.py b/src/orca/scripts/toolkits/WebKitGtk/script.py
index d3542fc9e..c91b3bf05 100644
--- a/src/orca/scripts/toolkits/WebKitGtk/script.py
+++ b/src/orca/scripts/toolkits/WebKitGtk/script.py
@@ -512,10 +512,7 @@ class Script(default.Script):
         if obj.getRole() == pyatspi.ROLE_LINK:
             obj = obj.parent
 
-        if self.utilities.isDocument(obj):
-            document = obj
-        else:
-            document = self.utilities.getContainingDocument(obj)
+        document = self.utilities.getDocumentForObject(obj)
         if not document or document.getState().contains(pyatspi.STATE_BUSY):
             return
 
diff --git a/src/orca/scripts/web/script_utilities.py b/src/orca/scripts/web/script_utilities.py
index bb513b6a9..56d99774d 100644
--- a/src/orca/scripts/web/script_utilities.py
+++ b/src/orca/scripts/web/script_utilities.py
@@ -225,15 +225,6 @@ class Utilities(script_utilities.Utilities):
         self._inDocumentContent[hash(obj)] = rv
         return rv
 
-    def getDocumentForObject(self, obj):
-        if not obj:
-            return None
-
-        if self.isDocument(obj):
-            return obj
-
-        return pyatspi.findAncestor(obj, self.isDocument)
-
     def getTopLevelDocumentForObject(self, obj):
         document = self.getDocumentForObject(obj)
         while document:


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]