Merged main

Descriting or spelling the current chracter, word or line now speaks in the appropriate language according to the text if auto language switching is turned on and the appropriate language information is available.
Specific changes:
* speech._speakSpellingGen:  place the initial text, locale and characterDescriptions bool as a tuple in to a list, and iterate through this list and spell each tuple. Also on each yield, check to see if a new tuple has been sent in to the generator and if so then append it to the list of things to be spelled.
* speech: rather than  holding _speakSpellingGenID, hold the actual generator as _speakspellingGenerator. CancelSpeech calls .close() on it if its still alive.
* speech.speakSpelling: if the generator is currently alive, use its .send to send new text to be spelled. If its dead then create a new generator.
* speech: add a spellTextInfo function which will spell the text in the given TextInfo, but also detects langChangeCommand objects and appropriately honours the language shen speaking.
* globalCommands:  for script_review_current[Chracter|Word|Line] use spellTextInfo instead of speakSpelling.

keyboardHandler: No longer always ignore injected keys. Instead only ignore them while NVDA is emulating a key press. This change allows apps such as on-screen keyboards and speech recognition software to  control NVDA by  emulating keyboard input themselves. Note that this has only so far been tested on Windows8 and must be tested on 7/Vista/xp for side affects. If in deed there are issues, such as our keyboard hook being called *after* keybd_event has returned, then we may need to look at some kind of emulated key set which our keyboard hook will  look at and ignore and remove any key in that set. MSDN docs do state that context is switched in keybd_event from the app to the keyboard hook and then back to the app, so I'm hoping that's true.

Updated version to 2012.1dev

NVDAObjects.IAccessible.sysListView32: Oops. Removed one too many lines of code. Put one of them back. :)
Fixes errors in certain list view controls.
Fixes #1866.

keyboardHandler: no longer always ignore injected key presses. Instead only ignore them while NVDA is currently emulating key presses itself (as to still not cause key loops). This change is to allow NVDA to respond to key presses sent by applications such as speech recognition software or alternative keyboard input programs.
So far I cannot see issues with this change, though it must be tested on all operating systems. Its possible that keybd_event could return before our keyboard hook is executed. If so then we'll need to use a different approach such as noting all key downs and ups emulated and  ignoring injected keys for just those ones as we see them come to the keyboard hook.

User Guide: Note that UIA is only supported in Windows 7 and later.

NVDAObjects.IAccessible.sysListView32: Gracefully handle the case where retrieving a process handle from a window handle fails. Also remove two pointless lines of code.

If autoLanguageSwitching is turned off, then never use the synth's reported language for such things as symbol names. Instead fall back to the older way of using NVDA's interface language. Thus if you are using a synth which incorrectly specifies its language, then turn autoLanguageSwitching off and you should get 2011.2 behaviour. May fix #1861.

Move characterDescriptions and symbols dict files out of zh_TW in to a new zh directory. This allows these character descriptions and symbols to be used for synths that only specify zh as their language (such as eSpeak mandarin). It also has the side affect that it will also make these symbols and character descriptions get used for any other zh_* language as no other dic files have been provided for these languages yet. In short this now allows chinese character descriptions and symbols to function again, having previously been broken due to the addition of auto language switching.

tr:
  characterDescriptions.dic
  symbols.dic matching 4745
  nvda.po matching 4745
  userGuide.t2t matching 4745

ta:
  symbols.dic matching 4745
  nvda.po matching 4745

nl:
  userGuide.t2t matching 4739

ja:
  nvda.po matching 4745
  userGuide.t2t matching 4733

Great thanks to Katsutoshi Tsuji, we have a complete Japanese userGuide.

fi:
  changes.t2t matching 4743
  userGuide.t2t matching 4739

de:
  userGuide.t2t matching 4732

ar:
  nvda.po: matching 4745
  changes.t2t matching 4743
  userGuide.t2t  matching 4745

User Guide: Remapping Key Assignments and Other Input Gestures: Clarify info about the sub-device/layout component of the gesture identifier with respect to braille displays.
Fixes #1860.

NVDAObjects.IAccessible.sysListView32.GroupingItem: Fix typos that were probably breaking this object.

Update What's New.

sayAllhandler.readTextHelper_generator: Gracefully handle the case where for the underlying NVDAObject dies before the generator is first pumped. Prevents an exception.

