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.

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.

Merge main.

Refactor the build process to allow anyone to create binary distributions, portable archives, installers and gettext translation templates with a simple command, including setting the version number and signing with a supplied certificate file.
scons is used to facilitate this. All builds should now be done using scons at the top level of the source distribution.
See the updated instructions towards the bottom of the source readme for details on how to use this.
Note that you can no longer build an installer directly by using makensis.

nvdaHelper: implement support in display models for scrolled windows by hooking ScrollWindow and ScrollWindowEx. This implementation makes use of displayModel_t::copyRectangle to move a given rectangle in a display model.

NVDAHelper: displayModel_t::copyrectangleToOtherModel: rewritten to support new features, allow it to propertly copy from/to the same model, and to be more understandable. Specific changes:
*Rename to "copyRectangle", as the destination model is optional, meaning that the copy could occure all in the one model.
*Rename the arguments otherModel, otherX and otherY to destModel, destX and destY respectivly.
*Move the destModel argument to the end as its optional.
*Rename the clearEntireRectangle argument to opaqueCopy.
*Add a removeFromSource argument, which if True means that  the copy should act like a move (i.e. the content is removed from the source model). This will hopefully be useful when implementing support for scrolling.
*Add an optional destClippingRect argument which allows you to provide a clipping rectangle which should clip all content being copied in to the destination model. Again useful for implementing scrolling support.
*Make copies of all the chunks before doing any clearing,rather than after,  so that copying from/to the same model correctly works. Both bltBlt and scrolling support need this.

nvdaHelper: hook all functions using apiHook_hookFunction_safe, at the same time catching and fixing some coding errors, which may have caused, or been the future cause of, some crashes. Specific code error fixes:
*ExtTextOutHelper: lpString must be const.
*TextOutA and TextOutW: the return type is int, not bool (lowercase), and lpString must be const.
*PolyTextOutW and PolyTextOutA: do not use our own custom WA_POLYTEXT template struct, instead  make the hookClass_PolyTextOut template class take the POLYTEXTA or POLYTEXTW as its template argument rather than just char or wchar_t. Although that sort of worked in the past, for actual verification of function signatures a custom struct can't be used.
  *ExtTextOutA and ExtTextOutW: lpString should be const, cbCount should be UINT not int, and lpdx should be INT (uppercase) not int (lowercase).

nvdaHelper: added a much safer way of hooking functions, that verifies the function signatures at compile time.
If using apiHook_hookFunction_safe it is now impossible to use the incorrect function signiture for the real function symbol, the real function variable, or the fake function symbol. They *must* match, or else it doesn't compile.
To now hook a function, do something like real_GetDesktopWindow=apiHook_hookFunction_safe("USER32",GetDesktopWindow,fake_GetDesktopWindow).
The only difference on the outside is that a real defined function symbol must be used as the real function name rather than a string. This does mean though that you must have the header file for the function in order to hook it. Either that or at least have defined it somewhere in the same file, though this would not be any more safer than the older method.
How it works internally:
apiHook_hookFunction_safe is a macro that takes 3 arguments: moduleName, realFunction and fakeFunction.
apiHook_hookFunction_safe calls apiHook_hookFunction_tpl with these arguments, plus a stringified version of the realFunction argument.
apiHook_hookFunction_tpl is a template function which takes a moduleName string, a realFunctionName string, a realFunction symbol, and a fakeFunction symbol. Its template argument is a typename called funcType, which it deduces from the realFunction and fakeFunction signatures, which must match. It also returns a symbol of type funcType, which again will match the other two function symbols.
apiHook_hookFunction_tpl calls the original apiHook_hookFunction, hooking the function in the normal way. The macro and the template are only there for safety purposes at compile time.
 The only limit to this new way of hooking is that the symbol hooked in the particular module must have exactly the same name as the symbol defined in the header file. Plus a header file should be available containing this symbol you are hooking. If these limits are a problem then apiHook_hookFunction can be used directly, but when possible it is very important to use the safer version.

Merge 2010.2. Change sfrom the fi and pl gettext (.po) files have not been merged due to conflicts.

