v0.12-preview.120.18+252

Author: xclerc

LICENSE.md

@@ -1,6 +1,6 @@
 The MIT License
 
-Copyright (c) 2018 Jane Street Group, LLC <[email protected]>
+Copyright (c) 2018--2019 Jane Street Group, LLC <[email protected]>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

Makefile

@@ -1,18 +1,17 @@
 INSTALL_ARGS := $(if $(PREFIX),--prefix $(PREFIX),)
 
-# Default rule
 default:
-	jbuilder build @install
+	dune build
 
 install:
-	jbuilder install $(INSTALL_ARGS)
+	dune install $(INSTALL_ARGS)
 
 uninstall:
-	jbuilder uninstall $(INSTALL_ARGS)
+	dune uninstall $(INSTALL_ARGS)
 
 reinstall: uninstall install
 
 clean:
-	rm -rf _build
+	dune clean
 
 .PHONY: default install uninstall reinstall clean

bench/dune

@@ -0,0 +1,2 @@
+(library (name hardcaml_bench) (libraries hardcaml)
+ (preprocess (pps ppx_jane)))

bench/jbuild

@@ -0,0 +1 @@
+(lang dune 1.5)

dune-project

@@ -0,0 +1,3 @@
+(library (name hardcaml_examples_bench)
+ (libraries hardcaml hardcaml_examples hardcaml_examples_tests)
+ (preprocess (pps ppx_jane)))

example/bench/dune

@@ -0,0 +1,2 @@
+(library (name hardcaml_examples) (libraries hardcaml)
+ (preprocess (pps ppx_deriving_hardcaml ppx_jane)))

example/bench/jbuild

@@ -0,0 +1,4 @@
+(library (name hardcaml_examples_tests)
+ (libraries base expect_test_helpers_kernel hardcaml hardcaml_examples
+  hardcaml_step_testbench hardcaml_waveterm stdio)
+ (preprocess (pps ppx_jane)))

example/src/dune

@@ -1,27 +1,25 @@
-opam-version: "1.2"
+opam-version: "2.0"
 maintainer: "[email protected]"
 authors: ["Jane Street Group, LLC <[email protected]>"]
 homepage: "https://github.com/janestreet/hardcaml"
 bug-reports: "https://github.com/janestreet/hardcaml/issues"
 dev-repo: "git+https://github.com/janestreet/hardcaml.git"
+doc: "https://ocaml.janestreet.com/ocaml-core/latest/doc/hardcaml/index.html"
 license: "MIT"
 build: [
-  ["jbuilder" "build" "-p" name "-j" jobs]
+  ["dune" "build" "-p" name "-j" jobs]
 ]
 depends: [
+  "ocaml" {>= "4.07.0"}
   "base"
   "ppx_jane"
   "stdio"
   "topological_sort"
-  "jbuilder"                {build & >= "1.0+beta18.1"}
-  "ocaml-migrate-parsetree" {>= "1.0"}
-  "ppxlib"                  {>= "0.1.0"}
-  "zarith"                  {>= "1.4"}
+  "dune"             {build & >= "1.5.1"}
+  "zarith"           {>= "1.5"}
 ]
-available: [ ocaml-version >= "4.06.1" ]
-descr: "
-RTL Hardware Design in OCaml.
-
+synopsis: "RTL Hardware Design in OCaml"
+description: "
 Hardcaml is an embedded DSL for designing and simulating hardware in OCaml.
 Generic hardware designs are easily expressed using features such as higher
 order functions, lists, maps etc.  A built in simulator allows designs to

example/src/jbuild

@@ -0,0 +1,3 @@
+(library (name hardcaml) (public_name hardcaml) (c_names bits_stubs)
+ (preprocess (pps ppx_jane -dont-check-doc-comments-attachment))
+ (libraries base bigarray dynlink stdio topological_sort unix zarith))

example/test/dune

@@ -12,6 +12,64 @@ module Create_fn (I : S) (O : S) = struct
         ~outputs:(O.t : (string * int) O.t)]
 end
 
