Commit | Line | Data |
---|---|---|
ae5e4c48 | 1 | ;;; em-basic.el --- basic shell builtin commands -*- lexical-binding:t -*- |
affbf647 | 2 | |
ab422c4d | 3 | ;; Copyright (C) 1999-2013 Free Software Foundation, Inc. |
affbf647 | 4 | |
7de5b421 GM |
5 | ;; Author: John Wiegley <johnw@gnu.org> |
6 | ||
affbf647 GM |
7 | ;; This file is part of GNU Emacs. |
8 | ||
4ee57b2a | 9 | ;; GNU Emacs is free software: you can redistribute it and/or modify |
affbf647 | 10 | ;; it under the terms of the GNU General Public License as published by |
4ee57b2a GM |
11 | ;; the Free Software Foundation, either version 3 of the License, or |
12 | ;; (at your option) any later version. | |
affbf647 GM |
13 | |
14 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
15 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
16 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
17 | ;; GNU General Public License for more details. | |
18 | ||
19 | ;; You should have received a copy of the GNU General Public License | |
4ee57b2a | 20 | ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. |
affbf647 | 21 | |
affbf647 GM |
22 | ;;; Commentary: |
23 | ||
24 | ;; There are very few basic Eshell commands -- so-called builtins. | |
25 | ;; They are: echo, umask, and version. | |
26 | ;; | |
27 | ;;;_* `echo' | |
28 | ;; | |
29 | ;; The `echo' command repeats its arguments to the screen. It is | |
30 | ;; optional whether this is done in a Lisp-friendly fashion (so that | |
31 | ;; the value of echo is useful to a Lisp command using the result of | |
32 | ;; echo as an argument), or whether it should try to act like a normal | |
33 | ;; shell echo, and always result in a flat string being returned. | |
34 | ||
affbf647 GM |
35 | ;; An example of the difference is the following: |
36 | ;; | |
37 | ;; echo Hello world | |
38 | ;; | |
39 | ;; If `eshell-plain-echo-behavior' is non-nil, this will yield the | |
40 | ;; string "Hello world". If Lisp behavior is enabled, however, it | |
41 | ;; will yield a list whose two elements are the strings "Hello" and | |
42 | ;; "world". The way to write an equivalent expression for both would | |
43 | ;; be: | |
44 | ;; | |
45 | ;; echo "Hello world" | |
46 | ;; | |
47 | ;; This always returns a single string. | |
48 | ;; | |
49 | ;;;_* `umask' | |
50 | ;; | |
51 | ;; The umask command changes the default file permissions for newly | |
52 | ;; created files. It uses the same syntax as bash. | |
53 | ;; | |
54 | ;;;_* `version' | |
55 | ;; | |
56 | ;; This command reports the version number for Eshell and all its | |
57 | ;; dependent module, including the date when those modules were last | |
58 | ;; modified. | |
59 | ||
60 | ;;; Code: | |
61 | ||
f87b1284 | 62 | (require 'esh-util) |
5bbed427 | 63 | (require 'eshell) |
affbf647 GM |
64 | (require 'esh-opt) |
65 | ||
5bbed427 | 66 | ;;;###autoload |
35ff222c GM |
67 | (progn |
68 | (defgroup eshell-basic nil | |
20d7538e GM |
69 | "The \"basic\" code provides a set of convenience functions which |
70 | are traditionally considered shell builtins. Since all of the | |
71 | functionality provided by them is accessible through Lisp, they are | |
72 | not really builtins at all, but offer a command-oriented way to do the | |
73 | same thing." | |
74 | :tag "Basic shell commands" | |
35ff222c | 75 | :group 'eshell-module)) |
20d7538e GM |
76 | |
77 | (defcustom eshell-plain-echo-behavior nil | |
ec60da52 | 78 | "If non-nil, `echo' tries to behave like an ordinary shell echo. |
20d7538e GM |
79 | This comes at some detriment to Lisp functionality. However, the Lisp |
80 | equivalent of `echo' can always be achieved by using `identity'." | |
81 | :type 'boolean | |
82 | :group 'eshell-basic) | |
83 | ||
affbf647 GM |
84 | ;;; Functions: |
85 | ||
86 | (defun eshell-echo (args &optional output-newline) | |
87 | "Implementation code for a Lisp version of `echo'. | |
88 | It returns a formatted value that should be passed to `eshell-print' | |
89 | or `eshell-printn' for display." | |
90 | (if eshell-plain-echo-behavior | |
91 | (concat (apply 'eshell-flatten-and-stringify args) "\n") | |
92 | (let ((value | |
93 | (cond | |
94 | ((= (length args) 0) "") | |
95 | ((= (length args) 1) | |
96 | (car args)) | |
97 | (t | |
98 | (mapcar | |
99 | (function | |
100 | (lambda (arg) | |
101 | (if (stringp arg) | |
102 | (set-text-properties 0 (length arg) nil arg)) | |
103 | arg)) | |
104 | args))))) | |
105 | (if output-newline | |
106 | (cond | |
107 | ((stringp value) | |
108 | (concat value "\n")) | |
109 | ((listp value) | |
110 | (append value (list "\n"))) | |
111 | (t | |
112 | (concat (eshell-stringify value) "\n"))) | |
113 | value)))) | |
114 | ||
115 | (defun eshell/echo (&rest args) | |
116 | "Implementation of `echo'. See `eshell-plain-echo-behavior'." | |
117 | (eshell-eval-using-options | |
118 | "echo" args | |
119 | '((?n nil nil output-newline "terminate with a newline") | |
120 | (?h "help" nil nil "output this help screen") | |
121 | :preserve-args | |
122 | :usage "[-n] [object]") | |
123 | (eshell-echo args output-newline))) | |
124 | ||
125 | (defun eshell/printnl (&rest args) | |
c8de140b | 126 | "Print out each of the arguments, separated by newlines." |
affbf647 GM |
127 | (let ((elems (eshell-flatten-list args))) |
128 | (while elems | |
129 | (eshell-printn (eshell-echo (list (car elems)))) | |
130 | (setq elems (cdr elems))))) | |
131 | ||
132 | (defun eshell/listify (&rest args) | |
133 | "Return the argument(s) as a single list." | |
134 | (if (> (length args) 1) | |
135 | args | |
136 | (if (listp (car args)) | |
137 | (car args) | |
138 | (list (car args))))) | |
139 | ||
140 | (defun eshell/umask (&rest args) | |
141 | "Shell-like implementation of `umask'." | |
142 | (eshell-eval-using-options | |
143 | "umask" args | |
144 | '((?S "symbolic" nil symbolic-p "display umask symbolically") | |
145 | (?h "help" nil nil "display this usage message") | |
146 | :usage "[-S] [mode]") | |
147 | (if (or (not args) symbolic-p) | |
148 | (let ((modstr | |
149 | (concat "000" | |
150 | (format "%o" | |
151 | (logand (lognot (default-file-modes)) | |
152 | 511))))) | |
153 | (setq modstr (substring modstr (- (length modstr) 3))) | |
154 | (when symbolic-p | |
155 | (let ((mode (default-file-modes))) | |
156 | (setq modstr | |
157 | (format | |
158 | "u=%s,g=%s,o=%s" | |
159 | (concat (and (= (logand mode 64) 64) "r") | |
160 | (and (= (logand mode 128) 128) "w") | |
161 | (and (= (logand mode 256) 256) "x")) | |
162 | (concat (and (= (logand mode 8) 8) "r") | |
163 | (and (= (logand mode 16) 16) "w") | |
164 | (and (= (logand mode 32) 32) "x")) | |
165 | (concat (and (= (logand mode 1) 1) "r") | |
166 | (and (= (logand mode 2) 2) "w") | |
167 | (and (= (logand mode 4) 4) "x")))))) | |
168 | (eshell-printn modstr)) | |
169 | (setcar args (eshell-convert (car args))) | |
170 | (if (numberp (car args)) | |
171 | (set-default-file-modes | |
172 | (- 511 (car (read-from-string | |
173 | (concat "?\\" (number-to-string (car args))))))) | |
174 | (error "setting umask symbolically is not yet implemented")) | |
175 | (eshell-print | |
176 | "Warning: umask changed for all new files created by Emacs.\n")) | |
177 | nil)) | |
178 | ||
20d7538e | 179 | (provide 'em-basic) |
affbf647 | 180 | |
5bbed427 GM |
181 | ;; Local Variables: |
182 | ;; generated-autoload-file: "esh-groups.el" | |
183 | ;; End: | |
184 | ||
affbf647 | 185 | ;;; em-basic.el ends here |