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