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
|
;;; esh-module.el --- Eshell modules
;; Copyright (C) 1999, 2000 Free Software Foundation
;; Author: John Wiegley <johnw@gnu.org>
;; Keywords: processes
;; 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 2, 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; see the file COPYING. If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.
(provide 'esh-module)
(eval-when-compile
(require 'esh-maint)
(require 'cl))
(defgroup eshell-module nil
"The `eshell-module' group is for Eshell extension modules, which
provide optional behavior which the user can enable or disable by
customizing the variable `eshell-modules-list'."
:tag "Extension modules"
:group 'eshell)
;;; Commentary:
(require 'esh-util)
(defun eshell-load-defgroups (&optional directory)
"Load `defgroup' statements from Eshell's module files."
(with-current-buffer
(find-file-noselect (expand-file-name "esh-groups.el" directory))
(erase-buffer)
(insert ";;; do not modify this file; it is auto-generated\n\n")
(let ((files (directory-files (or directory
(car command-line-args-left))
nil "\\`em-.*\\.el\\'")))
(while files
(message "Loading defgroup from `%s'" (car files))
(let (defgroup)
(catch 'handled
(with-current-buffer (find-file-noselect (car files))
(goto-char (point-min))
(while t
(forward-sexp)
(if (eobp) (throw 'handled t))
(backward-sexp)
(let ((begin (point))
(defg (looking-at "(defgroup")))
(forward-sexp)
(if defg
(setq defgroup (buffer-substring begin (point))))))))
(if defgroup
(insert defgroup "\n\n")))
(setq files (cdr files))))
(save-buffer)))
;; load the defgroup's for the standard extension modules, so that
;; documentation can be provided when the user customize's
;; `eshell-modules-list'.
(eval-when-compile
(when (and (boundp 'byte-compile-current-file)
byte-compile-current-file
(or
(equal (file-name-nondirectory byte-compile-current-file)
"esh-module.el")
;; When eshell file names are expanded from a wildcard
;; or by reading the Eshell directory, e.g. when they
;; say "make recompile" in the lisp directory, Emacs on
;; MS-DOS sees a truncated name "esh-modu.el" instead of
;; "esh-module.el".
(and (fboundp 'msdos-long-file-names)
(null (msdos-long-file-names))
(equal (file-name-nondirectory byte-compile-current-file)
"esh-modu.el"))))
(let* ((directory (file-name-directory byte-compile-current-file))
(elc-file (expand-file-name "esh-groups.elc" directory)))
(eshell-load-defgroups directory)
(if (file-exists-p elc-file) (delete-file elc-file)))))
(load "esh-groups" t t)
;;; User Variables:
(defcustom eshell-module-unload-hook
'(eshell-unload-extension-modules)
"*A hook run when `eshell-module' is unloaded."
:type 'hook
:group 'eshell-module)
(defcustom eshell-modules-list
'(eshell-alias
eshell-banner
eshell-basic
eshell-cmpl
eshell-dirs
eshell-glob
eshell-hist
eshell-ls
eshell-pred
eshell-prompt
eshell-script
eshell-term
eshell-unix)
"*A list of optional add-on modules to be loaded by Eshell.
Changes will only take effect in future Eshell buffers."
:type (append
(list 'set ':tag "Supported modules")
(mapcar
(function
(lambda (modname)
(let ((modsym (intern modname)))
(list 'const
':tag (format "%s -- %s" modname
(get modsym 'custom-tag))
':link (caar (get modsym 'custom-links))
':doc (concat "\n" (get modsym 'group-documentation)
"\n ")
modsym))))
(sort (mapcar 'symbol-name
(eshell-subgroups 'eshell-module))
'string-lessp))
'((repeat :inline t :tag "Other modules" symbol)))
:group 'eshell-module)
;;; Code:
(defsubst eshell-using-module (module)
"Return non-nil if a certain Eshell MODULE is in use.
The MODULE should be a symbol corresponding to that module's
customization group. Example: `eshell-cmpl' for that module."
(memq module eshell-modules-list))
(defun eshell-unload-extension-modules ()
"Unload any memory resident extension modules."
(eshell-for module (eshell-subgroups 'eshell-module)
(if (featurep module)
(ignore-errors
(message "Unloading %s..." (symbol-name module))
(unload-feature module)
(message "Unloading %s...done" (symbol-name module))))))
;;; esh-module.el ends here
|
