Changeset 2517

Timestamp:

11/20/08 04:41:51 (7 weeks ago)

Author:

bzr

Message:

braille:

• Rename getContextRegions() to getFocusContextRegions(), as it can now only be used on the focus (see below).
• getFocusContextRegions() and getFocusRegions() now call update() on the regions they yield if necessary. This allows these functions to avoid calling update() if it isn't necessary for some reason.
• getFocusContextRegions() now accepts a list of regions for the previous focus. This allows it to use the focus difference level and ancestors to greatly optimise the retrieval of context. Instead of always building new regions for all context objects (and thus having to retrieve all of the information for each object), it keeps the regions that were common to the previous focus and only builds new regions for new context. This results in a significant performance increase, especially in Mozilla applications.
• BrailleHandler?: Rename _doNewRegions() to _doNewObject() to make it clear that this function deals with moving to a new object and not just arbitrary regions.
• api.setFocusObject(): Set the global focus variables (focusObject, focusAncestors, etc.) before calling event_virtualBuffer_gainFocus, as this event calls braille functions to handle the focus which now require that these variables be up to date.

Closes #201.

Location:

trunk

Files:

• . (modified) (5 props)
• source/api.py (modified) (2 diffs)
• source/braille.py (modified) (5 diffs)

trunk

@@ -1 @@
-timestamp: 2008-11-20 00:32:02.549000025 +1000
+timestamp: 2008-11-20 14:40:18.513999939 +1000
 committer: James Teh <jamie@jantrid.net>
 properties: 
 2314 jamie@jantrid.net-20081119113620-dz3izx839k8dy7z0
 2315 jamie@jantrid.net-20081119143202-ybvjifczhpjl9ldo
+2316 jamie@jantrid.net-20081120044018-ubawgup09fsqgp0i
-source/brailleDisplayDrivers/handyTech.py       handytech.py-20080908070031-15dxcuiuxfazjt1r-3
+source/api.py   46@dbe06fc7-9119-0410-a01d-9dbf589ecbba:trunk:source%2Fapi.py
+source/braille.py       braille.py-20080908070240-tjwqjsv7drp1kt8c-1
+source/api.py   jamie@jantrid.net-20081111000130-ogbjmubm7hbp2w8b
+source/braille.py       mick@kulgan.net-20081117132147-0s0gw63lue1v5xar

@@ -1 @@
-timestamp: 2008-11-20 00:32:02.549000025 +1000
+timestamp: 2008-11-20 14:40:18.513999939 +1000
 committer: James Teh <jamie@jantrid.net>
 properties: 

@@ -286 +286 @@
 2314 jamie@jantrid.net-20081119113620-dz3izx839k8dy7z0
 2315 jamie@jantrid.net-20081119143202-ybvjifczhpjl9ldo
+2316 jamie@jantrid.net-20081120044018-ubawgup09fsqgp0i

@@ -1 @@
-source/brailleDisplayDrivers/handyTech.py       handytech.py-20080908070031-15dxcuiuxfazjt1r-3
+source/api.py   46@dbe06fc7-9119-0410-a01d-9dbf589ecbba:trunk:source%2Fapi.py
+source/braille.py       braille.py-20080908070240-tjwqjsv7drp1kt8c-1

@@ +1 @@
+source/api.py   jamie@jantrid.net-20081111000130-ogbjmubm7hbp2w8b
+source/braille.py       mick@kulgan.net-20081117132147-0s0gw63lue1v5xar

trunk/source/api.py

@@ -132 +132 @@
                         virtualBufferObject.event_virtualBuffer_firstGainFocus()
         oldVirtualBuffer=globalVars.focusObject.virtualBuffer if globalVars.focusObject else None
+        # Set global focus variables before calling event_virtualBuffer_gainFocus.
+        globalVars.focusDifferenceLevel=focusDifferenceLevel
+        globalVars.focusObject=obj
+        globalVars.focusAncestors=ancestors
         if obj.virtualBuffer is not oldVirtualBuffer:
                 if hasattr(oldVirtualBuffer,"event_virtualBuffer_loseFocus"):
@@ -137 +141 @@
                 if hasattr(obj.virtualBuffer,"event_virtualBuffer_gainFocus"):
                         obj.virtualBuffer.event_virtualBuffer_gainFocus()
-        globalVars.focusDifferenceLevel=focusDifferenceLevel
-        globalVars.focusObject=obj
-        globalVars.focusAncestors=ancestors
         if log.isEnabledFor(log.DEBUG):
                 log.debug("%s %s %s %s"%(obj.name or "",controlTypes.speechRoleLabels[obj.role],obj.value or "",obj.description or ""))

trunk/source/braille.py

@@ -540 +540 @@
                                 raise
 
-def getContextRegions(obj):
+def getFocusContextRegions(obj, oldFocusRegions=None):
         # Late import to avoid circular import.
         from virtualBuffers import VirtualBuffer