+module Ast = struct
+  module rec Ast : sig
+    type t = Field.t list
+    [@@deriving sexp_of]
+  end = struct
+    type t = Field.t list
+    [@@deriving sexp_of]
+  end
+  and Field : sig
+    type t =
+      { name : string
+      ; type_ : Type.t
+      ; sequence : Sequence.t option
+      ; doc : string option }
+    [@@deriving sexp_of]
+  end = struct
+    type t =
+      { name : string
+      ; type_ : Type.t
+      ; sequence : Sequence.t option
+      ; doc : string option }
+    [@@deriving sexp_of]
+  end
+  and Type : sig
+    type t =
+      | Signal of { bits : int; rtlname : string }
+      | Module of { name : string; ast : Ast.t }
+    [@@deriving sexp_of]
+  end = struct
+    type t =
+      | Signal of { bits : int; rtlname : string }
+      | Module of { name : string; ast : Ast.t }
+    [@@deriving sexp_of]
+  end
+  and Sequence : sig
+    module Kind : sig
+      type t = Array | List
+      [@@deriving sexp_of]
+    end
+    type t =
+      { kind : Kind.t
+      ; length : int }
+    [@@deriving sexp_of]
+  end = struct
+    module Kind = struct
+      type t = Array | List
+      [@@deriving sexp_of]
+    end
+    type t =
+      { kind : Kind.t
+      ; length : int }
+    [@@deriving sexp_of]
+  end
+
+  type t = Ast.t
+  [@@deriving sexp_of]
+end
+
 module Make (X : Pre) : S with type 'a t := 'a X.t = struct
 
   include X
@@ -158,10 +216,15 @@ module Empty = struct
   include Make (struct
       type nonrec 'a t = 'a t [@@deriving sexp_of]
       let t = None
-      let iter ~f:_ _ = ()
-      let iter2 ~f:_ _ _ = ()
-      let map ~f:_ _ = None
-      let map2 ~f:_ _ _ = None
+      let iter _ ~f:_ = ()
+      let iter2 _ _ ~f:_ = ()
+      let map _ ~f:_ = None
+      let map2 _ _ ~f:_ = None
       let to_list _ = []
     end)
 end
+
+module type S_with_ast = sig
+  include S
+  val ast : Ast.t
+end

example/test/jbuild

@@ -18,13 +18,62 @@ module type Pre = sig
   [@@deriving sexp_of]
 
   val t : (string * int) t
