1 ;;;_ elinstall.el --- Automatically and flexibly install elisp files
5 ;; Copyright (C) 2010 Tom Breton (Tehom)
7 ;; Author: Tom Breton (Tehom) <tehom@panix.com>
8 ;; Keywords: maint, tools, internal
10 ;; This file 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 2, or (at your option)
15 ;; This file 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.
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
22 ;; the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, USA.
28 ;; elinstall Use this for overall loading
30 ;; elinstall-link-on-emacs-start - Use this for non-autogenerated
31 ;; files that need to be linked in.
33 ;; elinstall-update-directory-autoloads
34 ;; elinstall-update-file-autoloads
40 (require 'cus-edit
) ;;Because we save "installedness" manually
47 "Customizations for elinstall"
50 (defcustom elinstall-default-priority
52 "Default priority for site-start"
56 (defcustom elinstall-default-preload-target
57 "~/.emacs.d/site-start.d/"
58 "Default preload-target for registering autoloads"
62 (const "~/.emacs.d/site-start.d/")
63 (const "/etc/emacs/site-start.d/")
68 (defcustom elinstall-already-installed
70 "Things that have already been installed.
71 This exists for recording what has been installed. User interaction is not
72 contemplated at this time." )
75 ;;;_ . Regular expressions
76 ;;;_ , elinstall-elisp-regexp
77 (defconst elinstall-elisp-regexp
80 (suf (get-load-suffixes))
81 (unless (string-match "\\.elc" suf
) (push suf tmp
)))
82 (concat "^[^=.].*" (regexp-opt tmp t
) "\\'"))
83 "Regular expression that matches elisp files" )
86 ;;;_ . elinstall-directory-true-name
87 (defun elinstall-directory-true-name ()
88 "Get the true name of the directory the calling code lives in.
89 CAUTION: This is sensitive to where it's called. That's the point of it."
92 (file-truename load-file-name
)
93 (file-truename buffer-file-name
))))
94 ;;;_ . Checking installedness
95 ;;;_ , elinstall-already-installed
96 (defun elinstall-already-installed (project-name)
97 "Return non-nil if PROJECT-NAME has been installed."
98 (member project-name elinstall-already-installed
))
100 ;;;_ , elinstall-record-installed
101 (defun elinstall-record-installed (project-name)
102 "Record that PROJECT-NAME has been installed."
104 (add-to-list 'elinstall-already-installed project-name
)
105 (customize-save-variable
106 'elinstall-already-installed
107 elinstall-already-installed
108 "Set by elinstall-record-installed"))
112 ;;;_ , Doing autoload actions (All adapted from autoload.el)
113 ;;;_ . Utilities about the action list
114 ;;;_ , elinstall-remove-autogen-action
115 (defun elinstall-remove-autogen-action (file actions
)
116 "Return ACTIONS minus any add-file-autoloads on FILE removed."
123 (if (equal file
(third act
))
127 ;;;_ , elinstall-get-autogen-action
128 (defun elinstall-get-autogen-action (file actions
)
132 (dolist (act actions
)
135 (when (equal file
(third act
))
136 (setq the-act act
)))))
139 ;;;_ . Making autoloads
140 ;;;_ , elinstall-generate-file-autoloads
141 ;;override to allow slashed load-paths
142 ;;Quick and dirty: We just adapt `generate-file-autoloads' and add
144 ;;`relative-to' can be:
145 ;; * nil: act as at present. Assume that FILE's immediate directory
147 ;; * t :: use default-directory
148 ;; * a string :: relative to it, as a filename
150 (defun elinstall-generate-file-autoloads (relative-name full-name
)
151 "Insert at point a loaddefs autoload section for FILE.
152 Autoloads are generated for defuns and defmacros in FILE
153 marked by `generate-autoload-cookie' (which see).
154 If FILE is being visited in a buffer, the contents of the buffer
156 Return non-nil in the case where no autoloads were added at point.
158 FULL-NAME is the absolute name of the file.
159 RELATIVE-NAME is its name respective to some component of load-path."
160 (let ((outbuf (current-buffer))
163 (print-readably t
) ; This does something in Lucid Emacs.
164 (float-output-format nil
)
166 (visited (get-file-buffer full-name
))
169 ;;Older code massaged `file' but we take both `relative-name' and
170 ;;`full-name', so we don't.
172 (with-current-buffer (or visited
173 ;; It is faster to avoid visiting the file.
174 (autoload-find-file full-name
))
175 ;;$$MOVE ME - this should be checked in action-finding.
176 ;; Obey the no-update-autoloads file local variable.
177 (unless no-update-autoloads
178 (message "Generating autoloads for %s..." relative-name
)
179 (setq output-start
(with-current-buffer outbuf
(point)))
183 (goto-char (point-min))
185 (skip-chars-forward " \t\n\f")
187 ((looking-at (regexp-quote generate-autoload-cookie
))
188 (search-forward generate-autoload-cookie
)
189 (skip-chars-forward " \t")
192 ;; Read the next form and make an autoload.
193 (let* ((form (prog1 (read (current-buffer))
194 (or (bolp) (forward-line 1))))
195 (autoload (make-autoload form load-name
)))
197 (push (nth 1 form
) autoloads-done
)
198 (setq autoload form
))
199 (let ((autoload-print-form-outbuf outbuf
))
200 (autoload-print-form autoload
)))
202 ;; Copy the rest of the line to the output.
203 (princ (buffer-substring
205 ;; Back up over whitespace, to preserve it.
206 (skip-chars-backward " \f\t")
207 (if (= (char-after (1+ (point))) ?
)
211 (progn (forward-line 1) (point)))
214 ;; Don't read the comment.
218 (forward-line 1))))))
221 (with-current-buffer outbuf
223 ;; Insert the section-header line which lists the file name
224 ;; and which functions are in it, etc.
225 (goto-char output-start
)
226 (autoload-insert-section-header
227 outbuf autoloads-done relative-name full-name
228 (nth 5 (file-attributes full-name
)))
229 (insert ";;; Generated autoloads from "
230 (autoload-trim-file-name full-name
) "\n"))
231 (insert generate-autoload-section-trailer
)))
232 (message "Generating autoloads for %s...done" relative-name
))
234 ;; We created this buffer, so we should kill it.
235 (kill-buffer (current-buffer))))
239 ;;;_ , elinstall-deffile-insert-x
240 (defun elinstall-deffile-insert-x (file load-name
)
241 "Update the autoloads for FILE in current buffer.
242 Return FILE if there was no autoload cookie in it, else nil.
244 Current buffer must be a loaddef-style file.
246 LOAD-NAME is the absolute name of the file.
247 RELATIVE-NAME is its name respective to some component of load-path."
255 (goto-char (point-min))
256 ;; Look for the section for FILE
257 (while (and (not found
)
258 (search-forward generate-autoload-section-header nil t
))
259 (let ((form (autoload-read-section-header)))
261 ((equal (nth 2 form
) file
)
262 ;; We found the section for this file.
263 (let ((begin (match-beginning 0)))
265 (search-forward generate-autoload-section-trailer
)
266 (delete-region begin
(point))
268 ((string< file
(nth 2 form
))
269 ;; We've come to a section alphabetically later than
270 ;; FILE. We assume the file is in order and so
271 ;; there must be no section for FILE. We will
272 ;; insert one before the section here.
273 (goto-char (match-beginning 0))
274 (setq found
'new
)))))
278 ;; No later sections in the file. Put before the last page.
279 (goto-char (point-max))
280 (search-backward "\f" nil t
)))
282 (elinstall-generate-file-autoloads file load-name
))))
284 (if no-autoloads file nil
)))
285 ;;;_ . Arranging to add to info-path and load-path
286 ;;;_ , elinstall-generate-add-to-path
287 (defun elinstall-generate-add-to-path (path-element type
)
294 ;;;_ , elinstall-deffile-insert-add-to-path
295 (defun elinstall-deffile-insert-add-to-path (path-element type
)
296 "Insert code in current buffer to add PATH-ELEMENT to load-path.
298 Current buffer must be a loaddef-style file.
300 LOAD-NAME is the full name of the file."
308 (goto-char (point-min))
309 ;; Look for the section for PATH-ELEMENT
310 (while (and (not found
)
311 (search-forward generate-autoload-section-header nil t
))
312 (let ((form (autoload-read-section-header)))
315 (equal (nth 0 form
) type
)
316 (member (nth 1 form
) path-element
))
318 ;; We found the section for this add.
319 (let ((begin (match-beginning 0)))
321 (search-forward generate-autoload-section-trailer
)
322 (delete-region begin
(point))
328 ;; No later sections in the file. Put before the last page.
329 (goto-char (point-max))
330 (search-backward "\f" nil t
)))
332 (elinstall-generate-file-autoloads file load-name
)))
334 ;;This never belongs in the no-autoloads section.
337 ;;;_ . elinstall-deffile-insert
339 (defun elinstall-deffile-insert (action)
340 "Insert autoloads etc into current file according to ACTION.
341 The format of ACTION is described in the design docs.
343 Return filename if this action belongs in the no-autoload section."
348 (elinstall-deffile-insert-x
353 (elinstall-deffile-insert-add-to-path
358 ;;Similar, but for info-path.
360 (elinstall-deffile-insert-add-to-path
366 (error "This case should not come here.")))))
368 ;;;_ . elinstall-prepare-deffile
369 (defun elinstall-prepare-deffile (deffile)
370 "Try to ensure that DEFFILE is available for receiving autoloads"
372 (autoload-ensure-default-file deffile
)
373 (with-current-buffer (find-file-noselect deffile
)
376 ;; We must read/write the file without any code conversion,
377 ;; but still decode EOLs.
378 (let ((coding-system-for-read 'raw-text
))
380 ;; This is to make generated-autoload-file have Unix EOLs, so
381 ;; that it is portable to all platforms.
382 (setq buffer-file-coding-system
'raw-text-unix
))
383 (or (> (buffer-size) 0)
384 (error "Autoloads file %s does not exist" buffer-file-name
))
385 (or (file-writable-p buffer-file-name
)
386 (error "Autoloads file %s is not writable"
389 ;;;_ . elinstall-update-deffile
391 ;;Adapted from autoload.el `update-directory-autoloads'.
392 ;;Still being adapted:
394 ;; * Still need to treat add-to-info-path and
395 ;;add-to-load-path. Both recognize them and insert them.
396 ;; * Adapt `elinstall-update-file-autoloads' to understand actions.
398 ;; * Finding "file" among actions is rickety. Maybe knowing the
399 ;; respective load-path element would help.
401 (defun elinstall-update-deffile (target actions
&optional
404 Update file TARGET with current autoloads as specified by ACTIONS.
405 Also remove any old definitions pointing to libraries that can no
408 ACTIONS must be a list of actions (See the format doc). Each one's
409 filename must be relative to some element of load-path.
411 USE-LOAD-PATH is a list to use as load-path. It should include
412 any new load-path that we are arranging to create. If it's not given,
413 load-path itself is used.
415 If FORCE is `t', do it regardless of timestamps etc. (Not implemented)
416 Other non-nil cases of FORCE are reserved for future development.
418 This uses `update-file-autoloads' (which see) to do its work.
419 In an interactive call, you must give one argument, the name
420 of a single directory."
423 (use-load-path (or use-load-path load-path
))
424 (this-time (current-time))
425 ;;files with no autoload cookies.
428 (elinstall-prepare-deffile target
)
430 (find-file-noselect target
)
433 (elinstall-remove-autogen-action
434 (autoload-trim-file-name target
)
437 (goto-char (point-min))
438 (while (search-forward generate-autoload-section-header nil t
)
439 (let* ((form (autoload-read-section-header))
441 (cond ((and (consp file
) (stringp (car file
)))
442 ;; This is a list of files that have no
444 ;; There shouldn't be more than one such entry.
445 ;; Remove the obsolete section.
446 (autoload-remove-section (match-beginning 0))
447 (let ((last-time (nth 4 form
)))
449 (let ((file-time (nth 5 (file-attributes file
))))
451 (not (time-less-p last-time file-time
)))
453 (push file no-autoloads
)
455 (elinstall-remove-autogen-action
457 ((not (stringp file
)))
461 (locate-library file nil use-load-path
)))
463 ;;File doesn't exist, so remove its
466 (autoload-remove-section
467 (match-beginning 0)))
469 ;; File hasn't changed, so do nothing.
472 (nth 5 (file-attributes file-path
)))
475 (elinstall-deffile-insert
476 (elinstall-get-autogen-action
480 (elinstall-remove-autogen-action
483 ;; Remaining actions have no existing autoload sections yet.
486 (delq nil
(mapcar #'elinstall-deffile-insert actions
))))
488 ;; Sort them for better readability.
489 (setq no-autoloads
(sort no-autoloads
'string
<))
490 ;; Add the `no-autoloads' section.
491 (goto-char (point-max))
492 (search-backward "\f" nil t
)
493 (autoload-insert-section-header
494 (current-buffer) nil nil no-autoloads this-time
)
495 (insert generate-autoload-section-trailer
))
499 ;;;_ , Doing actions to arrange preloads
500 ;;;_ . elinstall-insert-add-to-path
501 (defun elinstall-insert-add-to-path (new path-sym
)
502 "Insert code to add NEW to PATH-SYM.
503 Insert this at point in current buffer."
506 `(add-to-list ',path-sym
507 (expand-file-name ,new
510 (file-truename load-file-name
)))))
513 ;;;_ . elinstall-insert-add-to-load-path
514 (defun elinstall-insert-add-to-load-path (new)
515 "Insert code to add NEW to load-path.
516 Insert this at point in current buffer."
517 (elinstall-insert-add-to-path new
'load-path
))
519 ;;;_ . elinstall-insert-add-to-info-path
520 (defun elinstall-insert-add-to-info-path (new)
521 "Insert code to add NEW to info-path.
522 Insert this at point in current buffer."
523 (elinstall-insert-add-to-path new
'Info-default-directory-list
))
525 ;;;_ . elinstall-symlink-on-emacs-start
526 (defun elinstall-symlink-on-emacs-start
527 (filename target-basename target-dir
&optional priority force
)
528 "Symlink to TARGET-BASENAME.el in TARGET-DIR
530 If PRIORITY is given, it will be used as the priority prefix,
531 otherwise elinstall-default-priority will be.
532 PRIORITY must be an integer or nil.
533 If FORCE is `t', do it regardless of timestamps etc.
534 Other non-nil cases of FORCE are reserved for future development."
537 (priority (or priority elinstall-default-priority
))
544 (expand-file-name target-name-nodir target-dir
)))
548 ;;Path should already exist.
550 (file-exists-p target-dir
))
551 (message "The target directory doesn't exist."))
552 ;;Target shouldn't already exist, but if force is given, let
555 (file-exists-p target
)
560 (format "Really overwrite %s? " project-name
))))
561 (message "No symlink made to %s" target
)))
569 ;;;_ . elinstall-add-to-dot-emacs
570 (defun elinstall-add-to-dot-emacs (dot-emacs-name filename force
&rest r
)
571 "Add code to load FILENAME to .emacs.
572 FILENAME should not have an extension"
575 (with-current-buffer (find-file-noselect dot-emacs-name
)
578 (goto-char (point-max))
579 (insert "\n;;Added by elinstall")
580 (insert "\n;;Consider using my-site-start to manage .emacs\n")
581 (pp `(load ,filename
) (current-buffer))
585 ;;;_ . elinstall-link-on-emacs-start
587 (defun elinstall-link-on-emacs-start (filename force basename priority
)
590 ;;Figure out parameters, using defaults when needed.
592 ( (preload-target elinstall-default-preload-target
))
594 ;;Dispatch the possibilities.
596 ((eq preload-target
'dot-emacs
)
597 (elinstall-add-to-dot-emacs "~/.emacs" filename
))
598 ((stringp preload-target
)
599 (elinstall-symlink-on-emacs-start
600 filename basename preload-target priority force
))
603 (message "I don't recognize that")))))
605 ;;;_ , Cleanup actions
606 ;;Nothing yet. This will be another type of action.
608 ;;;_ . Segregating actions
609 ;;;_ , elinstall-segregate-actions
610 (defun elinstall-segregate-actions (actions)
611 "Return actions segregated by deffile.
613 Returns a list whose elements are each a cons of:
614 * deffile filename or nil
615 * A list of actions to be done for that deffile."
619 (dolist (act actions
)
630 (cell (assoc deffile-name segment-list
)))
632 (setcdr cell
(cons act
(cdr cell
)))
643 ;;;_ . Finding actions
644 ;;;_ , Treating the parameter list
645 ;;;_ . elinstall-add-parameter
646 (defun elinstall-add-parameter (alist key new-value
)
647 "Add a new value for KEY to ALIST"
651 (assq-delete-all key
(copy-list alist
))))
653 ;;;_ . elinstall-get-parameter
654 (defun elinstall-get-parameter (alist key
)
655 "Get the value of KEY from ALIST"
657 (cdr (assq key alist
)))
658 ;;;_ . elinstall-expand-file-name
661 (defun elinstall-expand-file-name (filename alist
)
662 "Expand FILENAME by the value of `path' in ALIST"
665 (elinstall-get-parameter alist
'path
)))
666 ;;;_ , Finding deffiles
667 ;;;_ . elinstall-expand-deffile-name
668 (defun elinstall-expand-deffile-name (deffile)
669 "Expand DEFFILE autoload.el's way."
671 (expand-file-name (or deffile
"loaddefs.el")
672 (expand-file-name "lisp"
675 ;;;_ . elinstall-maybe-get-deffile
676 (defun elinstall-maybe-get-deffile (file)
677 "If FILE defined `generated-autoload-file', return it.
678 Otherwise return nil.
679 Return it as an absolute filename."
682 ;;$$FIXME load buffer if it's not already loaded
684 ((existing-buffer (get-file-buffer file
)))
686 ;; We want to get a value for generated-autoload-file from
687 ;; the local variables section if it's there.
688 ;;But if it's not loaded, we don't? Maybe should use
689 ;; `autoload-find-file' and load it.
691 (set-buffer existing-buffer
))
692 (if (local-variable-p 'generated-autoload-file
)
693 (elinstall-expand-deffile-name
694 generated-autoload-file
)
699 ;;;_ , elinstall-find-actions-by-spec
701 (defun elinstall-find-actions-by-spec (spec load-path-element path parameters
)
702 "Return a list of actions to do, controlled by SPEC and PARAMETERS.
704 LOAD-PATH-ELEMENT is the conceptual element of load-path that
705 surrounds PATH. It may not yet have been added to load-path."
707 ;;$$IMPROVE ME by adding the other cases in the design.
716 (elinstall-find-actions-by-spec
726 (elinstall-find-actions-by-spec
744 (elinstall-get-parameter
745 parameters
'block-add-to-load-path
))))
748 ;;Do this only if there are loadable files.
751 ,(elinstall-get-parameter
752 parameters
'def-file
)
756 ;;Do add-to-info-path too. But test if there are
757 ;;any info files present.
760 ;; We want to get a value for generated-autoload-file
761 ;; from the local variables section if it's there.
762 ;;Use `elinstall-maybe-get-deffile'
763 ;; Otherwise we'll use `def-file' in parameters.
765 ;;$$FIXME This isn't quite right. If directory
766 ;;itself is not in load-path, this will be wrong.
767 ;;Gotta know where our encompassing part of
770 ;;$$ENCAP ME This should be shared with the
771 ;;treatment of (file FN)
773 ;;$$FIXME Don't do directories, but maybe recurse on
774 ;;them, if a flag is set. And since we definitely
775 ;;have a load-path element here,
776 ;;'block-add-to-load-path according to a parameter.
777 ;;Maybe could follow/not symlinks similarly.
782 (expand-file-name filename dirname
)))
784 ,(elinstall-get-parameter
785 parameters
'def-file
)
786 ,(file-name-sans-extension
790 ,load-path-element
;;Is this still used?
795 nil
;;Relative filenames
796 elinstall-elisp-regexp
)))))
804 (elinstall-find-actions-by-spec
808 (elinstall-add-parameter parameters
809 'def-file new-def-file
)))))
811 ;;$$IMPROVE ME by adding the other cases in the design.
814 ;;;_ . high-level work
815 ;;;_ , elinstall-get-relevant-load-path
816 (defun elinstall-get-relevant-load-path (actions)
827 ;;;_ , elinstall-do-segment
828 (defun elinstall-do-segment (segment force use-load-path
)
829 "Do all the actions in SEGMENT.
830 FORCE has its usual meaning.
831 USE-LOAD-PATH is the effective load-path."
833 ;;$$IMPROVE ME - this will have to know the additions to load-path.
835 ((deffile (car segment
)))
836 (if (stringp deffile
)
837 (elinstall-update-deffile deffile
(cdr segment
) force
839 ;;Do other actions: link-in actions and cleanups.
842 ;;$$FIXME Distinguish link-in and cleanup actions.
844 #'elinstall-link-on-emacs-start
852 (defun elinstall-x (dir spec
&optional preload-target force
)
856 (elinstall-find-actions-by-spec
861 ;;$$RETHINK ME - maybe hand this work off to autoload?
862 ;;This is just the default loaddefs file, spec actually
864 (def-file .
,(elinstall-expand-deffile-name nil
) ))))
865 (segment-list (elinstall-segregate-actions actions
))
867 (elinstall-get-relevant-load-path
872 (elinstall-do-segment segment force use-load-path
))
877 (defun elinstall (project-name dir spec
&optional preload-target force
)
878 "Install elisp files.
880 They need not be presented as a package.
883 PROJECT-NAME - the name of the project
884 DIR - the root directory of the project.
885 Suggestion: (elinstall-directory-true-name)
887 SPEC - a spec for the autoloads etc to make. It can be as simple as
889 Suggestion: `(in ,(elinstall-directory-true-name) t)
890 PRELOAD-TARGET is where the autoload files are to be symlinked in. If
891 `nil' `elinstall-default-preload-target' is used instead.
893 If FORCE is t, install a package even if it has already been
895 Other non-nil cases of FORCE are reserved for future development."
901 (not (elinstall-already-installed project-name
)))
902 ;;$$RE-ADD ME - I commented it out just for development.
903 '(yes-or-no-p (format "Install %s " project-name
)))
904 (elinstall-x dir spec preload-target force
)
906 ;;$$RE-ADD ME - I commented it out just for development.
907 '(elinstall-record-installed project-name
)))
911 ;;;_ , elinstall-update-directory-autoloads
913 (defun elinstall-update-directory-autoloads (dir)
916 (interactive "DInstall all elisp files from directory: ")
921 (elinstall-expand-deffile-name
922 generated-autoload-file
)))
925 ;;;_ , elinstall-update-file-autoloads
927 (defun elinstall-update-file-autoloads (file)
930 (interactive "fInstall elisp file: ")
935 (elinstall-maybe-get-deffile file
)
936 (elinstall-expand-deffile-name
937 generated-autoload-file
))))
949 ;;;_ * Local emacs vars.
950 ;;;_ + Local variables:
955 ;;; elinstall.el ends here