Changeset 39581 in project

Timestamp:

02/06/21 17:42:00 (3 weeks ago)

Author:

juergen

Message:

premodules 0.7 docu with restricted exports

File:

• wiki/eggref/5/premodules (modified) (9 diffs)

wiki/eggref/5/premodules

@@ -10 +10 @@
 premodules, which differ from modules insofar, that there is
 
-- no license
-- no export-clause
-- no documentation routine
+* no license
+* no export-clause
+* no documentation routine
 
 Instead, those texts are inserted automatically into the final module
@@ -26 +26 @@
 A standardized routine comment looks like this
 
+<enscript highlight=scheme>
   #|[
   (name . args)
@@ -33 +34 @@
   ...
   ]|#
-
-where type is one of procedure, macro or parameter and is enclosed in at
-least three hyphens on each side
+</enscript>
+
+where type is one of
+
+* procedure 
+* macro 
+* parameter
+
+and is enclosed in at least three hyphens on each side.
+
+If type is macro, it can be followed by symbols representing restricted
+exports of helpers only needed in that macro, e.g.
+
+--- macro *foo* bar ---
+
+This will create an export clause (name *foo* bar) instead of name.
 
 Note, that this comment is placed immediately before the routine's
@@ -62 +76 @@
 
 Off course, the generated tests depend on the test suite used. It's
-obvious, that I use my own one, either simple-tests or simple-checks.
-So, exported tests are implemented either with define-checks from the
-simple-tests module or with define-checker from the simple-checks
-module, the latter being prefered. Internal tests are coded with one of
-pe, check or the ppp macros.
+obvious, that I use my own one, simple-tests.  So, exported tests are
+implemented with define-tester from simple-tests and will be collected
+and executed by test-all in the generated code.
+
+Internal tests are coded with one of pe, check or ppp and will be
+ignored in the generated code..
 
 Exported tests go into the automatically generated run.scm and the
@@ -163 +178 @@
              (loop (+ i 1))))))))
 
+(define foo 'foo) ; example of restricted export
+
 #|[
 (do-list i lst xpr ....)
---- macro ---
+--- macro foo ---
 execute xpr .... for i in lst
 ]|#
@@ -263 +280 @@
 
 ;; to be exported
-(define-checks (dos verbose?)
+(define-tester (dos?)
 
   (let ((lst '()))
@@ -316 +333 @@
 <enscript highligth=scheme>
 
+(import premodules)
 (premodule->module "preloops.scm" "loops.scm")
 (premodule->tests "preloops.scm" "run.scm")
@@ -336 +354 @@
 == Requirements
 
-simple-tests or simple-checks
+simple-tests
 
 == Last update
 
-Jan 27, 2021
+Feb 06, 2021
 
 == Author
@@ -378 +396 @@
 
 == Version history
+; 0.7 : support for restricted exports of macro helpers added
 ; 0.6.1 : support for define-tester and test-all added
 ; 0.5 : history, license and local docu updated, Makefile added