After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 697969 - Deprecate atspi_text_get_text_{before,at,after}_offset()
Deprecate atspi_text_get_text_{before,at,after}_offset()
Status: RESOLVED FIXED
Product: at-spi
Classification: Platform
Component: general
unspecified
Other Linux
: Normal normal
: ---
Assigned To: At-spi maintainer(s)
At-spi maintainer(s)
Depends on: 697968
Blocks:
 
 
Reported: 2013-04-13 21:54 UTC by Joanmarie Diggs (IRC: joanie)
Modified: 2015-01-21 09:56 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
1. Deprecate AtspiTextBoundaryType (4.13 KB, patch)
2013-08-06 16:14 UTC, Mario Sánchez Prada
none Details | Review
2. Deprecate atspi_text_get_text_*_offset() (6.14 KB, patch)
2013-08-06 16:14 UTC, Mario Sánchez Prada
none Details | Review
Patch proposal (9.69 KB, patch)
2013-08-13 13:10 UTC, Mario Sánchez Prada
none Details | Review
Patch proposal (9.69 KB, patch)
2013-08-13 13:12 UTC, Mario Sánchez Prada
none Details | Review
Patch proposal (8.26 KB, patch)
2013-09-02 13:05 UTC, Mario Sánchez Prada
needs-work Details | Review
Patch Proposal (1.50 KB, patch)
2015-01-19 17:58 UTC, Mario Sánchez Prada
accepted-commit_now Details | Review

Description Joanmarie Diggs (IRC: joanie) 2013-04-13 21:54:11 UTC
As described in this message [1], atk_text_get_text_{before,after}_offset should be removed. It's redundant to atk_text_get_text_at_offset() and confuses those implementing AtkText support.

Orca is the primary, and possibly only, consumer of these additional redundant methods. Or, rather, it was. As of today, Orca no longer calls the pyatspi2 methods getTextBeforeOffset() and getTextAfterOffset().

Let's deprecate these methods for the 3.10 cycle and remove them in 3.12.

[1] https://mail.gnome.org/archives/gnome-accessibility-devel/2013-April/msg00000.html
Comment 1 Mario Sánchez Prada 2013-08-06 16:02:08 UTC
We have finally decider to go ahead with other approach (see [1])and deprecating the three functions in favour of a new one, not break the ABI, so renaming the bug accordingly...

[1] https://mail.gnome.org/archives/gnome-accessibility-devel/2013-August/msg00001.html
Comment 2 Mario Sánchez Prada 2013-08-06 16:14:00 UTC
Created attachment 250990 [details] [review]
1. Deprecate AtspiTextBoundaryType
Comment 3 Mario Sánchez Prada 2013-08-06 16:14:26 UTC
Created attachment 250991 [details] [review]
2. Deprecate atspi_text_get_text_*_offset()
Comment 4 Mario Sánchez Prada 2013-08-13 13:10:22 UTC
Created attachment 251478 [details] [review]
Patch proposal

New (unique) patch to fix this issue after agreeing on the get_string_at_offset new name
Comment 5 Mario Sánchez Prada 2013-08-13 13:12:09 UTC
Created attachment 251479 [details] [review]
Patch proposal

Actually, this is the one
Comment 6 André Klapper 2013-08-14 10:03:30 UTC
[Mass-resetting default assignee, see bug 705890. Please reclaim this bug report by setting the assignee to yourself if you still plan to work on this. Thanks!]
Comment 7 Mario Sánchez Prada 2013-09-02 13:05:05 UTC
Created attachment 253842 [details] [review]
Patch proposal

(In reply to comment #5)
> Created an attachment (id=251479) [details] [review]
> Patch proposal
> 
> Actually, this is the one

Mike have already committed a similar patch to the one proposed one as part as the work done in bug 705581, but forgot to deprecate the "after" and "before" flavours of these methods, so I'm now attaching a new patch here just to take care of that extra last step.
Comment 8 Alejandro Piñeiro Iglesias (IRC: infapi00) 2014-06-20 10:11:55 UTC
Review of attachment 253842 [details] [review]:

After all this months the patch doesn't apply cleanly anymore. Could you update it?

In the same way, not sure if it makes sense to move the implementation of atspi_get_text_at_string around. Is not really related with the reason behind the commit (so not really atomic) and I don't think that is a rule-not-written the need to keep the same order of the header file on the source file. Mike, do you have an opinion about that?
Comment 9 Mario Sánchez Prada 2015-01-19 17:58:04 UTC
Created attachment 294907 [details] [review]
Patch Proposal

For some reason, this bug fell off my radar a long time ago and, for another reason, I happened to find it last week, so here is a patch updated.

Note: I also think it makes no sense to reorder the implementation file
Comment 10 Alejandro Piñeiro Iglesias (IRC: infapi00) 2015-01-20 17:35:27 UTC
Review of attachment 294907 [details] [review]:

Looks good.
Comment 11 Mario Sánchez Prada 2015-01-21 09:56:36 UTC
This problem has been fixed in the development version. The fix will be available in the next major software release. Thank you for your bug report.