/[slime]/slime/swank-loader.lisp
ViewVC logotype

Diff of /slime/swank-loader.lisp

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1.35 by asimon, Sun Sep 26 17:09:13 2004 UTC revision 1.112 by heller, Sun Dec 4 14:54:46 2011 UTC
# Line 1  Line 1 
1  ;;;; -*- Mode: lisp; indent-tabs-mode: nil -*-  ;;;; -*- indent-tabs-mode: nil -*-
2  ;;;  ;;;
3  ;;; swank-loader.lisp --- Compile and load the Slime backend.  ;;; swank-loader.lisp --- Compile and load the Slime backend.
4  ;;;  ;;;
# Line 8  Line 8 
8  ;;; are disclaimed.  ;;; are disclaimed.
9  ;;;  ;;;
10    
11  (cl:defpackage :swank-loader  ;; If you want customize the source- or fasl-directory you can set
12    (:use :common-lisp))  ;; swank-loader:*source-directory* resp. swank-loader:*fasl-directory*
13    ;; before loading this files. (you also need to create the
14  (in-package :swank-loader)  ;; swank-loader package.)
15    ;; E.g.:
16    ;;
17    ;;   (make-package :swank-loader)
18    ;;   (defparameter swank-loader::*fasl-directory* "/tmp/fasl/")
19    ;;   (load ".../swank-loader.lisp")
20    
21  (defun make-swank-pathname (name &optional (type "lisp"))  (cl:defpackage :swank-loader
22    "Return a pathname with name component NAME in the Slime directory."    (:use :cl)
23    (merge-pathnames (make-pathname :name name :type type)    (:export :init
24                     (or *compile-file-pathname*             :dump-image
25                         *load-pathname*             :*source-directory*
26                         *default-pathname-defaults*)))             :*fasl-directory*))
27    
28  (defparameter *sysdep-pathnames*  (cl:in-package :swank-loader)
29    (mapcar #'make-swank-pathname  
30            (append  (defvar *source-directory*
31             '("nregex")    (make-pathname :name nil :type nil
32             #+cmu '("swank-source-path-parser" "swank-cmucl")                   :defaults (or *load-pathname* *default-pathname-defaults*))
33             #+sbcl '("swank-sbcl" "swank-source-path-parser" "swank-gray")    "The directory where to look for the source.")
34             #+openmcl '("metering" "swank-openmcl" "swank-gray")  
35             #+lispworks '("swank-lispworks" "swank-gray")  (defparameter *sysdep-files*
36             #+allegro '("swank-allegro" "swank-gray")    #+cmu '(swank-source-path-parser swank-source-file-cache swank-cmucl)
37             #+clisp '("xref" "metering" "swank-clisp" "swank-gray")    #+scl '(swank-source-path-parser swank-source-file-cache swank-scl)
38             #+armedbear '("swank-abcl")    #+sbcl '(swank-source-path-parser swank-source-file-cache
39             )))             swank-sbcl swank-gray)
40      #+clozure '(metering swank-ccl swank-gray)
41  (defparameter *lisp-name*    #+lispworks '(swank-lispworks swank-gray)
42    #+cmu       (format nil "cmu-~A"    #+allegro '(swank-allegro swank-gray)
43                        (substitute #\- #\/ (lisp-implementation-version)))    #+clisp '(xref metering swank-clisp swank-gray)
44    #+sbcl      (format nil "sbcl-~A" (lisp-implementation-version))    #+armedbear '(swank-abcl)
45    #+openmcl   "openmcl"    #+cormanlisp '(swank-corman swank-gray)
46    #+lispworks (format nil "lispworks-~A" (lisp-implementation-version))    #+ecl '(swank-source-path-parser swank-source-file-cache
47    #+allegro   (format nil "allegro-~A" excl::*common-lisp-version-number*)            swank-ecl swank-gray))
48    #+clisp     (format nil "clisp-~A" (let ((s (lisp-implementation-version)))  
49                                         (subseq s 0 (position #\space s))))  (defparameter *implementation-features*
50    #+armedbear "abcl"    '(:allegro :lispworks :sbcl :clozure :cmu :clisp :ccl :corman :cormanlisp
51    )      :armedbear :gcl :ecl :scl))
52    
53  (defparameter *swank-pathname* (make-swank-pathname "swank"))  (defparameter *os-features*
54      '(:macosx :linux :windows :mswindows :win32 :solaris :darwin :sunos :hpux
55        :unix))
56    
57    (defparameter *architecture-features*
58      '(:powerpc :ppc :x86 :x86-64 :x86_64 :amd64 :i686 :i586 :i486 :pc386 :iapx386
59        :sparc64 :sparc :hppa64 :hppa :arm
60        :pentium3 :pentium4
61        :java-1.4 :java-1.5 :java-1.6 :java-1.7))
62    
63    (defun q (s) (read-from-string s))
64    
65    #+ecl
66    (defun ecl-version-string ()
67      (format nil "~A~@[-~A~]"
68              (lisp-implementation-version)
69              (when (find-symbol "LISP-IMPLEMENTATION-VCS-ID" :ext)
70                (let ((vcs-id (funcall (q "ext:lisp-implementation-vcs-id"))))
71                  (when (>= (length vcs-id) 8)
72                    (subseq vcs-id 0 8))))))
73    
74    (defun lisp-version-string ()
75      #+(or clozure cmu) (substitute-if #\_ (lambda (x) (find x " /"))
76                                        (lisp-implementation-version))
77      #+(or cormanlisp scl sbcl) (lisp-implementation-version)
78      #+lispworks (lisp-implementation-version)
79      #+allegro   (format nil "~A~A~A~A"
80                          excl::*common-lisp-version-number*
81                          (if (eq 'h 'H) "A" "M")     ; ANSI vs MoDeRn
82                          (if (member :64bit *features*) "-64bit" "")
83                          (excl:ics-target-case
84                           (:-ics "")
85                           (:+ics "-ics")))
86      #+clisp     (let ((s (lisp-implementation-version)))
87                    (subseq s 0 (position #\space s)))
88      #+armedbear (lisp-implementation-version)
89      #+ecl (ecl-version-string) )
90    
91    (defun unique-dir-name ()
92      "Return a name that can be used as a directory name that is
93    unique to a Lisp implementation, Lisp implementation version,
94    operating system, and hardware architecture."
95      (flet ((first-of (features)
96               (loop for f in features
97                     when (find f *features*) return it))
98             (maybe-warn (value fstring &rest args)
99               (cond (value)
100                     (t (apply #'warn fstring args)
101                        "unknown"))))
102        (let ((lisp (maybe-warn (first-of *implementation-features*)
103                                "No implementation feature found in ~a."
104                                *implementation-features*))
105              (os   (maybe-warn (first-of *os-features*)
106                                "No os feature found in ~a." *os-features*))
107              (arch (maybe-warn (first-of *architecture-features*)
108                                "No architecture feature found in ~a."
109                                *architecture-features*))
110              (version (maybe-warn (lisp-version-string)
111                                   "Don't know how to get Lisp ~
112                                    implementation version.")))
113          (format nil "~(~@{~a~^-~}~)" lisp version os arch))))
114    
115  (defun file-newer-p (new-file old-file)  (defun file-newer-p (new-file old-file)
116    "Returns true if NEW-FILE is newer than OLD-FILE."    "Returns true if NEW-FILE is newer than OLD-FILE."
117    (> (file-write-date new-file) (file-write-date old-file)))    (> (file-write-date new-file) (file-write-date old-file)))
118    
119  (defun binary-pathname (source-pathname)  (defun slime-version-string ()
120    "Return the pathname where SOURCE-PATHNAME's binary should be compiled."    "Return a string identifying the SLIME version.
121    (let ((cfp (compile-file-pathname source-pathname)))  Return nil if nothing appropriate is available."
122      (merge-pathnames (make-pathname    (with-open-file (s (merge-pathnames "ChangeLog" *source-directory*)
123                        :directory `(:relative ".slime" "fasl" ,*lisp-name*)                       :if-does-not-exist nil)
124                        :name (pathname-name cfp)      (and s (symbol-name (read s)))))
125                        :type (pathname-type cfp))  
126                       (user-homedir-pathname))))  (defun default-fasl-dir ()
127      (merge-pathnames
128  (defun compile-files-if-needed-serially (files)     (make-pathname
129    "Compile each file in FILES if the source is newer than      :directory `(:relative ".slime" "fasl"
130  its corresponding binary, or the file preceding it was                   ,@(if (slime-version-string) (list (slime-version-string)))
131  recompiled."                   ,(unique-dir-name)))
132    (with-compilation-unit ()     (user-homedir-pathname)))
133      (let ((needs-recompile nil))  
134        (dolist (source-pathname files)  (defvar *fasl-directory* (default-fasl-dir)
135          (let ((binary-pathname (binary-pathname source-pathname)))    "The directory where fasl files should be placed.")
136            (handler-case  
137                (progn  (defun binary-pathname (src-pathname binary-dir)
138                  (when (or needs-recompile    "Return the pathname where SRC-PATHNAME's binary should be compiled."
139                            (not (probe-file binary-pathname))    (let ((cfp (compile-file-pathname src-pathname)))
140                            (file-newer-p source-pathname binary-pathname))      (merge-pathnames (make-pathname :name (pathname-name cfp)
141                    (format t "~&;; Compiling ~A...~%" source-pathname)                                      :type (pathname-type cfp))
142                    (ensure-directories-exist binary-pathname)                       binary-dir)))
143                    (compile-file source-pathname :output-file binary-pathname)  
144                    (setq needs-recompile t))  (defun handle-swank-load-error (condition context pathname)
145                  (load binary-pathname))    (fresh-line *error-output*)
146              #+(or)    (pprint-logical-block (*error-output* () :per-line-prefix ";; ")
147              (error ()      (format *error-output*
148                ;; If an error occurs compiling, load the source instead              "~%Error while ~A ~A:~%  ~A~%Aborting.~%"
149                ;; so we can try to debug it.              context pathname condition))
150                (load source-pathname))    (when (equal (directory-namestring pathname)
151              ))))))                 (directory-namestring *fasl-directory*))
152        (ignore-errors (delete-file pathname)))
153  (defun user-init-file ()    (abort))
154    "Return the name of the user init file or nil."  
155    (probe-file (merge-pathnames (user-homedir-pathname)  (defun compile-files (files fasl-dir load)
156                                 (make-pathname :name ".swank" :type "lisp"))))    "Compile each file in FILES if the source is newer than its
157    corresponding binary, or the file preceding it was recompiled.
158    If LOAD is true, load the fasl file."
159  (compile-files-if-needed-serially    (let ((needs-recompile nil)
160    (append (list (make-swank-pathname "swank-backend"))          (state :unknown))
161            *sysdep-pathnames*      (dolist (src files)
162            (list *swank-pathname*)))        (let ((dest (binary-pathname src fasl-dir)))
163            (handler-case
164  (funcall (intern (string :warn-unimplemented-interfaces) :swank-backend))              (progn
165                  (when (or needs-recompile
166  (when (user-init-file)                          (not (probe-file dest))
167    (load (user-init-file)))                          (file-newer-p src dest))
168                    (ensure-directories-exist dest)
169                    ;; need to recompile SRC, so we'll need to recompile
170                    ;; everything after this too.
171                    (setq needs-recompile t)
172                    (setq state :compile)
173                    (or (compile-file src :output-file dest :print nil :verbose t)
174                        ;; An implementation may not necessarily signal a
175                        ;; condition itself when COMPILE-FILE fails (e.g. ECL)
176                        (error "COMPILE-FILE returned NIL.")))
177                  (when load
178                    (setq state :load)
179                    (load dest :verbose t)))
180              ;; Fail as early as possible
181              (serious-condition (c)
182                (ecase state
183                  (:compile (handle-swank-load-error c "compiling" src))
184                  (:load    (handle-swank-load-error c "loading" dest))
185                  (:unknown (handle-swank-load-error c "???ing" src)))))))))
186    
187    #+(or cormanlisp)
188    (defun compile-files (files fasl-dir load)
189      "Corman Lisp has trouble with compiled files."
190      (declare (ignore fasl-dir))
191      (when load
192        (dolist (file files)
193          (load file :verbose t)
194          (force-output))))
195    
196    (defun load-user-init-file ()
197      "Load the user init file, return NIL if it does not exist."
198      (load (merge-pathnames (user-homedir-pathname)
199                             (make-pathname :name ".swank" :type "lisp"))
200            :if-does-not-exist nil))
201    
202    (defun load-site-init-file (dir)
203      (load (make-pathname :name "site-init" :type "lisp"
204                           :defaults dir)
205            :if-does-not-exist nil))
206    
207    (defun src-files (names src-dir)
208      (mapcar (lambda (name)
209                (make-pathname :name (string-downcase name) :type "lisp"
210                               :defaults src-dir))
211              names))
212    
213    (defvar *swank-files*
214      `(swank-backend ,@*sysdep-files* swank-match swank-rpc swank))
215    
216    (defvar *contribs*
217      '(swank-util
218        swank-c-p-c swank-arglists swank-fuzzy
219        swank-fancy-inspector
220        swank-presentations swank-presentation-streams
221        #+(or asdf sbcl ecl) swank-asdf
222        swank-package-fu
223        swank-hyperdoc
224        #+sbcl swank-sbcl-exts
225        swank-mrepl
226        )
227      "List of names for contrib modules.")
228    
229    (defun append-dir (absolute name)
230      (merge-pathnames
231       (make-pathname :directory `(:relative ,name) :defaults absolute)
232       absolute))
233    
234    (defun contrib-dir (base-dir)
235      (append-dir base-dir "contrib"))
236    
237    (defun load-swank (&key (src-dir *source-directory*)
238                            (fasl-dir *fasl-directory*))
239      (compile-files (src-files *swank-files* src-dir) fasl-dir t)
240      (funcall (q "swank::before-init")
241               (slime-version-string)
242               (list (contrib-dir fasl-dir)
243                     (contrib-dir src-dir))))
244    
245    (defun compile-contribs (&key (src-dir (contrib-dir *source-directory*))
246                             (fasl-dir (contrib-dir *fasl-directory*))
247                             load)
248      (compile-files (src-files *contribs* src-dir) fasl-dir load))
249    
250    (defun loadup ()
251      (load-swank)
252      (compile-contribs :load t))
253    
254    (defun setup ()
255      (load-site-init-file *source-directory*)
256      (load-user-init-file)
257      (when (#-clisp probe-file
258             #+clisp ext:probe-directory
259             (contrib-dir *source-directory*))
260        (eval `(pushnew 'compile-contribs ,(q "swank::*after-init-hook*"))))
261      (funcall (q "swank::init")))
262    
263    (defun init (&key delete reload load-contribs (setup t))
264      "Load SWANK and initialize some global variables.
265    If DELETE is true, delete any existing SWANK packages.
266    If RELOAD is true, reload SWANK, even if the SWANK package already exists.
267    If LOAD-CONTRIBS is true, load all contribs
268    If SETUP is true, load user init files and initialize some
269    global variabes in SWANK."
270      (when (and delete (find-package :swank))
271        (mapc #'delete-package '(:swank :swank-io-package :swank-backend)))
272      (cond ((or (not (find-package :swank)) reload)
273             (load-swank))
274            (t
275             (warn "Not reloading SWANK.  Package already exists.")))
276      (when load-contribs
277        (compile-contribs :load t))
278      (when setup
279        (setup)))
280    
281    (defun dump-image (filename)
282      (init :setup nil)
283      (funcall (q "swank-backend:save-image") filename))

Legend:
Removed from v.1.35  
changed lines
  Added in v.1.112

  ViewVC Help
Powered by ViewVC 1.1.5