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-2011 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; see the file COPYING.  If not, write to the
  22 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  23 ;; Boston, MA 02110-1301, USA.
  24
  25 ;;; Commentary:
  26
  27 ;;; Code:
  28
  29 (defvar dgnushack-default-load-path (copy-sequence load-path))
  30
  31 (defalias 'facep 'ignore)
  32
  33 (require 'cl)
  34 (require 'iswitchb)
  35
  36 (condition-case nil
  37     (require 'org-entities)
  38   (error nil))
  39
  40 (defvar srcdir (or (getenv "srcdir") "."))
  41 (defvar loaddir (and load-file-name (file-name-directory load-file-name)))
  42
  43 (defun my-getenv (str)
  44   (let ((val (getenv str)))
  45     (if (equal val "no") nil val)))
  46
  47 (if (my-getenv "lispdir")
  48     (push (my-getenv "lispdir") load-path))
  49
  50 (push (or (my-getenv "URLDIR") (expand-file-name "../../url/lisp/" loaddir))
  51       load-path)
  52
  53 (push (or (my-getenv "W3DIR") (expand-file-name "../../w3/lisp/" loaddir))
  54       load-path)
  55
  56 ;(push "/usr/share/emacs/site-lisp" load-path)
  57
  58 ;; If we are building w3 in a different directory than the source
  59 ;; directory, we must read *.el from source directory and write *.elc
  60 ;; into the building directory.  For that, we define this function
  61 ;; before loading bytecomp.  Bytecomp doesn't overwrite this function.
  62 (defun byte-compile-dest-file (filename)
  63   "Convert an Emacs Lisp source file name to a compiled file name.
  64  In addition, remove directory name part from FILENAME."
  65   (setq filename (byte-compiler-base-file-name filename))
  66   (setq filename (file-name-sans-versions filename))
  67   (setq filename (file-name-nondirectory filename))
  68   (if (eq system-type 'windows-nt)
  69       (setq filename (downcase filename)))
  70   (cond ((eq system-type 'vax-vms)
  71          (concat (substring filename 0 (string-match ";" filename)) "c"))
  72         ((string-match emacs-lisp-file-regexp filename)
  73          (concat (substring filename 0 (match-beginning 0)) ".elc"))
  74         (t (concat filename ".elc"))))
  75
  76 (require 'bytecomp)
  77 ;; To avoid having defsubsts and inlines happen.
  78 ;(if (featurep 'xemacs)
  79 ;    (require 'byte-optimize)
  80 ;  (require 'byte-opt))
  81 ;(defun byte-optimize-inline-handler (form)
  82 ;  "byte-optimize-handler for the `inline' special-form."
  83 ;  (cons 'progn (cdr form)))
  84 ;(defalias 'byte-compile-file-form-defsubst 'byte-compile-file-form-defun)
  85
  86 ;; Work around for an incompatibility (XEmacs 21.4 vs. 21.5), see the
  87 ;; following threads:
  88 ;;
  89 ;; http://thread.gmane.org/gmane.emacs.gnus.general/56414
  90 ;; Subject: attachment problems found but not fixed
  91 ;;
  92 ;; http://thread.gmane.org/gmane.emacs.gnus.general/56459
  93 ;; Subject: Splitting mail -- XEmacs 21.4 vs 21.5
  94 ;;
  95 ;; http://thread.gmane.org/gmane.emacs.xemacs.beta/20519
  96 ;; Subject: XEmacs 21.5 and Gnus fancy splitting.
  97 ;;
  98 ;; Should be fixed in XEmacs (March 2007).
  99 ;; http://thread.gmane.org/gmane.emacs.xemacs.patches/8124
 100 ;; When should we remove this workaround?
 101 ;;
 102 (when (and (featurep 'xemacs)
 103            (let ((table (copy-syntax-table emacs-lisp-mode-syntax-table)))
 104              (modify-syntax-entry ?= " " table)
 105              (with-temp-buffer
 106                (with-syntax-table table
 107                  (insert "foo=bar")
 108                  (goto-char (point-min))
 109                  (forward-sexp 1)
 110                  (eolp)))))
 111   ;; The original `with-syntax-table' uses `copy-syntax-table' which
 112   ;; doesn't seem to copy modified syntax entries in old XEmacs 21.5.
 113   (defmacro with-syntax-table (syntab &rest body)
 114     "Evaluate BODY with the SYNTAB as the current syntax table."
 115     `(let ((stab (syntax-table)))
 116        (unwind-protect
 117            (progn
 118              ;;(set-syntax-table (copy-syntax-table ,syntab))
 119              (set-syntax-table ,syntab)
 120              ,@body)
 121          (set-syntax-table stab)))))
 122
 123 (push srcdir load-path)
 124 (push loaddir load-path)
 125 (load (expand-file-name "lpath.el" loaddir) nil t)
 126
 127 (defalias 'device-sound-enabled-p 'ignore)
 128 (defalias 'play-sound-file 'ignore)
 129 (defalias 'efs-re-read-dir 'ignore)
 130 (defalias 'ange-ftp-re-read-dir 'ignore)
 131 (defalias 'define-mail-user-agent 'ignore)
 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 (fboundp 'url-retrieve-synchronously)
 149       (defalias 'url-retrieve-synchronously 'url-retrieve))
 150     (autoload 'Info-directory "info" nil t)
 151     (autoload 'Info-index "info" nil t)
 152     (autoload 'Info-index-next "info" nil t)
 153     (autoload 'Info-menu "info" nil t)
 154     (autoload 'ad-add-advice "advice")
 155     (unless (and (emacs-version>= 21 5)
 156                  (not (featurep 'sxemacs)))
 157       ;; calendar/auto-autoloads.el provides it.
 158       (autoload 'add-to-invisibility-spec "dummy"))
 159     (autoload 'annotations-at "annotations")
 160     (autoload 'apropos "apropos" nil t)
 161     (autoload 'apropos-command "apropos" nil t)
 162     (autoload 'bbdb-complete-name "bbdb-com" nil t)
 163     (autoload 'browse-url "browse-url" nil t)
 164     (autoload 'browse-url-of-file "browse-url" nil t)
 165     (autoload 'c-mode "cc-mode" nil t)
 166     (autoload 'customize-apropos "cus-edit" nil t)
 167     (autoload 'customize-group "cus-edit" nil t)
 168     (autoload 'customize-save-variable "cus-edit" nil t)
 169     (autoload 'customize-set-variable "cus-edit" nil t)
 170     (autoload 'customize-variable "cus-edit" nil t)
 171     (autoload 'debug "debug" nil t)
 172     (if (featurep 'mule)
 173         (unless (locate-library "mule-ccl")
 174           (autoload 'define-ccl-program "ccl" nil nil 'macro))
 175       (defalias 'define-ccl-program 'ignore))
 176     (autoload 'delete-annotation "annotations")
 177     (autoload 'dolist "cl-macs" nil nil 'macro)
 178     (autoload 'enriched-decode "enriched")
 179     (autoload 'eudc-expand-inline "eudc" nil t)
 180     (autoload 'executable-find "executable")
 181     (autoload 'font-lock-fontify-buffer "font-lock" nil t)
 182     (when (and (emacs-version>= 21 5)
 183                (not (featurep 'sxemacs)))
 184       (autoload 'get-display-table "disp-table")
 185       (autoload 'put-display-table "disp-table"))
 186     (autoload 'info "info" nil t)
 187     (autoload 'mail-extract-address-components "mail-extr")
 188     (autoload 'mail-fetch-field "mail-utils")
 189     (autoload 'make-annotation "annotations")
 190     (autoload 'make-display-table "disp-table")
 191     (autoload 'pgg-snarf-keys-region "pgg" nil t)
 192     (autoload 'pp "pp")
 193     (autoload 'ps-despool "ps-print" nil t)
 194     (autoload 'ps-spool-buffer "ps-print" nil t)
 195     (autoload 'ps-spool-buffer-with-faces "ps-print" nil t)
 196     (autoload 'read-passwd "passwd")
 197     (autoload 'regexp-opt "regexp-opt")
 198     (autoload 'reporter-submit-bug-report "reporter")
 199     (if (condition-case nil
 200             (progn
 201               (require 'rot13)
 202               (not (fboundp 'rot13-string)))
 203           (error nil))
 204         (defmacro rot13-string (string)
 205           "Return ROT13 encryption of STRING."
 206           `(let ((string ,string))
 207              (with-temp-buffer
 208                (insert string)
 209                (translate-region (point-min) (point-max) ,rot13-display-table)
 210                (buffer-string)))))
 211     (if (and (emacs-version>= 21 5)
 212              (not (featurep 'sxemacs)))
 213         (autoload 'setenv "process" nil t)
 214       (autoload 'setenv "env" nil t))
 215     (autoload 'sgml-mode "psgml" nil t)
 216     (autoload 'smtpmail-send-it "smtpmail")
 217     (autoload 'sort-numeric-fields "sort" nil t)
 218     (autoload 'sort-subr "sort")
 219     (autoload 'thing-at-point "thingatpt")
 220     (autoload 'toggle-truncate-lines "view-less" nil t)
 221     (autoload 'trace-function-background "trace" nil t)
 222     (autoload 'unmorse-region "morse" nil t)
 223     (autoload 'w3-do-setup "w3")
 224     (autoload 'w3-prepare-buffer "w3-display")
 225     (autoload 'w3-region "w3-display" nil t)
 226     (defalias 'frame-char-height 'frame-height)
 227     (defalias 'frame-char-width 'frame-width)
 228     (defalias 'frame-parameter 'frame-property)
 229     (defalias 'make-overlay 'ignore)
 230     (defalias 'overlay-end 'ignore)
 231     (defalias 'overlay-get 'ignore)
 232     (defalias 'overlay-put 'ignore)
 233     (defalias 'overlay-start 'ignore)
 234     (defalias 'overlays-in 'ignore)
 235     (defalias 'replace-dehighlight 'ignore)
 236     (defalias 'replace-highlight 'ignore)
 237     (defalias 'w3-coding-system-for-mime-charset 'ignore)))
 238
 239 (defun dgnushack-emacs-compile-defcustom-p ()
 240   "Return non-nil if Emacs byte compiles `defcustom' forms.
 241 Those Emacsen will warn against undefined variables and functions used
 242 in `defcustom' forms."
 243   (let ((outbuf (with-temp-buffer
 244                   (insert "(defcustom foo (1+ (random)) \"\" :group 'emacs)\n")
 245                   (byte-compile-from-buffer (current-buffer) "foo.el"))))
 246     (when outbuf
 247       (prog1
 248           (with-current-buffer outbuf
 249             (goto-char (point-min))
 250             (search-forward " 'foo '(byte-code " nil t))
 251         (kill-buffer outbuf)))))
 252
 253 (when (dgnushack-emacs-compile-defcustom-p)
 254   (maybe-fbind '(defined-colors face-attribute))
 255   (maybe-bind '(idna-program installation-directory)))
 256
 257 (when (featurep 'xemacs)
 258   (defadvice byte-optimize-apply (before use-mapcan (form) activate)
 259     "Replace (apply 'nconc (mapcar ...)) with (mapcan ...)."
 260     (let ((last (nth (1- (length form)) form)))
 261       (when (and (eq last (third form))
 262                  (consp last)
 263                  (eq 'mapcar (car last))
 264                  (equal (nth 1 form) ''nconc))
 265         (setq form (cons 'mapcan (cdr last)))))))
 266
 267 (defun dgnushack-compile-verbosely ()
 268   "Call dgnushack-compile with warnings ENABLED.  If you are compiling
 269 patches to gnus, you should consider modifying make.bat to call
 270 dgnushack-compile-verbosely.  All other users should continue to use
 271 dgnushack-compile."
 272   (dgnushack-compile t))
 273
 274 (defun dgnushack-compile (&optional warn)
 275   ;;(setq byte-compile-dynamic t)
 276   (unless warn
 277     (setq byte-compile-warnings
 278           '(free-vars unresolved callargs redefine suspicious)))
 279   (let ((files (directory-files srcdir nil "^[^=].*\\.el$"))
 280         ;;(byte-compile-generate-call-tree t)
 281         file elc)
 282     ;; Avoid barfing (from gnus-xmas) because the etc directory is not yet
 283     ;; installed.
 284     (when (featurep 'xemacs)
 285       (setq gnus-xmas-glyph-directory "dummy"))
 286     (dolist (file '(".dir-locals.el" "dgnushack.el" "lpath.el"))
 287       (setq files (delete file files)))
 288     (when (featurep 'base64)
 289       (setq files (delete "base64.el" files)))
 290     (condition-case code
 291         (require 'w3-parse)
 292       (error
 293        (message "No w3: %s %s" (cadr code) (or (locate-library "w3-parse") ""))
 294        (dolist (file '("webmail.el" "nnwfm.el"))
 295          (setq files (delete file files)))))
 296     (condition-case code
 297         ;; Under XEmacs 21.4 this loads easy-mmode.elc that provides
 298         ;; the Emacs functions `propertize' and `replace-regexp-in-string'.
 299         (require 'mh-e)
 300       (error
 301        (message "No mh-e: %s %s" (cadr code) (or (locate-library "mh-e") ""))
 302        (setq files (delete "gnus-mh.el" files))))
 303     (condition-case code
 304         (require 'xml)
 305       (error
 306        (message "No xml: %s %s" (cadr code) (or (locate-library "xml") ""))
 307        (setq files (delete "nnrss.el" files))))
 308     (dolist (file
 309              (if (featurep 'xemacs)
 310                  '("md5.el")
 311                '("gnus-xmas.el" "messagexmas.el" "nnheaderxm.el")))
 312       (setq files (delete file files)))
 313     (unless (and (fboundp 'libxml-parse-html-region)
 314                  ;; lpath.el binds it.
 315                  (not (eq (symbol-function 'libxml-parse-html-region)
 316                           'ignore)))
 317       (dolist (file '("color.el" "shr-color.el" "shr.el"))
 318         (setq files (delete file files))))
 319
 320     (dolist (file files)
 321       (setq file (expand-file-name file srcdir))
 322       (when (and (file-exists-p
 323                   (setq elc (concat (file-name-nondirectory file) "c")))
 324                  (file-newer-than-file-p file elc))
 325         (delete-file elc)))
 326
 327     (while (setq file (pop files))
 328       (setq file (expand-file-name file srcdir))
 329       (when (or (not (file-exists-p
 330                       (setq elc (concat (file-name-nondirectory file) "c"))))
 331                 (file-newer-than-file-p file elc))
 332         (ignore-errors
 333           (byte-compile-file file))))))
 334
 335 (defun dgnushack-recompile ()
 336   (require 'gnus)
 337   (byte-recompile-directory "." 0))
 338
 339 (defvar dgnushack-gnus-load-file
 340   (if (featurep 'xemacs)
 341       (expand-file-name "auto-autoloads.el")
 342     (expand-file-name "gnus-load.el")))
 343
 344 (defvar dgnushack-cus-load-file
 345   (if (featurep 'xemacs)
 346       (expand-file-name "custom-load.el")
 347     (expand-file-name "cus-load.el")))
 348
 349 (defun dgnushack-make-cus-load ()
 350   (load "cus-dep")
 351   (let ((cusload-base-file dgnushack-cus-load-file))
 352     (defadvice directory-files (after exclude-dir-locals activate)
 353       "Exclude .dir-locals.el file."
 354       (dolist (file ad-return-value)
 355         (if (string-match "\\(?:\\`\\|/\\)\\.dir-locals\\.el\\'" file)
 356             (setq ad-return-value (delete file ad-return-value)))))
 357     (unwind-protect
 358         (if (fboundp 'custom-make-dependencies)
 359             (custom-make-dependencies)
 360           (Custom-make-dependencies))
 361       (ad-unadvise 'directory-files))
 362     (when (featurep 'xemacs)
 363       (message "Compiling %s..." dgnushack-cus-load-file)
 364       (byte-compile-file dgnushack-cus-load-file))))
 365
 366 (defun dgnushack-make-auto-load ()
 367   (require 'autoload)
 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     (defadvice directory-files (after exclude-dir-locals activate)
 377       "Exclude .dir-locals.el file."
 378       (dolist (file ad-return-value)
 379         (if (string-match "\\(?:\\`\\|/\\)\\.dir-locals\\.el\\'" file)
 380             (setq ad-return-value (delete file ad-return-value)))))
 381     (unwind-protect
 382         (batch-update-autoloads)
 383       (ad-unadvise 'directory-files))))
 384
 385 (defun dgnushack-make-load ()
 386   (unless (featurep 'xemacs)
 387     (message "Generating %s..." dgnushack-gnus-load-file)
 388     (with-temp-file dgnushack-gnus-load-file
 389       (insert-file-contents dgnushack-cus-load-file)
 390       (delete-file dgnushack-cus-load-file)
 391       (goto-char (point-min))
 392       (search-forward ";;; Code:")
 393       (forward-line)
 394       (delete-region (point-min) (point))
 395       (insert "\
 396 ;;; gnus-load.el --- automatically extracted custom dependencies and autoload
 397 ;;
 398 ;;; Code:
 399 ")
 400       (goto-char (point-max))
 401       (if (search-backward "custom-versions-load-alist" nil t)
 402           (forward-line -1)
 403         (forward-line -1)
 404         (while (eq (char-after) ?\;)
 405           (forward-line -1))
 406         (forward-line))
 407       (delete-region (point) (point-max))
 408       (insert "\n")
 409       ;; smiley-* are duplicated. Remove them all.
 410       (let ((point (point)))
 411         (insert-file-contents dgnushack-gnus-load-file)
 412         (goto-char point)
 413         (while (search-forward "smiley-" nil t)
 414           (beginning-of-line)
 415           (if (looking-at "(autoload ")
 416               (delete-region (point) (progn (forward-sexp) (point)))
 417             (forward-line))))
 418       ;;
 419       (goto-char (point-max))
 420       (when (search-backward "\n(provide " nil t)
 421         (forward-line -1)
 422         (delete-region (point) (point-max)))
 423       (insert "\
 424
 425 \(provide 'gnus-load)
 426
 427 ;;; Local Variables:
 428 ;;; version-control: never
 429 ;;; no-byte-compile: t
 430 ;;; no-update-autoloads: t
 431 ;;; End:
 432 ;;; gnus-load.el ends here
 433 ")
 434       ))
 435   (message "Compiling %s..." dgnushack-gnus-load-file)
 436   (byte-compile-file dgnushack-gnus-load-file)
 437   (when (featurep 'xemacs)
 438     (message "Creating dummy gnus-load.el...")
 439     (with-temp-file (expand-file-name "gnus-load.el")
 440       (insert "\
 441
 442 \(provide 'gnus-load)
 443
 444 ;;; Local Variables:
 445 ;;; version-control: never
 446 ;;; no-byte-compile: t
 447 ;;; no-update-autoloads: t
 448 ;;; End:
 449 ;;; gnus-load.el ends here"))))
 450
 451 (defun dgnushack-find-lisp-shadows (&optional lispdir)
 452   "Return a list of directories in which other Gnus installations exist.
 453 This function looks for the other Gnus installations which will shadow
 454 the new Gnus Lisp modules which have been installed in LISPDIR, using
 455 the default `load-path'.  The return value will make sense only when
 456 LISPDIR is existent and is listed in the default `load-path'.  Assume
 457 LISPDIR will be prepended to `load-path' by a user if the default
 458 `load-path' does not contain it."
 459   (unless lispdir
 460     (setq lispdir (getenv "lispdir")))
 461   (when (and lispdir (file-directory-p lispdir))
 462     (setq lispdir (file-truename (directory-file-name lispdir)))
 463     (let ((indices '("gnus.elc" "gnus.el" "gnus.el.bz2" "gnus.el.gz"
 464                      "message.elc" "message.el" "message.el.bz2"
 465                      "message.el.gz"))
 466           (path (delq nil (mapcar
 467                            (lambda (p)
 468                              (condition-case nil
 469                                  (when (and p (file-directory-p p))
 470                                    (file-truename (directory-file-name p)))
 471                                (error nil)))
 472                            dgnushack-default-load-path)))
 473           rest elcs)
 474       (while path
 475         (setq rest (cons (car path) rest)
 476               path (delete (car rest) (cdr path))))
 477       (setq path (nreverse (cdr (member lispdir rest)))
 478             rest nil)
 479       (while path
 480         (setq elcs indices)
 481         (while elcs
 482           (when (file-exists-p (expand-file-name (pop elcs) (car path)))
 483             (setq rest (cons (car path) rest)
 484                   elcs nil)))
 485         (setq path (cdr path)))
 486       (prog1
 487           (setq path (nreverse rest))
 488         (when path
 489           (let (print-level print-length)
 490             (princ (concat "\n\
 491 WARNING: The other Gnus installation" (if (cdr path) "s have" " has") "\
 492  been detected in:\n\n  " (mapconcat 'identity path "\n  ") "\n\n\
 493 You will need to modify the run-time `load-path', remove them manually,
 494 or remove them using `make remove-installed-shadows'.\n\n"))))))))
 495
 496 (defun dgnushack-remove-lisp-shadows (&optional lispdir)
 497   "Remove the other Gnus installations which shadow the recent one."
 498   (let ((path (with-temp-buffer
 499                 (let ((standard-output (current-buffer)))
 500                   (dgnushack-find-lisp-shadows lispdir))))
 501         elcs files shadows file)
 502     (when path
 503       (unless (setq elcs (directory-files srcdir nil "\\.elc\\'"))
 504         (error "You should build .elc files first."))
 505       (setq files
 506             (apply
 507              'append
 508              (mapcar
 509               (lambda (el)
 510                 (list (concat el "c") el (concat el ".bz2") (concat el ".gz")))
 511               (append
 512                (list (file-name-nondirectory dgnushack-gnus-load-file)
 513                      (file-name-nondirectory dgnushack-cus-load-file))
 514                (mapcar (lambda (elc) (substring elc 0 -1)) elcs)))))
 515       (while path
 516         (setq shadows files)
 517         (while shadows
 518           (setq file (expand-file-name (pop shadows) (car path)))
 519           (when (file-exists-p file)
 520             (princ (concat "  Removing " file "..."))
 521             (condition-case nil
 522                 (progn
 523                   (delete-file file)
 524                   (princ "done\n"))
 525               (error (princ "failed\n")))))
 526         (setq path (cdr path))))))
 527
 528 ;;; dgnushack.el ends here