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