all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
blob c31ef3d21688f078fe71b407a0e45f757e37f221 4309 bytes (raw)
name: lisp/shorthands.el 	 # note: path name is non-authoritative(*)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
;;; shorthands.el --- Read code considering Elisp shorthands  -*- lexical-binding: t; -*-

;; Copyright (C) 2021 Free Software Foundation, Inc.

;; Author: João Távora <joaotavora@gmail.com>
;; Keywords: lisp

;; 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:

;; Basic helpers for loading files with Shorthands.

;;; Code:
(require 'files)
(eval-when-compile (require 'cl-lib))

(defun hack-read-symbol-shorthands (fullname)
  "Return value of `read-symbol-shorthands' file-local variable in FULLNAME.
FULLNAME is the absolute file name of an Elisp .el file which
potentially specifies a file-local value for
`read-symbol-shorthands'.  The Elisp code in FULLNAME isn't read
or evaluated in any way, except for extraction of the
buffer-local value of `read-symbol-shorthands'."
  (let* ((size (nth 7 (file-attributes fullname)))
         (from (max 0 (- size 3000)))
         (to size))
    (with-temp-buffer
      (while (and (< (buffer-size) 3000) (>= from 0))
        (insert-file-contents fullname nil from to)
        (setq to from
              from (cond
                    ((= from 0) -1)
                    (t (max 0 (- from 100))))))
      ;; FIXME: relies on the `hack-local-variables--find-variables'
      ;; detail of files.el.  That function should be exported,
      ;; possibly be refactored into two parts, since we're only
      ;; interested in basic "Local Variables" parsing.
      (alist-get 'read-symbol-shorthands (hack-local-variables--find-variables)))))

(defun load-with-shorthands-and-code-conversion (fullname file noerror nomessage)
  "Like `load-with-code-conversion', but also consider Elisp shorthands.
This function uses shorthands defined in the file FULLNAME's local
value of `read-symbol-shorthands', when it processes that file's Elisp code."
  (let ((read-symbol-shorthands (hack-read-symbol-shorthands fullname)))
    (load-with-code-conversion fullname file noerror nomessage)))

\f
;; FIXME: move this all to progmodes/elisp-mode.el?  OTOH it'd make
;; more sense there, OTOH all the elisp font-lock stuff is actually in
;; lisp/emacs-lisp/lisp-mode.el, which isn't right either.  So
;; shorthand font-locking logic is probably better here for now.

(defface elisp-shorthand-font-lock-face
  '((t :inherit font-lock-keyword-face :foreground "cyan"))
  "Face for highlighting shorthands in Emacs Lisp."
  :version "28.1"
  :group 'font-lock-faces)

(defun shorthands--mismatch-from-end (str1 str2)
  (cl-loop with l1 = (length str1) with l2 = (length str2)
           for i from 1
           for i1 = (- l1 i) for i2 = (- l2 i)
           while (and (>= i1 0) (>= i2 0) (eq (aref str1 i1) (aref str2 i2)))
           finally (return (1- i))))

(defun shorthands-font-lock-shorthands (limit)
  (when read-symbol-shorthands
    (while (re-search-forward
            (eval-when-compile
              (concat "\\_<\\(" lisp-mode-symbol-regexp "\\)\\_>"))
            limit t)
      (let* ((existing (get-text-property (match-beginning 1) 'face))
             (probe (and (not (memq existing '(font-lock-comment-face
                                               font-lock-string-face)))
                         (intern-soft (match-string 1))))
             (sname (and probe (symbol-name probe)))
             (mm (and sname (shorthands--mismatch-from-end
                             (match-string 1) sname))))
        (unless (or (null mm) (= mm (length sname)))
          (add-face-text-property (match-beginning 1) (1+ (- (match-end 1) mm))
                                  'elisp-shorthand-font-lock-face))))))

(font-lock-add-keywords 'emacs-lisp-mode '((shorthands-font-lock-shorthands)) t)

;;; shorthands.el ends here

debug log:

solving c31ef3d216 ...
found c31ef3d216 in https://git.savannah.gnu.org/cgit/emacs.git

(*) Git path names are given by the tree(s) the blob belongs to.
    Blobs themselves have no identifier aside from the hash of its contents.^

Code repositories for project(s) associated with this external index

	https://git.savannah.gnu.org/cgit/emacs.git
	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.