merge main, resolving conflicts

Merged synthLanguageSupport. For most synths this provides a read-only language property, which allows  other code in NVDA to find out the language the synth is currently speaking in. It also standardizes support for setting and listing languages by adding needed types to synthDriverHandler. The addition of the language property will allow NVDA in future to improve its puncutation handling by using appropriate rules according to the synth's current language, rather than simply either a default set of rules or rules based on NVDA's interface language.

source readme:  mention that Python's scripts directory must be added to the path variable in order for scons to be run from any location.

inputCore: When in input help mode, and getting help for a particular gesture (e.g. when in input help mode and pressing a key), if that gesture is bound to a script, a part from speaking the script name and description, now the gesture's identifier, the script name, and the scripts location, are logged at info level. This provides some way of users finding out the specific location of a particular script, in orer to add an entry to gestures.ini.

scriptHandler: add a new getScriptLocation function, which takes a script, and returns its module.class location. A previous version of getScriptLocation used to exist, however this new one now searches the script's class mro until it finds where the script has really  been implemented, rather than simply returning the class that the script was originally fetched from.

Code doc.

Update code doc.

Support for global plugins which can globally bind scripts, handle NVDAObject events and choose NVDAObject overlay classes. See globalPluginHandler.GlobalPlugin for details.
Note that there is no longer an _default app module. Global scripts should be added or overridden using global plugins.
App modules should instead subclass appModuleHandler.AppModule (the base AppModule class).
The scripts from the _default app module are now in the new globalCommands.GlobalCommands object.
Fixes #281.

Rename plugins to global plugins to make it clear that they have global effect. We may also want ot use the term plugin for other things later; e.g. renaming app modules to app plugins.

Only allow one settings dialog to be opened at a time. This is specifically useful for stopping the user from changing the synthesizer while the voice settings dialog is open. Fixes #603

nvdaHelper remote: IA2Support: Register IAccessibleTable2 and IAccessibleTableCell interfaces for cross-process marshalling.

Remove pointless code.

Update What's New.

Allow plugins to choose NVDAObject overlay classes by implementing a chooseNVDAObjectOverlayClasses method.

Code doc.

Dispatch NVDAObject events to all plugins.
As for app modules, plugin event functions are named event_eventName and take two arguments: the NVDAObject and a callable to call the next event handler.

eventHandler: Refactor event execution to make it possible for events to be executed in an arbitrary number of plugins.
Note that events aren't actually dispatched to plugins yet.

Allow plugins to bind scripts which are executed globally and take precedence over scripts in all other objects.

Fixes.

Add basic code to support plugins.
See the pluginHandler.Plugin class for details.
All plugins are imported and instantiated when NVDA is started and terminated on exit.
Scripts and events aren't yet delivered to plugins. This will be done in subsequent commits.

appModuleHandler.initialize(): Use appModules.__init__ instead of appModules._default when fetching the list of importers for the appModules package, as _default doesn't exist anymore. This actually makes no practical difference, but it's more correct. :)

Get rid of the default app module!
The scripts from the default app module have been moved into a separate globalCommands module, which is handled explicitly by scriptHandler.
This was done because these commands are not application specific, so it doesn't make sense for all app modules to inherit them.
It also prevents users from breaking NVDA completely due to a broken default app module in their user configuration.
App modules should now inherit from the base appModuleHandler.AppModule.

sconstruct: Add certPassword option to specify the password for the private key in the certificate.
Fixes #1221.

What's New: Add a "Changes for Developers" which documents changes concerning developers.

Add support for mapping gestures to scripts anywhere in NVDA.
Currently, there are two global gesture maps: the user map and the locale map.
This allows users and locale maintainers to add new bindings and override existing bindings in a single file.
See the inputCore.GlobalGestureMap class for details.
The user map is stored in gestures.ini in the NVDA configuration directory.
The locale map is stored in locale\LANG\gestures.ini, where LANG is the language code.

Update What's New.

Implement loading of the locale gesture map.
This is stored in locale\lang\gestures.ini, where lang is the language code.
Also add some extra logging.

Add support for mapping gestures to scripts anywhere in NVDA.
Currently, there are two global gesture maps: the user map and the locale map.
This allows users and locale maintainers to add new bindings and override existing bindings in a single file.
See the inputCore.GlobalGestureMap class for details.
The user map is stored in gestures.ini in the NVDA configuration directory.
Loading of the locale map is not yet implemented.

Fixed hindi user guide so key commands are actually generated and the NVDA can be built.

Added hindi language file and user guide,
Added serbian user guide,
Updated italian language file,
Updated slovak language file and changes.

