[AUCTeX-diffs] GNU AUCTeX branch, master, updated. 5aef4bb0e7cc47dd7387d2324a5510b62a50a1d6

[Arash Esbati]

This is an automated email from the git hooks/post-receive script. It was
generated because a ref change was pushed to the repository containing
the project "GNU AUCTeX".

The branch, master has been updated
       via  5aef4bb0e7cc47dd7387d2324a5510b62a50a1d6 (commit)
      from  a589542d9296cd18f117efbbd77e1f84d6a095a7 (commit)

Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.

- Log -----------------------------------------------------------------
commit 5aef4bb0e7cc47dd7387d2324a5510b62a50a1d6
Author: Arash Esbati <arash@gnu.org>
Date:   Wed Jul 7 12:08:51 2021 +0200

    Add support for LaTeX hook macros
    
    * doc/auctex.texi (Adding Macros): Document new functions for
    reading and inserting LaTeX hooks.
    
    * doc/changes.texi: Add entry for LaTeX hooks support.
    
    * font-latex.el (font-latex-built-in-keyword-classes): Add hook
    macros to function keywords class.
    
    * latex.el (TeX-global-input-files-with-extension): New variable.
    (TeX-read-hook, TeX-arg-hook): New functions for reading and
    inserting LaTeX hooks.
    (LaTeX-common-initialization): Add hook macros to AUCTeX's LaTeX2e
    hook.

diff --git a/doc/auctex.texi b/doc/auctex.texi
index 2cca938..8a5676c 100644
--- a/doc/auctex.texi
+++ b/doc/auctex.texi
@@ -5253,8 +5253,9 @@ prompt.
 
 @ftable @code
 @item TeX-arg-conditional
-Implements if @var{expr} @var{then} @var{else}.  If @var{expr} evaluates to 
true, parse @var{then} as an
-argument list, else parse @var{else} as an argument list.
+Implements if @var{expr} @var{then} @var{else}.  If @var{expr} evaluates
+to true, parse @var{then} as an argument list, else parse @var{else} as an
+argument list.
 
 @item TeX-arg-literal
 Insert its arguments into the buffer.  Used for specifying extra syntax
@@ -5420,12 +5421,18 @@ Insert x and y coordinates as a pair.  No arguments.
 Prompt for document author, using @code{LaTeX-default-author} as initial
 input.
 
+@item TeX-read-hook
+Prompt for a @LaTeX{} hook and return it.
+
+@item TeX-arg-hook
+Prompt for a @LaTeX{} hook and insert it as a @TeX{} macro argument.
+
 @item TeX-read-key-val
 Prompt for a @samp{key=value} list of options and return them.
 
 @item TeX-arg-key-val
-Prompt for a @samp{key=value} list of options and insert it as a @TeX{} macro
-argument.
+Prompt for a @samp{key=value} list of options and insert it as a @TeX{}
+macro argument.
 @end ftable
 
 If you add new hooks, you can assume that point is placed directly after
diff --git a/doc/changes.texi b/doc/changes.texi
index 39b8308..c702341 100644
--- a/doc/changes.texi
+++ b/doc/changes.texi
@@ -105,6 +105,11 @@ now is an obsolete alias.
 The style @file{latexinfo.el} is removed from @AUCTeX{}.
 @file{latexinfo.el} was meant to support latexinfo which in return was a
 @LaTeX{}-2.09 extension of Texinfo, but didn't manage to replace Texinfo.
+
+@item
+@AUCTeX{} has preliminary support for @LaTeX{}-hooks.  Hooks provided by
+@LaTeX{} kernel are known and available for completion in
+@samp{\AddToHook}, @samp{\RemoveFromHook} and @samp{\AddToHookNext}.
 @end itemize
 
 @heading News in 12.3
diff --git a/font-latex.el b/font-latex.el
index da95bc2..18c04d5 100644
--- a/font-latex.el
+++ b/font-latex.el
@@ -353,6 +353,7 @@ variable `font-latex-fontify-sectioning'." ',num)
       ("addvspace" "{") ("vspace" "*{") ("hspace" "*{")
       ("thinspace" "")  ("negthinspace" "")
       ("labelformat" "{{")
+      ("AddToHook" "{[{") ("RemoveFromHook" "{[") ("AddToHookNext" "{{")
       ;; XXX: Should macros without arguments rather be listed in a
       ;; separate category with 'noarg instead of 'command handling?
       ("enspace" "") ("enskip" "") ("quad" "") ("qquad" "") ("nonumber" "")
diff --git a/latex.el b/latex.el
index cf26383..74ec036 100644
--- a/latex.el
+++ b/latex.el
@@ -2431,13 +2431,20 @@ To insert a hook here, you must insert it in the 
appropiate style file.")
 Initialized once at the first time you prompt for an input file.
 May be reset with `\\[universal-argument] \\[TeX-normal-mode]'.")
 
