From 98cd04853c60bf7bfd25f7e669ab89abfef20852 Mon Sep 17 00:00:00 2001 From: Justin Ethier Date: Thu, 14 Jan 2016 02:34:18 -0500 Subject: [PATCH] Initial file --- docs/api/scheme/base.md | 5 +++++ docs/api/scheme/char.md | 15 +++++++++++++++ docs/api/scheme/eval.md | 8 ++++++++ docs/api/scheme/file.md | 12 ++++++++++++ docs/api/scheme/load.md | 13 +++++++++++++ docs/api/scheme/process-context.md | 9 +++++++++ docs/api/scheme/read.md | 2 +- docs/api/scheme/time.md | 7 +++++++ docs/api/scheme/write.md | 18 ++++++++++++++++++ 9 files changed, 88 insertions(+), 1 deletion(-) create mode 100644 docs/api/scheme/base.md create mode 100644 docs/api/scheme/char.md create mode 100644 docs/api/scheme/eval.md create mode 100644 docs/api/scheme/file.md create mode 100644 docs/api/scheme/load.md create mode 100644 docs/api/scheme/process-context.md create mode 100644 docs/api/scheme/time.md create mode 100644 docs/api/scheme/write.md diff --git a/docs/api/scheme/base.md b/docs/api/scheme/base.md new file mode 100644 index 00000000..030bb6b9 --- /dev/null +++ b/docs/api/scheme/base.md @@ -0,0 +1,5 @@ +# Base Library + +The `(scheme base)` library exports many of the procedures and syntax bindings that are traditionally associated with Scheme. + +TODO: list functions diff --git a/docs/api/scheme/char.md b/docs/api/scheme/char.md new file mode 100644 index 00000000..f3f8e772 --- /dev/null +++ b/docs/api/scheme/char.md @@ -0,0 +1,15 @@ +# Char Library + +The `(scheme char)` library provides the procedures for dealing with characters. + +- `char-alphabetic?` +- `char-downcase` +- `char-lower-case?` +- `char-numeric?` +- `char-upcase` +- `char-upper-case?` +- `char-whitespace?` +- `digit-value` +- `string-upcase` +- `string-downcase` + diff --git a/docs/api/scheme/eval.md b/docs/api/scheme/eval.md new file mode 100644 index 00000000..c4a4feb1 --- /dev/null +++ b/docs/api/scheme/eval.md @@ -0,0 +1,8 @@ +# Eval Library + +The `(scheme eval)` library exports procedures for evaluating +Scheme data as programs. + +- `eval` +- `create-environment` +- `setup-environment` diff --git a/docs/api/scheme/file.md b/docs/api/scheme/file.md new file mode 100644 index 00000000..d3246129 --- /dev/null +++ b/docs/api/scheme/file.md @@ -0,0 +1,12 @@ +# File Library + +The `(scheme file)` library provides procedures for accessing +files. + +- `call-with-input-file` +- `call-with-output-file` +- `delete-file` +- `file-exists?` +- `with-input-from-file` +- `with-output-to-file` + diff --git a/docs/api/scheme/load.md b/docs/api/scheme/load.md new file mode 100644 index 00000000..a8b3968d --- /dev/null +++ b/docs/api/scheme/load.md @@ -0,0 +1,13 @@ +# Load Library + +The `(scheme load)` library exports procedures for loading Scheme expressions from files. + +- [`load`](#load) + +#load + + (load filename) + +The `load` procedure reads expressions and definitions from the file and evaluates them sequentially. + +Note that when using `load` in a compiled program, the file will be processed at runtime using `eval`. The file contents will not be compiled. diff --git a/docs/api/scheme/process-context.md b/docs/api/scheme/process-context.md new file mode 100644 index 00000000..f27b01f8 --- /dev/null +++ b/docs/api/scheme/process-context.md @@ -0,0 +1,9 @@ +# Process-Context Library + +The `(scheme process-context)` library exports procedures +for accessing with the program's calling context. + +- `command-line` +- `emergency-exit` +- `exit` +- `get-environment-variable` diff --git a/docs/api/scheme/read.md b/docs/api/scheme/read.md index 175b6bf6..24b235a8 100644 --- a/docs/api/scheme/read.md +++ b/docs/api/scheme/read.md @@ -10,7 +10,7 @@ The `(scheme read)` library provides procedures for reading Scheme objects. (read) (read port) -[test](../../../scheme/read.sld#L441) +Read a single Scheme object from the input port. #read-all diff --git a/docs/api/scheme/time.md b/docs/api/scheme/time.md new file mode 100644 index 00000000..022066e4 --- /dev/null +++ b/docs/api/scheme/time.md @@ -0,0 +1,7 @@ +# Time Library + +The `(scheme time` library provides access to time-related values. + +- `current-jiffy` +- `current-second` +- `jiffies-per-second` diff --git a/docs/api/scheme/write.md b/docs/api/scheme/write.md new file mode 100644 index 00000000..77c5f7d4 --- /dev/null +++ b/docs/api/scheme/write.md @@ -0,0 +1,18 @@ +# Write Library + +The `(scheme write)` library provides procedures for writing +Scheme objects. + +- [`display`](#display) +- `write` + +#display + + (display) + (display port) + +#write + + (write) + (write port) +