Fix access to some Windows Security dialogs such as the dialog that appears when installing unsigned drivers.
It seems that custom window messages cannot be sent to these dialogs, so sending our custom ping message returns an access denied error, which causes IAccessibleHandler.accessibleObjectFromEvent() to fail.
This custom ping message was implemented to fix Windows Live Messenger 2009 exiting on startup (#677). Instead, just use WM_NULL (which can be sent to these dialogs) and implement a specific condition to ignore the problematic event from Messenger.

versionInfo: Set version to 2010.2.

Updated traditional chinese language file and user guide.

ScriptableObject: Don't store instance methods in the gesture map, as this causes circular references and therefore memory leaks. Instance methods are meant ot be generated on retrieval anyway. Therefore, store the function from the class and create the instance method when the script is retrieved.

Updated croatian language file.

Added Russian changes in t2t format

Updated german language file user guide and changes.

Oops. Remove duplicate line.

gui: Keyboard Settings dialog: Display translated keyboard layout names. The possible layouts and their translatable strings are  defined in KeyboardInputGesture.LAYOUTS.
Fixes #558.

Allow gestures to be specified on the class and then magically bound when the class is instantiated.
This is done by using an __gestures dict on the class.
Note that gesture binding using bindGesture is still possible. It is also encouraged when it is more efficient/elegant to do so, such as when many gestures are bound to the same script.

Updated Arabic nvda.po and the userguide.

logHandler: Log RPC_E_DISCONNECTED at debugWarning.

Updated Arabic nvda.po and the userguide.

VirtualBuffer.prepare: force shouldPrepare to False so that if shouldPrepare is checked again in the same core pump cycle after prepare is called it won't  be True.

VirtualBuffer.shouldPrepare: fix logic.

Updated finnish language file and changes.

TreeInterceptor.shouldPrepare: this property should be cached per core cycle.

Updated hungarian user guide and changes.

Try at supporting late-loading Gecko documents containing subdocuments that are already loaded. I.e. make sure that we never get stuck in a buffer for the subdocument accidentily. Specific changes:
*TreeInterceptor: add a prepare method which should prepare the treeInterceptor in some way (e.g. load a buffer).
*TreeInterceptor: add a shouldPrepare property, which indicates if this treeInterceptor needs preparing (i.e. prepare should be called soon).
*treeInterceptorHandler.update: rearrange a bit so that  we only return an instanciated treeInterceptor once in the function. Also  before returning this treeInterceptor, check shouldPrepare and if necessary call prepare.
*NVDAObjects.IAccessible.mozilla.Document.treeInterceptorClass:  do not refuse to return a treeInterceptor class if the document is busy.
*base VirtualBuffer.__init__: no longer automatically call loadBuffer.
*Base VirtualBuffer.prepare: call self.loadBuffer
*(Base VirtualBuffer.shouldPrepare: the buffer should be prepared if it hasn't been prepared (VBufHandle is None) and its not currently being prepared (isLoding is False)
*Gecko IA2 virtualBuffer's shouldPrepare property: True if the Base virtualBuffer's shouldPrepare property says so, but only also if the busy state on the root NVDAObject is not there.
  *eventHandler.doPreDocumentLoadComplete:  call treeInterceptorHandler.update on the object no only if  the object has no treeInterceptor, or its not alive, but also if shouldPrepare is True.

These changes now mean that Gecko IA2 buffers will get created even if a document is busy, but no actual buffer content will be loaded. However once the document is no longer busy and there's a documentLoadComplete event, or the focus moves on or inside the document, the buffer content will be loaded.

Updated finnish changes.

keyboardHandler: In the key down and key up callbacks, save the (vkCode, extended) tuple in a variable near the top and use that instead of continually generating it. This looks nicer and is slightly more efficient.

keyboardHandler: Don't continually pause and resume speech when the shift key is held down (sounds like stuttering). Speech only resumes when shift is released and pressed again.
Fixes #989.

Updated czech language file.

Updated hungarian user guide.

VirtualBuffer.event_caretMovementFailed: fix typo

Fixes #992

Tree interceptors/virtual buffers:
* Remove the isTransitioning attribute on TreeInterceptor. This was basically just a hack to stop buffers from being killed while they are loading. Instead, buffers have an isLoading attribute and all buffers now return True for isAlive if isLoading is True.
* Add an isReady attribute to TreeInterceptor which defaults to True in the base class. VirtualBuffer overrides this to return False if the buffer isn't fully loaded.
* Events and scripts are not executed on tree interceptors if isReady is False. Practically speaking, this was always the case for events, but scripts previously executed regardless.
Always as making As well as making some code a little more elegant, these changes allow tree interceptors to be created early but not used until they are ready.

msnmsgr app module: OldMSNHistory: Fix calls to super. Should hopefully fix recently introduced exceptions in MSN Messenger 2009 (#988). Also a slight cosmetic change. :)

Updated polish language file.

Updated polish language file.

Remove  some delphi IAccessible NVDAObjects to do with dialogs and propertyPages, and instead create one delphi class called Form, which forces role to dialog, and inherits from behaviors.Dialog, and  another class called TabSheet, which forces role to propertyPage and also inherits from behaviors.Dialog.  These classes are now used in IAccessible's _staticMap. Also the TMessageForm window class is now mapped to delphi.Form in _staticMap, which allows dialogs in GoldWave to announce their caption properly. Fixes #863.

Updated italian language file and added italian changes in t2t format.

Added polish user guide in t2t format.

VirtualBuffer: refreshBuffer script: Don't try to refresh if the buffer is still loading.

MSNMSGR appModule: automatically announce new messages in Windows Live Messenger 2011. Specifically: rename MsnHistory to OldMSNHistory, and create a new MSNHistory class, which is similar but reimplements the value property using accValue directly as it would have got lost when inheriting from Edit and so forth. Also this new class does not inherit from CursorManager as its not needed due to better edit support.  Note also that ChooseNVDAObjectOverlayClasses has a much easier time of detecting this object with the last history item in it as the role is alert and the accState is alert_medium (we don't have to resort to using the localized history names anymore). Of course support for older MSN messengers is still there, and *hopefully* should not be broken

Fixed a problem where selection changes were no longer reported in Microsoft excel after an inputFramework merge. Specifically I've explicitly called initOverlayClass in the __init__ method of a ExcelWorksheet class because initOverlayClass is not called for the initially constructed object. Of course we may change this in the future we just need to decide whether we do want to call initOverlayClass for all classes.

Added simplified chinese language file and user guide,
Updated traditional chinese language strings for the NVDA installer,
Updated simplified chinese language strings for the NVDA installer.

Updated finnish language file, user guide and changes.

Fixed a problem where pressing the so called dead key to type accents on non-english keyboards would cause an error while retrieving the name of the key. As far as I know this key has no name so at least NVDA now fails silently.

Updated portuguese readme and language strings for the NVDA installer.

sndrec32 app module:
* Explicitly import _default from appModules. All new app modules should do this. We'll eventually need to change old ones to do this too.
* Avoid double dict lookup.

Miranda-IM appmodule:
* Fixed gesture binding for Miranda-IM specific buttons and links
* Fixed default action custom implementation for the Miranda-IM specific buttons and hyperlinks
* No longer incorrectly subclass root IAccessibles

Updated french language file,
Updated slovak language file, user guide and changes.

Updated portuguese user guide.

keyboardHandler, inputCore: Arrrg! Use unicode strings with .format(), as we are passing unicode arguments. Should fix exceptions when typing non-ASCII characters.

keyLabels: Change numpad key labels according to the rename in vkCodes, since i forgot to update keyLabels when I did that. :)

vkCodes: Name VK_CANCEL "break", as the key is normally called pause/break.

Updated traditional chinese user guide.

keyboardHandler.internal_keyDownEvent(): cosmetic: Always return True if the bottom of the function is hit. Currently, we always returned before hitting the end of the function anyway so there's no functional change, but it's best to be 100% clear about this in the code.

Speak punctuation keys in input help even when speak punctuation is disabled.
Fixes #977.

speech: Improve docstrings.

speech:
* Add an expandPunctuation parameter to speakText() which allows the caller to explicitly specify whether punctuation should be spoken. If None (default), the config is used.
* Remove processText and rename processTextSymbols to processText. The old processText simply called processTextSymbols with the configured punctuation setting.

cursorManager: Provide the ability to select by page and paragraph. In practical terms, this means that this is now possible in virtual buffers.
Fixes #639.

cursorManager: Rename pageUp and pageDown scripts to make them consistent with the other movement scripts.

New input handling framework!
This provides core functionality required for future enhancements, including a more flexible input mapping system, handling key presses from other sources such as braille displays, and automated testing.
It also includes several improvements and fixes related to keyboard handling.
Work on the major enhancements hasn't yet begun, but merging this now gives the new code some exposure and gives developers more time to familiarise themselves with the new concepts.

Changes for users:
*Keyboard help has been renamed to input help to reflect that it handles input from sources other than the keyboard.
*The location of a script in the code is no longer reported in input help, as it is irrelevant and cryptic to the user.
*When NVDA detects that it has frozen, it continues to intercept NVDA modifier keys, even though it passes all other keys through to the system. This prevents the user from unintentionally toggling caps lock, etc. if they press an NVDA modifier key without realising NVDA has frozen. (#939)
*If keys are held down after using the pass next key through command, all keys (including key repeats) are now passed through until the last key is released.
*If an NVDA modifier key is pressed twice in quick succession to pass it through and the second press is held down, all key repeats will now be passed through as well.
* The volume up, down and mute keys are now reported in input help. This could be helpful if the user is uncertain as to what these keys are.
*If an NVDA modifier key is pressed twice quickly but there is an intervening key press, the NVDA modifier key is no longer passed through on the second press.

Changes for developers:
* All input from the user is now represented by an inputCore.InputGesture instance.
* Each source of input subclasses the base InputGesture class. For example, key presses are encompassed by the keyboardHandler.KeyboardInputGesture class.
* All scripts now take an InputGesture instance instead of a key press.
* KeyboardInputGestures can be sent on to the OS using the send() method of the gesture.
* To send an arbitrary key press, you must now create a KeyboardInputGesture using KeyboardInputGesture.fromName() and then use its send() method.
* The key names used by NVDA (including key maps) have been made more friendly/logical; e.g. upArrow instead of extendedUp and numpadPageUp instead of prior. See the vkCodes module for a list.

Update What's New.

Remove developer_docs. This only contained "key list.txt", which is now totally incorrect.

Update for new key names.

KeyboardInputGesture: Make layout an instance variable. The current layout is fetched from the config in the constructor so that the gesture knows what layout it was created in.

ScriptableObject: Add clearGestureBindings() to remove all gesture bindings.
AppModule.loadKeyMap(): Clear all gesture bindings on the app module before loading the key map to allow for reloading.

Added traditional chinese user guide in t2t format,
Updated traditional chinese language file,
Updated portuguese language file, user guide, readme and language strings for the NVDA installer.

Update What's New.

keyboardHandler: If the NVDA modifier is pressed twice to pass it through and it is held down on the second press, keep passing the repeats through until the key is released.

keyboardHandler: If an NVDA modifier is pressed twice but there was another key pressed between, don't pass the NVDA modifier through. It should only be passed through if the NVDA modifier is pressed twice in quick succession with no intervening key press.

keyboardHandler: If the user holds down keys while passing keys through, continue to pass all keys through until the last key is released.

inputCore: Add module docstring.

Don't report the script's location in the code in input help, as it is irrelevant and cryptic to the user.
Also remove scriptHandler.getScriptDescription() and just directly use __doc__, as this is a fairly standard Pythonic concept.

Move the check for the core being dead from keyboardHandler hooks to InputManager.executeGesture().
This stops the NVDA modifier from being passed through even when the core is dead. Previously, if NVDA froze briefly and the user didn't realise, they could, for example, press caps lock for the NVDA key and it would be toggled without them realising.
This will also stop a potential flood of queued actions from other sources (e.g. braille) when the core revives.

KeyboardInputGesture.fromName(): Handle the case where a character requires multiple modifiers as reported by VkKeyScan().

Cancel speech when volume keys are pressed while input help is active.

treeInterceptorHandler.killTreeInterceptor(): Log a debug message upon successful completion.

Updated polish language file (by Andrzej Kałuża)

Updated Arabic changes, userguide.
Updated hungarian changes.

Updated finnish language file and user guide.

Merge main.

Merge 2010.2.

Make KeyboardInputGesture.fromName() case insensitive for key names.

vkCodes: Add copyright header and code documentation.

Remove old (now useless) code from keyUtils. This only leaves the key labels, so rename it to keyLabels.

Lower case identifiers in KeyboardInputGesture.identifiers instead of ScriptableObject.findScript(). The latter gets called more often than the former and is not cached, so it is more expensive.

KeyboardInputGesture.send(): Fix sending of Windows key as a modifier.

KeyboardInputGesture: Again use upper case for the NVDA modifier key now that we handle normalisation separately.

appModule key map (kbd) files: Update for new key names. Also, just for prettiness, make everything consistent: NVDA key is always first and always capitalised, no other keys start with a capital letter.

Change key names for numpad keys when numLock is off to conform to the User Guide; e.g. numpadLeftArrow is now numpad4. In order to do this, numpad4 with numLock on is now numLockNumpad4, etc.

Update for new key names.

Woops. Missed this during a merge.

Update appModules for new gesture binding code.

Updated Arabic changes, userguide and added a new contributor to the Arabic team.

Update NVDAObjects for new gesture binding code.

Update editableText for new gesture binding code.

Update cursorManager and virtualBuffers for the new gesture binding code.

Use more user friendly names for keys on the keyboard.
vkCodes now maps between vk codes and these new names, rather than using Windows vk names, which are often rather odd; e.g. prior instead of pageUp.
Updated other code accordingly.
Also some fixes to KeyboardInputGesture regarding text characters.