-        if isinstance(obj,VirtualBuffer):
-                obj=obj.rootNVDAObject
-        ancestors=[]
-        ancestor=obj.parent
-        while ancestor:
-                ancestors.append(ancestor)
-                ancestor=ancestor.parent
-        ancestors.reverse()
-        for parent in ancestors[1:]:
+        ancestors = api.getFocusAncestors()
+
+        ancestorsEnd = len(ancestors)
+        if isinstance(obj, VirtualBuffer):
+                obj = obj.rootNVDAObject
+                # We only want the ancestors of the buffer's root NVDAObject.
+                if obj != api.getFocusObject():
+                        # Search backwards through the focus ancestors to find the index of obj.
+                        for index, ancestor in itertools.izip(xrange(len(ancestors) - 1, 0, -1), reversed(ancestors)):
+                                if obj == ancestor:
+                                        ancestorsEnd = index
+                                        break
+
+        if oldFocusRegions:
+                # We have the regions from the previous focus, so use the focus difference level to avoid rebuilding regions which are the same.
+                # The focus difference level is generally where the new ancestors begin.
+                # However, we must ensure that it is not beyond the last ancestor we wish to consider.
+                # Also, we don't ever want to fetch ancestor 0 (the desktop).
+                newAncestorsStart = max(min(api.getFocusDifferenceLevel(), ancestorsEnd), 1)
+                # Search backwards through the old regions to find the last common region.
+                for index, region in itertools.izip(xrange(len(oldFocusRegions) - 1, -1, -1), reversed(oldFocusRegions)):
+                        ancestorIndex = getattr(region, "_focusAncestorIndex", None)
+                        if ancestorIndex is None:
+                                continue
+                        if ancestorIndex < newAncestorsStart:
+                                # This is the last common region.
+                                # An ancestor may have been skipped and not have a region, which means that we need to grab new ancestors from this point.
+                                newAncestorsStart = ancestorIndex + 1
+                                commonRegionsEnd = index + 1
+                                break
+                else:
+                        # No common regions were found.
+                        commonRegionsEnd = 0
+                        newAncestorsStart = 1
+                # Yield the common regions.
+                for region in oldFocusRegions[0:commonRegionsEnd]:
+                        yield region
+        else:
+                # Fetch all ancestors.
+                newAncestorsStart = 1
+
+        for index, parent in enumerate(ancestors[newAncestorsStart:ancestorsEnd], newAncestorsStart):
                 role=parent.role
                 if role in (controlTypes.ROLE_UNKNOWN,controlTypes.ROLE_WINDOW,controlTypes.ROLE_SECTION,controlTypes.ROLE_TREEVIEWITEM,controlTypes.ROLE_LISTITEM,controlTypes.ROLE_PARAGRAPH,controlTypes.ROLE_PROGRESSBAR,controlTypes.ROLE_EDITABLETEXT,controlTypes.ROLE_MENUITEM):
@@ -562 +595 @@
                 if controlTypes.STATE_INVISIBLE in states or controlTypes.STATE_UNAVAILABLE in states:
                         continue
-                yield NVDAObjectRegion(parent, appendText=" ")
+                region = NVDAObjectRegion(parent, appendText=" ")
+                region._focusAncestorIndex = index
+                region.update()
+                yield region
 
 def getFocusRegions(obj, review=False):
@@ -576 +612 @@
         if isinstance(obj, VirtualBuffer):
                 obj = obj.rootNVDAObject
-        yield (ReviewNVDAObjectRegion if review else NVDAObjectRegion)(obj, appendText=" " if region2 else "")
+        region = (ReviewNVDAObjectRegion if review else NVDAObjectRegion)(obj, appendText=" " if region2 else "")
+        region.update()
+        yield region
         if region2:
+                region2.update()
                 yield region2
 
@@ -709 +748 @@
                 if self.tether != self.TETHER_FOCUS:
                         return
-                self._doNewRegions(itertools.chain(getContextRegions(obj), getFocusRegions(obj)))
-
-        def _doNewRegions(self, regions):
+                self._doNewObject(itertools.chain(getFocusContextRegions(obj, oldFocusRegions=self.mainBuffer.regions), getFocusRegions(obj)))
+
+        def _doNewObject(self, regions):
                 self.mainBuffer.clear()
                 for region in regions:
                         self.mainBuffer.regions.append(region)
-                        region.update()
                 self.mainBuffer.update()
                 # Last region should receive focus.
@@ -775 +813 @@
                 else:
                         # We're reviewing a different object.
-                        self._doNewRegions(getFocusRegions(reviewPos.obj, review=True))
+                        self._doNewObject(getFocusRegions(reviewPos.obj, review=True))
 
 def initialize():

@@ -1 @@
-timestamp: 2008-11-20 00:32:02.549000025 +1000
+timestamp: 2008-11-20 14:40:18.513999939 +1000
 committer: James Teh <jamie@jantrid.net>
 properties: 

@@ -286 +286 @@
 2314 jamie@jantrid.net-20081119113620-dz3izx839k8dy7z0
 2315 jamie@jantrid.net-20081119143202-ybvjifczhpjl9ldo
+2316 jamie@jantrid.net-20081120044018-ubawgup09fsqgp0i

@@ -1 @@
-source/brailleDisplayDrivers/handyTech.py       handytech.py-20080908070031-15dxcuiuxfazjt1r-3
+source/api.py   46@dbe06fc7-9119-0410-a01d-9dbf589ecbba:trunk:source%2Fapi.py
+source/braille.py       braille.py-20080908070240-tjwqjsv7drp1kt8c-1

@@ +1 @@
+source/api.py   jamie@jantrid.net-20081111000130-ogbjmubm7hbp2w8b
+source/braille.py       mick@kulgan.net-20081117132147-0s0gw63lue1v5xar