Update What's New.

IAccessible NVDAObject: There can be negative child IDs with no full IAccessible. Fix childCount, children and parent accordingly.
I suspect this is actually a bug in the application rather than intentional, but we need to handle it regardless.
Fixes infinite recursion in the About dialog of Notepad in Windows XP.
Fixes #1853.

Corrected small typo in userGuide heading, two missing equal signs.

mshtml vbuf backend: Implement basic support for Design Science MathPlayer.
Currently, we just render IAccessible::accName exposed by MathPlayer.

winKernel.virtualAllocEx: Raise exceptions for errors. Errors hopefully won't happen, but the caller should definitely not keep going unchecked if an error does occur.

MSHTML vbuf isAlive property: If the root object isn't responding, treat the buffer as dead. Otherwise, we'll keep querying it on every focus change and freezing.
Fixes freezes in the system menu on IE 8 in Windows XP... *again*.
Fixes #1831.

Map RICHEDIT to RichEdit instead of Edit.
Among other things, fixes a crash when moving the mouse over these controls.
Fixes #672.

api.setFocusObject: Notify the watchdog that the core is alive before certain code that can take a while so that it doesn't get cancelled unnecessarily.
watchdog: Increase the minimum alive timeout to 0.5, making watchdog a little more tolerant when switching windows.
Should fix missed focus in some cases; e.g. when opening a new Mozilla browser window on some systems.
Fixes #1851.

User Guide: Add note about Freedom Scientific braille display drivers installed by other screen readers. Also, minor grammatical fix.

User Guide: Specify the x86 version of the Microsoft Speech Platform runtime.

What's New: Add item about speech language switching for developers.

We now require eSpeak 1.45.46 or later.
Fixes #1789.

gecko_ia2 vbuf backend: Render labels for image maps.

What's New: Add release blurb.

speech.speakTextInfo: Don't append the last LangChangeCommand if not necessary. speech.speak now handles empty sequences anyway, but there's already code in speakTextInfo to eliminate pointless language changes, so we may as well do it at the end too.

speech.speak: The sequence can also be empty after language normalisation, so return early in this case as well.

Updated french language file, user guide and changes.

speech.speak: return right at the top if this function is given an empty speech sequence.  Other code in nvda probably shouldn't be giving empty speech sequences in a perfect world, but  even if speak was called manually like this, there is no point going through all the motions when there's really nothing to do. Plus this of course should stop  an error seen with sapi4 when given an empty speech sequence.

During sayAll, it was previously possible for an IndexCommand to be provided at the end of a speech sequence given to a synth's speak method, rather than at the beginning of the next speech sequence. (The two speech sequences being split due to a forced BreakCommand). Make sure this never happens.
Specific changes:
* speech.speakTextInfo: Add the given index as an IndexCommand to the speechSequence after speech for exiting control fields, and also after a possible Breakcommand (due to exiting a block), but before any other text or commands. Previously the index was always inserted as an IndexCommand at the very start of the speech sequence. Technically this now means that there may be some speech (specifically exiting old control fields) which will occur before the requested index, but this probably makes some sence as it really hasn't yet started speaking the actual content of the textInfo. Plus this is definitely needed to make sure the index appears on the right side of the BreakCommand.
* speech.speakWithoutPauses: When breaking up the speech sequence  by looking for specific BreakCommand objects and passing the subSequences  to speakWithoutPauses again, make sure to handle the case where a speech sequence starts with a BreakCommand. Previously this was not really possible as speakTextInfo always started with an IndexCommand, but now its certainly necessary.

Merge from the screen reader translation project: Arabic, German, Finnish, Italian, Japanese, Polish, Turkish.

base SynthDriver: In the base implementation of speak() for synth drivers that haven't yet been updated to support speak() themselves, merge text between supported commands into a single chunk. Fixes pauses on every field for these synths (e.g. Svox Pico).

Fix punctuation.

gecko_ia2 vbuf: Listen for scrollingStart events even before the buffer is fully rendered and then move to that object once rendered.
In particular, Gecko 10 now always fires scrollingStart if appropriate the first time the document is focused, so this means we'll almost always get the right position if the document is loaded while NVDA is running.
Partial fix for #360.

In browse mode, pressing enter or space on a tab now activates it instead of switching to focus mode. Tabs will still auto switch to focus mode for focus changes.
Fixes #1760.

