1
0
mirror of https://git.savannah.gnu.org/git/emacs.git synced 2024-11-24 07:20:37 +00:00
emacs/lisp/pcmpl-gnu.el
Stefan Kangas a0f8fb806f pcomplete/find: Support new GNU find expressions
* lisp/pcmpl-gnu.el (pcomplete/find): Add expressions from new GNU find:
"-newerxy" (4.3.3) and "-files0-from" (4.9.0).  This list is now
complete as of GNU findutils 4.10.0, released on 2024-06-01.
2024-11-05 04:29:23 +01:00

419 lines
14 KiB
EmacsLisp

;;; pcmpl-gnu.el --- completions for GNU project tools -*- lexical-binding: t -*-
;; Copyright (C) 1999-2024 Free Software Foundation, Inc.
;; Package: pcomplete
;; This file is part of GNU Emacs.
;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
;;; Commentary:
;;; Code:
(provide 'pcmpl-gnu)
(require 'pcomplete)
(require 'pcmpl-unix)
(defgroup pcmpl-gnu nil
"Completions for GNU project tools."
:group 'pcomplete)
;; User Variables:
(defcustom pcmpl-gnu-makefile-regexps
'("\\`GNUmakefile" "\\`[Mm]akefile" "\\.ma?k\\'")
"A list of regexps that will match Makefile names."
:type '(repeat regexp))
(defcustom pcmpl-gnu-makefile-includes t
"If non-nil, `pcomplete/make' completes on targets in included files."
:type 'boolean
:version "27.1"
:safe 'booleanp)
;; Functions:
;;;###autoload
(defun pcomplete/gzip ()
"Completion for `gzip'."
(let ((pcomplete-help "(gzip)"))
(pcomplete-opt "cdfhlLnNqrStvV123456789")
(while (pcomplete-here
(pcmpl-gnu-zipped-files
(catch 'has-d-flag
(let ((args pcomplete-args))
(while args
(if (string-match "\\`-.*[dt]" (car args))
(throw 'has-d-flag t))
(setq args (cdr args))))))))))
(defun pcmpl-gnu-zipped-files (unzip-p)
"Find all zipped or unzipped files: the inverse of UNZIP-P."
(pcomplete-entries
nil
(lambda (entry)
(or (file-directory-p entry)
(when (and (file-readable-p entry)
(file-regular-p entry))
(let ((zipped (string-match "\\.\\(t?gz\\|\\(ta\\)?Z\\)\\'"
entry)))
(or (and unzip-p zipped)
(and (not unzip-p) (not zipped)))))))))
;;;###autoload
(defun pcomplete/bzip2 ()
"Completion for `bzip2'."
(pcomplete-opt "hdzkftcqvLVs123456789")
(while (pcomplete-here
(pcmpl-gnu-bzipped-files
(catch 'has-d-flag
(let ((args pcomplete-args))
(while args
(if (string-match "\\`-.*[dt]" (car args))
(throw 'has-d-flag t))
(setq args (cdr args)))))))))
(defun pcmpl-gnu-bzipped-files (unzip-p)
"Find all zipped or unzipped files: the inverse of UNZIP-P."
(pcomplete-entries
nil
(lambda (entry)
(when (and (file-readable-p entry)
(file-regular-p entry))
(let ((zipped (string-match "\\.\\(t?z2\\|bz2\\)\\'" entry)))
(or (and unzip-p zipped)
(and (not unzip-p) (not zipped))))))))
;;;###autoload
(defun pcomplete/make ()
"Completion for GNU `make'."
(let ((pcomplete-help "(make)Top"))
(pcomplete-opt "bmC/def(pcmpl-gnu-makefile-names)hiI/j?kl?no.pqrsStvwW.")
(while (pcomplete-here (completion-table-in-turn
(pcmpl-gnu-make-rule-names)
(pcomplete-entries))
nil #'identity))))
(defun pcmpl-gnu-makefile-names ()
"Return a list of possible makefile names."
(pcomplete-entries (mapconcat 'identity pcmpl-gnu-makefile-regexps "\\|")))
(defun pcmpl-gnu-make-targets (targets)
"Add to TARGETS the list of makefile targets in the current buffer.
Return the new list."
(goto-char (point-min))
(while (re-search-forward
"^\\([^\t\n#%.$][^:=\n]*\\)\\s-*:[^=]" nil t)
(setq targets (nconc (split-string (match-string-no-properties 1))
targets)))
targets)
(defun pcmpl-gnu-make-includes ()
"Return a list of all included file names in the current buffer."
(let (filenames)
(goto-char (point-min))
(while (search-forward-regexp "^include +\\(.*\\)$" nil t)
(push (match-string-no-properties 1) filenames))
filenames))
(defun pcmpl-gnu-make-all-targets (makefile targets)
"Add to TARGETS the list of target names in MAKEFILE and files it includes.
Return the new list."
(with-temp-buffer
(with-demoted-errors "Error inserting makefile: %S"
(insert-file-contents makefile))
(let ((filenames (when pcmpl-gnu-makefile-includes (pcmpl-gnu-make-includes))))
(setq targets (pcmpl-gnu-make-targets targets))
(dolist (file filenames)
(when (file-readable-p file)
(setq targets (pcmpl-gnu-make-all-targets file targets))))
))
targets)
(defun pcmpl-gnu-make-rule-names ()
"Return a list of possible make targets in a makefile in the current directory."
(let* ((minus-f (member "-f" pcomplete-args))
(makefile (or (cadr minus-f)
(cond
((file-exists-p "GNUmakefile") "GNUmakefile")
((file-exists-p "makefile") "makefile")
(t "Makefile"))))
rules)
(if (not (file-readable-p makefile))
(unless minus-f (list "-f"))
(setq rules (pcmpl-gnu-make-all-targets makefile rules))
(pcomplete-uniquify-list rules))))
(defcustom pcmpl-gnu-tarfile-regexp
"\\.t\\(ar\\(\\.\\(gz\\|bz2\\|Z\\|xz\\)\\)?\\|gz\\|a[zZ]\\|z2\\)\\'"
"A regexp which matches any tar archive."
:version "24.3" ; added xz
:type 'regexp)
;; Only used in tar-mode buffers.
(defvar tar-parse-info)
(declare-function tar-header-name "tar-mode" t t)
(defmacro pcmpl-gnu-with-file-buffer (file &rest body)
"Run BODY inside a buffer visiting FILE."
(declare (debug t) (indent 1))
(let ((exist (make-symbol "exist"))
(filesym (make-symbol "file"))
(buf (make-symbol "buf")))
`(let* ((,filesym ,file)
(,exist (find-buffer-visiting ,filesym))
(,buf (or ,exist (find-file-noselect ,filesym))))
(unwind-protect
(with-current-buffer ,buf
,@body)
(when (and (not ,exist) (buffer-live-p ,buf))
(kill-buffer ,buf))))))
(defvar pcmpl-gnu--tar-long-options
;; FIXME: Extract this list from "tar --help".
'("--absolute-names"
"--after-date="
"--append"
"--atime-preserve"
"--backup"
"--block-number"
"--blocking-factor="
"--catenate"
"--checkpoint"
"--compare"
"--compress"
"--concatenate"
"--confirmation"
"--create"
"--delete"
"--dereference"
"--diff"
"--directory="
"--exclude="
"--exclude-from="
"--extract"
"--file="
"--files-from="
"--force-local"
"--get"
"--group="
"--gzip"
"--help"
"--ignore-failed-read"
"--ignore-zeros"
"--incremental"
"--info-script="
"--interactive"
"--keep-old-files"
"--label="
"--list"
"--listed-incremental"
"--mode="
"--modification-time"
"--multi-volume"
"--new-volume-script="
"--newer="
"--newer-mtime"
"--no-recursion"
"--null"
"--numeric-owner"
"--old-archive"
"--one-file-system"
"--owner="
"--portability"
"--posix"
"--preserve"
"--preserve-order"
"--preserve-permissions"
"--read-full-records"
"--record-size="
"--recursive-unlink"
"--remove-files"
"--rsh-command="
"--same-order"
"--same-owner"
"--same-permissions"
"--sparse"
"--starting-file="
"--suffix="
"--tape-length="
"--to-stdout"
"--totals"
"--uncompress"
"--ungzip"
"--unlink-first"
"--update"
"--use-compress-program="
"--verbose"
"--verify"
"--version"
"--volno-file="))
;;;###autoload
(defun pcomplete/tar ()
"Completion for the GNU tar utility."
;; options that end in an equal sign will want further completion...
(let (saw-option complete-within)
(while (pcomplete-match "^-" 0)
(setq saw-option t)
(if (pcomplete-match "^--" 0)
(cond
((pcomplete-match "^--\\([^= \t\n\f]*\\)\\'" 0)
(pcomplete-here* pcmpl-gnu--tar-long-options))
((pcomplete-match "\\`--directory=\\(.*\\)" 0)
(pcomplete-here* (pcomplete-dirs)
(pcomplete-match-string 1 0)))
((pcomplete-match "\\`--exclude-from=\\(.*\\)" 0)
(pcomplete-here* (pcomplete-entries)
(pcomplete-match-string 1 0)))
((pcomplete-match "\\`--\\(extract\\|list\\)\\'" 0)
(setq complete-within t))
((pcomplete-match "\\`--file=\\(.*\\)" 0)
(pcomplete-here* (pcomplete-dirs-or-entries
pcmpl-gnu-tarfile-regexp)
(pcomplete-match-string 1 0)))
((pcomplete-match "\\`--files-from=\\(.*\\)" 0)
(pcomplete-here* (pcomplete-entries)
(pcomplete-match-string 1 0)))
((pcomplete-match "\\`--group=\\(.*\\)" 0)
(pcomplete-here* (pcmpl-unix-group-names)
(pcomplete-match-string 1 0)))
((pcomplete-match "\\`--info-script=\\(.*\\)" 0)
(pcomplete-here* (pcomplete-entries)
(pcomplete-match-string 1 0)))
((pcomplete-match "\\`--new-volume-script=\\(.*\\)" 0)
(pcomplete-here* (pcomplete-entries)
(pcomplete-match-string 1 0)))
((pcomplete-match "\\`--owner=\\(.*\\)" 0)
(pcomplete-here* (pcmpl-unix-user-names)
(pcomplete-match-string 1 0)))
((pcomplete-match "\\`--rsh-command=\\(.*\\)" 0)
(pcomplete-here* (funcall pcomplete-command-completion-function)
(pcomplete-match-string 1 0)))
((pcomplete-match "\\`--starting-file=\\(.*\\)" 0)
(pcomplete-here* (pcomplete-entries)
(pcomplete-match-string 1 0)))
((pcomplete-match "\\`--use-compress-program=\\(.*\\)" 0)
(pcomplete-here* (funcall pcomplete-command-completion-function)
(pcomplete-match-string 1 0)))
((pcomplete-match "\\`--volno-file=\\(.*\\)" 0)
(pcomplete-here* (pcomplete-entries)
(pcomplete-match-string 1 0)))
(t
(pcomplete-here*)))
(pcomplete-opt "01234567ABCFGKLMNOPRSTUVWXZbcdfghiklmoprstuvwxz")
(when (pcomplete-match "\\`-\\'" 0)
(pcomplete-here*))))
(unless saw-option
(pcomplete-here
(mapcar #'char-to-string
(string-to-list
"01234567ABCFGIKLMNOPRSTUVWXZbcdfghiklmoprstuvwxz")))
(if (pcomplete-match "[xt]" 'first 1)
(setq complete-within t)))
(pcomplete-here (pcomplete-dirs-or-entries pcmpl-gnu-tarfile-regexp))
(while (pcomplete-here
(if (and complete-within
(let* ((fa (file-attributes (pcomplete-arg 1)))
(size (file-attribute-size fa)))
(and (numberp size)
(or (null large-file-warning-threshold)
(< size large-file-warning-threshold)))))
(let ((file (pcomplete-arg 1)))
(completion-table-dynamic
(lambda (_string)
(pcmpl-gnu-with-file-buffer
file (mapcar #'tar-header-name tar-parse-info)))))
(pcomplete-entries))
nil #'identity))))
;;;###autoload
(defun pcomplete/find ()
"Completion for the GNU find utility."
(let ((prec (pcomplete-arg 'last -1)))
(cond ((and (pcomplete-match "^-" 'last)
(string= "find" prec))
(pcomplete-opt "HLPDO"))
((pcomplete-match "^-" 'last)
(while (pcomplete-here
'("-amin" "-anewer" "-atime" "-cmin" "-cnewer" "-context"
"-ctime" "-daystart" "-delete" "-depth" "-empty" "-exec"
"-execdir" "-executable" "-false" "-files0-from" "-fls" "-follow"
"-fprint" "-fprint0" "-fprintf" "-fstype" "-gid" "-group"
"-help" "-ignore_readdir_race" "-ilname" "-iname"
"-inum" "-ipath" "-iregex" "-iwholename"
"-links" "-lname" "-ls" "-maxdepth"
"-mindepth" "-mmin" "-mount" "-mtime"
"-name" "-newer" "-newerxy" "-nogroup" "-noignore_readdir_race"
"-noleaf" "-nouser" "-nowarn" "-ok"
"-okdir" "-path" "-perm" "-print"
"-print0" "-printf" "-prune" "-quit"
"-readable" "-regex" "-regextype" "-samefile"
"-size" "-true" "-type" "-uid"
"-used" "-user" "-version" "-warn"
"-wholename" "-writable" "-xdev" "-xtype"))))
((string= "-type" prec)
(while (pcomplete-here (list "b" "c" "d" "p" "f" "l" "s" "D"))))
((string= "-xtype" prec)
(while (pcomplete-here (list "b" "c" "d" "p" "f" "l" "s"))))
((or (string= prec "-exec")
(string= prec "-execdir"))
(while (pcomplete-here* (funcall pcomplete-command-completion-function)
(pcomplete-arg 'last) t))))
(while (pcomplete-here (pcomplete-dirs) nil #'identity))))
;;;###autoload
(defun pcomplete/awk ()
"Completion for the `awk' command."
(pcomplete-here-using-help "awk --help"
:margin "\t"
:separator " +"
:description "\0"
:metavar "[=a-z]+"))
;;;###autoload
(defun pcomplete/gpg ()
"Completion for the `gpg` command."
(pcomplete-here-using-help "gpg --help" :narrow-end "^ -se"))
;;;###autoload
(defun pcomplete/gdb ()
"Completion for the `gdb' command."
(while
(cond
((string= "--args" (pcomplete-arg 1))
(funcall pcomplete-command-completion-function)
(funcall (or (pcomplete-find-completion-function (pcomplete-arg 1))
pcomplete-default-completion-function)))
((string-prefix-p "-" (pcomplete-arg 0))
(pcomplete-here (pcomplete-from-help "gdb --help")))
(t (pcomplete-here (pcomplete-entries))))))
;;;###autoload
(defun pcomplete/emacs ()
"Completion for the `emacs' command."
(pcomplete-here-using-help "emacs --help" :margin "^\\(\\)-"))
;;;###autoload
(defun pcomplete/emacsclient ()
"Completion for the `emacsclient' command."
(pcomplete-here-using-help "emacsclient --help" :margin "^\\(\\)-"))
;;; pcmpl-gnu.el ends here