App modules no longer have key map files!
Instead, all gesture bindings are done in the app module itself. This keeps everything together in the one place, removes the appModules folder in the NVDA binary distribution (which only contains kbd files) and removes one stage of gesture mapping (which will be necessary to simplify future enhancements).
Note that desktop and laptop bindings, as well as bindings common to both, can all be provided in the same gesture map now, which eliminates another reason for these key map files.
The most common way to bind gestures is to use a magic __gestures dict on the class. bindGesture() can also be used on the instance. See the code doc for baseObject.ScriptableObject for more details.
It's not currently possible for users to override the in-built bindings. This is coming in future.

Source readme clarifications:
* Change "root of the NVDA source distribution/checkout" to just "root of the NVDA source distribution" to avoid confusion of "/" as a directory separator.
* Document that certFile expects a file in pfx format which must include the private key.

Correct the description for the current navigator object script in both NVDA and the english user guide. Input help now mentions that twice spells the information, and the user guide now mentions that 3 times copies it to the clibpard. Fixes #938.

Merge main.

Merge main.

setup.py: Fetch all data files in the call to setup() now. We no longer run generate.py from setup.py, so there's no need to delay this.

Changed the behaviour of the review follows caret option, so that  the review position will only move if the caret moves in the same object. Previously if the caret moved in any object, the review position would jump inside that object. Specific changes:
*NVDAObject.event_caret: only set the review position to the caret if the current navigator object is this object.
*VirtualBuffer._set_selection:  rather than unconditionally setting the review position to the new caret position, instead only do this if the current navigator object is the root of this virtualBuffer.
*TreeInterceptor._set_passthrough: if passthrough is turning on, and the focus is currently inside this treeInterceptor, and the review follows focus option is on, set the navigator object to the focus.
*TreeInterceptor._set_selection: if passthrough is turning off, and the navigator object is inside this treeInterceptor, and the review follows caret option is turned on,  set the navigator object to the root of this treeInterceptor.

Next release will be 2011.1.

sconstruct: Execute pygettext with the python executable, as not all systems will associate .py files with the interpreter.

Refactor the build process to allow anyone to prepare the source tree and create binary distributions, portable archives, installers, etc. with a simple command.
scons is used to facilitate this.
See the Building NVDA section of the source readme for details.

Notes:
* Of course, SCons is now required for anyone running from source.
* The nvdaHelper build process has now been incorporated into the new build process, so you do not need to run scons from source\NVDAHelper anymore.
* nvdaHelper builds will no longer be provided on the snapshots page. This means that the Windows SDK and several other dependencies are now required, as documented in the source readme.
* You should no longer run generate.py, setup.py or makensis directly. Instead, use scons as documented in the source readme.
* source\include and source\NVDAHelper have been moved out of the source directory.

sconstruct: Build the client archive relative to the extras\controllerClient directory.

sconstruct: pot no longer depends on sourceDir, as this depends on comInterfaces and nvdaHelper. Instead, just depend on *.py beneath sourceDir.

sconstruct: Rather than using normal scons mechanisms to create and remove _buildVersion.py*, do it as actions in the NVDADist builder. This is necessary because we want this to be removed immediately after NVDADist (not just when scons -c is run). Also, env.Clean() seems to make the file some sort of dependency, which causes problems for _buildVersion.pyc and _buildVersion.pyo which aren't scons targets.

Merged main

api.getReviewPosition(): Don't try to use a tree interceptor that isn't ready. Fixes exceptions when trying to use the review position in a document that hasn't finished loading yet.

Fix a bug where the "Use currently saved settings on the logon and other secure screens" button did not work if the systemConfig directory did not already exist, which is the case immediately after a clean install. Note that it did work after at least one secure screen appeared (as the directory gets created then).
Fixes #1194.

Hopefully fix exceptions when scripts are queued for objects in an app but the app closes before the scripts get executed.

Moved logLevel commandline option from NVDA's root sconstruct to nvdaHelper's, renaming it nvdaHelperLogLevel.

Added nvdaHelper/sconscript which for some reason was never added before, should have really be renamed from sconstruct.

Update bzr ignores.

Include nvdaHelper build dependencies in the source readme. Remove the separate nvdaHelper build instructions, as nvdaHelper is not built separately anymore.

nvda's root sconstruct: when cleaning _buildVersion.py, also get rid of  its .pyc and .pyo files as well.

Integrate generation of comTypes COM interfaces in to scons:
*Rename source/generate.py to source/generateComInterfaces.py, as that is all this file does now.
*NVDA's root sconstruct: generate comtypes COM interfaces in source/comInterfaces with the help of generateComInterfaces.py.
*source/setup.py: no longer call generate.py.

nvda root sconstruct: the release commandline option now only controls filenames and whether NVDA's Python will run optimized, it does not affect nvdaHelper. There is now a new scons commandline option called nvdaHelperDebug. If you set this to 1, then vdaHelper will be built with asertions enabled, debug symbols, it will use debug libraries, and it will not be optimized.

the output dir can now be specifically set on the commandline with outputDir=<dir>

