From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED.blaine.gmane.org!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.bugs Subject: bug#36232: 26.2; (elisp) `Click Events': OBJECT "string-type text property" etc. Date: Sun, 16 Jun 2019 18:30:14 +0300 Message-ID: <83fto9v989.fsf@gnu.org> References: Injection-Info: blaine.gmane.org; posting-host="blaine.gmane.org:195.159.176.226"; logging-data="266503"; mail-complaints-to="usenet@blaine.gmane.org" Cc: 36232-done@debbugs.gnu.org To: Drew Adams Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Sun Jun 16 17:32:15 2019 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([209.51.188.17]) by blaine.gmane.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.89) (envelope-from ) id 1hcX8g-0017Db-Re for geb-bug-gnu-emacs@m.gmane.org; Sun, 16 Jun 2019 17:32:14 +0200 Original-Received: from localhost ([::1]:40852 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.86_2) (envelope-from ) id 1hcX8f-0004qw-O7 for geb-bug-gnu-emacs@m.gmane.org; Sun, 16 Jun 2019 11:32:13 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:51087) by lists.gnu.org with esmtp (Exim 4.86_2) (envelope-from ) id 1hcX7Z-0004px-87 for bug-gnu-emacs@gnu.org; Sun, 16 Jun 2019 11:31:06 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1hcX7X-0001de-Qd for bug-gnu-emacs@gnu.org; Sun, 16 Jun 2019 11:31:05 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]:55968) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1hcX7W-0001aT-1a for bug-gnu-emacs@gnu.org; Sun, 16 Jun 2019 11:31:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1hcX7V-000253-SX for bug-gnu-emacs@gnu.org; Sun, 16 Jun 2019 11:31:01 -0400 Resent-From: Eli Zaretskii Original-Sender: "Debbugs-submit" Resent-To: bug-gnu-emacs@gnu.org Resent-Date: Sun, 16 Jun 2019 15:31:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: cc-closed 36232 X-GNU-PR-Package: emacs Mail-Followup-To: 36232@debbugs.gnu.org, eliz@gnu.org, drew.adams@oracle.com Original-Received: via spool by 36232-done@debbugs.gnu.org id=D36232.15606990217941 (code D ref 36232); Sun, 16 Jun 2019 15:31:01 +0000 Original-Received: (at 36232-done) by debbugs.gnu.org; 16 Jun 2019 15:30:21 +0000 Original-Received: from localhost ([127.0.0.1]:41278 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1hcX6r-000241-Hf for submit@debbugs.gnu.org; Sun, 16 Jun 2019 11:30:21 -0400 Original-Received: from eggs.gnu.org ([209.51.188.92]:42137) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1hcX6p-00023k-Re for 36232-done@debbugs.gnu.org; Sun, 16 Jun 2019 11:30:21 -0400 Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]:57883) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1hcX6e-0000Bj-7Q; Sun, 16 Jun 2019 11:30:09 -0400 Original-Received: from [176.228.60.248] (port=2479 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_256_CBC_SHA1:256) (Exim 4.82) (envelope-from ) id 1hcX6c-0005Ts-HI; Sun, 16 Jun 2019 11:30:07 -0400 In-reply-to: (message from Drew Adams on Sat, 15 Jun 2019 14:21:50 -0700 (PDT)) X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 209.51.188.43 X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Original-Sender: "bug-gnu-emacs" Xref: news.gmane.org gmane.emacs.bugs:160673 Archived-At: > Date: Sat, 15 Jun 2019 14:21:50 -0700 (PDT) > From: Drew Adams > > No clue what is meant by "string-type text property". > > Which text properties are string-type text properties? It's a string that comes from a text property or from an overlay. > OBJECT is apparently either nil or (STRING . STRING-POS), where STRING > is the string clicked on and STRING-POS is the position in the string > where clicked. > > But: > > 1. Why call that OBJECT instead of, say, STRING-INFO? What kind of > object is it? If the value is nil doesn't it just mean that a string > was not clicked on? Because nil stands for a buffer, not just for the lack of a string. > 2. What text properties are string-type properties? Asked and answered. > This doc would likely be clearer if something were said about what kind > of "objects" it tries to talk about, in general (assuming that all of > the occurrences of "object" mean the same kind of thing). That's just a > guess, as I have no good idea what it is trying to say. It can talk about any Lisp object, or I don't understand the question. > This apparently affects also `posn-object' (e.g. in (elisp `Accessing > Mouse'). There it talks about a string or an image in a POSITION. Does > "object" just mean string or image? How can a string be in a position? See above. > And the doc string of `posn-object' talks about "the object of > POSITION." Again, unclear what that object is. See above. "OBJECT in POSITION" refers to the object recorded in (or described by) POSITION. > `posn-object-x-y' is described as coordinates relative to a corner of > "the object in POSITION" - what kind of cornered object is this, and > what/where are its "corners"? Every object on display, be it a character glyph, a display string, an image, or anything else, has 2 dimensions, which means it has 4 corners. > And "if the POSITION is on buffer text" (huh? a position on text?) POSITION describes a click, remember? > then it returns "the relative position of the > ... character closest to that position." Unintelligible to me. There > must be a clear way of saying what this is trying to say, whatever that > is. I hope the modified text is more clear. > Also there, `posnp' says that its arg (OBJECT) is a position list "in > either of the formats documented in Click Events..." What are those two > formats? "In the format". ("Either of the formats" doesn't necessarily mean there are two of them.) > Going to the parent node, `Input Events', OBJECT is an input event or > event type. Is that the same kind of object the other nodes are talking > about? No. > If this all makes perfect sense to its author, fine. Consider it the > feedback of this user that the description is not understandable - hope > the feedback helps somehow. I improved the wording (in the emacs-26 branch), you are invited to take a look.