-  val iter : f:('a -> unit) -> 'a t -> unit
-  val iter2 : f:('a -> 'b -> unit) -> 'a t -> 'b t -> unit
-  val map : f:('a -> 'b) -> 'a t -> 'b t
-  val map2 : f:('a -> 'b -> 'c) -> 'a t -> 'b t -> 'c t
+  val iter : 'a t -> f:('a -> unit) -> unit
+  val iter2 : 'a t -> 'b t -> f:('a -> 'b -> unit) -> unit
+  val map : 'a t -> f:('a -> 'b) -> 'b t
+  val map2 : 'a t -> 'b t -> f:('a -> 'b -> 'c) -> 'c t
   val to_list : 'a t -> 'a list
 end
 
+module type Ast = sig
+  (** The PPX can optionally generate an [ast] field containing an [Ast.t]. This
+      represents the structure of the interface, including how it is constructed from
+      fields, arrays, lists and sub-modules.
+
+      This is of particular use when generating further code from the interface i.e. a
+      register interace specification.
+
+      [ast]s are not generated by default. *)
+  module rec Ast : sig
+    type t = Field.t list
+    [@@deriving sexp_of]
+  end
+  and Field : sig
+    type t =
+      { name : string
+      (** Name of the field *)
+      ; type_ : Type.t
+      (** Field type - a signal or a sub-module *)
+      ; sequence : Sequence.t option
+      (** Is the field type an array or list? *)
+      ; doc : string option
+      (** Ocaml documentation string, if any. Note that this must be placed in the [ml]
+          and not [mli].*)
+      }
+    [@@deriving sexp_of]
+  end
+  and Type : sig
+    type t =
+      | Signal of { bits : int; rtlname : string }
+      | Module of { name : string; ast : Ast.t }
+    [@@deriving sexp_of]
+  end
+  and Sequence : sig
+    module Kind : sig
+      type t = Array | List
+      [@@deriving sexp_of]
+    end
+
+    type t =
+      { kind : Kind.t
+      ; length : int }
+    [@@deriving sexp_of]
+  end
+
+  type t = Ast.t
+  [@@deriving sexp_of]
+end
+
 module type Comb = sig
 
   type 'a interface
@@ -170,14 +219,20 @@ end
 
 module type Interface = sig
 
-
   module type Pre = Pre
   module type S   = S
+  module type Ast = Ast
 
   module type Empty = Empty
 
+  module Ast : Ast
   module Empty : Empty
 
+  module type S_with_ast = sig
+    include S
+    val ast : Ast.t
+  end
+
   (** Type of functions representing the implementation of a circuit from an input to
       output interface. *)
   module Create_fn (I : S) (O : S) : sig

hardcaml.opam

@@ -180,50 +180,50 @@ end
 module SVar = Same (struct
     type 'a t = 'a [@@deriving sexp_of]
     let t = "var", 0
-    let iter ~f a = f a
-    let iter2 ~f a b = f a b
-    let map ~f a = f a
-    let map2 ~f a b = f a b
+    let iter a ~f = f a
+    let iter2 a b ~f = f a b
+    let map a ~f = f a
+    let map2 a b ~f = f a b
     let to_list a = [ a ]
   end)
 
 (* not so sure these are particularly useful; interfaces can do the job better *)
 module SList = Same (struct
     type 'a t = 'a list [@@deriving sexp_of]
     let t = []
-    let iter ~f l = List.iter l ~f
-    let iter2 ~f l0 l1 = List.iter2_exn l0 l1 ~f
-    let map ~f l = List.map l ~f
-    let map2 ~f l0 l1 = List.map2_exn l0 l1 ~f
+    let iter l ~f = List.iter l ~f
+    let iter2 l0 l1 ~f = List.iter2_exn l0 l1 ~f
+    let map l ~f = List.map l ~f
+    let map2 l0 l1 ~f = List.map2_exn l0 l1 ~f
     let to_list a = a
   end)
 
 module SArray = Same (struct
     type 'a t = 'a array [@@deriving sexp_of]
     let t = [||]
-    let iter ~f t = Array.iter t ~f
-    let iter2 ~f t1 t2 = Array.iter2_exn t1 t2 ~f
-    let map ~f a = Array.map a ~f
-    let map2 ~f a b = Array.init (Array.length a) ~f:(fun i -> f a.(i) b.(i))
+    let iter t ~f = Array.iter t ~f
+    let iter2 t1 t2 ~f = Array.iter2_exn t1 t2 ~f
+    let map a ~f = Array.map a ~f
+    let map2 a b ~f = Array.init (Array.length a) ~f:(fun i -> f a.(i) b.(i))
     let to_list = Array.to_list
   end)
 
 module STuple2 = Same (struct
     type 'a t = 'a * 'a [@@deriving sexp_of]
     let t = ("a", 0), ("b", 0)
-    let iter ~f (a, b) = f a; f b
-    let iter2 ~f (a, b) (c, d) = f a c; f b d
-    let map ~f (a, b) = (f a, f b)
-    let map2 ~f (a, b) (c, d) = (f a c, f b d)
+    let iter (a, b) ~f = f a; f b
+    let iter2 (a, b) (c, d) ~f = f a c; f b d
+    let map (a, b) ~f = (f a, f b)
+    let map2 (a, b) (c, d) ~f = (f a c, f b d)
     let to_list (a, b) = [ a; b ]
   end)
 
 module STuple3 = Same (struct
     type 'a t = 'a * 'a * 'a [@@deriving sexp_of]
     let t = ("a", 0), ("b", 0), ("c", 0)
-    let iter ~f (a, b, c) = f a; f b; f c
-    let iter2 ~f:f' (a, b, c) (d, e, f) = f' a d; f' b e; f' c f
-    let map ~f (a, b, c) = (f a, f b, f c)
-    let map2 ~f:f' (a, b, c) (d, e, f) = (f' a d, f' b e, f' c f)
+    let iter (a, b, c) ~f = f a; f b; f c
+    let iter2 (a, b, c) (d, e, f) ~f:fn = fn a d; fn b e; fn c f
+    let map (a, b, c) ~f = (f a, f b, f c)
+    let map2 (a, b, c) (d, e, f) ~f:fn = (fn a d, fn b e, fn c f)
     let to_list (a, b, c) = [ a; b; c ]
   end)