speech.speakTextInfo: Don't speak "blank" when there are only fields which are announced but have already been entered; e.g. a blank line in a multi-line link.

Make sure that *no* LangChangeCommand objects are sent to a synth by speech.speak or speech._speakSpellingGen  when autoLanguageSwitching is turned off.

tr:
  nvda.po 4710

ja:
  nvda.po 4710
  userGuide.t2t 4658 (uncomplete)

it:
  nvda.po 4710
  changes.t2t 4710 (uncomplete)

pl:
  nvda.po 4710

de:
  langstrings.txt 4710
  nvda.po 4710
  changes.t2t 4710
  userGuide.t2t 4658
  symbols.dic

ar:
    nvda.po 4710
    changes.t2t 4710

fi:
    changes.t2t 4710
    userGuide 4658 + modifications and updates
    symbols.dic 4710
    nvda.po 4710

virtual buffers: Now that combo box items return a position in the buffer, they don't automatically force focus mode. Therefore, do this explicitly in the alt+up/downArrow script if appropriate.
Fixes failure to switch to focus mode when pressing alt+down/upArrow on a collapsed combo box.
Also remove specific code fixing #1630, as it is no longer required.
Fixes #1826.

Appropriately contain combo box and list (select) list items within an MSHTML virtual buffer, so that its possible to switch back to browse mode rather than it seeming as if you're not in the buffer at all. Fixes #1818, though  this does not fully fix combo boxes until #1826 is fixed.
Specific changes:
  * MSHTML virtualBuffer's __contains__ method: treet plane MSAA list items as being part of the buffer if their parent is a list that is in deed in the buffer.
* MSHTML virtualBuffer's getIdentifierFromNVDAObject: raise LookupError if given an NVDAObject that is not an MSHTML NVDAObject. This is now possible with the change for list items.
* Create a PopupList MSHTML NVDAObject overlay class, which  will always use MSAA's accParent, rather than  only if MSHTML's parentElement fails. For expanded MSHTML combo boxes the list  seems to have a unuseful parentElement as the list seems to be embedded in a temporary document, yet accParent is correctly overridden to point back to the real combo box. Use PopupList if the nodeName is 'SELECT' and the object's window is a popup window.

Expanding a combo box may have been broken for a very long time as we have not chosen to use accParent always in this case since long ago.

virtual buffers: List/combo box descendants aren't rendered into the buffer but are still considered part of it, so use the list/combo box when retrieving the position for such a descendant.
Fixes undesirable switch to focus mode when navigating to lists/combo boxes in certain cases.
Fixes #1819, #1815.

XMLFormatting.XMLTextParser: Merge consecutive character data chunks into a single string in the output, as some of our code assumes this.
Fixes weirdness with certain characters when working with display model.
Fixes #1824.

English symbols: Add HEAVY WIDE-HEADED RIGHTWARDS ARROW.

Updated changes file

FreedomScientific braille display driver: fix typo

textInfos.offsets: import config as it is used, though I think think any code in NVDA ever actually get to that exact code path right now

Map MSHTML's nodeName of 'OPTION' to a role of listItem. Really just cosmetic

source readme: Update IA2 URL.

What's New: Note JAB 2.0.2 support.

nvdaHelperLocal: Make initialize and terminate functions call startServer and stopServer respectively instead of calling them separately from Python.
This is a bit cleaner. It also seems we were never calling stopServer before this.

nvdaHelperLocal: Fix initialisation/termination code, which was very broken on systems without UIA.
On such systems, this was preventing the SendMessage* hooks for oleacc from being installed and was also causing an access violation exception on termination.
Fixes #1817.

Add copyright header.

Clarify docstring.

Wrap all calls to VirtualAllocEx and VirtualFreeEx in try-finally blocks so that VirtualAllocEx will be called even if there is an exception.
Previously, an exception would have caused a memory leak. This is more important now that watchdog.cancellableSendMessage is used (as it will raise an exception if the call is cancelled), but there could have been Windows exceptions in the past also.

Change all calls to winUser.sendMessage to watchdog.cancellableSendMessage to eliminate freezing when sending messages to windows that have stopped responding.
Fixes #1806.

Merged arabic and swedish files from the screen reader translation project

Fixed a small typo in sv/nvda.po.

