Dogtail

=============
A first update to the new GNOME3 / KDE4 compatible release containing several fixes:

* Sniff's autorefresh made togglable, to help avoid collisions with potential
running dogtail scripts. Sniff checks at startup whether some script is running
and sets up the autorefresh off if it is.

* Added a locking mechanism into utils that can be used to solve situations when
multiple dogtail processes/thread are running (applied in tree/procedural and sniff
already)

* Removed the deprecated dependency on CORBA

* Icons no longer use absolute pathing in sniff (thx roignac)

* Deprecated .has_key() operator replaced with 'in'.

* Removed .svg inside sniff's .desktop file

=============
Finally a big release updating dogtail after more than 2 years ! Dogtail
is developed and maintained now again.

Simply put, ported to be compatible with the new GNOME 3 and to work well in major
GNOME 3 (GTK3) distributions.

We'd like to make the 0.8.x version onward the GNOME 3 compatible branch usable
for Fedora, RHEL7 and others, while keeping 0.7.x releases for fixes in older GNOME2
systems.

--- What was done ---

Notably, Sniff's UI needed to ported completely to GTK3, yet there are
also several places in dogtail 'itself' that needed to be rewritten to go ahead
with the new technologies. Those were all the modules where the old pygtk was
used for various reasons (rawinput, utils, tree...). Incompatibilites were also
present due to the new version of pyatspi (notably with the doAction method).

Release highlights:

* A great number of fixes everywhere related to GTK/GNOME/At-Spi updates

* The dogtail-recorder was dropped for now, but might return in RC or 0.8.1

* Thanks to the qt-at-spi project, dogtail now works out-of-the-box for QT!

* Headless supports KDE sessions

* Headless working with full 3D-Accelerated GNOME session (no fallback anymore)

* Highlight used in sniff completely re-written and made toggleable (of by default)

* Makefile updated, 'make run' builds packages in homedir/rpmbuld now

* Several examples fixed for updated gedit

* Added tree.isChild() convenience method

* Renamed doAction to doActionNamed due to conflict with doAction inside
pyatspi namespace

* Delay made configurable in absoluteMotion and relativeMotion functions

* Changed at-spi activation to use DConf instead of GConf

* A bit of code clean-up and modernization (using property now etc.)

* More error checking added

* A couple of unit tests for Node added

* Node.findChildren() updated to be faster

=============

This release has too many changes to list. Here are some of the major ones:

* Dogtail has been ported to pyatspi. This means:
- Faster performance.
- Errors will be more clear.
- No more segfaulting or myserious crashes.

* There is now useful generated API documentation:
http://fedorapeople.org/~zmc/dogtail/epydoc/

* Inline documentation has been greatly improved.

* Headless execution support was completely rewritten.

* Sniff was completely rewritten. It is now:
- Faster.
- More reliable.
- Self-updating via AT-SPI events.
- Slightly prettier.
- Able to tell you about certain states and relations.

* Image Comparison (TCImage) was rewritten. No more ImageMagick!

Note: tests/Node.py's TestNodeAttributes is failing due to GNOME bugs 498557
and 498563

=============

Features:

* dogtail-recorder has a Play button now.

* dogtail-recorder now records right-clicks. That it didn't previously was an
oversight. Note that there is some inconsistency when dealing with context
menus, as the events often get fired in the wrong order.

* New logging mechanism:

- Debug output is now written to a file. To disable this, set
dogtail.config.config.logDebugToFile to False.

- The procedural API defaults to not raising FocusErrors, and instead
issuing warnings via the debug logging mechanism (which prints to
standard out along with writing to a file). To re-enable FocusErrors, set
dogtail.config.config.fatalErrors to True.

* Brian Cameron submitted a patch to make dogtail.distro correctly detect that
it is running on Solaris.

Bugfixes:

* dogtail-recorder no longer offers the broken Object-Oriented backend as a
choice. If it gets fixed, it will be offered again.

* dogtail-recorder can be properly exited by clicking on the window manager
close button. In fact, the Quit button was removed also.

* dogtail-recorder's syntax hilighting works again, thanks to a patch from
Dave Malcolm.

* Searching for nodes with parentheses in their names will no longer fail.

* The various pressKey() functions were blowing up on punctuation and
newlines. Fixed.

* Predicate subclasses in dogtail.predicate which were missing debugNames have
gotten them back.

* Warnings are no longer issued when dogtail encounters invalid Unicode.

* Where several of our example scripts were broken, Michal Babej noticed and
submitted patches fixing them.

* dogtail's tarball is 90% smaller! Some overly large test images were
replaced with very, very small ones that still do the job.

=============

Features:

* Keystroke recording support in dogtail-recorder:

- Normal keypresses (e.g. typing 'foo bar baz') will be recorded as
"type('foo bar baz')" in the procedural API. dogtail.tree.Node has a new
method, typeText(), which is called by dogtail.procedural.type().

- Nonprintable keypresses (e.g. typing Control-Shift-c) will be recorded as
"keyCombo('<Control><Shift>c')" in the procedural API. dogtail.tree.Node
has a new method, keyCombo(), which is called by
dogtail.procedural.keyCombo().

- The now-unnecessary 'Input Text' button has been removed.

* dogtail.tree.Node has new attributes and a new method:

- grabFocus(): Attempts to cause the node to grab the keyboard focus.

- focusable: Whether the node is able to have keyboard focus.

- focused: Whether the node currently has keyboard focus.

- checked: Whether the node is a checkbox that is currently checked.

* Dogtail now checks if accessibility is enabled before it does anything.
sniff and dogtail-recorder will prompt to enable it via a dialog, and
scripts themselves will just refuse to run.

* Dogtail no longer uses the IconLogger (in the notification area) by default.
Set dogtail.config.config.useIconLogger to True to reenable it.

* dogtail.utils.screenshot() was rewritten to use GDK instead of ImageMagick.

Bugfixes:

* Dogtail is now much more robust in dealing with possibly-invalid Unicode
strings passed to it via AT-SPI. (GNOME bug 354515)

* Dogtail will not crash when it receives an SpiException caused by a CORBA
COMM_FAILURE, unless the source of that error is the application under test.

* While exceptions occuring inside callbacks used in dogtail-recorder will
still not properly be raised, they are now printed to standard out.

* SuSe support in dogtail.distro is fixed. (GNOME bug 353601)

* sniff and dogtail-recorder will now find their glade files, even if they're
installed into a nonstandard prefix. (GNOME bug 353719, 353731)

* dogtail-run-headless had a few bugs fixed.

=============

Features:

* A much-improved recorder:

- A procedural script writer, which is now default.

- An 'Input Text' feature, which allows you to set the text attribute
of any visible Node via the recorder. Coming soon is proper keystroke
recording.

- The script view now uses syntax hilighting where available. (GNOME bug
345374)

* A completely-rewritten dogtail-run-headless, which now offers two session
types: minimal GNOME and metacity. The syntax has changed, so use
'dogtail-run-headless --help' to get started. (GNOME bug 320548)

* All 'name' arguments in dogtail.tree and dogtail.procedural now accept
regular expressions.

* Support for AccessibleSelections, providing a clean way to select page
tabs and combo box items. (GNOME bug 336562)

* Support for building in a jhbuild environment. (GNOME bug 318535)

* Far more extensive unit tests for dogtail.tree.Node.

Bugfixes:

* The source is now indented with spaces and not tabs! :) (GNOME bug 318833)

* Pyspi and dogtail no longer mysteriously stop working. (GNOME bug 321273)

* Sniff no longer crashes when an application being poked disappears. (GNOME
bug 318135)