Synch with Oort Gnus.
[elisp/gnus.git-] / lisp / dgnushack.el
1 ;;; dgnushack.el --- a hack to set the load path for byte-compiling
2 ;; Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001
3 ;;        Free Software Foundation, Inc.
4
5 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
6 ;;      Katsumi Yamaoka <yamaoka@jpl.org>
7 ;; Version: 4.19
8 ;; Keywords: news, path
9
10 ;; This file is part of GNU Emacs.
11
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; any later version.
16
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20 ;; GNU General Public License for more details.
21
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
24 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25 ;; Boston, MA 02111-1307, USA.
26
27 ;;; Commentary:
28
29 ;;; Code:
30
31 ;; Set coding priority of Shift-JIS to the bottom.
32 (if (featurep 'xemacs)
33     (defalias 'set-coding-priority 'ignore)
34   (defalias 'coding-priority-list 'ignore)
35   (defalias 'set-coding-priority-list 'ignore))
36 (cond ((and (featurep 'xemacs) (featurep 'mule))
37        (if (memq 'shift-jis (coding-priority-list))
38            (set-coding-priority-list
39             (append (delq 'shift-jis (coding-priority-list)) '(shift-jis)))))
40       ((boundp 'MULE)
41        (put '*coding-category-sjis* 'priority (length *predefined-category*)))
42       ((featurep 'mule)
43        (if (memq 'coding-category-sjis coding-category-list)
44            (set-coding-priority
45             (append (delq 'coding-category-sjis
46                           (copy-sequence coding-category-list))
47                     '(coding-category-sjis))))))
48
49 (defalias 'facep 'ignore)
50
51 (require 'cl)
52
53 (defvar srcdir (or (getenv "srcdir") "."))
54
55 (defvar dgnushack-w3-dir (let ((w3dir (getenv "W3DIR")))
56                            (unless (zerop (length w3dir))
57                              (file-name-as-directory w3dir))))
58 (when dgnushack-w3-dir
59   (push dgnushack-w3-dir load-path))
60
61 ;; If we are building w3 in a different directory than the source
62 ;; directory, we must read *.el from source directory and write *.elc
63 ;; into the building directory.  For that, we define this function
64 ;; before loading bytecomp.  Bytecomp doesn't overwrite this function.
65 (defun byte-compile-dest-file (filename)
66   "Convert an Emacs Lisp source file name to a compiled file name.
67  In addition, remove directory name part from FILENAME."
68   (setq filename (byte-compiler-base-file-name filename))
69   (setq filename (file-name-sans-versions filename))
70   (setq filename (file-name-nondirectory filename))
71   (if (memq system-type '(win32 w32 mswindows windows-nt))
72       (setq filename (downcase filename)))
73   (cond ((eq system-type 'vax-vms)
74          (concat (substring filename 0 (string-match ";" filename)) "c"))
75         ((string-match emacs-lisp-file-regexp filename)
76          (concat (substring filename 0 (match-beginning 0)) ".elc"))
77         (t (concat filename ".elc"))))
78
79 (require 'bytecomp)
80
81 (unless (fboundp 'si:byte-optimize-form-code-walker)
82   (byte-optimize-form nil);; Load `byte-opt' or `byte-optimize'.
83   (setq max-specpdl-size 3000)
84   (defalias 'si:byte-optimize-form-code-walker
85     (symbol-function 'byte-optimize-form-code-walker))
86   (defun byte-optimize-form-code-walker (form for-effect)
87     (if (and for-effect (memq (car-safe form) '(and or)))
88         ;; Fix bug in and/or forms.
89         (let ((fn (car form))
90               (backwards (reverse (cdr form))))
91           (while (and backwards
92                       (null (setcar backwards
93                                     (byte-optimize-form (car backwards) t))))
94             (setq backwards (cdr backwards)))
95           (if (and (cdr form) (null backwards))
96               (byte-compile-log
97                "  all subforms of %s called for effect; deleted" form))
98           (if backwards
99               (let ((head backwards))
100                 (while (setq backwards (cdr backwards))
101                   (setcar backwards (byte-optimize-form (car backwards)
102                                                         nil)))
103                 (cons fn (nreverse head)))))
104       (si:byte-optimize-form-code-walker form for-effect)))
105   (byte-compile 'byte-optimize-form-code-walker))
106
107 (load (expand-file-name "gnus-clfns.el" srcdir) nil t t)
108
109 (condition-case nil
110     (char-after)
111   (wrong-number-of-arguments
112    ;; Optimize byte code for `char-after'.
113    (put 'char-after 'byte-optimizer 'byte-optimize-char-after)
114    (defun byte-optimize-char-after (form)
115      (if (null (cdr form))
116          '(char-after (point))
117        form))))
118
119 (condition-case nil
120     (char-before)
121   (wrong-number-of-arguments
122    ;; Optimize byte code for `char-before'.
123    (put 'char-before 'byte-optimizer 'byte-optimize-char-before)
124    (defun byte-optimize-char-before (form)
125      (if (null (cdr form))
126          '(char-before (point))
127        form))))
128
129 (load (expand-file-name "dgnuspath.el" srcdir) nil nil t)
130
131 (condition-case err
132     (load "~/.lpath.el" t nil t)
133   (error (message "Error in \"~/.lpath.el\" file: %s" err)))
134
135 ;; Don't load path-util until `char-after' and `char-before' have been
136 ;; optimized because it requires `poe' and then modify the functions.
137 (or (featurep 'path-util)
138     (load "apel/path-util"))
139 (add-path "apel")
140 (add-path "flim")
141 (unless (module-installed-p 'mel)
142   ;; FLIM 1.14 may have installed in two "flim" subdirectories.
143   (push (expand-file-name "flim"
144                           (file-name-directory (get-latest-path "^apel$" t)))
145         load-path)
146   (unless (module-installed-p 'mel)
147     (error "
148 FLIM package does not found in %s.
149 Try to re-configure with --with-addpath=FLIM_PATH and run make again.
150 "
151            (progn
152              (add-path "semi")
153              load-path))))
154 (add-path "semi")
155
156 (push srcdir load-path)
157 (load (expand-file-name "lpath.el" srcdir) nil t t)
158
159 (require 'custom)
160
161 ;; Bind functions defined by `defun-maybe'.
162 (put 'defun-maybe 'byte-hunk-handler 'byte-compile-file-form-defun-maybe)
163 (defun byte-compile-file-form-defun-maybe (form)
164   (if (and (not (fboundp (nth 1 form)))
165            (memq 'unresolved byte-compile-warnings))
166       (setq byte-compile-function-environment
167             (cons (cons (nth 1 form)
168                         (cons 'lambda (cdr (cdr form))))
169                   byte-compile-function-environment)))
170   form)
171
172 (condition-case nil
173     :symbol-for-testing-whether-colon-keyword-is-available-or-not
174   (void-variable
175    ;; Bind keywords.
176    (dolist (keyword '(:button-keymap :data :file :mime-handle
177                                      :key-type :value-type
178                                      :ascent :foreground :help))
179      (set keyword keyword))))
180
181 ;; If you are using Mule 2.3 based on Emacs 19.34, you may also put the
182 ;; following lines in your .emacs file, before gnus related modules are
183 ;; loaded.  It is not always necessary.  However if it is done, you will
184 ;; be able to load or evaluate gnus related *.el (not compiled) files.
185 ;; ------ cut here ------ cut here ------ cut here ------ cut here ------
186 (if (boundp 'MULE)
187     (progn
188       (setq :version ':version
189             :set-after ':set-after)
190       (require 'custom)
191       (defadvice custom-handle-keyword
192         (around dont-signal-an-error-even-if-unsupported-keyword-is-given
193                 activate)
194         "Don't signal an error even if unsupported keyword is given."
195         (if (not (memq (ad-get-arg 1) '(:version :set-after)))
196             ad-do-it))))
197 ;; ------ cut here ------ cut here ------ cut here ------ cut here ------
198
199 (when (boundp 'MULE)
200   (put 'custom-declare-face 'byte-optimizer
201        'byte-optimize-ignore-unsupported-custom-keywords)
202   (put 'custom-declare-group 'byte-optimizer
203        'byte-optimize-ignore-unsupported-custom-keywords)
204   (defun byte-optimize-ignore-unsupported-custom-keywords (form)
205     (if (or (memq ':version (nthcdr 4 form))
206             (memq ':set-after (nthcdr 4 form)))
207         (let ((newform (list (car form) (nth 1 form)
208                              (nth 2 form) (nth 3 form)))
209               (args (nthcdr 4 form)))
210           (while args
211             (or (memq (car args) '(:version :set-after))
212                 (setq newform (nconc newform (list (car args)
213                                                    (car (cdr args))))))
214             (setq args (cdr (cdr args))))
215           newform)
216       form))
217
218   (put 'custom-declare-variable 'byte-hunk-handler
219        'byte-compile-file-form-custom-declare-variable)
220   (defun byte-compile-file-form-custom-declare-variable (form)
221     ;; Bind defcustom'ed variables.
222     (if (memq 'free-vars byte-compile-warnings)
223         (setq byte-compile-bound-variables
224               (cons (nth 1 (nth 1 form)) byte-compile-bound-variables)))
225     (if (memq ':version (nthcdr 4 form))
226         ;; Make the variable uncustomizable.
227         `(defvar ,(nth 1 (nth 1 form)) ,(nth 1 (nth 2 form))
228            ,(substring (nth 3 form) (if (string-match "^[\t *]+" (nth 3 form))
229                                         (match-end 0)
230                                       0)))
231       ;; Ignore unsupported keyword(s).
232       (if (memq ':set-after (nthcdr 4 form))
233           (let ((newform (list (car form) (nth 1 form)
234                                (nth 2 form) (nth 3 form)))
235                 (args (nthcdr 4 form)))
236             (while args
237               (or (eq (car args) ':set-after)
238                   (setq newform (nconc newform (list (car args)
239                                                      (car (cdr args))))))
240               (setq args (cdr (cdr args))))
241             newform)
242         form))))
243
244 ;; Unknown variables and functions.
245 (unless (boundp 'buffer-file-coding-system)
246   (defvar buffer-file-coding-system (symbol-value 'file-coding-system)))
247 (unless (featurep 'xemacs)
248   (defalias 'Custom-make-dependencies 'ignore)
249   (defalias 'update-autoloads-from-directory 'ignore))
250
251 (unless (fboundp 'with-temp-buffer)
252   ;; Pickup some macros.
253   (require 'emu))
254
255 (defalias 'device-sound-enabled-p 'ignore)
256 (defalias 'play-sound-file 'ignore)
257 (defalias 'nndb-request-article 'ignore)
258 (defalias 'efs-re-read-dir 'ignore)
259 (defalias 'ange-ftp-re-read-dir 'ignore)
260 (defalias 'define-mail-user-agent 'ignore)
261
262 (defconst dgnushack-unexporting-files
263   (append '("dgnushack.el" "dgnuspath.el" "lpath.el")
264           (unless (or (condition-case code
265                           (require 'w3-forms)
266                         (error
267                          (message "No w3: %s %s retrying..." code
268                                   (locate-library "w3-forms"))
269                          nil))
270                       ;; Maybe mis-configured Makefile is used (e.g.
271                       ;; configured for FSFmacs but XEmacs is running).
272                       (let ((lp (delete dgnushack-w3-dir
273                                         (copy-sequence load-path))))
274                         (if (let ((load-path lp))
275                               (condition-case nil
276                                   (require 'w3-forms)
277                                 (error nil)))
278                             ;; If success, fix `load-path' for compiling.
279                             (progn
280                               (setq load-path lp)
281                               (message " => fixed; W3DIR=%s"
282                                        (file-name-directory
283                                         (locate-library "w3-forms")))
284                               t)
285                           (message " => ignored")
286                           nil)))
287             '("nnweb.el" "nnlistserv.el" "nnultimate.el"
288               "nnslashdot.el" "nnwarchive.el" "webmail.el"
289               "nnwfm.el"))
290           (condition-case nil
291               (progn (require 'bbdb) nil)
292             (error '("gnus-bbdb.el")))
293           (unless (featurep 'xemacs)
294             '("gnus-xmas.el" "gnus-picon.el" "messagexmas.el"
295               "nnheaderxm.el" "smiley.el"))
296           (when (or (featurep 'xemacs) (<= emacs-major-version 20))
297             '("smiley-ems.el"))
298           (when (and (fboundp 'base64-decode-string)
299                      (subrp (symbol-function 'base64-decode-string)))
300             '("base64.el"))
301           (when (and (fboundp 'md5) (subrp (symbol-function 'md5)))
302             '("md5.el")))
303   "Files which will not be installed.")
304
305 (defconst dgnushack-exporting-files
306   (let ((files (directory-files srcdir nil "^[^=].*\\.el$" t)))
307     (dolist (file dgnushack-unexporting-files)
308       (setq files (delete file files)))
309     (sort files 'string-lessp))
310   "Files which will be compiled and installed.")
311
312 (defun dgnushack-exporting-files ()
313   "Print name of files which will be installed."
314   (princ (mapconcat 'identity dgnushack-exporting-files " ")))
315
316 (defun dgnushack-compile (&optional warn)
317   ;;(setq byte-compile-dynamic t)
318   (unless warn
319     (setq byte-compile-warnings
320           '(free-vars unresolved callargs redefine)))
321   (unless (locate-library "cus-edit")
322     (error "You do not seem to have Custom installed.
323 Fetch it from <URL:http://www.dina.kvl.dk/~abraham/custom/>.
324 You also then need to add the following to the lisp/dgnushack.el file:
325
326      (push \"~/lisp/custom\" load-path)
327
328 Modify to suit your needs."))
329
330   ;; Show `load-path'.
331   (message "load-path=(\"%s\")"
332            (mapconcat 'identity load-path "\"\n           \""))
333
334   (dolist (file dgnushack-exporting-files)
335     (setq file (expand-file-name file srcdir))
336     (when (and (file-exists-p
337                 (setq elc (concat (file-name-nondirectory file) "c")))
338                (file-newer-than-file-p file elc))
339       (delete-file elc)))
340
341   (let ((files dgnushack-exporting-files)
342         ;;(byte-compile-generate-call-tree t)
343         file elc)
344     ;; Avoid barfing (from gnus-xmas) because the etc directory is not yet
345     ;; installed.
346     (when (featurep 'xemacs)
347       (setq gnus-xmas-glyph-directory "dummy"))
348     (while (setq file (pop files))
349       (setq file (expand-file-name file srcdir))
350       (when (or (not (file-exists-p
351                       (setq elc (concat (file-name-nondirectory file) "c"))))
352                 (file-newer-than-file-p file elc))
353         (ignore-errors
354           (byte-compile-file file))))))
355
356 (defun dgnushack-recompile ()
357   (require 'gnus)
358   (byte-recompile-directory "." 0))
359
360 \f
361 (defconst dgnushack-info-file-regexp-en
362   (let ((names '("gnus" "message" "emacs-mime"))
363         regexp name)
364     (while (setq name (pop names))
365       (setq regexp (concat regexp "^" name "\\.info\\(-[0-9]+\\)?$"
366                            (when names "\\|"))))
367     regexp)
368   "Regexp matching English info files.")
369
370 (defconst dgnushack-info-file-regexp-ja
371   (let ((names '("gnus-ja" "message-ja"))
372         regexp name)
373     (while (setq name (pop names))
374       (setq regexp (concat regexp "^" name "\\.info\\(-[0-9]+\\)?$"
375                            (when names "\\|"))))
376     regexp)
377   "Regexp matching Japanese info files.")
378
379 (defun dgnushack-make-autoloads ()
380   "Make auto-autoloads.el, custom-load.el and then compile them."
381   (let ((auto-autoloads (expand-file-name "auto-autoloads.el" srcdir))
382         (custom-load (expand-file-name "custom-load.el" srcdir)))
383     (unless (and (file-exists-p auto-autoloads)
384                  (file-exists-p (concat auto-autoloads "c"))
385                  (file-newer-than-file-p (concat auto-autoloads "c")
386                                          auto-autoloads)
387                  (file-exists-p custom-load)
388                  (file-exists-p (concat custom-load "c"))
389                  (file-newer-than-file-p (concat custom-load "c")
390                                          custom-load))
391       (let (make-backup-files)
392         (message "Updating autoloads for directory %s..." default-directory)
393         (let ((generated-autoload-file auto-autoloads)
394               (si:message (symbol-function 'message))
395               noninteractive)
396           (defun message (fmt &rest args)
397             (cond ((and (string-equal "Generating autoloads for %s..." fmt)
398                         (file-exists-p (file-name-nondirectory (car args))))
399                    (funcall si:message
400                             fmt (file-name-nondirectory (car args))))
401                   ((string-equal "No autoloads found in %s" fmt))
402                   ((string-equal "Generating autoloads for %s...done" fmt))
403                   (t (apply si:message fmt args))))
404           (unwind-protect
405               (update-autoloads-from-directory default-directory)
406             (fset 'message si:message)))
407         (byte-compile-file auto-autoloads)
408         (with-temp-buffer
409           (let ((standard-output (current-buffer)))
410             (Custom-make-dependencies "."))
411           (message "%s" (buffer-string)))
412         (require 'cus-load)
413         (byte-compile-file custom-load)))))
414
415 (defun dgnushack-remove-extra-files-in-package ()
416   "Remove extra files in the lisp directory of the XEmacs package."
417   (let ((lisp-dir (expand-file-name (concat "lisp/"
418                                             ;; GNUS_PRODUCT_NAME
419                                             (cadr command-line-args-left)
420                                             "/")
421                                     ;; PACKAGEDIR
422                                     (car command-line-args-left))))
423     (when (file-directory-p lisp-dir)
424       (let (files)
425         (dolist (file dgnushack-exporting-files)
426           (setq files (nconc files (list file (concat file "c")))))
427         (dolist (file (directory-files lisp-dir nil nil t t))
428           (unless (member file files)
429             (setq file (expand-file-name file lisp-dir))
430             (message "Removing %s..." file)
431             (condition-case nil
432                 (delete-file file)
433               (error nil))))))))
434
435 (defun dgnushack-install-package-manifest ()
436   "Install MANIFEST file as an XEmacs package."
437   (let* ((package-dir (car command-line-args-left))
438          (product-name (cadr command-line-args-left))
439          (name (expand-file-name (concat "pkginfo/MANIFEST." product-name)
440                                  package-dir))
441          make-backup-files)
442     (message "Generating %s..." name)
443     (with-temp-file name
444       (insert "pkginfo/MANIFEST." product-name "\n")
445       (let ((lisp-dir (concat "lisp/" product-name "/"))
446             (files (sort (directory-files "." nil "\\.elc?$" t) 'string-lessp))
447             file)
448         (while (setq file (pop files))
449           (unless (member file dgnushack-unexporting-files)
450             (insert lisp-dir file "\n")))
451         (setq files
452               (sort (directory-files "../texi/" nil
453                                      (concat dgnushack-info-file-regexp-en
454                                              "\\|"
455                                              dgnushack-info-file-regexp-ja)
456                                      t)
457                     'string-lessp))
458         (while (setq file (pop files))
459           (insert "info/" file "\n"))))))
460
461 \f
462 (define-compiler-macro describe-key-briefly (&whole form key &optional insert)
463   (if (condition-case nil
464           (progn
465             (describe-key-briefly '((())) nil)
466             t)
467         (wrong-number-of-arguments nil);; Old Emacsen.
468         (error t))
469       form
470     (if insert
471         `(if ,insert
472              (insert (funcall 'describe-key-briefly ,key))
473            (funcall 'describe-key-briefly ,key))
474       `(funcall 'describe-key-briefly ,key))))
475
476 ;;; dgnushack.el ends here