gettext scons tool: import msgfmt and use it that way, rather than spauning a separate Python process each time its used. However to do this msgfmt.MESSAGES must be cleared after each use, and NVDA's root sconstruct must alert scons  that the gettextMoFile builder can not be run in parallel.

as txt2tags can not be run in parallel, make sure scons doesn't try, by making all the txt2tags target nodes  share a fake side effect.

Generate all archives and the pot etc in a directory called output to stop cluttering  NVDA's root directory, and also to make it easier for an automatic snapshot builder to collect up all created files. Also add a 'changes' target which  copies user_docs/en/changes.html to the putput directory as nvda_version_changes.html.

Move generation of html documentation from t2t files (including keyCommands)  from source/generate.py and into scons:
*Add a t2t scons tool in which provides a builder called txt2tags which converts a given t2t source file in to  an html file. Note that the real txt2tags module must be able to be imported by scons, so it either needs to be in Python's site-packages, or in nvda's root directory (not in source).
*Move keyCommandsDoc.py from source in to nvda's root directory.
*keyCommandsDoc: the maker now takes an output filename, not just an input file name.
*keyCommandsDoc: the maker now generates the output in a temporary file (for now the output filename with two underscores after) and then if successfull renames to the appropriate name.  The documentation for this function stated that the file was only generated if successfull, which was not the case.
*Ad a keyCommandsDoc tool function to nvda's root sconstruct which provides a builder called keyCommandsDoc which generates a keyCommands t2t from a given userGuide t2t.
*NVDA's root sconstruct: keyCommands.t2t files will be built from all userGuide.t2t files in user_docs, excluding  languages that are in a special keyCommandsLangBlacklist (this is currently cs and ja). The blacklisted languages do not have the newer format for their user guide.
*NVDA's root sconstruct: build html files from all t2t files in user_docs, including any keyCommands.t2t files.
*source/generate.py: remove now redundant code that generated keyCommands t2t files and converted t2t files to html files.

Updated spanish language file,
updated galician language file,
updated danish language file,
Updated polish language file,
Added serbian language file by Dejan Zubovic.

gettext scons tool:  execute msgfmt each time in a separate python process, as  if scons was building multiple files in parallel msgfmt would produce bad results as there is state kept at module level.

Move gettext mo file generation out of source/generate.py and in to scons:
*Added a gettext scons tool to site_scons/site_tools. This tool provides a gettextMoFile builder, which takes a gettext template file (.po) and compiles it using msgfmt to a .mo.
*NVDA root sconstruct: cause all of NVDA's po files to be compiled to mo files if source is being built.
*Removed locale compilation code from source/generate.py as its now redundant.

Newfon synthDriver: fix syntax errors and missing imports.
Use StringInfo instead of VoiceInfo for accel setting (because accelleration isn't a voice-like setting, particularly, it doesn't have language.)
SynthDriverHandler: add missing import

Integrate the building of nvdaHelper into NVDA's scons files:
*NVDA's new root sconstruct: declare and export clientDir, sourceLibDir and sourceLibDir64 variables, which can be used by nvdaHelper and client etc.
* Move source/include to include (at NVDA's root). also change all mentions of the path '#../include' to '#/include' in nvdaHelper's sconscript files.
* Move contents of nvdaHelper's site_scons to NVDA's root site_scons
*Move the nvdaHelper dir out of source and in to the root of NVDA.
* Rename nvdaHelper's sconstruct file to sconscript
* nvdaHelper's archBuild_sconscript: Remove the 'install' target, and at the same time no longer collect built targets to make them be required by the install target.
* NVDAHelper's sconscript (previously sconstruct):  no longer create a base environment from which to clone the arch-specific environments, instead Import  the environment called 'env' and clone from that.
*nvdaHelper's sconscript: import clientDir, sourceLibDir and sourceLibDir64, and pass arch-specific variants of these to archBuild_sconscript.
*nvdaHelper's archBuild_ssconscript: do not hardcode libInstallDir and clientInstallDir, instead import them (given by nvdaHelper's sconscript).
* Remove pointless print statements from NVDAHelper scons files
* Move the commandline variable declarations (such as targetArchitectures and logLevel) from nvdaHelper's archBuild_sconscript and in to NVDA's new root sconstruct.
* rename the 'isRelease' commandline variable in NVDA's new root sconstruct to 'release' to be compatible with nvdaHelper -- it uses it in quite a few places.
*NVDAHelper's remote, client and local sconscript files: change all mentions of the path '#interfaces' to '../interfaces' (we can no longer really use # as its now at NVDA's root.
*nvdaHelper's remote/apiHooks.cpp: explicitly include nvdaControllerInternal.h above common/log.h as for some reason now scons is failing to scan more than one level deep for implicit dependencies -- all other files including log.h already did this.
*NVDA's new root sconstruct: no longer build an nvdaHelper archive (its no longer needed)
*NVDA's new root sconstruct: there is now a target called 'client' which will build the nvda controller client archive.

