Changeset 13580 in project

Timestamp:

03/08/09 02:04:40 (11 years ago)

Author:

felix winkelmann

Message:

updated manual with some changes from the wiki

Location:

chicken/trunk/manual

Files:

• C interface (modified) (2 diffs)
• Callbacks (modified) (1 diff)
• Extensions to the standard (modified) (1 diff)
• Non-standard macros and special forms (modified) (1 diff)
• Non-standard read syntax (modified) (1 diff)
• Parameters (modified) (2 diffs)
• The User's Manual (modified) (1 diff)
• Unit eval (modified) (1 diff)

chicken/trunk/manual/C interface

@@ -321 +321 @@
  extern int callout(int, int, int);
  <#
-
+ 
  (define callout (foreign-safe-lambda int "callout" int int int))
-
+ 
  (define-external (callin (scheme-object xyz)) int
    (print "This is 'callin': " xyz)
    123)
-
+ 
  (print (callout 1 2 3))
 
@@ -333 +333 @@
  #include <stdio.h>
  #include "chicken.h"
-
+ 
  extern int callout(int, int, int);
  extern int callin(C_word x);
-
+ 
  int callout(int x, int y, int z)
  {
    C_word *ptr = C_alloc(C_SIZEOF_LIST(3));
    C_word lst;
-
+ 
    printf("This is 'callout': %d, %d, %d\n", x, y, z);
    lst = C_list(&ptr, 3, C_fix(x), C_fix(y), C_fix(z));

chicken/trunk/manual/Callbacks

@@ -23 +23 @@
 Non-local exits leaving the scope of the invocation of a callback from Scheme into C
 will not remove the C call-frame from the stack (and will result in a memory
-leak).
-
+leak).  '''Note:''' The same applies to
+SRFI-18 threading, which is implemented with {{call/cc}};
+additionally, if you enter one callback, switch threads and then exit
+a different callback, your program is likely to crash.
 
 

chicken/trunk/manual/Extensions to the standard

@@ -161 +161 @@
 {{#:append}}.
 
+[6.7] The {{exit}} procedure exits a program right away and does ''not'' invoke pending {{dynamic-wind}} thunks.
+
 Previous: [[Deviations from the standard]]
 

chicken/trunk/manual/Non-standard macros and special forms

@@ -52 +52 @@
 This is equivalent to {{(require-library ID ...)}} but performs an implicit
 {{import}}, if necessary.
+This implementation of {{require-extension}} is compliant with [[http://srfi.schemers.org/srfi-55/srfi-55.html|SRFI-55]]
+(see the [[http://srfi.schemers.org/srfi-55/srfi-55.html|SRFI-55]] document for more information).
 
 ==== use

chicken/trunk/manual/Non-standard read syntax

@@ -15 +15 @@
  #;EXPRESSION
 
-Treats {{EXPRESSION}} as a comment.
-
+Treats {{EXPRESSION}} as a comment.  That is, the comment runs through the whole S-expression, regardless of newlines, which saves you from having to comment out every line, or add a newline in the middle of your parens to make the commenting of the last line work, or other things like that.
 === External Representation
 

chicken/trunk/manual/Parameters

@@ -4 +4 @@
 == Parameters
 
-Certain behavior of the interpreter and compiled programs can be
-customized via 'parameters', where a parameter is a procedure of
+Parameters are Chicken's form of dynamic variables, except that they are
+procedures rather than actual variables.  A parameter is a procedure of
 zero or one arguments. To retrieve the value of a parameter call the
 parameter-procedure with zero arguments. To change the setting of the
@@ -36 +36 @@
 procedure. The guard procedure should check the value and/or convert it
 to an appropriate form.
+
+== Built-in parameters
+
+Certain behavior of the interpreter and compiled programs can be
+customized via the following built-in parameters:
 
 === case-sensitive

chicken/trunk/manual/The User's Manual

@@ -5 +5 @@
 This is the user's manual for the Chicken Scheme compiler, version 4.0.0x5
 
-; [[Overview]] : What is Chicken?
+; [[Getting started]] : What is CHICKEN and how do I use it?
 
 ; [[Basic mode of operation]] : Compiling Scheme files.

chicken/trunk/manual/Unit eval

@@ -135 +135 @@
 If {{X}} is a macro-form, expand the macro (and repeat expansion
 until expression is a non-macro form).  Returns the resulting expression.
-
-==== expand*
-
- [procedure] (expand* X)
-
-If {{X}} is a macro-form, expand the macro.  Returns the resulting
-expression.
 
 ==== undefine-macro!