forked from emacs-ess/ESS
-
Notifications
You must be signed in to change notification settings - Fork 0
/
ess-mode.el
1147 lines (1006 loc) · 45.8 KB
/
ess-mode.el
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
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
;;; ess-mode.el --- Support for editing ESS source code
;; Copyright (C) 1989-1994 Doug Bates, Ed Kademan, Frank Ritter, David 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 <[email protected]>
;; Created: 7 Jan 1994
;; Maintainer: ESS-core <[email protected]>
;; Package-Requires: ((julia-mode "0.3"))
;; 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
;; http://www.r-project.org/Licenses/
;;; Commentary:
;; Code for editing ESS source code.
;;; Code:
(require 'cl)
(autoload 'ess-turn-on-eldoc "ess-r-d" "" nil)
;; (autoload 'ess-ddeclient-p "ess-inf" "(autoload)" nil)
(autoload 'ess-dump-object-ddeclient "ess-dde" "(autoload)" nil)
(autoload 'SAS "ess-sas-d.el" "(autoload)" t)
(require 'ess-utils)
(defun ess-line-end-position (&optional N)
"return the 'point' at the end of N lines. N defaults to 1, i.e., current line."
(save-excursion
(end-of-line N)
(point)))
;;; ESS mode
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;;; In this section:
;;;;
;;;; * The major mode ess-mode
;;;; * Commands for ess-mode
;;;; * Code evaluation commands
;;;; * Indenting code and commands
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;*;; Major mode definition
(defvar ess-mode-map
(let ((map (make-sparse-keymap)))
;; By popular demand:
(define-key map "\C-m" 'newline-and-indent); = [RETURN]
(define-key map [remap yank] 'ess-yank)
(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-b" 'ess-eval-buffer)
(define-key map "\C-c\M-b" 'ess-eval-buffer-and-go)
(define-key map (kbd "C-c C-<up>") 'ess-eval-buffer-from-beg-to-here)
(define-key map (kbd "C-c C-<down>") 'ess-eval-buffer-from-here-to-end)
(define-key map "\C-c\C-f" 'ess-eval-function)
(define-key map "\C-c\M-f" 'ess-eval-function-and-go)
(define-key map "\C-c\C-c" 'ess-eval-region-or-function-or-paragraph-and-step)
(define-key map "\C-c\C-p" 'ess-eval-paragraph-and-step)
(define-key map "\C-c\M-p" 'ess-eval-paragraph-and-go)
(define-key map "\C-\M-x" 'ess-eval-region-or-function-or-paragraph)
(define-key map "\C-c\C-n" 'ess-eval-line-and-step)
(define-key map "\C-c\C-j" 'ess-eval-line)
(define-key map [(control return)] 'ess-eval-region-or-line-and-step)
(define-key map "\C-c\M-j" 'ess-eval-line-and-go)
;; the next three can only work in S/R - mode {FIXME}
(define-key map "\C-\M-a" 'ess-goto-beginning-of-function-or-para)
(define-key map "\C-\M-e" 'ess-goto-end-of-function-or-para)
(define-key map "\C-xnd" 'ess-narrow-to-defun-or-para)
(define-key map "\C-xnf" 'ess-narrow-to-defun-or-para)
(define-key map "\C-c\C-y" 'ess-switch-to-ESS-deprecated)
(define-key map "\C-c\C-z" 'ess-switch-to-inferior-or-script-buffer)
(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-c5\C-d"'ess-dump-object-into-edit-buffer-other-frame)
(define-key map "\C-c\C-s" 'ess-switch-process) ; use a
;; different process for the buffer.
;; (define-key map "\C-c\C-t" 'ess-execute-in-tb)
(define-key map "\C-c\t" 'ess-complete-object-name-deprecated)
;;M (define-key map "\C-c\t" 'comint-dynamic-complete-filename)
(unless (and (featurep 'emacs) (>= emacs-major-version 24))
(define-key map "\M-\t" 'comint-dynamic-complete))
(define-key map "\M-?" 'ess-list-object-completions)
;; wrong here (define-key map "\C-c\C-k" 'ess-request-a-process)
(define-key map "\C-c\C-k" 'ess-force-buffer-current)
(define-key map "\C-c`" 'ess-show-traceback)
(define-key map [(control ?c) ?~] 'ess-show-call-stack)
(define-key map "\C-c." (lambda () (interactive) (message "ess-set-style moved to C-c C-e C-s. Sorry for the inconvenience")))
(define-key map "{" 'ess-electric-brace)
(define-key map "}" 'ess-electric-brace)
(define-key map "\C-\M-q" 'ess-indent-exp)
(define-key map "\C-\M-h" 'ess-mark-function-or-para)
(if (featurep 'xemacs) ;; work around Xemacs bug (\C-\M-h redefines M-BS):
(define-key map [(meta backspace)] 'backward-kill-word))
;;(define-key map [delete] 'backward-delete-char-untabify)
(define-key map "\t" 'ess-indent-or-complete)
(define-key map "\C-c\C-q" 'ess-quit)
(define-key map "\M-\r" 'ess-use-this-dir)
;; smart operators; most likely will go in the future into a separate local map
(define-key map "," 'ess-smart-comma)
(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-mode'.")
;; Redefine substituted commands
(substitute-key-definition 'newline-and-indent
'ess-newline-and-indent
ess-mode-map global-map)
(substitute-key-definition 'indent-new-comment-line
'ess-indent-new-comment-line
ess-mode-map global-map)
(defvar ess-eval-map
(let ((map (make-sparse-keymap)))
;; (define-key map "\C-r" 'ess-eval-region)
;; (define-key map "\M-r" 'ess-eval-region-and-go)
;; (define-key map "\C-b" 'ess-eval-buffer)
;; (define-key map "\M-b" 'ess-eval-buffer-and-go)
;; (define-key map "\C-f" 'ess-eval-function)
;; (define-key map "\M-f" 'ess-eval-function-and-go)
;; (define-key map "\C-x" 'ess-eval-function)
;; (define-key map "\C-n" 'ess-eval-line-and-step)
;; (define-key map "\C-j" 'ess-eval-line)
;; (define-key map "\M-j" 'ess-eval-line-and-go)
map)
"Keymap for ess-eval functions.")
(make-obsolete-variable 'ess-eval-map nil "ESS[12.09.1]")
(defvar ess-extra-map
(let (ess-extra-map)
(define-prefix-command 'ess-extra-map)
(define-key ess-extra-map "\C-d" 'ess-dump-object-into-edit-buffer)
(define-key ess-extra-map "d" 'ess-dump-object-into-edit-buffer)
(define-key ess-extra-map "\C-e" 'ess-execute)
(define-key ess-extra-map "e" 'ess-execute)
(define-key ess-extra-map "\C-i" 'ess-install-library)
(define-key ess-extra-map "i" 'ess-install-library)
(define-key ess-extra-map "\C-l" 'ess-load-library)
(define-key ess-extra-map "l" 'ess-load-library)
(define-key ess-extra-map "\C-s" 'ess-set-style)
(define-key ess-extra-map "s" 'ess-set-style)
(define-key ess-extra-map "\C-t" 'ess-build-tags-for-directory)
(define-key ess-extra-map "t" 'ess-build-tags-for-directory)
(define-key ess-extra-map "\C-w" 'ess-execute-screen-options)
(define-key ess-extra-map "w" 'ess-execute-screen-options)
(define-key ess-extra-map "/" 'ess-set-working-directory)
ess-extra-map)
"ESS extra map")
(require 'ess-noweb-mode)
(easy-menu-define
ess-mode-menu ess-mode-map
"Menu for use in `ess-mode'."
'("ESS" ; ESS-mode
["What is this? (beta)" ess-mouse-me t]
["Load file" ess-load-file t]
["Eval region | func | para" ess-eval-region-or-function-or-paragraph t]
["Eval region | func | para & step" ess-eval-region-or-function-or-paragraph-and-step t]
["Eval region | line" ess-eval-region-or-line-and-step t]
["Enter expression" ess-execute t]
;; sub menus
"------"
("Process"
["Goto end of process buffer" ess-switch-to-end-of-ESS t]
["Switch to process buffer" ess-switch-to-inferior-or-script-buffer t]
["Switch Process" ess-switch-process t]
["Recreate R and S versions known to ESS" (ess-r-s-versions-creation+menu) t]
("Start Process"
;; SJE - :help not yet recognised in XEmacs.
["R" R t] ;; :help "Start a new R process" :active t
["S" S t] ;; :help "Start a new S process" :active t
["Sqpe" Sqpe ess-microsoft-p] ;; :help "Start a new Sqpe process" :active t
["S+6-exisiting" S+6-existing ess-microsoft-p] ;; :help "Access an existing S process" :active t
["SAS" SAS-menu t] ;; :help "Start a new SAS process" :active t
;; The following menu item "Other" is a place-holder that will
;; be replaced with the other versions of R and Sqpe that can be run.
;; See `ess-r-versions-create' and ess-site.el
("Other"
["No other R or Sqpe versions" nil nil])
["About"
(ess-goto-info "Starting up") t]
;; :help "Read about starting a new ESS process" :active t]
)
("Eval visibly "
:filter ess--generate-eval-visibly-submenu))
"------"
("ESS Eval"
["Eval region | func | para" ess-eval-region-or-function-or-paragraph t]
["Eval region | func | para & step" ess-eval-region-or-function-or-paragraph-and-step t]
["Eval region | line" ess-eval-region-or-line-and-step t]
"-----"
["Eval buffer" ess-eval-buffer t]
["Eval buffer till here" ess-eval-buffer-from-beg-to-here t]
["Eval buffer from here" ess-eval-buffer-from-here-to-end t]
["Eval region" ess-eval-region t]
["Eval function" ess-eval-function t]
["Eval line" ess-eval-line t]
["Eval line & step" ess-eval-line-and-step t]
["Eval paragraph" ess-eval-paragraph t]
["Eval paragraph & step" ess-eval-paragraph-and-step t]
["Eval chunk" ess-eval-chunk ess-noweb-mode]
["Eval chunk and step" ess-eval-chunk-and-step ess-noweb-mode]
["Eval thread" ess-eval-thread ess-noweb-mode]
["About" (ess-goto-info "Evaluating code") t]
)
("Eval and Go"
["Eval buffer" ess-eval-buffer-and-go t]
["Eval region" ess-eval-region-and-go t]
["Eval function" ess-eval-function-and-go t]
["Eval line" ess-eval-line-and-go t]
["Eval paragraph" ess-eval-paragraph-and-go t]
["Eval chunk" ess-eval-chunk-and-go ess-noweb-mode]
["Eval thread" ess-eval-thread-and-go ess-noweb-mode]
["About" (ess-goto-info "Evaluating code") t]
)
("Motion"
["Beginning of function or para" ess-goto-beginning-of-function-or-para t]
["End of function or para" ess-goto-end-of-function-or-para t]
"-----"
["Backward list" backward-list t]
["Forward list" forward-list t]
["Next parenthesis" down-list t]
["Enclosing parenthesis" backward-up-list t]
["Backward sexp" backward-sexp t]
["Forward sexp" forward-sexp t]
["About" (Info-goto-node "(Emacs)Lists") t]
)
("ESS Edit"
["Edit new object" ess-dump-object-into-edit-buffer t]
["Complete Filename" comint-replace-by-expanded-filename t]
["Complete File or Object" ess-indent-or-complete t]
["Kill sexp" kill-sexp t]
["Mark function" ess-mark-function-or-para t]
["Indent expression" ess-indent-exp t]
["Indent line" ess-indent-command t]
["Toggle Auto-Fill Mode" auto-fill-mode t]
["Undo" undo t]
["About" (ess-goto-info "Edit buffer") t]
)
"------"
("start-dev" :visible nil)
("end-dev" :visible nil)
"------"
("Font Lock"
:active ess-font-lock-keywords
:filter ess--generate-font-lock-submenu)
"------"
["Describe" describe-mode t]
["About editing" (ess-goto-info "Editing") t]
["Read ESS info" (ess-goto-info "") t]
["Send bug report" ess-submit-bug-report t]
))
;; (defun test-gen-menu (men)
;; '(
;; ["About editing" (ess-goto-info "Editing") t]
;; ["Read ESS info" (ess-goto-info "") t]
;; ["Send bug report" ess-submit-bug-report t]))
(defun SAS-menu ()
"Start SAS from the menu."
(interactive)
(if ess-microsoft-p
;; replace with other choices for starting SAS under XEmacs?
(error "SAS cannot be started this way in ESS on Windows.")
(SAS)))
(defun ess-mode-xemacs-menu ()
"Hook to install `ess-mode' menu for XEmacs (w/ easymenu)."
(if 'ess-mode
(easy-menu-add ess-mode-menu)
(easy-menu-remove ess-mode-menu)))
(if (featurep 'xemacs)
(add-hook 'ess-mode-hook 'ess-mode-xemacs-menu))
(defun ess-mode (&optional alist proc-name is-derived)
"Major mode for editing ESS source.
Optional arg ALIST describes how to customize the editing mode.
Optional arg PROC-NAME is name of associated inferior process.
\\{ess-mode-map}
Extra binding to note: 'ESC C-\\' indent-region.
Entry to this mode runs the hooks in ess-mode-hook.
You can send text to the inferior ESS process from other buffers containing
ESS source.
`ess-eval-region' sends the current region to the ESS process.
`ess-eval-buffer' sends the current buffer to the ESS process.
`ess-eval-function' sends the current function to the ESS process.
`ess-eval-line' sends the current line to the ESS process.
`ess-beginning-of-function' and `ess-end-of-function' move the point to
the beginning and end of the current ESS function.
`ess-switch-to-ESS' switches the current buffer to the ESS process buffer.
`ess-switch-to-end-of-ESS' switches the current buffer to the ESS process
buffer and puts point at the end of it.
`ess-eval-region-and-go', `ess-eval-buffer-and-go',
`ess-eval-function-and-go', and `ess-eval-line-and-go' switch to the S
process buffer after sending their text.
`ess-load-file' sources a file of commands to the ESS process.
\\[ess-indent-command] indents for ESS code.
\\[backward-delete-char-untabify] converts tabs to spaces as it moves back.
Comments are indented in a similar way to Emacs-lisp mode:
`###' beginning of line
`##' the same level of indentation as the code
`#' the same column on the right, or to the right of such a
column if that is not possible.(default value 40).
\\[indent-for-comment] command automatically inserts such a
`#' in the right place, or aligns such a comment if it is
already inserted.
\\[ess-indent-exp] command indents each line of the syntactic unit following point.
Variables controlling indentation style:
`ess-tab-always-indent'
Non-nil means TAB in ESS mode should always reindent the current line,
regardless of where in the line point is when the TAB command is used.
`ess-auto-newline'
Non-nil means automatically newline before and after braces inserted in S
code.
`ess-indent-offset'
Indentation of ESS statements within surrounding block.
The surrounding block's indentation is the indentation of the line on
which the open-brace appears.
`ess-offset-block'
Indentation of blocks opened with curly braces or anonymous parentheses.
`ess-offset-arguments'
Indentation of function arguments or bracket indices.
`ess-offset-arguments-newline'
Indentation of function arguments or bracket indices when the opening
delimiter is immediately followed by a newline.
`ess-offset-continued'
Indentation style for continued statements.
`ess-align-nested-calls'
Functions whose nested calls should be aligned.
`ess-align-arguments-in-calls'
Calls in which arguments should be aligned.
`ess-align-continuations-in-calls'
Whether ignore indentation after an operator in calls
`ess-align-blocks'
Blocks that should always be aligned vertically.
`ess-indent-from-lhs'
Whether function calls given as argument should be indented from the
parameter name.
`ess-indent-from-chain-start'
Whether to indent arguments from the first of several consecutive calls.
`ess-indent-with-fancy-comments'
Non-nil means distinguish between #, ##, and ### for indentation.
Furthermore, \\[ess-set-style] command enables you to set up predefined ess-mode
indentation style. At present, predefined style are `BSD', `GNU', `K&R', `C++',
`CLB' (quoted from C language style)."
(setq alist (or alist
(buffer-local-value 'ess-local-customize-alist (current-buffer))
(error "Customise alist is not specified, nor ess-local-customize-alist is set.")))
(unless is-derived
(kill-all-local-variables)) ;; NOTICE THIS! *** NOTICE THIS! *** NOTICE THIS! ***
(ess-setq-vars-local alist)
;; must happen here, since the mode map is set up too early:
(if ess-r-args-electric-paren (define-key ess-mode-map "(" 'ess-r-args-auto-show))
(ess-write-to-dribble-buffer
(format "(ess-mode-1): ess-language=%s, ess-dialect=%s buf=%s \n"
ess-language
ess-dialect
(current-buffer)))
;; (ess-write-to-dribble-buffer
;; (format "(ess-mode-1.2): ess-process=%s \n"
;; (ess-local-process-name ess-local-process-name "none")))
(ess-write-to-dribble-buffer
(format "(ess-mode-1.5): alist=%s \n" alist))
(unless is-derived
(setq major-mode 'ess-mode)
(setq mode-name (concat "ESS[" ess-language "]"))) ; was ess-dialect
;; The following line does the next 20 or so :-).
(ess-write-to-dribble-buffer
(format "(ess-mode-1.6): editing-alist=%s \n"
ess-mode-editing-alist))
(ess-setq-vars-local ess-mode-editing-alist)
(ess-set-style ess-style t)
(use-local-map ess-mode-map)
(when ess-mode-syntax-table
(set-syntax-table ess-mode-syntax-table))
;; Keep <tabs> out of the code.
(make-local-variable 'indent-tabs-mode)
(setq indent-tabs-mode nil)
(put 'ess-local-process-name 'permanent-local t) ; protect from RCS
(setq mode-line-process
'(" ["
(:eval (ess--get-mode-line-indicator))
ess--local-mode-line-process-indicator
"]"))
;; completion
(if (and (featurep 'emacs)
(>= emacs-major-version 24))
(add-hook 'completion-at-point-functions 'ess-filename-completion nil 'local)
(add-hook 'comint-dynamic-complete-functions 'ess-complete-filename nil 'local)
(delq t comint-dynamic-complete-functions)
)
(set (make-local-variable 'comint-completion-addsuffix)
(cons "/" ""))
;; timer
(add-hook 'ess-idle-timer-functions 'ess-synchronize-dirs nil 'local)
;;; extras
(ess-load-extras)
;; SJE Tue 28 Dec 2004: do not attempt to load object name db.
;; (ess-load-object-name-db-file)
(if (> emacs-major-version 21)
(run-mode-hooks 'ess-mode-hook)
;; old emacs 21.x
(run-hooks 'ess-mode-hook))
(ess-write-to-dribble-buffer "\nFinished setting up ESS-mode.\n"))
(defun ess--get-mode-line-indicator ()
"Get `ess--mode-line-process-indicator' from process buffer.
Internal function to be used for dynamic mode-line dysplay in
ess-mode."
(if ess-local-process-name
(let* ((proc (get-process ess-local-process-name))
(buff (when proc (process-buffer proc))))
(if (and proc (buffer-live-p buff))
(with-current-buffer buff (mapcar 'eval ess--mode-line-process-indicator))
"none"))
"none"))
;;*;; User commands in ess-mode
;;;*;;; Handy commands
(defun ess-execute-in-tb ()
"Like `ess-execute', but always evaluates in temp buffer."
(interactive)
(let ((ess-execute-in-process-buffer nil))
(call-interactively 'ess-execute)))
(defun ess-goto-line (line)
(save-restriction
(widen)
(goto-char (point-min))
(forward-line (1- line))))
(defun ess-containing-sexp-position ()
(cadr (syntax-ppss)))
(defun ess-code-end-position ()
"Like (line-end-position) but stops at comments"
(save-excursion
(or (and (re-search-forward "#" (line-end-position) t)
(match-beginning 0))
(line-end-position))))
;;;*;;; Buffer motion/manipulation commands
(defvar ess-set-function-start
;; setAs, setGeneric; setMethod, setReplaceMethod, setGroupMethod
"^set[MGAR][Ma-z]+\\s-?("
)
;; common R and S
;; SJE: 2007-07-16 add to quieten byte-compiler.
(defvar ess-function-pattern nil
"Regexp to match the beginning of a function in S buffers.")
(defvar ess-R-symbol-pattern
"\\(\\sw\\|\\s_\\)"
"The regular expression for matching an R symbol")
(defvar ess-R-name-pattern
(concat "\\(" ess-R-symbol-pattern "+\\|\\(`\\).+`\\)")
"The regular expression for matching a R name.")
(let*
((Q "\\s\"") ; quote
(repl "\\(<-\\)?") ; replacement (function)
(Sym-0 "\\(\\sw\\|\\s_\\)") ; symbol
(Symb (concat Sym-0 "+"))
(xSymb "[^ \t\n\"']+") ;; (concat "\\[?\\[?" Sym-0 "*")); symbol / [ / [[ / [symbol / [[symbol
;; FIXME: allow '%foo%' but only when quoted; don't allow [_0-9] at beg.
(_or_ "\\)\\|\\(") ; OR
(space "\\(\\s-\\|\n\\)*") ; white space
(part-1 (concat
"\\(" ;;--------outer Either-------
"\\(\\(" ; EITHER
Q xSymb Q ; any function name between quotes
_or_
"\\(^\\|[ ]\\)" Symb ; (beginning of name) + ess-R-symbol-pattern
"\\)\\)")) ; END EITHER OR
(set-S4-exp
(concat
"^set\\(As\\|Method\\|Generic\\|GroupMethod\\|ReplaceMethod\\)(" ; S4 ...
Q xSymb Q "," space
;; and now often `` signature(......), : ''
".*" ;; <<< FIXME ???
))
(part-2 (concat
"\\|" ;;--------outer Or ---------
set-S4-exp
"\\)" ;;--------end outer Either/Or-------
"\\(" space "\\s<.*\\s>\\)*" ; whitespace, comment
;; FIXME: in principle we should skip 'definition *= *' here
space "function\\s-*(" ; whitespace, function keyword, parenthesis
))
)
(defvar ess-R-function-pattern
(concat part-1
"\\s-*\\(<-\\|=\\)" ; whitespace, assign
part-2)
"The regular expression for matching the beginning of an R function.")
(defvar ess-S-function-pattern
(concat part-1
"\\s-*\\(<-\\|_\\|=\\)" ; whitespace, assign (incl. "_")
part-2)
"The regular expression for matching the beginning of an S function.")
); {end let}
(defun ess-beginning-of-function (&optional no-error)
"Leave (and return) the point at the beginning of the current ESS function.
If the optional argument NO-ERROR is non-nil, the function returns nil when
it cannot find a function beginning."
;; FIXME: should not throw error in accordance with beginning-of-defun and
;; beginning-of-defun-function specification
(interactive)
(let ((init-point (point))
(in-set-S4 nil)
beg end done)
;; Note that we must be sure that we are past the 'function (' text,
;; such that ess-function-pattern is found in BACKwards later.
;; In case we're sitting in a function or setMethod() header,
;; we need to move further.
;; But not too far! {wrongly getting into next function}
(if (search-forward "("
(ess-line-end-position 2) t) ; at most end of next line
(forward-char 1))
;; TODO: replace the above by hopefully more sucessful logic:
;; 1. If we have 'function *(' in the same line, move to end of that line
;; 2. if *not*, skip all comment lines (concat space comment-char .* "\n")
;; and only* then do something like the
;; (search-forward '(' .. (..line-end.. 2) ) above
(setq end (point)) ; = init-point when nothing found
(ess-write-to-dribble-buffer
(format "ess-BEG-of-fun after 'search-FWD (': Ini-pt %d, (p)-Ini-pt = %d\n"
init-point (- end init-point)))
(if (and (> end 1)
(re-search-backward ;; in case of setMethod() etc ..
ess-set-function-start
;; at most 1 line earlier {2 is too much: finds previous sometimes}
(+ 1 (ess-line-end-position -1)) t))
(progn ;; yes we *have* an S4 setMethod(..)-like
(setq in-set-S4 t
beg (point))
(ess-write-to-dribble-buffer
(format " set*() function start at position %d" beg))
;; often need to move even further to have 'function(' to our left
;; (if (search-forward "function" end t)
;; (ess-write-to-dribble-buffer
;; (format " -> 'function' already at pos %d\n" (point)))
;; ;; else need to move further
(goto-char end)
;; search 4 lines, we are pretty sure now:
(search-forward
"function" (ess-line-end-position 4) t)
;; )
(search-forward "(" (ess-line-end-position) t))
;; else: regular function; no set*Method(..)
(ess-write-to-dribble-buffer "ELSE not in setMethod() header ...\n"))
(while (not done)
;; Need this while loop to skip over local function definitions
;; In the case of non-success, it is inefficiently
;; going back in the buffer through all function definitions...
(unless
(and (re-search-backward ess-function-pattern (point-min) t)
(not (ess-inside-string-or-comment-p (point))))
(goto-char init-point)
(if no-error
(setq done t beg nil)
;; else [default]:
(error "Point is not in a function according to 'ess-function-pattern'.")))
(unless done
(setq beg (point))
(ess-write-to-dribble-buffer
(format "\tMatch,Pt:(%d,%d),%d\n"
(match-beginning 0) (match-end 0) beg))
(setq in-set-S4 (looking-at ess-set-function-start))
(forward-list 1) ; get over arguments
;; The following used to bomb "Unbalanced parentheses", n1, n2
;; when the above (search-forward "(" ..) wasn't delimited :
(unless in-set-S4 (forward-sexp 1)) ; move over braces
;;DBG (ess-write-to-dribble-buffer "|")
(setq end (point))
(goto-char beg)
;; current function must begin and end around point
(setq done (and (>= end init-point) (<= beg init-point)))))
beg))
(defun ess-end-of-function (&optional beginning no-error)
"Leave the point at the end of the current ESS function.
Optional argument for location of beginning. Return '(beg end)."
(interactive)
(if beginning
(goto-char beginning)
(setq beginning (ess-beginning-of-function no-error)))
(if beginning
;; *hack* only for S (R || S+): are we in setMethod(..) etc?
(let ((in-set-S4 (looking-at ess-set-function-start))
(end-pos) (npos))
(ess-write-to-dribble-buffer
(format "ess-END-of-fun: S4=%s, beginning = %d\n" in-set-S4 beginning))
(forward-list 1) ; get over arguments || whole set*(..)
(unless in-set-S4 (forward-sexp 1)) ; move over braces
(ess-write-to-dribble-buffer
(format "ess-END-of-fun: found #1 : %d\n" (point)))
;; For one-line functions withOUT '{ .. }' body -- added 2008-07-23 --
;; particularly helpful for C-c C-c (ess-eval-function-or-paragraph-and-step):
(setq end-pos (ess-line-end-position))
(while (< (point) end-pos) ; if not at end of line, move further forward
(goto-char ;; careful not to move too far; e.g. *not* over empty lines:
(min (save-excursion (forward-sexp 1) (point))
(save-excursion (forward-paragraph 1) (point)))))
(list beginning (point)))
;; else: 'no-error': we are not in a function
nil))
(defun ess-goto-beginning-of-function-or-para ()
"If inside a function go to the beginning of it, otherwise go to the beginning
of paragraph."
(interactive)
(or (ess-beginning-of-function 'no-error)
(backward-paragraph))
(point))
(defun ess-goto-end-of-function-or-para ()
"If inside a function go to end of it, otherwise go to the end
of paragraph."
(interactive)
(or (ess-end-of-function nil 'no-error)
(forward-paragraph))
(point))
(defun ess-mark-function-or-para ()
"Put mark at end of ESS function, point at beginning."
(interactive)
(ess-goto-beginning-of-function-or-para)
(push-mark (point))
(ess-goto-end-of-function-or-para)
(exchange-point-and-mark))
(define-obsolete-function-alias 'ess-mark-function 'ess-mark-function-or-para "15.09")
(defun ess-narrow-to-defun-or-para ()
"Make text outside current function invisible.
If text is already narrowed, this is removed before narrowing to the
current function."
(interactive)
;; if point is not in a function, ess-end-of-function catches the error.
(save-excursion
(widen)
(let* ((beg (ess-goto-beginning-of-function-or-para))
(end (ess-goto-end-of-function-or-para)))
(narrow-to-region beg end))))
(define-obsolete-function-alias 'ess-narrow-to-defun 'ess-narrow-to-defun-or-para "15.09")
(defun ess-newline-and-indent ()
(interactive)
(cond ((string= ess-dialect "R")
(ess-roxy-newline-and-indent))
(t
(newline-and-indent))))
(defun ess-indent-new-comment-line ()
(interactive)
(cond ((string= ess-dialect "R")
(ess-roxy-indent-new-comment-line))
(t
(indent-new-comment-line))))
;;*;; Loading files
(defun ess-check-modifications nil
"Check whether loading this file would overwrite some ESS objects
which have been modified more recently than this file, and confirm
if this is the case."
;; FIXME: this should really cycle through all top-level assignments in
;; the buffer
;;VS[02-04-2012|ESS 12.03]: this is sooo ugly
(when (> (length ess-change-sp-regexp) 0)
(and (buffer-file-name) ess-filenames-map
(let ((sourcemod (nth 5 (file-attributes (buffer-file-name))))
(objname))
(save-excursion
(goto-char (point-min))
;; Get name of assigned object, if we can find it
(setq objname
(and
(re-search-forward
"^\\s *\"?\\(\\(\\sw\\|\\s_\\)+\\)\"?\\s *[<_]"
nil
t)
(buffer-substring (match-beginning 1)
(match-end 1)))))
(and
sourcemod ; the file may have been deleted
objname ; may not have been able to
; find name
(ess-modtime-gt (ess-object-modtime objname) sourcemod)
(not (y-or-n-p
(format
"The ESS object %s is newer than this file. Continue?"
objname)))
(error "Aborted"))))))
(defun ess-check-source (fname)
"If file FNAME has an unsaved buffer, offer to save it.
Returns t if the buffer existed and was modified, but was not saved."
(let ((buff (get-file-buffer fname)))
;; RMH: Corrections noted below are needed for C-c C-l to work
;; correctly when issued from *S* buffer.
;; The following barfs since
;; 1. `if' does not accept a buffer argument, `not' does.
;; 2. (buffer-file-name) is not necessarily defined for *S*
;;(if buff
;; (let ((deleted (not (file-exists-p (buffer-file-name)))))
;; Next 2 lines are RMH's solution:
(if (not(not buff))
(let ((deleted (not (file-exists-p fname))))
(if (and deleted (not (buffer-modified-p buff)))
;; Buffer has been silently deleted, so silently save
(with-current-buffer buff
(set-buffer-modified-p t)
(save-buffer))
(if (and (buffer-modified-p buff)
(or ess-mode-silently-save
(y-or-n-p
(format "Save buffer %s first? "
(buffer-name buff)))))
(with-current-buffer buff
(save-buffer))))
(buffer-modified-p buff)))))
(defvar ess-error-regexp "^\\(Syntax error: .*\\) at line \\([0-9]*\\), file \\(.*\\)$"
"Regexp to search for errors.")
(defun ess-parse-errors (&optional showerr reset)
"Jump to error in last loaded ESS source file.
With prefix argument, only shows the errors ESS reported."
;; reset argument is for compatibility with emacs next-error (tracebug
;; rebinds ess-parse-errors to next-error), This silences the compiler.
(interactive "P")
(ess-make-buffer-current)
(let ((errbuff (get-buffer ess-error-buffer-name)))
(if (not errbuff)
(error "You need to do a load first!")
(set-buffer errbuff)
(goto-char (point-max))
(if
(re-search-backward
;; FIXME: R does not give "useful" error messages -
;; ----- by default: We (ESS) could try to use a more useful one, via
;; options(error=essErrorHandler)
ess-error-regexp
nil
t)
(let* ((filename (buffer-substring (match-beginning 3) (match-end 3)))
(fbuffer (get-file-buffer filename))
(linenum
(string-to-number
(buffer-substring (match-beginning 2) (match-end 2))))
(errmess (buffer-substring (match-beginning 1) (match-end 1))))
(if showerr
(ess-display-temp-buffer errbuff)
(if fbuffer nil
(setq fbuffer (find-file-noselect filename))
(with-current-buffer fbuffer
(ess-mode)))
(pop-to-buffer fbuffer)
(ess-goto-line linenum))
(princ errmess t))
(message "Not a syntax error.")
(ess-display-temp-buffer errbuff)))))
;;*;; ESS code formatting/indentation
;;;*;;; User commands
(defun ess-electric-brace (arg)
"Insert character and correct line's indentation."
(interactive "P")
;; skeleton-pair takes precedence
(if (and (boundp 'skeleton-pair) skeleton-pair (featurep 'skeleton))
(skeleton-pair-insert-maybe "{")
;; else
(let (insertpos)
(if (and (not arg)
(eolp)
(or (save-excursion
(skip-chars-backward " \t")
(bolp))
(if ess-auto-newline (progn (ess-indent-line) (newline) t) nil)))
(progn
(insert (if (featurep 'xemacs) (event-to-character last-command-event) last-command-event))
(ess-indent-line)
(if ess-auto-newline
(progn
(newline)
;; (newline) may have done auto-fill
(setq insertpos (- (point) 2))
(ess-indent-line)))
(save-excursion
(if insertpos (goto-char (1+ insertpos)))
(delete-char -1))))
(if insertpos
(save-excursion
(goto-char insertpos)
(self-insert-command (prefix-numeric-value arg)))
(self-insert-command (prefix-numeric-value arg))))))
;; fixeme: move into ess-indent-or-complete, indentation functions are overly
;; scattered around
(defun ess-indent-command (&optional whole-exp)
"Indent current line as ESS code, or in some cases insert a tab character.
If `ess-tab-always-indent' is non-nil (the default), always indent
current line. Otherwise, indent the current line only if point is at
the left margin or in the line's indentation; otherwise insert a tab.
A numeric argument, regardless of its value, means indent rigidly all
the lines of the expression starting after point so that this line
becomes properly indented. The relative indentation among the lines
of the expression are preserved."
(interactive "P")
(if whole-exp
;; If arg, always indent this line as S
;; and shift remaining lines of expression the same amount.
(let ((shift-amt (ess-indent-line))
beg end)
(save-excursion
(if ess-tab-always-indent
(beginning-of-line))
(setq beg (point))
(backward-up-list 1)
(forward-list 1)
(setq end (point))
(goto-char beg)
(forward-line 1)
(setq beg (point)))
(if (> end beg)
(indent-code-rigidly beg end shift-amt)))
(if (and (not ess-tab-always-indent)
(save-excursion
(skip-chars-backward " \t")
(not (bolp))))
(insert-tab)
;; call ess-indent-line
(funcall indent-line-function))))
(defun ess-indent-or-complete ()
"When region is selected indent the region, otherwise, if
`ess-tab-complete-in-script' is non-nil, try to indent, if code
is already indented, complete instead.
The default of `ess-tab-complete-in-script' is nil. Also see
`ess-first-tab-never-complete'."
(interactive)
(if (use-region-p)
(indent-region (region-beginning) (region-end))
(let ((shift (ess-indent-command)))
(when (and ess-tab-complete-in-script
(numberp shift) ;; can be nil if ess-tab-always-indent is nil
(equal shift 0)
(or (eq last-command 'ess-indent-or-complete)
(null ess-first-tab-never-complete)
(and (eq ess-first-tab-never-complete 'unless-eol)
(looking-at "\\s-*$"))
(and (eq ess-first-tab-never-complete 'symbol)
(not (looking-at "\\w\\|\\s_")))
(and (eq ess-first-tab-never-complete 'symbol-or-paren)
(not (looking-at "\\w\\|\\s_\\|\\s)")))
(and (eq ess-first-tab-never-complete 'symbol-or-paren-or-punct)
(not (looking-at "\\w\\|\\s_\\|\\s)\\|\\s.")))
))
(if (and (featurep 'emacs) (>= emacs-major-version 24))
(completion-at-point)
(comint-dynamic-complete)
)))))
(defun ess-indent-exp ()
"Indent each line of the ESS grouping following point."
(interactive)
(cond ((string= ess-dialect "R")
(ess-r-indent-exp))
(t
(save-excursion
(if (fboundp ess-indent-exp-function)
(funcall ess-indent-exp-function)
(let ((start (point))
(end (ignore-errors (forward-sexp 1) (point))))
(when end
(indent-region start end))))))))
(defun ess-indent-line ()
"Indent current line as ESS code.
Return the amount the indentation changed by."
;; fixme: make this work with standard indent-line-function
(if (fboundp ess-indent-line-function)
(funcall ess-indent-line-function)
;; else S and R default behavior
(ess-r-indent-line)))
;;;*;;; Predefined indentation styles
(defun ess-set-style (&optional style quiet)
"Set up the `ess-mode' style variables from the `ess-style' variable
or if STYLE argument is given, use that. It makes the ESS indentation
style variables buffer local."
(interactive)
(let ((ess-styles (mapcar 'symbol-name (mapcar 'car ess-style-alist))))
(unless style
(setq style
(intern (ess-completing-read "Set ESS mode indentation style"
ess-styles nil t nil nil ess-default-style))))
(setq style (or style ess-style))
(make-local-variable 'ess-style)
(if (memq (symbol-name style) ess-styles)
(setq ess-style style)
(error (format "Bad ESS style: %s" style)))
(if (not quiet)
(message "ESS-style: %s" ess-style))
;; finally, set the indentation style variables making each one local
(mapc (lambda (ess-style-pair)
(make-local-variable (car ess-style-pair))
(set (car ess-style-pair)
(cdr ess-style-pair)))
(cdr (assq ess-style ess-style-alist)))
ess-style))
;;*;; Creating and manipulating dump buffers
;;;*;;; The user command