From: Yuan Fu <casouri@gmail.com>
To: Stefan Monnier <monnier@iro.umontreal.ca>
Cc: Eli Zaretskii <eliz@gnu.org>, emacs-devel@gnu.org
Subject: Re: Use (eval-when-compile 'treesit) to save us from writing declare-function forms
Date: Sat, 7 Dec 2024 22:39:21 -0800 [thread overview]
Message-ID: <292D0D0F-AB88-49AB-86DD-A9B736DB00F7@gmail.com> (raw)
In-Reply-To: <jwvv7vv8v7e.fsf-monnier+emacs@gnu.org>
[-- Attachment #1: Type: text/plain, Size: 1151 bytes --]
> On Dec 7, 2024, at 5:47 AM, Stefan Monnier <monnier@iro.umontreal.ca> wrote:
>
>>> Does that mean declare-function forms only affect the file it’s in?
>>> Because if treesit.el has declare-function forms for all the treesit.c
>>> functions, and c-ts-mode.el requires treesit.el, why do we need to have
>>> declare-function forms in c-ts-mode.el?
>> Seems like that. Stefan, am I missing something here?
>
> Yes, `declare-function` *should* follow the same principles as `(defvar
> FOO)`, meaning that they are compiler directives not functions to
> execute. They affect warnings only in the current lexical scope, and
> requiring a file full of `(defvar FOO)` and `declare-function` will have
> no effect at all.
>
> [ Side note regarding this *should*: it currently doesn't work quite as
> well as `defvar` because its effect is always file-wide, whereas it
> should be limited to the current scope. ]
Defining a macro that contains the declare-function forms, and calling it in eval-when-compile forms seem to work (see patch), WDYT? The name (treesit-declare-c-functions) could be better, any ideas?
Yuan
[-- Attachment #2: declare-function.patch --]
[-- Type: application/octet-stream, Size: 7491 bytes --]
From ba77886d5e250770251d8c1abec93d4fcf0e0268 Mon Sep 17 00:00:00 2001
From: Yuan Fu <casouri@gmail.com>
Date: Sat, 7 Dec 2024 22:13:07 -0800
Subject: [PATCH] declare-function POC
---
lisp/progmodes/c-ts-mode.el | 17 +-----
lisp/treesit.el | 103 ++++++++++++++++++++----------------
2 files changed, 60 insertions(+), 60 deletions(-)
diff --git a/lisp/progmodes/c-ts-mode.el b/lisp/progmodes/c-ts-mode.el
index dec9411b87c..4a1f616b048 100644
--- a/lisp/progmodes/c-ts-mode.el
+++ b/lisp/progmodes/c-ts-mode.el
@@ -73,21 +73,8 @@
(require 'c-ts-common)
(eval-when-compile (require 'rx))
-(declare-function treesit-parser-create "treesit.c")
-(declare-function treesit-parser-root-node "treesit.c")
-(declare-function treesit-parser-set-included-ranges "treesit.c")
-(declare-function treesit-node-parent "treesit.c")
-(declare-function treesit-node-start "treesit.c")
-(declare-function treesit-node-end "treesit.c")
-(declare-function treesit-node-child "treesit.c")
-(declare-function treesit-node-child-by-field-name "treesit.c")
-(declare-function treesit-node-type "treesit.c")
-(declare-function treesit-node-prev-sibling "treesit.c")
-(declare-function treesit-node-first-child-for-pos "treesit.c")
-(declare-function treesit-node-next-sibling "treesit.c")
-(declare-function treesit-node-eq "treesit.c")
-(declare-function treesit-node-match-p "treesit.c")
-(declare-function treesit-query-compile "treesit.c")
+(eval-when-compile
+ (treesit-declare-c-functions))
;;; Custom variables
diff --git a/lisp/treesit.el b/lisp/treesit.el
index db3a706f016..2e189394983 100644
--- a/lisp/treesit.el
+++ b/lisp/treesit.el
@@ -39,61 +39,74 @@
;;; Function declarations
-(declare-function treesit-language-available-p "treesit.c")
-(declare-function treesit-language-version "treesit.c")
+(defmacro treesit-declare-c-functions ()
+ "Declare C functions and variables defined in treesit.c.
-(declare-function treesit-parser-p "treesit.c")
-(declare-function treesit-node-p "treesit.c")
-(declare-function treesit-compiled-query-p "treesit.c")
-(declare-function treesit-query-p "treesit.c")
-(declare-function treesit-query-language "treesit.c")
+This macro is only needed for byte-compiling in Emacs not built with
+tree-sitter library. It should be used with `eval-when-compile' like
+this:
-(declare-function treesit-node-parser "treesit.c")
+ (eval-when-compile
+ (treesit-declare-c-functions))"
+ '(progn
+ (declare-function treesit-language-available-p "treesit.c")
+ (declare-function treesit-language-version "treesit.c")
-(declare-function treesit-parser-create "treesit.c")
-(declare-function treesit-parser-delete "treesit.c")
-(declare-function treesit-parser-list "treesit.c")
-(declare-function treesit-parser-buffer "treesit.c")
-(declare-function treesit-parser-language "treesit.c")
-(declare-function treesit-parser-tag "treesit.c")
+ (declare-function treesit-parser-p "treesit.c")
+ (declare-function treesit-node-p "treesit.c")
+ (declare-function treesit-compiled-query-p "treesit.c")
+ (declare-function treesit-query-p "treesit.c")
+ (declare-function treesit-query-language "treesit.c")
-(declare-function treesit-parser-root-node "treesit.c")
+ (declare-function treesit-node-parser "treesit.c")
-(declare-function treesit-parser-set-included-ranges "treesit.c")
-(declare-function treesit-parser-included-ranges "treesit.c")
-(declare-function treesit-parser-changed-ranges "treesit.c")
-(declare-function treesit-parser-add-notifier "treesit.c")
+ (declare-function treesit-parser-create "treesit.c")
+ (declare-function treesit-parser-delete "treesit.c")
+ (declare-function treesit-parser-list "treesit.c")
+ (declare-function treesit-parser-buffer "treesit.c")
+ (declare-function treesit-parser-language "treesit.c")
+ (declare-function treesit-parser-tag "treesit.c")
-(declare-function treesit-node-type "treesit.c")
-(declare-function treesit-node-start "treesit.c")
-(declare-function treesit-node-end "treesit.c")
-(declare-function treesit-node-string "treesit.c")
-(declare-function treesit-node-parent "treesit.c")
-(declare-function treesit-node-child "treesit.c")
-(declare-function treesit-node-check "treesit.c")
-(declare-function treesit-node-field-name-for-child "treesit.c")
-(declare-function treesit-node-child-count "treesit.c")
-(declare-function treesit-node-child-by-field-name "treesit.c")
-(declare-function treesit-node-next-sibling "treesit.c")
-(declare-function treesit-node-prev-sibling "treesit.c")
-(declare-function treesit-node-first-child-for-pos "treesit.c")
-(declare-function treesit-node-descendant-for-range "treesit.c")
-(declare-function treesit-node-eq "treesit.c")
+ (declare-function treesit-parser-root-node "treesit.c")
-(declare-function treesit-pattern-expand "treesit.c")
-(declare-function treesit-query-expand "treesit.c")
-(declare-function treesit-query-compile "treesit.c")
-(declare-function treesit-query-capture "treesit.c")
+ (declare-function treesit-parser-set-included-ranges "treesit.c")
+ (declare-function treesit-parser-included-ranges "treesit.c")
+ (declare-function treesit-parser-changed-ranges "treesit.c")
+ (declare-function treesit-parser-add-notifier "treesit.c")
-(declare-function treesit-search-subtree "treesit.c")
-(declare-function treesit-search-forward "treesit.c")
-(declare-function treesit-induce-sparse-tree "treesit.c")
-(declare-function treesit-subtree-stat "treesit.c")
-(declare-function treesit-node-match-p "treesit.c")
+ (declare-function treesit-node-type "treesit.c")
+ (declare-function treesit-node-start "treesit.c")
+ (declare-function treesit-node-end "treesit.c")
+ (declare-function treesit-node-string "treesit.c")
+ (declare-function treesit-node-parent "treesit.c")
+ (declare-function treesit-node-child "treesit.c")
+ (declare-function treesit-node-check "treesit.c")
+ (declare-function treesit-node-field-name-for-child "treesit.c")
+ (declare-function treesit-node-child-count "treesit.c")
+ (declare-function treesit-node-child-by-field-name "treesit.c")
+ (declare-function treesit-node-next-sibling "treesit.c")
+ (declare-function treesit-node-prev-sibling "treesit.c")
+ (declare-function treesit-node-first-child-for-pos "treesit.c")
+ (declare-function treesit-node-descendant-for-range "treesit.c")
+ (declare-function treesit-node-eq "treesit.c")
-(declare-function treesit-available-p "treesit.c")
+ (declare-function treesit-pattern-expand "treesit.c")
+ (declare-function treesit-query-expand "treesit.c")
+ (declare-function treesit-query-compile "treesit.c")
+ (declare-function treesit-query-capture "treesit.c")
-(defvar treesit-thing-settings)
+ (declare-function treesit-search-subtree "treesit.c")
+ (declare-function treesit-search-forward "treesit.c")
+ (declare-function treesit-induce-sparse-tree "treesit.c")
+ (declare-function treesit-subtree-stat "treesit.c")
+ (declare-function treesit-node-match-p "treesit.c")
+
+ (declare-function treesit-available-p "treesit.c")
+
+ (defvar treesit-thing-settings)))
+
+(eval-when-compile
+ (treesit-declare-c-functions))
;;; Custom options
--
2.39.5 (Apple Git-151)
[-- Attachment #3: Type: text/plain, Size: 2 bytes --]
next prev parent reply other threads:[~2024-12-08 6:39 UTC|newest]
Thread overview: 18+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-12-03 6:31 Use (eval-when-compile 'treesit) to save us from writing declare-function forms Yuan Fu
2024-12-03 8:30 ` Andrea Corallo
2024-12-04 18:21 ` Yuan Fu
2024-12-03 13:12 ` Eli Zaretskii
2024-12-04 18:19 ` Yuan Fu
2024-12-04 18:57 ` Eli Zaretskii
2024-12-05 6:25 ` Yuan Fu
2024-12-05 7:07 ` Eli Zaretskii
2024-12-07 1:12 ` Yuan Fu
2024-12-07 7:51 ` Eli Zaretskii
2024-12-07 13:47 ` Stefan Monnier
2024-12-08 6:39 ` Yuan Fu [this message]
2024-12-08 7:20 ` Eli Zaretskii
2024-12-08 15:27 ` Stefan Monnier
2024-12-09 1:37 ` Yuan Fu
2024-12-09 2:40 ` Stefan Monnier
2024-12-11 1:57 ` Dmitry Gutov
2024-12-08 16:01 ` Dmitry Gutov
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=292D0D0F-AB88-49AB-86DD-A9B736DB00F7@gmail.com \
--to=casouri@gmail.com \
--cc=eliz@gnu.org \
--cc=emacs-devel@gnu.org \
--cc=monnier@iro.umontreal.ca \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).