convert ar userGuide/changes to utf8.

merge of main.

Merged from the screen reader transslation project

Updated portuguese language file,
updated brazilian portuguese user guide and changes,
updated slovak changes.

sv:
  corrected Swedish installer localization path
  nvda.nsi to reflect above change.
  nvda.po improvement of swedish interface, work in progress.

tr:
  nvda.po matching 4680
  userGuide.t2t matching 4658

ta:
    nvda.po matching 4659
    characterDescriptions.dic
    symbols.dic

pl:
    langstrings.txt
    nvda.po matching 4666
    changes.t2t matching 4659
    userGuide.t2t matching 4659

ja:
    nvda.po matching 4659
    userGuide.t2t work in progress added section 9 and subsections.

fi:
    langstrings.txt
    symbols.dic
    nvda.po matching 4659
    changes.t2t matching 4678
    userGuide.t2t matching 4658

ar:
    nvda.po matching 4659
    changes.t2t matching 4678
    userGuide.t2t matching 4658

displayModelTextInfo: make sure to always return unicode strings. Fixes #1799.

IAccessibleHandler.getIAccIdentity:  if getting the objectID from IAccPropServices::decomposeHwndIdentityString, use ctypes to cast the objectID to a signed int as our objectID constants are of this form. This again allows  matching of client IAccessibles etc.

IAccessibleHandler: make the usage of IAccPropServices condissional as on some XP systems this class is not registered. In this case fall back to the older  identity string decomposition code.

speech.speakTextInfo: Again merge text into a single chunk where there is no speakable formatting change or language change.

speech.speakTextInfo: A bit of cleanup: remove unused argument, fix typo, use xrange instead of range, iterate through a list instead of counting and indexing, fix indentation on a comment.

IAccessibleHandler.getIAccIdentity: Properly make use of IAccPropServices::DecomposeHwndString rather than trying to decompose the string ourselves manually. Our code has worked okay in the past but now breaks in some circomstances in Windows8. This fixes that issue, and hopefully does not cause any regressions on older Operating systems.
Specifically, the address bar in Windows 8 Windows explorer gave back an identity string we did not know how to handle.
We also no longer at all handle menuHandle identity strings, but these were never useful anyway.

speech.speakTextInfo: Eliminate a pointless list and rename other variables accordingly.

Temporary fix for correctly tracking focus in Windows8 Metro apps: If _loadBufferDone is told that the loading of the virtualBuffer failed, then set self.passThrough on this buffer to true before returning. The buffer is rather stuffed now anyway, but we should at least let it still work as good as possible. This was probably not as much of an issue before we allowed event_gainFocus to be still handled on virtualBuffers if they were not ready yet.
Better solutions could be:
* Detect metro apps and never try creating buffers
* Remove the dead buffer and some how force NVDA to not try creating it again
* Try and fix the issue that is stopping us from creating RPC interfaces inside metro app processes.

Fix typo.

Fix a rather bad typo? in gdiHooks where the wrong scriptString hook function was protecting against hook reentrency. Specifically, scriptStringAnalize was protecting, rather than scriptStringOut. A part from this cutting out pointless displayModel writes that will get overridden anyway, it also hides a nasty bug somewhere in the glyph translation code that was causing many apps to crash in Windows 8. E.g. winver, wordpad, Notepad, Windows Installers...
Note though that fixing this displayModel issue may cause some text to disappear from the model, though I think this is a very rare case -- we can fix it better soon if needed. Specifically, an app would have to call ScriptStringOut with their own custom scriptAnalisis structure not made by ScriptStringAnalyze.

Don't announce clickable for documents in browse mode, as a clickable document doesn't really make sense and is just an implementation detail.

JAB: Implement support for actions. This allows the activate current navigator object command to work where actions are exposed.
Fixes #1744.

Don't speak clickable for menu items, tabs or sliders in browse mode.

Detect and report toggle buttons correctly in Gecko. This includes using the name when the text is just whitespace.
Fixes #1757.

Fix typo, though it has no effect anyway.

ExcelSelection NVDAObject: make a TextInfo instance using position_all be returned from makeTextInfo if position_selection is asked for. This allows the reportCurrentSelection script to report the selected cells, as the NVDAObjectTextInfo grabs all needed info from basicText anyway. Fixes #1787.