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
   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 2, or (at your option)
  15 ;; any later version.
  16
  17 ;; GNU Emacs is distributed in the hope that it will be useful,
  18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20 ;; GNU General Public License for more details.
  21
  22 ;; You should have received a copy of the GNU General Public License
  23 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  24 ;; Free Software Foundation, Inc., 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 '(and (> 0 1) foo) t))
 122   (defadvice byte-optimize-form-code-walker
 123     (around fix-bug-in-and/or-forms (form for-effect) activate)
 124     "Optimize the rest of the and/or forms.
 125 It has been fixed in XEmacs before releasing 21.4 and also has been
 126 fixed in Emacs after 21.3."
 127     (if (and for-effect (memq (car-safe form) '(and or)))
 128         (let ((fn (car form))
 129               (backwards (reverse (cdr form))))
 130           (while (and backwards
 131                       (null (setcar backwards
 132                                     (byte-optimize-form (car backwards) t))))
 133             (setq backwards (cdr backwards)))
 134           (if (and (cdr form) (null backwards))
 135               (byte-compile-log
 136                "  all subforms of %s called for effect; deleted" form))
 137           (when backwards
 138             (setcdr backwards
 139                     (mapcar 'byte-optimize-form (cdr backwards))))
 140           (setq ad-return-value (cons fn (nreverse backwards))))
 141       ad-do-it)))
 142
 143 ;; Work around for an incompatibility (XEmacs 21.4 vs. 21.5), see the
 144 ;; following threads:
 145 ;;
 146 ;; http://thread.gmane.org/gmane.emacs.gnus.general/56414
 147 ;; Subject: attachment problems found but not fixed
 148 ;;
 149 ;; http://thread.gmane.org/gmane.emacs.gnus.general/56459
 150 ;; Subject: Splitting mail -- XEmacs 21.4 vs 21.5
 151 ;;
 152 ;; http://thread.gmane.org/gmane.emacs.xemacs.beta/20519
 153 ;; Subject: XEmacs 21.5 and Gnus fancy splitting.
 154 ;;
 155 ;; Should be fixed in XEmacs (March 2007).
 156 ;; http://thread.gmane.org/gmane.emacs.xemacs.patches/8124
 157 ;; When should we remove this workaround?
 158 ;;
 159 (when (and (featurep 'xemacs)
 160            (let ((table (copy-syntax-table emacs-lisp-mode-syntax-table)))
 161              (modify-syntax-entry ?= " " table)
 162              (with-temp-buffer
 163                (with-syntax-table table
 164                  (insert "foo=bar")
 165                  (goto-char (point-min))
 166                  (forward-sexp 1)
 167                  (eolp)))))
 168   ;; The original `with-syntax-table' uses `copy-syntax-table' which
 169   ;; doesn't seem to copy modified syntax entries in XEmacs 21.5.
 170   (defmacro with-syntax-table (syntab &rest body)
 171     "Evaluate BODY with the SYNTAB as the current syntax table."
 172     `(let ((stab (syntax-table)))
 173        (unwind-protect
 174            (progn
 175              ;;(set-syntax-table (copy-syntax-table ,syntab))
 176              (set-syntax-table ,syntab)
 177              ,@body)
 178          (set-syntax-table stab)))))
 179
 180 (push srcdir load-path)
 181 (push loaddir load-path)
 182 (load (expand-file-name "lpath.el" loaddir) nil t)
 183
 184 (defalias 'device-sound-enabled-p 'ignore)
 185 (defalias 'play-sound-file 'ignore)
 186 (defalias 'nndb-request-article 'ignore)
 187 (defalias 'efs-re-read-dir 'ignore)
 188 (defalias 'ange-ftp-re-read-dir 'ignore)
 189 (defalias 'define-mail-user-agent 'ignore)
 190
 191 (eval-and-compile
 192   (unless (featurep 'xemacs)
 193     (defalias 'get-popup-menu-response 'ignore)
 194     (defalias 'event-object 'ignore)
 195     (defalias 'x-defined-colors 'ignore)
 196     (defalias 'read-color 'ignore)))
 197
 198 (eval-and-compile
 199   (when (featurep 'xemacs)
 200     (unless (fboundp 'defadvice)
 201       (autoload 'defadvice "advice" nil nil 'macro))
 202     (autoload 'Info-directory "info" nil t)
 203     (autoload 'Info-menu "info" nil t)
 204     (autoload 'annotations-at "annotations")
 205     (autoload 'apropos "apropos" nil t)
 206     (autoload 'apropos-command "apropos" nil t)
 207     (autoload 'bbdb-complete-name "bbdb-com" nil t)
 208     (autoload 'browse-url "browse-url" nil t)
 209     (autoload 'browse-url-of-file "browse-url" nil t)
 210     (autoload 'c-mode "cc-mode" nil t)
 211     (autoload 'customize-apropos "cus-edit" nil t)
 212     (autoload 'customize-group "cus-edit" nil t)
 213     (autoload 'customize-save-variable "cus-edit" nil t)
 214     (autoload 'customize-set-variable "cus-edit" nil t)
 215     (autoload 'customize-variable "cus-edit" nil t)
 216     (autoload 'delete-annotation "annotations")
 217     (autoload 'dolist "cl-macs" nil nil 'macro)
 218     (autoload 'enriched-decode "enriched")
 219     (autoload 'executable-find "executable")
 220     (autoload 'font-lock-fontify-buffer "font-lock" nil t)
 221     (autoload 'info "info" nil t)
 222     (autoload 'mail-extract-address-components "mail-extr")
 223     (autoload 'mail-fetch-field "mail-utils")
 224     (autoload 'make-annotation "annotations")
 225     (autoload 'make-display-table "disp-table")
 226     (autoload 'pp "pp")
 227     (autoload 'ps-despool "ps-print" nil t)
 228     (autoload 'ps-spool-buffer "ps-print" nil t)
 229     (autoload 'ps-spool-buffer-with-faces "ps-print" nil t)
 230     (autoload 'read-passwd "passwd")
 231     (autoload 'regexp-opt "regexp-opt")
 232     (autoload 'reporter-submit-bug-report "reporter")
 233     (if (and (emacs-version>= 21 5)
 234              (not (featurep 'sxemacs)))
 235         (autoload 'setenv "process" nil t)
 236       (autoload 'setenv "env" nil t))
 237     (autoload 'sgml-mode "psgml" nil t)
 238     (autoload 'smtpmail-send-it "smtpmail")
 239     (autoload 'sort-numeric-fields "sort" nil t)
 240     (autoload 'sort-subr "sort")
 241     (autoload 'toggle-truncate-lines "view-less" nil t)
 242     (autoload 'trace-function-background "trace" nil t)
 243     (autoload 'unmorse-region "morse" nil t)
 244     (autoload 'w3-do-setup "w3")
 245     (autoload 'w3-prepare-buffer "w3-display")
 246     (autoload 'w3-region "w3-display" nil t)
 247     (defalias 'frame-char-height 'frame-height)
 248     (defalias 'frame-char-width 'frame-width)
 249     (defalias 'frame-parameter 'frame-property)
 250     (defalias 'make-overlay 'ignore)
 251     (defalias 'overlay-end 'ignore)
 252     (defalias 'overlay-get 'ignore)
 253     (defalias 'overlay-put 'ignore)
 254     (defalias 'overlay-start 'ignore)
 255     (defalias 'overlays-in 'ignore)
 256     (defalias 'replace-dehighlight 'ignore)
 257     (defalias 'replace-highlight 'ignore)
 258     (defalias 'w3-coding-system-for-mime-charset 'ignore)))
 259
 260 (defun dgnushack-compile-verbosely ()
 261   "Call dgnushack-compile with warnings ENABLED.  If you are compiling
 262 patches to gnus, you should consider modifying make.bat to call
 263 dgnushack-compile-verbosely.  All other users should continue to use
 264 dgnushack-compile."
 265   (dgnushack-compile t))
 266
 267 (defun dgnushack-compile (&optional warn)
 268   ;;(setq byte-compile-dynamic t)
 269   (unless warn
 270     (setq byte-compile-warnings
 271           '(free-vars unresolved callargs redefine)))
 272   (let ((files (directory-files srcdir nil "^[^=].*\\.el$"))
 273         ;;(byte-compile-generate-call-tree t)
 274         file elc)
 275     ;; Avoid barfing (from gnus-xmas) because the etc directory is not yet
 276     ;; installed.
 277     (when (featurep 'xemacs)
 278       (setq gnus-xmas-glyph-directory "dummy"))
 279     (dolist (file '("dgnushack.el" "lpath.el"))
 280       (setq files (delete file files)))
 281     (when (featurep 'base64)
 282       (setq files (delete "base64.el" files)))
 283     (condition-case code
 284         (require 'w3-parse)
 285       (error
 286        (message "No w3: %s %s" (cadr code) (or (locate-library "w3-parse") ""))
 287        (dolist (file '("nnultimate.el" "webmail.el" "nnwfm.el"))
 288          (setq files (delete file files)))))
 289     (condition-case code
 290         (require 'mh-e)
 291       (error
 292        (message "No mh-e: %s %s" (cadr code) (or (locate-library "mh-e") ""))
 293        (setq files (delete "gnus-mh.el" files))))
 294     (condition-case code
 295         (require 'xml)
 296       (error
 297        (message "No xml: %s %s" (cadr code) (or (locate-library "xml") ""))
 298        (setq files (delete "nnrss.el" files))))
 299     (dolist (file
 300              (if (featurep 'xemacs)
 301                  '("md5.el")
 302                '("gnus-xmas.el" "messagexmas.el" "nnheaderxm.el")))
 303       (setq files (delete file files)))
 304
 305     (dolist (file files)
 306       (setq file (expand-file-name file srcdir))
 307       (when (and (file-exists-p
 308                   (setq elc (concat (file-name-nondirectory file) "c")))
 309                  (file-newer-than-file-p file elc))
 310         (delete-file elc)))
 311
 312     (while (setq file (pop files))
 313       (setq file (expand-file-name file srcdir))
 314       (when (or (not (file-exists-p
 315                       (setq elc (concat (file-name-nondirectory file) "c"))))
 316                 (file-newer-than-file-p file elc))
 317         (ignore-errors
 318           (byte-compile-file file))))))
 319
 320 (defun dgnushack-recompile ()
 321   (require 'gnus)
 322   (byte-recompile-directory "." 0))
 323
 324 (defvar dgnushack-gnus-load-file
 325   (if (featurep 'xemacs)
 326       (expand-file-name "auto-autoloads.el")
 327     (expand-file-name "gnus-load.el")))
 328
 329 (defvar dgnushack-cus-load-file
 330   (if (featurep 'xemacs)
 331       (expand-file-name "custom-load.el")
 332     (expand-file-name "cus-load.el")))
 333
 334 (defun dgnushack-make-cus-load ()
 335   (load "cus-dep")
 336   (let ((cusload-base-file dgnushack-cus-load-file))
 337     (if (fboundp 'custom-make-dependencies)
 338         (custom-make-dependencies)
 339       (Custom-make-dependencies))
 340     (when (featurep 'xemacs)
 341       (message "Compiling %s..." dgnushack-cus-load-file)
 342       (byte-compile-file dgnushack-cus-load-file))))
 343
 344 (defun dgnushack-make-auto-load ()
 345   (require 'autoload)
 346   (unless (make-autoload '(define-derived-mode child parent name
 347                             "docstring" body)
 348                          "file")
 349     (defadvice make-autoload (around handle-define-derived-mode activate)
 350       "Handle `define-derived-mode'."
 351       (if (eq (car-safe (ad-get-arg 0)) 'define-derived-mode)
 352           (setq ad-return-value
 353                 (list 'autoload
 354                       (list 'quote (nth 1 (ad-get-arg 0)))
 355                       (ad-get-arg 1)
 356                       (nth 4 (ad-get-arg 0))
 357                       t nil))
 358         ad-do-it))
 359     (put 'define-derived-mode 'doc-string-elt 3))
 360   (let ((generated-autoload-file dgnushack-gnus-load-file)
 361         (make-backup-files nil)
 362         (autoload-package-name "gnus"))
 363     (if (featurep 'xemacs)
 364         (if (file-exists-p generated-autoload-file)
 365             (delete-file generated-autoload-file))
 366       (with-temp-file generated-autoload-file
 367         (insert ?\014)))
 368     (batch-update-autoloads)))
 369
 370 (defun dgnushack-make-load ()
 371   (unless (featurep 'xemacs)
 372     (message "Generating %s..." dgnushack-gnus-load-file)
 373     (with-temp-file dgnushack-gnus-load-file
 374       (insert-file-contents dgnushack-cus-load-file)
 375       (delete-file dgnushack-cus-load-file)
 376       (goto-char (point-min))
 377       (search-forward ";;; Code:")
 378       (forward-line)
 379       (delete-region (point-min) (point))
 380       (insert "\
 381 ;;; gnus-load.el --- automatically extracted custom dependencies and autoload
 382 ;;
 383 ;;; Code:
 384 ")
 385       (goto-char (point-max))
 386       (if (search-backward "custom-versions-load-alist" nil t)
 387           (forward-line -1)
 388         (forward-line -1)
 389         (while (eq (char-after) ?\;)
 390           (forward-line -1))
 391         (forward-line))
 392       (delete-region (point) (point-max))
 393       (insert "\n")
 394       ;; smiley-* are duplicated. Remove them all.
 395       (let ((point (point)))
 396         (insert-file-contents dgnushack-gnus-load-file)
 397         (goto-char point)
 398         (while (search-forward "smiley-" nil t)
 399           (beginning-of-line)
 400           (if (looking-at "(autoload ")
 401               (delete-region (point) (progn (forward-sexp) (point)))
 402             (forward-line))))
 403       ;;
 404       (goto-char (point-max))
 405       (when (search-backward "\n(provide " nil t)
 406         (forward-line -1)
 407         (delete-region (point) (point-max)))
 408       (insert "\
 409
 410 \(provide 'gnus-load)
 411
 412 ;;; Local Variables:
 413 ;;; version-control: never
 414 ;;; no-byte-compile: t
 415 ;;; no-update-autoloads: t
 416 ;;; End:
 417 ;;; gnus-load.el ends here
 418 ")
 419       ))
 420   (message "Compiling %s..." dgnushack-gnus-load-file)
 421   (byte-compile-file dgnushack-gnus-load-file)
 422   (when (featurep 'xemacs)
 423     (message "Creating dummy gnus-load.el...")
 424     (with-temp-file (expand-file-name "gnus-load.el")
 425       (insert "\
 426
 427 \(provide 'gnus-load)
 428
 429 ;;; Local Variables:
 430 ;;; version-control: never
 431 ;;; no-byte-compile: t
 432 ;;; no-update-autoloads: t
 433 ;;; End:
 434 ;;; gnus-load.el ends here"))))
 435
 436 (defun dgnushack-find-lisp-shadows (&optional lispdir)
 437   "Return a list of directories in which other Gnus installations exist.
 438 This function looks for the other Gnus installations which will shadow
 439 the new Gnus Lisp modules which have been installed in LISPDIR, using
 440 the default `load-path'.  The return value will make sense only when
 441 LISPDIR is existent and is listed in the default `load-path'.  Assume
 442 LISPDIR will be prepended to `load-path' by a user if the default
 443 `load-path' does not contain it."
 444   (unless lispdir
 445     (setq lispdir (getenv "lispdir")))
 446   (when (and lispdir (file-directory-p lispdir))
 447     (setq lispdir (file-truename (directory-file-name lispdir)))
 448     (let ((indices '("gnus.elc" "gnus.el" "gnus.el.bz2" "gnus.el.gz"
 449                      "message.elc" "message.el" "message.el.bz2"
 450                      "message.el.gz"))
 451           (path (delq nil (mapcar
 452                            (lambda (p)
 453                              (condition-case nil
 454                                  (when (and p (file-directory-p p))
 455                                    (file-truename (directory-file-name p)))
 456                                (error nil)))
 457                            dgnushack-default-load-path)))
 458           rest elcs)
 459       (while path
 460         (setq rest (cons (car path) rest)
 461               path (delete (car rest) (cdr path))))
 462       (setq path (nreverse (cdr (member lispdir rest)))
 463             rest nil)
 464       (while path
 465         (setq elcs indices)
 466         (while elcs
 467           (when (file-exists-p (expand-file-name (pop elcs) (car path)))
 468             (setq rest (cons (car path) rest)
 469                   elcs nil)))
 470         (setq path (cdr path)))
 471       (prog1
 472           (setq path (nreverse rest))
 473         (when path
 474           (let (print-level print-length)
 475             (princ (concat "\n\
 476 WARNING: The other Gnus installation" (if (cdr path) "s have" " has") "\
 477  been detected in:\n\n  " (mapconcat 'identity path "\n  ") "\n\n\
 478 You will need to modify the run-time `load-path', remove them manually,
 479 or remove them using `make remove-installed-shadows'.\n\n"))))))))
 480
 481 (defun dgnushack-remove-lisp-shadows (&optional lispdir)
 482   "Remove the other Gnus installations which shadow the recent one."
 483   (let ((path (with-temp-buffer
 484                 (let ((standard-output (current-buffer)))
 485                   (dgnushack-find-lisp-shadows lispdir))))
 486         elcs files shadows file)
 487     (when path
 488       (unless (setq elcs (directory-files srcdir nil "\\.elc\\'"))
 489         (error "You should build .elc files first."))
 490       (setq files
 491             (apply
 492              'append
 493              (mapcar
 494               (lambda (el)
 495                 (list (concat el "c") el (concat el ".bz2") (concat el ".gz")))
 496               (append
 497                (list (file-name-nondirectory dgnushack-gnus-load-file)
 498                      (file-name-nondirectory dgnushack-cus-load-file))
 499                (mapcar (lambda (elc) (substring elc 0 -1)) elcs)))))
 500       (while path
 501         (setq shadows files)
 502         (while shadows
 503           (setq file (expand-file-name (pop shadows) (car path)))
 504           (when (file-exists-p file)
 505             (princ (concat "  Removing " file "..."))
 506             (condition-case nil
 507                 (progn
 508                   (delete-file file)
 509                   (princ "done\n"))
 510               (error (princ "failed\n")))))
 511         (setq path (cdr path))))))
 512
 513 ;;; dgnushack.el ends here
 514
 515 ;;; arch-tag: 579f585a-24eb-4e1c-8d34-4808e11b68f2