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