Commit | Line | Data |
---|---|---|
60370d40 | 1 | ;;; esh-module.el --- Eshell modules |
affbf647 | 2 | |
5fd6d89f | 3 | ;; Copyright (C) 1999, 2000, 2002, 2003, 2004, |
8b72699e | 4 | ;; 2005, 2006, 2007, 2008 Free Software Foundation, Inc. |
affbf647 | 5 | |
04f9dc47 SM |
6 | ;; Author: John Wiegley <johnw@gnu.org> |
7 | ;; Keywords: processes | |
04f9dc47 | 8 | |
affbf647 GM |
9 | ;; This file is part of GNU Emacs. |
10 | ||
11 | ;; GNU Emacs is free software; you can redistribute it and/or modify | |
12 | ;; it under the terms of the GNU General Public License as published by | |
e0085d62 | 13 | ;; the Free Software Foundation; either version 3, or (at your option) |
affbf647 GM |
14 | ;; any later version. |
15 | ||
16 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
17 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
18 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
19 | ;; GNU General Public License for more details. | |
20 | ||
21 | ;; You should have received a copy of the GNU General Public License | |
22 | ;; along with GNU Emacs; see the file COPYING. If not, write to the | |
3a35cf56 LK |
23 | ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, |
24 | ;; Boston, MA 02110-1301, USA. | |
affbf647 | 25 | |
fa31eac3 GM |
26 | ;;; Code: |
27 | ||
affbf647 GM |
28 | (provide 'esh-module) |
29 | ||
dace60cf | 30 | (eval-when-compile |
fa31eac3 GM |
31 | (require 'cl) |
32 | (require 'esh-util)) | |
33 | ||
34 | (require 'esh-util) | |
affbf647 GM |
35 | |
36 | (defgroup eshell-module nil | |
37 | "The `eshell-module' group is for Eshell extension modules, which | |
38 | provide optional behavior which the user can enable or disable by | |
39 | customizing the variable `eshell-modules-list'." | |
40 | :tag "Extension modules" | |
41 | :group 'eshell) | |
42 | ||
fa31eac3 | 43 | (eval-and-compile |
affbf647 GM |
44 | (defun eshell-load-defgroups (&optional directory) |
45 | "Load `defgroup' statements from Eshell's module files." | |
0c2222fa MB |
46 | (let ((vc-handled-backends nil)) ; avoid VC fucking things up |
47 | (with-current-buffer | |
48 | (find-file-noselect (expand-file-name "esh-groups.el" directory)) | |
49 | (erase-buffer) | |
50 | (insert ";;; do not modify this file; it is auto-generated -*- no-byte-compile: t -*-\n\n") | |
51 | (let ((files (directory-files (or directory | |
52 | (car command-line-args-left)) | |
53 | nil "\\`em-.*\\.el\\'"))) | |
54 | (while files | |
55 | (message "Loading defgroup from `%s'" (car files)) | |
56 | (let (defgroup) | |
57 | (catch 'handled | |
58 | (with-current-buffer (find-file-noselect (car files)) | |
59 | (goto-char (point-min)) | |
60 | (while t | |
affbf647 | 61 | (forward-sexp) |
0c2222fa MB |
62 | (if (eobp) (throw 'handled t)) |
63 | (backward-sexp) | |
64 | (let ((begin (point)) | |
65 | (defg (looking-at "(defgroup"))) | |
66 | (forward-sexp) | |
67 | (if defg | |
68 | (setq defgroup (buffer-substring begin (point)))))))) | |
69 | (if defgroup | |
70 | (insert defgroup "\n\n"))) | |
71 | (setq files (cdr files)))) | |
4e60b1b6 EZ |
72 | ;; Don't make backups, to avoid prompting the user if there are |
73 | ;; excess backup versions. | |
fa31eac3 | 74 | (save-buffer 0))))) |
affbf647 GM |
75 | |
76 | ;; load the defgroup's for the standard extension modules, so that | |
77 | ;; documentation can be provided when the user customize's | |
78 | ;; `eshell-modules-list'. | |
79 | (eval-when-compile | |
60d2b434 EZ |
80 | (when (and (boundp 'byte-compile-current-file) |
81 | byte-compile-current-file | |
5514ba5c EZ |
82 | (or |
83 | (equal (file-name-nondirectory byte-compile-current-file) | |
84 | "esh-module.el") | |
85 | ;; When eshell file names are expanded from a wildcard | |
86 | ;; or by reading the Eshell directory, e.g. when they | |
87 | ;; say "make recompile" in the lisp directory, Emacs on | |
88 | ;; MS-DOS sees a truncated name "esh-modu.el" instead of | |
89 | ;; "esh-module.el". | |
90 | (and (fboundp 'msdos-long-file-names) | |
91 | (null (msdos-long-file-names)) | |
92 | (equal (file-name-nondirectory byte-compile-current-file) | |
93 | "esh-modu.el")))) | |
affbf647 | 94 | (let* ((directory (file-name-directory byte-compile-current-file)) |
dace60cf | 95 | (elc-file (expand-file-name "esh-groups.elc" directory))) |
affbf647 GM |
96 | (eshell-load-defgroups directory) |
97 | (if (file-exists-p elc-file) (delete-file elc-file))))) | |
98 | ||
99 | (load "esh-groups" t t) | |
100 | ||
101 | ;;; User Variables: | |
102 | ||
103 | (defcustom eshell-module-unload-hook | |
104 | '(eshell-unload-extension-modules) | |
105 | "*A hook run when `eshell-module' is unloaded." | |
106 | :type 'hook | |
107 | :group 'eshell-module) | |
108 | ||
109 | (defcustom eshell-modules-list | |
110 | '(eshell-alias | |
111 | eshell-banner | |
112 | eshell-basic | |
113 | eshell-cmpl | |
114 | eshell-dirs | |
115 | eshell-glob | |
116 | eshell-hist | |
117 | eshell-ls | |
118 | eshell-pred | |
119 | eshell-prompt | |
120 | eshell-script | |
121 | eshell-term | |
122 | eshell-unix) | |
123 | "*A list of optional add-on modules to be loaded by Eshell. | |
124 | Changes will only take effect in future Eshell buffers." | |
125 | :type (append | |
126 | (list 'set ':tag "Supported modules") | |
127 | (mapcar | |
128 | (function | |
129 | (lambda (modname) | |
130 | (let ((modsym (intern modname))) | |
131 | (list 'const | |
132 | ':tag (format "%s -- %s" modname | |
133 | (get modsym 'custom-tag)) | |
134 | ':link (caar (get modsym 'custom-links)) | |
135 | ':doc (concat "\n" (get modsym 'group-documentation) | |
136 | "\n ") | |
137 | modsym)))) | |
138 | (sort (mapcar 'symbol-name | |
139 | (eshell-subgroups 'eshell-module)) | |
140 | 'string-lessp)) | |
141 | '((repeat :inline t :tag "Other modules" symbol))) | |
142 | :group 'eshell-module) | |
143 | ||
144 | ;;; Code: | |
145 | ||
146 | (defsubst eshell-using-module (module) | |
147 | "Return non-nil if a certain Eshell MODULE is in use. | |
148 | The MODULE should be a symbol corresponding to that module's | |
149 | customization group. Example: `eshell-cmpl' for that module." | |
150 | (memq module eshell-modules-list)) | |
151 | ||
152 | (defun eshell-unload-extension-modules () | |
153 | "Unload any memory resident extension modules." | |
154 | (eshell-for module (eshell-subgroups 'eshell-module) | |
155 | (if (featurep module) | |
156 | (ignore-errors | |
157 | (message "Unloading %s..." (symbol-name module)) | |
158 | (unload-feature module) | |
159 | (message "Unloading %s...done" (symbol-name module)))))) | |
160 | ||
cbee283d | 161 | ;; arch-tag: 97a3fa16-9d08-40e6-bc2c-36bd70986507 |
affbf647 | 162 | ;;; esh-module.el ends here |