Changeset 34903 in project

Timestamp:

11/22/17 21:02:01 (3 years ago)

Author:

sjamaan

Message:

man/5: Copy (but not move!) return-to-host to Module (chicken platform); leave it in "TODO/Embedding" for now

Location:

wiki/man/5

Files:

• Module (chicken platform) (modified) (1 diff)
• TODO/Embedding (modified) (4 diffs)

wiki/man/5/Module (chicken platform)

@@ -183 +183 @@
 
 
+=== Returning to the host program
+
+=== return-to-host
+
+<procedure>(return-to-host)</procedure>
+
+Exits the Scheme code and returns to the invoking context that called
+{{CHICKEN_run}} or {{CHICKEN_continue}}.
+
+After {{return-to-host}} has been executed and once {{CHICKEN_run}}
+returns, you can invoke callbacks which have been defined with
+{{define-external}}.
+
+
 ---
 Previous: [[Module (chicken pathname)]]

wiki/man/5/TODO/Embedding

@@ -56 +56 @@
 {{toplevel}} is the toplevel entry-point procedure, you usually pass {{C_toplevel}} here.
 The result value is the continuation that can be used to re-invoke the Scheme code from the
-point after it called {{return-to-host}} (see below).
+point after it called [[Module (chicken gc)#return-to-host|{{return-to-host}}]].
 
 If you just need a Scheme interpreter, you can also pass {{CHICKEN_default_toplevel}} as
@@ -66 +66 @@
 
 === return-to-host
+
+TODO: This has been documented under (chicken platform)
+
+The {{eval}} library unit also provides boilerplate callbacks, that
+simplify invoking Scheme code embedded in a C or C++ application:
 
 <procedure>(return-to-host)</procedure>
@@ -161 +166 @@
  % cat x.scm
  ;;; x.scm
+ (import (chicken platform))
  
  (define (bar x) (gc) (* x x))
@@ -235 +241 @@
 
  % cat x.scm
- (require-extension srfi-18)
+ (import (chicken platform) srfi-18) ;; Needs the srfi-18 egg
  
  (define m (make-mutex))