Merged addon-packaging branch.
You can now install and uninstall special add-on packages (.nvda-addon files) for NVDA that provide custom app modules, global plugins, braille display drivers and synth drivers. The Manage Add-ons menu item can be found under Tools in the NVDA menu. The User guide provides more info about the Add-ons manager, and the developer guide provides info on how to create these packages for distribution.

addonGui: Change the term bundle to package, as it's more user friendly.

Minor documentation changes.

gui: Rename Tools -> Add-ons Manage to Manage add-ons.

addonGui: Don't use title capitalisation for the "About Add-on" button.

addonHandler:  move state.pickle out of the addons directory and call it addonsState.pickle. This allows quick checking of the addons directory for any content to work out if there are addons or not. General settings dialog's copy settings button:  also check the addons directory when working out if there are custom plugins that will be copied.

Rebrand addons as add-ons in the GUI and documentation.

Fix two spelling mistakes in user guide

Correct serious bug in addonHandler.getCodeAddon that caused an infinit loop when addonHandler.initTranslation was called.

* the curdir variable _must_ be updated for the loop to take effect (I'm almost sure I did write that line...).

Installer GUI: Make sure to set create desktop shortut and run at window logon both to true by default if no previous install of NVDA exists. also if a previous copy is being updated, and it was not previously installed to NVDA's new instal path in Program Files, then let the user know with an extra sentence in the installer dialog. Fixes #2302.

English user guide: added a section explaining the Addons manager, under the Extra tools section.

Updated english Changes file to mention addons

developer guide: add sections about how to create addons by hand.

Handle the situation where files are locked (probably due to loaded c extensions or dlls in the addon's installTasks.py) when an addon tries to get completely removed (this includes if the installation failes). Now the directory will be renamed to a temp name with a '.delete' extension and removed on NVDA restart. Hopefully this should never happen, but its certainly possible.

addonHandler.Addon.isPendingRemove: don't check for this addon in removesSet if isPendingInstall is true. Allows r full removal of a pending installed package, even if another addon with the same name is still marked for removal.

Add the ability for addons to run code at install/uninstall time, and simplify addons in general by removing a few features, at least for 2012.2.
Specific changes:
* Add the concept of install tasks, which are functions  in an addon that will be run at install/uninstall time. onInstall and onUninstall can be defined in the addon's installTasks.py. onInstall will be run after the addon has been copied in to nvda as a pending install, but if the function raises an exception, then the installation will fail. onUninstall is called on NVDA restart after an addon has been marked for removal and just before its directory is deleted. Note that installTasks.py should not load any addon-specific python c extensions or load dlls etc as removal may then fail. This should only be used for copying/removing files or for validating licenses or other info.
* Remove the existing hook implementation for addons for now. There were a few problems such as it loading the hooksModule too early, and possibilities that unLoad may have been never called due to incorrect state. We may eventually have something similar, but probably not for 2012.2. For general initialization/termination code, this could be placed in a global plugin.
* Rename Addon.isLoaded to isRunning to match getRunningAddons and the GUI, and reimplement it simply as being true if isPendingInstall is false. Also remove Addon.load and Addon.unload. This now therefore means any addon that is not currently being installed must be running as its packages are available to the rest of NVDA.
* addonHandler._availableAddons is now an ordered dictionary, and installAddonBundle manually adds the new addon to it. this is so that the GUI can guarantee some kind of predictable order when refreshing or adding to its list of addons.
* addon GUI: don't call getAvailableAddons with refresh=True any more as its no longer needed.
* Addon GUI: rename the 'new' and 'removed' addon status translatable strings to 'install' and 'remove' respectivly to make it a little clearer that the action isn't actually complete yet.
* Addon GUI: Try to select the most appropriate addon in the list after an action completes.
* core: Initialize addonHandler before appModuleHandler.

Make two more messages consistant.

installer.py: now consistant with gui/__init__.py, have the exact same naming/capitilization for 'Keyboard command quick reference'

sconstruct: Remove backwards compatibility aliases for the launcher target.

Update bzr ignores.

launcher: Look for nvda_logo.wav in the launcher directory instead of installer/waves.
This means the installer directory is no longer needed and has been removed.
People running from source will need to manually move this file. A new nvda-media archive has been created which includes the file in the right place.

Launcher: extract the launcher wave file in to the plugin dir itself, rather than the app subdir where NVDA is extracted. Makes sure that the wave file is not accidentilly  copied when installing / creating a portable copy.

Add comment.

updateCheck.UpdateDownloader:
* Make the timer a one-shot timer as it was meant to be, rather than a repeating timer. This could cause exceptions on completion and probably other problems. Oops!
* Set the wx.PD_AUTO_HIDE style on the progress dialog. Otherwise, the ProgressDialog.Update call blocks at 100% until the user presses the Close button.

In browse mode in applications using Mozilla Gecko 14 and later (e.g. Firefox 14), quick navigation now works for block quotes and embedded objects.
The problem was that in Gecko < 14, the value of the tag object attribute is upper case, whereas it is lower case in Gecko >= 14. The latter is more consistent with the rest of Gecko (and Chrome does this too), so the code considers Gecko < 14 to be the abnormal case, even though 14 hasn't been released yet.
Fixes #2287.

NVDAObjects.IAccessible.mozilla: Remove the _ prefix on _getGeckoVersion, as external code may well use it in future. It now returns a namedtuple containing the full version string and the major version number as an int to make comparison easier.

In addon manifest convert all strings to unicode (translated and untranslated) using configobj default_encoding parameter.
Assumed encoding for all manifest data is utf-8, and the manifest file is decoded using this codec. No automatic encoding detection (as per configobj support) is atempted.

Report graphics and alt text in Microsoft Word.

Minor addon manifest translation changes:
* Removed translated configSpec since it is not used.
* When merging translated fields convert translated strings to unicode to avoid strange decode errors on the addons gui.

Merged main

Remove the files for the old NSIS installer. The installer directory still exists until we move the logo sound.

JAB returns -1 for line offsets when querying the end insertion position instead of returning the offsets for the last line. Therefore, try one character back.
This means that the current line is reported correctly when at the end of the text.
Fixes #1892.

JABHandler.JABContext.getAccessibleTextRange: Return an empty unicode string when the text length is 0 instead of a non-unicode line feed. Fixes weirdness in braille caret/selection reporting.
NVDAObjects.JAB.JABTextInfo._getLineOffsets: JAB can return -1, so normalise this to 0. JAB can return strange characters when passed -1, so this change prevents this from happening.
Fixes #2284.

Addons dialog: Always make sure that an addon is selected when the list gets the focus and there is content in it. Also enable/disable the buttons appropriately depending on what is selected in the list (e.g. can't remove a removed addon, can't view addon info on a removed addon, can't view addon info or remove if nothing is in the list).

Turkish (tr):
  userGuide.t2t matching 5126
  nvda.po matching 5128

Tamil (ta):
  userGuide.t2t matching 5126
  nvda.po matching 5128

Portuguese (pt_PT):
  nvda.po matching 5113

Brazilian Portuguese (pt_BR):
  userGuide.t2t matching 5126
  changes.t2t matching 5132
  nvda.po matching 5128

Authors: Cleverson Casarin Uliana <clever92000@yahoo.com.br>, Marlin Rodrigues <marlincgrodrigues@yahoo.com.br>

Polish (pl):
  changes.t2t matching 5059
  nvda.po matching 5128

Norwegian bokmål (nb_NO):
  nvda.po matching 5128

contributors.txt: Added new French and Japanese translators.

Japanese (ja):
  nvda.po matching 5128

Italian (it):
  userGuide.t2t matching 5126
  changes.t2t matching 5128
  nvda.po matching 5128

French (fr):
  changes.t2t matching 5132
  nvda.po matching 5114

Authors: Michel such <michel.such@free.fr>, Patrick ZAJDA <webmaster@gansta93.com>

Finnish (fi):
  userGuide.t2t matching 5126
  changes.t2t matching 5132
  nvda.po matching 5128

Galician (gl):
  userGuide.t2t matching 5126
  changes.t2t matching 5132
  nvda.po matching 5128

Spanish (es):
  userGuide.t2t matching 5126
  changes.t2t matching 5132
  nvda.po matching 5128

Greek (el):
  nvda.po: 97% matching rev 5128
  characterDescriptions.dic

New localization,
Greek translation provided by Gerasimos Xydas (e-rhetor) on behalf of The Hellenic Technology for the Blind Development Association (STAT)
Many Thanks.

Czech (cs):
  nvda.po matching 5113

More addon changes:
* addonHandler.AddonManifest has been changed slightly so that description has been renamed to summary and long_description has been renamed to description. also for now categories have been removed as there is no support for it at the moment.
* addonHandler.AddonManifest no longer has a '_' method, instead summary and description are pulled from the translation if they exist at construction time. Certainly makes some GUI code much simpler.
* Addons dialog: add an About Addon button which will show a message box with all the addon info (summary, version, author, url, description).
* The list in the Addons Dialog now  no longer shows description, instead its author in its place.

German (de):
  developerGuide.t2t
  userGuide.t2t matching 5126
  changes.t2t matching 5132
  nvda.po matching 5128

Authors: Bernd Dorer <bernd_dorer@yahoo.de>, David Parduhn <xkill85@gmx.net>

Danish (da):
  nvda.po

More addon changes:
* If the user requests to remove an addon, it is now only marked for removal in a separate state file, and really only removed on NVDA restart. (its too dangerous to try to delete files or rename directories while the addon may still be in use).
* If the user installs an addon, its copied in to the addons directory, but has a special pendingInstall suffix and is marked as needing install completion on NVDA restart. (We need this delay as addons with the same name marked for removal have not yet moved out of the way).
* If the addon has just been installed (no restart yet) and the user removes it, the addon is fully removed there and then.
* The list in the Addons dialog now has a Status column which shows one of the following translatable strings: new, removed, or running.

Merged Rui's addons-packaging branch on launcchpad

Better cleanup of removed addons:
* addonHandler.Addon.removecontents: If not all of the addon could be deleted, rename the directory to a temp name with an extention of ADDON_REMOVED_EXTENSION (.removed). Also remove the ignore_errors argument as it really can't be changed anymore.
* addonHandler._getAvailableAddonsFromPath: do not include directories marked for removal.
* addonHandler: add a 'cleanRemovedAddons' function which  removes any addons marked for removal.
* addonHandler.initialize: before loading any addons, call cleanRemovedAddons (which gets rid of any addons that failed to be removed on last run of NVDA).

Make manifest._ return an unicode string.

Merged addon-packaging from nvaccess. Simple update did not work due to a not-pushed trivial commit.

No point in a late import when the module is imported earlier elsewhere anyway.

updateCheck: Implement the cancel button in the update download dialog.
As part of this, use a timer instead of wx.CallAfter, as it seems wx.ProgressDialog.Update pumps before returning, which means CallAfters can execute within it. Re-entrancy like this causes all sorts of pain here, which is prevented by the timer because timers aren't re-entrant.
This CallAfter problem is probably also what was causing the crash in #2228, as Destroy could be called on the ProgressDialog before Update returned. Nasty.
Fixes #2259.

Fix for #2276 (tree in Elements List was hard or impossible to see). Patch from NVDAJP

The file extension for addons is now nvda-addon not nvda-adon. Also make  the File type label in the Choose addon dialog translatable.

VirtualBuffer.getEnclosingContainerRange: allow the user to jump t the start or past the end of container elements even though the user has configured  the particular element they're in to be not reported. #123

Added a basic GUI for managing Addons. Find it under Tools in the NVDA manu. It allows you to add and remove them. If adding or removals have happened and you close the dialog, you will be asked if you wish to restart NVDA. If trying to install an addon with the same name as an already installed one, for now you will be told to remove the xisting addon and try again.

gui: move IndeterminateProgressDialog out of installerGui.py and into __init__.py so it can be used by more code.

Add translator comments.

gui: add an ExecAndPump class, which allows you to execute a given function, along with the given args and kwargs, in a background thread, while the current thread blocks and pumps.

What's New: Add ticket number. Fix typo. Minor linguistic fixes.
Fixes #2275.

Merged main

Addressed review comments for #123 implementation - mostly translator comments.

contributors: Fix capitalisation of a name. Remove unnecessary blank line at end of file.

addonHandler: support falling back to base locales when looking for translated manifested (e.g. fr_CA becomes fr becomes en). Also fix a small typo.
specific changes:
* rename addonHandler._translatedManifestPath to _translatedManifestPaths and have it return a list of possible locale paths in the order they should be tested.
* addonHandler.Addon and addonHandler.AddonBundle: their constructors try each locale manifest path in turn until one succeeds.
* addonHandler.AddonBundle: z.open throws KeyError not IOError if a file can't be found, also 'R' should be 'r' (lower case).

Change references to languageHandler.curLang to languageHandler.getLanguage()

Implementation of #123 (quick nav scripts to jump to the start, or past the end, of the current containing element). Use "kb:shift+," and "kb:shift+." (< and >). Should be able to work within tables, lists, multiline edit, frames, blockquotes, editable documents (pretty much anything that would announce "out of xxx").

Implement support for addon manifest translation.

* Addon manifest translations must be kept on <addon>\locale\<lang>\manifest.ini
* Only description and long description are supported.
* AddonManifest can receive an optional argument with a file-like object for the translation data (Addon and AddonBundle must provide it since retrieval is diferent).
* AddonManifest has a new _ methodto retrieve translated data. For instance manifest._('description')
* Other minor code tweaks and cleanups.

Merge main.

Minor change in initialize.

Make sure that creation of appModules always happens in the main thread, even when created because of nvdaControllerInternal_requestRegistration. A part from appModuleHandler.runningTable being mutated during removal of old appModules, it also meant that sometimes two appModule instances for the same process were being created, but only one of them ever received an rpc binding handle. This would cause displayModel or virtualBuffers not to work for the life time of an app or until NVDA was restarted.
Specifically:
* appModuleHandler.update: allow a helperLocalBindingHandle and an inprocRegistration handle to be passed in as optional keyword arguments. If given then they are set on the module gotten/created.
* nvdaHelper.nvdaControllerInternal_requestRegistration: rather than fetching an existing/new appModule directly, just queue a call to appModuleHandler.update giving a process ID and the binding and registration handles so that they get set on the existing/new appModule.
* Revert the recent change to appModuleHandler.update protecting against dictionary mutation (#2258) as this no longer can happen -- if so we want to know about it.

displayModelTextInfo._textAndRects and Window NVDAObject's displayText property: handle the case where there is no binding handle available and log a debugWarning and return an empty string. Should fix #2258

appModuleHandler.update: its now possible for appModules to be created in other threads (nvdaControllerInternal_requestRegistration) so therefore we must use values not itervalues when looping through runningTable looking for dead modules. This should stop  a runtimeError complaining that the dictiony had changed during iteration.

Got ride of the _runningAddons global variable. We can get loaded addons by filtering availableAddons by the isLoaded property.

Further than addons that could not be loaded for some reason (code errors, damaged files, etc) if we want to support activation and deactivation of specific addons without removal from the first system, this separation is needed.

Corrected stuppid bug that prevented nvda to start: running addons, when addonHandler is not initialized, should be [].

merge main.

Another try at fixing #2254 (crashes on process exits in XP). As we are now loading minHook after nvdaHelperRemote (its not a static dependency) Windows is unloading minHook before nvdaHelperRemote on process exit. Therefore handle this situation.
Specific changes:
* minhook.dll: add a dllmain function which, on process exit, disables any hooks, waits for 250 ms for hooks to complete and then  uninitializes.
* nvdaHelperRemote: Don't mark minhook.dll for delay loading, instead just rely on LoadLibrary and GetProcAddress all the way. Although its a bit more fiddly, at least I understand exactly what is going on.
* nvdaHelperRemote's apiHooks_terminate: If the process is exiting, don't do anything. Windows will automatically free libraries, and minhook having been loaded late will have been unloaded by Windows before nvdaHelperRemote and its dllmain function will have cleaned up its hooks.

Hopefully stop crashes in apps when they exit on XP (#2254).
Specific changes to nvdaHelperRemote:
* Declare isProcessExiting extern in dllmain.h and use it in apiHooks_terminate to return early to stop freeing libraries if the process is exiting -- its dangerous to call LoadLibrary or FreeLibrary when dllmain is being run.
* dllmain: If the process is exiting, also unregister any in-context winEvent hooks. Seems that winEvents kept being fired on process shutdown trying to install IA2 support over and over again -- until the whole thing fell over due to it trying to log an error via a freed rpc binding handle.
* dllmain: only free nvdaController and nvdaControllerInternal binding handles if the process isn't exiting. If it is the OS will clean it up anyway and we want logging to work for as long as possible.

merge main

Major refactoring to support addon specific translations.

* Refactored getAvailableAddons and getRunningAddons. Internally addons can be queried by path to facilitate identification of currently calling addon.
* addonHanler.getCodeAddon() retrieves the addon instnace for the calling addon, using stack inspection.
* addonHandler.initTranslation() adds the ettext _ function to the calling module to support addon specific translation (it relies on addonHandler.getCodeAddon internally).
* Many more minor tweaks and corrections.

Merged win8Injection branch. This means that installed releases of NVDA can now hook into metro style apps, enabling features such as speaking typed characters, browse mode for web documents (including full support for metro version of Internet Explorer 10), and displayModel (if GDI is ever used). Please note that this will *only* work if NVDA runs with the uiAccess privilidge, which for now only is installed official releases (not snapshots or any portable copies).
A lot of NVDA's rpc and injection code needed to be rewritten to handle metro style apps. Therefore please watch out for and report any weirdness resulting from this revision (especially on Operating Systems before Windows 8).

update changes file

updateCheck: Why calculate when we don't need to? :)

installerGui:
* Remove the "Installation options" grouping, as it is redundant and creates extraneous verbosity.
* Place the options vertically instead of horizontally.
* Call mainSizer.Fit so that everything actually fits in the window properly.

gui: Move About below Check for update in the Help menu for consistency with most other apps.
Fixes #2251.

Add translator comment for "no navigator object".

Add translator comments for reporting of formatting.

nvdaHelperLocal's startServer:  while we're fiddling with rpc and doing lots of testing, convert this code to use auto-listen interfaces just like nvdaHelperRemote does, rather than having to create a thread to run a specific server.  !. dlls are supposed to do this, and 2. There has always been a chance that our rpc server thread had not yet fully initialized before  the first remote code was run.

nvdaHelperLocal's createRemoteBindingHandle: on versions less win8, the 'AC' sid is unknown therefore ConvertStringSecurityDescriptorToSecurityDescriptor fails. Only try making the security descriptor and calling RpcBindingSetAuthInfoEx if RpcServerRegisterIf3 exists in rpcrt4.dll (i.e. this is Win8 or higher) -- same check as in startServer. This allows correct running on Win7 and Xp (sp3 tested so far).

nvdaHelperRemote: Create the nvdaUnregisteredEvent initially as signaled rather than unsignaled. This means that if there is some kind of error and NVDA never gets to register, then the inproc code will appropriately terminate as soon as it can.

nvdaHelperRemote: Make sure that minhook.dll really gets unloaded properly when apiHooks_terminate is called. This means calling FreeLibrary to match our explicit LoadLibrary in apiHooks_initialize, telling the linker to support delayLoad unloading with /delay:unload, and also by calling __FUnloadDelayLoadedDLL2("minHook.dll") to cleanly unload the delay loaded minHook.dll. Also pass /delay:nobind to the linker as this can speed up loading a bit as we never need to supported pre-bounded dlls, in fact this would be bad for minhook anyway.

Fix a typo in a log call

merged main

Create a addonHandler.getRunningAddons() function to abstract internal tracking of running addons.

Changed runningAddons to _runningAddons to make it "module-private" and a dictionary keyed by addon.path. This would be important for nvda to trac from what addon belongs a specific object (by inspection) so add-on localization for instance can be implemented. This is subject to change though.