WIP: The Produce Exchange Dapp, via the ActorScript standard library.

README.md

@@ -372,7 +372,7 @@ charlie.go("charlie", server);
 
 ## Syntax
 
-See [here](design/Syntax.md).
+See [here](design/Syntax.html).
 
 
 ## Semantics
@@ -382,4 +382,4 @@ TODO...
 
 ## Implementation
 
-See [here](design/Implementation.md)
+See [here](design/Implementation.html)

default.nix

@@ -79,6 +79,15 @@ let
     "stdlib/.*.as"
     "stdlib/examples/"
     "stdlib/examples/.*.as"
+    "stdlib/examples/produce-exchange/"
+    "stdlib/examples/produce-exchange/.*.as"
+    "stdlib/examples/produce-exchange/test/"
+    "stdlib/examples/produce-exchange/test/.*.as"
+  ];
+  stdlib_doc_files = [
+    "stdlib/.*\.py"
+    "stdlib/README.md"
+    "stdlib/examples/produce-exchange/README.md"
   ];
 
 in
@@ -120,8 +129,7 @@ rec {
 
     src = sourceByRegex ./. (
       test_files ++
-      samples_files ++
-      stdlib_files
+      samples_files
     );
 
     buildInputs =
@@ -137,7 +145,6 @@ rec {
     buildPhase = ''
       patchShebangs .
       asc --version
-      make -C stdlib ASC=asc all
       make -C samples ASC=asc all
     '' +
       (if test-dvm
@@ -226,8 +233,57 @@ rec {
     [ { name = "bin/FileCheck"; path = "${nixpkgs.llvm}/bin/FileCheck";} ];
   wabt = nixpkgs.wabt;
 
+  stdlib-reference = stdenv.mkDerivation {
+    name = "stdlib-reference";
+
+    src = sourceByRegex ./. (
+      stdlib_files ++
+      stdlib_doc_files
+    ) + "/stdlib";
+
+    buildInputs = with nixpkgs;
+      [ pandoc bash python ];
+
+    buildPhase = ''
+      patchShebangs .
+      make alldoc
+    '';
+
+    installPhase = ''
+      mkdir -p $out
+      mv doc $out/
+      mkdir -p $out/nix-support
+      echo "report docs $out/doc README.html" >> $out/nix-support/hydra-build-products
+    '';
+
+    forceShare = ["man"];
+  };
+
+  produce-exchange = stdenv.mkDerivation {
+    name = "produce-exchange";
+    src = sourceByRegex ./. (
+      stdlib_files
+    );
+
+    buildInputs = [
+      native
+    ];
+
+    doCheck = true;
+    buildPhase = ''
+      make -C stdlib ASC=asc OUTDIR=_out _out/ProduceExchange.wasm
+    '';
+    checkPhase = ''
+      make -C stdlib ASC=asc OUTDIR=_out _out/ProduceExchange.out
+    '';
+    installPhase = ''
+      mkdir -p $out
+      cp stdlib/_out/ProduceExchange.wasm $out
+    '';
+  };
+
   all-systems-go = nixpkgs.releaseTools.aggregate {
     name = "all-systems-go";
-    constituents = [ native js native_test coverage-report ];
+    constituents = [ native js native_test coverage-report stdlib-reference produce-exchange ];
   };
 }

src/prelude.ml

@@ -40,7 +40,6 @@ func print(x : Text) { (prim "print" : Text -> ()) x };
 // Hashing
 func hashInt(n : Int) : Word32 = (prim "Int~hash" : Int -> Word32) n;
 
-
 // Conversions
 func natToWord8(n : Nat) : Word8 = (prim "Nat->Word8" : Nat -> Word8) n;
 func word8ToNat(n : Word8) : Nat = (prim "Word8->Nat" : Word8 -> Nat) n;

stdlib/.gitignore

@@ -1 +1,2 @@
 _out
+doc

stdlib/Makefile

@@ -1,117 +1,154 @@
 ASC=../src/asc
 OUTDIR=_out
-
-## VT100 stuff
-HRULE="\x1b[2;34m----------------------------------------------------------------\x1b[0m"
-MODULE_NAME="\x1b[1;32mModule:\x1b[1;34m"
-BEGIN="\x1b[0;1mBegin...\x1b[0m"
-DONE="\x1b[1mDone.\n"$(HRULE)
-MODULE_NAME_COLOR="\x1b[0;1;34m"
-NO_COLOR="\x1b[0m"
+DOCDIR=doc
+MDofAS=./markdown-of-actorscript.py
+MDofMD=./markdown-of-markdown.py
+PANDOC=pandoc
 
 # Add new module targets here:
 MODULES=\
+	Hash \
 	List \
 	ListTest \
 	AssocList \
 	Trie \
+	DocTable \
 	Set \
 	SetDb \
 	SetDbTest \
 	ProduceExchange \
 
+WASM=\
+  ProduceExchange
 
-OUTFILES=$(addsuffix .out, $(MODULES))
+OUTFILES=$(addsuffix .out, $(MODULES)) $(addsuffix .wasm, $(WASM))
 
 OUTPATHS=$(addprefix $(OUTDIR)/, $(OUTFILES))
 
-.PHONY: default all clean startmsg
+.PHONY: default all clean alltests alldoc docMd docHtml
 
 default: all
 
-startmsg:
-	@echo Begin build: $(MODULE_NAME_COLOR)$(MODULES)$(NO_COLOR)...
+docmsg:
+	@echo Begin building documentation in \`$(DOCDIR)\`...
 	@echo $(HRULE)
 
-all: $(OUTDIR) startmsg $(OUTPATHS)
-	@echo Build done : $(MODULE_NAME_COLOR)$(MODULES)$(NO_COLOR)
+alltests: $(OUTDIR) $(OUTPATHS)
+
+all: alltests alldoc
+
+alldoc: docMd docHtml
+
+# Markdown documentation, extracted from the source directory
+docMd: \
+	$(DOCDIR)/README.md \
+	$(DOCDIR)/prelude.md \
+	$(DOCDIR)/hash.md \
+	$(DOCDIR)/list.md \
+	$(DOCDIR)/assocList.md \
+	$(DOCDIR)/trie.md \
+	$(DOCDIR)/docTable.md \
+	$(DOCDIR)/set.md \
+	$(DOCDIR)/setDb.md \
+	$(DOCDIR)/setDbTest.md \
+	$(DOCDIR)/examples/produce-exchange/README.md \
+	$(DOCDIR)/examples/produce-exchange/serverTypes.md \
+	$(DOCDIR)/examples/produce-exchange/serverActor.md \
+	$(DOCDIR)/examples/produce-exchange/serverModelTypes.md \
+	$(DOCDIR)/examples/produce-exchange/serverModel.md \
+	| \
+	$(DOCDIR)/ \
+	$(DOCDIR)/examples/produce-exchange/
+
+# HTML documentation, extracted from the source directory
+docHtml: \
+	$(DOCDIR)/README.html \
+	$(DOCDIR)/prelude.html \
+	$(DOCDIR)/hash.html \
+	$(DOCDIR)/list.html \
+	$(DOCDIR)/assocList.html \
+	$(DOCDIR)/trie.html \
+	$(DOCDIR)/docTable.html \
+	$(DOCDIR)/set.html \
+	$(DOCDIR)/setDb.html \
+	$(DOCDIR)/setDbTest.html \
+	$(DOCDIR)/examples/produce-exchange/README.html \
+	$(DOCDIR)/examples/produce-exchange/serverTypes.html \
+	$(DOCDIR)/examples/produce-exchange/serverActor.html \
+	$(DOCDIR)/examples/produce-exchange/serverModelTypes.html \
+	$(DOCDIR)/examples/produce-exchange/serverModel.html \
+	| \
+	$(DOCDIR)/ \
+	$(DOCDIR)/examples/produce-exchange/
 
 clean:
-	rm -rf $(OUTDIR)
+	rm -rf $(OUTDIR) $(DOCDIR)
 
 $(OUTDIR):
-	@mkdir $(OUTDIR)
+	@mkdir $@
 
+$(DOCDIR):
+	mkdir $@
 
-$(OUTDIR)/List.out: $(OUTDIR) list.as
-	@echo $(MODULE_NAME) $(basename $(notdir $@))
-	@echo $(BEGIN)
-	$(ASC) -r $(filter-out $(OUTDIR), $^) > $@
-	@echo $(DONE)
+$(DOCDIR)/README.md: README.md | $(DOCDIR)
+	@echo "<!-- **[ DO NOT EDIT -- GENERATED by a Makefile, on `date` ]** -->" > $@
+	@echo "" >> $@
+	$(MDofMD) $< >> $@
 
-$(OUTDIR)/ListTest.out: $(OUTDIR) list.as listTest.as
-	@echo $(MODULE_NAME) $(basename $(notdir $@))
-	@echo $(BEGIN)
-	$(ASC) -r $(filter-out $(OUTDIR), $^) > $@
-	@echo $(DONE)
+$(DOCDIR)/examples/produce-exchange/: README.md
+	@mkdir -p $@
 
-$(OUTDIR)/AssocList.out: $(OUTDIR) list.as assocList.as
-	@echo $(MODULE_NAME) $(basename $(notdir $@))
-	@echo $(BEGIN)
-	$(ASC) -r $(filter-out $(OUTDIR), $^) > $@
-	@echo $(DONE)
+$(DOCDIR)/examples/produce-exchange/README.md: examples/produce-exchange/README.md | $(DOCDIR)/examples/produce-exchange/
+	@echo "<!-- **[ DO NOT EDIT -- GENERATED by a Makefile, on `date` ]** -->" > $@
+	@echo "" >> $@
+	$(MDofMD) $< >> $@
 
-$(OUTDIR)/Trie.out: $(OUTDIR) list.as assocList.as trie.as
-	@echo $(MODULE_NAME) $(basename $(notdir $@))
-	@echo $(BEGIN)
+$(OUTDIR)/Hash.out: prelude.as hash.as | $(OUTDIR)
 	$(ASC) -r $(filter-out $(OUTDIR), $^) > $@
-	@echo $(DONE)
 
-$(OUTDIR)/Set.out: $(OUTDIR) list.as assocList.as trie.as set.as
-	@echo $(MODULE_NAME) $(basename $(notdir $@))
-	@echo $(BEGIN)
+$(OUTDIR)/List.out: prelude.as list.as | $(OUTDIR)
 	$(ASC) -r $(filter-out $(OUTDIR), $^) > $@
-	@echo $(DONE)
 
-$(OUTDIR)/SetDb.out: $(OUTDIR) list.as assocList.as trie.as set.as setDb.as
-	@echo $(MODULE_NAME) $(basename $(notdir $@))
-	@echo $(BEGIN)
+$(OUTDIR)/ListTest.out: prelude.as list.as listTest.as | $(OUTDIR)
 	$(ASC) -r $(filter-out $(OUTDIR), $^) > $@
-	@echo $(DONE)
 
-$(OUTDIR)/SetDbTest.out: $(OUTDIR) list.as assocList.as trie.as set.as setDb.as setDbTest.as
-	@echo $(MODULE_NAME) $(basename $(notdir $@))
-	@echo $(BEGIN)
+$(OUTDIR)/AssocList.out: prelude.as list.as assocList.as | $(OUTDIR)
 	$(ASC) -r $(filter-out $(OUTDIR), $^) > $@
-	@echo $(DONE)
 
-$(OUTDIR)/ProduceExchange.out: $(OUTDIR) list.as assocList.as trie.as examples/produceExchange.as
-	@echo $(MODULE_NAME) $(basename $(notdir $@))
-	@echo $(BEGIN)
+$(OUTDIR)/Trie.out: prelude.as hash.as list.as assocList.as trie.as | $(OUTDIR)
 	$(ASC) -r $(filter-out $(OUTDIR), $^) > $@
-	@echo $(DONE)
-
 
-#########################################################################################
-# TODO(Matthew): Figure out why this "compressed" version of the rules doesn't work.
+$(OUTDIR)/DocTable.out: prelude.as hash.as list.as assocList.as trie.as docTable.as | $(OUTDIR)
+	$(ASC) -r $(filter-out $(OUTDIR), $^) > $@
 
-# $(OUTDIR)/List.out: $(OUTDIR) list.as ;	@$(doModule)
+$(OUTDIR)/Set.out: prelude.as hash.as list.as assocList.as trie.as set.as | $(OUTDIR)
+	$(ASC) -r $(filter-out $(OUTDIR), $^) > $@
 
-# $(OUTDIR)/ListTest.out: $(OUTDIR) list.as listTest.as ; @$(doModule)
+$(OUTDIR)/SetDb.out: prelude.as hash.as list.as assocList.as trie.as set.as setDb.as | $(OUTDIR)
+	$(ASC) -r $(filter-out $(OUTDIR), $^) > $@
 
-# $(OUTDIR)/Trie.out: $(OUTDIR) list.as trie.as ; @$(doModule)
+$(OUTDIR)/SetDbTest.out: prelude.as hash.as list.as assocList.as trie.as set.as setDb.as setDbTest.as | $(OUTDIR)
+	$(ASC) -r $(filter-out $(OUTDIR), $^) > $@
 
-# $(OUTDIR)/Set.out: $(OUTDIR) list.as trie.as set.as ; @$(doModule)
+PRODUCE_EXCHANGE_SRC=\
+	prelude.as hash.as list.as assocList.as trie.as docTable.as \
+	examples/produce-exchange/serverTypes.as \
+	examples/produce-exchange/serverModelTypes.as \
+	examples/produce-exchange/serverModel.as \
+	examples/produce-exchange/serverActor.as \
 
-# $(OUTDIR)/SetDb.out: $(OUTDIR) list.as trie.as set.as setDb.as ; @$(doModule)
+$(OUTDIR)/ProduceExchange.out: $(PRODUCE_EXCHANGE_SRC) \
+	examples/produce-exchange/test/simpleSetupAndQuery.as | $(OUTDIR)
+	$(ASC) -r $(filter-out $(OUTDIR), $^) > $@
 
-# $(OUTDIR)/SetDbTest.out: $(OUTDIR) list.as trie.as set.as setDb.as setDbTest.as ; @$(doModule)
+$(OUTDIR)/ProduceExchange.wasm: $(PRODUCE_EXCHANGE_SRC) | $(OUTDIR)
+	$(ASC) -c --dfinity -o $@ $(filter-out $(OUTDIR), $^)
 
-# $(OUTDIR)/ProduceExchange.out: $(OUTDIR) list.as trie.as produceExchange.as ; @$(doModule)
+$(DOCDIR)/%.md: %.as $(MDofAS) | $(DOCDIR)
+	@echo "<!-- **[ Do not edit; This file was machine-generated on `date`. ]** -->" > $@
+	@echo "" >> $@
+	@echo "" >> $@
+	$(MDofAS) $< >> $@
 
-# define doModule =
-# @echo $(MODULE_NAME) $(basename $(notdir $@))
-# @echo $(BEGIN)
-# $(ASC) -r $(filter-out $(OUTDIR), $^) > $@
-# @echo $(DONE)
-# endef
+$(DOCDIR)/%.html: $(DOCDIR)/%.md
+	$(PANDOC) -f gfm $^ > $@