cgit.sxemacs.org Git - gnus/blob - 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     (autoload 'annotations-at "annotations")
 211     (autoload 'apropos "apropos" nil t)
 212     (autoload 'apropos-command "apropos" nil t)
 213     (autoload 'bbdb-complete-name "bbdb-com" nil t)
 214     (autoload 'browse-url "browse-url" nil t)
 215     (autoload 'browse-url-of-file "browse-url" nil t)
 216     (autoload 'c-mode "cc-mode" nil t)
 217     (autoload 'customize-apropos "cus-edit" nil t)
 218     (autoload 'customize-group "cus-edit" nil t)
 219     (autoload 'customize-save-variable "cus-edit" nil t)
 220     (autoload 'customize-set-variable "cus-edit" nil t)
 221     (autoload 'customize-variable "cus-edit" nil t)
 222     (if (featurep 'mule)
 223         (unless (locate-library "mule-ccl")
 224           (autoload 'define-ccl-program "ccl" nil nil 'macro))
 225       (defalias 'define-ccl-program 'ignore))
 226     (autoload 'delete-annotation "annotations")
 227     (autoload 'dolist "cl-macs" nil nil 'macro)
 228     (autoload 'enriched-decode "enriched")
 229     (autoload 'executable-find "executable")
 230     (autoload 'font-lock-fontify-buffer "font-lock" nil t)
 231     (autoload 'info "info" nil t)
 232     (autoload 'mail-extract-address-components "mail-extr")
 233     (autoload 'mail-fetch-field "mail-utils")
 234     (autoload 'make-annotation "annotations")
 235     (autoload 'make-display-table "disp-table")
 236     (autoload 'pp "pp")
 237     (autoload 'ps-despool "ps-print" nil t)
 238     (autoload 'ps-spool-buffer "ps-print" nil t)
 239     (autoload 'ps-spool-buffer-with-faces "ps-print" nil t)
 240     (autoload 'read-passwd "passwd")
 241     (autoload 'regexp-opt "regexp-opt")
 242     (autoload 'reporter-submit-bug-report "reporter")
 243     (if (and (emacs-version>= 21 5)
 244              (not (featurep 'sxemacs)))
 245         (autoload 'setenv "process" nil t)
 246       (autoload 'setenv "env" nil t))
 247     (autoload 'sgml-mode "psgml" nil t)
 248     (autoload 'smtpmail-send-it "smtpmail")
 249     (autoload 'sort-numeric-fields "sort" nil t)
 250     (autoload 'sort-subr "sort")
 251     (autoload 'toggle-truncate-lines "view-less" nil t)
 252     (autoload 'trace-function-background "trace" nil t)
 253     (autoload 'unmorse-region "morse" nil t)
 254     (autoload 'w3-do-setup "w3")
 255     (autoload 'w3-prepare-buffer "w3-display")
 256     (autoload 'w3-region "w3-display" nil t)
 257     (defalias 'frame-char-height 'frame-height)
 258     (defalias 'frame-char-width 'frame-width)
 259     (defalias 'frame-parameter 'frame-property)
 260     (defalias 'make-overlay 'ignore)
 261     (defalias 'overlay-end 'ignore)
 262     (defalias 'overlay-get 'ignore)
 263     (defalias 'overlay-put 'ignore)
 264     (defalias 'overlay-start 'ignore)
 265     (defalias 'overlays-in 'ignore)
 266     (defalias 'replace-dehighlight 'ignore)
 267     (defalias 'replace-highlight 'ignore)
 268     (defalias 'w3-coding-system-for-mime-charset 'ignore)))
 269
 270 (defun dgnushack-emacs-compile-defcustom-p ()
 271   "Return non-nil if Emacs byte compiles `defcustom' forms.
 272 Those Emacsen will warn against undefined variables and functions used
 273 in `defcustom' forms."
 274   (let ((outbuf (with-temp-buffer
 275                   (insert "(defcustom foo (1+ (random)) \"\" :group 'emacs)\n")
 276                   (byte-compile-from-buffer (current-buffer) "foo.el"))))
 277     (when outbuf
 278       (prog1
 279           (with-current-buffer outbuf
 280             (goto-char (point-min))
 281             (search-forward " 'foo '(byte-code " nil t))
 282         (kill-buffer outbuf)))))
 283
 284 (when (dgnushack-emacs-compile-defcustom-p)
 285   (maybe-fbind '(defined-colors face-attribute))
 286   (maybe-bind '(idna-program installation-directory)))
 287
 288 (defun dgnushack-compile-verbosely ()
 289   "Call dgnushack-compile with warnings ENABLED.  If you are compiling
 290 patches to gnus, you should consider modifying make.bat to call
 291 dgnushack-compile-verbosely.  All other users should continue to use
 292 dgnushack-compile."
 293   (dgnushack-compile t))
 294
 295 (defun dgnushack-compile (&optional warn)
 296   ;;(setq byte-compile-dynamic t)
 297   (unless warn
 298     (setq byte-compile-warnings
 299           '(free-vars unresolved callargs redefine)))
 300   (let ((files (directory-files srcdir nil "^[^=].*\\.el$"))
 301         ;;(byte-compile-generate-call-tree t)
 302         file elc)
 303     ;; Avoid barfing (from gnus-xmas) because the etc directory is not yet
 304     ;; installed.
 305     (when (featurep 'xemacs)
 306       (setq gnus-xmas-glyph-directory "dummy"))
 307     (dolist (file '("dgnushack.el" "lpath.el"))
 308       (setq files (delete file files)))
 309     (when (featurep 'base64)
 310       (setq files (delete "base64.el" files)))
 311     (condition-case code
 312         (require 'w3-parse)
 313       (error
 314        (message "No w3: %s %s" (cadr code) (or (locate-library "w3-parse") ""))
 315        (dolist (file '("nnultimate.el" "webmail.el" "nnwfm.el"))
 316          (setq files (delete file files)))))
 317     (condition-case code
 318         (require 'mh-e)
 319       (error
 320        (message "No mh-e: %s %s" (cadr code) (or (locate-library "mh-e") ""))
 321        (setq files (delete "gnus-mh.el" files))))
 322     (condition-case code
 323         (require 'xml)
 324       (error
 325        (message "No xml: %s %s" (cadr code) (or (locate-library "xml") ""))
 326        (setq files (delete "nnrss.el" files))))
 327     (dolist (file
 328              (if (featurep 'xemacs)
 329                  '("md5.el")
 330                '("gnus-xmas.el" "messagexmas.el" "nnheaderxm.el")))
 331       (setq files (delete file files)))
 332
 333     (dolist (file files)
 334       (setq file (expand-file-name file srcdir))
 335       (when (and (file-exists-p
 336                   (setq elc (concat (file-name-nondirectory file) "c")))
 337                  (file-newer-than-file-p file elc))
 338         (delete-file elc)))
 339
 340     (while (setq file (pop files))
 341       (setq file (expand-file-name file srcdir))
 342       (when (or (not (file-exists-p
 343                       (setq elc (concat (file-name-nondirectory file) "c"))))
 344                 (file-newer-than-file-p file elc))
 345         (ignore-errors
 346           (byte-compile-file file))))))
 347
 348 (defun dgnushack-recompile ()
 349   (require 'gnus)
 350   (byte-recompile-directory "." 0))
 351
 352 (defvar dgnushack-gnus-load-file
 353   (if (featurep 'xemacs)
 354       (expand-file-name "auto-autoloads.el")
 355     (expand-file-name "gnus-load.el")))
 356
 357 (defvar dgnushack-cus-load-file
 358   (if (featurep 'xemacs)
 359       (expand-file-name "custom-load.el")
 360     (expand-file-name "cus-load.el")))
 361
 362 (defun dgnushack-make-cus-load ()
 363   (load "cus-dep")
 364   (let ((cusload-base-file dgnushack-cus-load-file))
 365     (if (fboundp 'custom-make-dependencies)
 366         (custom-make-dependencies)
 367       (Custom-make-dependencies))
 368     (when (featurep 'xemacs)
 369       (message "Compiling %s..." dgnushack-cus-load-file)
 370       (byte-compile-file dgnushack-cus-load-file))))
 371
 372 (defun dgnushack-make-auto-load ()
 373   (require 'autoload)
 374   (unless (make-autoload '(define-derived-mode child parent name
 375                             "docstring" body)
 376                          "file")
 377     (defadvice make-autoload (around handle-define-derived-mode activate)
 378       "Handle `define-derived-mode'."
 379       (if (eq (car-safe (ad-get-arg 0)) 'define-derived-mode)
 380           (setq ad-return-value
 381                 (list 'autoload
 382                       (list 'quote (nth 1 (ad-get-arg 0)))
 383                       (ad-get-arg 1)
 384                       (nth 4 (ad-get-arg 0))
 385                       t nil))
 386         ad-do-it))
 387     (put 'define-derived-mode 'doc-string-elt 3))
 388   (let ((generated-autoload-file dgnushack-gnus-load-file)
 389         (make-backup-files nil)
 390         (autoload-package-name "gnus"))
 391     (if (featurep 'xemacs)
 392         (if (file-exists-p generated-autoload-file)
 393             (delete-file generated-autoload-file))
 394       (with-temp-file generated-autoload-file
 395         (insert ?\014)))
 396     (batch-update-autoloads)))
 397
 398 (defun dgnushack-make-load ()
 399   (unless (featurep 'xemacs)
 400     (message "Generating %s..." dgnushack-gnus-load-file)
 401     (with-temp-file dgnushack-gnus-load-file
 402       (insert-file-contents dgnushack-cus-load-file)
 403       (delete-file dgnushack-cus-load-file)
 404       (goto-char (point-min))
 405       (search-forward ";;; Code:")
 406       (forward-line)
 407       (delete-region (point-min) (point))
 408       (insert "\
 409 ;;; gnus-load.el --- automatically extracted custom dependencies and autoload
 410 ;;
 411 ;;; Code:
 412 ")
 413       (goto-char (point-max))
 414       (if (search-backward "custom-versions-load-alist" nil t)
 415           (forward-line -1)
 416         (forward-line -1)
 417         (while (eq (char-after) ?\;)
 418           (forward-line -1))
 419         (forward-line))
 420       (delete-region (point) (point-max))
 421       (insert "\n")
 422       ;; smiley-* are duplicated. Remove them all.
 423       (let ((point (point)))
 424         (insert-file-contents dgnushack-gnus-load-file)
 425         (goto-char point)
 426         (while (search-forward "smiley-" nil t)
 427           (beginning-of-line)
 428           (if (looking-at "(autoload ")
 429               (delete-region (point) (progn (forward-sexp) (point)))
 430             (forward-line))))
 431       ;;
 432       (goto-char (point-max))
 433       (when (search-backward "\n(provide " nil t)
 434         (forward-line -1)
 435         (delete-region (point) (point-max)))
 436       (insert "\
 437
 438 \(provide 'gnus-load)
 439
 440 ;;; Local Variables:
 441 ;;; version-control: never
 442 ;;; no-byte-compile: t
 443 ;;; no-update-autoloads: t
 444 ;;; End:
 445 ;;; gnus-load.el ends here
 446 ")
 447       ))
 448   (message "Compiling %s..." dgnushack-gnus-load-file)
 449   (byte-compile-file dgnushack-gnus-load-file)
 450   (when (featurep 'xemacs)
 451     (message "Creating dummy gnus-load.el...")
 452     (with-temp-file (expand-file-name "gnus-load.el")
 453       (insert "\
 454
 455 \(provide 'gnus-load)
 456
 457 ;;; Local Variables:
 458 ;;; version-control: never
 459 ;;; no-byte-compile: t
 460 ;;; no-update-autoloads: t
 461 ;;; End:
 462 ;;; gnus-load.el ends here"))))
 463
 464 (defun dgnushack-find-lisp-shadows (&optional lispdir)
 465   "Return a list of directories in which other Gnus installations exist.
 466 This function looks for the other Gnus installations which will shadow
 467 the new Gnus Lisp modules which have been installed in LISPDIR, using
 468 the default `load-path'.  The return value will make sense only when
 469 LISPDIR is existent and is listed in the default `load-path'.  Assume
 470 LISPDIR will be prepended to `load-path' by a user if the default
 471 `load-path' does not contain it."
 472   (unless lispdir
 473     (setq lispdir (getenv "lispdir")))
 474   (when (and lispdir (file-directory-p lispdir))
 475     (setq lispdir (file-truename (directory-file-name lispdir)))
 476     (let ((indices '("gnus.elc" "gnus.el" "gnus.el.bz2" "gnus.el.gz"
 477                      "message.elc" "message.el" "message.el.bz2"
 478                      "message.el.gz"))
 479           (path (delq nil (mapcar
 480                            (lambda (p)
 481                              (condition-case nil
 482                                  (when (and p (file-directory-p p))
 483                                    (file-truename (directory-file-name p)))
 484                                (error nil)))
 485                            dgnushack-default-load-path)))
 486           rest elcs)
 487       (while path
 488         (setq rest (cons (car path) rest)
 489               path (delete (car rest) (cdr path))))
 490       (setq path (nreverse (cdr (member lispdir rest)))
 491             rest nil)
 492       (while path
 493         (setq elcs indices)
 494         (while elcs
 495           (when (file-exists-p (expand-file-name (pop elcs) (car path)))
 496             (setq rest (cons (car path) rest)
 497                   elcs nil)))
 498         (setq path (cdr path)))
 499       (prog1
 500           (setq path (nreverse rest))
 501         (when path
 502           (let (print-level print-length)
 503             (princ (concat "\n\
 504 WARNING: The other Gnus installation" (if (cdr path) "s have" " has") "\
 505  been detected in:\n\n  " (mapconcat 'identity path "\n  ") "\n\n\
 506 You will need to modify the run-time `load-path', remove them manually,
 507 or remove them using `make remove-installed-shadows'.\n\n"))))))))
 508
 509 (defun dgnushack-remove-lisp-shadows (&optional lispdir)
 510   "Remove the other Gnus installations which shadow the recent one."
 511   (let ((path (with-temp-buffer
 512                 (let ((standard-output (current-buffer)))
 513                   (dgnushack-find-lisp-shadows lispdir))))
 514         elcs files shadows file)
 515     (when path
 516       (unless (setq elcs (directory-files srcdir nil "\\.elc\\'"))
 517         (error "You should build .elc files first."))
 518       (setq files
 519             (apply
 520              'append
 521              (mapcar
 522               (lambda (el)
 523                 (list (concat el "c") el (concat el ".bz2") (concat el ".gz")))
 524               (append
 525                (list (file-name-nondirectory dgnushack-gnus-load-file)
 526                      (file-name-nondirectory dgnushack-cus-load-file))
 527                (mapcar (lambda (elc) (substring elc 0 -1)) elcs)))))
 528       (while path
 529         (setq shadows files)
 530         (while shadows
 531           (setq file (expand-file-name (pop shadows) (car path)))
 532           (when (file-exists-p file)
 533             (princ (concat "  Removing " file "..."))
 534             (condition-case nil
 535                 (progn
 536                   (delete-file file)
 537                   (princ "done\n"))
 538               (error (princ "failed\n")))))
 539         (setq path (cdr path))))))
 540
 541 ;;; dgnushack.el ends here
 542
 543 ;;; arch-tag: 579f585a-24eb-4e1c-8d34-4808e11b68f2