utility.lisp 16.6 KB
Newer Older
1 2 3
;;;; -------------------------------------------------------------------------
;;;; General Purpose Utilities for ASDF

4 5
(asdf/package:define-package :asdf/utility
  (:recycle :asdf/utility :asdf)
6 7
  (:use :asdf/common-lisp :asdf/package)
  ;; import and reexport a few things defined in :asdf/common-lisp
8
  (:import-from :asdf/common-lisp #:compatfmt #:loop* #:remove-substrings
9
   #+ecl #:use-ecl-byte-compiler-p #+mcl #:probe-posix)
10
  (:export #:compatfmt #:loop* #:remove-substrings #:compatfmt
11
   #+ecl #:use-ecl-byte-compiler-p #+mcl #:probe-posix)
12
  (:export
13 14 15
   ;; magic helper to define debugging functions:
   #:asdf-debug #:load-asdf-debug-utility #:*asdf-debug-utility*
   #:undefine-function #:undefine-functions #:defun* #:defgeneric* ;; (un)defining functions
16
   #:if-let ;; basic flow control
17
   #:while-collecting #:appendf #:length=n-p #:remove-plist-keys #:remove-plist-key ;; lists and plists
18
   #:emptyp ;; sequences
19
   #:strcat #:first-char #:last-char #:split-string ;; strings
20
   #:string-prefix-p #:string-enclosed-p #:string-suffix-p
21
   #:find-class* ;; CLOS
22 23
   #:stamp< #:stamps< #:stamp*< #:stamp<= ;; stamps
   #:earlier-stamp #:stamps-earliest #:earliest-stamp
24 25
   #:later-stamp #:stamps-latest #:latest-stamp #:latest-stamp-f
   #:list-to-hash-set ;; hash-table
26
   #:ensure-function #:access-at #:access-at-count ;; functions
27
   #:call-function #:call-functions #:register-hook-function
28 29
   #:match-condition-p #:match-any-condition-p ;; conditions
   #:call-with-muffled-conditions #:with-muffled-conditions
30
   #:load-string #:load-stream
31
   #:parse-version #:unparse-version #:version-compatible-p)) ;; version
32 33
(in-package :asdf/utility)

34 35 36 37 38
;;;; Defining functions in a way compatible with hot-upgrade:
;; DEFUN* and DEFGENERIC* use FMAKUNBOUND to delete any previous fdefinition,
;; thus replacing the function without warning or error
;; even if the signature and/or generic-ness of the function has changed.
;; For a generic function, this invalidates any previous DEFMETHOD.
39 40 41
(eval-when (:load-toplevel :compile-toplevel :execute)
  (defun undefine-function (function-spec)
    (cond
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
42
      ((symbolp function-spec)
43
       #+clisp
Francois-Rene Rideau's avatar
Francois-Rene Rideau committed
44 45 46 47 48
       (let ((f (and (fboundp function-spec) (fdefinition function-spec))))
         (when (typep f 'clos:standard-generic-function)
           (loop :for m :in (clos:generic-function-methods f)
                 :do (remove-method f m))))
       (fmakunbound function-spec))
49 50
      ((and (consp function-spec) (eq (car function-spec) 'setf)
            (consp (cdr function-spec)) (null (cddr function-spec)))
51
       #-gcl2.6 (fmakunbound function-spec))
52 53 54 55
      (t (error "bad function spec ~S" function-spec))))
  (defun undefine-functions (function-spec-list)
    (map () 'undefine-function function-spec-list)))

56 57 58
(macrolet
    ((defdef (def* def)
       `(defmacro ,def* (name formals &rest rest)
59 60 61 62 63 64
          (destructuring-bind (name &key (supersede t))
              (if (or (atom name) (eq (car name) 'setf))
                  (list name :supersede nil)
                  name)
            (declare (ignorable supersede))
            `(progn
65
             ;; undefining the previous function is the portable way
66 67
             ;; of overriding any incompatible previous gf, except on CLISP.
             ;; We usually try to do it only for the functions that need it,
68 69
             ;; which happens in asdf/upgrade - however, for ECL, we need this hammer,
             ;; (which causes issues in clisp)
70
               ,@(when (or #-clisp supersede #+(or ecl gcl2.7) t) ; XXX
71 72 73 74 75
                   `((undefine-function ',name)))
               #-gcl ; gcl 2.7.0 notinline functions lose secondary return values :-(
               ,@(when (and #+ecl (symbolp name)) ; fails for setf functions on ecl
                   `((declaim (notinline ,name))))
               (,',def ,name ,formals ,@rest))))))
76 77 78
  (defdef defgeneric* defgeneric)
  (defdef defun* defun))

79 80 81

;;; Magic debugging help. See contrib/debug.lisp
(defvar *asdf-debug-utility*
82 83 84
  '(or (ignore-errors
        (symbol-call :asdf :system-relative-pathname :asdf-driver "contrib/debug.lisp"))
    (merge-pathnames "cl/asdf/contrib/debug.lisp" (user-homedir-pathname)))
85 86
  "form that evaluates to the pathname to your favorite debugging utilities")

87
(defmacro asdf-debug (&rest keys)
88
  `(eval-when (:compile-toplevel :load-toplevel :execute)
89
     (load-asdf-debug-utility ,@keys)))
90

91
(defun* load-asdf-debug-utility (&key package utility-file)
92 93 94 95 96 97 98 99 100 101
  (let* ((*package* (if package (find-package package) *package*))
         (keyword (read-from-string
                   (format nil ":DBG-~:@(~A~)" (package-name *package*)))))
    (unless (member keyword *features*)
      (let* ((utility-file (or utility-file *asdf-debug-utility*))
             (file (ignore-errors (probe-file (eval utility-file)))))
        (if file (load file)
            (error "Failed to locate debug utility file: ~S" utility-file))))))


102
;;; Flow control
103 104 105 106 107 108 109 110 111 112
(defmacro if-let (bindings &body (then-form &optional else-form)) ;; from alexandria
  ;; bindings can be (var form) or ((var1 form1) ...)
  (let* ((binding-list (if (and (consp bindings) (symbolp (car bindings)))
                           (list bindings)
                           bindings))
         (variables (mapcar #'car binding-list)))
    `(let ,binding-list
       (if (and ,@variables)
           ,then-form
           ,else-form))))
113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144

;;; List manipulation
(defmacro while-collecting ((&rest collectors) &body body)
  "COLLECTORS should be a list of names for collections.  A collector
defines a function that, when applied to an argument inside BODY, will
add its argument to the corresponding collection.  Returns multiple values,
a list for each collection, in order.
   E.g.,
\(while-collecting \(foo bar\)
           \(dolist \(x '\(\(a 1\) \(b 2\) \(c 3\)\)\)
             \(foo \(first x\)\)
             \(bar \(second x\)\)\)\)
Returns two values: \(A B C\) and \(1 2 3\)."
  (let ((vars (mapcar #'(lambda (x) (gensym (symbol-name x))) collectors))
        (initial-values (mapcar (constantly nil) collectors)))
    `(let ,(mapcar #'list vars initial-values)
       (flet ,(mapcar #'(lambda (c v) `(,c (x) (push x ,v) (values))) collectors vars)
         ,@body
         (values ,@(mapcar #'(lambda (v) `(reverse ,v)) vars))))))

(define-modify-macro appendf (&rest args)
  append "Append onto list") ;; only to be used on short lists.

(defun* length=n-p (x n) ;is it that (= (length x) n) ?
  (check-type n (integer 0 *))
  (loop
    :for l = x :then (cdr l)
    :for i :downfrom n :do
    (cond
      ((zerop i) (return (null l)))
      ((not (consp l)) (return nil)))))

145
;;; remove a key from a plist, i.e. for keyword argument cleanup
146
(defun* remove-plist-key (key plist)
147
  "Remove a single key from a plist"
148
  (loop* :for (k v) :on plist :by #'cddr
149 150 151
    :unless (eq k key)
    :append (list k v)))

152
(defun* remove-plist-keys (keys plist)
153
  "Remove a list of keys from a plist"
154
  (loop* :for (k v) :on plist :by #'cddr
155 156 157 158
    :unless (member k keys)
    :append (list k v)))


159
;;; Sequences
160
(defun* emptyp (x)
161 162 163
  "Predicate that is true for an empty sequence"
  (or (null x) (and (vectorp x) (zerop (length x)))))

164

165
;;; Strings
166 167
(defun* strcat (&rest strings)
  (apply 'concatenate 'string strings))
168

169 170 171 172 173 174 175 176 177 178 179 180
(defun* first-char (s)
  (and (stringp s) (plusp (length s)) (char s 0)))

(defun* last-char (s)
  (and (stringp s) (plusp (length s)) (char s (1- (length s)))))

(defun* split-string (string &key max (separator '(#\Space #\Tab)))
  "Split STRING into a list of components separated by
any of the characters in the sequence SEPARATOR.
If MAX is specified, then no more than max(1,MAX) components will be returned,
starting the separation from the end, e.g. when called with arguments
 \"a.b.c.d.e\" :max 3 :separator \".\" it will return (\"a.b.c\" \"d\" \"e\")."
181
  (block ()
182 183
    (let ((list nil) (words 0) (end (length string)))
      (flet ((separatorp (char) (find char separator))
184
             (done () (return (cons (subseq string 0 end) list))))
185 186 187 188 189 190 191 192 193 194
        (loop
          :for start = (if (and max (>= words (1- max)))
                           (done)
                           (position-if #'separatorp string :end end :from-end t)) :do
          (when (null start)
            (done))
          (push (subseq string (1+ start) end) list)
          (incf words)
          (setf end start))))))

195
(defun* string-prefix-p (prefix string)
196 197 198 199 200 201 202
  "Does STRING begin with PREFIX?"
  (let* ((x (string prefix))
         (y (string string))
         (lx (length x))
         (ly (length y)))
    (and (<= lx ly) (string= x y :end2 lx))))

203
(defun* string-suffix-p (string suffix)
204 205 206 207 208 209 210
  "Does STRING end with SUFFIX?"
  (let* ((x (string string))
         (y (string suffix))
         (lx (length x))
         (ly (length y)))
    (and (<= ly lx) (string= x y :start1 (- lx ly)))))

211
(defun* string-enclosed-p (prefix string suffix)
212 213 214 215
  "Does STRING begin with PREFIX and end with SUFFIX?"
  (and (string-prefix-p prefix string)
       (string-suffix-p string suffix)))

216 217 218 219 220

;;; CLOS
(defun* find-class* (x &optional (errorp t) environment)
  (etypecase x
    ((or standard-class built-in-class) x)
221
    #+gcl2.6 (keyword nil)
222 223
    (symbol (find-class x errorp environment))))

224 225 226

;;; stamps: a REAL or boolean where NIL=-infinity, T=+infinity
(deftype stamp () '(or real boolean))
227 228 229 230 231 232 233 234
(defun* stamp< (x y)
  (etypecase x
    (null (and y t))
    ((eql t) nil)
    (real (etypecase y
            (null nil)
            ((eql t) t)
            (real (< x y))))))
235 236
(defun* stamps< (list) (loop :for y :in list :for x = nil :then y :always (stamp< x y)))
(defun* stamp*< (&rest list) (stamps< list))
237 238 239 240 241 242 243 244 245
(defun* stamp<= (x y) (not (stamp< y x)))
(defun* earlier-stamp (x y) (if (stamp< x y) x y))
(defun* stamps-earliest (list) (reduce 'earlier-stamp list :initial-value t))
(defun* earliest-stamp (&rest list) (stamps-earliest list))
(defun* later-stamp (x y) (if (stamp< x y) y x))
(defun* stamps-latest (list) (reduce 'later-stamp list :initial-value nil))
(defun* latest-stamp (&rest list) (stamps-latest list))
(define-modify-macro latest-stamp-f (&rest stamps) latest-stamp)

246

247 248 249 250
;;; Hash-tables
(defun* list-to-hash-set (list &aux (h (make-hash-table :test 'equal)))
  (dolist (x list h) (setf (gethash x h) t)))

251

252
;;; Function designators
253
(defun* ensure-function (fun &key (package :cl))
254 255 256 257 258 259 260 261 262 263
  "Coerce the object FUN into a function.

If FUN is a FUNCTION, return it.
If the FUN is a non-sequence literal constant, return constantly that,
i.e. for a boolean keyword character number or pathname.
Otherwise if FUN is a non-literally constant symbol, return its FDEFINITION.
If FUN is a CONS, return the function that applies its CAR
to the appended list of the rest of its CDR and the arguments.
If FUN is a string, READ a form from it in the specified PACKAGE (default: CL)
and EVAL that in a (FUNCTION ...) context."
264
  (etypecase fun
265
    (function fun)
266
    ((or boolean keyword character number pathname) (constantly fun))
267
    ((or function symbol) fun)
268
    (cons #'(lambda (&rest args) (apply (car fun) (append (cdr fun) args))))
269 270
    (string (eval `(function ,(with-standard-io-syntax
                                (let ((*package* (find-package package)))
271
                                  (read-from-string fun))))))))
272

273 274
(defun* access-at (object at)
  "Given an OBJECT and an AT specifier, list of successive accessors,
275 276
call each accessor on the result of the previous calls.
An accessor may be an integer, meaning a call to ELT,
277 278 279 280 281
a keyword, meaning a call to GETF,
NIL, meaning identity,
a function or other symbol, meaning itself,
or a list of a function designator and arguments, interpreted as per ENSURE-FUNCTION.
As a degenerate case, the AT specifier may be an atom of a single such accessor
282 283 284
instead of a list."
  (flet ((access (object accessor)
           (etypecase accessor
285
             (function (funcall accessor object))
286
             (integer (elt object accessor))
287 288 289
             (keyword (getf object accessor))
             (null object)
             (symbol (funcall accessor object))
290
             (cons (funcall (ensure-function accessor) object)))))
291 292
    (if (listp at)
        (dolist (accessor at object)
293
          (setf object (access object accessor)))
294 295 296 297 298 299 300 301 302 303
        (access object at))))

(defun* access-at-count (at)
  "From an AT specification, extract a COUNT of maximum number
   of sub-objects to read as per ACCESS-AT"
  (cond
    ((integerp at)
     (1+ at))
    ((and (consp at) (integerp (first at)))
     (1+ (first at)))))
304

305 306
(defun* call-function (function-spec &rest arguments)
  (apply (ensure-function function-spec) arguments))
307 308

(defun* call-functions (function-specs)
309
  (map () 'call-function function-specs))
310

311
(defun* register-hook-function (variable hook &optional call-now-p)
312
  (pushnew hook (symbol-value variable))
313
  (when call-now-p (call-function hook)))
314

315 316

;;; Version handling
317 318 319 320 321 322 323 324 325 326 327 328
(defun* unparse-version (version-list)
  (format nil "~{~D~^.~}" version-list))

(defun* parse-version (version-string &optional on-error)
  "Parse a VERSION-STRING as a series of natural integers separated by dots.
Return a (non-null) list of integers if the string is valid;
otherwise return NIL.

When invalid, ON-ERROR is called as per CALL-FUNCTION before to return NIL,
with format arguments explaining why the version is invalid.
ON-ERROR is also called if the version is not canonical
in that it doesn't print back to itself, but the list is returned anyway."
329
  (block nil
330 331
   (unless (stringp version-string)
     (call-function on-error "~S: ~S is not a string" 'parse-version version-string)
332
     (return))
333
   (unless (loop :for prev = nil :then c :for c :across version-string
334 335 336 337
                 :always (or (digit-char-p c)
                             (and (eql c #\.) prev (not (eql prev #\.))))
                 :finally (return (and c (digit-char-p c))))
     (call-function on-error "~S: ~S doesn't follow asdf version numbering convention"
338
                    'parse-version version-string)
339
     (return))
340 341 342 343 344 345
   (let* ((version-list
            (mapcar #'parse-integer (split-string version-string :separator ".")))
          (normalized-version (unparse-version version-list)))
     (unless (equal version-string normalized-version)
       (call-function on-error "~S: ~S contains leading zeros" 'parse-version version-string))
     version-list)))
346

347

348 349 350 351 352
(defun* version-compatible-p (provided-version required-version)
  "Is the provided version a compatible substitution for the required-version?
If major versions differ, it's not compatible.
If they are equal, then any later version is compatible,
with later being determined by a lexicographical comparison of minor numbers."
353 354
  (let ((x (parse-version provided-version nil))
        (y (parse-version required-version nil)))
355 356 357 358 359 360 361 362 363
    (labels ((bigger (x y)
               (cond ((not y) t)
                     ((not x) nil)
                     ((> (car x) (car y)) t)
                     ((= (car x) (car y))
                      (bigger (cdr x) (cdr y))))))
      (and x y (= (car x) (car y))
           (or (not (cdr y)) (bigger (cdr x) (cdr y)))))))

364 365 366 367 368 369 370 371 372 373 374 375

;;; Condition control

(defvar *uninteresting-conditions* nil
  "Uninteresting conditions, as per MATCH-CONDITION-P")

(defparameter +simple-condition-format-control-slot+
  #+abcl 'system::format-control
  #+allegro 'excl::format-control
  #+clisp 'system::$format-control
  #+clozure 'ccl::format-control
  #+(or cmu scl) 'conditions::format-control
376
  #+ecl 'si::format-control
377 378
  #+(or gcl lispworks) 'conditions::format-string
  #+sbcl 'sb-kernel:format-control
379
  #-(or abcl allegro clisp clozure cmu ecl gcl lispworks sbcl scl) nil
380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408
  "Name of the slot for FORMAT-CONTROL in simple-condition")

(defun* match-condition-p (x condition)
  "Compare received CONDITION to some pattern X:
a symbol naming a condition class,
a simple vector of length 2, arguments to find-symbol* with result as above,
or a string describing the format-control of a simple-condition."
  (etypecase x
    (symbol (typep condition x))
    ((simple-vector 2) (typep condition (find-symbol* (svref x 0) (svref x 1) nil)))
    (function (funcall x condition))
    (string (and (typep condition 'simple-condition)
                 ;; On SBCL, it's always set and the check triggers a warning
                 #+(or allegro clozure cmu lispworks scl)
		 (slot-boundp condition +simple-condition-format-control-slot+)
                 (ignore-errors (equal (simple-condition-format-control condition) x))))))

(defun* match-any-condition-p (condition conditions)
  "match CONDITION against any of the patterns of CONDITIONS supplied"
  (loop :for x :in conditions :thereis (match-condition-p x condition)))

(defun* call-with-muffled-conditions (thunk conditions)
  (handler-bind ((t #'(lambda (c) (when (match-any-condition-p c conditions)
                                    (muffle-warning c)))))
    (funcall thunk)))

(defmacro with-muffled-uninteresting-conditions ((conditions) &body body)
  `(call-with-muffled-uninteresting-conditions #'(lambda () ,@body) ,conditions))

409