-
Notifications
You must be signed in to change notification settings - Fork 7
/
esh-mode.el
1084 lines (948 loc) · 38 KB
/
esh-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
;;; esh-mode.el --- user interface
;; Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004,
;; 2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
;; Author: John Wiegley <johnw@gnu.org>
;; 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 <http://www.gnu.org/licenses/>.
;;; Commentary:
;; Basically, Eshell is used just like shell mode (<M-x shell>). The
;; keystrokes for navigating the buffer, and accessing the command
;; history, are identical. Unlike shell mode, however, Eshell mode's
;; governing process is Emacs itself. With shell mode, an inferior
;; shell process is executed that communicates with Emacs via comint
;; -- a mode for handling sub-process interaction. Eshell mode, on
;; the other hand, is a truly native Emacs shell. No subprocess are
;; invoked except the ones requested by the user at the prompt.
;;
;; After entering a command, use <RET> to invoke it ([Command
;; invocation]) . If there is a command on disk, it will be executed
;; as in a normal shell. If there is no command by that name on disk,
;; but a Lisp function with that name is defined, the Lisp function
;; will be called, using the arguments passed on the command line.
;;
;; Some of the other features of the command interaction mode are:
;;
;; @ <M-RET> can be used to accumulate further commands while a
;; command is currently running. Since all input is passed to the
;; subprocess being executed, there is no automatic input queueing
;; as there is with other shells.
;;
;; @ <C-c C-t> can be used to truncate the buffer if it grows too
;; large.
;;
;; @ <C-c C-r> will move point to the beginning of the output of the
;; last command. With a prefix argument, it will narrow to view
;; only that output.
;;
;; @ <C-c C-o> will delete the output from the last command.
;;
;; @ <C-c C-f> will move forward a complete shell argument.
;;
;; @ <C-c C-b> will move backward a complete shell argument.
(provide 'esh-mode)
(eval-when-compile (require 'esh-util))
(require 'esh-module)
(require 'esh-cmd)
(require 'esh-io)
(require 'esh-var)
(defgroup eshell-mode nil
"This module contains code for handling input from the user."
:tag "User interface"
:group 'eshell)
;;; User Variables:
(defcustom eshell-mode-unload-hook nil
"*A hook that gets run when `eshell-mode' is unloaded."
:type 'hook
:group 'eshell-mode)
(defcustom eshell-mode-hook nil
"*A hook that gets run when `eshell-mode' is entered."
:type 'hook
:group 'eshell-mode)
(defcustom eshell-first-time-mode-hook nil
"*A hook that gets run the first time `eshell-mode' is entered.
That is to say, the first time during an Emacs session."
:type 'hook
:group 'eshell-mode)
(defcustom eshell-exit-hook '(eshell-query-kill-processes)
"*A hook that is run whenever `eshell' is exited.
This hook is only run if exiting actually kills the buffer."
:type 'hook
:group 'eshell-mode)
(defcustom eshell-kill-on-exit t
"*If non-nil, kill the Eshell buffer on the `exit' command.
Otherwise, the buffer will simply be buried."
:type 'boolean
:group 'eshell-mode)
(defcustom eshell-input-filter-functions nil
"*Functions to call before input is processed.
The input is contained in the region from `eshell-last-input-start' to
`eshell-last-input-end'."
:type 'hook
:group 'eshell-mode)
(defcustom eshell-send-direct-to-subprocesses nil
"*If t, send any input immediately to a subprocess."
:type 'boolean
:group 'eshell-mode)
(defcustom eshell-expand-input-functions nil
"*Functions to call before input is parsed.
Each function is passed two arguments, which bounds the region of the
current input text."
:type 'hook
:group 'eshell-mode)
(defcustom eshell-scroll-to-bottom-on-input nil
"*Controls whether input to interpreter causes window to scroll.
If nil, then do not scroll. If t or `all', scroll all windows showing
buffer. If `this', scroll only the selected window.
See `eshell-preinput-scroll-to-bottom'."
:type '(radio (const :tag "Do not scroll Eshell windows" nil)
(const :tag "Scroll all windows showing the buffer" all)
(const :tag "Scroll only the selected window" this))
:group 'eshell-mode)
(defcustom eshell-scroll-to-bottom-on-output nil
"*Controls whether interpreter output causes window to scroll.
If nil, then do not scroll. If t or `all', scroll all windows showing
buffer. If `this', scroll only the selected window. If `others',
scroll only those that are not the selected window.
See variable `eshell-scroll-show-maximum-output' and function
`eshell-postoutput-scroll-to-bottom'."
:type '(radio (const :tag "Do not scroll Eshell windows" nil)
(const :tag "Scroll all windows showing the buffer" all)
(const :tag "Scroll only the selected window" this)
(const :tag "Scroll all windows other than selected" this))
:group 'eshell-mode)
(defcustom eshell-scroll-show-maximum-output t
"*Controls how interpreter output causes window to scroll.
If non-nil, then show the maximum output when the window is scrolled.
See variable `eshell-scroll-to-bottom-on-output' and function
`eshell-postoutput-scroll-to-bottom'."
:type 'boolean
:group 'eshell-mode)
(defcustom eshell-buffer-maximum-lines 1024
"*The maximum size in lines for eshell buffers.
Eshell buffers are truncated from the top to be no greater than this
number, if the function `eshell-truncate-buffer' is on
`eshell-output-filter-functions'."
:type 'integer
:group 'eshell-mode)
(defcustom eshell-output-filter-functions
'(eshell-postoutput-scroll-to-bottom
eshell-handle-control-codes
eshell-watch-for-password-prompt)
"*Functions to call before output is displayed.
These functions are only called for output that is displayed
interactively, and not for output which is redirected."
:type 'hook
:group 'eshell-mode)
(defcustom eshell-preoutput-filter-functions nil
"*Functions to call before output is inserted into the buffer.
These functions get one argument, a string containing the text to be
inserted. They return the string as it should be inserted."
:type 'hook
:group 'eshell-mode)
(defcustom eshell-password-prompt-regexp
"[Pp]ass\\(word\\|phrase\\).*:\\s *\\'"
"*Regexp matching prompts for passwords in the inferior process.
This is used by `eshell-watch-for-password-prompt'."
:type 'regexp
:group 'eshell-mode)
(defcustom eshell-skip-prompt-function nil
"*A function called from beginning of line to skip the prompt."
:type '(choice (const nil) function)
:group 'eshell-mode)
(defcustom eshell-status-in-modeline t
"*If non-nil, let the user know a command is running in the modeline."
:type 'boolean
:group 'eshell-mode)
(defvar eshell-first-time-p t
"A variable which is non-nil the first time Eshell is loaded.")
;; Internal Variables:
;; these are only set to `nil' initially for the sake of the
;; byte-compiler, when compiling other files which `require' this one
(defvar eshell-mode nil)
(defvar eshell-mode-map nil)
(defvar eshell-command-running-string "--")
(defvar eshell-command-map nil)
(defvar eshell-command-prefix nil)
(defvar eshell-last-input-start nil)
(defvar eshell-last-input-end nil)
(defvar eshell-last-output-start nil)
(defvar eshell-last-output-block-begin nil)
(defvar eshell-last-output-end nil)
(defvar eshell-currently-handling-window nil)
(defvar eshell-mode-syntax-table nil)
(defvar eshell-mode-abbrev-table nil)
(define-abbrev-table 'eshell-mode-abbrev-table ())
(if (not eshell-mode-syntax-table)
(let ((i 0))
(setq eshell-mode-syntax-table (make-syntax-table))
(while (< i ?0)
(modify-syntax-entry i "_ " eshell-mode-syntax-table)
(setq i (1+ i)))
(setq i (1+ ?9))
(while (< i ?A)
(modify-syntax-entry i "_ " eshell-mode-syntax-table)
(setq i (1+ i)))
(setq i (1+ ?Z))
(while (< i ?a)
(modify-syntax-entry i "_ " eshell-mode-syntax-table)
(setq i (1+ i)))
(setq i (1+ ?z))
(while (< i 128)
(modify-syntax-entry i "_ " eshell-mode-syntax-table)
(setq i (1+ i)))
(modify-syntax-entry ? " " eshell-mode-syntax-table)
(modify-syntax-entry ?\t " " eshell-mode-syntax-table)
(modify-syntax-entry ?\f " " eshell-mode-syntax-table)
(modify-syntax-entry ?\n "> " eshell-mode-syntax-table)
;; Give CR the same syntax as newline, for selective-display.
(modify-syntax-entry ?\^m "> " eshell-mode-syntax-table)
;;; (modify-syntax-entry ?\; "< " eshell-mode-syntax-table)
(modify-syntax-entry ?` "' " eshell-mode-syntax-table)
(modify-syntax-entry ?' "' " eshell-mode-syntax-table)
(modify-syntax-entry ?, "' " eshell-mode-syntax-table)
;; Used to be singlequote; changed for flonums.
(modify-syntax-entry ?. "_ " eshell-mode-syntax-table)
(modify-syntax-entry ?- "_ " eshell-mode-syntax-table)
(modify-syntax-entry ?| ". " eshell-mode-syntax-table)
(modify-syntax-entry ?# "' " eshell-mode-syntax-table)
(modify-syntax-entry ?\" "\" " eshell-mode-syntax-table)
(modify-syntax-entry ?\\ "/ " eshell-mode-syntax-table)
(modify-syntax-entry ?\( "() " eshell-mode-syntax-table)
(modify-syntax-entry ?\) ")( " eshell-mode-syntax-table)
(modify-syntax-entry ?\{ "(} " eshell-mode-syntax-table)
(modify-syntax-entry ?\} "){ " eshell-mode-syntax-table)
(modify-syntax-entry ?\[ "(] " eshell-mode-syntax-table)
(modify-syntax-entry ?\] ")[ " eshell-mode-syntax-table)
;; All non-word multibyte characters should be `symbol'.
(if (featurep 'xemacs)
(map-char-table
(function
(lambda (key val)
(and (characterp key)
(>= (char-int key) 256)
(/= (char-syntax key) ?w)
(modify-syntax-entry key "_ "
eshell-mode-syntax-table))))
(standard-syntax-table))
(map-char-table
(function
(lambda (key val)
(and (if (consp key)
(and (>= (car key) 128)
(/= (char-syntax (car key)) ?w))
(and (>= key 256)
(/= (char-syntax key) ?w)))
(modify-syntax-entry key "_ "
eshell-mode-syntax-table))))
(standard-syntax-table)))))
;;; User Functions:
;;;###autoload
(defun eshell-mode ()
"Emacs shell interactive mode.
\\{eshell-mode-map}"
(kill-all-local-variables)
(setq major-mode 'eshell-mode)
(setq mode-name "EShell")
(set (make-local-variable 'eshell-mode) t)
(make-local-variable 'eshell-mode-map)
(setq eshell-mode-map (make-sparse-keymap))
(use-local-map eshell-mode-map)
(when eshell-status-in-modeline
(make-local-variable 'eshell-command-running-string)
(let ((fmt (copy-sequence mode-line-format)))
(make-local-variable 'mode-line-format)
(setq mode-line-format fmt))
(let ((modeline (memq 'mode-line-modified mode-line-format)))
(if modeline
(setcar modeline 'eshell-command-running-string))))
(define-key eshell-mode-map [return] 'eshell-send-input)
(define-key eshell-mode-map [(control ?m)] 'eshell-send-input)
(define-key eshell-mode-map [(control ?j)] 'eshell-send-input)
(define-key eshell-mode-map [(meta return)] 'eshell-queue-input)
(define-key eshell-mode-map [(meta control ?m)] 'eshell-queue-input)
(define-key eshell-mode-map [(meta control ?l)] 'eshell-show-output)
(set (make-local-variable 'eshell-command-prefix)
(make-symbol "eshell-command-prefix"))
(fset eshell-command-prefix (make-sparse-keymap))
(set (make-local-variable 'eshell-command-map)
(symbol-function eshell-command-prefix))
(define-key eshell-mode-map [(control ?c)] eshell-command-prefix)
;; without this, find-tag complains about read-only text being
;; modified
(if (eq (key-binding [(meta ?.)]) 'find-tag)
(define-key eshell-mode-map [(meta ?.)] 'eshell-find-tag))
(define-key eshell-command-map [(meta ?o)] 'eshell-mark-output)
(define-key eshell-command-map [(meta ?d)] 'eshell-toggle-direct-send)
(define-key eshell-command-map [(control ?a)] 'eshell-bol)
(define-key eshell-command-map [(control ?b)] 'eshell-backward-argument)
(define-key eshell-command-map [(control ?e)] 'eshell-show-maximum-output)
(define-key eshell-command-map [(control ?f)] 'eshell-forward-argument)
(define-key eshell-command-map [return] 'eshell-copy-old-input)
(define-key eshell-command-map [(control ?m)] 'eshell-copy-old-input)
(define-key eshell-command-map [(control ?o)] 'eshell-kill-output)
(define-key eshell-command-map [(control ?r)] 'eshell-show-output)
(define-key eshell-command-map [(control ?t)] 'eshell-truncate-buffer)
(define-key eshell-command-map [(control ?u)] 'eshell-kill-input)
(define-key eshell-command-map [(control ?w)] 'backward-kill-word)
(define-key eshell-command-map [(control ?y)] 'eshell-repeat-argument)
(setq local-abbrev-table eshell-mode-abbrev-table)
(set-syntax-table eshell-mode-syntax-table)
(set (make-local-variable 'dired-directory) default-directory)
(set (make-local-variable 'list-buffers-directory)
(expand-file-name default-directory))
;; always set the tab width to 8 in Eshell buffers, since external
;; commands which do their own formatting almost always expect this
(set (make-local-variable 'tab-width) 8)
;; don't ever use auto-fill in Eshell buffers
(setq auto-fill-function nil)
;; always display everything from a return value
(if (boundp 'print-length)
(set (make-local-variable 'print-length) nil))
(if (boundp 'print-level)
(set (make-local-variable 'print-level) nil))
;; set require-final-newline to nil; otherwise, all redirected
;; output will end with a newline, whether or not the source
;; indicated it!
(set (make-local-variable 'require-final-newline) nil)
(set (make-local-variable 'max-lisp-eval-depth)
(max 3000 max-lisp-eval-depth))
(set (make-local-variable 'max-specpdl-size)
(max 6000 max-lisp-eval-depth))
(set (make-local-variable 'eshell-last-input-start) (point-marker))
(set (make-local-variable 'eshell-last-input-end) (point-marker))
(set (make-local-variable 'eshell-last-output-start) (point-marker))
(set (make-local-variable 'eshell-last-output-end) (point-marker))
(set (make-local-variable 'eshell-last-output-block-begin) (point))
(let ((modules-list (copy-sequence eshell-modules-list)))
(make-local-variable 'eshell-modules-list)
(setq eshell-modules-list modules-list))
;; load extension modules into memory. This will cause any global
;; variables they define to be visible, since some of the core
;; modules sometimes take advantage of their functionality if used.
(eshell-for module eshell-modules-list
(let ((module-fullname (symbol-name module))
module-shortname)
(if (string-match "^eshell-\\(.*\\)" module-fullname)
(setq module-shortname
(concat "em-" (match-string 1 module-fullname))))
(unless module-shortname
(error "Invalid Eshell module name: %s" module-fullname))
(unless (featurep (intern module-shortname))
(load module-shortname))))
(unless (file-exists-p eshell-directory-name)
(eshell-make-private-directory eshell-directory-name t))
;; load core Eshell modules for this session
(eshell-for module (eshell-subgroups 'eshell)
(run-hooks (intern-soft (concat (symbol-name module)
"-load-hook"))))
;; load extension modules for this session
(eshell-for module eshell-modules-list
(let ((load-hook (intern-soft (concat (symbol-name module)
"-load-hook"))))
(if (and load-hook (boundp load-hook))
(run-hooks load-hook))))
(if eshell-send-direct-to-subprocesses
(add-hook 'pre-command-hook 'eshell-intercept-commands t t))
(if eshell-scroll-to-bottom-on-input
(add-hook 'pre-command-hook 'eshell-preinput-scroll-to-bottom t t))
(when eshell-scroll-show-maximum-output
(set (make-local-variable 'scroll-conservatively) 1000))
(when eshell-status-in-modeline
(add-hook 'eshell-pre-command-hook 'eshell-command-started nil t)
(add-hook 'eshell-post-command-hook 'eshell-command-finished nil t))
(add-hook 'kill-buffer-hook
(function
(lambda ()
(run-hooks 'eshell-exit-hook))) t t)
(if eshell-first-time-p
(run-hooks 'eshell-first-time-mode-hook))
(run-mode-hooks 'eshell-mode-hook)
(run-hooks 'eshell-post-command-hook))
(put 'eshell-mode 'mode-class 'special)
(eshell-deftest mode major-mode
"Major mode is correct"
(eq major-mode 'eshell-mode))
(eshell-deftest mode eshell-mode-variable
"`eshell-mode' is true"
(eq eshell-mode t))
(eshell-deftest var window-height
"LINES equals window height"
(let ((eshell-stringify-t t))
(eshell-command-result-p "= $LINES (window-height)" "t\n")))
(defun eshell-command-started ()
"Indicate in the modeline that a command has started."
(setq eshell-command-running-string "**")
(force-mode-line-update))
(defun eshell-command-finished ()
"Indicate in the modeline that a command has finished."
(setq eshell-command-running-string "--")
(force-mode-line-update))
(eshell-deftest mode command-running-p
"Modeline shows no command running"
(or (featurep 'xemacs)
(not eshell-status-in-modeline)
(and (memq 'eshell-command-running-string mode-line-format)
(equal eshell-command-running-string "--"))))
;;; Internal Functions:
(defun eshell-toggle-direct-send ()
(interactive)
(if eshell-send-direct-to-subprocesses
(progn
(setq eshell-send-direct-to-subprocesses nil)
(remove-hook 'pre-command-hook 'eshell-intercept-commands t)
(message "Sending subprocess input on RET"))
(setq eshell-send-direct-to-subprocesses t)
(add-hook 'pre-command-hook 'eshell-intercept-commands t t)
(message "Sending subprocess input directly")))
(defun eshell-self-insert-command (N)
(interactive "i")
(process-send-string
(eshell-interactive-process)
(char-to-string (if (symbolp last-command-char)
(get last-command-char 'ascii-character)
last-command-char))))
(defun eshell-intercept-commands ()
(when (and (eshell-interactive-process)
(not (and (integerp last-input-event)
(memq last-input-event '(?\C-x ?\C-c)))))
(let ((possible-events (where-is-internal this-command))
(name (symbol-name this-command))
(intercept t))
;; Assume that any multikey combination which does NOT target an
;; Eshell command, is a combo the user wants invoked rather than
;; sent to the underlying subprocess.
(unless (and (> (length name) 7)
(equal (substring name 0 7) "eshell-"))
(while possible-events
(if (> (length (car possible-events)) 1)
(setq intercept nil possible-events nil)
(setq possible-events (cdr possible-events)))))
(if intercept
(setq this-command 'eshell-self-insert-command)))))
(defun eshell-find-tag (&optional tagname next-p regexp-p)
"A special version of `find-tag' that ignores read-onlyness."
(interactive)
(require 'etags)
(let ((inhibit-read-only t)
(no-default (eobp))
(find-tag-default-function 'ignore))
(with-no-warnings
(setq tagname (car (find-tag-interactive "Find tag: "))))
(find-tag tagname next-p regexp-p)))
(defun eshell-move-argument (limit func property arg)
"Move forward ARG arguments."
(catch 'eshell-incomplete
(eshell-parse-arguments (save-excursion (eshell-bol) (point))
(line-end-position)))
(let ((pos (save-excursion
(funcall func 1)
(while (and (> arg 0) (/= (point) limit))
(if (get-text-property (point) property)
(setq arg (1- arg)))
(if (> arg 0)
(funcall func 1)))
(point))))
(goto-char pos)
(if (and (eq func 'forward-char)
(= (1+ pos) limit))
(forward-char 1))))
(eshell-deftest arg forward-arg
"Move across command arguments"
(eshell-insert-command "echo $(+ 1 (- 4 3)) \"alpha beta\" file" 'ignore)
(let ((here (point)) begin valid)
(eshell-bol)
(setq begin (point))
(eshell-forward-argument 4)
(setq valid (= here (point)))
(eshell-backward-argument 4)
(prog1
(and valid (= begin (point)))
(eshell-bol)
(delete-region (point) (point-max)))))
(defun eshell-forward-argument (&optional arg)
"Move forward ARG arguments."
(interactive "p")
(eshell-move-argument (point-max) 'forward-char 'arg-end arg))
(defun eshell-backward-argument (&optional arg)
"Move backward ARG arguments."
(interactive "p")
(eshell-move-argument (point-min) 'backward-char 'arg-begin arg))
(defun eshell-repeat-argument (&optional arg)
(interactive "p")
(let ((begin (save-excursion
(eshell-backward-argument arg)
(point))))
(kill-ring-save begin (point))
(yank)))
(defun eshell-bol ()
"Goes to the beginning of line, then skips past the prompt, if any."
(interactive)
(beginning-of-line)
(and eshell-skip-prompt-function
(funcall eshell-skip-prompt-function)))
(defsubst eshell-push-command-mark ()
"Push a mark at the end of the last input text."
(push-mark (1- eshell-last-input-end) t))
(custom-add-option 'eshell-pre-command-hook 'eshell-push-command-mark)
(defsubst eshell-goto-input-start ()
"Goto the start of the last command input.
Putting this function on `eshell-pre-command-hook' will mimic Plan 9's
9term behavior."
(goto-char eshell-last-input-start))
(custom-add-option 'eshell-pre-command-hook 'eshell-push-command-mark)
(defsubst eshell-interactive-print (string)
"Print STRING to the eshell display buffer."
(eshell-output-filter nil string))
(defsubst eshell-begin-on-new-line ()
"This function outputs a newline if not at beginning of line."
(save-excursion
(goto-char eshell-last-output-end)
(or (bolp)
(eshell-interactive-print "\n"))))
(defsubst eshell-reset (&optional no-hooks)
"Output a prompt on a new line, aborting any current input.
If NO-HOOKS is non-nil, then `eshell-post-command-hook' won't be run."
(goto-char (point-max))
(setq eshell-last-input-start (point-marker)
eshell-last-input-end (point-marker)
eshell-last-output-start (point-marker)
eshell-last-output-block-begin (point)
eshell-last-output-end (point-marker))
(eshell-begin-on-new-line)
(unless no-hooks
(run-hooks 'eshell-post-command-hook)
(goto-char (point-max))))
(defun eshell-parse-command-input (beg end &optional args)
"Parse the command input from BEG to END.
The difference is that `eshell-parse-command' expects a complete
command string (and will error if it doesn't get one), whereas this
function will inform the caller whether more input is required.
If nil is returned, more input is necessary (probably because a
multi-line input string wasn't terminated properly). Otherwise, it
will return the parsed command."
(let (delim command)
(if (setq delim
(catch 'eshell-incomplete
(ignore
(setq command (eshell-parse-command (cons beg end)
args t)))))
(ignore
(message "Expecting completion of delimeter %c ..."
(if (listp delim)
(car delim)
delim)))
command)))
(defun eshell-update-markers (pmark)
"Update the input and output markers relative to point and PMARK."
(set-marker eshell-last-input-start pmark)
(set-marker eshell-last-input-end (point))
(set-marker eshell-last-output-end (point)))
(defun eshell-queue-input (&optional use-region)
"Queue the current input text for execution by Eshell.
Particularly, don't send the text to the current process, even if it's
waiting for input."
(interactive "P")
(eshell-send-input use-region t))
(eshell-deftest mode queue-input
"Queue command input"
(eshell-insert-command "sleep 2")
(eshell-insert-command "echo alpha" 'eshell-queue-input)
(let ((count 10))
(while (and eshell-current-command
(> count 0))
(sit-for 1 0)
(setq count (1- count))))
(eshell-match-result "alpha\n"))
(defun eshell-send-input (&optional use-region queue-p no-newline)
"Send the input received to Eshell for parsing and processing.
After `eshell-last-output-end', sends all text from that marker to
point as input. Before that marker, calls `eshell-get-old-input' to
retrieve old input, copies it to the end of the buffer, and sends it.
If USE-REGION is non-nil, the current region (between point and mark)
will be used as input.
If QUEUE-P is non-nil, input will be queued until the next prompt,
rather than sent to the currently active process. If no process, the
input is processed immediately.
If NO-NEWLINE is non-nil, the input is sent without an implied final
newline."
(interactive "P")
;; Note that the input string does not include its terminal newline.
(let ((proc-running-p (and (eshell-interactive-process)
(not queue-p)))
(inhibit-point-motion-hooks t)
after-change-functions)
(unless (and proc-running-p
(not (eq (process-status
(eshell-interactive-process)) 'run)))
(if (or proc-running-p
(>= (point) eshell-last-output-end))
(goto-char (point-max))
(let ((copy (eshell-get-old-input use-region)))
(goto-char eshell-last-output-end)
(insert-and-inherit copy)))
(unless (or no-newline
(and eshell-send-direct-to-subprocesses
proc-running-p))
(insert-before-markers-and-inherit ?\n))
(if proc-running-p
(progn
(eshell-update-markers eshell-last-output-end)
(if (or eshell-send-direct-to-subprocesses
(= eshell-last-input-start eshell-last-input-end))
(unless no-newline
(process-send-string (eshell-interactive-process) "\n"))
(process-send-region (eshell-interactive-process)
eshell-last-input-start
eshell-last-input-end)))
(if (= eshell-last-output-end (point))
(run-hooks 'eshell-post-command-hook)
(let (input)
(eshell-condition-case err
(progn
(setq input (buffer-substring-no-properties
eshell-last-output-end (1- (point))))
(run-hook-with-args 'eshell-expand-input-functions
eshell-last-output-end (1- (point)))
(let ((cmd (eshell-parse-command-input
eshell-last-output-end (1- (point)))))
(when cmd
(eshell-update-markers eshell-last-output-end)
(setq input (buffer-substring-no-properties
eshell-last-input-start
(1- eshell-last-input-end)))
(run-hooks 'eshell-input-filter-functions)
(and (catch 'eshell-terminal
(ignore
(if (eshell-invoke-directly cmd input)
(eval cmd)
(eshell-eval-command cmd input))))
(eshell-life-is-too-much)))))
(quit
(eshell-reset t)
(run-hooks 'eshell-post-command-hook)
(signal 'quit nil))
(error
(eshell-reset t)
(eshell-interactive-print
(concat (error-message-string err) "\n"))
(run-hooks 'eshell-post-command-hook)
(insert-and-inherit input)))))))))
; (eshell-deftest proc send-to-subprocess
; "Send input to a subprocess"
; ;; jww (1999-12-06): what about when bc is unavailable?
; (if (not (eshell-search-path "bc"))
; t
; (eshell-insert-command "bc")
; (eshell-insert-command "1 + 2")
; (sit-for 1 0)
; (forward-line -1)
; (prog1
; (looking-at "3\n")
; (eshell-insert-command "quit")
; (sit-for 1 0))))
(defsubst eshell-kill-new ()
"Add the last input text to the kill ring."
(kill-ring-save eshell-last-input-start eshell-last-input-end))
(custom-add-option 'eshell-input-filter-functions 'eshell-kill-new)
(defun eshell-output-filter (process string)
"Send the output from PROCESS (STRING) to the interactive display.
This is done after all necessary filtering has been done."
(let ((oprocbuf (if process (process-buffer process)
(current-buffer)))
(inhibit-point-motion-hooks t)
after-change-functions)
(let ((functions eshell-preoutput-filter-functions))
(while (and functions string)
(setq string (funcall (car functions) string))
(setq functions (cdr functions))))
(if (and string oprocbuf (buffer-name oprocbuf))
(let (opoint obeg oend)
(with-current-buffer oprocbuf
(setq opoint (point))
(setq obeg (point-min))
(setq oend (point-max))
(let ((buffer-read-only nil)
(nchars (length string))
(ostart nil))
(widen)
(goto-char eshell-last-output-end)
(setq ostart (point))
(if (<= (point) opoint)
(setq opoint (+ opoint nchars)))
(if (< (point) obeg)
(setq obeg (+ obeg nchars)))
(if (<= (point) oend)
(setq oend (+ oend nchars)))
(insert-before-markers string)
(if (= (window-start (selected-window)) (point))
(set-window-start (selected-window)
(- (point) nchars)))
(if (= (point) eshell-last-input-end)
(set-marker eshell-last-input-end
(- eshell-last-input-end nchars)))
(set-marker eshell-last-output-start ostart)
(set-marker eshell-last-output-end (point))
(force-mode-line-update))
(narrow-to-region obeg oend)
(goto-char opoint)
(eshell-run-output-filters))))))
(defun eshell-run-output-filters ()
"Run the `eshell-output-filter-functions' on the current output."
(save-current-buffer
(run-hooks 'eshell-output-filter-functions))
(setq eshell-last-output-block-begin
(marker-position eshell-last-output-end)))
;;; jww (1999-10-23): this needs testing
(defun eshell-preinput-scroll-to-bottom ()
"Go to the end of buffer in all windows showing it.
Movement occurs if point in the selected window is not after the
process mark, and `this-command' is an insertion command. Insertion
commands recognized are `self-insert-command', `yank', and
`hilit-yank'. Depends on the value of
`eshell-scroll-to-bottom-on-input'.
This function should be a pre-command hook."
(if (memq this-command '(self-insert-command yank hilit-yank))
(let* ((selected (selected-window))
(current (current-buffer))
(scroll eshell-scroll-to-bottom-on-input))
(if (< (point) eshell-last-output-end)
(if (eq scroll 'this)
(goto-char (point-max))
(walk-windows
(function
(lambda (window)
(when (and (eq (window-buffer window) current)
(or (eq scroll t) (eq scroll 'all)))
(select-window window)
(goto-char (point-max))
(select-window selected))))
nil t))))))
;;; jww (1999-10-23): this needs testing
(defun eshell-postoutput-scroll-to-bottom ()
"Go to the end of buffer in all windows showing it.
Does not scroll if the current line is the last line in the buffer.
Depends on the value of `eshell-scroll-to-bottom-on-output' and
`eshell-scroll-show-maximum-output'.
This function should be in the list `eshell-output-filter-functions'."
(let* ((selected (selected-window))
(current (current-buffer))
(scroll eshell-scroll-to-bottom-on-output))
(unwind-protect
(walk-windows
(function
(lambda (window)
(if (eq (window-buffer window) current)
(progn
(select-window window)
(if (and (< (point) eshell-last-output-end)
(or (eq scroll t) (eq scroll 'all)
;; Maybe user wants point to jump to end.
(and (eq scroll 'this)
(eq selected window))
(and (eq scroll 'others)
(not (eq selected window)))
;; If point was at the end, keep it at end.
(>= (point) eshell-last-output-start)))
(goto-char eshell-last-output-end))
;; Optionally scroll so that the text
;; ends at the bottom of the window.
(if (and eshell-scroll-show-maximum-output
(>= (point) eshell-last-output-end))
(save-excursion
(goto-char (point-max))
(recenter -1)))
(select-window selected)))))
nil t)
(set-buffer current))))
(defun eshell-beginning-of-input ()
"Return the location of the start of the previous input."
eshell-last-input-start)
(defun eshell-beginning-of-output ()
"Return the location of the end of the previous output block."
eshell-last-input-end)
(defun eshell-end-of-output ()
"Return the location of the end of the previous output block."
(if (eshell-using-module 'eshell-prompt)
eshell-last-output-start
eshell-last-output-end))
(defun eshell-kill-output ()
"Kill all output from interpreter since last input.
Does not delete the prompt."
(interactive)
(save-excursion
(goto-char (eshell-beginning-of-output))
(insert "*** output flushed ***\n")
(delete-region (point) (eshell-end-of-output))))
(eshell-deftest io flush-output
"Flush previous output"
(eshell-insert-command "echo alpha")
(eshell-kill-output)
(and (eshell-match-result (regexp-quote "*** output flushed ***\n"))
(forward-line)
(= (point) eshell-last-output-start)))
(defun eshell-show-output (&optional arg)
"Display start of this batch of interpreter output at top of window.
Sets mark to the value of point when this command is run.
With a prefix argument, narrows region to last command output."
(interactive "P")
(goto-char (eshell-beginning-of-output))
(set-window-start (selected-window)
(save-excursion
(goto-char (eshell-beginning-of-input))
(line-beginning-position)))
(if arg
(narrow-to-region (eshell-beginning-of-output)
(eshell-end-of-output)))
(eshell-end-of-output))
(defun eshell-mark-output (&optional arg)
"Display start of this batch of interpreter output at top of window.
Sets mark to the value of point when this command is run.
With a prefix argument, narrows region to last command output."
(interactive "P")
(push-mark (eshell-show-output arg)))
(defun eshell-kill-input ()
"Kill all text from last stuff output by interpreter to point."
(interactive)
(if (> (point) eshell-last-output-end)
(kill-region eshell-last-output-end (point))
(let ((here (point)))
(eshell-bol)
(kill-region (point) here))))
(defun eshell-show-maximum-output (&optional interactive)
"Put the end of the buffer at the bottom of the window.
When run interactively, widen the buffer first."
(interactive "p")
(if interactive
(widen))
(goto-char (point-max))
(recenter -1))
(defun eshell-get-old-input (&optional use-current-region)
"Return the command input on the current line."
(if use-current-region
(buffer-substring (min (point) (mark))
(max (point) (mark)))
(save-excursion
(beginning-of-line)
(and eshell-skip-prompt-function
(funcall eshell-skip-prompt-function))
(let ((beg (point)))
(end-of-line)
(buffer-substring beg (point))))))
(defun eshell-copy-old-input ()
"Insert after prompt old input at point as new input to be edited."
(interactive)
(let ((input (eshell-get-old-input)))
(goto-char eshell-last-output-end)
(insert-and-inherit input)))
(eshell-deftest mode run-old-command
"Re-run an old command"
(eshell-insert-command "echo alpha")
(goto-char eshell-last-input-start)
(string= (eshell-get-old-input) "echo alpha"))
(defun eshell/exit ()
"Leave or kill the Eshell buffer, depending on `eshell-kill-on-exit'."
(throw 'eshell-terminal t))
(defun eshell-life-is-too-much ()
"Kill the current buffer (or bury it). Good-bye Eshell."
(interactive)
(if (not eshell-kill-on-exit)
(bury-buffer)
(kill-buffer (current-buffer))))
(defun eshell-truncate-buffer ()
"Truncate the buffer to `eshell-buffer-maximum-lines'.
This function could be on `eshell-output-filter-functions' or bound to
a key."
(interactive)
(save-excursion
(goto-char eshell-last-output-end)
(let ((lines (count-lines 1 (point)))
(inhibit-read-only t))
(forward-line (- eshell-buffer-maximum-lines))
(beginning-of-line)
(let ((pos (point)))
(if (bobp)
(if (interactive-p)
(message "Buffer too short to truncate"))
(delete-region (point-min) (point))