cyclone/docs/API.md

API Documentation

• R⁷RS Libraries
• SRFI Library Support
• Cyclone Compiler API
• Index

R⁷RS Libraries

This section of the Cyclone API is based on the R⁷RS Scheme Specification:

• Primitives
• scheme base
• scheme case-lambda
• scheme char
• scheme complex
• scheme cxr
• scheme eval
• scheme file
• scheme inexact
• scheme lazy
• scheme load
• scheme process-context
• scheme read
• scheme time
• scheme write

SRFI Library Support

Cyclone supports the following Scheme Requests for Implementation (SRFI) libraries. Detailed information is available in the linked SRFI page as well as the provided Cyclone API:

• srfi 1 - List Library
• srfi 2 - and-let*
• srfi 8 - receive: Binding to multiple values - Included as part of scheme base.
• srfi 18 - Multithreading support
• srfi 27 - Sources of random bits
• srfi 69 - Basic hash tables
• srfi 106 - Basic socket interface
• srfi 111 - Boxes
• srfi 117 - Mutable queues
• srfi 132 - Sort Libraries
• srfi 133 - Vector Library (R7RS-compatible)

Cyclone Compiler API

These libraries are used by the Cyclone compiler itself and could change in the future:

• scheme cyclone ast
• scheme cyclone cgen
• scheme cyclone common
• scheme cyclone cps-optimizations
• scheme cyclone libraries
• scheme cyclone macros
• scheme cyclone pretty-print
• scheme cyclone primitives
• scheme cyclone test
• scheme cyclone transforms
• scheme cyclone util

Index

abs acos and angle any append asin assoc assq assv atan

---

begin boolean=? bytevector-copy bytevector-copy!

---

caaaar caaadr caaar caadar caaddr caadr cadaar cadadr cadar caddar cadddr caddr call/cc call-with-current-continuation call-with-input-file call-with-output-file call-with-port call-with-values case case-lambda cdaaar cdaadr cdaar cdadar cdaddr cdadr cddaar cddadr cddar cdddar cddddr cdddr ceiling char-alphabetic? char<=? char<? char=? char>=? char>? char-ci<=? char-ci<? char-ci=? char-ci>=? char-ci>? char-downcase char-foldcase char-lower-case? char-numeric? char-upcase char-upper-case? char-whitespace? command-line complex? cond cond-expand cos create-environment current-error-port current-input-port current-jiffy current-output-port current-second

---

define-record-type delay delay-force denominator digit-value display do dynamic-wind

---

emergency-exit eof-object error eval even? every exact exact? exact-integer? exp expt

---

features finite? floor floor/ floor-quotient floor-remainder floor-remainder flush-output-port foldl foldr force for-each

---

gcd get-environment-variable get-environment-variables get-output-bytevector get-output-string guard

---

imag-part inexact inexact? infinite? input-port? input-port-open?

---

jiffies-per-second

---

lcm let let* letrec letrec* let*-values let-values list list? list-copy list-ref list-set! list-tail load log

---

magnitude make-constructor make-getter make-list make-parameter make-polar make-promise make-rectangular make-setter make-string make-type-predicate map max member memq memv min modulo

---

nan? negative? newline not numerator

---

odd? open-input-bytevector open-input-string open-output-bytevector open-output-string or output-port? output-port-open?

---

parameterize positive? promise?

---

quasiquote quotient

---

raise raise-continuable rational? read-all read read-line read-string real-part receive record? remainder reverse round

---

setup-environment sin slot-set! sqrt square string string<=? string<? string=? string>=? string>? string-ci<=? string-ci<? string-ci=? string-ci>=? string-ci>? string-copy string-copy! string-downcase string-fill! string-foldcase string-for-each string->list string-map string-upcase string->utf8 string->vector symbol=? syntax-error

---

tan truncate truncate/ truncate-quotient truncate-remainder type-slot-offset

---

unless utf8->string

---

values vector vector-append vector-copy vector-copy! vector-fill! vector-for-each vector->list vector-map vector->string

---

when with-exception-handler with-input-from-file with-output-to-file write write-char write-shared write-simple write-string

---

zero?