Implement self-documenting ‘network structures’

In contrast to scheme-bytestructures and
(gnu gnunet utils netstruct), this allows associating
a synopsis, a documention string (docstring) and arbitrary
properties with structures and fields.

Code compilation should be faster now as well and the
compiled '.go' should be smaller due to less excessive
use of syntax-rules.

TODO: update old modules

* Makefile.am (modules): compile new modules
  gnu/gnunet/netstruct/procedural.scm and
  gnu/gnunet/netstruct/syntactic.scm.
* README.org (Network Structures): document new modules.
* gnu/gnunet/crypto/struct.scm: use new module.
* gnu/gnunet/hashcode/struct.scm: likewise.
* gnu/gnunet/nse/struct.scm: likewise.
* gnu/gnunet/util/struct.scm: likewise.
* gnu/gnunet/netstruct/procedural.scm: new module
  for defining and using network structures
  procedurally.
* gnu/gnunet/netstruct/syntactic.scm: likewise,
  but syntactically and with some inlining.

1 files changed, 51 insertions, 42 deletions

diff --git a/gnu/gnunet/nse/struct.scm b/gnu/gnunet/nse/struct.scm
index 7ecd8c9..53f789d 100644
--- a/gnu/gnunet/nse/struct.scm
+++ b/gnu/gnunet/nse/struct.scm
@@ -26,49 +26,58 @@
 (define-library (gnu gnunet nse struct (0 0))
   (export /:msg:nse:estimate
           /:msg:nse:flood)
-  (import (only (rnrs base)
-                define-syntax begin)
-          (gnu gnunet utils netstruct)
-          (gnu gnunet hashcode struct)
-          (gnu gnunet util struct))
+  (import (only (rnrs base) begin quote)
+          (only (gnu gnunet util struct)
+                /:message-header)
+          (only (gnu gnunet crypto struct)
+                /peer-identity /eddsa-signature)
+          (only (gnu gnunet netstruct syntactic)
+                define-type structure/packed)
+          (only (gnu gnunet netstruct procedural)
+                u32/big u64/big))
   (begin
-    ;; Network size estimate sent from the service
-    ;; to clients.  Contains the current size estimate
-    ;; (or 0 if none has been calculated) and the
-    ;; standard deviation of known estimates.
-    (define-syntax /:msg:nse:estimate
-      (structure/packed
-       ;; Type: msg:nse:estimate
-       ("header" /message-header)
-       ("reserved" u32/big)
-       ("timestamp" /time-absolute)
-       ("size-estimate" ieee-double/big)
-       ("std-deviation" ieee-double/big)))
+    ;; XXX check for mistakes
 
-    ;; Network size estimate reply; sent when "this"
-    ;; peer's timer has run out before receiving a
-    ;; valid reply from another peer.
-    (define-syntax /:msg:nse:flood
+    (define-type /:msg:nse:estimate
       (structure/packed
-       ;; Type: msg:nse:flood
-       ("header" /message-header)
-       ;; Number of hops this message has taken so far.
-       ("hop-count" u32/big)
-       ;; Purpose.
-       ("purpose" /ecc-signature-purpose)
-       ;; The current timestamp value (which all
-       ;; peers should agree on).
-       ("timestamp" /time-absolute)
-       ;; Number of matching bits between the hash
-       ;; of timestamp and the initiator's public
-       ;; key.
-       ;; XXX add to (gnu gnunet util struct)
-       ("matching-bits" u32/big)
-       ;; Public key of the originator.
-       ("origin" /peer-identity)
-       ;; Proof of work, causing leading zeros when hashed with pkey.
-       ("proof-of-work" u64/big)
-       ;; Signature (over range specified in purpose).
-       ("signature" /eddsa-signature)))))
+       (synopsis "Network size estimate sent from the service to clients")
+       (documentation
+        "Contains the current size estimate
+(or 0 if none has been calculated) and the
+standard deviation of known estimates.")
+       (properties '((message-symbol msg:nse:estimate)))
+       (field (header /:message-header))
+       (field (reserved u32/big))
+       (field (timestamp /time-absolute))
+       (field (size-estimate ieee-double/big))
+       (field (std-deviation ieee-double/big))))
 
-    
+    (define-type /:msg:nse:flood
+      (structure/packed
+       (synopsis "Network size estimate reply")
+       (documentation
+        "Sent when \"this\" peer's timer has run out before receiving a
+valid reply from another peer.")
+       (properties '((message-symbol msg:nse:flood)))
+       (field (header /:message-header))
+       (field (hop-count u32/big)
+              (synopsis
+               "Number of hops this message has taken so far"))
+       (field (purpose /ecc-signature-purpose)
+              (synopsis "Purpose"))
+       (field (timestamp /time-absolute)
+              (synopsis "The current timestamp value (which all
+peers should agree on)"))
+       (field (matching-bits u32/big)
+              ;; XXX add to (gnu gnunet util struct)
+              ;; XXX I don't understand the above XXX anymore
+              (synopsis
+               "Number of matching bits between the hash
+of timestamp and the initiator's public key."))
+       (field (origin /peer-identity)
+              (synopsis "Public key of the originator"))
+       (field (proof-of-work u64/big)
+              (synopsis
+               "Proof of work, causing leading zeros when hashed with pkey."))
+       (field (signature /eddsa-signature)
+              (synopsis "Signature (over range specified in purpose)."))))))