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
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
|
;;; ess-help.el --- Support for viewing ESS help files -*- lexical-binding: t; -*-
;; Copyright (C) 1989-2020 Free Software Foundation, Inc.
;; Author: David Smith <dsmith@stats.adelaide.edu.au>
;; Created: 7 Jan 1994
;; Maintainer: ESS-core <ESS-core@r-project.org>
;; This file is part of GNU Emacs.
;;; License:
;;
;; This program 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.
;;
;; This program 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 this program. If not, see
;; <http://www.gnu.org/licenses/>
;;; Commentary:
;; Code for dealing with ESS help files. See README.<LANGUAGE> where
;; <LANGUAGE> is one of `S', `SAS', `Stata' or `XLispStat'.
;;; Code:
; Requires and autoloads
(require 'cl-lib)
(eval-when-compile
(require 'tramp))
(require 'info)
(require 'ess-mode)
(require 'ess-inf)
(require 'ess-utils)
(require 'ansi-color)
(declare-function ess-r-help-mode "ess-r-mode")
(declare-function ess-stata-help-mode "ess-stata-lang")
(defcustom ess-help-mode-hook nil
"Functions to call when entering `ess-help-mode'."
:group 'ess-hooks
:type 'hook)
(defvar ess--help-frame nil
"Stores the frame used for displaying R help buffers.")
(defvar ess-help--aliases-timeout 10
"The large timeout is necessary for some users (#1025, #1081).")
; ess-help-mode
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;;; In this section:
;;;;
;;;; * The function ess-display-help-on-object
;;;; * The major mode ess-help-mode
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
(cl-defgeneric ess--help-major-mode ()
"Determine which help major mode to call, and call it.
Uses `ess-dialect' to determine the appropriate help mode."
(ess-help-mode))
(defun ess--help-get-bogus-buffer-substring (buffer &optional nr-first)
"Return non-nil if BUFFER looks like a bogus ESS help buffer.
Return the pair (match-beg. match-end) which can be used in error
message. NR-FIRST is the number of characters at the start of the
buffer to examine when deciding if the buffer if bogus. If nil,
the first 150 characters of the buffer are searched."
(if (not nr-first) (setq nr-first 150))
(with-current-buffer buffer
(let ((PM (point-min))
(case-fold-search t)
searching res)
(setq res
(or ;; evaluate up to first non-nil (or end):
(< (- (point-max) PM) 80); buffer less than 80 chars
(not (setq searching t))
;; todo: move to customize-alist
(progn (goto-char PM) ;; R:
(re-search-forward "Error in help" nr-first t))
(progn (goto-char PM) ;; S-plus 5.1 :
(re-search-forward "^cat: .*--" nr-first t))
(progn (goto-char PM) ;; S version 3 ; R :
(re-search-forward "no documentation .+" nr-first t))
(progn (goto-char PM) ;; stata
(re-search-forward "^help .*not found" nr-first t))))
(ess-write-to-dribble-buffer
(format " |--> %s [searching %s]\n" res searching))
(when res
(if searching
(buffer-substring (match-beginning 0) (match-end 0))
(buffer-string))))))
(defun ess-help-get-local-help-buffers ()
(ess-force-buffer-current)
(cl-remove-if-not
(lambda (buffer)
(let* ((pattern (concat "*help[" ess-current-process-name "]("))
(name (buffer-name buffer))
(candidate (when (> (length name) (length pattern))
(substring name 0 (length pattern))) ))
(when (string= pattern candidate)
buffer)))
(buffer-list)))
(defvar-local ess-help-type nil
"Type of help file, help, index, vignettes etc.
Local in `ess-help' buffers.")
(defvar-local ess-help-object nil
"Name of the object the help is displayed for.
Is name of the package for package index.
Local in `ess-help' buffers.")
(put 'ess-help-object 'permanent-local t)
(defun ess-display-help-on-object (object &optional command)
"Display documentation for OBJECT.
If prefix ARG is given, force an update of the cached help topics
and query the ESS process for the help file instead of reusing an
existing buffer if it exists. Uses the variable
`inferior-ess-help-command' for the actual help command. Prompts
for the object name based on the cursor location for all cases
except the S-Plus GUI. With S-Plus on Windows (both GUI and in an
inferior Emacs buffer) the GUI help window is used. If COMMAND is
supplied, it is used instead of `inferior-ess-help-command'."
(interactive
(progn
(ess-force-buffer-current)
(when current-prefix-arg
(ess-help--reset-cache))
(list (ess-find-help-file "Help on"))))
(let* ((hb-name (concat "*help[" ess-current-process-name "]("
(replace-regexp-in-string "^\\?\\|`" "" object) ")*"))
(old-hb-p (get-buffer hb-name))
(tbuffer (get-buffer-create hb-name)))
(when (or (not old-hb-p)
(ess-process-get 'sp-for-help-changed?)
(ess--help-get-bogus-buffer-substring old-hb-p))
(ess-with-current-buffer tbuffer
(ess--flush-help-into-current-buffer object command)
(setq ess-help-object object)
(ess--help-major-mode)
(setq truncate-lines nil
ess-help-type 'help)))
(unless (ess--help-kill-bogus-buffer-maybe tbuffer)
(ess-display-help tbuffer))))
(defun ess-help--reset-cache ()
"Reset all cached help files."
(ess-process-put 'sp-for-help-changed? t)
(ess-help--reset-cache-override))
(cl-defgeneric ess-help--reset-cache-override ())
(defun ess-help-revert-buffer (_ignore-auto _noconfirm)
"Revert the current help buffer.
This reloads the documentation. IGNORE-AUTO and NOCONFIRM are
ignored."
(ess-process-put 'sp-for-help-changed? t)
(ess-display-help-on-object ess-help-object))
(defalias 'ess-help 'ess-display-help-on-object)
(cl-defgeneric ess-build-help-command (object)
"Build a string command for retrieving help on OBJECT."
(format inferior-ess-help-command object))
(defun ess--flush-help-into-current-buffer (object &optional command)
(let ((inhibit-modification-hooks t)
(inhibit-read-only t))
(delete-region (point-min) (point-max))
(let ((command (if (and command (string-match-p "%s" command))
(format command object)
command)))
(ess-command (or command (ess-build-help-command object))
(current-buffer)))
(ess-help-underline)
(unless (string= ess-language "STA")
(ess-nuke-help-bs))
(goto-char (point-min))
(set-buffer-modified-p 'nil)))
(defun ess--help-kill-bogus-buffer-maybe (buffer)
"Internal, try to kill bogus BUFFER with message. Return t if killed."
(when ess-help-kill-bogus-buffers
(let ((bog-mes (ess--help-get-bogus-buffer-substring buffer)))
(when bog-mes
;; The following is giving erroneous messages when help is displayed in the browser
;; (when (< (length bog-mes) 10) ;;no message at all, how to treat this properly?
;; (setq bog-mes (format "No documentation found; %s" bog-mes)))
(ess-write-to-dribble-buffer
(format "(ess-help: kill bogus buffer %s ..\n" (buffer-name buffer)))
(message "%s" (replace-regexp-in-string "\n" "" bog-mes))
;; (ding) ;; don't ding, in julia a lot of doc strings are very short
(kill-buffer buffer)))))
(defun ess-display-help-in-browser ()
"Displaying HTML help where available, using \\[browse-url]."
(interactive)
(unless (string-match "^R" ess-dialect)
(user-error "Sorry, not implemented for %s " ess-dialect))
(if (or (not ess-help-object)
(not (eq ess-help-type 'help)))
(message "No help topic found")
(ess-command (format "help('%s', help_type='html')\n" ess-help-object))))
(defun ess--button-action (&optional button)
"Provide help on object at the beginning of line.
It's intended to be used in R-index help pages. Load the package
if necessary. It is bound to RET and C-m in R-index pages."
(let* ((string (button-label button))
(command (ess-build-help-command string)))
(ess-display-help-on-object string command)))
(cl-defgeneric ess-help-commands ()
"Return an alist of dialect specific retriever commands.
Currently understood commands:
- package-for-object - command to get the package of current
help object
- packages - command to get a list of available
packages (REQUIRED)
- package-index - command to get the package index (REQUIRED)
- index-keyword-reg - regexp used to find keywords for linking in
index listing only (1st subexpression is used)
- index-start-reg - regexp from where to start searching for
keywords in index listing"
(user-error "Not implemented for %s " ess-dialect))
(cl-defmethod ess-help-commands (&context (ess-dialect "R"))
'((package-for-object . "sub('package:', '', .ess.findFUN('%s'))\n")
(packages . ".packages(all.available=TRUE)\n")
(package-index . ".ess.help(package='%s', help.type='text')\n")
(index-keyword-reg . "^\\([^ \t\n:]+\\)")
(index-start-reg . "^Index:")))
(defun ess-display-package-index (&optional package)
"Prompt for package name and display its index."
(interactive
(list (let* ((coms (ess-help-commands))
(all-packs (ess-get-words-from-vector (cdr (assoc 'packages coms))))
(pack (or (when (and ess-help-object
(cdr (assoc 'package-for-object coms))
(eq ess-help-type 'help))
(car (ess-get-words-from-vector
(format (cdr (assoc 'package-for-object coms))
ess-help-object))))
(car (member (ess-read-object-name-default) all-packs)))))
(ess-completing-read "Index of" all-packs nil nil nil nil pack))))
(let ((coms (ess-help-commands)))
(ess--display-indexed-help-page
(format (cdr (assoc 'package-index coms)) package)
(cdr (assoc 'index-keyword-reg coms))
(format "*help[%s](index:%s)*" ess-dialect package)
'index nil nil (cdr (assoc 'index-start-reg coms)) package)))
(defun ess--display-indexed-help-page (command item-regexp title help-type
&optional action help-echo reg-start help-object)
"Internal function to display help pages with linked actions.
COMMAND to produce the indexed help page,
ITEM-REGEXP -- first subexpression is highlighted,
TITLE of the help page,
HELP-TYPE to be stored in `ess-help-type' local variable,
ACTION is a function with no argument (default is `ess--button-action'),
HELP-ECHO if given becomes the help-echo property of the button,
REG-START gives the start location from where to search linkifying,
and HELP-OBJECT becomes `ess-help-object'."
(let ((inhibit-modification-hooks t)
(alist ess-local-customize-alist)
(pname ess-local-process-name)
(buff (get-buffer-create title)))
(ess-with-current-buffer buff
(setq buffer-read-only nil)
(delete-region (point-min) (point-max))
(setq ess-local-process-name pname)
(ess--help-major-mode)
(ess-setq-vars-local (eval alist))
(setq ess-help-object help-object
ess-help-sec-regex "\\(^\\s-.*\n\\)\\|\\(^\n\\)")
(ess--foreground-command command buff)
(ess-help-underline)
(set-buffer-modified-p 'nil)
(goto-char (point-min))
(when reg-start ;; go to the beginning of listing
(re-search-forward reg-start nil t))
(when item-regexp
;;linkify the buffer
(save-excursion
(while (re-search-forward item-regexp nil t)
(make-text-button (match-beginning 1) (match-end 1)
'mouse-face 'highlight
'action (or action #'ess--button-action)
'help-object (buffer-substring-no-properties (match-beginning 1) (match-end 1))
'follow-link t
'help-echo (or help-echo "help on object")))))
(save-excursion ;; why R help adds all these spaces?
(goto-char (point-min))
(when (re-search-forward "Index:\n\n" nil t)
(let ((beg (point)))
(forward-paragraph 1)
(align-regexp beg (point) "\\(\\s-+\\)"))))
(setq buffer-read-only t)
(setq ess-help-type help-type)
(setq truncate-lines nil))
(unless (ess--help-kill-bogus-buffer-maybe buff)
(ess-display-help buff))))
(defun ess-display-help-apropos (&optional pattern)
"Create an ess-apropos buffer with a *linked* list of apropos topics."
(interactive "sPattern: ")
(let (com regexp)
(cond ((equal ess-dialect "R")
(setq com "help.search('%s')\n"
regexp "^\\([^ \t\n:]+::[^ \t\n:]+\\)[ \t\n]+"))
((equal ess-dialect "julia")
(setq com "apropos(\"%s\")\n"
regexp "^\\(\\(\\w\\|\\s_\\)+\\)("))
((equal ess-dialect "stata")
(setq com "hsearch %s\n"
regexp "^[\t ]*[0-9]+\\.[\t ]+\\(.+\\)$"))
(t (error "Not implemented for dialect %s" ess-dialect)))
(ess--display-indexed-help-page
(format com pattern) regexp
(format "*ess-apropos[%s](%s)*" ess-current-process-name pattern)
'appropos)))
(defun ess-display-demos ()
"Create an ess-demos buffer with a *linked* list of available demos."
(interactive)
(let (com regexp)
(cond ((equal ess-dialect "R")
(setq com "demo()\n"
regexp "^\\([^ \n:]+\\) +"))
(t (error "Not implemented for dialect %s" ess-dialect)))
(ess--display-indexed-help-page
com regexp
(format "*ess-demos[%s]*" ess-current-process-name)
'demos #'ess--action-demo)))
(defun ess--action-demo (&optional button)
"Provide help on object at the beginning of line.
It's intended to be used in R-index help pages. Load the package
if necessary. It is bound to RET and C-m in R-index pages."
(let* ((string (button-label button))
(command
(cond ((equal ess-dialect "R")
(format "demo('%s')\n" string))
(t (error "Not implemented for dialect %s" ess-dialect)))))
(ess-eval-linewise command)
(ess-switch-to-end-of-ESS)))
(defun ess-display-vignettes (&optional all)
"Display vignettes if available for the current dialect.
With (prefix) ALL non-nil, use `vignette(*, all=TRUE)`, i.e., from all installed
packages, which can be *very* slow."
(interactive "P")
(ess--display-vignettes-override all))
(cl-defgeneric ess--display-vignettes-override (_all)
"Display vignettes for the current dialect.
See `ess-display-vignettes' for ALL."
(user-error "Sorry, not implemented for %s" ess-dialect))
(defun ess--action-open-in-emacs (pos)
(display-buffer (find-file-noselect (get-text-property pos 'help-echo))))
(defun ess--action-R-open-vignette (pos)
(ess-eval-linewise (format "vignette('%s', package='%s')\n"
(get-text-property pos 'vignette)
(get-text-property pos 'package))))
(defalias 'ess-help-quit 'quit-window)
(make-obsolete 'ess-help-quit 'quit-window "16.04")
(defun ess-display-help (buff)
"Display buffer BUFF.
If `ess-help-pop-to-buffer' is non-nil, call `pop-to-buffer',
otherwise call `display-buffer' to display the buffer.
You may control how help buffers are displayed by EITHER setting
an entry in `display-buffer-alist' (see examples in info
node `(ess) Controlling buffer display') OR setting the
ESS-specific variables `ess-help-own-frame',
`ess-help-reuse-window', `ess-help-frame-alist', and
`ess-display-buffer-reuse-frames'."
(let* ((action (cond (ess-help-own-frame
'(display-buffer-reuse-window
display-buffer-use-some-frame
display-buffer-pop-up-frame))
(ess-help-reuse-window
'(display-buffer-reuse-window
ess-display-buffer-reuse-mode-window
display-buffer-pop-up-window
display-buffer-use-some-window))
(t '(display-buffer-pop-up-window
display-buffer-use-some-window))))
(alist `((mode . (ess-help-mode ess-r-help-mode ess-stata-help-mode ess-julia-help-mode))
(reusable-frames . ,ess-display-buffer-reuse-frames)
;; `display-buffer-use-some-frame' uses this to
;; determine whether to use the frame or not.
(frame-predicate . (lambda (f)
(when (equal ess-help-own-frame 'one)
;; Note we're always returning
;; nil for `ess-help-own-frame' t.
(frame-parameter f 'ess-help-frame))))
;; If `display-buffer' makes a new frame, these are
;; given as frame parameters.
(pop-up-frame-parameters . ,(append ess-help-frame-alist
`((auto-hide-function . delete-frame)
(ess-help-frame . ,(equal ess-help-own-frame 'one)))))))
(display-alist `(,action . ,alist)))
(if ess-help-pop-to-buffer
(pop-to-buffer buff display-alist)
(display-buffer buff display-alist))))
(defun ess-help-web-search (cmd)
"Search the web for documentation on CMD."
(interactive "sSearch for: ")
(ess--help-web-search-override cmd))
(cl-defgeneric ess--help-web-search-override (_cmd)
"Dialect-specific override for `ess-help-web-search', which see for CMD."
(error "Not implemented for %s" ess-dialect))
(defun ess-manual-lookup ()
"Search manual for documentation."
(interactive)
(ess--manual-lookup-override))
(cl-defgeneric ess--manual-lookup-override ()
"Dialect-specific override for `ess-manual-lookup'."
(error "Not implemented for %s" ess-dialect))
(defvar ess-doc-map
(let (ess-doc-map)
(define-prefix-command 'ess-doc-map)
(define-key ess-doc-map "\C-e" #'ess-describe-object-at-point)
(define-key ess-doc-map "e" #'ess-describe-object-at-point)
(define-key ess-doc-map "\C-d" #'ess-display-help-on-object)
(define-key ess-doc-map "d" #'ess-display-help-on-object)
(define-key ess-doc-map "\C-i" #'ess-display-package-index)
(define-key ess-doc-map "i" #'ess-display-package-index)
(define-key ess-doc-map "\C-a" #'ess-display-help-apropos)
(define-key ess-doc-map "a" #'ess-display-help-apropos)
(define-key ess-doc-map "\C-v" #'ess-display-vignettes)
(define-key ess-doc-map "v" #'ess-display-vignettes)
(define-key ess-doc-map "\C-o" #'ess-display-demos)
(define-key ess-doc-map "o" #'ess-display-demos)
(define-key ess-doc-map "\C-w" #'ess-help-web-search)
(define-key ess-doc-map "w" #'ess-help-web-search)
(define-key ess-doc-map "\C-m" #'ess-manual-lookup)
(define-key ess-doc-map "m" #'ess-manual-lookup)
ess-doc-map)
"ESS documentation map.")
(defvar ess-help-mode-map
(let ((map (make-keymap)))
(define-key map "\C-m" #'next-line)
(define-key map "h" #'ess-display-help-on-object)
(define-key map "w" #'ess-display-help-in-browser)
(define-key map "i" #'ess-display-package-index)
(define-key map "a" #'ess-display-help-apropos)
(define-key map "v" #'ess-display-vignettes)
(define-key map "l" #'ess-eval-line-visibly-and-step)
(define-key map "r" #'ess-eval-region-and-go)
(define-key map "f" #'ess-eval-function-or-paragraph-and-step)
(define-key map "n" #'ess-skip-to-next-section)
(define-key map "p" #'ess-skip-to-previous-section)
(define-key map "/" #'isearch-forward)
(define-key map "x" #'ess-kill-buffer-and-go)
(define-key map "k" #'kill-this-buffer)
(define-key map "\C-c\C-s" #'ess-switch-process)
(define-key map "\C-c\C-r" #'ess-eval-region)
(define-key map "\C-c\M-r" #'ess-eval-region-and-go)
(define-key map "\C-c\C-f" #'ess-eval-function)
(define-key map "\M-\C-x" #'ess-eval-function)
(define-key map "\C-c\M-f" #'ess-eval-function-and-go)
(define-key map "\C-c\C-j" #'ess-eval-line)
(define-key map "\C-c\C-n" #'ess-eval-line-visibly-and-step)
(define-key map "\C-c\C-c" #'ess-eval-region-or-function-or-paragraph-and-step)
(define-key map [(control return)] #'ess-eval-region-or-line-visibly-and-step)
(define-key map "\C-c\M-j" #'ess-eval-line-and-go)
(define-key map "\M-\C-a" #'ess-goto-beginning-of-function-or-para)
(define-key map "\M-\C-e" #'ess-goto-end-of-function-or-para)
(define-key map "\C-c\C-y" #'ess-switch-to-ESS)
(define-key map "\C-c\C-z" #'ess-switch-to-end-of-ESS)
(define-key map "\C-c\C-l" #'ess-load-file)
(define-key map "\C-c\M-l" #'ess-load-file); alias, as in #'iESS#' where C-c C-l is comint-list-*
(define-key map "\C-c\C-v" #'ess-display-help-on-object)
(define-key map "\C-c\C-k" #'ess-request-a-process)
(define-key map "\C-c\C-d" 'ess-doc-map)
(define-key map "\C-c\C-e" 'ess-extra-map)
(define-key map "\C-c\C-t" 'ess-dev-map)
map)
"Keymap for ESS help mode.")
;; One reason for the following menu is to <TEACH> the user about key strokes
(defvar ess-help-mode-menu
'("ESS-help"
["Search forward" isearch-forward t]
["Next section" ess-skip-to-next-section t]
["Previous section" ess-skip-to-previous-section t]
["Help on section skipping" ess-describe-sec-map t]
["Beginning of buffer" beginning-of-buffer t]
["End of buffer" end-of-buffer t]
"-"
["Help on ..." ess-display-help-on-object t]
["Apropos of ..." ess-display-help-apropos t]
["Index of ..." ess-display-package-index t]
["Vignettes" ess-display-vignettes t]
["Open in browser" ess-display-help-in-browser t]
"-"
["Eval line" ess-eval-line-and-step t]
["Eval paragraph & step" ess-eval-paragraph-and-step t]
["Eval region & go" ess-eval-region-and-go t]
["Switch to ESS process" ess-switch-to-ESS t]
["Switch to end of ESS proc." ess-switch-to-end-of-ESS t]
["Switch _the_ process" ess-switch-process t]
"-"
["Kill buffer" kill-this-buffer t]
["Kill buffer & go" ess-kill-buffer-and-go t]
"-"
["Handy commands" ess-handy-commands t])
"Menu used in ess-help mode.")
(easy-menu-define ess-help-mode-menu-map ess-help-mode-map
"Menu keymap for ess-help mode." ess-help-mode-menu)
(define-derived-mode ess-help-mode special-mode "ESS Help"
"Mode for viewing ESS help files."
:group 'ess-help
;; FIXME
;; (if ess-mode-syntax-table ;;set in advance by ess-setq-local
;; (set-syntax-table ess-mode-syntax-table))
(setq-local revert-buffer-function #'ess-help-revert-buffer)
(setq show-trailing-whitespace nil))
;;*;; User commands defined in ESS help mode
(defun ess-skip-to-help-section ()
"Jump to a section heading of a help buffer.
The section selected is determined by the command letter used to
invoke the command, as indicated by `ess-help-sec-keys-alist'.
Use \\[ess-describe-sec-map] to see which keystrokes find which
sections."
(interactive)
(let ((old-point (point))
(case-fold-search nil)
(the-sec (cdr (assoc last-command-event ess-help-sec-keys-alist))))
(cl-assert the-sec nil (format "Invalid section key: %c" last-command-event))
(goto-char (point-min))
(if (re-search-forward (concat "^" the-sec) nil t)
(progn (recenter)
(beginning-of-line))
(message "No %s section in this help. Sorry." the-sec)
(goto-char old-point))))
(defun ess-skip-to-next-section ()
"Jump to next section in ESS help buffer."
(interactive)
(let ((case-fold-search nil))
(when (looking-at-p ess-help-sec-regex)
(forward-line))
(if (re-search-forward ess-help-sec-regex nil 'no-error)
(beginning-of-line)
(message "No more sections."))))
(defun ess-skip-to-previous-section ()
"Jump to previous section in ESS help buffer."
(interactive)
(let ((case-fold-search nil))
(if (re-search-backward ess-help-sec-regex nil 'no-error)
(beginning-of-line)
(message "No previous section."))))
(defun ess-kill-buffer-and-go nil
"Kill the current buffer and switch back to the ESS process."
(interactive)
(kill-buffer (current-buffer))
(when (and ess-current-process-name (get-process ess-current-process-name))
(ess-switch-to-ESS nil)))
(defun ess-describe-sec-map nil
"Display help for the `s' key."
(interactive)
(let ((keys-alist ess-help-sec-keys-alist))
(describe-function 'ess-skip-to-help-section)
(with-current-buffer "*Help*"
(setq buffer-read-only nil)
(goto-char (point-max))
(insert "\n\nCurrently defined keys are:
Keystroke Section
--------- -------\n")
(dolist (cs keys-alist)
(insert " "
(car cs)
" "
(cdr cs) "\n")))))
(defun ess-helpobjs-at-point--read-obj ()
(let* ((obj (ess-read-object-name-default)))
;; Exclude numbers
(unless (and obj (not (string-match "[[:alpha:]]" obj)))
obj)))
(defun ess-unqualify-symbol (object)
(if (string-match "^[[:alnum:].]+::?" object)
(substring object (match-end 0))
object))
(defun ess-helpobjs-at-point (slist)
"Return a list (def obj fun).
Obj is a name at point, fun is the name of the function call
point is in, and def is either obj or fun (in that order) which
has a a help file, i.e. it is a member of SLIST (string-list).
nil otherwise."
(let* ((obj (ess-helpobjs-at-point--read-obj))
(unqualified-obj (and obj (ess-unqualify-symbol obj)))
;; FIXME: probably should use syntactic logic here
(fun (ignore-errors
(save-excursion
(save-restriction
(narrow-to-region (max (point-min) (- (point) 1000))
(point-max))
(backward-up-list 1)
(backward-char 1)
(ess-read-object-name-default))))))
(list (or (car (member obj slist))
(when (member unqualified-obj slist)
obj)
(car (member fun slist)))
obj fun)))
(cl-defgeneric ess-help-get-topics (proc)
"Return a list of help topics from PROC."
(user-error "Not supported for %s (process: %s)" ess-dialect proc))
(defun ess-find-help-file (p-string)
"Find help, prompting for P-STRING."
(ess-make-buffer-current)
(let* ((help-files-list (ess-help-get-topics ess-current-process-name))
(hlpobjs (delq nil (ess-helpobjs-at-point help-files-list))))
(ess-completing-read p-string (append hlpobjs help-files-list)
nil nil nil nil (car hlpobjs))))
;;*;; Utility functions
(defun ess-get-help-files-list ()
"Return a list of files which have help available."
(apply 'nconc
(mapcar (lambda (str)
(let ((dirname (concat str "/.Help")))
(and (file-directory-p dirname)
(directory-files dirname))))
(ess-search-list))))
(defun ess-get-help-aliases-list ()
"Return a list of aliases which have help available."
(message "Retrieving RDS aliases...")
;; ess-command locks display, make sure the above message is visible
(redisplay t)
(ess-write-to-dribble-buffer "Processing RDS files ...\n")
;; FIXME: This should be run asynchronously
(prog1 (ess-get-words-from-vector ".ess.getHelpAliases()\n"
nil nil nil ess-help--aliases-timeout)
(message "Retrieving RDS aliases...done")))
(defun ess-nuke-help-bs ()
"Remove ASCII underlining and overstriking performed by ^H codes."
;; This function is a modification of nuke-nroff-bs in man.el from the
;; standard Emacs 18 lisp library.
;; Nuke underlining and overstriking (only by the same letter)
(goto-char (point-min))
(while (search-forward "\b" nil t)
(let* ((preceding (char-after (- (point) 2)))
(following (following-char)))
(cond ((= preceding following)
;; x\bx
(delete-char -2))
((= preceding ?\_)
;; _\b
(delete-char -2))
((= following ?\_)
;; \b_
(delete-region (1- (point)) (1+ (point)))))))
(goto-char (point-min))
(let ((case-fold-search nil)); 'URL' != 'url' ('libcurl: ' on ?capabilities)
(while (re-search-forward "\\bURL: " nil t); test with ?rtags
;; quick fix for C-x f confusion (getting into tramp)
(delete-region (match-beginning 0) (match-end 0))))
;; Crunch blank lines
(goto-char (point-min))
(while (re-search-forward "\n\n\n\n*" nil t)
(replace-match "\n\n"))
;; Nuke blanks lines at start.
(goto-char (point-min))
(skip-chars-forward "\n")
(delete-region (point-min) (point)))
(defun ess-help-underline ()
"Replace _^H codes with underline face."
(save-excursion
(goto-char (point-min))
(while (search-forward "_" nil t)
(backward-delete-char 2)
(put-text-property (point) (1+ (point)) 'face 'underline))))
;;*;; Link to Info
(defun ess-goto-info (node)
"Display node NODE from `ess-mode' info."
(require 'info)
(split-window)
(Info-goto-node (concat "(ess)" node)))
;; describe object at point
(defvar-local ess-describe-object-at-point-commands nil
"Commands cycled by `ess-describe-object-at-point'.
Dialect specific.")
(defvar ess--descr-o-a-p-commands nil)
(defun ess-describe-object-at-point ()
"Get info for object at point, & display it in an electric buffer or tooltip.
If region is active use it instead of the object at point.
This is an electric command (`ess--execute-electric-command'),
which means that you can use the last key to cycle through the
action set (in this case `C-e'). After invocation of this command
all standard Emacs commands, except those containing `window' in
their names, remove the electric *ess-describe* buffer. Use
`other-window' to switch to *ess-describe* window.
Customize `ess-describe-at-point-method' if you want to display
the description in a tooltip. See also
`ess-r-describe-object-at-point-commands' (and similar option for
other dialects)."
(interactive)
(if (not ess-describe-object-at-point-commands)
(message "Not implemented for dialect %s" ess-dialect)
(ess-force-buffer-current)
(let ((map (make-sparse-keymap))
(objname (or (and (use-region-p)
(buffer-substring-no-properties (point) (mark)))
(ess-symbol-at-point)))
ess--descr-o-a-p-commands) ;; used in ess--describe-object-at-point
(unless objname (error "No object at point "))
(define-key map (vector last-command-event) 'ess--describe-object-at-point)
;; todo: put digits into the map
(let* ((inhibit-quit t) ;; C-g removes the buffer
(buf (ess--execute-electric-command
map (format "Press %s to cycle"
(single-key-description last-command-event))
nil nil objname))
;; read full command
(keys (read-key-sequence-vector ""))
(command (and keys (key-binding keys))))
(when (and (commandp command)
(bufferp buf)
(or (not (symbolp command)) ;; kill on lambdas
(not (string-match "window" (symbol-name command)))))
(kill-buffer buf)) ;; bury does not work here :( (Emacs bug?)
(setq unread-command-events
(append keys unread-command-events))))))
(defun ess--describe-object-at-point (_ev objname)
(setq ess--descr-o-a-p-commands (or ess--descr-o-a-p-commands
(symbol-value ess-describe-object-at-point-commands)))
(let* ((com (format (car (pop ess--descr-o-a-p-commands)) objname))
(buf (get-buffer-create "*ess-describe*"))
pos)
(unless (eq ess-describe-at-point-method 'tooltip)
;; can take some time for the command to execute
(display-buffer buf))
(sit-for .01)
(ess-command (concat com "\n") buf) ;; erases buf
(with-current-buffer buf
(goto-char (point-min))
(insert (propertize (format "%s:\n\n" com) 'face 'font-lock-string-face))
(forward-line -1)
(setq pos (point))
;; set the keys that we are used to in help mode
(special-mode)
(let ((inhibit-read-only t))
(ansi-color-apply-on-region (point-min) (point-max))))
(if (eq ess-describe-at-point-method 'tooltip)
(ess-tooltip-show-at-point
(with-current-buffer buf (buffer-string)) 0 30)
(display-buffer buf)
(set-window-point (get-buffer-window buf) pos) ;; don't move window point
buf)))
(with-no-warnings
;; We're just backporting here, don't care about compiler warnings
(defalias 'ess-display-buffer-reuse-mode-window
;; TODO: Remove once we drop support for Emacs 25
(if (fboundp 'display-buffer-reuse-mode-window)
'display-buffer-reuse-mode-window
(lambda (buffer alist)
(let* ((alist-entry (assq 'reusable-frames alist))
(alist-mode-entry (assq 'mode alist))
(frames (cond (alist-entry (cdr alist-entry))
((if (eq pop-up-frames 'graphic-only)
(display-graphic-p)
pop-up-frames)
0)
(display-buffer-reuse-frames 0)
(t (last-nonminibuffer-frame))))
(inhibit-same-window-p (cdr (assq 'inhibit-same-window alist)))
(windows (window-list-1 nil 'nomini frames))
(buffer-mode (with-current-buffer buffer major-mode))
(allowed-modes (if alist-mode-entry
(cdr alist-mode-entry)
buffer-mode))
(curwin (selected-window))
(curframe (selected-frame)))
(unless (listp allowed-modes)
(setq allowed-modes (list allowed-modes)))
(let (same-mode-same-frame
same-mode-other-frame
derived-mode-same-frame
derived-mode-other-frame)
(dolist (window windows)
(let ((mode?
(with-current-buffer (window-buffer window)
(cond ((memq major-mode allowed-modes)
'same)
((derived-mode-p allowed-modes)
'derived)))))
(when (and mode?
(not (and inhibit-same-window-p
(eq window curwin))))
(push window (if (eq curframe (window-frame window))
(if (eq mode? 'same)
same-mode-same-frame
derived-mode-same-frame)
(if (eq mode? 'same)
same-mode-other-frame
derived-mode-other-frame))))))
(let ((window (car (nconc same-mode-same-frame
same-mode-other-frame
derived-mode-same-frame
derived-mode-other-frame))))
(when (window-live-p window)
(prog1 (window--display-buffer buffer window 'reuse alist)
(unless (cdr (assq 'inhibit-switch-frame alist))
(window--maybe-raise-frame (window-frame window))))))))))))
(provide 'ess-help)
;;; ess-help.el ends here
|
