From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Stephen Gildea Newsgroups: gmane.emacs.devel Subject: Re: a property "definition-type" would help find macro-defined tests Date: Wed, 08 Jan 2025 09:44:56 -0800 Message-ID: <326902.1736358296@pental.sg.gildea.net> References: <86bjwh4hcn.fsf@gnu.org> Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="7901"; mail-complaints-to="usenet@ciao.gmane.io" To: emacs-devel@gnu.org Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Wed Jan 08 18:46:07 2025 Return-path: Envelope-to: ged-emacs-devel@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1tVa83-0001rb-3v for ged-emacs-devel@m.gmane-mx.org; Wed, 08 Jan 2025 18:46:06 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1tVa78-0006OY-HZ; Wed, 08 Jan 2025 12:45:06 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1tVa74-0006OD-Rb for emacs-devel@gnu.org; Wed, 08 Jan 2025 12:45:03 -0500 Original-Received: from tigger.sg.gildea.net ([99.65.78.170] helo=tigger3.gildea.net) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1tVa72-0003fd-2J for emacs-devel@gnu.org; Wed, 08 Jan 2025 12:45:02 -0500 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=gildea.com; i=@gildea.com; q=dns/txt; s=2023b; t=1736358296; h=from : to : subject : in-reply-to : mime-version : content-type : date : message-id : from; bh=NzMwvTRsbdDwDksZlTF1bz5CdZXIHVEP9sQ1yYKg56w=; b=xZN9HaQTBfXVLj9uWPh+IYc8Rn12VDipjq6W2ZYAGTXaCpd+MDKIztBmYbZMG0XPYBshf MaTAcwwmi8r9R+R5EVzysDQDrQi8GxY8ckLuvByqrXd0adASp/TZyoDrzgXn/yfEkuo4meS TBwVMDDBnWZofs/4YtFzH1np7ANTnEeo0+f0SXTEJu3tQxV1sjw5S60gJeuoWu/FFwJHltY uh9R/0KQUR7ryz+9gsMmau590+kkVW9bME+T/EMII5AG6x5DWmuF52A76lJ2S67lFQEQOdf F1yVA+3CKut3tpnp9NUyXhUXfadDXIwB/fPZxfchqMDqgUdiqVerNdxkKjww== Original-Received: from pental.sg.gildea.net (pental.wg.gildea.net [192.168.113.18]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "pental-mail", Issuer "gildea.net Mail Root CA" (verified OK)) by tigger3.gildea.net (Postfix) with ESMTPS id 8798F3E0D75 for ; Wed, 8 Jan 2025 09:44:56 -0800 (PST) Original-Received: from pental.sg.gildea.net (localhost [127.0.0.1]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (Client did not present a certificate) by pental.sg.gildea.net (Postfix) with ESMTPS id 6B6F12BE237 for ; Wed, 8 Jan 2025 09:44:56 -0800 (PST) In-Reply-To: Message from eliz@gnu.org of 8 Jan 2025 14:31:36 +0200 <86bjwh4hcn.fsf@gnu.org> X-Mailer: MH-E 8.6+git; nmh 1.8+dev; Emacs 31.0.50 Received-SPF: pass client-ip=99.65.78.170; envelope-from=stepheng+emacs@gildea.com; helo=tigger3.gildea.net X-Spam_score_int: -4 X-Spam_score: -0.5 X-Spam_bar: / X-Spam_report: (-0.5 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, NULL_IN_BODY=1.596, RCVD_IN_MSPIKE_H3=0.001, RCVD_IN_MSPIKE_WL=0.001, RCVD_IN_VALIDITY_RPBL_BLOCKED=0.001, RCVD_IN_VALIDITY_SAFE_BLOCKED=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_TVD_MIME_EPI=0.01 autolearn=no autolearn_force=no X-Spam_action: no action X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Original-Sender: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.devel:327800 Archived-At: --=-=-= Content-Type: text/plain Eli Zaretskii wrote: > Please post the full patch before you install it. Your original > message only shows a very small part of the tip of this particular > iceberg, which makes it hard to provide useful feedback. Thank you for your implied offer to review my small patch. I had not expected so much interest. < Stephen --=-=-= Content-Type: text/x-diff Content-Disposition: inline; filename=definition-type.patch Content-Description: new property definition-type diff --git a/lisp/emacs-lisp/find-func.el b/lisp/emacs-lisp/find-func.el index 0837b37023e..8b6c7fc23cf 100644 --- a/lisp/emacs-lisp/find-func.el +++ b/lisp/emacs-lisp/find-func.el @@ -400,9 +400,13 @@ find-function-search-for-symbol Visit the library in a buffer, and return a cons cell (BUFFER . POSITION), or just (BUFFER . nil) if the definition can't be found in the file. -If TYPE is nil, look for a function definition. -Otherwise, TYPE specifies the kind of definition, -and it is interpreted via `find-function-regexp-alist'. +If TYPE is nil, look for a function definition, otherwise, TYPE specifies +the kind of definition. If SYMBOL has a property `definition-type', +the property value is used instead of TYPE. (Macros that define objects +can put a `definition-type' on the symbol to help find an +unusual-looking definition site.) +TYPE is interpreted via `find-function-regexp-alist'. + The search is done in the source for library LIBRARY." (if (null library) (error "Don't know where `%s' is defined" symbol)) @@ -410,6 +414,8 @@ find-function-search-for-symbol ;; that defines something else. (while (and (symbolp symbol) (get symbol 'definition-name)) (setq symbol (get symbol 'definition-name))) + (setq type (or (get symbol 'definition-type) + type)) (if (string-match "\\`src/\\(.*\\.\\(c\\|m\\)\\)\\'" library) (find-function-C-source symbol (match-string 1 library) type) (when (string-match "\\.el\\(c\\)\\'" library) diff --git a/doc/lispref/symbols.texi b/doc/lispref/symbols.texi index 24b4e892024..6590d6be93f 100644 --- a/doc/lispref/symbols.texi +++ b/doc/lispref/symbols.texi @@ -536,9 +536,16 @@ Standard Properties related functions. @xref{Variable Definitions}. @item definition-name -This property is used to find the definition of a symbol in the source -code, when it might be hard to find the definition by textual search -of the source file. For example, a @code{define-derived-mode} +@itemx definition-type +These properties help find the definition of a symbol in the source +code when it might be hard to find the definition by textual search +of the source file. +The Emacs Help commands such as @kbd{C-h f} (@pxref{Help,,, +emacs, The GNU Emacs Manual}) use these properties to show the definition +of a symbol via a button in the @file{*Help*} buffer where the +symbol's documentation is shown. + +For example, a @code{define-derived-mode} (@pxref{Derived Modes}) might define a mode-specific function or a variable implicitly; or your Lisp program might generate a run-time call to @code{defun} to define a function (@pxref{Defining @@ -547,10 +554,50 @@ Standard Properties be found by textual search and whose code defines the original symbol. In the example with @code{define-derived-mode}, the value of this property of the functions and variables it defines should be the mode -symbol. The Emacs Help commands such as @kbd{C-h f} (@pxref{Help,,, -emacs, The GNU Emacs Manual}) use this property to show the definition -of a symbol via a button in the @file{*Help*} buffer where the -symbol's documentation is shown. +symbol. + +In some cases, the definition cannot be found by looking for the +definition of another symbol. For example, a test file might use a +macro to generate calls to @code{ert-deftest} +(@pxref{,,,ert, ERT: Emacs Lisp Regression Testing}) where the code +is boiler plate and only varying data need to be passed in. +In such cases, the @code{definition-type} property of the symbol can +be a symbol that has an entry in @code{find-function-regexp-alist} +telling how to find the definition of symbols of this type. + +In the example of a macro defining calls to @code{ert-deftest}, +the macro could put the property @code{definition-type} on each +test defined. The file defining the macro would also define a +definition-finding function or regexp and add it to +@code{find-function-regexp-alist} after that variable is loaded. +Here is an example using a function to find the definition: + +@example +(defmacro define-foo-test (data) + "Define a test of the foo system using DATA." + (declare (debug (&rest sexp))) + (let ((test-name (intern (concat ...)))) + `(progn + (put ',test-name 'definition-type 'foo-test-type) + (ert-deftest ,test-name () + ,(concat "Test foo with " ...) + ...)))) + +(defun foo-find-test-def-function (test-name) + "Search for the `define-foo-test' call defining TEST-NAME. +Return non-nil if the definition is found." + (save-match-data + (let ((regexp ...)) + (save-restriction + (widen) + (goto-char (point-min)) + (re-search-forward regexp nil t))))) + +(with-eval-after-load "find-func" + (add-to-list + 'find-function-regexp-alist + '(foo-test-type . foo-find-test-def-function))) +@end example @item disabled If the value is non-@code{nil}, the named function is disabled as a diff --git a/doc/lispref/functions.texi b/doc/lispref/functions.texi index c659ecaf3f8..8e183e7382b 100644 --- a/doc/lispref/functions.texi +++ b/doc/lispref/functions.texi @@ -752,9 +752,9 @@ Defining Functions buffer a button to jump to the function's definition, might be unable to find the source code because generating a function dynamically usually looks very different from the usual static calls to -@code{defun}. You can make the job of finding the code which +@code{defun}. You can make the job of finding the code that generates such functions easier by using the @code{definition-name} -property, @pxref{Standard Properties}. +or @code{definition-type} property, @pxref{Standard Properties}. @cindex override existing functions @cindex redefine existing functions diff --git a/doc/misc/ert.texi b/doc/misc/ert.texi index 9e60647f3ba..c8aac971ec7 100644 --- a/doc/misc/ert.texi +++ b/doc/misc/ert.texi @@ -518,9 +518,14 @@ How to Write Tests with @code{eval-defun} or @code{compile-defun}, or you can save the file and load it, optionally byte-compiling it first. -Just like @code{find-function} is only able to find where a function -was defined if the function was loaded from a file, ERT is only able -to find where a test was defined if the test was loaded from a file. +Just like @code{find-function} is able to find where a function was +defined only if the function was loaded from a file, ERT is able to +find where a test was defined only if the test was loaded from a file. + +If the test definition is generated by a macro, the macro may want to +help ERT find the defining call to the macro by putting the property +@code{definition-type} on the test name. +@xref{Standard Properties,,,elisp, GNU Emacs Lisp Reference Manual}. @menu --=-=-=--