~ chicken-core (chicken-5) 86ebee2cec8a79297649c3287f415d5590f3c6cf
commit 86ebee2cec8a79297649c3287f415d5590f3c6cf
Author: Peter Bex <peter@more-magic.net>
AuthorDate: Fri May 31 08:36:44 2024 +0200
Commit: Peter Bex <peter@more-magic.net>
CommitDate: Fri May 31 08:36:44 2024 +0200
Sync manual from wiki
diff --git a/manual/C interface b/manual/C interface
index c34a6857..174ee143 100644
--- a/manual/C interface
+++ b/manual/C interface
@@ -425,9 +425,11 @@ returns that vector to its continuation:
#include <assert.h>
-void fill_vector(C_word c, C_word closure, C_word vec)
+void fill_vector(C_word c, C_word *av)
{
+ C_word closure = av[0];
C_word kontinuation = C_block_item(closure, 1);
+ C_word vec = av[1];
C_block_item(vec, 0) = C_fix(1);
C_block_item(vec, 1) = C_fix(2);
@@ -437,7 +439,7 @@ void fill_vector(C_word c, C_word closure, C_word vec)
C_kontinue(kontinuation, vec);
}
-void one_two_three(C_word c, C_word self, C_word k, C_word str)
+void one_two_three(C_word continuation, C_word str)
{
/*
* Allocate room on the stack to hold the closure: 1 word for
@@ -447,8 +449,11 @@ void one_two_three(C_word c, C_word self, C_word k, C_word str)
*/
C_word closure[4], *cp = closure;
+ /* Allocate room for the argvector for C_allocate_vector */
+ C_word av[6];
+
/* Create the closure. It holds 3 values, not counting the tag */
- C_word closure_object = C_closure(&cp, 3, (C_word)fill_vector, k, str);
+ C_word closure_object = C_closure(&cp, 3, (C_word)fill_vector, continuation, str);
/*
* After this, cp points just beyond the last word of the allocated
@@ -460,18 +465,22 @@ void one_two_three(C_word c, C_word self, C_word k, C_word str)
assert( C_data_pointer(closure_object) == (closure + 1) );
assert( C_block_item(closure_object, 0) == (*(closure + 1)) );
+ /* Set up the arguments for C_allocate_vector */
+ av[0] = (C_word)NULL; /* Closure of allocate_vector - unused, so pass NULL */
+ av[1] = closure_object; /* Continuation to call after allocating Scheme vector */
+ av[2] = C_fix(4); /* Size of Scheme vector to allocate */
+ av[3] = C_SCHEME_FALSE; /* We want a regular vector, not a bytevector */
+ av[4] = C_SCHEME_FALSE; /* Initialization value for slots. Don't care */
+ av[5] = C_SCHEME_FALSE; /* Do not align at 8 byte (64-bit word) boundary */
/* Make a vector of 4 objects and use closure_object as continuation */
- C_allocate_vector(6, (C_word)NULL, closure_object, C_fix(4),
- C_SCHEME_FALSE, /* not a byte vector */
- C_SCHEME_FALSE, /* initialization value. Don't care */
- C_SCHEME_FALSE); /* don't align at 8 bytes */
+ C_allocate_vector(6, av);
/* .. C_allocate_vector does not return ... */
}
<#
(define one-two-three
- (foreign-primitive ((scheme-object str)) "one_two_three(C_c, C_self, C_k, str);"))
+ (foreign-primitive ((scheme-object str)) "one_two_three(C_k, str);"))
(print (one-two-three "hi"))
</enscript>
diff --git a/manual/Extensions b/manual/Extensions
index 9ce47869..7f3a4077 100644
--- a/manual/Extensions
+++ b/manual/Extensions
@@ -82,11 +82,10 @@ custom script to compile your extension's code. See below for more information.
=== Creating eggs
-An egg can be created by placing its code and some special
-files in a directory named after the desired name of the egg.
-For example, if your
-egg is called {{foo}}, create a directory called {{foo}}
-and put the egg code there.
+An egg can be created by placing the code and some special
+files in a directory of its own.
+For example, if your egg is called {{foo}}, create a directory called {{foo}}
+and put the egg code there (the directory's name is not actually important).
Eggs need an egg description file {{<egg name>.egg}}. This file
indicates how the egg is to be compiled and provides some information
@@ -159,9 +158,8 @@ Here we create a simple application:
We also need an egg file:
-;;;; hello2.egg
-
<enscript highlight=scheme>
+;;;; hello2.egg
((author "Me")
(synopsis "A cool hello-world application")
(license "proprietary")
diff --git a/manual/Getting started b/manual/Getting started
index 61d03919..c0ed8167 100644
--- a/manual/Getting started
+++ b/manual/Getting started
@@ -236,9 +236,9 @@ To invoke the CHICKEN interpreter, you use the {{csi}} command.
$ csi
CHICKEN
- (c) 2008-2022, The CHICKEN Team
+ (c) 2008-2021, The CHICKEN Team
(c) 2000-2007, Felix L. Winkelmann
- Version 5.2.0 (rev 317468e4)
+ Version 5.3.0 (rev e31bbee5)
linux-unix-gnu-x86-64 [ 64bit dload ptables ]
Type ,? for help.
diff --git a/manual/Module (chicken base) b/manual/Module (chicken base)
index 0522f851..42bc92a0 100644
--- a/manual/Module (chicken base)
+++ b/manual/Module (chicken base)
@@ -335,7 +335,8 @@ name of the procedure) where the error occurred.
<macro>(assert EXP [OBJ ...])</macro>
-Evaluates {{EXP}}, if it returns #f, applies {{error}} on {{OBJ ...}}.
+Evaluates {{EXP}}, if it returns #f, {{error}} is applied to {{OBJ ...}},
+else the result of {{EXP}} is returned.
When compiling in unsafe mode, assertions of this kind are disabled.
@@ -534,9 +535,6 @@ argument vectors is copied.
Exceptions: {{(exn bounds)}}
-This procedure is compatible with the definition from the R7RS
-{{(scheme base)}} library.
-
==== vector-resize
<procedure>(vector-resize VECTOR N [INIT])</procedure>
diff --git a/manual/Module (chicken foreign) b/manual/Module (chicken foreign)
index 3a6afdd1..fac40174 100644
--- a/manual/Module (chicken foreign)
+++ b/manual/Module (chicken foreign)
@@ -196,9 +196,10 @@ C_values(N + 2, av);
</enscript>
where {{N}} is the number of values to be returned, and {{X1, ...}}
-are the results, which should be Scheme data objects. When returning
-multiple values, the return-type should be omitted. Of course, if you
-have to dynamically compute the values, you do not have to use C's
+are the results, which should be Scheme data objects.
+See [[/manual/C interface#constructors|Constructors]] for the APIs to construct Scheme data objects from C primitives.
+When returning multiple values, the return-type should be omitted.
+Of course, if you have to dynamically compute the values, you do not have to use C's
array initialization syntax, but you can just assign them one by one.
Returning just a single value can still be done via the {{C_return(...)}} macro.
diff --git a/manual/Module (chicken platform) b/manual/Module (chicken platform)
index 2d513034..134132c6 100644
--- a/manual/Module (chicken platform)
+++ b/manual/Module (chicken platform)
@@ -167,8 +167,8 @@ in the current system. Additionally the {{cond-expand}} form accesses this
feature list to infer what features are provided. Predefined features are
{{chicken}}, and the SRFIs (Scheme Request For Implementation) provided by the
base system: {{srfi-23, srfi-30, srfi-39}}. If the {{eval}} unit
-is used (the default), the features {{srfi-0, srfi-2, srfi-6, srfi-8}} and {{srfi-9}}
-are defined. When compiling code (during compile-time) the
+is used (the default), the features {{srfi-0, srfi-2, srfi-6, srfi-8, srfi-9}}
+and {{srfi-10}} are defined. When compiling code (during compile-time) the
feature {{compiling}} is registered. When evaluating code in the interpreter
(csi), the feature {{csi}} is registered.
diff --git a/manual/Module scheme b/manual/Module scheme
index 62976614..401bb4d6 100644
--- a/manual/Module scheme
+++ b/manual/Module scheme
@@ -93,7 +93,7 @@ initial environment; for example, the addition and multiplication
procedures in the above examples are the values of the variables + and
*. New procedures are created by evaluating lambda
expressions. Procedure calls may return any number of values (see the
-{{values}} procedure [[#control-features|below]]).
+{{values}} procedure [[#Control_features|below]]).
Procedure calls are also called combinations.
@@ -352,7 +352,7 @@ All the <datum>s must be distinct. The last <clause> may be an
Semantics: A case expression is evaluated as follows. <Key> is
evaluated and its result is compared against each <datum>. If the
result of evaluating <key> is equivalent (in the sense of {{eqv?}};
-see [[#equivalence-predicates|below]]) to a <datum>, then the
+see [[#Equivalence_predicates|below]]) to a <datum>, then the
expressions in the corresponding <clause> are evaluated from left to
right and the result(s) of the last expression in the <clause> is(are)
returned as the result(s) of the case expression. If the selected
@@ -441,7 +441,7 @@ returned. Each binding of a <variable> has <body> as its region.
(z (+ x y)))
(* z x))) ===> 35
-See also "named let", [[#iteration|below]].
+See also "named let", [[#Iteration|below]].
<macro>(let* <bindings> <body>)</macro><br>
@@ -1460,7 +1460,7 @@ Rational operations such as + should always produce exact results when
given exact arguments. If the operation is unable to produce an exact
result, then it may either report the violation of an implementation
restriction or it may silently coerce its result to an inexact value.
-See [[#implementation-restrictions|the next section]].
+See [[#Implementation restrictions|the next section]].
With the exception of inexact->exact, the operations described in this
section must generally return inexact results when given any inexact
@@ -1596,7 +1596,7 @@ which are encoded in the naming conventions of the arguments as
given in the procedure's signature. The conventions are as follows:
; {{obj}} : any object
-; {{list, list1, ... listj, ... list : (see "[[#pairs-and-lists|Pairs and lists]]" below)
+; {{list, list1, ... listj, ... list : (see "[[#Pairs_and_lists|Pairs and lists]]" below)
; {{z, z1, ... zj, ...}} : complex number
; {{x, x1, ... xj, ...}} : real number
; {{y, y1, ... yj, ...}} : real number
diff --git a/manual/Module srfi-4 b/manual/Module srfi-4
index fd6b9835..42c6d3f1 100644
--- a/manual/Module srfi-4
+++ b/manual/Module srfi-4
@@ -179,8 +179,8 @@ is {{#XXX( ...elements... )}}.
For example,
- #u8(0 #e1e2 #xff)}} ; a {{u8vector}} of length 3 containing 0, 100, 255
- #f64(-1.5) ; a {{f64vector}} of length 1 containing -1.5.
+ #u8(0 #e1e2 #xff) ; a u8vector of length 3 containing 0, 100, 255
+ #f64(-1.5) ; a f64vector of length 1 containing -1.5.
This external representation is also available in program source code. For example,
diff --git a/manual/Using the compiler b/manual/Using the compiler
index e9eb3672..079e2cf1 100644
--- a/manual/Using the compiler
+++ b/manual/Using the compiler
@@ -46,7 +46,7 @@ the source text should be read from standard input.
; -epilogue FILENAME : Includes the file named {{FILENAME}} at the end of the compiled source file. The include-path is not searched. This option may be given multiple times.
-; -emit-all-import-libraries : emit import libraries for all modules defined in the current compulation unit (see also: {{-emit-import-library}}).
+; -emit-all-import-libraries : emit import libraries for all modules defined in the current compilation unit (see also: {{-emit-import-library}}).
; -emit-external-prototypes-first : Emit prototypes for callbacks defined with {{define-external}} before any other foreign declarations. This is sometimes useful, when C/C++ code embedded into the a Scheme program has to access the callbacks. By default the prototypes are emitted after foreign declarations.
Trap