brmlab/hackerbase
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Duck util-proc.

Browse source
This commit is contained in:
Dominik Pantůček 2023-07-05 22:09:07 +02:00
parent 2f1589579e
commit a2c312741b
5 changed files with 109 additions and 64 deletions
Download patch file Download diff file Expand all files Collapse all files

66
doc/d-utils.md
View file

@ -274,3 +274,69 @@ most scheme implementations.
Returns a list containing only elements matching given ```pred?```
predicate.
## util-proc [module]
(import util-proc)
This module provides a few simple procedures for querying properties
of other procedures.
### improper-list-info [procedure]
(improper-list-info lst)
Returns two values: the proper part of the list length and #t if
there is an improper list end
### (procedure-arity=? n) [procedure]
((procedure-arity=? proc)
n)
* ```n``` - integer representing the number of arguments
* ```proc``` - procedure to query
Returns true if the procedure ```proc``` accepts exactly ```n```
arguments.
### (procedure-arity>=? n) [procedure]
((procedure-arity>=? proc)
n)
* ```n``` - integer representing the number of arguments
* ```proc``` - procedure to query
Returns true if the procedure ```proc``` accepts at least ```n```
arguments.
### (procedure-arity>? n) [procedure]
((procedure-arity>? proc)
n)
* ```n``` - integer representing the number of arguments
* ```proc``` - procedure to query
Returns true if the procedure ```proc``` accepts more than ```n```
arguments.
### procedure-num-args [procedure]
(procedure-num-args proc)
* ```proc``` - procedure to check
Returns the number of mandatory arguments.
### procedure-arg-names [procedure]
(procedure-arg-names proc)
* ```proc``` - procedure to check
Returns the (possibly improper) list of arguments the procedure
```proc``` accepts. If it accepts arbitrary number of arguments, it is
signalled by simple symbol instead of pair at the last position. If it
accepts an exact number of arguments, it returns a proper list.

46
doc/utils.md
View file

@ -162,52 +162,6 @@ sent to the address stored within.
Sends email using mail(1) command. The arguments ```#:to``` and
```#:subject``` are mandatory. Argument ```#:from``` is optional.
### Proc
(import util-proc)
This module provides a few simple procedures for querying properties
of other procedures.
((procedure-arity=? n) proc)
* ```n``` - integer representing the number of arguments
* ```proc``` - procedure to query
Returns true if the procedure ```proc``` accepts exactly ```n```
arguments.
((procedure-arity>=? n) proc)
* ```n``` - integer representing the number of arguments
* ```proc``` - procedure to query
Returns true if the procedure ```proc``` accepts at least ```n```
arguments.
((procedure-arity>? n) proc)
* ```n``` - integer representing the number of arguments
* ```proc``` - procedure to query
Returns true if the procedure ```proc``` accepts more than ```n```
arguments.
(procedure-num-args proc)
* ```proc``` - procedure to check
Returns the number of mandatory arguments.
(procedure-arg-names proc)
* ```proc``` - procedure to check
Returns the (possibly improper) list of arguments the procedure
```proc``` accepts. If it accepts arbitrary number of arguments, it is
signalled by simple symbol instead of pair at the last position. If it
accepts an exact number of arguments, it returns a proper list.
### Set (List)
(import util-set-list)

7
src/Makefile
View file

@ -60,11 +60,12 @@ HACKERBASE-OBJS=hackerbase.o testing.o listing.o cal-month.o \
GENDOC-SOURCES=gendoc.scm duck-extract.import.scm \
util-time.import.scm util-csv.import.scm util-git.import.scm \
util-io.import.scm util-stdout.import.scm \
util-parser.import.scm util-list.import.scm
util-parser.import.scm util-list.import.scm \
util-proc.import.scm
GENDOC-OBJS=gendoc.o duck-extract.o util-time.o util-csv.o util-io.o \
progress.o testing.o util-proc.o util-git.o util-io.o \
util-stdout.o util-parser.o util-list.o
util-stdout.o util-parser.o util-list.o util-proc.o
.PHONY: imports
imports: $(HACKERBASE-DEPS)
@ -130,7 +131,7 @@ listing.import.scm: $(LISTING-SOURCES)
UTIL-DICT-LIST-SOURCES=util-dict-list.scm testing.import.scm \
util-tag.import.scm util-proc.import.scm \
util-set-list.import.scm
util-set-list.import.scm duck.import.scm
util-dict-list.o: util-dict-list.import.scm
util-dict-list.import.scm: $(UTIL-DICT-LIST-SOURCES)

3
src/gendoc.scm
View file

@ -26,4 +26,5 @@
util-io
util-stdout
util-parser
util-list)
util-list
util-proc)

51
src/util-proc.scm
View file

@ -25,8 +25,12 @@
(declare (unit util-proc))
(module
(import duck)
(module*
util-proc
#:doc ("This module provides a few simple procedures for querying properties
of other procedures.")
(
improper-list-info
@ -41,9 +45,9 @@
(import scheme
(chicken base))
;; Returns two values: the proper part of the list length and #t if
;; there is an improper list end
(define (improper-list-info lst)
(define/doc (improper-list-info lst)
("Returns two values: the proper part of the list length and #t if
there is an improper list end")
(let loop ((lst lst)
(len 0))
(if (symbol? lst)
@ -59,31 +63,50 @@
(let-values (((len rest?) (improper-list-info (procedure-information proc))))
(values (sub1 len) rest?)))
;; Returns true if given procedure arity is exactly n
(define ((procedure-arity=? n) proc)
(define/doc ((procedure-arity=? n) proc)
("* ```n``` - integer representing the number of arguments
* ```proc``` - procedure to query
Returns true if the procedure ```proc``` accepts exactly ```n```
arguments.")
(let-values (((args rest?) (procedure-arity-info proc)))
(and (not rest?)
(= args n))))
;; Returns true if given procedure arity is greater than or equal to n
(define ((procedure-arity>=? n) proc)
(define/doc ((procedure-arity>=? n) proc)
("* ```n``` - integer representing the number of arguments
* ```proc``` - procedure to query
Returns true if the procedure ```proc``` accepts at least ```n```
arguments.")
(let-values (((args rest?) (procedure-arity-info proc)))
(or rest?
(>= args n))))
;; Returns true if given procedure arity is greater than n
(define ((procedure-arity>? n) proc)
(define/doc ((procedure-arity>? n) proc)
("* ```n``` - integer representing the number of arguments
* ```proc``` - procedure to query
Returns true if the procedure ```proc``` accepts more than ```n```
arguments.")
(let-values (((args rest?) (procedure-arity-info proc)))
(or rest?
(> args n))))
;; Returns the number of mandatory arguments
(define (procedure-num-args proc)
(define/doc (procedure-num-args proc)
("* ```proc``` - procedure to check
Returns the number of mandatory arguments.")
(let-values (((args rest?) (procedure-arity-info proc)))
args))
;; Returns the formal argument names for given procedure
(define (procedure-arg-names proc)
(define/doc (procedure-arg-names proc)
("* ```proc``` - procedure to check
Returns the (possibly improper) list of arguments the procedure
```proc``` accepts. If it accepts arbitrary number of arguments, it is
signalled by simple symbol instead of pair at the last position. If it
accepts an exact number of arguments, it returns a proper list.")
(cdr (procedure-information proc)))
)