+(defvar TeX-global-input-files-with-extension nil
+  "List of the non-local TeX input files with extension.
+Initialized once at the first time you prompt for an input file
+inside a file hook command.
+May be reset with `\\[universal-argument] \\[TeX-normal-mode]'.")
+
 (defvar LaTeX-global-package-files nil
   "List of the LaTeX package files.
 Initialized once at the first time you prompt for a LaTeX package.
 May be reset with `\\[universal-argument] \\[TeX-normal-mode]'.")
 
-;; Add both variables to `TeX-normal-mode-reset-list':
+;; Add the variables to `TeX-normal-mode-reset-list':
 (add-to-list 'TeX-normal-mode-reset-list 'TeX-global-input-files)
+(add-to-list 'TeX-normal-mode-reset-list 
'TeX-global-input-files-with-extension)
 (add-to-list 'TeX-normal-mode-reset-list 'LaTeX-global-package-files)
 
 (defun LaTeX-arg-usepackage-read-packages-with-options ()
@@ -3103,6 +3110,170 @@ as values for the key.  Use PROMPT as the prompt 
string."
   (let ((options (TeX-read-key-val optional key-val-alist prompt)))
     (TeX-argument-insert options optional)))
 
+(defun TeX-read-hook ()
+  "Read a LaTeX hook and return it as a string."
+  (let* ((hook (completing-read
+               (TeX-argument-prompt nil nil "Hook")
+               '("cmd"
+                 "env"
+                 ;; From ltfilehook-doc.pdf
+                 "file/before"        "file/after"
+                 "include/before"     "include/end"   "include/after"
+                 "class/before"       "class/after"
+                 "package/before"     "package/after"
+                 ;; From lthooks-doc.pdf
+                 "begindocument"
+                 "begindocument/before"
+                 "begindocument/end"
+                 "enddocument"
+                 "enddocument/afterlastpage"
+                 "enddocument/afteraux"
+                 "enddocument/info"
+                 "enddocument/end"
+                 "rmfamily"           "sffamily"
+                 "ttfamily"           "normalfont"
+                 "bfseries"           "bfseries/defaults"
+                 "mdseries"           "mdseries/defaults"
+                 ;; From ltshipout-doc.pdf
+                 "shipout/before"     "shipout/after"
+                 "shipout/foreground" "shipout/background"
+                 "shipout/firstpage"  "shipout/lastpage"
+                 ;; From ltpara-doc.pdf
+                 "para/before"         "para/begin"
+                 "para/end"            "para/after")))
+        (place (lambda ()
+                 (completing-read
+                  (TeX-argument-prompt nil nil "Where")
+                  (if (string= hook "cmd")
+                      '("after" "before")
+                    '("before" "begin" "end" "after")))))
+        (search (lambda ()
+                  (if (eq TeX-arg-input-file-search 'ask)
+                      (not (y-or-n-p "Find file yourself? "))
+                    TeX-arg-input-file-search)))
+        name where files ); result
+    (cond ((string= hook "cmd")
+          ;; cmd/<name>/<where>
+          (setq name (completing-read
+                      (TeX-argument-prompt nil nil "Command")
+                      (TeX-symbol-list)))
+          (setq where (funcall place)))
+
+         ;; env/<name>/<where>
+         ((string= hook "env")
+          (setq name (completing-read
+                      (TeX-argument-prompt nil nil "Environment")
+                      (LaTeX-environment-list)))
+          (setq where (funcall place)))
+
+         ;; file/(before|after)/<file-name.xxx> where <file-name> is
+         ;; optional and must be with extension
+         ((member hook '("file/before" "file/after"))
+          (if (funcall search)
+              (progn
+                (unless TeX-global-input-files-with-extension
+                  (setq TeX-global-input-files-with-extension
+                        (prog2
+                            (message "Searching for files...")
+                            (mapcar #'list
+                                    (TeX-search-files-by-type 'texinputs
+                                                              'global
+                                                              t nil))
+                          (message "Searching for files...done"))))
+                (setq name
+                      (completing-read
+                       (TeX-argument-prompt t nil "File")
+                       TeX-global-input-files-with-extension)))
+            (setq name
+                  (file-name-nondirectory
+                   (read-file-name
+                    (TeX-argument-prompt t nil "File")
+                    nil "")))))
+
+         ;; include/(before|after|end)/<file-name> where <file-name>
+         ;; is optional
+         ((member hook '("include/before" "include/end" "include/after"))
+          (if (funcall search)
+              (progn
+                (setq files
+                      (prog2
+                          (message "Searching for files...")
+                          ;; \include looks for files with TeX content,
+                          ;; so limit the search:
+                          (let* ((TeX-file-extensions '("tex" "ltx")))
+                            (TeX-search-files-by-type 'texinputs 'local t t))
+                        (message "Searching for files...done")))
+                (setq name (completing-read
+                            (TeX-argument-prompt t nil "File")
+                            files)))
+            (setq name
+                  (file-name-base
+                   (read-file-name
+                    (TeX-argument-prompt t nil "File")
+                    nil "")))))
+
+         ;; class/(before|after)/<doc-class> where <doc-class> is
+         ;; optional
+         ((member hook '("class/before" "class/after"))
+          (if (funcall search)
+              (progn
+                (unless LaTeX-global-class-files
+                  (setq LaTeX-global-class-files
+                        (prog2
+                            (message "Searching for LaTeX classes...")
+                            (let* ((TeX-file-extensions '("cls")))
+                              (mapcar #'list
+                                      (TeX-search-files-by-type 'texinputs
+                                                                'global
+                                                                t t)))
+                          (message "Searching for LaTeX classes...done"))))
+                (setq name (completing-read
+                            (TeX-argument-prompt t nil "Document class")
+                            LaTeX-global-class-files)))
+            (setq name
+                  (file-name-base
+                   (read-file-name
+                    (TeX-argument-prompt t nil "File")
+                    nil "")))))
+
+         ;; package/(before|after)/<pack-name> where
+         ;; <pack-name> is optional
+         ((member hook '("package/before" "package/after"))
+          (if (funcall search)
+              (progn
+                (unless LaTeX-global-package-files
+                  (setq LaTeX-global-package-files
+                        (prog2
+                            (message "Searching for LaTeX packages...")
+                            (let* ((TeX-file-extensions '("sty")))
+                              (mapcar #'list
+                                      (TeX-search-files-by-type 'texinputs
+                                                                'global
+                                                                t t)))
+                          (message "Searching for LaTeX packages...done"))))
+                (setq name (completing-read
+                            (TeX-argument-prompt t nil "Package")
+                            LaTeX-global-package-files)))
+            (setq name (file-name-base
+                        (read-file-name
+                         (TeX-argument-prompt t nil "File")
+                         nil "")))))
+
+         ;; User specific input for the hook, do nothing:
+         (t nil))
+    ;; Process the input: For cmd or env, concat the elements with a
+    ;; slash.  For other hooks, check if the optional name is given
+    ;; and append it with a backslash to the hook:
+    (if (member hook '("cmd" "env"))
+       (concat hook "/" name "/" where)
+      (concat hook (when (and name (not (string= name "")))
+                    (concat "/" name))))))
+
+(defun TeX-arg-hook (optional)
+  "Prompt for a LaTeX hook.
+Insert the given hook as a TeX macro argument.  If OPTIONAL is
+non-nil, insert it as an optional argument."
+  (TeX-argument-insert (TeX-read-hook) optional))
 
 ;;; Verbatim constructs
 
@@ -7167,7 +7338,12 @@ function would return non-nil and `(match-string 1)' 
would return
      ;; `LaTeX-font-list' once it is needed more frequently.
      '("textssc" t)
      ;; User level reset macros:
-     '("normalfont" -1) '("normalshape" -1)))
+     '("normalfont" -1) '("normalshape" -1)
+
+     ;; LaTeX hook macros:
+     '("AddToHook"      TeX-arg-hook [ "Label" ] t)
+     '("RemoveFromHook" TeX-arg-hook [ "Label" ])
+     '("AddToHookNext"  TeX-arg-hook t)))
 
   (TeX-run-style-hooks "LATEX")
 

-----------------------------------------------------------------------

Summary of changes:
 doc/auctex.texi  |  15 +++--
 doc/changes.texi |   5 ++
 font-latex.el    |   1 +
 latex.el         | 180 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 4 files changed, 195 insertions(+), 6 deletions(-)


hooks/post-receive
-- 
GNU AUCTeX