Further notes:
*As dist (portable, installer etc) depends on source, any nvdaHelper related libs / EXEs that should be in source will automatically get built when needed.
*controller client will no longer get built just because the rest of nvdaHelper is built, unless you specifically tell scons to build the 'client' target.

nvdaHelper displayModel interface implementation of getWindowTextInRect: when collecting text from descendant windows, ignore windows that are invisible according to IsWindowVisible. This among other things stops text from other tabs bleeding through when reviewing a particular propertysheet in a multitabbed dialog (e.g. file / folder properties in Windows explorer).

Unneeded import.

Woops. Not called Tera Term Pro anymore.

Support for automatically reporting new text when it appears on the screen!
To avoid lag and spam, this must be enabled for individual controls using the LiveText and Terminal NVDAObject behaviors and the DisplayModelLiveText overlay class.
Specific support for mIRC, PuTTY, Tera Term Pro and SecureCRT has been included so far.
See those app modules for examples on how to do this for other applications.
Windows text consoles now use this new LiveText/Terminal behavior, which means they use the same monitoring code. This code is similar to the previous code in winConsoleHandler, but has been simplified and improved somewhat.

Update What's New.

Window NVDAObject: redraw(): RedrawWindow() takes client coordinates, not screen coordinates, so convert them first. Fixes failure to redraw some objects.

Remove unused stuff.

speech: Don't use globalVars.keyCounter to determine when to kill the speak spelling generator, as keyCounter is currently not set and this is a pretty dodgy way of doing this. Instead, cancel the speak spelling generator (if any) when cancelSpeech is called. Fixes spelling continuing later after being interrupted.
Fixes #1188.

Add code doc.

LiveText behavior: Minor fixes:
* Clear the event in startMonitoring() just in case it was left set when monitoring previously.
* If there is a stabilise delay, check if monitoring was stopped while waiting. This is unlikely but possible.

App module for SecureCRT which reads incoming text automatically.

WinConsole NVDAObject: Allow 30 ms for the text to stabilise.

LiveText behavior: Ignore single characters like we did in the old winConsoleHandler code, as these are probably typed characters.

Missing import.

LiveText behavior: Remove MIN_CHECK_NEW_INTERVAL and introduce STABILIZE_DELAY instead. This is the time to wait before fetching the text (i.e. before the text is considered stable) after a change event.

LiveText: When calculating new text, don't barf on empty lines.

LiveText monitor thread: Add some exception handling.

Cosmetic.

Check whether a console is dead every 100 ms and disconnect if so to allow it to close.
This used to be done in the console monitor thread, but it doesn't make much sense to do this in the LiveText monitor thread, so use a separate timer.

Remove IAccessible.ConsoleWindowClass NVDAObject, which isn't useful. It was only getting instantiated for the window accessible, which never gets focus.

winConsoleHandler.consoleWinEventHook(): Only fetch console screen buffer info if it is really needed.

Convert Windows Console support to use the new Terminal behavior.
There are a couple of regressions which I have yet to fix.
Also, moving to a console with object navigation no longer causes new text from that console to be spoken, which partially fixes #673.

LiveText behavior: Fix bug where startMonitoring() couldn't be called again even after stopMonitoring(). Also, startMonitoring() now just returns if monitoring has already been started and vice versa for stopMonitoring().

Merge main.

WinConsoleTextInfo: Override the clipboardText property instead of the copyToClipboard() method.

Remove unnecessary code.

Add app module for Tera Term, which automatically reads incoming text.

 gdiHooks: Since rectangles aren't usually useful for text change notifications due to the text changing before NVDA can fetch it, condense notifications even further to just one notification per window per notification interval. A rectangle is still provided in case it is useful, but it encompasses all updated rectangles, which may include text that wasn't updated.

Add an app module for PuTTY, which causes incoming text to be read automatically.

DisplayModelLiveText NVDAObject: Use EditableTextDisplayModelTextInfo, as this gives more accurate information regarding spacing and is needed for caret offset in terminals.

Terminal behavior: Inherit EditableText, as terminals need to handle caret navigation. Don't call super in loseFocus event, as there is no base event.

LiveText._calculateNewText(): Handle lines with different lengths when searching a changed line for the changed section of text. Also, optimise and simplify.

LiveText behavior: Don't report new text if report dynamic content changes is disabled.

Add app module for mIRC. This reads new output text automatically when the input field is focused.

Add NVDAObjects.Window.DisplayModelLiveText, which can be used for NVDAObjects which should automatically report new display text.

displayModel: Allow NVDAObjects to register for text change notifications using requestTextChangeNotifications().
The textChange event will be called on the object when the display text changes.