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

TODO: update this with API for scheme, scheme cyclone, and srfi. seems scheme is missing in latest run