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
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
|
;;; ess-trns.el --- Support for manipulating S transcript files
;; Copyright (C) 1989--1994 Bates, Kademan, Ritter and Smith
;; Copyright (C) 1997--2010 A.J. Rossini, Richard M. Heiberger, Martin
;; Maechler, Kurt Hornik, Rodney Sparapani, and Stephen Eglen.
;; Copyright (C) 2011--2012 A.J. Rossini, Richard M. Heiberger, Martin Maechler,
;; Kurt Hornik, Rodney Sparapani, Stephen Eglen and Vitalie Spinu.
;; Author: David Smith <dsmith@stats.adelaide.edu.au>
;; Maintainer: ESS-core <ESS-core@r-project.org>
;; This file is part of ESS
;; This file 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 2, or (at your option)
;; any later version.
;; This file 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.
;; A copy of the GNU General Public License is available at
;; https://www.r-project.org/Licenses/
;;; Commentary:
;; Code for dealing with ESS transcripts.
;;; Code:
; Requires and autoloads
(require 'ess-mode)
(require 'ess-inf)
(require 'comint)
; ess-transcript-mode
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;;; In this section:
;;;;
;;;; * The major mode ess-transcript-mode
;;;; * Commands for ess-transcript-mode
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;*;; Major mode definition
(defvar ess-transcript-mode-map nil "Keymap for `ess-transcript-mode'.")
(unless ess-transcript-mode-map
(setq ess-transcript-mode-map (make-sparse-keymap))
(define-key ess-transcript-mode-map "\C-c\C-s" 'ess-switch-process)
(define-key ess-transcript-mode-map "\C-c\C-r" 'ess-eval-region)
(define-key ess-transcript-mode-map "\C-c\M-r" 'ess-eval-region-and-go)
;; (define-key ess-transcript-mode-map "\M-\C-x" 'ess-eval-function)
;; (define-key ess-transcript-mode-map "\C-c\M-f" 'ess-eval-function-and-go)
;; (define-key ess-transcript-mode-map "\C-c\C-j" 'ess-eval-line)
;; (define-key ess-transcript-mode-map "\C-c\M-j" 'ess-eval-line-and-go)
(define-key ess-transcript-mode-map "\C-c\C-k" 'ess-force-buffer-current)
(define-key ess-transcript-mode-map "\C-c\C-q" 'ess-quit)
(define-key ess-transcript-mode-map "\C-c\C-j" 'ess-transcript-send-command)
(define-key ess-transcript-mode-map "\C-c\M-j" 'ess-transcript-send-command-and-move)
(define-key ess-transcript-mode-map "\M-\C-a" 'ess-goto-end-of-function-or-para)
(define-key ess-transcript-mode-map "\M-\C-e" 'ess-goto-end-of-function-or-para)
(define-key ess-transcript-mode-map "\C-c\C-y" 'ess-switch-to-ESS)
(define-key ess-transcript-mode-map "\C-c\C-z" 'ess-switch-to-end-of-ESS)
(define-key ess-transcript-mode-map "\C-c\C-v" 'ess-display-help-on-object)
(define-key ess-transcript-mode-map "\C-c\C-d" 'ess-dump-object-into-edit-buffer)
(define-key ess-transcript-mode-map "\C-c\t" 'ess-complete-object-name-deprecated)
(define-key ess-transcript-mode-map "\C-a" 'comint-bol)
(define-key ess-transcript-mode-map "\M-\t" 'comint-replace-by-expanded-filename)
(define-key ess-transcript-mode-map "\M-?" 'comint-dynamic-list-completions)
(define-key ess-transcript-mode-map "\C-c\C-k" 'ess-request-a-process)
(define-key ess-transcript-mode-map "{" 'skeleton-pair-insert-maybe)
(define-key ess-transcript-mode-map "}" 'skeleton-pair-insert-maybe)
(define-key ess-transcript-mode-map "\e\C-h" 'ess-mark-function)
(define-key ess-transcript-mode-map "\e\C-q" 'ess-indent-exp)
;(define-key ess-transcript-mode-map "\177" 'backward-delete-char-untabify)
(define-key ess-transcript-mode-map "\t" 'ess-indent-command)
(define-key ess-transcript-mode-map "\C-c\C-p" 'comint-previous-prompt)
(define-key ess-transcript-mode-map "\C-c\C-n" 'comint-next-prompt)
;; (define-key ess-transcript-mode-map "\C-c\C-n" 'ess-eval-line-and-step)
(define-key ess-transcript-mode-map "\r" 'ess-transcript-send-command-and-move)
(define-key ess-transcript-mode-map "\M-\r" 'ess-transcript-send-command)
(define-key ess-transcript-mode-map "\C-c\r" 'ess-transcript-copy-command)
(define-key ess-transcript-mode-map "\C-c\C-w" 'ess-transcript-DO-clean-region)
(define-key ess-transcript-mode-map "\C-c\M-c" 'ess-transcript-clean-buffer)
)
(easy-menu-define
ess-transcript-mode-menu ess-transcript-mode-map
"Menu for use in S transcript mode."
'("ESS-trans"
["What is this? (beta)" ess-mouse-me t]
["Describe" describe-mode t]
["About" (ess-goto-info "Transcript Mode") t]
["Send bug report" ess-submit-bug-report t]
"------"
["Mark cmd group" mark-paragraph t]
["Previous prompt" comint-previous-prompt t]
["Next prompt" comint-next-prompt t]
"------"
["Send and move" ess-transcript-send-command-and-move t]
["Copy command" ess-transcript-copy-command t]
["Send command" ess-transcript-send-command t]
["Clean Region" ess-transcript-DO-clean-region t]
["Clean Whole Buffer" ess-transcript-clean-buffer t]
["Switch S process" ess-switch-process t]
))
(if (featurep 'ess-trans)
(define-key ess-transcript-mode-map [menu-bar ess-trans]
(cons "ess-trans" ess-transcript-mode-menu))
(eval-after-load "ess-trans"
'(define-key ess-transcript-mode-map
[menu-bar ess-trans]
(cons "ess-trans"
ess-transcript-mode-menu))))
;;;###autoload
(defun ess-transcript-mode (alist &optional proc)
"Major mode for manipulating {ESS} transcript files.
Type \\[ess-transcript-send-command] to send a command in the
transcript to the current S process. \\[ess-transcript-copy-command]
copies the command but does not execute it, allowing you to edit it in
the process buffer first.
Type \\[ess-transcript-clean-region] to delete all outputs and prompts
in the region, leaving only the S commands. Other keybindings are:
\\{ess-transcript-mode-map}"
(kill-all-local-variables)
(setq buffer-read-only t) ;; to protect the buffer.
(ess-setq-vars-local alist); (current-buffer))
(setq major-mode 'ess-transcript-mode)
(setq mode-name "ESS Transcript")
(use-local-map ess-transcript-mode-map)
(set-syntax-table (or inferior-ess-mode-syntax-table
ess-mode-syntax-table))
(setq mode-line-process
'(" [" ess-local-process-name "]"))
(make-local-variable 'ess-local-process-name)
(setq ess-local-process-name nil)
(unless inferior-ess-prompt ;; For S languages it is set in custom-alist
(setq inferior-ess-prompt
;; Do not anchor to bol with `^'
(concat "\\("
inferior-ess-primary-prompt
"\\|"
inferior-ess-secondary-prompt
"\\)")))
(make-local-variable 'paragraph-start)
(setq paragraph-start (concat "^" inferior-ess-prompt "\\|^\^L"))
(make-local-variable 'paragraph-separate)
(setq paragraph-separate "^\^L")
(make-local-variable 'comint-use-prompt-regexp)
(setq comint-use-prompt-regexp t)
(make-local-variable 'comint-prompt-regexp)
(setq comint-prompt-regexp (concat "^" inferior-ess-prompt))
(setq inferior-ess-font-lock-keywords 'inferior-ess-r-font-lock-keywords)
(setq font-lock-defaults '(ess-build-font-lock-keywords
nil nil ((?\. . "w") (?\_ . "w") (?' . "."))))
;;; Keep <tabs> out of the code.
(make-local-variable 'indent-tabs-mode)
(setq indent-tabs-mode nil)
(run-mode-hooks 'ess-transcript-mode-hook))
;;*;; Commands used in S transcript mode
(defun ess-transcript-send-command ()
"Send the command at point in the transcript to the ESS process.
The line should begin with a prompt. The ESS process buffer is displayed if it
is not already."
(interactive)
(let* ((proc (or ess-local-process-name
(ess-request-a-process "Evaluate into which process? " t)))
(ess-buf (ess-get-process-buffer proc)))
(setq ess-local-process-name proc)
(if (get-buffer-window ess-buf) nil
(display-buffer ess-buf t))
(let ((input (inferior-ess-get-old-input)))
(with-current-buffer ess-buf
(goto-char (point-max))
(ess-eval-linewise input)))))
(defun ess-transcript-send-command-and-move ()
"Send the command on this line, and move point to the next command."
(interactive)
;; (ess-transcript-send-command) ;; This doesn't work properly
;; replacement code begins
(let* ((proc (or ess-local-process-name
(ess-request-a-process "Evaluate into which process? " t)))
(ess-buf (ess-get-process-buffer proc)))
(setq ess-local-process-name proc)
(if (get-buffer-window ess-buf) nil
(display-buffer ess-buf t))
(let ((input (inferior-ess-get-old-input)))
(with-current-buffer ess-buf
(goto-char (point-max))
(ess-eval-linewise input nil nil nil 1))))
;; replacement code ends
(goto-char ess-temp-point)
(comint-next-prompt 1))
(defun ess-transcript-copy-command ()
"Copy the command at point to the command line of the ESS process."
(interactive)
(let* ((proc (or ess-local-process-name
(ess-request-a-process "Evaluate into which process? " t)))
(ess-buf (process-buffer (get-process proc)))
(input (inferior-ess-get-old-input)))
(setq ess-local-process-name proc)
(if (get-buffer-window ess-buf) nil
(display-buffer ess-buf t))
(with-current-buffer ess-buf
(goto-char (point-max))
(insert input)))
(ess-switch-to-end-of-ESS))
;;;###autoload
(defun ess-transcript-clean-region (beg end even-if-read-only)
"Strip the transcript in the region, leaving only (R/S/Lsp/..) commands.
Deletes any lines not beginning with a prompt, and then removes the
prompt from those lines that remain. Prefix argument means to
clean even if the buffer is \\[read-only]."
(interactive "r\nP")
(unless inferior-ess-prompt
(error "Cannot clean ESS transcript region in this mode!
That only works in ess-transcript-mode or inferior-ess-mode ('*R*' etc)."
;; Maybe call ess-clean-region-in-new-transcript ?"))
))
(let ((do-toggle (and buffer-read-only even-if-read-only))
(ess-prompt-rx (if inferior-ess-secondary-prompt
(concat "^\\(\\("
inferior-ess-prompt
"\\)\\|\\("
inferior-ess-secondary-prompt
"\\)\\)")
(concat "^" inferior-ess-prompt))))
(save-excursion
(if do-toggle (setq buffer-read-only nil))
(save-restriction
(deactivate-mark)
(narrow-to-region beg end)
(goto-char (point-min))
(delete-non-matching-lines ess-prompt-rx)
(goto-char (point-min))
;; (replace-regexp * * ) :
(while (re-search-forward ess-prompt-rx nil t)
(replace-match "" nil nil)))
(if do-toggle (setq buffer-read-only t)))))
;; unfinished idea :-----------------------
;; (defun ess-clean-region-in-new-transcript (beg end)
;; "Copy the region into a new ess-transcript buffer, and clean it there,
;; using \\[ess-transcript-clean-region]."
;; (interactive "r")
;; (let ((bname (buffer-file-name)))
;; (setq bname (if bname .. ..))
;; (let
;; (fbase (if fname (file-name-sans-extension (file-name-nondirectory fname))
;; (buffer-name)))
;;
;; ;; the buffer name should be like a file name
;; (buf-nam ....)
;; (trns-buf (get-buffer-create fbase))
;; (pop-to-buffer trns-buf)
;; (ess-transcript-mode .....)
;; )))
(defun ess-transcript-DO-clean-region (beg end)
"Clean the current via \\[ess-transcript-clean-region] even if the buffer is read-only."
(interactive "r")
(ess-transcript-clean-region beg end 'In-ANY-case))
(defun ess-transcript-clean-buffer ()
"Cleanup the whole buffer.
Use point-min/max to obey `narrow-to-region'."
(interactive)
(ess-transcript-clean-region (point-min) (point-max) 'In-ANY-case))
(provide 'ess-trns)
;;; ess-trns.el ends here
|
