gnus-notifications: add actions support
[gnus] / lisp / dgnushack.el
1 ;;; dgnushack.el --- a hack to set the load path for byte-compiling
2 ;; Copyright (C) 1994-2012 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.  If not, see <http://www.gnu.org/licenses/>.
22
23 ;;; Commentary:
24
25 ;;; Code:
26
27 (defvar dgnushack-default-load-path (copy-sequence load-path))
28
29 (defalias 'facep 'ignore)
30
31 (require 'cl)
32 (require 'iswitchb)
33
34 (condition-case nil
35     (require 'org-entities)
36   (error nil))
37
38 (defvar srcdir (or (getenv "srcdir") "."))
39 (defvar loaddir (and load-file-name (file-name-directory load-file-name)))
40
41 (defun my-getenv (str)
42   (let ((val (getenv str)))
43     (if (equal val "no") nil val)))
44
45 (if (my-getenv "lispdir")
46     (push (my-getenv "lispdir") load-path))
47
48 (push (or (my-getenv "URLDIR") (expand-file-name "../../url/lisp/" loaddir))
49       load-path)
50
51 (push (or (my-getenv "W3DIR") (expand-file-name "../../w3/lisp/" loaddir))
52       load-path)
53
54 ;(push "/usr/share/emacs/site-lisp" load-path)
55
56 ;; If we are building w3 in a different directory than the source
57 ;; directory, we must read *.el from source directory and write *.elc
58 ;; into the building directory.  For that, we define this function
59 ;; before loading bytecomp.  Bytecomp doesn't overwrite this function.
60 (defun byte-compile-dest-file (filename)
61   "Convert an Emacs Lisp source file name to a compiled file name.
62  In addition, remove directory name part from FILENAME."
63   (setq filename (byte-compiler-base-file-name filename))
64   (setq filename (file-name-sans-versions filename))
65   (setq filename (file-name-nondirectory filename))
66   (if (eq system-type 'windows-nt)
67       (setq filename (downcase filename)))
68   (cond ((eq system-type 'vax-vms)
69          (concat (substring filename 0 (string-match ";" filename)) "c"))
70         ((string-match emacs-lisp-file-regexp filename)
71          (concat (substring filename 0 (match-beginning 0)) ".elc"))
72         (t (concat filename ".elc"))))
73
74 (require 'bytecomp)
75 ;; To avoid having defsubsts and inlines happen.
76 ;(if (featurep 'xemacs)
77 ;    (require 'byte-optimize)
78 ;  (require 'byte-opt))
79 ;(defun byte-optimize-inline-handler (form)
80 ;  "byte-optimize-handler for the `inline' special-form."
81 ;  (cons 'progn (cdr form)))
82 ;(defalias 'byte-compile-file-form-defsubst 'byte-compile-file-form-defun)
83
84 ;; Work around for an incompatibility (XEmacs 21.4 vs. 21.5), see the
85 ;; following threads:
86 ;;
87 ;; http://thread.gmane.org/gmane.emacs.gnus.general/56414
88 ;; Subject: attachment problems found but not fixed
89 ;;
90 ;; http://thread.gmane.org/gmane.emacs.gnus.general/56459
91 ;; Subject: Splitting mail -- XEmacs 21.4 vs 21.5
92 ;;
93 ;; http://thread.gmane.org/gmane.emacs.xemacs.beta/20519
94 ;; Subject: XEmacs 21.5 and Gnus fancy splitting.
95 ;;
96 ;; Should be fixed in XEmacs (March 2007).
97 ;; http://thread.gmane.org/gmane.emacs.xemacs.patches/8124
98 ;; When should we remove this workaround?
99 ;;
100 (when (and (featurep 'xemacs)
101            (let ((table (copy-syntax-table emacs-lisp-mode-syntax-table)))
102              (modify-syntax-entry ?= " " table)
103              (with-temp-buffer
104                (with-syntax-table table
105                  (insert "foo=bar")
106                  (goto-char (point-min))
107                  (forward-sexp 1)
108                  (eolp)))))
109   ;; The original `with-syntax-table' uses `copy-syntax-table' which
110   ;; doesn't seem to copy modified syntax entries in old XEmacs 21.5.
111   (defmacro with-syntax-table (syntab &rest body)
112     "Evaluate BODY with the SYNTAB as the current syntax table."
113     `(let ((stab (syntax-table)))
114        (unwind-protect
115            (progn
116              ;;(set-syntax-table (copy-syntax-table ,syntab))
117              (set-syntax-table ,syntab)
118              ,@body)
119          (set-syntax-table stab)))))
120
121 (push srcdir load-path)
122 (push loaddir load-path)
123 (load (expand-file-name "lpath.el" loaddir) nil t)
124
125 (defalias 'device-sound-enabled-p 'ignore)
126 (defalias 'play-sound-file 'ignore)
127 (defalias 'efs-re-read-dir 'ignore)
128 (defalias 'ange-ftp-re-read-dir 'ignore)
129 (defalias 'define-mail-user-agent 'ignore)
130 (defalias 'debbugs-gnu-summary-mode 'ignore)
131 (defvar debbugs-gnu-bug-number nil)
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 (boundp 'gnus-registry-enabled)
149       (defvar gnus-registry-enabled nil))
150     (unless (fboundp 'url-retrieve-synchronously)
151       (defalias 'url-retrieve-synchronously 'url-retrieve))
152     (unless (fboundp 'url-queue-retrieve)
153       (defun url-queue-retrieve (url callback &optional cbargs silent
154                                      inhibit-cookies)
155         (url-retrieve url callback cbargs)))
156     (autoload 'Info-directory "info" nil t)
157     (autoload 'Info-index "info" nil t)
158     (autoload 'Info-index-next "info" nil t)
159     (autoload 'Info-menu "info" nil t)
160     (autoload 'ad-add-advice "advice")
161     (unless (and (emacs-version>= 21 5)
162                  (not (featurep 'sxemacs)))
163       ;; calendar/auto-autoloads.el provides it.
164       (autoload 'add-to-invisibility-spec "dummy"))
165     (autoload 'annotations-at "annotations")
166     (autoload 'apropos "apropos" nil t)
167     (autoload 'apropos-command "apropos" nil t)
168     (autoload 'bbdb-complete-name "bbdb-com" nil t)
169     (autoload 'browse-url "browse-url" nil t)
170     (autoload 'browse-url-of-file "browse-url" nil t)
171     (autoload 'c-mode "cc-mode" nil t)
172     (autoload 'customize-apropos "cus-edit" nil t)
173     (autoload 'customize-group "cus-edit" nil t)
174     (autoload 'customize-save-variable "cus-edit" nil t)
175     (autoload 'customize-set-variable "cus-edit" nil t)
176     (autoload 'customize-variable "cus-edit" nil t)
177     (autoload 'debug "debug" nil t)
178     (autoload 'sha1 "sha1")
179     (if (featurep 'mule)
180         (unless (locate-library "mule-ccl")
181           (autoload 'define-ccl-program "ccl" nil nil 'macro))
182       (defalias 'define-ccl-program 'ignore))
183     (autoload 'delete-annotation "annotations")
184     (autoload 'dolist "cl-macs" nil nil 'macro)
185     (autoload 'enriched-decode "enriched")
186     (autoload 'eudc-expand-inline "eudc" nil t)
187     (autoload 'executable-find "executable")
188     (autoload 'font-lock-fontify-buffer "font-lock" nil t)
189     (when (and (emacs-version>= 21 5)
190                (not (featurep 'sxemacs)))
191       (autoload 'get-display-table "disp-table")
192       (autoload 'put-display-table "disp-table"))
193     (autoload 'info "info" nil t)
194     (autoload 'mail-extract-address-components "mail-extr")
195     (autoload 'mail-fetch-field "mail-utils")
196     (autoload 'make-annotation "annotations")
197     (autoload 'make-display-table "disp-table")
198     (autoload 'pp "pp")
199     (autoload 'ps-despool "ps-print" nil t)
200     (autoload 'ps-spool-buffer "ps-print" nil t)
201     (autoload 'ps-spool-buffer-with-faces "ps-print" nil t)
202     (autoload 'read-passwd "passwd")
203     (autoload 'regexp-opt "regexp-opt")
204     (autoload 'reporter-submit-bug-report "reporter")
205     (if (condition-case nil
206             (progn
207               (require 'rot13)
208               (not (fboundp 'rot13-string)))
209           (error nil))
210         (defmacro rot13-string (string)
211           "Return ROT13 encryption of STRING."
212           `(let ((string ,string))
213              (with-temp-buffer
214                (insert string)
215                (translate-region (point-min) (point-max) ,rot13-display-table)
216                (buffer-string)))))
217     (if (and (emacs-version>= 21 5)
218              (not (featurep 'sxemacs)))
219         (autoload 'setenv "process" nil t)
220       (autoload 'setenv "env" nil t))
221     (autoload 'sgml-mode "psgml" nil t)
222     (autoload 'smtpmail-send-it "smtpmail")
223     (autoload 'sort-numeric-fields "sort" nil t)
224     (autoload 'sort-subr "sort")
225     (autoload 'thing-at-point "thingatpt")
226     (autoload 'toggle-truncate-lines "view-less" nil t)
227     (autoload 'trace-function-background "trace" nil t)
228     (autoload 'unmorse-region "morse" nil t)
229     (autoload 'w3-do-setup "w3")
230     (autoload 'w3-prepare-buffer "w3-display")
231     (autoload 'w3-region "w3-display" nil t)
232     (defalias 'frame-char-height 'frame-height)
233     (defalias 'frame-char-width 'frame-width)
234     (defalias 'frame-parameter 'frame-property)
235     (defalias 'make-overlay 'ignore)
236     (defalias 'overlay-end 'ignore)
237     (defalias 'overlay-get 'ignore)
238     (defalias 'overlay-put 'ignore)
239     (defalias 'overlay-start 'ignore)
240     (defalias 'overlays-in 'ignore)
241     (defalias 'replace-dehighlight 'ignore)
242     (defalias 'replace-highlight 'ignore)
243     (defalias 'gnutls-available-p 'ignore)
244     (defvar timer-list nil)
245     (defvar scroll-margin 0)
246     (defalias 'w3-coding-system-for-mime-charset 'ignore)))
247
248 (defun dgnushack-emacs-compile-defcustom-p ()
249   "Return non-nil if Emacs byte compiles `defcustom' forms.
250 Those Emacsen will warn against undefined variables and functions used
251 in `defcustom' forms."
252   (let ((outbuf (with-temp-buffer
253                   (insert "(defcustom foo (1+ (random)) \"\" :group 'emacs)\n")
254                   (byte-compile-from-buffer (current-buffer) "foo.el"))))
255     (when outbuf
256       (prog1
257           (with-current-buffer outbuf
258             (goto-char (point-min))
259             (search-forward " 'foo '(byte-code " nil t))
260         (kill-buffer outbuf)))))
261
262 (when (and (featurep 'xemacs)
263            (dgnushack-emacs-compile-defcustom-p))
264   (maybe-fbind '(defined-colors face-attribute))
265   (maybe-bind '(idna-program installation-directory)))
266
267 (when (featurep 'xemacs)
268   (defadvice byte-optimize-apply (before use-mapcan (form) activate)
269     "Replace (apply 'nconc (mapcar ...)) with (mapcan ...)."
270     (let ((last (nth (1- (length form)) form)))
271       (when (and (eq last (third form))
272                  (consp last)
273                  (eq 'mapcar (car last))
274                  (equal (nth 1 form) ''nconc))
275         (setq form (cons 'mapcan (cdr last)))))))
276
277 (defun dgnushack-compile-verbosely ()
278   "Call dgnushack-compile with warnings ENABLED.  If you are compiling
279 patches to gnus, you should consider modifying make.bat to call
280 dgnushack-compile-verbosely.  All other users should continue to use
281 dgnushack-compile."
282   (dgnushack-compile t))
283
284 (defun dgnushack-compile-error-on-warn ()
285   "Call dgnushack-compile with minimal warnings, but with error-on-warn ENABLED.
286 This means that every warning will be reported as an error."
287   (unless (dgnushack-compile nil t)
288     (error "Error during byte compilation (warnings were reported as errors!).")))
289
290 (defun dgnushack-compile (&optional warn error-on-warn)
291   ;;(setq byte-compile-dynamic t)
292   (unless warn
293     (setq byte-compile-warnings
294           '(free-vars unresolved callargs redefine suspicious)))
295   (let ((files (directory-files srcdir nil "^[^=].*\\.el$"))
296         (compilesuccess t)
297         ;;(byte-compile-generate-call-tree t)
298         file elc)
299     ;; Avoid barfing (from gnus-xmas) because the etc directory is not yet
300     ;; installed.
301     (when (featurep 'xemacs)
302       (setq gnus-xmas-glyph-directory "dummy"))
303     (dolist (file '(".dir-locals.el" "dgnushack.el" "lpath.el"))
304       (setq files (delete file files)))
305     (when (featurep 'base64)
306       (setq files (delete "base64.el" files)))
307     (condition-case code
308         (require 'w3-parse)
309       (error
310        (message "No w3: %s %s" (cadr code) (or (locate-library "w3-parse") ""))
311        (dolist (file '("webmail.el" "nnwfm.el"))
312          (setq files (delete file files)))))
313     (condition-case code
314         ;; Under XEmacs 21.4 this loads easy-mmode.elc that provides
315         ;; the Emacs functions `propertize' and `replace-regexp-in-string'.
316         (require 'mh-e)
317       (error
318        (message "No mh-e: %s %s" (cadr code) (or (locate-library "mh-e") ""))
319        (setq files (delete "gnus-mh.el" files))))
320     (condition-case code
321         (require 'xml)
322       (error
323        (message "No xml: %s %s" (cadr code) (or (locate-library "xml") ""))
324        (setq files (delete "nnrss.el" files))))
325     (dolist (file
326              (if (featurep 'xemacs)
327                  '("md5.el")
328                '("gnus-xmas.el" "messagexmas.el" "nnheaderxm.el")))
329       (setq files (delete file files)))
330     (unless (and (fboundp 'libxml-parse-html-region)
331                  ;; lpath.el binds it.
332                  (not (eq (symbol-function 'libxml-parse-html-region)
333                           'ignore)))
334       (dolist (file '("color.el" "shr-color.el" "shr.el"))
335         (setq files (delete file files))))
336     (unless (locate-library "epg")
337       (setq files (delete "plstore.el" files)))
338
339     (dolist (file files)
340       (setq file (expand-file-name file srcdir))
341       (when (and (file-exists-p
342                   (setq elc (concat (file-name-nondirectory file) "c")))
343                  (file-newer-than-file-p file elc))
344         (delete-file elc)))
345
346     (while (setq file (pop files))
347       (setq file (expand-file-name file srcdir))
348       (when (or (not (file-exists-p
349                       (setq elc (concat (file-name-nondirectory file) "c"))))
350                 (file-newer-than-file-p file elc))
351         (if error-on-warn
352             (let ((byte-compile-error-on-warn t))
353               (unless (ignore-errors
354                         (byte-compile-file file))
355                 (setq compilesuccess nil)))
356           (ignore-errors
357             (byte-compile-file file)))))
358     compilesuccess))
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     (defadvice directory-files (after exclude-dir-locals activate)
378       "Exclude .dir-locals.el file."
379       (dolist (file ad-return-value)
380         (if (string-match "\\(?:\\`\\|/\\)\\.dir-locals\\.el\\'" file)
381             (setq ad-return-value (delete file ad-return-value)))))
382     (unwind-protect
383         (if (fboundp 'custom-make-dependencies)
384             (custom-make-dependencies)
385           (Custom-make-dependencies))
386       (ad-unadvise 'directory-files))
387     (when (featurep 'xemacs)
388       (message "Compiling %s..." dgnushack-cus-load-file)
389       (byte-compile-file dgnushack-cus-load-file))))
390
391 (defun dgnushack-make-auto-load ()
392   (require 'autoload)
393   (let ((generated-autoload-file dgnushack-gnus-load-file)
394         (make-backup-files nil)
395         (autoload-package-name "gnus"))
396     (if (featurep 'xemacs)
397         (if (file-exists-p generated-autoload-file)
398             (delete-file generated-autoload-file))
399       (with-temp-file generated-autoload-file
400         (insert ?\014)))
401     (defadvice directory-files (after exclude-dir-locals activate)
402       "Exclude .dir-locals.el file."
403       (dolist (file ad-return-value)
404         (if (string-match "\\(?:\\`\\|/\\)\\.dir-locals\\.el\\'" file)
405             (setq ad-return-value (delete file ad-return-value)))))
406     (unwind-protect
407         (batch-update-autoloads)
408       (ad-unadvise 'directory-files))))
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 (unless (fboundp 'with-demoted-errors)
554   (defmacro with-demoted-errors (&rest body)
555     "Run BODY and demote any errors to simple messages.
556 If `debug-on-error' is non-nil, run BODY without catching its errors.
557 This is to be used around code which is not expected to signal an error
558 but which should be robust in the unexpected case that an error is signaled."
559     (declare (debug t) (indent 0))
560     (let ((err (make-symbol "err")))
561       `(condition-case ,err
562            (progn ,@body)
563          (error (message "Error: %S" ,err) nil)))))
564
565 ;;; dgnushack.el ends here