Claudio/collection modules

default.nix

@@ -98,6 +98,11 @@ rec {
       "test/.*.sh"
       "samples/"
       "samples/.*"
+      "stdlib/"
+      "stdlib/.*Makefile.*"
+      "stdlib/.*.as"
+      "stdlib/examples/"
+      "stdlib/examples/.*.as"
       ];
 
     buildInputs =
@@ -112,6 +117,7 @@ rec {
     buildPhase = ''
       patchShebangs .
       asc --version
+      make -C stdlib ASC=asc all
       make -C samples ASC=asc all
       make -C test/run VERBOSE=1 ASC=asc all
       make -C test/fail VERBOSE=1 ASC=asc all

src/Makefile

@@ -49,6 +49,7 @@ clean:
 	$(MAKE) -C ../test clean
 
 test: $(NAME)
+	$(MAKE) -C ../stdlib ASC=$(ASC) all
 	$(MAKE) -C ../test ASC=$(ASC) all
 	$(MAKE) -C ../samples ASC=$(ASC) all
 

stdlib/.gitignore

@@ -0,0 +1 @@
+_out

stdlib/Makefile

@@ -0,0 +1,110 @@
+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"
+
+# Add new module targets here:
+MODULES=\
+	List \
+	ListTest \
+	Trie \
+	Set \
+	SetDb \
+	SetDbTest \
+	ProduceExchange \
+
+
+OUTFILES=$(addsuffix .out, $(MODULES))
+
+OUTPATHS=$(addprefix $(OUTDIR)/, $(OUTFILES))
+
+.PHONY: default all clean startmsg
+
+default: all
+
+startmsg:
+	@echo Begin build: $(MODULE_NAME_COLOR)$(MODULES)$(NO_COLOR)...
+	@echo $(HRULE)
+
+all: $(OUTDIR) startmsg $(OUTPATHS)
+	@echo Build done : $(MODULE_NAME_COLOR)$(MODULES)$(NO_COLOR)
+
+clean:
+	rm -rf $(OUTDIR)
+
+$(OUTDIR):
+	@mkdir $(OUTDIR)
+
+
+$(OUTDIR)/List.out: $(OUTDIR) list.as
+	@echo $(MODULE_NAME) $(basename $(notdir $@))
+	@echo $(BEGIN)
+	$(ASC) -r $(filter-out $(OUTDIR), $^) > $@
+	@echo $(DONE)
+
+$(OUTDIR)/ListTest.out: $(OUTDIR) list.as listTest.as
+	@echo $(MODULE_NAME) $(basename $(notdir $@))
+	@echo $(BEGIN)
+	$(ASC) -r $(filter-out $(OUTDIR), $^) > $@
+	@echo $(DONE)
+
+$(OUTDIR)/Trie.out: $(OUTDIR) list.as trie.as
+	@echo $(MODULE_NAME) $(basename $(notdir $@))
+	@echo $(BEGIN)
+	$(ASC) -r $(filter-out $(OUTDIR), $^) > $@
+	@echo $(DONE)
+
+$(OUTDIR)/Set.out: $(OUTDIR) list.as trie.as set.as
+	@echo $(MODULE_NAME) $(basename $(notdir $@))
+	@echo $(BEGIN)
+	$(ASC) -r $(filter-out $(OUTDIR), $^) > $@
+	@echo $(DONE)
+
+$(OUTDIR)/SetDb.out: $(OUTDIR) list.as trie.as set.as setDb.as
+	@echo $(MODULE_NAME) $(basename $(notdir $@))
+	@echo $(BEGIN)
+	$(ASC) -r $(filter-out $(OUTDIR), $^) > $@
+	@echo $(DONE)
+
+$(OUTDIR)/SetDbTest.out: $(OUTDIR) list.as trie.as set.as setDb.as setDbTest.as
+	@echo $(MODULE_NAME) $(basename $(notdir $@))
+	@echo $(BEGIN)
+	$(ASC) -r $(filter-out $(OUTDIR), $^) > $@
+	@echo $(DONE)
+
+$(OUTDIR)/ProduceExchange.out: $(OUTDIR) list.as trie.as examples/produceExchange.as
+	@echo $(MODULE_NAME) $(basename $(notdir $@))
+	@echo $(BEGIN)
+	$(ASC) -r $(filter-out $(OUTDIR), $^) > $@
+	@echo $(DONE)
+
+
+#########################################################################################
+# TODO(Matthew): Figure out why this "compressed" version of the rules doesn't work.
+
+# $(OUTDIR)/List.out: $(OUTDIR) list.as ;	@$(doModule)
+
+# $(OUTDIR)/ListTest.out: $(OUTDIR) list.as listTest.as ; @$(doModule)
+
+# $(OUTDIR)/Trie.out: $(OUTDIR) list.as trie.as ; @$(doModule)
+
+# $(OUTDIR)/Set.out: $(OUTDIR) list.as trie.as set.as ; @$(doModule)
+
+# $(OUTDIR)/SetDb.out: $(OUTDIR) list.as trie.as set.as setDb.as ; @$(doModule)
+
+# $(OUTDIR)/SetDbTest.out: $(OUTDIR) list.as trie.as set.as setDb.as setDbTest.as ; @$(doModule)
+
+# $(OUTDIR)/ProduceExchange.out: $(OUTDIR) list.as trie.as produceExchange.as ; @$(doModule)
+
+# define doModule =
+# @echo $(MODULE_NAME) $(basename $(notdir $@))
+# @echo $(BEGIN)
+# $(ASC) -r $(filter-out $(OUTDIR), $^) > $@
+# @echo $(DONE)
+# endef

stdlib/README.md

@@ -0,0 +1,20 @@
+[See #127](https://github.com/dfinity-lab/actorscript/issues/127)
+
+Critical modules
+==================
+ - [x] **List**: See [`List` module from SML Basis library](http://sml-family.org/Basis/list.html).
+ - [x] **Hashtrie**: Persistent maps, as functional hash tries.
+ - [x] **Set**: Persistent sets, based directly on persistent maps.
+ - [ ] **Hashtable**: Mutable maps, as imperative hash tables.
+
+Secondary modules
+==================
+These modules _may_ be useful in the collections library:
+ - [ ] **Stream**: Type def done; most operations are pending...
+
+Other modules
+==================
+These modules are merely exercises (toys/examples), and _not_ essential to the collections library:
+ - [ ] **Thunk**: Type def and some operations are done.
+
+

stdlib/examples/produceExchange.as

@@ -0,0 +1,214 @@
+// Produce Exchange Dapp
+// =====================
+//
+// Start here:
+// - Detailed examples: https://dfinity.atlassian.net/wiki/x/joXUBg
+// - More background: https://dfinity.atlassian.net/wiki/x/4gg5Bg
+//
+
+// Open Questions:
+// -------------------------------------------------
+
+// 1. Massive result messages:
+//  How do we represent and send these?
+//
+// - lazy lists? (seems "easy" from AS programmer perspective, but
+//   requires non-first-order data in the IDL)
+// 
+// - list iterators? (almost as good as lazy lists, but requires
+//   references in the IDL, and complicates the GC story).
+// 
+// - arrays? (expensive to build and send; can become way *too big*).
+//
+
+// 2. For now, wan we assume that the canister is maintained by the
+// central authority?
+
+////////////////////////////////////////////////////////////////
+
+// Use the standard library of AS:
+// ===============================
+//
+
+// Collections implement internal tables:
+// --------------------------------------
+// import Table (same as Trie?) xxx
+
+// import Date
+// xxx Dates, eventually from a standard library:
+type Date = Nat;
+
+// xxx standard weight units?
+type Weight = Nat;
+
+// xxx standard price units?
+type Price = Nat;
+
+/////////////////////////////////////////////////////////////////
+
+// Fixed types 
+// ===============================
+//
+// We assume some fixed types (for now).
+// Updating these types requires a canister upgrade.
+//
+// ?? defined by the central authority, aka, the "canister maintainer"?
+//
+
+type Unit = Nat; // xxx replace with a variant type
+type Grade = Nat; // xxx replace with a variant type
+
+type TruckType = Nat; // ??? replace with a variant type
+
+type TruckCapacity = Weight;
+
+type Quantity = Nat;
+
+type PricePerUnit = Price; // needed to calculate prices
+type PriceTotal = Price;
+
+type WeightPerUnit = Weight; // needed to meet truck constraints
+
+type RegionId = Nat; // xxx variant type?
+
+
+//
+// Unique Ids
+// ----------
+// Internally, each type of Id serves as a "row key" for a table (or two).
+//
+
+type ProduceId     = Nat;
+type ProducerId    = Nat;
+type RetailerId    = Nat;
+type TruckTypeId   = Nat;
+type InventoryId   = Nat;
+type TransporterId = Nat;
+type RouteId       = Nat;
+type OrderId       = Nat;
+
+//
+// Query parameters and results
+// ----------------------------
+//
+
+type OrderInfo = shared {
+  produce:     ProduceId;
+  producer:    ProducerId;
+  quant:       Quantity;
+  ppu:         PricePerUnit;
+  transporter: TransporterId;
+  truck_type:  TruckTypeId;
+  weight:      Weight;
+  region_begin:RegionId;
+  region_end:  RegionId;
+  date_begin:  Date;
+  date_end:    Date;
+  prod_cost:   PriceTotal;
+  trans_cost:  PriceTotal;
+};
+
+// xxx same as an OrderInfo?  If different, then how?
+type QueryAllResult = shared {
+  produce:     ProduceId;
+  producer:    ProducerId;
+  quant:       Quantity;
+  ppu:         PricePerUnit;
+  transporter: TransporterId;
+  truck_type:  TruckTypeId;
+  weight:      Weight;
+  region_begin:RegionId;
+  region_end:  RegionId;
+  date_begin:  Date;
+  date_end:    Date;
+  prod_cost:   PriceTotal;
+  trans_cost:  PriceTotal;  
+};
+
+// xxx how to represent huge result messages?
+type QueryAllResults = [QueryAllResult];
+
+// the "Service"
+actor ProduceExchange {
+
+  // Producer-based ingress messages:
+  // ================================
+
+  producerAddInventory(
+    prod: ProduceId,
+    quant:Quantity,
+    ppu:  PricePerUnit,
+    begin:Date,
+    end:  Date,
+  ) : async ?InventoryId {
+    // xxx
+    null
+  };
+
+  producerRemInventory(id:InventoryId) : async ?() {
+    // xxx
+    null
+  };
+
+  producerOrders(id:ProducerId) : async ?[OrderId] {
+    // xxx
+    null
+  };
+
+  // Transporter-based ingress messages:
+  // ===================================
+
+  transporterAddRoute(
+    trans:  TransporterId,
+    rstart: RegionId,
+    rend:   RegionId,
+    start:  Date,
+    end:    Date,
+    cost:   Price,
+    tt:     TruckTypeId
+  ) : async ?RouteId {
+    // xxx
+    null
+  };
+
+  transporterRemRoute(id:RouteId) : async ?() {
+    // xxx
+    null
+  };
+
+  transporterOrders(id:TransporterId) : async ?[OrderId] {
+    // xxx
+    null
+  };
+
+  // Retailer-based ingress messages:
+  // ===================================
+
+  retailerQueryAll(id:RetailerId) : async ?QueryAllResults {
+    // xxx
+    null
+  };
+
+  retailerPlaceOrder(
+    id:RetailerId, 
+    inventory:InventoryId, 
+    route:RouteId) : async ?OrderId 
+  {
+    // xxx
+    null
+  };
+
+  retailerOrders(id:RetailerId) : async ?[OrderId] {
+    // xxx
+    null
+  };
+
+  // (Producer/Transporter/Retailer) ingress messages:
+  // ========================================================
+
+  orderInfo(id:OrderId) : async ?OrderInfo {
+    // xxx
+    null
+  };
+
+};