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
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
|
;;; ansi-osc.el --- Support for OSC escape sequences -*- lexical-binding: t; -*-
;; Copyright (C) 2022-2023 Free Software Foundation, Inc.
;; Author: Augusto Stoffel <arstoffel@gmail.com>
;; Matthias Meulien <orontee@gmail.com>
;; Maintainer: emacs-devel@gnu.org
;; Keywords: processes, terminals, services
;; 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:
;; Interpretation of OSC (Operating System Commands) escape sequences.
;; Handlers for OSC 2, 7 and 8 (for window title, current directory
;; and hyperlinks respectively) are provided.
;; The function `ansi-osc-compilation-filter' can be added to
;; `compilation-filter-hook' to collect OSC sequences in compilation
;; buffers. The variable `ansi-osc-for-compilation-buffer' tells what
;; to do with collected sequences.
;;; Code:
(defconst ansi-osc-control-seq-regexp
;; See ECMA 48, section 8.3.89 "OSC - OPERATING SYSTEM COMMAND".
"\e\\][\x08-\x0D]*[\x20-\x7E]*\\(\a\\|\e\\\\\\)"
"Regexp matching an OSC control sequence.")
(defun ansi-osc-filter-region (begin end)
"Filter out all OSC control sequences from region between BEGIN and END."
(save-excursion
(goto-char begin)
;; Delete escape sequences.
(while (re-search-forward ansi-osc-control-seq-regexp end t)
(delete-region (match-beginning 0) (match-end 0)))))
(defvar-local ansi-osc-handlers '(("2" . ansi-osc-window-title-handler)
("7" . ansi-osc-directory-tracker)
("8" . ansi-osc-hyperlink-handler))
"Alist of handlers for OSC escape sequences.
See `ansi-osc-apply-on-region' for details.")
(defvar-local ansi-osc--marker nil)
;; The function `ansi-osc-apply-on-region' can set `ansi-osc--marker'
;; to the start position of an escape sequence without termination.
(defun ansi-osc-apply-on-region (begin end)
"Interpret OSC escape sequences in region between BEGIN and END.
This function searches for escape sequences of the forms
ESC ] command ; text BEL
ESC ] command ; text ESC \\
Every occurrence of such escape sequences is removed from the
buffer. Then, if `command' is a key in the alist that is the
value of the local variable `ansi-osc-handlers', that key's
value, which should be a function, is called with `command' and
`text' as arguments, with point where the escape sequence was
located."
(save-excursion
(goto-char (or ansi-osc--marker begin))
(when (eq (char-before) ?\e) (backward-char))
(while (re-search-forward "\e]" end t)
(let ((pos0 (match-beginning 0))
(code (and (re-search-forward "\\=\\([0-9A-Za-z]*\\);" end t)
(match-string 1)))
(pos1 (point)))
(if (re-search-forward "\a\\|\e\\\\" end t)
(let ((text (buffer-substring-no-properties
pos1 (match-beginning 0))))
(setq ansi-osc--marker nil)
(delete-region pos0 (point))
(when-let ((fun (cdr (assoc-string code ansi-osc-handlers))))
(funcall fun code text)))
(put-text-property pos0 end 'invisible t)
(setq ansi-osc--marker (copy-marker pos0)))))))
;; Window title handling (OSC 2)
(defvar-local ansi-osc-window-title nil)
(defun ansi-osc-window-title-handler (_ text)
"Set value of `ansi-osc-window-title' from an OSC 2 escape sequence.
The variable `ansi-osc-window-title' can then be referenced in
`frame-title-format' to dynamically set the frame title.
This function is intended to be included as an element of the
list that is the value of `ansi-osc-handlers'."
(setq ansi-osc-window-title text))
;; Current directory tracking (OSC 7)
(declare-function url-host "url/url-parse.el")
(declare-function url-type "url/url-parse.el")
(declare-function url-filename "url/url-parse.el")
(defun ansi-osc-directory-tracker (_ text)
"Update `default-directory' from OSC 7 escape sequences.
This function is intended to be included as an element of the
list that is the value of `ansi-osc-handlers'. You should arrange
for your shell to print the appropriate escape sequence at each prompt,
such as with the following command:
printf \"\\e]7;file://%s%s\\e\\\\\" \"$HOSTNAME\" \"$PWD\"
This functionality serves as an alternative to `dirtrack-mode'
and `shell-dirtrack-mode'."
(let ((url (url-generic-parse-url text)))
(when (and (string= (url-type url) "file")
(or (null (url-host url))
(string= (url-host url) (system-name))))
(ignore-errors
(cd-absolute (url-unhex-string (url-filename url)))))))
;; Hyperlink handling (OSC 8)
(defvar-keymap ansi-osc-hyperlink-map
:doc "Keymap used by OSC 8 hyperlink buttons."
"C-c RET" #'browse-url-button-open
"<mouse-2>" #'browse-url-button-open
"<follow-link>" 'mouse-face)
(define-button-type 'ansi-osc-hyperlink
'keymap ansi-osc-hyperlink-map
'help-echo (lambda (_ buffer pos)
(when-let ((url (get-text-property pos 'browse-url-data buffer)))
(format "mouse-2, C-c RET: Open %s" url))))
(defvar-local ansi-osc-hyperlink--state nil)
(defun ansi-osc-hyperlink-handler (_ text)
"Create a hyperlink from an OSC 8 escape sequence.
This function is intended to be included as an element of the list
that is the value of `ansi-osc-handlers'."
(when ansi-osc-hyperlink--state
(let ((start (car ansi-osc-hyperlink--state))
(url (cdr ansi-osc-hyperlink--state)))
(make-text-button start (point)
'type 'ansi-osc-hyperlink
'browse-url-data url)))
(setq ansi-osc-hyperlink--state
(and (string-match ";\\(.+\\)" text)
(cons (point-marker) (match-string-no-properties 1 text)))))
(defgroup ansi-osc nil
"Interpretation of OSC escape sequences.
Handlers for OSC 2, 7 and 8 (for window title, current directory
and hyperlinks respectively) are provided. OSC (Operating System
Commands) control sequences are defined in section 8.3.89 of the
ECMA-48 standard is freely available at
<URL:https://www.ecma-international.org/publications/standards/Ecma-048.htm>
as a PDF file."
:version "29.1"
:group 'processes)
(defcustom ansi-osc-for-compilation-buffer 'filter
"What to do with OSC escape sequences in compilation output.
If nil, do nothing.
If the symbol `filter', then filter out all OSC control sequences.
If any other non-nil value, then collect OSC control sequences
and call the appropriate handlers as described in `ansi-osc-handlers'.
In order for this to have any effect, `ansi-osc-compilation-filter'
must be in `compilation-filter-hook'."
:type '(choice (const :tag "Do nothing" nil)
(const :tag "Filter out OSC" filter)
(other :tag "Translate OSC" t))
:group 'ansi-osc
:version "29.1")
(defvar compilation-filter-start)
;;;###autoload
(defun ansi-osc-compilation-filter ()
"Maybe collect OSC control sequences.
This function depends on the variable `ansi-osc-for-compilation-buffer',
and is meant to be used in `compilation-filter-hook'."
(let ((inhibit-read-only t))
(pcase ansi-osc-for-compilation-buffer
('nil nil)
('filter
(ansi-osc-filter-region compilation-filter-start (point)))
(_
(ansi-osc-apply-on-region compilation-filter-start (point))))))
(provide 'ansi-osc)
;;; ansi-osc.el ends here
|
