Actions

Difference between revisions of "Internal Documentation"

From Gambit wiki

m (Added two sections.)
Line 12: Line 12:
 
=== Memory Management ===
 
=== Memory Management ===
  
Phil Dawes has put together some notes on [[Notes on Memory Management | memory management]].
+
General notes on internal object storage and memory consumption is on the [[Debugging]] page. Also see [[Notes on Memory Management]].
  
 
=== Thread System ===
 
=== Thread System ===

Revision as of 21:36, 4 October 2008

People who want to contribute to Gambit development will need to learn something about how the Gambit-C runtime and compiler are organized. While we intend that source code documentation be included in the source itself (currently there is very little documentation), we intend that descriptions of program design or algorithms used in the runtime and compiler could be included here.

Namespace handling

See Namespaces.

Runtime Library

Memory Management

General notes on internal object storage and memory consumption is on the Debugging page. Also see Notes on Memory Management.

Thread System

I/O System

Arithmetic implementation

Eval

Continuation manipulation

The manual lists continuation-graft, continuation-capture, and continuation-return but doesn't describe them. The REPL debugger, and possibly other things, use them. See Marc Feeley's paper A Better API for First-Class Continuations.

REPL

The REPL has some fairly interesting functions and variables, especially for hackers.

Variables

##repl-location-relative
Should the REPL give relative or absolute pathnames. Note: When using emacs with gambit, it is useful to set it to #f, especially if you change the current-directory.

Functions

##cmd-x
where x is a REPL command letter (typed after a comma from the REPL). Executes that command as if it was executed inside of the REPL. For instance ##cmd-b displays a backtrace.

Record system

That is, define-type. Based on SRFI-9, but extensions not documented.

Compiler