Dragonfly

.. _Lark-based: https://github.com/lark-parser/lark
.. _Semantic Versioning: http://semver.org/spec/v2.0.0.html
.. _pynput: https://github.com/moses-palmer/pynput
.. _reStructuredText format: http://docutils.sourceforge.net/rst.html

-------------------------

Added
~~~~~
- Add two example command modules under *dragonfly/examples*.

Changed
~~~~~~~
- Make all engine back-ends pass recognition results objects on to grammar
callback functions with a *results* parameter.
- Reallow multiple engine options per "-o" CLI argument.

Fixed
~~~~~
- Add missing *content* constructor parameter to the *Digits* element class.
- Fix Natlink support for recognizing quoted words.
- Fix a *FuncContext* class error affecting Python 3.11 users.
- Fix a Natlink engine error affecting proper recognition of the *Empty*
element.
- Fix a Natlink engine error affecting the use of grammar and rule contexts
in certain cases.
- Fix an error in the *Digits* element class' *value()* method.
- Make all engine back-ends support grammar callback functions.

Removed
~~~~~~~
- Remove recognition observer event *on_post_recognition()*.
- Remove the CMU Pocket Sphinx engine's key phrases feature.
- Remove two aliases of the *do_recognition()* engine method.

-------------------------

Added
~~~~~
- Add an optional feature that allows key and mouse events to be sent to the
foreground window via Natlink.

Changed
~~~~~~~
- Change Dragonfly to stop checking for X11 on Windows and macOS.
- Change the Natlink engine to give preference to user grammars over global
commands.
- Make the *dragonfly.accessibility* sub-package dependencies optional.
- Replace *~/.dragonfly2-speech/settings.cfg* config file with keyboard
class attributes.
- Set the log level of Windows DPI awareness messages to 'info'.

Fixed
~~~~~
- Fix a bug with the Natlink engine where empty grammars cannot be loaded and
unloaded.
- Fix an encoding-related error in the Literal element class.
- Fix an error in the Optional element class.
- Fix a bug preventing double clicking, triple clicking and scrolling with
the Mouse action class on macOS.
- Fix problems with the *dragonfly.accessibility* regex requirement.
- Make the Natlink engine back-end work with newer versions of Natlink.

Removed
~~~~~~~
- Remove *dragonfly.rpc* sub-package.
- Remove multiple engine options per "-o" CLI argument.
- Remove the sphinx engine's built-in microphone asleep feature and training
mode.

--------------------

Added
~~~~~
* Add get_speaker() function for retrieving the specified or default
text-to-speech (speaker) implementation.
* Add eSpeak and CMU Flite text-to-speech implementations.

Changed
~~~~~~~
* Detach text-to-speech functionality from the Natlink and SAPI 5 engine
back-ends and make it available via the get_speaker() function.
* Change Kaldi, CMU Pocket Sphinx and text-input engine back-ends to use the
default or specified text-to-speech implementation for engine.speak().
* Use xdotool for mouse functions on X11 if pynput is not installed.
* Remove the pynput requirement on Linux.
* Remove the requirement to upper-case mimicked dictated words with some
engine back-ends.

Fixed
~~~~~
* Fix incorrect handling of inactive grammars by CMU Pocket Sphinx back-end.
* Remove dictation element limitation effecting most engine back-ends.

--------------------

Fixed
~~~~~
* Fix a problem with the behaviour of the X11Window.close() method.

--------------------

Changed
~~~~~~~
* Change Kaldi back-end to enable local-only pronunciation generation by
default.
* Change accessibility sub-package to use AT-SPI if X11 is detected.
* Give X11 precedence over other platforms in initialization modules.
* Remove deprecation notices for the dragonfly.timer interface (since it
works fine).

Fixed
~~~~~
* Fix Kaldi marking of whether retained utterance has dictation.
* Fix a word pronunciation generation bug with the Kaldi back-end (thanks
`daanzu`_).
* Fix problems caused by relative import statements in the library by using
the absolute form instead.
* Improve X11 detection by checking the DISPLAY environment variable.