874207ad619373410fe0eb0279b6ccce249722f8
[gnus] / 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, 2003,
3 ;; 2004, 2005, 2006, 2007, 2008
4 ;;        Free Software Foundation, Inc.
5
6 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.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 3, 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., 51 Franklin Street, Fifth Floor,
25 ;; Boston, MA 02110-1301, USA.
26
27 ;;; Commentary:
28
29 ;;; Code:
30
31 (defvar dgnushack-default-load-path (copy-sequence load-path))
32
33 (defalias 'facep 'ignore)
34
35 (require 'cl)
36
37 (defvar srcdir (or (getenv "srcdir") "."))
38 (defvar loaddir (and load-file-name (file-name-directory load-file-name)))
39
40 (defun my-getenv (str)
41   (let ((val (getenv str)))
42     (if (equal val "no") nil val)))
43
44 (if (my-getenv "lispdir")
45     (push (my-getenv "lispdir") load-path))
46
47 (push (or (my-getenv "URLDIR") (expand-file-name "../../url/lisp/" loaddir))
48       load-path)
49
50 (push (or (my-getenv "W3DIR") (expand-file-name "../../w3/lisp/" loaddir))
51       load-path)
52
53 ;(push "/usr/share/emacs/site-lisp" load-path)
54
55 ;; If we are building w3 in a different directory than the source
56 ;; directory, we must read *.el from source directory and write *.elc
57 ;; into the building directory.  For that, we define this function
58 ;; before loading bytecomp.  Bytecomp doesn't overwrite this function.
59 (defun byte-compile-dest-file (filename)
60   "Convert an Emacs Lisp source file name to a compiled file name.
61  In addition, remove directory name part from FILENAME."
62   (setq filename (byte-compiler-base-file-name filename))
63   (setq filename (file-name-sans-versions filename))
64   (setq filename (file-name-nondirectory filename))
65   (if (memq system-type '(win32 w32 mswindows windows-nt))
66       (setq filename (downcase filename)))
67   (cond ((eq system-type 'vax-vms)
68          (concat (substring filename 0 (string-match ";" filename)) "c"))
69         ((string-match emacs-lisp-file-regexp filename)
70          (concat (substring filename 0 (match-beginning 0)) ".elc"))
71         (t (concat filename ".elc"))))
72
73 (require 'bytecomp)
74 ;; To avoid having defsubsts and inlines happen.
75 ;(if (featurep 'xemacs)
76 ;    (require 'byte-optimize)
77 ;  (require 'byte-opt))
78 ;(defun byte-optimize-inline-handler (form)
79 ;  "byte-optimize-handler for the `inline' special-form."
80 ;  (cons 'progn (cdr form)))
81 ;(defalias 'byte-compile-file-form-defsubst 'byte-compile-file-form-defun)
82
83 (when (and (not (featurep 'xemacs))
84            (= emacs-major-version 21)
85            (>= emacs-minor-version 3)
86            (condition-case code
87                (let ((byte-compile-error-on-warn t))
88                  (byte-optimize-form (quote (pop x)) t)
89                  nil)
90              (error (string-match "called for effect"
91                                   (error-message-string code)))))
92   (defadvice byte-optimize-form-code-walker (around silence-warn-for-pop
93                                                     (form for-effect)
94                                                     activate)
95     "Silence the warning \"...called for effect\" for the `pop' form.
96 It is effective only when the `pop' macro is defined by cl.el rather
97 than subr.el."
98     (let (tmp)
99       (if (and (eq (car-safe form) 'car)
100                for-effect
101                (setq tmp (get 'car 'side-effect-free))
102                (not byte-compile-delete-errors)
103                (not (eq tmp 'error-free))
104                (eq (car-safe (cadr form)) 'prog1)
105                (let ((var (cadr (cadr form)))
106                      (last (nth 2 (cadr form))))
107                  (and (symbolp var)
108                       (null (nthcdr 3 (cadr form)))
109                       (eq (car-safe last) 'setq)
110                       (eq (cadr last) var)
111                       (eq (car-safe (nth 2 last)) 'cdr)
112                       (eq (cadr (nth 2 last)) var))))
113           (progn
114             (put 'car 'side-effect-free 'error-free)
115             (unwind-protect
116                 ad-do-it
117               (put 'car 'side-effect-free tmp)))
118         ad-do-it))))
119
120 (when (and (not (featurep 'xemacs))
121            (byte-optimize-form
122             '(and (> 0 1)
123                   (message "This should not appear in the byte-code."))
124             t))
125   (defadvice byte-optimize-form-code-walker
126     (around fix-bug-in-and/or-forms (form for-effect) activate)
127     "Optimize the rest of the and/or forms.
128 It has been fixed in XEmacs before releasing 21.4 and also has been
129 fixed in Emacs 22."
130     (if (and for-effect (memq (car-safe form) '(and or)))
131         (let ((fn (car form))
132               (backwards (reverse (cdr form))))
133           (while (and backwards
134                       (null (setcar backwards
135                                     (byte-optimize-form (car backwards) t))))
136             (setq backwards (cdr backwards)))
137           (if (and (cdr form) (null backwards))
138               (byte-compile-log
139                "  all subforms of %s called for effect; deleted" form))
140           (when backwards
141             (setcdr backwards
142                     (mapcar 'byte-optimize-form (cdr backwards))))
143           (setq ad-return-value (cons fn (nreverse backwards))))
144       ad-do-it)))
145
146 ;; Work around for an incompatibility (XEmacs 21.4 vs. 21.5), see the
147 ;; following threads:
148 ;;
149 ;; http://thread.gmane.org/gmane.emacs.gnus.general/56414
150 ;; Subject: attachment problems found but not fixed
151 ;;
152 ;; http://thread.gmane.org/gmane.emacs.gnus.general/56459
153 ;; Subject: Splitting mail -- XEmacs 21.4 vs 21.5
154 ;;
155 ;; http://thread.gmane.org/gmane.emacs.xemacs.beta/20519
156 ;; Subject: XEmacs 21.5 and Gnus fancy splitting.
157 ;;
158 ;; Should be fixed in XEmacs (March 2007).
159 ;; http://thread.gmane.org/gmane.emacs.xemacs.patches/8124
160 ;; When should we remove this workaround?
161 ;;
162 (when (and (featurep 'xemacs)
163            (let ((table (copy-syntax-table emacs-lisp-mode-syntax-table)))
164              (modify-syntax-entry ?= " " table)
165              (with-temp-buffer
166                (with-syntax-table table
167                  (insert "foo=bar")
168                  (goto-char (point-min))
169                  (forward-sexp 1)
170                  (eolp)))))
171   ;; The original `with-syntax-table' uses `copy-syntax-table' which
172   ;; doesn't seem to copy modified syntax entries in XEmacs 21.5.
173   (defmacro with-syntax-table (syntab &rest body)
174     "Evaluate BODY with the SYNTAB as the current syntax table."
175     `(let ((stab (syntax-table)))
176        (unwind-protect
177            (progn
178              ;;(set-syntax-table (copy-syntax-table ,syntab))
179              (set-syntax-table ,syntab)
180              ,@body)
181          (set-syntax-table stab)))))
182
183 (push srcdir load-path)
184 (push loaddir load-path)
185 (load (expand-file-name "lpath.el" loaddir) nil t)
186
187 (defalias 'device-sound-enabled-p 'ignore)
188 (defalias 'play-sound-file 'ignore)
189 (defalias 'nndb-request-article 'ignore)
190 (defalias 'efs-re-read-dir 'ignore)
191 (defalias 'ange-ftp-re-read-dir 'ignore)
192 (defalias 'define-mail-user-agent 'ignore)
193
194 (eval-and-compile
195   (unless (featurep 'xemacs)
196     (defalias 'get-popup-menu-response 'ignore)
197     (defalias 'event-object 'ignore)
198     (defalias 'x-defined-colors 'ignore)
199     (defalias 'read-color 'ignore)))
200
201 (eval-and-compile
202   (when (featurep 'xemacs)
203     (unless (fboundp 'defadvice)
204       (autoload 'defadvice "advice" nil nil 'macro))
205     (autoload 'Info-directory "info" nil t)
206     (autoload 'Info-index "info" nil t)
207     (autoload 'Info-index-next "info" nil t)
208     (autoload 'Info-menu "info" nil t)
209     (autoload 'ad-add-advice "advice")
210     (unless (and (emacs-version>= 21 5)
211                  (not (featurep 'sxemacs)))
212       ;; calendar/auto-autoloads.el provides it.
213       (autoload 'add-to-invisibility-spec "dummy"))
214     (autoload 'annotations-at "annotations")
215     (autoload 'apropos "apropos" nil t)
216     (autoload 'apropos-command "apropos" nil t)
217     (autoload 'bbdb-complete-name "bbdb-com" nil t)
218     (autoload 'browse-url "browse-url" nil t)
219     (autoload 'browse-url-of-file "browse-url" nil t)
220     (autoload 'c-mode "cc-mode" nil t)
221     (autoload 'customize-apropos "cus-edit" nil t)
222     (autoload 'customize-group "cus-edit" nil t)
223     (autoload 'customize-save-variable "cus-edit" nil t)
224     (autoload 'customize-set-variable "cus-edit" nil t)
225     (autoload 'customize-variable "cus-edit" nil t)
226     (autoload 'debug "debug" nil t)
227     (if (featurep 'mule)
228         (unless (locate-library "mule-ccl")
229           (autoload 'define-ccl-program "ccl" nil nil 'macro))
230       (defalias 'define-ccl-program 'ignore))
231     (autoload 'delete-annotation "annotations")
232     (autoload 'dolist "cl-macs" nil nil 'macro)
233     (autoload 'enriched-decode "enriched")
234     (autoload 'eudc-expand-inline "eudc" nil t)
235     (autoload 'executable-find "executable")
236     (autoload 'font-lock-fontify-buffer "font-lock" nil t)
237     (when (and (emacs-version>= 21 5)
238                (not (featurep 'sxemacs)))
239       (autoload 'get-display-table "disp-table")
240       (autoload 'put-display-table "disp-table"))
241     (autoload 'info "info" nil t)
242     (autoload 'mail-extract-address-components "mail-extr")
243     (autoload 'mail-fetch-field "mail-utils")
244     (autoload 'make-annotation "annotations")
245     (autoload 'make-display-table "disp-table")
246     (autoload 'pgg-snarf-keys-region "pgg" nil t)
247     (autoload 'pp "pp")
248     (autoload 'ps-despool "ps-print" nil t)
249     (autoload 'ps-spool-buffer "ps-print" nil t)
250     (autoload 'ps-spool-buffer-with-faces "ps-print" nil t)
251     (autoload 'read-passwd "passwd")
252     (autoload 'regexp-opt "regexp-opt")
253     (autoload 'reporter-submit-bug-report "reporter")
254     (if (and (emacs-version>= 21 5)
255              (not (featurep 'sxemacs)))
256         (autoload 'setenv "process" nil t)
257       (autoload 'setenv "env" nil t))
258     (autoload 'sgml-mode "psgml" nil t)
259     (autoload 'smtpmail-send-it "smtpmail")
260     (autoload 'sort-numeric-fields "sort" nil t)
261     (autoload 'sort-subr "sort")
262     (autoload 'thing-at-point "thingatpt")
263     (autoload 'toggle-truncate-lines "view-less" nil t)
264     (autoload 'trace-function-background "trace" nil t)
265     (autoload 'unmorse-region "morse" nil t)
266     (autoload 'w3-do-setup "w3")
267     (autoload 'w3-prepare-buffer "w3-display")
268     (autoload 'w3-region "w3-display" nil t)
269     (defalias 'frame-char-height 'frame-height)
270     (defalias 'frame-char-width 'frame-width)
271     (defalias 'frame-parameter 'frame-property)
272     (defalias 'make-overlay 'ignore)
273     (defalias 'overlay-end 'ignore)
274     (defalias 'overlay-get 'ignore)
275     (defalias 'overlay-put 'ignore)
276     (defalias 'overlay-start 'ignore)
277     (defalias 'overlays-in 'ignore)
278     (defalias 'replace-dehighlight 'ignore)
279     (defalias 'replace-highlight 'ignore)
280     (defalias 'w3-coding-system-for-mime-charset 'ignore)))
281
282 (defun dgnushack-emacs-compile-defcustom-p ()
283   "Return non-nil if Emacs byte compiles `defcustom' forms.
284 Those Emacsen will warn against undefined variables and functions used
285 in `defcustom' forms."
286   (let ((outbuf (with-temp-buffer
287                   (insert "(defcustom foo (1+ (random)) \"\" :group 'emacs)\n")
288                   (byte-compile-from-buffer (current-buffer) "foo.el"))))
289     (when outbuf
290       (prog1
291           (with-current-buffer outbuf
292             (goto-char (point-min))
293             (search-forward " 'foo '(byte-code " nil t))
294         (kill-buffer outbuf)))))
295
296 (when (dgnushack-emacs-compile-defcustom-p)
297   (maybe-fbind '(defined-colors face-attribute))
298   (maybe-bind '(idna-program installation-directory)))
299
300 (defun dgnushack-compile-verbosely ()
301   "Call dgnushack-compile with warnings ENABLED.  If you are compiling
302 patches to gnus, you should consider modifying make.bat to call
303 dgnushack-compile-verbosely.  All other users should continue to use
304 dgnushack-compile."
305   (dgnushack-compile t))
306
307 (defun dgnushack-compile (&optional warn)
308   ;;(setq byte-compile-dynamic t)
309   (unless warn
310     (setq byte-compile-warnings
311           '(free-vars unresolved callargs redefine)))
312   (let ((files (directory-files srcdir nil "^[^=].*\\.el$"))
313         ;;(byte-compile-generate-call-tree t)
314         file elc)
315     ;; Avoid barfing (from gnus-xmas) because the etc directory is not yet
316     ;; installed.
317     (when (featurep 'xemacs)
318       (setq gnus-xmas-glyph-directory "dummy"))
319     (dolist (file '("dgnushack.el" "lpath.el"))
320       (setq files (delete file files)))
321     (when (featurep 'base64)
322       (setq files (delete "base64.el" files)))
323     (condition-case code
324         (require 'w3-parse)
325       (error
326        (message "No w3: %s %s" (cadr code) (or (locate-library "w3-parse") ""))
327        (dolist (file '("nnultimate.el" "webmail.el" "nnwfm.el"))
328          (setq files (delete file files)))))
329     (condition-case code
330         (require 'mh-e)
331       (error
332        (message "No mh-e: %s %s" (cadr code) (or (locate-library "mh-e") ""))
333        (setq files (delete "gnus-mh.el" files))))
334     (condition-case code
335         (require 'xml)
336       (error
337        (message "No xml: %s %s" (cadr code) (or (locate-library "xml") ""))
338        (setq files (delete "nnrss.el" files))))
339     (dolist (file
340              (if (featurep 'xemacs)
341                  '("md5.el")
342                '("gnus-xmas.el" "messagexmas.el" "nnheaderxm.el")))
343       (setq files (delete file files)))
344
345     (dolist (file files)
346       (setq file (expand-file-name file srcdir))
347       (when (and (file-exists-p
348                   (setq elc (concat (file-name-nondirectory file) "c")))
349                  (file-newer-than-file-p file elc))
350         (delete-file elc)))
351
352     (while (setq file (pop files))
353       (setq file (expand-file-name file srcdir))
354       (when (or (not (file-exists-p
355                       (setq elc (concat (file-name-nondirectory file) "c"))))
356                 (file-newer-than-file-p file elc))
357         (ignore-errors
358           (byte-compile-file file))))))
359
360 (defun dgnushack-recompile ()
361   (require 'gnus)
362   (byte-recompile-directory "." 0))
363
364 (defvar dgnushack-gnus-load-file
365   (if (featurep 'xemacs)
366       (expand-file-name "auto-autoloads.el")
367     (expand-file-name "gnus-load.el")))
368
369 (defvar dgnushack-cus-load-file 
370   (if (featurep 'xemacs)
371       (expand-file-name "custom-load.el")
372     (expand-file-name "cus-load.el")))
373
374 (defun dgnushack-make-cus-load ()
375   (load "cus-dep")
376   (let ((cusload-base-file dgnushack-cus-load-file))
377     (if (fboundp 'custom-make-dependencies)
378         (custom-make-dependencies)
379       (Custom-make-dependencies))
380     (when (featurep 'xemacs)
381       (message "Compiling %s..." dgnushack-cus-load-file)
382       (byte-compile-file dgnushack-cus-load-file))))
383
384 (defun dgnushack-make-auto-load ()
385   (require 'autoload)
386   (unless (make-autoload '(define-derived-mode child parent name
387                             "docstring" body)
388                          "file")
389     (defadvice make-autoload (around handle-define-derived-mode activate)
390       "Handle `define-derived-mode'."
391       (if (eq (car-safe (ad-get-arg 0)) 'define-derived-mode)
392           (setq ad-return-value
393                 (list 'autoload
394                       (list 'quote (nth 1 (ad-get-arg 0)))
395                       (ad-get-arg 1)
396                       (nth 4 (ad-get-arg 0))
397                       t nil))
398         ad-do-it))
399     (put 'define-derived-mode 'doc-string-elt 3))
400   (let ((generated-autoload-file dgnushack-gnus-load-file)
401         (make-backup-files nil)
402         (autoload-package-name "gnus"))
403     (if (featurep 'xemacs)
404         (if (file-exists-p generated-autoload-file)
405             (delete-file generated-autoload-file))
406       (with-temp-file generated-autoload-file
407         (insert ?\014)))
408     (batch-update-autoloads)))
409
410 (defun dgnushack-make-load ()
411   (unless (featurep 'xemacs)
412     (message "Generating %s..." dgnushack-gnus-load-file)
413     (with-temp-file dgnushack-gnus-load-file
414       (insert-file-contents dgnushack-cus-load-file)
415       (delete-file dgnushack-cus-load-file)
416       (goto-char (point-min))
417       (search-forward ";;; Code:")
418       (forward-line)
419       (delete-region (point-min) (point))
420       (insert "\
421 ;;; gnus-load.el --- automatically extracted custom dependencies and autoload
422 ;;
423 ;;; Code:
424 ")
425       (goto-char (point-max))
426       (if (search-backward "custom-versions-load-alist" nil t)
427           (forward-line -1)
428         (forward-line -1)
429         (while (eq (char-after) ?\;)
430           (forward-line -1))
431         (forward-line))
432       (delete-region (point) (point-max))
433       (insert "\n")
434       ;; smiley-* are duplicated. Remove them all.
435       (let ((point (point)))
436         (insert-file-contents dgnushack-gnus-load-file)
437         (goto-char point)
438         (while (search-forward "smiley-" nil t)
439           (beginning-of-line)
440           (if (looking-at "(autoload ")
441               (delete-region (point) (progn (forward-sexp) (point)))
442             (forward-line))))
443       ;;
444       (goto-char (point-max))
445       (when (search-backward "\n(provide " nil t)
446         (forward-line -1)
447         (delete-region (point) (point-max)))
448       (insert "\
449
450 \(provide 'gnus-load)
451
452 ;;; Local Variables:
453 ;;; version-control: never
454 ;;; no-byte-compile: t
455 ;;; no-update-autoloads: t
456 ;;; End:
457 ;;; gnus-load.el ends here
458 ")
459       ))
460   (message "Compiling %s..." dgnushack-gnus-load-file)
461   (byte-compile-file dgnushack-gnus-load-file)
462   (when (featurep 'xemacs)
463     (message "Creating dummy gnus-load.el...")
464     (with-temp-file (expand-file-name "gnus-load.el")
465       (insert "\
466
467 \(provide 'gnus-load)
468
469 ;;; Local Variables:
470 ;;; version-control: never
471 ;;; no-byte-compile: t
472 ;;; no-update-autoloads: t
473 ;;; End:
474 ;;; gnus-load.el ends here"))))
475
476 (defun dgnushack-find-lisp-shadows (&optional lispdir)
477   "Return a list of directories in which other Gnus installations exist.
478 This function looks for the other Gnus installations which will shadow
479 the new Gnus Lisp modules which have been installed in LISPDIR, using
480 the default `load-path'.  The return value will make sense only when
481 LISPDIR is existent and is listed in the default `load-path'.  Assume
482 LISPDIR will be prepended to `load-path' by a user if the default
483 `load-path' does not contain it."
484   (unless lispdir
485     (setq lispdir (getenv "lispdir")))
486   (when (and lispdir (file-directory-p lispdir))
487     (setq lispdir (file-truename (directory-file-name lispdir)))
488     (let ((indices '("gnus.elc" "gnus.el" "gnus.el.bz2" "gnus.el.gz"
489                      "message.elc" "message.el" "message.el.bz2"
490                      "message.el.gz"))
491           (path (delq nil (mapcar
492                            (lambda (p)
493                              (condition-case nil
494                                  (when (and p (file-directory-p p))
495                                    (file-truename (directory-file-name p)))
496                                (error nil)))
497                            dgnushack-default-load-path)))
498           rest elcs)
499       (while path
500         (setq rest (cons (car path) rest)
501               path (delete (car rest) (cdr path))))
502       (setq path (nreverse (cdr (member lispdir rest)))
503             rest nil)
504       (while path
505         (setq elcs indices)
506         (while elcs
507           (when (file-exists-p (expand-file-name (pop elcs) (car path)))
508             (setq rest (cons (car path) rest)
509                   elcs nil)))
510         (setq path (cdr path)))
511       (prog1
512           (setq path (nreverse rest))
513         (when path
514           (let (print-level print-length)
515             (princ (concat "\n\
516 WARNING: The other Gnus installation" (if (cdr path) "s have" " has") "\
517  been detected in:\n\n  " (mapconcat 'identity path "\n  ") "\n\n\
518 You will need to modify the run-time `load-path', remove them manually,
519 or remove them using `make remove-installed-shadows'.\n\n"))))))))
520
521 (defun dgnushack-remove-lisp-shadows (&optional lispdir)
522   "Remove the other Gnus installations which shadow the recent one."
523   (let ((path (with-temp-buffer
524                 (let ((standard-output (current-buffer)))
525                   (dgnushack-find-lisp-shadows lispdir))))
526         elcs files shadows file)
527     (when path
528       (unless (setq elcs (directory-files srcdir nil "\\.elc\\'"))
529         (error "You should build .elc files first."))
530       (setq files
531             (apply
532              'append
533              (mapcar
534               (lambda (el)
535                 (list (concat el "c") el (concat el ".bz2") (concat el ".gz")))
536               (append
537                (list (file-name-nondirectory dgnushack-gnus-load-file)
538                      (file-name-nondirectory dgnushack-cus-load-file))
539                (mapcar (lambda (elc) (substring elc 0 -1)) elcs)))))
540       (while path
541         (setq shadows files)
542         (while shadows
543           (setq file (expand-file-name (pop shadows) (car path)))
544           (when (file-exists-p file)
545             (princ (concat "  Removing " file "..."))
546             (condition-case nil
547                 (progn
548                   (delete-file file)
549                   (princ "done\n"))
550               (error (princ "failed\n")))))
551         (setq path (cdr path))))))
552
553 ;;; dgnushack.el ends here
554
555 ;;; arch-tag: 579f585a-24eb-4e1c-8d34-4808e11b68f2