# HG changeset patch # User Steve Losh # Date 1460299310 0 # Node ID e29b793a6e91dc7b39e4fbb2e28dedbd16764202 # Parent 51022d18e98f705067c42efffb1859133616b472 Rename the utils files diff -r 51022d18e98f -r e29b793a6e91 .lispwords --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/.lispwords Sun Apr 10 14:41:50 2016 +0000 @@ -0,0 +1,1 @@ +(1 vector-push-extend-all) diff -r 51022d18e98f -r e29b793a6e91 Makefile --- a/Makefile Sun Apr 10 14:35:22 2016 +0000 +++ b/Makefile Sun Apr 10 14:41:50 2016 +0000 @@ -7,8 +7,8 @@ test: sbcl --noinform --load test/run.lisp --eval '(quit)' -src/utils.lisp: src/make-utilities.lisp - cd src && sbcl --noinform --load make-utilities.lisp --eval '(quit)' +src/quickutils.lisp: src/make-quickutils.lisp + cd src && sbcl --noinform --load make-quickutils.lisp --eval '(quit)' $(apidoc): $(sourcefiles) docs/api.lisp sbcl --noinform --load docs/api.lisp --eval '(quit)' diff -r 51022d18e98f -r e29b793a6e91 bones.asd --- a/bones.asd Sun Apr 10 14:35:22 2016 +0000 +++ b/bones.asd Sun Apr 10 14:41:50 2016 +0000 @@ -16,11 +16,11 @@ #:fare-quasiquote-readtable) :serial t - :components ((:file "src/utils") ; quickutils package ordering crap + :components ((:file "src/quickutils") ; quickutils package ordering crap (:file "package") (:module "src" :components ((:file "paip") - (:file "more-utilities") + (:file "utils") (:module "wam" :components ((:file "constants") (:file "types") diff -r 51022d18e98f -r e29b793a6e91 package-test.lisp --- a/package-test.lisp Sun Apr 10 14:35:22 2016 +0000 +++ b/package-test.lisp Sun Apr 10 14:41:50 2016 +0000 @@ -1,10 +1,12 @@ (defpackage #:bones-test - (:use #:cl #:5am + (:use #:cl + #:5am #:bones)) (defpackage #:bones-test.paip - (:use #:cl #:5am - #:bones.utils + (:use #:cl + #:5am + #:bones.quickutils #:bones.paip) ; kill me (:shadowing-import-from #:5am #:fail)) diff -r 51022d18e98f -r e29b793a6e91 package.lisp --- a/package.lisp Sun Apr 10 14:35:22 2016 +0000 +++ b/package.lisp Sun Apr 10 14:41:50 2016 +0000 @@ -2,20 +2,26 @@ (:use #:cl) (:export #:hello)) -(defpackage #:bones.more-utils - (:use #:cl #:defstar #:bones.utils) +(defpackage #:bones.utils + (:use #:cl + #:defstar + #:bones.quickutils) (:export #:vector-push-extend-all #:push-if-new)) (defpackage #:bones.wam - (:use #:cl #:defstar #:optima #:cl-arrows - #:bones.utils #:bones.more-utils) + (:use #:cl + #:defstar + #:optima + #:cl-arrows + #:bones.quickutils + #:bones.utils) (:import-from #:optima #:match) (:shadowing-import-from #:cl-arrows #:->)) (defpackage #:bones.paip - (:use #:cl #:defstar #:bones.utils) + (:use #:cl #:defstar #:bones.quickutils) (:documentation "Test?") (:export diff -r 51022d18e98f -r e29b793a6e91 src/make-quickutils.lisp --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/make-quickutils.lisp Sun Apr 10 14:41:50 2016 +0000 @@ -0,0 +1,16 @@ +(ql:quickload 'quickutil) + +(qtlc:save-utils-as + "quickutils.lisp" + :utilities '(:define-constant + :set-equal + :curry + :switch + :ensure-boolean + :while + :until + :tree-member-p + :with-gensyms + :map-tree + ) + :package "BONES.QUICKUTILS") diff -r 51022d18e98f -r e29b793a6e91 src/make-utilities.lisp --- a/src/make-utilities.lisp Sun Apr 10 14:35:22 2016 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,15 +0,0 @@ -(ql:quickload 'quickutil) - -(qtlc:save-utils-as "utils.lisp" - :utilities '(:define-constant - :set-equal - :curry - :switch - :ensure-boolean - :while - :until - :tree-member-p - :with-gensyms - :map-tree - ) - :package "BONES.UTILS") diff -r 51022d18e98f -r e29b793a6e91 src/more-utilities.lisp --- a/src/more-utilities.lisp Sun Apr 10 14:35:22 2016 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,9 +0,0 @@ -(in-package #:bones.more-utils) - -;; TODO: learn setf expanders and do this right. -(defmacro push-if-new (thing list-place) - `(not (eql ,list-place (pushnew ,thing ,list-place)))) - -(defun vector-push-extend-all (vector &rest things) - (loop :for thing :in things :do - (vector-push-extend thing vector))) diff -r 51022d18e98f -r e29b793a6e91 src/quickutils.lisp --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/quickutils.lisp Sun Apr 10 14:41:50 2016 +0000 @@ -0,0 +1,255 @@ +;;;; This file was automatically generated by Quickutil. +;;;; See http://quickutil.org for details. + +;;;; To regenerate: +;;;; (qtlc:save-utils-as "quickutils.lisp" :utilities '(:DEFINE-CONSTANT :SET-EQUAL :CURRY :SWITCH :ENSURE-BOOLEAN :WHILE :UNTIL :TREE-MEMBER-P :WITH-GENSYMS :MAP-TREE) :ensure-package T :package "BONES.QUICKUTILS") + +(eval-when (:compile-toplevel :load-toplevel :execute) + (unless (find-package "BONES.QUICKUTILS") + (defpackage "BONES.QUICKUTILS" + (:documentation "Package that contains Quickutil utility functions.") + (:use #:cl)))) + +(in-package "BONES.QUICKUTILS") + +(when (boundp '*utilities*) + (setf *utilities* (union *utilities* '(:DEFINE-CONSTANT :SET-EQUAL + :MAKE-GENSYM-LIST :ENSURE-FUNCTION + :CURRY :STRING-DESIGNATOR + :WITH-GENSYMS :EXTRACT-FUNCTION-NAME + :SWITCH :ENSURE-BOOLEAN :UNTIL :WHILE + :TREE-MEMBER-P :MAP-TREE)))) + + (defun %reevaluate-constant (name value test) + (if (not (boundp name)) + value + (let ((old (symbol-value name)) + (new value)) + (if (not (constantp name)) + (prog1 new + (cerror "Try to redefine the variable as a constant." + "~@<~S is an already bound non-constant variable ~ + whose value is ~S.~:@>" name old)) + (if (funcall test old new) + old + (restart-case + (error "~@<~S is an already defined constant whose value ~ + ~S is not equal to the provided initial value ~S ~ + under ~S.~:@>" name old new test) + (ignore () + :report "Retain the current value." + old) + (continue () + :report "Try to redefine the constant." + new))))))) + + (defmacro define-constant (name initial-value &key (test ''eql) documentation) + "Ensures that the global variable named by `name` is a constant with a value +that is equal under `test` to the result of evaluating `initial-value`. `test` is a +function designator that defaults to `eql`. If `documentation` is given, it +becomes the documentation string of the constant. + +Signals an error if `name` is already a bound non-constant variable. + +Signals an error if `name` is already a constant variable whose value is not +equal under `test` to result of evaluating `initial-value`." + `(defconstant ,name (%reevaluate-constant ',name ,initial-value ,test) + ,@(when documentation `(,documentation)))) + + + (defun set-equal (list1 list2 &key (test #'eql) (key nil keyp)) + "Returns true if every element of `list1` matches some element of `list2` and +every element of `list2` matches some element of `list1`. Otherwise returns false." + (let ((keylist1 (if keyp (mapcar key list1) list1)) + (keylist2 (if keyp (mapcar key list2) list2))) + (and (dolist (elt keylist1 t) + (or (member elt keylist2 :test test) + (return nil))) + (dolist (elt keylist2 t) + (or (member elt keylist1 :test test) + (return nil)))))) + +(eval-when (:compile-toplevel :load-toplevel :execute) + (defun make-gensym-list (length &optional (x "G")) + "Returns a list of `length` gensyms, each generated as if with a call to `make-gensym`, +using the second (optional, defaulting to `\"G\"`) argument." + (let ((g (if (typep x '(integer 0)) x (string x)))) + (loop repeat length + collect (gensym g)))) + ) ; eval-when +(eval-when (:compile-toplevel :load-toplevel :execute) + ;;; To propagate return type and allow the compiler to eliminate the IF when + ;;; it is known if the argument is function or not. + (declaim (inline ensure-function)) + + (declaim (ftype (function (t) (values function &optional)) + ensure-function)) + (defun ensure-function (function-designator) + "Returns the function designated by `function-designator`: +if `function-designator` is a function, it is returned, otherwise +it must be a function name and its `fdefinition` is returned." + (if (functionp function-designator) + function-designator + (fdefinition function-designator))) + ) ; eval-when + + (defun curry (function &rest arguments) + "Returns a function that applies `arguments` and the arguments +it is called with to `function`." + (declare (optimize (speed 3) (safety 1) (debug 1))) + (let ((fn (ensure-function function))) + (lambda (&rest more) + (declare (dynamic-extent more)) + ;; Using M-V-C we don't need to append the arguments. + (multiple-value-call fn (values-list arguments) (values-list more))))) + + (define-compiler-macro curry (function &rest arguments) + (let ((curries (make-gensym-list (length arguments) "CURRY")) + (fun (gensym "FUN"))) + `(let ((,fun (ensure-function ,function)) + ,@(mapcar #'list curries arguments)) + (declare (optimize (speed 3) (safety 1) (debug 1))) + (lambda (&rest more) + (apply ,fun ,@curries more))))) + + + (deftype string-designator () + "A string designator type. A string designator is either a string, a symbol, +or a character." + `(or symbol string character)) + +(eval-when (:compile-toplevel :load-toplevel :execute) + (defmacro with-gensyms (names &body forms) + "Binds each variable named by a symbol in `names` to a unique symbol around +`forms`. Each of `names` must either be either a symbol, or of the form: + + (symbol string-designator) + +Bare symbols appearing in `names` are equivalent to: + + (symbol symbol) + +The string-designator is used as the argument to `gensym` when constructing the +unique symbol the named variable will be bound to." + `(let ,(mapcar (lambda (name) + (multiple-value-bind (symbol string) + (etypecase name + (symbol + (values name (symbol-name name))) + ((cons symbol (cons string-designator null)) + (values (first name) (string (second name))))) + `(,symbol (gensym ,string)))) + names) + ,@forms)) + + (defmacro with-unique-names (names &body forms) + "Binds each variable named by a symbol in `names` to a unique symbol around +`forms`. Each of `names` must either be either a symbol, or of the form: + + (symbol string-designator) + +Bare symbols appearing in `names` are equivalent to: + + (symbol symbol) + +The string-designator is used as the argument to `gensym` when constructing the +unique symbol the named variable will be bound to." + `(with-gensyms ,names ,@forms)) + ) ; eval-when +(eval-when (:compile-toplevel :load-toplevel :execute) + (defun extract-function-name (spec) + "Useful for macros that want to mimic the functional interface for functions +like `#'eq` and `'eq`." + (if (and (consp spec) + (member (first spec) '(quote function))) + (second spec) + spec)) + ) ; eval-when + + (eval-when (:compile-toplevel :load-toplevel :execute) + (defun generate-switch-body (whole object clauses test key &optional default) + (with-gensyms (value) + (setf test (extract-function-name test)) + (setf key (extract-function-name key)) + (when (and (consp default) + (member (first default) '(error cerror))) + (setf default `(,@default "No keys match in SWITCH. Testing against ~S with ~S." + ,value ',test))) + `(let ((,value (,key ,object))) + (cond ,@(mapcar (lambda (clause) + (if (member (first clause) '(t otherwise)) + (progn + (when default + (error "Multiple default clauses or illegal use of a default clause in ~S." + whole)) + (setf default `(progn ,@(rest clause))) + '(())) + (destructuring-bind (key-form &body forms) clause + `((,test ,value ,key-form) + ,@forms)))) + clauses) + (t ,default)))))) + + (defmacro switch (&whole whole (object &key (test 'eql) (key 'identity)) + &body clauses) + "Evaluates first matching clause, returning its values, or evaluates and +returns the values of `default` if no keys match." + (generate-switch-body whole object clauses test key)) + + (defmacro eswitch (&whole whole (object &key (test 'eql) (key 'identity)) + &body clauses) + "Like `switch`, but signals an error if no key matches." + (generate-switch-body whole object clauses test key '(error))) + + (defmacro cswitch (&whole whole (object &key (test 'eql) (key 'identity)) + &body clauses) + "Like `switch`, but signals a continuable error if no key matches." + (generate-switch-body whole object clauses test key '(cerror "Return NIL from CSWITCH."))) + + + (defun ensure-boolean (x) + "Convert `x` into a Boolean value." + (and x t)) + + + (defmacro until (expression &body body) + "Executes `body` until `expression` is true." + `(do () + (,expression) + ,@body)) + + + (defmacro while (expression &body body) + "Executes `body` while `expression` is true." + `(until (not ,expression) + ,@body)) + + + (defun tree-member-p (item tree &key (test #'eql)) + "Returns `t` if `item` is in `tree`, `nil` otherwise." + (labels ((rec (tree) + (cond ((null tree) nil) + ((atom tree) (funcall test item tree)) + (t (or (rec (car tree)) + (rec (cdr tree))))))) + (rec tree))) + + + (defun map-tree (function tree) + "Map `function` to each of the leave of `tree`." + (check-type tree cons) + (labels ((rec (tree) + (cond + ((null tree) nil) + ((atom tree) (funcall function tree)) + ((consp tree) + (cons (rec (car tree)) + (rec (cdr tree))))))) + (rec tree))) + +(eval-when (:compile-toplevel :load-toplevel :execute) + (export '(define-constant set-equal curry switch eswitch cswitch + ensure-boolean while until tree-member-p with-gensyms + with-unique-names map-tree))) + +;;;; END OF quickutils.lisp ;;;; diff -r 51022d18e98f -r e29b793a6e91 src/utils.lisp --- a/src/utils.lisp Sun Apr 10 14:35:22 2016 +0000 +++ b/src/utils.lisp Sun Apr 10 14:41:50 2016 +0000 @@ -1,255 +1,9 @@ -;;;; This file was automatically generated by Quickutil. -;;;; See http://quickutil.org for details. - -;;;; To regenerate: -;;;; (qtlc:save-utils-as "utils.lisp" :utilities '(:DEFINE-CONSTANT :SET-EQUAL :CURRY :SWITCH :ENSURE-BOOLEAN :WHILE :UNTIL :TREE-MEMBER-P :WITH-GENSYMS :MAP-TREE) :ensure-package T :package "BONES.UTILS") - -(eval-when (:compile-toplevel :load-toplevel :execute) - (unless (find-package "BONES.UTILS") - (defpackage "BONES.UTILS" - (:documentation "Package that contains Quickutil utility functions.") - (:use #:cl)))) - -(in-package "BONES.UTILS") - -(when (boundp '*utilities*) - (setf *utilities* (union *utilities* '(:DEFINE-CONSTANT :SET-EQUAL - :MAKE-GENSYM-LIST :ENSURE-FUNCTION - :CURRY :STRING-DESIGNATOR - :WITH-GENSYMS :EXTRACT-FUNCTION-NAME - :SWITCH :ENSURE-BOOLEAN :UNTIL :WHILE - :TREE-MEMBER-P :MAP-TREE)))) - - (defun %reevaluate-constant (name value test) - (if (not (boundp name)) - value - (let ((old (symbol-value name)) - (new value)) - (if (not (constantp name)) - (prog1 new - (cerror "Try to redefine the variable as a constant." - "~@<~S is an already bound non-constant variable ~ - whose value is ~S.~:@>" name old)) - (if (funcall test old new) - old - (restart-case - (error "~@<~S is an already defined constant whose value ~ - ~S is not equal to the provided initial value ~S ~ - under ~S.~:@>" name old new test) - (ignore () - :report "Retain the current value." - old) - (continue () - :report "Try to redefine the constant." - new))))))) - - (defmacro define-constant (name initial-value &key (test ''eql) documentation) - "Ensures that the global variable named by `name` is a constant with a value -that is equal under `test` to the result of evaluating `initial-value`. `test` is a -function designator that defaults to `eql`. If `documentation` is given, it -becomes the documentation string of the constant. - -Signals an error if `name` is already a bound non-constant variable. - -Signals an error if `name` is already a constant variable whose value is not -equal under `test` to result of evaluating `initial-value`." - `(defconstant ,name (%reevaluate-constant ',name ,initial-value ,test) - ,@(when documentation `(,documentation)))) - - - (defun set-equal (list1 list2 &key (test #'eql) (key nil keyp)) - "Returns true if every element of `list1` matches some element of `list2` and -every element of `list2` matches some element of `list1`. Otherwise returns false." - (let ((keylist1 (if keyp (mapcar key list1) list1)) - (keylist2 (if keyp (mapcar key list2) list2))) - (and (dolist (elt keylist1 t) - (or (member elt keylist2 :test test) - (return nil))) - (dolist (elt keylist2 t) - (or (member elt keylist1 :test test) - (return nil)))))) - -(eval-when (:compile-toplevel :load-toplevel :execute) - (defun make-gensym-list (length &optional (x "G")) - "Returns a list of `length` gensyms, each generated as if with a call to `make-gensym`, -using the second (optional, defaulting to `\"G\"`) argument." - (let ((g (if (typep x '(integer 0)) x (string x)))) - (loop repeat length - collect (gensym g)))) - ) ; eval-when -(eval-when (:compile-toplevel :load-toplevel :execute) - ;;; To propagate return type and allow the compiler to eliminate the IF when - ;;; it is known if the argument is function or not. - (declaim (inline ensure-function)) - - (declaim (ftype (function (t) (values function &optional)) - ensure-function)) - (defun ensure-function (function-designator) - "Returns the function designated by `function-designator`: -if `function-designator` is a function, it is returned, otherwise -it must be a function name and its `fdefinition` is returned." - (if (functionp function-designator) - function-designator - (fdefinition function-designator))) - ) ; eval-when - - (defun curry (function &rest arguments) - "Returns a function that applies `arguments` and the arguments -it is called with to `function`." - (declare (optimize (speed 3) (safety 1) (debug 1))) - (let ((fn (ensure-function function))) - (lambda (&rest more) - (declare (dynamic-extent more)) - ;; Using M-V-C we don't need to append the arguments. - (multiple-value-call fn (values-list arguments) (values-list more))))) - - (define-compiler-macro curry (function &rest arguments) - (let ((curries (make-gensym-list (length arguments) "CURRY")) - (fun (gensym "FUN"))) - `(let ((,fun (ensure-function ,function)) - ,@(mapcar #'list curries arguments)) - (declare (optimize (speed 3) (safety 1) (debug 1))) - (lambda (&rest more) - (apply ,fun ,@curries more))))) - - - (deftype string-designator () - "A string designator type. A string designator is either a string, a symbol, -or a character." - `(or symbol string character)) - -(eval-when (:compile-toplevel :load-toplevel :execute) - (defmacro with-gensyms (names &body forms) - "Binds each variable named by a symbol in `names` to a unique symbol around -`forms`. Each of `names` must either be either a symbol, or of the form: - - (symbol string-designator) +(in-package #:bones.utils) -Bare symbols appearing in `names` are equivalent to: - - (symbol symbol) - -The string-designator is used as the argument to `gensym` when constructing the -unique symbol the named variable will be bound to." - `(let ,(mapcar (lambda (name) - (multiple-value-bind (symbol string) - (etypecase name - (symbol - (values name (symbol-name name))) - ((cons symbol (cons string-designator null)) - (values (first name) (string (second name))))) - `(,symbol (gensym ,string)))) - names) - ,@forms)) - - (defmacro with-unique-names (names &body forms) - "Binds each variable named by a symbol in `names` to a unique symbol around -`forms`. Each of `names` must either be either a symbol, or of the form: - - (symbol string-designator) - -Bare symbols appearing in `names` are equivalent to: - - (symbol symbol) - -The string-designator is used as the argument to `gensym` when constructing the -unique symbol the named variable will be bound to." - `(with-gensyms ,names ,@forms)) - ) ; eval-when -(eval-when (:compile-toplevel :load-toplevel :execute) - (defun extract-function-name (spec) - "Useful for macros that want to mimic the functional interface for functions -like `#'eq` and `'eq`." - (if (and (consp spec) - (member (first spec) '(quote function))) - (second spec) - spec)) - ) ; eval-when +;; TODO: learn setf expanders and do this right. +(defmacro push-if-new (thing list-place) + `(not (eql ,list-place (pushnew ,thing ,list-place)))) - (eval-when (:compile-toplevel :load-toplevel :execute) - (defun generate-switch-body (whole object clauses test key &optional default) - (with-gensyms (value) - (setf test (extract-function-name test)) - (setf key (extract-function-name key)) - (when (and (consp default) - (member (first default) '(error cerror))) - (setf default `(,@default "No keys match in SWITCH. Testing against ~S with ~S." - ,value ',test))) - `(let ((,value (,key ,object))) - (cond ,@(mapcar (lambda (clause) - (if (member (first clause) '(t otherwise)) - (progn - (when default - (error "Multiple default clauses or illegal use of a default clause in ~S." - whole)) - (setf default `(progn ,@(rest clause))) - '(())) - (destructuring-bind (key-form &body forms) clause - `((,test ,value ,key-form) - ,@forms)))) - clauses) - (t ,default)))))) - - (defmacro switch (&whole whole (object &key (test 'eql) (key 'identity)) - &body clauses) - "Evaluates first matching clause, returning its values, or evaluates and -returns the values of `default` if no keys match." - (generate-switch-body whole object clauses test key)) - - (defmacro eswitch (&whole whole (object &key (test 'eql) (key 'identity)) - &body clauses) - "Like `switch`, but signals an error if no key matches." - (generate-switch-body whole object clauses test key '(error))) - - (defmacro cswitch (&whole whole (object &key (test 'eql) (key 'identity)) - &body clauses) - "Like `switch`, but signals a continuable error if no key matches." - (generate-switch-body whole object clauses test key '(cerror "Return NIL from CSWITCH."))) - - - (defun ensure-boolean (x) - "Convert `x` into a Boolean value." - (and x t)) - - - (defmacro until (expression &body body) - "Executes `body` until `expression` is true." - `(do () - (,expression) - ,@body)) - - - (defmacro while (expression &body body) - "Executes `body` while `expression` is true." - `(until (not ,expression) - ,@body)) - - - (defun tree-member-p (item tree &key (test #'eql)) - "Returns `t` if `item` is in `tree`, `nil` otherwise." - (labels ((rec (tree) - (cond ((null tree) nil) - ((atom tree) (funcall test item tree)) - (t (or (rec (car tree)) - (rec (cdr tree))))))) - (rec tree))) - - - (defun map-tree (function tree) - "Map `function` to each of the leave of `tree`." - (check-type tree cons) - (labels ((rec (tree) - (cond - ((null tree) nil) - ((atom tree) (funcall function tree)) - ((consp tree) - (cons (rec (car tree)) - (rec (cdr tree))))))) - (rec tree))) - -(eval-when (:compile-toplevel :load-toplevel :execute) - (export '(define-constant set-equal curry switch eswitch cswitch - ensure-boolean while until tree-member-p with-gensyms - with-unique-names map-tree))) - -;;;; END OF utils.lisp ;;;; +(defun vector-push-extend-all (vector &rest things) + (loop :for thing :in things :do + (vector-push-extend thing vector)))