pax_global_header00006660000000000000000000000064131773567530014533gustar00rootroot0000000000000052 comment=05fb76531a8b290862c1e6d8e9d52dffeac19049 gen-0.5/000077500000000000000000000000001317735675300121505ustar00rootroot00000000000000gen-0.5/.gitignore000066400000000000000000000001231317735675300141340ustar00rootroot00000000000000.*.swp .*.swo _build *.native *.byte .session TAGS *.docdir *.log setup.data qtest gen-0.5/.header000066400000000000000000000001241317735675300133760ustar00rootroot00000000000000(* This file is free software, part of gen. See file "license" for more details. *) gen-0.5/.merlin000066400000000000000000000001031317735675300134310ustar00rootroot00000000000000S src B _build/src S tests B _build/tests PKG oUnit FLG -w +a-4-44 gen-0.5/.ocamlinit000066400000000000000000000000541317735675300141270ustar00rootroot00000000000000#directory "_build/src";; #load "gen.cma";; gen-0.5/.ocp-indent000066400000000000000000000000171317735675300142070ustar00rootroot00000000000000match_clause=4 gen-0.5/CHANGELOG.md000066400000000000000000000042031317735675300137600ustar00rootroot00000000000000# Changelog # 0.5 - fix small problem with safe-string - move to safe-string, for compatibility with 4.06.0 - add optimize() flag to `_tags` - rename parameter of `int_range` from `by` to `step` - add `?(by=1)` to `int_range` # 0.4 - update `GenLabels` with missing functions - add `Gen.peek_n` - add `Gen.peek` - add first draft of `GenM`, an overlay for iterating over monadic values. this module is experimental as of now. - cleanup: * more tests * move all tests to gen.ml using qtest * merge benchmarks into a single file * add ocp-indent file, update header, reindent files * move code to src/ # 0.3 - add `Gen.return` - fix overflow in `Gen.flat_map`; add regression test - opam: depend on ocamlbuild - add functions `Gen.{lines,unlines}` - add `Gen.Restart.of_gen` as a convenient alias to `persistent_lazy` - add `Gen.IO.{with_lines, write_lines}` - update benchmarks to use Benchmark.Tree # 0.2.4 - `GenLabels` module - `fold_while` function - `fold_map` implementation, deprecating `scan` - updated doc to make clear that combinators consume their generator argument - add missing @since; expose infix operators # 0.2.3 - updated .mli to replace "enum" with "gen" - `Gen.persistent_lazy` now exposes caching parameters related to `GenMList.of_gen_lazy` - give control over buffering in `GenMList.of_gen_lazy` - move some code to new modules GenClone and GenMList - add lwt and async style infix map operators - Gen.IO - `to_string`, `of_string`, `to_buffer` - opam file - add `permutations_heap` for array-based permutations; add a corresponding benchmark to compare - license file # 0.2.2 - do not depend on qtest - better combinatorics (`permutations`, `power_set`, `combinations`) -` Gen.{permutations,power_set,combinations}` - `Gen.unfold_scan` - put Gen.S into a new module, `Gen_intf` - `Gen.persistent_lazy` implemented - .merlin files ## 0.2.1 - added many tests using Qtest; fixed 2 bugs - simpler and more efficient unrolled list - unrolled list for Gen.persistent (much better on big generators) ## 0.2 - changed `camlCase` to `this_case` - `take_nth` combinator note: `git log --no-merges previous_version..HEAD --pretty=%s` gen-0.5/LICENSE000066400000000000000000000024061317735675300131570ustar00rootroot00000000000000Copyright (c) 2012, Simon Cruanes All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. gen-0.5/Makefile000066400000000000000000000026111317735675300136100ustar00rootroot00000000000000# OASIS_START # DO NOT EDIT (digest: a3c674b4239234cbbe53afe090018954) SETUP = ocaml setup.ml build: setup.data $(SETUP) -build $(BUILDFLAGS) doc: setup.data build $(SETUP) -doc $(DOCFLAGS) test: setup.data build $(SETUP) -test $(TESTFLAGS) all: $(SETUP) -all $(ALLFLAGS) install: setup.data $(SETUP) -install $(INSTALLFLAGS) uninstall: setup.data $(SETUP) -uninstall $(UNINSTALLFLAGS) reinstall: setup.data $(SETUP) -reinstall $(REINSTALLFLAGS) clean: $(SETUP) -clean $(CLEANFLAGS) distclean: $(SETUP) -distclean $(DISTCLEANFLAGS) setup.data: $(SETUP) -configure $(CONFIGUREFLAGS) configure: $(SETUP) -configure $(CONFIGUREFLAGS) .PHONY: build doc test all install uninstall reinstall clean distclean configure # OASIS_STOP push_doc: all doc rsync -tavu gen.docdir/* cedeela.fr:~/simon/root/software/gen/ qtest-gen: mkdir -p qtest qtest extract src/gen.ml > qtest/run_qtest.ml || true test-all: ./run_qtest.native VERSION=$(shell awk '/^Version:/ {print $$2}' _oasis) update_next_tag: @echo "update version to $(VERSION)..." find -name '*.ml' -or -name '*.mli' | xargs sed -i "s/NEXT_VERSION/$(VERSION)/g" find -name '*.ml' -or -name '*.mli' | xargs sed -i "s/NEXT_RELEASE/$(VERSION)/g" watch: while find src/ bench/ -print0 | xargs -0 inotifywait -e delete_self -e modify ; do \ echo "============ at `date` ==========" ; \ make ; \ done .PHONY: update_next_tag release gen-0.5/README.md000066400000000000000000000022201317735675300134230ustar00rootroot00000000000000# Gen Iterators for OCaml, both restartable and consumable. The implementation keeps a good balance between simplicity and performance. The library is extensively tested using `qtest`. If you find a bug, please report! The documentation can be found [here](http://cedeela.fr/~simon/software/gen); the main module is [Gen](http://cedeela.fr/~simon/software/gen/Gen.html) and should suffice for 95% of use cases. ## Install $ opam install gen or, manually, by building the library and running `make install`. Opam is recommended, for it keeps the library up-to-date. ## Use You can either build and install the library (see "Build"), or just copy files to your own project. The last solution has the benefits that you don't have additional dependencies nor build complications (and it may enable more inlining). If you have comments, requests, or bugfixes, please share them! :-) ## Build There are no dependencies. This should work with OCaml>=3.12. $ make To build and run tests (requires `oUnit` and `qtest`): $ opam install oUnit qtest $ ./configure --enable-tests $ make test ## License This code is free, under the BSD license. gen-0.5/_oasis000066400000000000000000000025471317735675300133600ustar00rootroot00000000000000OASISFormat: 0.3 Name: gen Version: 0.5 Homepage: https://github.com/c-cube/gen Authors: Simon Cruanes License: BSD-3-clause LicenseFile: LICENSE Plugins: META (0.3), DevFiles (0.3) BuildTools: ocamlbuild Synopsis: Simple, efficient iterators for OCaml Flag "bench" Description: build benchmark Default: false Library gen Path: src Pack: false Modules: Gen, GenLabels, GenClone, GenMList, Gen_intf, GenLabels_intf, GenM, GenM_intf Document gen Title: Containers docs Type: ocamlbuild (0.3) BuildTools+: ocamldoc Install: true XOCamlbuildPath: src XOCamlbuildLibraries: gen PreBuildCommand: make qtest-gen Executable run_qtest Path: qtest/ Install: false CompiledObject: native MainIs: run_qtest.ml Build$: flag(tests) BuildDepends: gen, oUnit, qcheck Test all Command: make test-all TestTools: run_qtest Run$: flag(tests) Executable run_benchs Path: bench/ Install: false CompiledObject: native MainIs: run_benchs.ml Build$: flag(bench) BuildDepends: gen, benchmark SourceRepository head Type: git Location: https://github.com/c-cube/gen Browser: https://github.com/c-cube/gen/tree/master/src gen-0.5/_tags000066400000000000000000000017651317735675300132010ustar00rootroot00000000000000# OASIS_START # DO NOT EDIT (digest: 40703a1b20afe876b3dffbe1b72fc538) # Ignore VCS directories, you can use the same kind of rule outside # OASIS_START/STOP if you want to exclude directories that contains # useless stuff for the build process true: annot, bin_annot <**/.svn>: -traverse <**/.svn>: not_hygienic ".bzr": -traverse ".bzr": not_hygienic ".hg": -traverse ".hg": not_hygienic ".git": -traverse ".git": not_hygienic "_darcs": -traverse "_darcs": not_hygienic # Library gen "src/gen.cmxs": use_gen # Executable run_qtest "qtest/run_qtest.native": pkg_oUnit "qtest/run_qtest.native": pkg_qcheck "qtest/run_qtest.native": use_gen : pkg_oUnit : pkg_qcheck : use_gen # Executable run_benchs "bench/run_benchs.native": pkg_benchmark "bench/run_benchs.native": use_gen : pkg_benchmark : use_gen # OASIS_STOP "qtest": include <**/*.ml>: warn(+a-4-44@8), safe_string <**/*.cmx>: optimize(3) <**/genLabels.cm*>: nolabels gen-0.5/bench/000077500000000000000000000000001317735675300132275ustar00rootroot00000000000000gen-0.5/bench/.merlin000066400000000000000000000000511317735675300145120ustar00rootroot00000000000000S . B ../_build/bench/ REC PKG benchmark gen-0.5/bench/run_benchs.ml000066400000000000000000000221271317735675300157130ustar00rootroot00000000000000 module B = Benchmark (* benchmark the "persistent" function *) module Persistent = struct let _sum g = Gen.Restart.fold (+) 0 g module MList = struct type 'a t = 'a node option ref and 'a node = { content : 'a; mutable prev : 'a node; mutable next : 'a node; } let create () = ref None let is_empty d = match !d with | None -> true | Some _ -> false let push_back d x = match !d with | None -> let rec elt = { content = x; prev = elt; next = elt; } in d := Some elt | Some first -> let elt = { content = x; next=first; prev=first.prev; } in first.prev.next <- elt; first.prev <- elt (* conversion to gen *) let to_gen d = fun () -> match !d with | None -> (fun () -> None) | Some first -> let cur = ref first in (* current element of the list *) let stop = ref false in (* are we done yet? *) fun () -> if !stop then None else begin let x = (!cur).content in cur := (!cur).next; (if !cur == first then stop := true); (* EOG, we made a full cycle *) Some x end end (** Store content of the generator in an enum *) let persistent_mlist gen = let l = MList.create () in Gen.iter (MList.push_back l) gen; MList.to_gen l let bench_mlist n = let g = persistent_mlist Gen.(1 -- n) in ignore (_sum g) (** {6 Unrolled mutable list} *) module UnrolledList = struct type 'a node = | Nil | Partial of 'a array * int | Cons of 'a array * 'a node ref let of_gen gen = let start = ref Nil in let chunk_size = ref 16 in let rec fill prev cur = match cur, gen() with | Partial (a,n), None -> prev := Cons (Array.sub a 0 n, ref Nil); () (* done *) | _, None -> prev := cur; () (* done *) | Nil, Some x -> let n = !chunk_size in if n < 4096 then chunk_size := 2 * !chunk_size; fill prev (Partial (Array.make n x, 1)) | Partial (a, n), Some x -> assert (n < Array.length a); a.(n) <- x; if n+1 = Array.length a then begin let r = ref Nil in prev := Cons(a, r); fill r Nil end else fill prev (Partial (a, n+1)) | Cons _, _ -> assert false in fill start !start ; !start let to_gen l () = let cur = ref l in let i = ref 0 in let rec next() = match !cur with | Nil -> None | Cons (a,l') -> if !i = Array.length a then begin cur := !l'; i := 0; next() end else begin let y = a.(!i) in incr i; Some y end | Partial _ -> assert false in next end (** Store content of the generator in an enum *) let persistent_unrolled gen = let l = UnrolledList.of_gen gen in UnrolledList.to_gen l let bench_unrolled n = let g = persistent_unrolled Gen.(1 -- n) in ignore (_sum g) let bench_naive n = let l = Gen.to_rev_list Gen.(1 -- n) in let g = Gen.Restart.of_list (List.rev l) in ignore (_sum g) let bench_current n = let g = Gen.persistent Gen.(1 -- n) in ignore (_sum g) let bench_current_lazy n = let g = Gen.persistent_lazy Gen.(1 -- n) in ignore (_sum g) let bench_current_lazy_no_cache n = let g = Gen.persistent_lazy ~max_chunk_size:16 ~caching:false Gen.(1 -- n) in ignore (_sum g) let () = let open B.Tree in let bench_n n = B.throughputN 2 ~repeat:3 [ "mlist", bench_mlist, n ; "naive", bench_naive, n ; "unrolled", bench_unrolled, n ; "current", bench_current, n ; "current_lazy", bench_current_lazy, n ; "current_lazy_no_cache", bench_current_lazy_no_cache, n ] in let app_int f n = string_of_int n @> lazy (f n) in let app_ints f l = B.Tree.concat (List.map (app_int f) l) in B.Tree.register ( "persistent" @>> app_ints bench_n [100; 1_000; 10_000; 100_000] ) end (* benchmark the "permutation" function *) module Perm = struct module PermState = struct type 'a state = | Done | Base (* bottom machine, yield [] *) | Insert of 'a insert_state and 'a insert_state = { x : 'a; mutable l : 'a list; mutable n : int; (* idx for insertion *) len : int; (* len of [l] *) sub : 'a t; } and 'a t = { mutable st : 'a state; } end let permutations_rec g = let open PermState in (* make a machine for n elements. Invariant: n=len(l) *) let rec make_machine n l = match l with | [] -> assert (n=0); {st=Base} | x :: tail -> let sub = make_machine (n-1) tail in let st = match next sub () with | None -> Done | Some l -> Insert {x;n=0;l;len=n;sub} in {st;} (* next element of the machine *) and next m () = match m.st with | Done -> None | Base -> m.st <- Done; Some [] | Insert ({x;len;n;l;sub} as state) -> if n=len then match next sub () with | None -> m.st <- Done; None | Some l -> state.l <- l; state.n <- 0; next m () else ( state.n <- state.n + 1; Some (insert x n l) ) and insert x n l = match n, l with | 0, _ -> x::l | _, [] -> assert false | _, y::tail -> y :: insert x (n-1) tail in let l = Gen.fold (fun acc x->x::acc) [] g in next (make_machine (List.length l) l) (* Credits to Bernardo Freitas Paulo da Costa for [permutations_heap]! B.R.Heap's algorithm for permutations, cf http://en.wikipedia.org/wiki/Heap%27s_algorithm. Continuation-based recursive formula, model for the state manipulations below: {[ let rec heap_perm k a n = match n with | 0 -> k a | n -> for i = 0 to n-1 do heap_perm k a (n-1); let j = (if n mod 2 = 1 then 0 else i) in let t = a.(j) in a.(j) <- a.(n-1); a.(n-1) <- t done ]} *) (* The state of the permutation machine, containing - the array [a] we're permuting, in the "current permutation"; - the level of recursion [n]: we can permute elements with index < [n] - the stack of values of indices to permute [i] in the list [is] The permutation stops when we have no more elements in the stack [is]. *) module HeapPermState = struct type 'a state = { elts : 'a array; mutable n : int; mutable is : int list; } end let permutations_heap g = let open HeapPermState in let l = Gen.fold (fun acc x->x::acc) [] g in let a = Array.of_list l in let rec next st () = match st.n with | 0 -> begin match st.is with | [] | _::[] -> assert false | 0::i::is' -> (* "Pop state" before returning next element *) st.is <- (i+1)::is'; st.n <- 1; Some (Array.copy a) | _::_::_ -> assert false end | n -> match st.is with | [] -> None | i::is' when i = n -> (* Pop state at end of loop *) st.is <- is'; st.n <- n+1; begin match st.is with | [] -> None (* last loop *) | i::is' -> let j = (if st.n mod 2 = 1 then 0 else i) in let tmp = st.elts.(j) in st.elts.(j) <- st.elts.(n); st.elts.(n) <- tmp; st.is <- (i+1)::is'; next st () end | _::_ -> (* Recurse down and start new loop *) st.n <- n-1; st.is <- 0 :: st.is; next st () in let n = Array.length a in if n = 0 then Gen.empty else next {elts = a; n=n; is=[0]} (* take [len] permutations of [1..n] *) let bench_it n len = Printf.printf "\ntake %d permutations out of [1...%d]\n" len n; let run perm () = let open Gen in perm (1--n) |> take len |> iter (fun _ -> ()) in let res = Benchmark.throughputN 2 [ "perm_rec", run permutations_rec, () ; "perm_heap", run permutations_heap, () ; "current", run Gen.permutations, () ] in Benchmark.tabulate res let bench_n len n = let run perm () = let open Gen in perm (1--n) |> take len |> iter (fun _ -> ()) in B.throughputN 2 ~repeat:3 [ "perm_rec", run permutations_rec, () ; "perm_heap", run permutations_heap, () ; "current", run Gen.permutations, () ] let () = let open B.Tree in let app_int f n = string_of_int n @> lazy (f n) in let app_ints f l = B.Tree.concat (List.map (app_int f) l) in B.Tree.register ( "perm" @>>> [ "len=100" @>> app_ints (bench_n 100) [5; 100; 1_000] ; "len=50_000" @>> app_ints (bench_n 50_000) [100; 1_000] ]) end let () = try B.Tree.run_global () with Arg.Help msg -> print_endline msg gen-0.5/configure000077500000000000000000000005531317735675300140620ustar00rootroot00000000000000#!/bin/sh # OASIS_START # DO NOT EDIT (digest: dc86c2ad450f91ca10c931b6045d0499) set -e FST=true for i in "$@"; do if $FST; then set -- FST=false fi case $i in --*=*) ARG=${i%%=*} VAL=${i##*=} set -- "$@" "$ARG" "$VAL" ;; *) set -- "$@" "$i" ;; esac done ocaml setup.ml -configure "$@" # OASIS_STOP gen-0.5/descr000066400000000000000000000002721317735675300131740ustar00rootroot00000000000000Simple and efficient iterators (modules Gen and GenLabels). Now provides additional modules GenClone and GenMList for lower-level control over persistency and duplication of iterators. gen-0.5/gen.odocl000066400000000000000000000002441317735675300137430ustar00rootroot00000000000000# OASIS_START # DO NOT EDIT (digest: 8baad29d22c1f5fe92efa8f831e8907b) src/Gen src/GenLabels src/GenClone src/GenMList src/Gen_intf src/GenLabels_intf # OASIS_STOP gen-0.5/myocamlbuild.ml000066400000000000000000000570141317735675300151720ustar00rootroot00000000000000(* OASIS_START *) (* DO NOT EDIT (digest: f285b67ce7fedefd0650ed1690939304) *) module OASISGettext = struct (* # 22 "src/oasis/OASISGettext.ml" *) let ns_ str = str let s_ str = str let f_ (str: ('a, 'b, 'c, 'd) format4) = str let fn_ fmt1 fmt2 n = if n = 1 then fmt1^^"" else fmt2^^"" let init = [] end module OASISString = struct (* # 22 "src/oasis/OASISString.ml" *) (** Various string utilities. Mostly inspired by extlib and batteries ExtString and BatString libraries. @author Sylvain Le Gall *) let nsplitf str f = if str = "" then [] else let buf = Buffer.create 13 in let lst = ref [] in let push () = lst := Buffer.contents buf :: !lst; Buffer.clear buf in let str_len = String.length str in for i = 0 to str_len - 1 do if f str.[i] then push () else Buffer.add_char buf str.[i] done; push (); List.rev !lst (** [nsplit c s] Split the string [s] at char [c]. It doesn't include the separator. *) let nsplit str c = nsplitf str ((=) c) let find ~what ?(offset=0) str = let what_idx = ref 0 in let str_idx = ref offset in while !str_idx < String.length str && !what_idx < String.length what do if str.[!str_idx] = what.[!what_idx] then incr what_idx else what_idx := 0; incr str_idx done; if !what_idx <> String.length what then raise Not_found else !str_idx - !what_idx let sub_start str len = let str_len = String.length str in if len >= str_len then "" else String.sub str len (str_len - len) let sub_end ?(offset=0) str len = let str_len = String.length str in if len >= str_len then "" else String.sub str 0 (str_len - len) let starts_with ~what ?(offset=0) str = let what_idx = ref 0 in let str_idx = ref offset in let ok = ref true in while !ok && !str_idx < String.length str && !what_idx < String.length what do if str.[!str_idx] = what.[!what_idx] then incr what_idx else ok := false; incr str_idx done; !what_idx = String.length what let strip_starts_with ~what str = if starts_with ~what str then sub_start str (String.length what) else raise Not_found let ends_with ~what ?(offset=0) str = let what_idx = ref ((String.length what) - 1) in let str_idx = ref ((String.length str) - 1) in let ok = ref true in while !ok && offset <= !str_idx && 0 <= !what_idx do if str.[!str_idx] = what.[!what_idx] then decr what_idx else ok := false; decr str_idx done; !what_idx = -1 let strip_ends_with ~what str = if ends_with ~what str then sub_end str (String.length what) else raise Not_found let replace_chars f s = let buf = Buffer.create (String.length s) in String.iter (fun c -> Buffer.add_char buf (f c)) s; Buffer.contents buf let lowercase_ascii = replace_chars (fun c -> if (c >= 'A' && c <= 'Z') then Char.chr (Char.code c + 32) else c) let uncapitalize_ascii s = if s <> "" then (lowercase_ascii (String.sub s 0 1)) ^ (String.sub s 1 ((String.length s) - 1)) else s let uppercase_ascii = replace_chars (fun c -> if (c >= 'a' && c <= 'z') then Char.chr (Char.code c - 32) else c) let capitalize_ascii s = if s <> "" then (uppercase_ascii (String.sub s 0 1)) ^ (String.sub s 1 ((String.length s) - 1)) else s end module OASISUtils = struct (* # 22 "src/oasis/OASISUtils.ml" *) open OASISGettext module MapExt = struct module type S = sig include Map.S val add_list: 'a t -> (key * 'a) list -> 'a t val of_list: (key * 'a) list -> 'a t val to_list: 'a t -> (key * 'a) list end module Make (Ord: Map.OrderedType) = struct include Map.Make(Ord) let rec add_list t = function | (k, v) :: tl -> add_list (add k v t) tl | [] -> t let of_list lst = add_list empty lst let to_list t = fold (fun k v acc -> (k, v) :: acc) t [] end end module MapString = MapExt.Make(String) module SetExt = struct module type S = sig include Set.S val add_list: t -> elt list -> t val of_list: elt list -> t val to_list: t -> elt list end module Make (Ord: Set.OrderedType) = struct include Set.Make(Ord) let rec add_list t = function | e :: tl -> add_list (add e t) tl | [] -> t let of_list lst = add_list empty lst let to_list = elements end end module SetString = SetExt.Make(String) let compare_csl s1 s2 = String.compare (OASISString.lowercase_ascii s1) (OASISString.lowercase_ascii s2) module HashStringCsl = Hashtbl.Make (struct type t = string let equal s1 s2 = (compare_csl s1 s2) = 0 let hash s = Hashtbl.hash (OASISString.lowercase_ascii s) end) module SetStringCsl = SetExt.Make (struct type t = string let compare = compare_csl end) let varname_of_string ?(hyphen='_') s = if String.length s = 0 then begin invalid_arg "varname_of_string" end else begin let buf = OASISString.replace_chars (fun c -> if ('a' <= c && c <= 'z') || ('A' <= c && c <= 'Z') || ('0' <= c && c <= '9') then c else hyphen) s; in let buf = (* Start with a _ if digit *) if '0' <= s.[0] && s.[0] <= '9' then "_"^buf else buf in OASISString.lowercase_ascii buf end let varname_concat ?(hyphen='_') p s = let what = String.make 1 hyphen in let p = try OASISString.strip_ends_with ~what p with Not_found -> p in let s = try OASISString.strip_starts_with ~what s with Not_found -> s in p^what^s let is_varname str = str = varname_of_string str let failwithf fmt = Printf.ksprintf failwith fmt let rec file_location ?pos1 ?pos2 ?lexbuf () = match pos1, pos2, lexbuf with | Some p, None, _ | None, Some p, _ -> file_location ~pos1:p ~pos2:p ?lexbuf () | Some p1, Some p2, _ -> let open Lexing in let fn, lineno = p1.pos_fname, p1.pos_lnum in let c1 = p1.pos_cnum - p1.pos_bol in let c2 = c1 + (p2.pos_cnum - p1.pos_cnum) in Printf.sprintf (f_ "file %S, line %d, characters %d-%d") fn lineno c1 c2 | _, _, Some lexbuf -> file_location ~pos1:(Lexing.lexeme_start_p lexbuf) ~pos2:(Lexing.lexeme_end_p lexbuf) () | None, None, None -> s_ "" let failwithpf ?pos1 ?pos2 ?lexbuf fmt = let loc = file_location ?pos1 ?pos2 ?lexbuf () in Printf.ksprintf (fun s -> failwith (Printf.sprintf "%s: %s" loc s)) fmt end module OASISExpr = struct (* # 22 "src/oasis/OASISExpr.ml" *) open OASISGettext open OASISUtils type test = string type flag = string type t = | EBool of bool | ENot of t | EAnd of t * t | EOr of t * t | EFlag of flag | ETest of test * string type 'a choices = (t * 'a) list let eval var_get t = let rec eval' = function | EBool b -> b | ENot e -> not (eval' e) | EAnd (e1, e2) -> (eval' e1) && (eval' e2) | EOr (e1, e2) -> (eval' e1) || (eval' e2) | EFlag nm -> let v = var_get nm in assert(v = "true" || v = "false"); (v = "true") | ETest (nm, vl) -> let v = var_get nm in (v = vl) in eval' t let choose ?printer ?name var_get lst = let rec choose_aux = function | (cond, vl) :: tl -> if eval var_get cond then vl else choose_aux tl | [] -> let str_lst = if lst = [] then s_ "" else String.concat (s_ ", ") (List.map (fun (cond, vl) -> match printer with | Some p -> p vl | None -> s_ "") lst) in match name with | Some nm -> failwith (Printf.sprintf (f_ "No result for the choice list '%s': %s") nm str_lst) | None -> failwith (Printf.sprintf (f_ "No result for a choice list: %s") str_lst) in choose_aux (List.rev lst) end # 437 "myocamlbuild.ml" module BaseEnvLight = struct (* # 22 "src/base/BaseEnvLight.ml" *) module MapString = Map.Make(String) type t = string MapString.t let default_filename = Filename.concat (Sys.getcwd ()) "setup.data" let load ?(allow_empty=false) ?(filename=default_filename) ?stream () = let line = ref 1 in let lexer st = let st_line = Stream.from (fun _ -> try match Stream.next st with | '\n' -> incr line; Some '\n' | c -> Some c with Stream.Failure -> None) in Genlex.make_lexer ["="] st_line in let rec read_file lxr mp = match Stream.npeek 3 lxr with | [Genlex.Ident nm; Genlex.Kwd "="; Genlex.String value] -> Stream.junk lxr; Stream.junk lxr; Stream.junk lxr; read_file lxr (MapString.add nm value mp) | [] -> mp | _ -> failwith (Printf.sprintf "Malformed data file '%s' line %d" filename !line) in match stream with | Some st -> read_file (lexer st) MapString.empty | None -> if Sys.file_exists filename then begin let chn = open_in_bin filename in let st = Stream.of_channel chn in try let mp = read_file (lexer st) MapString.empty in close_in chn; mp with e -> close_in chn; raise e end else if allow_empty then begin MapString.empty end else begin failwith (Printf.sprintf "Unable to load environment, the file '%s' doesn't exist." filename) end let rec var_expand str env = let buff = Buffer.create ((String.length str) * 2) in Buffer.add_substitute buff (fun var -> try var_expand (MapString.find var env) env with Not_found -> failwith (Printf.sprintf "No variable %s defined when trying to expand %S." var str)) str; Buffer.contents buff let var_get name env = var_expand (MapString.find name env) env let var_choose lst env = OASISExpr.choose (fun nm -> var_get nm env) lst end # 517 "myocamlbuild.ml" module MyOCamlbuildFindlib = struct (* # 22 "src/plugins/ocamlbuild/MyOCamlbuildFindlib.ml" *) (** OCamlbuild extension, copied from * https://ocaml.org/learn/tutorials/ocamlbuild/Using_ocamlfind_with_ocamlbuild.html * by N. Pouillard and others * * Updated on 2016-06-02 * * Modified by Sylvain Le Gall *) open Ocamlbuild_plugin type conf = {no_automatic_syntax: bool} let run_and_read = Ocamlbuild_pack.My_unix.run_and_read let blank_sep_strings = Ocamlbuild_pack.Lexers.blank_sep_strings let exec_from_conf exec = let exec = let env = BaseEnvLight.load ~allow_empty:true () in try BaseEnvLight.var_get exec env with Not_found -> Printf.eprintf "W: Cannot get variable %s\n" exec; exec in let fix_win32 str = if Sys.os_type = "Win32" then begin let buff = Buffer.create (String.length str) in (* Adapt for windowsi, ocamlbuild + win32 has a hard time to handle '\\'. *) String.iter (fun c -> Buffer.add_char buff (if c = '\\' then '/' else c)) str; Buffer.contents buff end else begin str end in fix_win32 exec let split s ch = let buf = Buffer.create 13 in let x = ref [] in let flush () = x := (Buffer.contents buf) :: !x; Buffer.clear buf in String.iter (fun c -> if c = ch then flush () else Buffer.add_char buf c) s; flush (); List.rev !x let split_nl s = split s '\n' let before_space s = try String.before s (String.index s ' ') with Not_found -> s (* ocamlfind command *) let ocamlfind x = S[Sh (exec_from_conf "ocamlfind"); x] (* This lists all supported packages. *) let find_packages () = List.map before_space (split_nl & run_and_read (exec_from_conf "ocamlfind" ^ " list")) (* Mock to list available syntaxes. *) let find_syntaxes () = ["camlp4o"; "camlp4r"] let well_known_syntax = [ "camlp4.quotations.o"; "camlp4.quotations.r"; "camlp4.exceptiontracer"; "camlp4.extend"; "camlp4.foldgenerator"; "camlp4.listcomprehension"; "camlp4.locationstripper"; "camlp4.macro"; "camlp4.mapgenerator"; "camlp4.metagenerator"; "camlp4.profiler"; "camlp4.tracer" ] let dispatch conf = function | After_options -> (* By using Before_options one let command line options have an higher * priority on the contrary using After_options will guarantee to have * the higher priority override default commands by ocamlfind ones *) Options.ocamlc := ocamlfind & A"ocamlc"; Options.ocamlopt := ocamlfind & A"ocamlopt"; Options.ocamldep := ocamlfind & A"ocamldep"; Options.ocamldoc := ocamlfind & A"ocamldoc"; Options.ocamlmktop := ocamlfind & A"ocamlmktop"; Options.ocamlmklib := ocamlfind & A"ocamlmklib" | After_rules -> (* Avoid warnings for unused tag *) flag ["tests"] N; (* When one link an OCaml library/binary/package, one should use * -linkpkg *) flag ["ocaml"; "link"; "program"] & A"-linkpkg"; (* For each ocamlfind package one inject the -package option when * compiling, computing dependencies, generating documentation and * linking. *) List.iter begin fun pkg -> let base_args = [A"-package"; A pkg] in (* TODO: consider how to really choose camlp4o or camlp4r. *) let syn_args = [A"-syntax"; A "camlp4o"] in let (args, pargs) = (* Heuristic to identify syntax extensions: whether they end in ".syntax"; some might not. *) if not (conf.no_automatic_syntax) && (Filename.check_suffix pkg "syntax" || List.mem pkg well_known_syntax) then (syn_args @ base_args, syn_args) else (base_args, []) in flag ["ocaml"; "compile"; "pkg_"^pkg] & S args; flag ["ocaml"; "ocamldep"; "pkg_"^pkg] & S args; flag ["ocaml"; "doc"; "pkg_"^pkg] & S args; flag ["ocaml"; "link"; "pkg_"^pkg] & S base_args; flag ["ocaml"; "infer_interface"; "pkg_"^pkg] & S args; (* TODO: Check if this is allowed for OCaml < 3.12.1 *) flag ["ocaml"; "compile"; "package("^pkg^")"] & S pargs; flag ["ocaml"; "ocamldep"; "package("^pkg^")"] & S pargs; flag ["ocaml"; "doc"; "package("^pkg^")"] & S pargs; flag ["ocaml"; "infer_interface"; "package("^pkg^")"] & S pargs; end (find_packages ()); (* Like -package but for extensions syntax. Morover -syntax is useless * when linking. *) List.iter begin fun syntax -> flag ["ocaml"; "compile"; "syntax_"^syntax] & S[A"-syntax"; A syntax]; flag ["ocaml"; "ocamldep"; "syntax_"^syntax] & S[A"-syntax"; A syntax]; flag ["ocaml"; "doc"; "syntax_"^syntax] & S[A"-syntax"; A syntax]; flag ["ocaml"; "infer_interface"; "syntax_"^syntax] & S[A"-syntax"; A syntax]; end (find_syntaxes ()); (* The default "thread" tag is not compatible with ocamlfind. * Indeed, the default rules add the "threads.cma" or "threads.cmxa" * options when using this tag. When using the "-linkpkg" option with * ocamlfind, this module will then be added twice on the command line. * * To solve this, one approach is to add the "-thread" option when using * the "threads" package using the previous plugin. *) flag ["ocaml"; "pkg_threads"; "compile"] (S[A "-thread"]); flag ["ocaml"; "pkg_threads"; "doc"] (S[A "-I"; A "+threads"]); flag ["ocaml"; "pkg_threads"; "link"] (S[A "-thread"]); flag ["ocaml"; "pkg_threads"; "infer_interface"] (S[A "-thread"]); flag ["c"; "pkg_threads"; "compile"] (S[A "-thread"]); flag ["ocaml"; "package(threads)"; "compile"] (S[A "-thread"]); flag ["ocaml"; "package(threads)"; "doc"] (S[A "-I"; A "+threads"]); flag ["ocaml"; "package(threads)"; "link"] (S[A "-thread"]); flag ["ocaml"; "package(threads)"; "infer_interface"] (S[A "-thread"]); flag ["c"; "package(threads)"; "compile"] (S[A "-thread"]); | _ -> () end module MyOCamlbuildBase = struct (* # 22 "src/plugins/ocamlbuild/MyOCamlbuildBase.ml" *) (** Base functions for writing myocamlbuild.ml @author Sylvain Le Gall *) open Ocamlbuild_plugin module OC = Ocamlbuild_pack.Ocaml_compiler type dir = string type file = string type name = string type tag = string type t = { lib_ocaml: (name * dir list * string list) list; lib_c: (name * dir * file list) list; flags: (tag list * (spec OASISExpr.choices)) list; (* Replace the 'dir: include' from _tags by a precise interdepends in * directory. *) includes: (dir * dir list) list; } (* # 110 "src/plugins/ocamlbuild/MyOCamlbuildBase.ml" *) let env_filename = Pathname.basename BaseEnvLight.default_filename let dispatch_combine lst = fun e -> List.iter (fun dispatch -> dispatch e) lst let tag_libstubs nm = "use_lib"^nm^"_stubs" let nm_libstubs nm = nm^"_stubs" let dispatch t e = let env = BaseEnvLight.load ~allow_empty:true () in match e with | Before_options -> let no_trailing_dot s = if String.length s >= 1 && s.[0] = '.' then String.sub s 1 ((String.length s) - 1) else s in List.iter (fun (opt, var) -> try opt := no_trailing_dot (BaseEnvLight.var_get var env) with Not_found -> Printf.eprintf "W: Cannot get variable %s\n" var) [ Options.ext_obj, "ext_obj"; Options.ext_lib, "ext_lib"; Options.ext_dll, "ext_dll"; ] | After_rules -> (* Declare OCaml libraries *) List.iter (function | nm, [], intf_modules -> ocaml_lib nm; let cmis = List.map (fun m -> (OASISString.uncapitalize_ascii m) ^ ".cmi") intf_modules in dep ["ocaml"; "link"; "library"; "file:"^nm^".cma"] cmis | nm, dir :: tl, intf_modules -> ocaml_lib ~dir:dir (dir^"/"^nm); List.iter (fun dir -> List.iter (fun str -> flag ["ocaml"; "use_"^nm; str] (S[A"-I"; P dir])) ["compile"; "infer_interface"; "doc"]) tl; let cmis = List.map (fun m -> dir^"/"^(OASISString.uncapitalize_ascii m)^".cmi") intf_modules in dep ["ocaml"; "link"; "library"; "file:"^dir^"/"^nm^".cma"] cmis) t.lib_ocaml; (* Declare directories dependencies, replace "include" in _tags. *) List.iter (fun (dir, include_dirs) -> Pathname.define_context dir include_dirs) t.includes; (* Declare C libraries *) List.iter (fun (lib, dir, headers) -> (* Handle C part of library *) flag ["link"; "library"; "ocaml"; "byte"; tag_libstubs lib] (S[A"-dllib"; A("-l"^(nm_libstubs lib)); A"-cclib"; A("-l"^(nm_libstubs lib))]); flag ["link"; "library"; "ocaml"; "native"; tag_libstubs lib] (S[A"-cclib"; A("-l"^(nm_libstubs lib))]); if bool_of_string (BaseEnvLight.var_get "native_dynlink" env) then flag ["link"; "program"; "ocaml"; "byte"; tag_libstubs lib] (S[A"-dllib"; A("dll"^(nm_libstubs lib))]); (* When ocaml link something that use the C library, then one need that file to be up to date. This holds both for programs and for libraries. *) dep ["link"; "ocaml"; tag_libstubs lib] [dir/"lib"^(nm_libstubs lib)^"."^(!Options.ext_lib)]; dep ["compile"; "ocaml"; tag_libstubs lib] [dir/"lib"^(nm_libstubs lib)^"."^(!Options.ext_lib)]; (* TODO: be more specific about what depends on headers *) (* Depends on .h files *) dep ["compile"; "c"] headers; (* Setup search path for lib *) flag ["link"; "ocaml"; "use_"^lib] (S[A"-I"; P(dir)]); ) t.lib_c; (* Add flags *) List.iter (fun (tags, cond_specs) -> let spec = BaseEnvLight.var_choose cond_specs env in let rec eval_specs = function | S lst -> S (List.map eval_specs lst) | A str -> A (BaseEnvLight.var_expand str env) | spec -> spec in flag tags & (eval_specs spec)) t.flags | _ -> () let dispatch_default conf t = dispatch_combine [ dispatch t; MyOCamlbuildFindlib.dispatch conf; ] end # 878 "myocamlbuild.ml" open Ocamlbuild_plugin;; let package_default = { MyOCamlbuildBase.lib_ocaml = [("gen", ["src"], [])]; lib_c = []; flags = []; includes = [("qtest", ["src"]); ("bench", ["src"])] } ;; let conf = {MyOCamlbuildFindlib.no_automatic_syntax = false} let dispatch_default = MyOCamlbuildBase.dispatch_default conf package_default;; # 894 "myocamlbuild.ml" (* OASIS_STOP *) Ocamlbuild_plugin.dispatch dispatch_default;; gen-0.5/opam000066400000000000000000000011211317735675300130220ustar00rootroot00000000000000opam-version: "1.2" maintainer: "simon.cruanes.2007@m4x.org" author: "Simon Cruanes" name: "gen" version: "0.4" build: [ ["./configure" "--disable-docs" "--disable-tests" "--disable-bench"] [make "all"] ] install: [ [make "install"] ] remove: [ ["ocamlfind" "remove" "gen"] ] depends: [ "ocamlfind" {build} "ocamlbuild" {build} "base-bytes" ] tags: [ "gen" "iterator" "iter" "fold" ] homepage: "https://github.com/c-cube/gen/" doc: "http://cedeela.fr/~simon/software/gen/" bug-reports: "https://github.com/c-cube/gen/issues" dev-repo: "https://github.com/c-cube/gen.git" gen-0.5/setup.ml000066400000000000000000006416041317735675300136550ustar00rootroot00000000000000(* setup.ml generated for the first time by OASIS v0.4.0 *) (* OASIS_START *) (* DO NOT EDIT (digest: ad915a78b7f41db0b225ba8cf8a08d8e) *) (* Regenerated by OASIS v0.4.10 Visit http://oasis.forge.ocamlcore.org for more information and documentation about functions used in this file. *) module OASISGettext = struct (* # 22 "src/oasis/OASISGettext.ml" *) let ns_ str = str let s_ str = str let f_ (str: ('a, 'b, 'c, 'd) format4) = str let fn_ fmt1 fmt2 n = if n = 1 then fmt1^^"" else fmt2^^"" let init = [] end module OASISString = struct (* # 22 "src/oasis/OASISString.ml" *) (** Various string utilities. Mostly inspired by extlib and batteries ExtString and BatString libraries. @author Sylvain Le Gall *) let nsplitf str f = if str = "" then [] else let buf = Buffer.create 13 in let lst = ref [] in let push () = lst := Buffer.contents buf :: !lst; Buffer.clear buf in let str_len = String.length str in for i = 0 to str_len - 1 do if f str.[i] then push () else Buffer.add_char buf str.[i] done; push (); List.rev !lst (** [nsplit c s] Split the string [s] at char [c]. It doesn't include the separator. *) let nsplit str c = nsplitf str ((=) c) let find ~what ?(offset=0) str = let what_idx = ref 0 in let str_idx = ref offset in while !str_idx < String.length str && !what_idx < String.length what do if str.[!str_idx] = what.[!what_idx] then incr what_idx else what_idx := 0; incr str_idx done; if !what_idx <> String.length what then raise Not_found else !str_idx - !what_idx let sub_start str len = let str_len = String.length str in if len >= str_len then "" else String.sub str len (str_len - len) let sub_end ?(offset=0) str len = let str_len = String.length str in if len >= str_len then "" else String.sub str 0 (str_len - len) let starts_with ~what ?(offset=0) str = let what_idx = ref 0 in let str_idx = ref offset in let ok = ref true in while !ok && !str_idx < String.length str && !what_idx < String.length what do if str.[!str_idx] = what.[!what_idx] then incr what_idx else ok := false; incr str_idx done; !what_idx = String.length what let strip_starts_with ~what str = if starts_with ~what str then sub_start str (String.length what) else raise Not_found let ends_with ~what ?(offset=0) str = let what_idx = ref ((String.length what) - 1) in let str_idx = ref ((String.length str) - 1) in let ok = ref true in while !ok && offset <= !str_idx && 0 <= !what_idx do if str.[!str_idx] = what.[!what_idx] then decr what_idx else ok := false; decr str_idx done; !what_idx = -1 let strip_ends_with ~what str = if ends_with ~what str then sub_end str (String.length what) else raise Not_found let replace_chars f s = let buf = Buffer.create (String.length s) in String.iter (fun c -> Buffer.add_char buf (f c)) s; Buffer.contents buf let lowercase_ascii = replace_chars (fun c -> if (c >= 'A' && c <= 'Z') then Char.chr (Char.code c + 32) else c) let uncapitalize_ascii s = if s <> "" then (lowercase_ascii (String.sub s 0 1)) ^ (String.sub s 1 ((String.length s) - 1)) else s let uppercase_ascii = replace_chars (fun c -> if (c >= 'a' && c <= 'z') then Char.chr (Char.code c - 32) else c) let capitalize_ascii s = if s <> "" then (uppercase_ascii (String.sub s 0 1)) ^ (String.sub s 1 ((String.length s) - 1)) else s end module OASISUtils = struct (* # 22 "src/oasis/OASISUtils.ml" *) open OASISGettext module MapExt = struct module type S = sig include Map.S val add_list: 'a t -> (key * 'a) list -> 'a t val of_list: (key * 'a) list -> 'a t val to_list: 'a t -> (key * 'a) list end module Make (Ord: Map.OrderedType) = struct include Map.Make(Ord) let rec add_list t = function | (k, v) :: tl -> add_list (add k v t) tl | [] -> t let of_list lst = add_list empty lst let to_list t = fold (fun k v acc -> (k, v) :: acc) t [] end end module MapString = MapExt.Make(String) module SetExt = struct module type S = sig include Set.S val add_list: t -> elt list -> t val of_list: elt list -> t val to_list: t -> elt list end module Make (Ord: Set.OrderedType) = struct include Set.Make(Ord) let rec add_list t = function | e :: tl -> add_list (add e t) tl | [] -> t let of_list lst = add_list empty lst let to_list = elements end end module SetString = SetExt.Make(String) let compare_csl s1 s2 = String.compare (OASISString.lowercase_ascii s1) (OASISString.lowercase_ascii s2) module HashStringCsl = Hashtbl.Make (struct type t = string let equal s1 s2 = (compare_csl s1 s2) = 0 let hash s = Hashtbl.hash (OASISString.lowercase_ascii s) end) module SetStringCsl = SetExt.Make (struct type t = string let compare = compare_csl end) let varname_of_string ?(hyphen='_') s = if String.length s = 0 then begin invalid_arg "varname_of_string" end else begin let buf = OASISString.replace_chars (fun c -> if ('a' <= c && c <= 'z') || ('A' <= c && c <= 'Z') || ('0' <= c && c <= '9') then c else hyphen) s; in let buf = (* Start with a _ if digit *) if '0' <= s.[0] && s.[0] <= '9' then "_"^buf else buf in OASISString.lowercase_ascii buf end let varname_concat ?(hyphen='_') p s = let what = String.make 1 hyphen in let p = try OASISString.strip_ends_with ~what p with Not_found -> p in let s = try OASISString.strip_starts_with ~what s with Not_found -> s in p^what^s let is_varname str = str = varname_of_string str let failwithf fmt = Printf.ksprintf failwith fmt let rec file_location ?pos1 ?pos2 ?lexbuf () = match pos1, pos2, lexbuf with | Some p, None, _ | None, Some p, _ -> file_location ~pos1:p ~pos2:p ?lexbuf () | Some p1, Some p2, _ -> let open Lexing in let fn, lineno = p1.pos_fname, p1.pos_lnum in let c1 = p1.pos_cnum - p1.pos_bol in let c2 = c1 + (p2.pos_cnum - p1.pos_cnum) in Printf.sprintf (f_ "file %S, line %d, characters %d-%d") fn lineno c1 c2 | _, _, Some lexbuf -> file_location ~pos1:(Lexing.lexeme_start_p lexbuf) ~pos2:(Lexing.lexeme_end_p lexbuf) () | None, None, None -> s_ "" let failwithpf ?pos1 ?pos2 ?lexbuf fmt = let loc = file_location ?pos1 ?pos2 ?lexbuf () in Printf.ksprintf (fun s -> failwith (Printf.sprintf "%s: %s" loc s)) fmt end module OASISUnixPath = struct (* # 22 "src/oasis/OASISUnixPath.ml" *) type unix_filename = string type unix_dirname = string type host_filename = string type host_dirname = string let current_dir_name = "." let parent_dir_name = ".." let is_current_dir fn = fn = current_dir_name || fn = "" let concat f1 f2 = if is_current_dir f1 then f2 else let f1' = try OASISString.strip_ends_with ~what:"/" f1 with Not_found -> f1 in f1'^"/"^f2 let make = function | hd :: tl -> List.fold_left (fun f p -> concat f p) hd tl | [] -> invalid_arg "OASISUnixPath.make" let dirname f = try String.sub f 0 (String.rindex f '/') with Not_found -> current_dir_name let basename f = try let pos_start = (String.rindex f '/') + 1 in String.sub f pos_start ((String.length f) - pos_start) with Not_found -> f let chop_extension f = try let last_dot = String.rindex f '.' in let sub = String.sub f 0 last_dot in try let last_slash = String.rindex f '/' in if last_slash < last_dot then sub else f with Not_found -> sub with Not_found -> f let capitalize_file f = let dir = dirname f in let base = basename f in concat dir (OASISString.capitalize_ascii base) let uncapitalize_file f = let dir = dirname f in let base = basename f in concat dir (OASISString.uncapitalize_ascii base) end module OASISHostPath = struct (* # 22 "src/oasis/OASISHostPath.ml" *) open Filename open OASISGettext module Unix = OASISUnixPath let make = function | [] -> invalid_arg "OASISHostPath.make" | hd :: tl -> List.fold_left Filename.concat hd tl let of_unix ufn = match Sys.os_type with | "Unix" | "Cygwin" -> ufn | "Win32" -> make (List.map (fun p -> if p = Unix.current_dir_name then current_dir_name else if p = Unix.parent_dir_name then parent_dir_name else p) (OASISString.nsplit ufn '/')) | os_type -> OASISUtils.failwithf (f_ "Don't know the path format of os_type %S when translating unix \ filename. %S") os_type ufn end module OASISFileSystem = struct (* # 22 "src/oasis/OASISFileSystem.ml" *) (** File System functions @author Sylvain Le Gall *) type 'a filename = string class type closer = object method close: unit end class type reader = object inherit closer method input: Buffer.t -> int -> unit end class type writer = object inherit closer method output: Buffer.t -> unit end class type ['a] fs = object method string_of_filename: 'a filename -> string method open_out: ?mode:(open_flag list) -> ?perm:int -> 'a filename -> writer method open_in: ?mode:(open_flag list) -> ?perm:int -> 'a filename -> reader method file_exists: 'a filename -> bool method remove: 'a filename -> unit end module Mode = struct let default_in = [Open_rdonly] let default_out = [Open_wronly; Open_creat; Open_trunc] let text_in = Open_text :: default_in let text_out = Open_text :: default_out let binary_in = Open_binary :: default_in let binary_out = Open_binary :: default_out end let std_length = 4096 (* Standard buffer/read length. *) let binary_out = Mode.binary_out let binary_in = Mode.binary_in let of_unix_filename ufn = (ufn: 'a filename) let to_unix_filename fn = (fn: string) let defer_close o f = try let r = f o in o#close; r with e -> o#close; raise e let stream_of_reader rdr = let buf = Buffer.create std_length in let pos = ref 0 in let eof = ref false in let rec next idx = let bpos = idx - !pos in if !eof then begin None end else if bpos < Buffer.length buf then begin Some (Buffer.nth buf bpos) end else begin pos := !pos + Buffer.length buf; Buffer.clear buf; begin try rdr#input buf std_length; with End_of_file -> if Buffer.length buf = 0 then eof := true end; next idx end in Stream.from next let read_all buf rdr = try while true do rdr#input buf std_length done with End_of_file -> () class ['a] host_fs rootdir : ['a] fs = object (self) method private host_filename fn = Filename.concat rootdir fn method string_of_filename = self#host_filename method open_out ?(mode=Mode.text_out) ?(perm=0o666) fn = let chn = open_out_gen mode perm (self#host_filename fn) in object method close = close_out chn method output buf = Buffer.output_buffer chn buf end method open_in ?(mode=Mode.text_in) ?(perm=0o666) fn = (* TODO: use Buffer.add_channel when minimal version of OCaml will * be >= 4.03.0 (previous version was discarding last chars). *) let chn = open_in_gen mode perm (self#host_filename fn) in let strm = Stream.of_channel chn in object method close = close_in chn method input buf len = let read = ref 0 in try for _i = 0 to len do Buffer.add_char buf (Stream.next strm); incr read done with Stream.Failure -> if !read = 0 then raise End_of_file end method file_exists fn = Sys.file_exists (self#host_filename fn) method remove fn = Sys.remove (self#host_filename fn) end end module OASISContext = struct (* # 22 "src/oasis/OASISContext.ml" *) open OASISGettext type level = [ `Debug | `Info | `Warning | `Error] type source type source_filename = source OASISFileSystem.filename let in_srcdir ufn = OASISFileSystem.of_unix_filename ufn type t = { (* TODO: replace this by a proplist. *) quiet: bool; info: bool; debug: bool; ignore_plugins: bool; ignore_unknown_fields: bool; printf: level -> string -> unit; srcfs: source OASISFileSystem.fs; load_oasis_plugin: string -> bool; } let printf lvl str = let beg = match lvl with | `Error -> s_ "E: " | `Warning -> s_ "W: " | `Info -> s_ "I: " | `Debug -> s_ "D: " in prerr_endline (beg^str) let default = ref { quiet = false; info = false; debug = false; ignore_plugins = false; ignore_unknown_fields = false; printf = printf; srcfs = new OASISFileSystem.host_fs(Sys.getcwd ()); load_oasis_plugin = (fun _ -> false); } let quiet = {!default with quiet = true} let fspecs () = (* TODO: don't act on default. *) let ignore_plugins = ref false in ["-quiet", Arg.Unit (fun () -> default := {!default with quiet = true}), s_ " Run quietly"; "-info", Arg.Unit (fun () -> default := {!default with info = true}), s_ " Display information message"; "-debug", Arg.Unit (fun () -> default := {!default with debug = true}), s_ " Output debug message"; "-ignore-plugins", Arg.Set ignore_plugins, s_ " Ignore plugin's field."; "-C", Arg.String (fun str -> Sys.chdir str; default := {!default with srcfs = new OASISFileSystem.host_fs str}), s_ "dir Change directory before running (affects setup.{data,log})."], fun () -> {!default with ignore_plugins = !ignore_plugins} end module PropList = struct (* # 22 "src/oasis/PropList.ml" *) open OASISGettext type name = string exception Not_set of name * string option exception No_printer of name exception Unknown_field of name * name let () = Printexc.register_printer (function | Not_set (nm, Some rsn) -> Some (Printf.sprintf (f_ "Field '%s' is not set: %s") nm rsn) | Not_set (nm, None) -> Some (Printf.sprintf (f_ "Field '%s' is not set") nm) | No_printer nm -> Some (Printf.sprintf (f_ "No default printer for value %s") nm) | Unknown_field (nm, schm) -> Some (Printf.sprintf (f_ "Field %s is not defined in schema %s") nm schm) | _ -> None) module Data = struct type t = (name, unit -> unit) Hashtbl.t let create () = Hashtbl.create 13 let clear t = Hashtbl.clear t (* # 77 "src/oasis/PropList.ml" *) end module Schema = struct type ('ctxt, 'extra) value = { get: Data.t -> string; set: Data.t -> ?context:'ctxt -> string -> unit; help: (unit -> string) option; extra: 'extra; } type ('ctxt, 'extra) t = { name: name; fields: (name, ('ctxt, 'extra) value) Hashtbl.t; order: name Queue.t; name_norm: string -> string; } let create ?(case_insensitive=false) nm = { name = nm; fields = Hashtbl.create 13; order = Queue.create (); name_norm = (if case_insensitive then OASISString.lowercase_ascii else fun s -> s); } let add t nm set get extra help = let key = t.name_norm nm in if Hashtbl.mem t.fields key then failwith (Printf.sprintf (f_ "Field '%s' is already defined in schema '%s'") nm t.name); Hashtbl.add t.fields key { set = set; get = get; help = help; extra = extra; }; Queue.add nm t.order let mem t nm = Hashtbl.mem t.fields nm let find t nm = try Hashtbl.find t.fields (t.name_norm nm) with Not_found -> raise (Unknown_field (nm, t.name)) let get t data nm = (find t nm).get data let set t data nm ?context x = (find t nm).set data ?context x let fold f acc t = Queue.fold (fun acc k -> let v = find t k in f acc k v.extra v.help) acc t.order let iter f t = fold (fun () -> f) () t let name t = t.name end module Field = struct type ('ctxt, 'value, 'extra) t = { set: Data.t -> ?context:'ctxt -> 'value -> unit; get: Data.t -> 'value; sets: Data.t -> ?context:'ctxt -> string -> unit; gets: Data.t -> string; help: (unit -> string) option; extra: 'extra; } let new_id = let last_id = ref 0 in fun () -> incr last_id; !last_id let create ?schema ?name ?parse ?print ?default ?update ?help extra = (* Default value container *) let v = ref None in (* If name is not given, create unique one *) let nm = match name with | Some s -> s | None -> Printf.sprintf "_anon_%d" (new_id ()) in (* Last chance to get a value: the default *) let default () = match default with | Some d -> d | None -> raise (Not_set (nm, Some (s_ "no default value"))) in (* Get data *) let get data = (* Get value *) try (Hashtbl.find data nm) (); match !v with | Some x -> x | None -> default () with Not_found -> default () in (* Set data *) let set data ?context x = let x = match update with | Some f -> begin try f ?context (get data) x with Not_set _ -> x end | None -> x in Hashtbl.replace data nm (fun () -> v := Some x) in (* Parse string value, if possible *) let parse = match parse with | Some f -> f | None -> fun ?context s -> failwith (Printf.sprintf (f_ "Cannot parse field '%s' when setting value %S") nm s) in (* Set data, from string *) let sets data ?context s = set ?context data (parse ?context s) in (* Output value as string, if possible *) let print = match print with | Some f -> f | None -> fun _ -> raise (No_printer nm) in (* Get data, as a string *) let gets data = print (get data) in begin match schema with | Some t -> Schema.add t nm sets gets extra help | None -> () end; { set = set; get = get; sets = sets; gets = gets; help = help; extra = extra; } let fset data t ?context x = t.set data ?context x let fget data t = t.get data let fsets data t ?context s = t.sets data ?context s let fgets data t = t.gets data end module FieldRO = struct let create ?schema ?name ?parse ?print ?default ?update ?help extra = let fld = Field.create ?schema ?name ?parse ?print ?default ?update ?help extra in fun data -> Field.fget data fld end end module OASISMessage = struct (* # 22 "src/oasis/OASISMessage.ml" *) open OASISGettext open OASISContext let generic_message ~ctxt lvl fmt = let cond = if ctxt.quiet then false else match lvl with | `Debug -> ctxt.debug | `Info -> ctxt.info | _ -> true in Printf.ksprintf (fun str -> if cond then begin ctxt.printf lvl str end) fmt let debug ~ctxt fmt = generic_message ~ctxt `Debug fmt let info ~ctxt fmt = generic_message ~ctxt `Info fmt let warning ~ctxt fmt = generic_message ~ctxt `Warning fmt let error ~ctxt fmt = generic_message ~ctxt `Error fmt end module OASISVersion = struct (* # 22 "src/oasis/OASISVersion.ml" *) open OASISGettext type t = string type comparator = | VGreater of t | VGreaterEqual of t | VEqual of t | VLesser of t | VLesserEqual of t | VOr of comparator * comparator | VAnd of comparator * comparator (* Range of allowed characters *) let is_digit c = '0' <= c && c <= '9' let is_alpha c = ('a' <= c && c <= 'z') || ('A' <= c && c <= 'Z') let is_special = function | '.' | '+' | '-' | '~' -> true | _ -> false let rec version_compare v1 v2 = if v1 <> "" || v2 <> "" then begin (* Compare ascii string, using special meaning for version * related char *) let val_ascii c = if c = '~' then -1 else if is_digit c then 0 else if c = '\000' then 0 else if is_alpha c then Char.code c else (Char.code c) + 256 in let len1 = String.length v1 in let len2 = String.length v2 in let p = ref 0 in (** Compare ascii part *) let compare_vascii () = let cmp = ref 0 in while !cmp = 0 && !p < len1 && !p < len2 && not (is_digit v1.[!p] && is_digit v2.[!p]) do cmp := (val_ascii v1.[!p]) - (val_ascii v2.[!p]); incr p done; if !cmp = 0 && !p < len1 && !p = len2 then val_ascii v1.[!p] else if !cmp = 0 && !p = len1 && !p < len2 then - (val_ascii v2.[!p]) else !cmp in (** Compare digit part *) let compare_digit () = let extract_int v p = let start_p = !p in while !p < String.length v && is_digit v.[!p] do incr p done; let substr = String.sub v !p ((String.length v) - !p) in let res = match String.sub v start_p (!p - start_p) with | "" -> 0 | s -> int_of_string s in res, substr in let i1, tl1 = extract_int v1 (ref !p) in let i2, tl2 = extract_int v2 (ref !p) in i1 - i2, tl1, tl2 in match compare_vascii () with | 0 -> begin match compare_digit () with | 0, tl1, tl2 -> if tl1 <> "" && is_digit tl1.[0] then 1 else if tl2 <> "" && is_digit tl2.[0] then -1 else version_compare tl1 tl2 | n, _, _ -> n end | n -> n end else begin 0 end let version_of_string str = str let string_of_version t = t let chop t = try let pos = String.rindex t '.' in String.sub t 0 pos with Not_found -> t let rec comparator_apply v op = match op with | VGreater cv -> (version_compare v cv) > 0 | VGreaterEqual cv -> (version_compare v cv) >= 0 | VLesser cv -> (version_compare v cv) < 0 | VLesserEqual cv -> (version_compare v cv) <= 0 | VEqual cv -> (version_compare v cv) = 0 | VOr (op1, op2) -> (comparator_apply v op1) || (comparator_apply v op2) | VAnd (op1, op2) -> (comparator_apply v op1) && (comparator_apply v op2) let rec string_of_comparator = function | VGreater v -> "> "^(string_of_version v) | VEqual v -> "= "^(string_of_version v) | VLesser v -> "< "^(string_of_version v) | VGreaterEqual v -> ">= "^(string_of_version v) | VLesserEqual v -> "<= "^(string_of_version v) | VOr (c1, c2) -> (string_of_comparator c1)^" || "^(string_of_comparator c2) | VAnd (c1, c2) -> (string_of_comparator c1)^" && "^(string_of_comparator c2) let rec varname_of_comparator = let concat p v = OASISUtils.varname_concat p (OASISUtils.varname_of_string (string_of_version v)) in function | VGreater v -> concat "gt" v | VLesser v -> concat "lt" v | VEqual v -> concat "eq" v | VGreaterEqual v -> concat "ge" v | VLesserEqual v -> concat "le" v | VOr (c1, c2) -> (varname_of_comparator c1)^"_or_"^(varname_of_comparator c2) | VAnd (c1, c2) -> (varname_of_comparator c1)^"_and_"^(varname_of_comparator c2) end module OASISLicense = struct (* # 22 "src/oasis/OASISLicense.ml" *) (** License for _oasis fields @author Sylvain Le Gall *) type license = string type license_exception = string type license_version = | Version of OASISVersion.t | VersionOrLater of OASISVersion.t | NoVersion type license_dep_5_unit = { license: license; excption: license_exception option; version: license_version; } type license_dep_5 = | DEP5Unit of license_dep_5_unit | DEP5Or of license_dep_5 list | DEP5And of license_dep_5 list type t = | DEP5License of license_dep_5 | OtherLicense of string (* URL *) end module OASISExpr = struct (* # 22 "src/oasis/OASISExpr.ml" *) open OASISGettext open OASISUtils type test = string type flag = string type t = | EBool of bool | ENot of t | EAnd of t * t | EOr of t * t | EFlag of flag | ETest of test * string type 'a choices = (t * 'a) list let eval var_get t = let rec eval' = function | EBool b -> b | ENot e -> not (eval' e) | EAnd (e1, e2) -> (eval' e1) && (eval' e2) | EOr (e1, e2) -> (eval' e1) || (eval' e2) | EFlag nm -> let v = var_get nm in assert(v = "true" || v = "false"); (v = "true") | ETest (nm, vl) -> let v = var_get nm in (v = vl) in eval' t let choose ?printer ?name var_get lst = let rec choose_aux = function | (cond, vl) :: tl -> if eval var_get cond then vl else choose_aux tl | [] -> let str_lst = if lst = [] then s_ "" else String.concat (s_ ", ") (List.map (fun (cond, vl) -> match printer with | Some p -> p vl | None -> s_ "") lst) in match name with | Some nm -> failwith (Printf.sprintf (f_ "No result for the choice list '%s': %s") nm str_lst) | None -> failwith (Printf.sprintf (f_ "No result for a choice list: %s") str_lst) in choose_aux (List.rev lst) end module OASISText = struct (* # 22 "src/oasis/OASISText.ml" *) type elt = | Para of string | Verbatim of string | BlankLine type t = elt list end module OASISSourcePatterns = struct (* # 22 "src/oasis/OASISSourcePatterns.ml" *) open OASISUtils open OASISGettext module Templater = struct (* TODO: use this module in BaseEnv.var_expand and BaseFileAB, at least. *) type t = { atoms: atom list; origin: string } and atom = | Text of string | Expr of expr and expr = | Ident of string | String of string | Call of string * expr type env = { variables: string MapString.t; functions: (string -> string) MapString.t; } let eval env t = let rec eval_expr env = function | String str -> str | Ident nm -> begin try MapString.find nm env.variables with Not_found -> (* TODO: add error location within the string. *) failwithf (f_ "Unable to find variable %S in source pattern %S") nm t.origin end | Call (fn, expr) -> begin try (MapString.find fn env.functions) (eval_expr env expr) with Not_found -> (* TODO: add error location within the string. *) failwithf (f_ "Unable to find function %S in source pattern %S") fn t.origin end in String.concat "" (List.map (function | Text str -> str | Expr expr -> eval_expr env expr) t.atoms) let parse env s = let lxr = Genlex.make_lexer [] in let parse_expr s = let st = lxr (Stream.of_string s) in match Stream.npeek 3 st with | [Genlex.Ident fn; Genlex.Ident nm] -> Call(fn, Ident nm) | [Genlex.Ident fn; Genlex.String str] -> Call(fn, String str) | [Genlex.String str] -> String str | [Genlex.Ident nm] -> Ident nm (* TODO: add error location within the string. *) | _ -> failwithf (f_ "Unable to parse expression %S") s in let parse s = let lst_exprs = ref [] in let ss = let buff = Buffer.create (String.length s) in Buffer.add_substitute buff (fun s -> lst_exprs := (parse_expr s) :: !lst_exprs; "\000") s; Buffer.contents buff in let rec join = function | hd1 :: tl1, hd2 :: tl2 -> Text hd1 :: Expr hd2 :: join (tl1, tl2) | [], tl -> List.map (fun e -> Expr e) tl | tl, [] -> List.map (fun e -> Text e) tl in join (OASISString.nsplit ss '\000', List.rev (!lst_exprs)) in let t = {atoms = parse s; origin = s} in (* We rely on a simple evaluation for checking variables/functions. It works because there is no if/loop statement. *) let _s : string = eval env t in t (* # 144 "src/oasis/OASISSourcePatterns.ml" *) end type t = Templater.t let env ~modul () = { Templater. variables = MapString.of_list ["module", modul]; functions = MapString.of_list [ "capitalize_file", OASISUnixPath.capitalize_file; "uncapitalize_file", OASISUnixPath.uncapitalize_file; ]; } let all_possible_files lst ~path ~modul = let eval = Templater.eval (env ~modul ()) in List.fold_left (fun acc pat -> OASISUnixPath.concat path (eval pat) :: acc) [] lst let to_string t = t.Templater.origin end module OASISTypes = struct (* # 22 "src/oasis/OASISTypes.ml" *) type name = string type package_name = string type url = string type unix_dirname = string type unix_filename = string (* TODO: replace everywhere. *) type host_dirname = string (* TODO: replace everywhere. *) type host_filename = string (* TODO: replace everywhere. *) type prog = string type arg = string type args = string list type command_line = (prog * arg list) type findlib_name = string type findlib_full = string type compiled_object = | Byte | Native | Best type dependency = | FindlibPackage of findlib_full * OASISVersion.comparator option | InternalLibrary of name type tool = | ExternalTool of name | InternalExecutable of name type vcs = | Darcs | Git | Svn | Cvs | Hg | Bzr | Arch | Monotone | OtherVCS of url type plugin_kind = [ `Configure | `Build | `Doc | `Test | `Install | `Extra ] type plugin_data_purpose = [ `Configure | `Build | `Install | `Clean | `Distclean | `Install | `Uninstall | `Test | `Doc | `Extra | `Other of string ] type 'a plugin = 'a * name * OASISVersion.t option type all_plugin = plugin_kind plugin type plugin_data = (all_plugin * plugin_data_purpose * (unit -> unit)) list type 'a conditional = 'a OASISExpr.choices type custom = { pre_command: (command_line option) conditional; post_command: (command_line option) conditional; } type common_section = { cs_name: name; cs_data: PropList.Data.t; cs_plugin_data: plugin_data; } type build_section = { bs_build: bool conditional; bs_install: bool conditional; bs_path: unix_dirname; bs_compiled_object: compiled_object; bs_build_depends: dependency list; bs_build_tools: tool list; bs_interface_patterns: OASISSourcePatterns.t list; bs_implementation_patterns: OASISSourcePatterns.t list; bs_c_sources: unix_filename list; bs_data_files: (unix_filename * unix_filename option) list; bs_findlib_extra_files: unix_filename list; bs_ccopt: args conditional; bs_cclib: args conditional; bs_dlllib: args conditional; bs_dllpath: args conditional; bs_byteopt: args conditional; bs_nativeopt: args conditional; } type library = { lib_modules: string list; lib_pack: bool; lib_internal_modules: string list; lib_findlib_parent: findlib_name option; lib_findlib_name: findlib_name option; lib_findlib_directory: unix_dirname option; lib_findlib_containers: findlib_name list; } type object_ = { obj_modules: string list; obj_findlib_fullname: findlib_name list option; obj_findlib_directory: unix_dirname option; } type executable = { exec_custom: bool; exec_main_is: unix_filename; } type flag = { flag_description: string option; flag_default: bool conditional; } type source_repository = { src_repo_type: vcs; src_repo_location: url; src_repo_browser: url option; src_repo_module: string option; src_repo_branch: string option; src_repo_tag: string option; src_repo_subdir: unix_filename option; } type test = { test_type: [`Test] plugin; test_command: command_line conditional; test_custom: custom; test_working_directory: unix_filename option; test_run: bool conditional; test_tools: tool list; } type doc_format = | HTML of unix_filename (* TODO: source filename. *) | DocText | PDF | PostScript | Info of unix_filename (* TODO: source filename. *) | DVI | OtherDoc type doc = { doc_type: [`Doc] plugin; doc_custom: custom; doc_build: bool conditional; doc_install: bool conditional; doc_install_dir: unix_filename; (* TODO: dest filename ?. *) doc_title: string; doc_authors: string list; doc_abstract: string option; doc_format: doc_format; (* TODO: src filename. *) doc_data_files: (unix_filename * unix_filename option) list; doc_build_tools: tool list; } type section = | Library of common_section * build_section * library | Object of common_section * build_section * object_ | Executable of common_section * build_section * executable | Flag of common_section * flag | SrcRepo of common_section * source_repository | Test of common_section * test | Doc of common_section * doc type section_kind = [ `Library | `Object | `Executable | `Flag | `SrcRepo | `Test | `Doc ] type package = { oasis_version: OASISVersion.t; ocaml_version: OASISVersion.comparator option; findlib_version: OASISVersion.comparator option; alpha_features: string list; beta_features: string list; name: package_name; version: OASISVersion.t; license: OASISLicense.t; license_file: unix_filename option; (* TODO: source filename. *) copyrights: string list; maintainers: string list; authors: string list; homepage: url option; bugreports: url option; synopsis: string; description: OASISText.t option; tags: string list; categories: url list; conf_type: [`Configure] plugin; conf_custom: custom; build_type: [`Build] plugin; build_custom: custom; install_type: [`Install] plugin; install_custom: custom; uninstall_custom: custom; clean_custom: custom; distclean_custom: custom; files_ab: unix_filename list; (* TODO: source filename. *) sections: section list; plugins: [`Extra] plugin list; disable_oasis_section: unix_filename list; (* TODO: source filename. *) schema_data: PropList.Data.t; plugin_data: plugin_data; } end module OASISFeatures = struct (* # 22 "src/oasis/OASISFeatures.ml" *) open OASISTypes open OASISUtils open OASISGettext open OASISVersion module MapPlugin = Map.Make (struct type t = plugin_kind * name let compare = Pervasives.compare end) module Data = struct type t = { oasis_version: OASISVersion.t; plugin_versions: OASISVersion.t option MapPlugin.t; alpha_features: string list; beta_features: string list; } let create oasis_version alpha_features beta_features = { oasis_version = oasis_version; plugin_versions = MapPlugin.empty; alpha_features = alpha_features; beta_features = beta_features } let of_package pkg = create pkg.OASISTypes.oasis_version pkg.OASISTypes.alpha_features pkg.OASISTypes.beta_features let add_plugin (plugin_kind, plugin_name, plugin_version) t = {t with plugin_versions = MapPlugin.add (plugin_kind, plugin_name) plugin_version t.plugin_versions} let plugin_version plugin_kind plugin_name t = MapPlugin.find (plugin_kind, plugin_name) t.plugin_versions let to_string t = Printf.sprintf "oasis_version: %s; alpha_features: %s; beta_features: %s; \ plugins_version: %s" (OASISVersion.string_of_version (t:t).oasis_version) (String.concat ", " t.alpha_features) (String.concat ", " t.beta_features) (String.concat ", " (MapPlugin.fold (fun (_, plg) ver_opt acc -> (plg^ (match ver_opt with | Some v -> " "^(OASISVersion.string_of_version v) | None -> "")) :: acc) t.plugin_versions [])) end type origin = | Field of string * string | Section of string | NoOrigin type stage = Alpha | Beta let string_of_stage = function | Alpha -> "alpha" | Beta -> "beta" let field_of_stage = function | Alpha -> "AlphaFeatures" | Beta -> "BetaFeatures" type publication = InDev of stage | SinceVersion of OASISVersion.t type t = { name: string; plugin: all_plugin option; publication: publication; description: unit -> string; } (* TODO: mutex protect this. *) let all_features = Hashtbl.create 13 let since_version ver_str = SinceVersion (version_of_string ver_str) let alpha = InDev Alpha let beta = InDev Beta let to_string t = Printf.sprintf "feature: %s; plugin: %s; publication: %s" (t:t).name (match t.plugin with | None -> "" | Some (_, nm, _) -> nm) (match t.publication with | InDev stage -> string_of_stage stage | SinceVersion ver -> ">= "^(OASISVersion.string_of_version ver)) let data_check t data origin = let no_message = "no message" in let check_feature features stage = let has_feature = List.mem (t:t).name features in if not has_feature then match (origin:origin) with | Field (fld, where) -> Some (Printf.sprintf (f_ "Field %s in %s is only available when feature %s \ is in field %s.") fld where t.name (field_of_stage stage)) | Section sct -> Some (Printf.sprintf (f_ "Section %s is only available when features %s \ is in field %s.") sct t.name (field_of_stage stage)) | NoOrigin -> Some no_message else None in let version_is_good ~min_version version fmt = let version_is_good = OASISVersion.comparator_apply version (OASISVersion.VGreaterEqual min_version) in Printf.ksprintf (fun str -> if version_is_good then None else Some str) fmt in match origin, t.plugin, t.publication with | _, _, InDev Alpha -> check_feature data.Data.alpha_features Alpha | _, _, InDev Beta -> check_feature data.Data.beta_features Beta | Field(fld, where), None, SinceVersion min_version -> version_is_good ~min_version data.Data.oasis_version (f_ "Field %s in %s is only valid since OASIS v%s, update \ OASISFormat field from '%s' to '%s' after checking \ OASIS changelog.") fld where (string_of_version min_version) (string_of_version data.Data.oasis_version) (string_of_version min_version) | Field(fld, where), Some(plugin_knd, plugin_name, _), SinceVersion min_version -> begin try let plugin_version_current = try match Data.plugin_version plugin_knd plugin_name data with | Some ver -> ver | None -> failwithf (f_ "Field %s in %s is only valid for the OASIS \ plugin %s since v%s, but no plugin version is \ defined in the _oasis file, change '%s' to \ '%s (%s)' in your _oasis file.") fld where plugin_name (string_of_version min_version) plugin_name plugin_name (string_of_version min_version) with Not_found -> failwithf (f_ "Field %s in %s is only valid when the OASIS plugin %s \ is defined.") fld where plugin_name in version_is_good ~min_version plugin_version_current (f_ "Field %s in %s is only valid for the OASIS plugin %s \ since v%s, update your plugin from '%s (%s)' to \ '%s (%s)' after checking the plugin's changelog.") fld where plugin_name (string_of_version min_version) plugin_name (string_of_version plugin_version_current) plugin_name (string_of_version min_version) with Failure msg -> Some msg end | Section sct, None, SinceVersion min_version -> version_is_good ~min_version data.Data.oasis_version (f_ "Section %s is only valid for since OASIS v%s, update \ OASISFormat field from '%s' to '%s' after checking OASIS \ changelog.") sct (string_of_version min_version) (string_of_version data.Data.oasis_version) (string_of_version min_version) | Section sct, Some(plugin_knd, plugin_name, _), SinceVersion min_version -> begin try let plugin_version_current = try match Data.plugin_version plugin_knd plugin_name data with | Some ver -> ver | None -> failwithf (f_ "Section %s is only valid for the OASIS \ plugin %s since v%s, but no plugin version is \ defined in the _oasis file, change '%s' to \ '%s (%s)' in your _oasis file.") sct plugin_name (string_of_version min_version) plugin_name plugin_name (string_of_version min_version) with Not_found -> failwithf (f_ "Section %s is only valid when the OASIS plugin %s \ is defined.") sct plugin_name in version_is_good ~min_version plugin_version_current (f_ "Section %s is only valid for the OASIS plugin %s \ since v%s, update your plugin from '%s (%s)' to \ '%s (%s)' after checking the plugin's changelog.") sct plugin_name (string_of_version min_version) plugin_name (string_of_version plugin_version_current) plugin_name (string_of_version min_version) with Failure msg -> Some msg end | NoOrigin, None, SinceVersion min_version -> version_is_good ~min_version data.Data.oasis_version "%s" no_message | NoOrigin, Some(plugin_knd, plugin_name, _), SinceVersion min_version -> begin try let plugin_version_current = match Data.plugin_version plugin_knd plugin_name data with | Some ver -> ver | None -> raise Not_found in version_is_good ~min_version plugin_version_current "%s" no_message with Not_found -> Some no_message end let data_assert t data origin = match data_check t data origin with | None -> () | Some str -> failwith str let data_test t data = match data_check t data NoOrigin with | None -> true | Some _ -> false let package_test t pkg = data_test t (Data.of_package pkg) let create ?plugin name publication description = let () = if Hashtbl.mem all_features name then failwithf "Feature '%s' is already declared." name in let t = { name = name; plugin = plugin; publication = publication; description = description; } in Hashtbl.add all_features name t; t let get_stage name = try (Hashtbl.find all_features name).publication with Not_found -> failwithf (f_ "Feature %s doesn't exist.") name let list () = Hashtbl.fold (fun _ v acc -> v :: acc) all_features [] (* * Real flags. *) let features = create "features_fields" (since_version "0.4") (fun () -> s_ "Enable to experiment not yet official features.") let flag_docs = create "flag_docs" (since_version "0.3") (fun () -> s_ "Make building docs require '-docs' flag at configure.") let flag_tests = create "flag_tests" (since_version "0.3") (fun () -> s_ "Make running tests require '-tests' flag at configure.") let pack = create "pack" (since_version "0.3") (fun () -> s_ "Allow to create packed library.") let section_object = create "section_object" beta (fun () -> s_ "Implement an object section.") let dynrun_for_release = create "dynrun_for_release" alpha (fun () -> s_ "Make '-setup-update dynamic' suitable for releasing project.") let compiled_setup_ml = create "compiled_setup_ml" alpha (fun () -> s_ "Compile the setup.ml and speed-up actions done with it.") let disable_oasis_section = create "disable_oasis_section" alpha (fun () -> s_ "Allow the OASIS section comments and digests to be omitted in \ generated files.") let no_automatic_syntax = create "no_automatic_syntax" alpha (fun () -> s_ "Disable the automatic inclusion of -syntax camlp4o for packages \ that matches the internal heuristic (if a dependency ends with \ a .syntax or is a well known syntax).") let findlib_directory = create "findlib_directory" beta (fun () -> s_ "Allow to install findlib libraries in sub-directories of the target \ findlib directory.") let findlib_extra_files = create "findlib_extra_files" beta (fun () -> s_ "Allow to install extra files for findlib libraries.") let source_patterns = create "source_patterns" alpha (fun () -> s_ "Customize mapping between module name and source file.") end module OASISSection = struct (* # 22 "src/oasis/OASISSection.ml" *) open OASISTypes let section_kind_common = function | Library (cs, _, _) -> `Library, cs | Object (cs, _, _) -> `Object, cs | Executable (cs, _, _) -> `Executable, cs | Flag (cs, _) -> `Flag, cs | SrcRepo (cs, _) -> `SrcRepo, cs | Test (cs, _) -> `Test, cs | Doc (cs, _) -> `Doc, cs let section_common sct = snd (section_kind_common sct) let section_common_set cs = function | Library (_, bs, lib) -> Library (cs, bs, lib) | Object (_, bs, obj) -> Object (cs, bs, obj) | Executable (_, bs, exec) -> Executable (cs, bs, exec) | Flag (_, flg) -> Flag (cs, flg) | SrcRepo (_, src_repo) -> SrcRepo (cs, src_repo) | Test (_, tst) -> Test (cs, tst) | Doc (_, doc) -> Doc (cs, doc) (** Key used to identify section *) let section_id sct = let k, cs = section_kind_common sct in k, cs.cs_name let string_of_section_kind = function | `Library -> "library" | `Object -> "object" | `Executable -> "executable" | `Flag -> "flag" | `SrcRepo -> "src repository" | `Test -> "test" | `Doc -> "doc" let string_of_section sct = let k, nm = section_id sct in (string_of_section_kind k)^" "^nm let section_find id scts = List.find (fun sct -> id = section_id sct) scts module CSection = struct type t = section let id = section_id let compare t1 t2 = compare (id t1) (id t2) let equal t1 t2 = (id t1) = (id t2) let hash t = Hashtbl.hash (id t) end module MapSection = Map.Make(CSection) module SetSection = Set.Make(CSection) end module OASISBuildSection = struct (* # 22 "src/oasis/OASISBuildSection.ml" *) open OASISTypes (* Look for a module file, considering capitalization or not. *) let find_module source_file_exists bs modul = let possible_lst = OASISSourcePatterns.all_possible_files (bs.bs_interface_patterns @ bs.bs_implementation_patterns) ~path:bs.bs_path ~modul in match List.filter source_file_exists possible_lst with | (fn :: _) as fn_lst -> `Sources (OASISUnixPath.chop_extension fn, fn_lst) | [] -> let open OASISUtils in let _, rev_lst = List.fold_left (fun (set, acc) fn -> let base_fn = OASISUnixPath.chop_extension fn in if SetString.mem base_fn set then set, acc else SetString.add base_fn set, base_fn :: acc) (SetString.empty, []) possible_lst in `No_sources (List.rev rev_lst) end module OASISExecutable = struct (* # 22 "src/oasis/OASISExecutable.ml" *) open OASISTypes let unix_exec_is (cs, bs, exec) is_native ext_dll suffix_program = let dir = OASISUnixPath.concat bs.bs_path (OASISUnixPath.dirname exec.exec_main_is) in let is_native_exec = match bs.bs_compiled_object with | Native -> true | Best -> is_native () | Byte -> false in OASISUnixPath.concat dir (cs.cs_name^(suffix_program ())), if not is_native_exec && not exec.exec_custom && bs.bs_c_sources <> [] then Some (dir^"/dll"^cs.cs_name^"_stubs"^(ext_dll ())) else None end module OASISLibrary = struct (* # 22 "src/oasis/OASISLibrary.ml" *) open OASISTypes open OASISGettext let find_module ~ctxt source_file_exists cs bs modul = match OASISBuildSection.find_module source_file_exists bs modul with | `Sources _ as res -> res | `No_sources _ as res -> OASISMessage.warning ~ctxt (f_ "Cannot find source file matching module '%s' in library %s.") modul cs.cs_name; OASISMessage.warning ~ctxt (f_ "Use InterfacePatterns or ImplementationPatterns to define \ this file with feature %S.") (OASISFeatures.source_patterns.OASISFeatures.name); res let source_unix_files ~ctxt (cs, bs, lib) source_file_exists = List.fold_left (fun acc modul -> match find_module ~ctxt source_file_exists cs bs modul with | `Sources (base_fn, lst) -> (base_fn, lst) :: acc | `No_sources _ -> acc) [] (lib.lib_modules @ lib.lib_internal_modules) let generated_unix_files ~ctxt ~is_native ~has_native_dynlink ~ext_lib ~ext_dll ~source_file_exists (cs, bs, lib) = let find_modules lst ext = let find_module modul = match find_module ~ctxt source_file_exists cs bs modul with | `Sources (_, [fn]) when ext <> "cmi" && Filename.check_suffix fn ".mli" -> None (* No implementation files for pure interface. *) | `Sources (base_fn, _) -> Some [base_fn] | `No_sources lst -> Some lst in List.fold_left (fun acc nm -> match find_module nm with | None -> acc | Some base_fns -> List.map (fun base_fn -> base_fn ^"."^ext) base_fns :: acc) [] lst in (* The .cmx that be compiled along *) let cmxs = let should_be_built = match bs.bs_compiled_object with | Native -> true | Best -> is_native | Byte -> false in if should_be_built then if lib.lib_pack then find_modules [cs.cs_name] "cmx" else find_modules (lib.lib_modules @ lib.lib_internal_modules) "cmx" else [] in let acc_nopath = [] in (* The headers and annot/cmt files that should be compiled along *) let headers = let sufx = if lib.lib_pack then [".cmti"; ".cmt"; ".annot"] else [".cmi"; ".cmti"; ".cmt"; ".annot"] in List.map (List.fold_left (fun accu s -> let dot = String.rindex s '.' in let base = String.sub s 0 dot in List.map ((^) base) sufx @ accu) []) (find_modules lib.lib_modules "cmi") in (* Compute what libraries should be built *) let acc_nopath = (* Add the packed header file if required *) let add_pack_header acc = if lib.lib_pack then [cs.cs_name^".cmi"; cs.cs_name^".cmti"; cs.cs_name^".cmt"] :: acc else acc in let byte acc = add_pack_header ([cs.cs_name^".cma"] :: acc) in let native acc = let acc = add_pack_header (if has_native_dynlink then [cs.cs_name^".cmxs"] :: acc else acc) in [cs.cs_name^".cmxa"] :: [cs.cs_name^ext_lib] :: acc in match bs.bs_compiled_object with | Native -> byte (native acc_nopath) | Best when is_native -> byte (native acc_nopath) | Byte | Best -> byte acc_nopath in (* Add C library to be built *) let acc_nopath = if bs.bs_c_sources <> [] then begin ["lib"^cs.cs_name^"_stubs"^ext_lib] :: if has_native_dynlink then ["dll"^cs.cs_name^"_stubs"^ext_dll] :: acc_nopath else acc_nopath end else begin acc_nopath end in (* All the files generated *) List.rev_append (List.rev_map (List.rev_map (OASISUnixPath.concat bs.bs_path)) acc_nopath) (headers @ cmxs) end module OASISObject = struct (* # 22 "src/oasis/OASISObject.ml" *) open OASISTypes open OASISGettext let find_module ~ctxt source_file_exists cs bs modul = match OASISBuildSection.find_module source_file_exists bs modul with | `Sources _ as res -> res | `No_sources _ as res -> OASISMessage.warning ~ctxt (f_ "Cannot find source file matching module '%s' in object %s.") modul cs.cs_name; OASISMessage.warning ~ctxt (f_ "Use InterfacePatterns or ImplementationPatterns to define \ this file with feature %S.") (OASISFeatures.source_patterns.OASISFeatures.name); res let source_unix_files ~ctxt (cs, bs, obj) source_file_exists = List.fold_left (fun acc modul -> match find_module ~ctxt source_file_exists cs bs modul with | `Sources (base_fn, lst) -> (base_fn, lst) :: acc | `No_sources _ -> acc) [] obj.obj_modules let generated_unix_files ~ctxt ~is_native ~source_file_exists (cs, bs, obj) = let find_module ext modul = match find_module ~ctxt source_file_exists cs bs modul with | `Sources (base_fn, _) -> [base_fn ^ ext] | `No_sources lst -> lst in let header, byte, native, c_object, f = match obj.obj_modules with | [ m ] -> (find_module ".cmi" m, find_module ".cmo" m, find_module ".cmx" m, find_module ".o" m, fun x -> x) | _ -> ([cs.cs_name ^ ".cmi"], [cs.cs_name ^ ".cmo"], [cs.cs_name ^ ".cmx"], [cs.cs_name ^ ".o"], OASISUnixPath.concat bs.bs_path) in List.map (List.map f) ( match bs.bs_compiled_object with | Native -> native :: c_object :: byte :: header :: [] | Best when is_native -> native :: c_object :: byte :: header :: [] | Byte | Best -> byte :: header :: []) end module OASISFindlib = struct (* # 22 "src/oasis/OASISFindlib.ml" *) open OASISTypes open OASISUtils open OASISGettext type library_name = name type findlib_part_name = name type 'a map_of_findlib_part_name = 'a OASISUtils.MapString.t exception InternalLibraryNotFound of library_name exception FindlibPackageNotFound of findlib_name type group_t = | Container of findlib_name * group_t list | Package of (findlib_name * common_section * build_section * [`Library of library | `Object of object_] * unix_dirname option * group_t list) type data = common_section * build_section * [`Library of library | `Object of object_] type tree = | Node of (data option) * (tree MapString.t) | Leaf of data let findlib_mapping pkg = (* Map from library name to either full findlib name or parts + parent. *) let fndlb_parts_of_lib_name = let fndlb_parts cs lib = let name = match lib.lib_findlib_name with | Some nm -> nm | None -> cs.cs_name in let name = String.concat "." (lib.lib_findlib_containers @ [name]) in name in List.fold_left (fun mp -> function | Library (cs, _, lib) -> begin let lib_name = cs.cs_name in let fndlb_parts = fndlb_parts cs lib in if MapString.mem lib_name mp then failwithf (f_ "The library name '%s' is used more than once.") lib_name; match lib.lib_findlib_parent with | Some lib_name_parent -> MapString.add lib_name (`Unsolved (lib_name_parent, fndlb_parts)) mp | None -> MapString.add lib_name (`Solved fndlb_parts) mp end | Object (cs, _, obj) -> begin let obj_name = cs.cs_name in if MapString.mem obj_name mp then failwithf (f_ "The object name '%s' is used more than once.") obj_name; let findlib_full_name = match obj.obj_findlib_fullname with | Some ns -> String.concat "." ns | None -> obj_name in MapString.add obj_name (`Solved findlib_full_name) mp end | Executable _ | Test _ | Flag _ | SrcRepo _ | Doc _ -> mp) MapString.empty pkg.sections in (* Solve the above graph to be only library name to full findlib name. *) let fndlb_name_of_lib_name = let rec solve visited mp lib_name lib_name_child = if SetString.mem lib_name visited then failwithf (f_ "Library '%s' is involved in a cycle \ with regard to findlib naming.") lib_name; let visited = SetString.add lib_name visited in try match MapString.find lib_name mp with | `Solved fndlb_nm -> fndlb_nm, mp | `Unsolved (lib_nm_parent, post_fndlb_nm) -> let pre_fndlb_nm, mp = solve visited mp lib_nm_parent lib_name in let fndlb_nm = pre_fndlb_nm^"."^post_fndlb_nm in fndlb_nm, MapString.add lib_name (`Solved fndlb_nm) mp with Not_found -> failwithf (f_ "Library '%s', which is defined as the findlib parent of \ library '%s', doesn't exist.") lib_name lib_name_child in let mp = MapString.fold (fun lib_name status mp -> match status with | `Solved _ -> (* Solved initialy, no need to go further *) mp | `Unsolved _ -> let _, mp = solve SetString.empty mp lib_name "" in mp) fndlb_parts_of_lib_name fndlb_parts_of_lib_name in MapString.map (function | `Solved fndlb_nm -> fndlb_nm | `Unsolved _ -> assert false) mp in (* Convert an internal library name to a findlib name. *) let findlib_name_of_library_name lib_nm = try MapString.find lib_nm fndlb_name_of_lib_name with Not_found -> raise (InternalLibraryNotFound lib_nm) in (* Add a library to the tree. *) let add sct mp = let fndlb_fullname = let cs, _, _ = sct in let lib_name = cs.cs_name in findlib_name_of_library_name lib_name in let rec add_children nm_lst (children: tree MapString.t) = match nm_lst with | (hd :: tl) -> begin let node = try add_node tl (MapString.find hd children) with Not_found -> (* New node *) new_node tl in MapString.add hd node children end | [] -> (* Should not have a nameless library. *) assert false and add_node tl node = if tl = [] then begin match node with | Node (None, children) -> Node (Some sct, children) | Leaf (cs', _, _) | Node (Some (cs', _, _), _) -> (* TODO: allow to merge Package, i.e. * archive(byte) = "foo.cma foo_init.cmo" *) let cs, _, _ = sct in failwithf (f_ "Library '%s' and '%s' have the same findlib name '%s'") cs.cs_name cs'.cs_name fndlb_fullname end else begin match node with | Leaf data -> Node (Some data, add_children tl MapString.empty) | Node (data_opt, children) -> Node (data_opt, add_children tl children) end and new_node = function | [] -> Leaf sct | hd :: tl -> Node (None, MapString.add hd (new_node tl) MapString.empty) in add_children (OASISString.nsplit fndlb_fullname '.') mp in let unix_directory dn lib = let directory = match lib with | `Library lib -> lib.lib_findlib_directory | `Object obj -> obj.obj_findlib_directory in match dn, directory with | None, None -> None | None, Some dn | Some dn, None -> Some dn | Some dn1, Some dn2 -> Some (OASISUnixPath.concat dn1 dn2) in let rec group_of_tree dn mp = MapString.fold (fun nm node acc -> let cur = match node with | Node (Some (cs, bs, lib), children) -> let current_dn = unix_directory dn lib in Package (nm, cs, bs, lib, current_dn, group_of_tree current_dn children) | Node (None, children) -> Container (nm, group_of_tree dn children) | Leaf (cs, bs, lib) -> let current_dn = unix_directory dn lib in Package (nm, cs, bs, lib, current_dn, []) in cur :: acc) mp [] in let group_mp = List.fold_left (fun mp -> function | Library (cs, bs, lib) -> add (cs, bs, `Library lib) mp | Object (cs, bs, obj) -> add (cs, bs, `Object obj) mp | _ -> mp) MapString.empty pkg.sections in let groups = group_of_tree None group_mp in let library_name_of_findlib_name = lazy begin (* Revert findlib_name_of_library_name. *) MapString.fold (fun k v mp -> MapString.add v k mp) fndlb_name_of_lib_name MapString.empty end in let library_name_of_findlib_name fndlb_nm = try MapString.find fndlb_nm (Lazy.force library_name_of_findlib_name) with Not_found -> raise (FindlibPackageNotFound fndlb_nm) in groups, findlib_name_of_library_name, library_name_of_findlib_name let findlib_of_group = function | Container (fndlb_nm, _) | Package (fndlb_nm, _, _, _, _, _) -> fndlb_nm let root_of_group grp = let rec root_lib_aux = (* We do a DFS in the group. *) function | Container (_, children) -> List.fold_left (fun res grp -> if res = None then root_lib_aux grp else res) None children | Package (_, cs, bs, lib, _, _) -> Some (cs, bs, lib) in match root_lib_aux grp with | Some res -> res | None -> failwithf (f_ "Unable to determine root library of findlib library '%s'") (findlib_of_group grp) end module OASISFlag = struct (* # 22 "src/oasis/OASISFlag.ml" *) end module OASISPackage = struct (* # 22 "src/oasis/OASISPackage.ml" *) end module OASISSourceRepository = struct (* # 22 "src/oasis/OASISSourceRepository.ml" *) end module OASISTest = struct (* # 22 "src/oasis/OASISTest.ml" *) end module OASISDocument = struct (* # 22 "src/oasis/OASISDocument.ml" *) end module OASISExec = struct (* # 22 "src/oasis/OASISExec.ml" *) open OASISGettext open OASISUtils open OASISMessage (* TODO: I don't like this quote, it is there because $(rm) foo expands to * 'rm -f' foo... *) let run ~ctxt ?f_exit_code ?(quote=true) cmd args = let cmd = if quote then if Sys.os_type = "Win32" then if String.contains cmd ' ' then (* Double the 1st double quote... win32... sigh *) "\""^(Filename.quote cmd) else cmd else Filename.quote cmd else cmd in let cmdline = String.concat " " (cmd :: args) in info ~ctxt (f_ "Running command '%s'") cmdline; match f_exit_code, Sys.command cmdline with | None, 0 -> () | None, i -> failwithf (f_ "Command '%s' terminated with error code %d") cmdline i | Some f, i -> f i let run_read_output ~ctxt ?f_exit_code cmd args = let fn = Filename.temp_file "oasis-" ".txt" in try begin let () = run ~ctxt ?f_exit_code cmd (args @ [">"; Filename.quote fn]) in let chn = open_in fn in let routput = ref [] in begin try while true do routput := (input_line chn) :: !routput done with End_of_file -> () end; close_in chn; Sys.remove fn; List.rev !routput end with e -> (try Sys.remove fn with _ -> ()); raise e let run_read_one_line ~ctxt ?f_exit_code cmd args = match run_read_output ~ctxt ?f_exit_code cmd args with | [fst] -> fst | lst -> failwithf (f_ "Command return unexpected output %S") (String.concat "\n" lst) end module OASISFileUtil = struct (* # 22 "src/oasis/OASISFileUtil.ml" *) open OASISGettext let file_exists_case fn = let dirname = Filename.dirname fn in let basename = Filename.basename fn in if Sys.file_exists dirname then if basename = Filename.current_dir_name then true else List.mem basename (Array.to_list (Sys.readdir dirname)) else false let find_file ?(case_sensitive=true) paths exts = (* Cardinal product of two list *) let ( * ) lst1 lst2 = List.flatten (List.map (fun a -> List.map (fun b -> a, b) lst2) lst1) in let rec combined_paths lst = match lst with | p1 :: p2 :: tl -> let acc = (List.map (fun (a, b) -> Filename.concat a b) (p1 * p2)) in combined_paths (acc :: tl) | [e] -> e | [] -> [] in let alternatives = List.map (fun (p, e) -> if String.length e > 0 && e.[0] <> '.' then p ^ "." ^ e else p ^ e) ((combined_paths paths) * exts) in List.find (fun file -> (if case_sensitive then file_exists_case file else Sys.file_exists file) && not (Sys.is_directory file) ) alternatives let which ~ctxt prg = let path_sep = match Sys.os_type with | "Win32" -> ';' | _ -> ':' in let path_lst = OASISString.nsplit (Sys.getenv "PATH") path_sep in let exec_ext = match Sys.os_type with | "Win32" -> "" :: (OASISString.nsplit (Sys.getenv "PATHEXT") path_sep) | _ -> [""] in find_file ~case_sensitive:false [path_lst; [prg]] exec_ext (**/**) let rec fix_dir dn = (* Windows hack because Sys.file_exists "src\\" = false when * Sys.file_exists "src" = true *) let ln = String.length dn in if Sys.os_type = "Win32" && ln > 0 && dn.[ln - 1] = '\\' then fix_dir (String.sub dn 0 (ln - 1)) else dn let q = Filename.quote (**/**) let cp ~ctxt ?(recurse=false) src tgt = if recurse then match Sys.os_type with | "Win32" -> OASISExec.run ~ctxt "xcopy" [q src; q tgt; "/E"] | _ -> OASISExec.run ~ctxt "cp" ["-r"; q src; q tgt] else OASISExec.run ~ctxt (match Sys.os_type with | "Win32" -> "copy" | _ -> "cp") [q src; q tgt] let mkdir ~ctxt tgt = OASISExec.run ~ctxt (match Sys.os_type with | "Win32" -> "md" | _ -> "mkdir") [q tgt] let rec mkdir_parent ~ctxt f tgt = let tgt = fix_dir tgt in if Sys.file_exists tgt then begin if not (Sys.is_directory tgt) then OASISUtils.failwithf (f_ "Cannot create directory '%s', a file of the same name already \ exists") tgt end else begin mkdir_parent ~ctxt f (Filename.dirname tgt); if not (Sys.file_exists tgt) then begin f tgt; mkdir ~ctxt tgt end end let rmdir ~ctxt tgt = if Sys.readdir tgt = [||] then begin match Sys.os_type with | "Win32" -> OASISExec.run ~ctxt "rd" [q tgt] | _ -> OASISExec.run ~ctxt "rm" ["-r"; q tgt] end else begin OASISMessage.error ~ctxt (f_ "Cannot remove directory '%s': not empty.") tgt end let glob ~ctxt fn = let basename = Filename.basename fn in if String.length basename >= 2 && basename.[0] = '*' && basename.[1] = '.' then begin let ext_len = (String.length basename) - 2 in let ext = String.sub basename 2 ext_len in let dirname = Filename.dirname fn in Array.fold_left (fun acc fn -> try let fn_ext = String.sub fn ((String.length fn) - ext_len) ext_len in if fn_ext = ext then (Filename.concat dirname fn) :: acc else acc with Invalid_argument _ -> acc) [] (Sys.readdir dirname) end else begin if file_exists_case fn then [fn] else [] end end # 3159 "setup.ml" module BaseEnvLight = struct (* # 22 "src/base/BaseEnvLight.ml" *) module MapString = Map.Make(String) type t = string MapString.t let default_filename = Filename.concat (Sys.getcwd ()) "setup.data" let load ?(allow_empty=false) ?(filename=default_filename) ?stream () = let line = ref 1 in let lexer st = let st_line = Stream.from (fun _ -> try match Stream.next st with | '\n' -> incr line; Some '\n' | c -> Some c with Stream.Failure -> None) in Genlex.make_lexer ["="] st_line in let rec read_file lxr mp = match Stream.npeek 3 lxr with | [Genlex.Ident nm; Genlex.Kwd "="; Genlex.String value] -> Stream.junk lxr; Stream.junk lxr; Stream.junk lxr; read_file lxr (MapString.add nm value mp) | [] -> mp | _ -> failwith (Printf.sprintf "Malformed data file '%s' line %d" filename !line) in match stream with | Some st -> read_file (lexer st) MapString.empty | None -> if Sys.file_exists filename then begin let chn = open_in_bin filename in let st = Stream.of_channel chn in try let mp = read_file (lexer st) MapString.empty in close_in chn; mp with e -> close_in chn; raise e end else if allow_empty then begin MapString.empty end else begin failwith (Printf.sprintf "Unable to load environment, the file '%s' doesn't exist." filename) end let rec var_expand str env = let buff = Buffer.create ((String.length str) * 2) in Buffer.add_substitute buff (fun var -> try var_expand (MapString.find var env) env with Not_found -> failwith (Printf.sprintf "No variable %s defined when trying to expand %S." var str)) str; Buffer.contents buff let var_get name env = var_expand (MapString.find name env) env let var_choose lst env = OASISExpr.choose (fun nm -> var_get nm env) lst end # 3239 "setup.ml" module BaseContext = struct (* # 22 "src/base/BaseContext.ml" *) (* TODO: get rid of this module. *) open OASISContext let args () = fst (fspecs ()) let default = default end module BaseMessage = struct (* # 22 "src/base/BaseMessage.ml" *) (** Message to user, overrid for Base @author Sylvain Le Gall *) open OASISMessage open BaseContext let debug fmt = debug ~ctxt:!default fmt let info fmt = info ~ctxt:!default fmt let warning fmt = warning ~ctxt:!default fmt let error fmt = error ~ctxt:!default fmt end module BaseEnv = struct (* # 22 "src/base/BaseEnv.ml" *) open OASISGettext open OASISUtils open OASISContext open PropList module MapString = BaseEnvLight.MapString type origin_t = | ODefault | OGetEnv | OFileLoad | OCommandLine type cli_handle_t = | CLINone | CLIAuto | CLIWith | CLIEnable | CLIUser of (Arg.key * Arg.spec * Arg.doc) list type definition_t = { hide: bool; dump: bool; cli: cli_handle_t; arg_help: string option; group: string option; } let schema = Schema.create "environment" (* Environment data *) let env = Data.create () (* Environment data from file *) let env_from_file = ref MapString.empty (* Lexer for var *) let var_lxr = Genlex.make_lexer [] let rec var_expand str = let buff = Buffer.create ((String.length str) * 2) in Buffer.add_substitute buff (fun var -> try (* TODO: this is a quick hack to allow calling Test.Command * without defining executable name really. I.e. if there is * an exec Executable toto, then $(toto) should be replace * by its real name. It is however useful to have this function * for other variable that depend on the host and should be * written better than that. *) let st = var_lxr (Stream.of_string var) in match Stream.npeek 3 st with | [Genlex.Ident "utoh"; Genlex.Ident nm] -> OASISHostPath.of_unix (var_get nm) | [Genlex.Ident "utoh"; Genlex.String s] -> OASISHostPath.of_unix s | [Genlex.Ident "ocaml_escaped"; Genlex.Ident nm] -> String.escaped (var_get nm) | [Genlex.Ident "ocaml_escaped"; Genlex.String s] -> String.escaped s | [Genlex.Ident nm] -> var_get nm | _ -> failwithf (f_ "Unknown expression '%s' in variable expansion of %s.") var str with | Unknown_field (_, _) -> failwithf (f_ "No variable %s defined when trying to expand %S.") var str | Stream.Error e -> failwithf (f_ "Syntax error when parsing '%s' when trying to \ expand %S: %s") var str e) str; Buffer.contents buff and var_get name = let vl = try Schema.get schema env name with Unknown_field _ as e -> begin try MapString.find name !env_from_file with Not_found -> raise e end in var_expand vl let var_choose ?printer ?name lst = OASISExpr.choose ?printer ?name var_get lst let var_protect vl = let buff = Buffer.create (String.length vl) in String.iter (function | '$' -> Buffer.add_string buff "\\$" | c -> Buffer.add_char buff c) vl; Buffer.contents buff let var_define ?(hide=false) ?(dump=true) ?short_desc ?(cli=CLINone) ?arg_help ?group name (* TODO: type constraint on the fact that name must be a valid OCaml id *) dflt = let default = [ OFileLoad, (fun () -> MapString.find name !env_from_file); ODefault, dflt; OGetEnv, (fun () -> Sys.getenv name); ] in let extra = { hide = hide; dump = dump; cli = cli; arg_help = arg_help; group = group; } in (* Try to find a value that can be defined *) let var_get_low lst = let errors, res = List.fold_left (fun (errors, res) (_, v) -> if res = None then begin try errors, Some (v ()) with | Not_found -> errors, res | Failure rsn -> (rsn :: errors), res | e -> (Printexc.to_string e) :: errors, res end else errors, res) ([], None) (List.sort (fun (o1, _) (o2, _) -> Pervasives.compare o2 o1) lst) in match res, errors with | Some v, _ -> v | None, [] -> raise (Not_set (name, None)) | None, lst -> raise (Not_set (name, Some (String.concat (s_ ", ") lst))) in let help = match short_desc with | Some fs -> Some fs | None -> None in let var_get_lst = FieldRO.create ~schema ~name ~parse:(fun ?(context=ODefault) s -> [context, fun () -> s]) ~print:var_get_low ~default ~update:(fun ?context:_ x old_x -> x @ old_x) ?help extra in fun () -> var_expand (var_get_low (var_get_lst env)) let var_redefine ?hide ?dump ?short_desc ?cli ?arg_help ?group name dflt = if Schema.mem schema name then begin (* TODO: look suspsicious, we want to memorize dflt not dflt () *) Schema.set schema env ~context:ODefault name (dflt ()); fun () -> var_get name end else begin var_define ?hide ?dump ?short_desc ?cli ?arg_help ?group name dflt end let var_ignore (_: unit -> string) = () let print_hidden = var_define ~hide:true ~dump:false ~cli:CLIAuto ~arg_help:"Print even non-printable variable. (debug)" "print_hidden" (fun () -> "false") let var_all () = List.rev (Schema.fold (fun acc nm def _ -> if not def.hide || bool_of_string (print_hidden ()) then nm :: acc else acc) [] schema) let default_filename = in_srcdir "setup.data" let load ~ctxt ?(allow_empty=false) ?(filename=default_filename) () = let open OASISFileSystem in env_from_file := let repr_filename = ctxt.srcfs#string_of_filename filename in if ctxt.srcfs#file_exists filename then begin let buf = Buffer.create 13 in defer_close (ctxt.srcfs#open_in ~mode:binary_in filename) (read_all buf); defer_close (ctxt.srcfs#open_in ~mode:binary_in filename) (fun rdr -> OASISMessage.info ~ctxt "Loading environment from %S." repr_filename; BaseEnvLight.load ~allow_empty ~filename:(repr_filename) ~stream:(stream_of_reader rdr) ()) end else if allow_empty then begin BaseEnvLight.MapString.empty end else begin failwith (Printf.sprintf (f_ "Unable to load environment, the file '%s' doesn't exist.") repr_filename) end let unload () = env_from_file := MapString.empty; Data.clear env let dump ~ctxt ?(filename=default_filename) () = let open OASISFileSystem in defer_close (ctxt.OASISContext.srcfs#open_out ~mode:binary_out filename) (fun wrtr -> let buf = Buffer.create 63 in let output nm value = Buffer.add_string buf (Printf.sprintf "%s=%S\n" nm value) in let mp_todo = (* Dump data from schema *) Schema.fold (fun mp_todo nm def _ -> if def.dump then begin try output nm (Schema.get schema env nm) with Not_set _ -> () end; MapString.remove nm mp_todo) !env_from_file schema in (* Dump data defined outside of schema *) MapString.iter output mp_todo; wrtr#output buf) let print () = let printable_vars = Schema.fold (fun acc nm def short_descr_opt -> if not def.hide || bool_of_string (print_hidden ()) then begin try let value = Schema.get schema env nm in let txt = match short_descr_opt with | Some s -> s () | None -> nm in (txt, value) :: acc with Not_set _ -> acc end else acc) [] schema in let max_length = List.fold_left max 0 (List.rev_map String.length (List.rev_map fst printable_vars)) in let dot_pad str = String.make ((max_length - (String.length str)) + 3) '.' in Printf.printf "\nConfiguration:\n"; List.iter (fun (name, value) -> Printf.printf "%s: %s" name (dot_pad name); if value = "" then Printf.printf "\n" else Printf.printf " %s\n" value) (List.rev printable_vars); Printf.printf "\n%!" let args () = let arg_concat = OASISUtils.varname_concat ~hyphen:'-' in [ "--override", Arg.Tuple ( let rvr = ref "" in let rvl = ref "" in [ Arg.Set_string rvr; Arg.Set_string rvl; Arg.Unit (fun () -> Schema.set schema env ~context:OCommandLine !rvr !rvl) ] ), "var+val Override any configuration variable."; ] @ List.flatten (Schema.fold (fun acc name def short_descr_opt -> let var_set s = Schema.set schema env ~context:OCommandLine name s in let arg_name = OASISUtils.varname_of_string ~hyphen:'-' name in let hlp = match short_descr_opt with | Some txt -> txt () | None -> "" in let arg_hlp = match def.arg_help with | Some s -> s | None -> "str" in let default_value = try Printf.sprintf (f_ " [%s]") (Schema.get schema env name) with Not_set _ -> "" in let args = match def.cli with | CLINone -> [] | CLIAuto -> [ arg_concat "--" arg_name, Arg.String var_set, Printf.sprintf (f_ "%s %s%s") arg_hlp hlp default_value ] | CLIWith -> [ arg_concat "--with-" arg_name, Arg.String var_set, Printf.sprintf (f_ "%s %s%s") arg_hlp hlp default_value ] | CLIEnable -> let dflt = if default_value = " [true]" then s_ " [default: enabled]" else s_ " [default: disabled]" in [ arg_concat "--enable-" arg_name, Arg.Unit (fun () -> var_set "true"), Printf.sprintf (f_ " %s%s") hlp dflt; arg_concat "--disable-" arg_name, Arg.Unit (fun () -> var_set "false"), Printf.sprintf (f_ " %s%s") hlp dflt ] | CLIUser lst -> lst in args :: acc) [] schema) end module BaseArgExt = struct (* # 22 "src/base/BaseArgExt.ml" *) open OASISUtils open OASISGettext let parse argv args = (* Simulate command line for Arg *) let current = ref 0 in try Arg.parse_argv ~current:current (Array.concat [[|"none"|]; argv]) (Arg.align args) (failwithf (f_ "Don't know what to do with arguments: '%s'")) (s_ "configure options:") with | Arg.Help txt -> print_endline txt; exit 0 | Arg.Bad txt -> prerr_endline txt; exit 1 end module BaseCheck = struct (* # 22 "src/base/BaseCheck.ml" *) open BaseEnv open BaseMessage open OASISUtils open OASISGettext let prog_best prg prg_lst = var_redefine prg (fun () -> let alternate = List.fold_left (fun res e -> match res with | Some _ -> res | None -> try Some (OASISFileUtil.which ~ctxt:!BaseContext.default e) with Not_found -> None) None prg_lst in match alternate with | Some prg -> prg | None -> raise Not_found) let prog prg = prog_best prg [prg] let prog_opt prg = prog_best prg [prg^".opt"; prg] let ocamlfind = prog "ocamlfind" let version var_prefix cmp fversion () = (* Really compare version provided *) let var = var_prefix^"_version_"^(OASISVersion.varname_of_comparator cmp) in var_redefine ~hide:true var (fun () -> let version_str = match fversion () with | "[Distributed with OCaml]" -> begin try (var_get "ocaml_version") with Not_found -> warning (f_ "Variable ocaml_version not defined, fallback \ to default"); Sys.ocaml_version end | res -> res in let version = OASISVersion.version_of_string version_str in if OASISVersion.comparator_apply version cmp then version_str else failwithf (f_ "Cannot satisfy version constraint on %s: %s (version: %s)") var_prefix (OASISVersion.string_of_comparator cmp) version_str) () let package_version pkg = OASISExec.run_read_one_line ~ctxt:!BaseContext.default (ocamlfind ()) ["query"; "-format"; "%v"; pkg] let package ?version_comparator pkg () = let var = OASISUtils.varname_concat "pkg_" (OASISUtils.varname_of_string pkg) in let findlib_dir pkg = let dir = OASISExec.run_read_one_line ~ctxt:!BaseContext.default (ocamlfind ()) ["query"; "-format"; "%d"; pkg] in if Sys.file_exists dir && Sys.is_directory dir then dir else failwithf (f_ "When looking for findlib package %s, \ directory %s return doesn't exist") pkg dir in let vl = var_redefine var (fun () -> findlib_dir pkg) () in ( match version_comparator with | Some ver_cmp -> ignore (version var ver_cmp (fun _ -> package_version pkg) ()) | None -> () ); vl end module BaseOCamlcConfig = struct (* # 22 "src/base/BaseOCamlcConfig.ml" *) open BaseEnv open OASISUtils open OASISGettext module SMap = Map.Make(String) let ocamlc = BaseCheck.prog_opt "ocamlc" let ocamlc_config_map = (* Map name to value for ocamlc -config output (name ^": "^value) *) let rec split_field mp lst = match lst with | line :: tl -> let mp = try let pos_semicolon = String.index line ':' in if pos_semicolon > 1 then ( let name = String.sub line 0 pos_semicolon in let linelen = String.length line in let value = if linelen > pos_semicolon + 2 then String.sub line (pos_semicolon + 2) (linelen - pos_semicolon - 2) else "" in SMap.add name value mp ) else ( mp ) with Not_found -> ( mp ) in split_field mp tl | [] -> mp in let cache = lazy (var_protect (Marshal.to_string (split_field SMap.empty (OASISExec.run_read_output ~ctxt:!BaseContext.default (ocamlc ()) ["-config"])) [])) in var_redefine "ocamlc_config_map" ~hide:true ~dump:false (fun () -> (* TODO: update if ocamlc change !!! *) Lazy.force cache) let var_define nm = (* Extract data from ocamlc -config *) let avlbl_config_get () = Marshal.from_string (ocamlc_config_map ()) 0 in let chop_version_suffix s = try String.sub s 0 (String.index s '+') with _ -> s in let nm_config, value_config = match nm with | "ocaml_version" -> "version", chop_version_suffix | _ -> nm, (fun x -> x) in var_redefine nm (fun () -> try let map = avlbl_config_get () in let value = SMap.find nm_config map in value_config value with Not_found -> failwithf (f_ "Cannot find field '%s' in '%s -config' output") nm (ocamlc ())) end module BaseStandardVar = struct (* # 22 "src/base/BaseStandardVar.ml" *) open OASISGettext open OASISTypes open BaseCheck open BaseEnv let ocamlfind = BaseCheck.ocamlfind let ocamlc = BaseOCamlcConfig.ocamlc let ocamlopt = prog_opt "ocamlopt" let ocamlbuild = prog "ocamlbuild" (**/**) let rpkg = ref None let pkg_get () = match !rpkg with | Some pkg -> pkg | None -> failwith (s_ "OASIS Package is not set") let var_cond = ref [] let var_define_cond ~since_version f dflt = let holder = ref (fun () -> dflt) in let since_version = OASISVersion.VGreaterEqual (OASISVersion.version_of_string since_version) in var_cond := (fun ver -> if OASISVersion.comparator_apply ver since_version then holder := f ()) :: !var_cond; fun () -> !holder () (**/**) let pkg_name = var_define ~short_desc:(fun () -> s_ "Package name") "pkg_name" (fun () -> (pkg_get ()).name) let pkg_version = var_define ~short_desc:(fun () -> s_ "Package version") "pkg_version" (fun () -> (OASISVersion.string_of_version (pkg_get ()).version)) let c = BaseOCamlcConfig.var_define let os_type = c "os_type" let system = c "system" let architecture = c "architecture" let ccomp_type = c "ccomp_type" let ocaml_version = c "ocaml_version" (* TODO: Check standard variable presence at runtime *) let standard_library_default = c "standard_library_default" let standard_library = c "standard_library" let standard_runtime = c "standard_runtime" let bytecomp_c_compiler = c "bytecomp_c_compiler" let native_c_compiler = c "native_c_compiler" let model = c "model" let ext_obj = c "ext_obj" let ext_asm = c "ext_asm" let ext_lib = c "ext_lib" let ext_dll = c "ext_dll" let default_executable_name = c "default_executable_name" let systhread_supported = c "systhread_supported" let flexlink = BaseCheck.prog "flexlink" let flexdll_version = var_define ~short_desc:(fun () -> "FlexDLL version (Win32)") "flexdll_version" (fun () -> let lst = OASISExec.run_read_output ~ctxt:!BaseContext.default (flexlink ()) ["-help"] in match lst with | line :: _ -> Scanf.sscanf line "FlexDLL version %s" (fun ver -> ver) | [] -> raise Not_found) (**/**) let p name hlp dflt = var_define ~short_desc:hlp ~cli:CLIAuto ~arg_help:"dir" name dflt let (/) a b = if os_type () = Sys.os_type then Filename.concat a b else if os_type () = "Unix" || os_type () = "Cygwin" then OASISUnixPath.concat a b else OASISUtils.failwithf (f_ "Cannot handle os_type %s filename concat") (os_type ()) (**/**) let prefix = p "prefix" (fun () -> s_ "Install architecture-independent files dir") (fun () -> match os_type () with | "Win32" -> let program_files = Sys.getenv "PROGRAMFILES" in program_files/(pkg_name ()) | _ -> "/usr/local") let exec_prefix = p "exec_prefix" (fun () -> s_ "Install architecture-dependent files in dir") (fun () -> "$prefix") let bindir = p "bindir" (fun () -> s_ "User executables") (fun () -> "$exec_prefix"/"bin") let sbindir = p "sbindir" (fun () -> s_ "System admin executables") (fun () -> "$exec_prefix"/"sbin") let libexecdir = p "libexecdir" (fun () -> s_ "Program executables") (fun () -> "$exec_prefix"/"libexec") let sysconfdir = p "sysconfdir" (fun () -> s_ "Read-only single-machine data") (fun () -> "$prefix"/"etc") let sharedstatedir = p "sharedstatedir" (fun () -> s_ "Modifiable architecture-independent data") (fun () -> "$prefix"/"com") let localstatedir = p "localstatedir" (fun () -> s_ "Modifiable single-machine data") (fun () -> "$prefix"/"var") let libdir = p "libdir" (fun () -> s_ "Object code libraries") (fun () -> "$exec_prefix"/"lib") let datarootdir = p "datarootdir" (fun () -> s_ "Read-only arch-independent data root") (fun () -> "$prefix"/"share") let datadir = p "datadir" (fun () -> s_ "Read-only architecture-independent data") (fun () -> "$datarootdir") let infodir = p "infodir" (fun () -> s_ "Info documentation") (fun () -> "$datarootdir"/"info") let localedir = p "localedir" (fun () -> s_ "Locale-dependent data") (fun () -> "$datarootdir"/"locale") let mandir = p "mandir" (fun () -> s_ "Man documentation") (fun () -> "$datarootdir"/"man") let docdir = p "docdir" (fun () -> s_ "Documentation root") (fun () -> "$datarootdir"/"doc"/"$pkg_name") let htmldir = p "htmldir" (fun () -> s_ "HTML documentation") (fun () -> "$docdir") let dvidir = p "dvidir" (fun () -> s_ "DVI documentation") (fun () -> "$docdir") let pdfdir = p "pdfdir" (fun () -> s_ "PDF documentation") (fun () -> "$docdir") let psdir = p "psdir" (fun () -> s_ "PS documentation") (fun () -> "$docdir") let destdir = p "destdir" (fun () -> s_ "Prepend a path when installing package") (fun () -> raise (PropList.Not_set ("destdir", Some (s_ "undefined by construct")))) let findlib_version = var_define "findlib_version" (fun () -> BaseCheck.package_version "findlib") let is_native = var_define "is_native" (fun () -> try let _s: string = ocamlopt () in "true" with PropList.Not_set _ -> let _s: string = ocamlc () in "false") let ext_program = var_define "suffix_program" (fun () -> match os_type () with | "Win32" | "Cygwin" -> ".exe" | _ -> "") let rm = var_define ~short_desc:(fun () -> s_ "Remove a file.") "rm" (fun () -> match os_type () with | "Win32" -> "del" | _ -> "rm -f") let rmdir = var_define ~short_desc:(fun () -> s_ "Remove a directory.") "rmdir" (fun () -> match os_type () with | "Win32" -> "rd" | _ -> "rm -rf") let debug = var_define ~short_desc:(fun () -> s_ "Turn ocaml debug flag on") ~cli:CLIEnable "debug" (fun () -> "true") let profile = var_define ~short_desc:(fun () -> s_ "Turn ocaml profile flag on") ~cli:CLIEnable "profile" (fun () -> "false") let tests = var_define_cond ~since_version:"0.3" (fun () -> var_define ~short_desc:(fun () -> s_ "Compile tests executable and library and run them") ~cli:CLIEnable "tests" (fun () -> "false")) "true" let docs = var_define_cond ~since_version:"0.3" (fun () -> var_define ~short_desc:(fun () -> s_ "Create documentations") ~cli:CLIEnable "docs" (fun () -> "true")) "true" let native_dynlink = var_define ~short_desc:(fun () -> s_ "Compiler support generation of .cmxs.") ~cli:CLINone "native_dynlink" (fun () -> let res = let ocaml_lt_312 () = OASISVersion.comparator_apply (OASISVersion.version_of_string (ocaml_version ())) (OASISVersion.VLesser (OASISVersion.version_of_string "3.12.0")) in let flexdll_lt_030 () = OASISVersion.comparator_apply (OASISVersion.version_of_string (flexdll_version ())) (OASISVersion.VLesser (OASISVersion.version_of_string "0.30")) in let has_native_dynlink = let ocamlfind = ocamlfind () in try let fn = OASISExec.run_read_one_line ~ctxt:!BaseContext.default ocamlfind ["query"; "-predicates"; "native"; "dynlink"; "-format"; "%d/%a"] in Sys.file_exists fn with _ -> false in if not has_native_dynlink then false else if ocaml_lt_312 () then false else if (os_type () = "Win32" || os_type () = "Cygwin") && flexdll_lt_030 () then begin BaseMessage.warning (f_ ".cmxs generation disabled because FlexDLL needs to be \ at least 0.30. Please upgrade FlexDLL from %s to 0.30.") (flexdll_version ()); false end else true in string_of_bool res) let init pkg = rpkg := Some pkg; List.iter (fun f -> f pkg.oasis_version) !var_cond end module BaseFileAB = struct (* # 22 "src/base/BaseFileAB.ml" *) open BaseEnv open OASISGettext open BaseMessage open OASISContext let to_filename fn = if not (Filename.check_suffix fn ".ab") then warning (f_ "File '%s' doesn't have '.ab' extension") fn; OASISFileSystem.of_unix_filename (Filename.chop_extension fn) let replace ~ctxt fn_lst = let open OASISFileSystem in let ibuf, obuf = Buffer.create 13, Buffer.create 13 in List.iter (fun fn -> Buffer.clear ibuf; Buffer.clear obuf; defer_close (ctxt.srcfs#open_in (of_unix_filename fn)) (read_all ibuf); Buffer.add_string obuf (var_expand (Buffer.contents ibuf)); defer_close (ctxt.srcfs#open_out (to_filename fn)) (fun wrtr -> wrtr#output obuf)) fn_lst end module BaseLog = struct (* # 22 "src/base/BaseLog.ml" *) open OASISUtils open OASISContext open OASISGettext open OASISFileSystem let default_filename = in_srcdir "setup.log" let load ~ctxt () = let module SetTupleString = Set.Make (struct type t = string * string let compare (s11, s12) (s21, s22) = match String.compare s11 s21 with | 0 -> String.compare s12 s22 | n -> n end) in if ctxt.srcfs#file_exists default_filename then begin defer_close (ctxt.srcfs#open_in default_filename) (fun rdr -> let line = ref 1 in let lxr = Genlex.make_lexer [] (stream_of_reader rdr) in let rec read_aux (st, lst) = match Stream.npeek 2 lxr with | [Genlex.String e; Genlex.String d] -> let t = e, d in Stream.junk lxr; Stream.junk lxr; if SetTupleString.mem t st then read_aux (st, lst) else read_aux (SetTupleString.add t st, t :: lst) | [] -> List.rev lst | _ -> failwithf (f_ "Malformed log file '%s' at line %d") (ctxt.srcfs#string_of_filename default_filename) !line in read_aux (SetTupleString.empty, [])) end else begin [] end let register ~ctxt event data = defer_close (ctxt.srcfs#open_out ~mode:[Open_append; Open_creat; Open_text] ~perm:0o644 default_filename) (fun wrtr -> let buf = Buffer.create 13 in Printf.bprintf buf "%S %S\n" event data; wrtr#output buf) let unregister ~ctxt event data = let lst = load ~ctxt () in let buf = Buffer.create 13 in List.iter (fun (e, d) -> if e <> event || d <> data then Printf.bprintf buf "%S %S\n" e d) lst; if Buffer.length buf > 0 then defer_close (ctxt.srcfs#open_out default_filename) (fun wrtr -> wrtr#output buf) else ctxt.srcfs#remove default_filename let filter ~ctxt events = let st_events = SetString.of_list events in List.filter (fun (e, _) -> SetString.mem e st_events) (load ~ctxt ()) let exists ~ctxt event data = List.exists (fun v -> (event, data) = v) (load ~ctxt ()) end module BaseBuilt = struct (* # 22 "src/base/BaseBuilt.ml" *) open OASISTypes open OASISGettext open BaseStandardVar open BaseMessage type t = | BExec (* Executable *) | BExecLib (* Library coming with executable *) | BLib (* Library *) | BObj (* Library *) | BDoc (* Document *) let to_log_event_file t nm = "built_"^ (match t with | BExec -> "exec" | BExecLib -> "exec_lib" | BLib -> "lib" | BObj -> "obj" | BDoc -> "doc")^ "_"^nm let to_log_event_done t nm = "is_"^(to_log_event_file t nm) let register ~ctxt t nm lst = BaseLog.register ~ctxt (to_log_event_done t nm) "true"; List.iter (fun alt -> let registered = List.fold_left (fun registered fn -> if OASISFileUtil.file_exists_case fn then begin BaseLog.register ~ctxt (to_log_event_file t nm) (if Filename.is_relative fn then Filename.concat (Sys.getcwd ()) fn else fn); true end else begin registered end) false alt in if not registered then warning (f_ "Cannot find an existing alternative files among: %s") (String.concat (s_ ", ") alt)) lst let unregister ~ctxt t nm = List.iter (fun (e, d) -> BaseLog.unregister ~ctxt e d) (BaseLog.filter ~ctxt [to_log_event_file t nm; to_log_event_done t nm]) let fold ~ctxt t nm f acc = List.fold_left (fun acc (_, fn) -> if OASISFileUtil.file_exists_case fn then begin f acc fn end else begin warning (f_ "File '%s' has been marked as built \ for %s but doesn't exist") fn (Printf.sprintf (match t with | BExec | BExecLib -> (f_ "executable %s") | BLib -> (f_ "library %s") | BObj -> (f_ "object %s") | BDoc -> (f_ "documentation %s")) nm); acc end) acc (BaseLog.filter ~ctxt [to_log_event_file t nm]) let is_built ~ctxt t nm = List.fold_left (fun _ (_, d) -> try bool_of_string d with _ -> false) false (BaseLog.filter ~ctxt [to_log_event_done t nm]) let of_executable ffn (cs, bs, exec) = let unix_exec_is, unix_dll_opt = OASISExecutable.unix_exec_is (cs, bs, exec) (fun () -> bool_of_string (is_native ())) ext_dll ext_program in let evs = (BExec, cs.cs_name, [[ffn unix_exec_is]]) :: (match unix_dll_opt with | Some fn -> [BExecLib, cs.cs_name, [[ffn fn]]] | None -> []) in evs, unix_exec_is, unix_dll_opt let of_library ffn (cs, bs, lib) = let unix_lst = OASISLibrary.generated_unix_files ~ctxt:!BaseContext.default ~source_file_exists:(fun fn -> OASISFileUtil.file_exists_case (OASISHostPath.of_unix fn)) ~is_native:(bool_of_string (is_native ())) ~has_native_dynlink:(bool_of_string (native_dynlink ())) ~ext_lib:(ext_lib ()) ~ext_dll:(ext_dll ()) (cs, bs, lib) in let evs = [BLib, cs.cs_name, List.map (List.map ffn) unix_lst] in evs, unix_lst let of_object ffn (cs, bs, obj) = let unix_lst = OASISObject.generated_unix_files ~ctxt:!BaseContext.default ~source_file_exists:(fun fn -> OASISFileUtil.file_exists_case (OASISHostPath.of_unix fn)) ~is_native:(bool_of_string (is_native ())) (cs, bs, obj) in let evs = [BObj, cs.cs_name, List.map (List.map ffn) unix_lst] in evs, unix_lst end module BaseCustom = struct (* # 22 "src/base/BaseCustom.ml" *) open BaseEnv open BaseMessage open OASISTypes open OASISGettext let run cmd args extra_args = OASISExec.run ~ctxt:!BaseContext.default ~quote:false (var_expand cmd) (List.map var_expand (args @ (Array.to_list extra_args))) let hook ?(failsafe=false) cstm f e = let optional_command lst = let printer = function | Some (cmd, args) -> String.concat " " (cmd :: args) | None -> s_ "No command" in match var_choose ~name:(s_ "Pre/Post Command") ~printer lst with | Some (cmd, args) -> begin try run cmd args [||] with e when failsafe -> warning (f_ "Command '%s' fail with error: %s") (String.concat " " (cmd :: args)) (match e with | Failure msg -> msg | e -> Printexc.to_string e) end | None -> () in let res = optional_command cstm.pre_command; f e in optional_command cstm.post_command; res end module BaseDynVar = struct (* # 22 "src/base/BaseDynVar.ml" *) open OASISTypes open OASISGettext open BaseEnv open BaseBuilt let init ~ctxt pkg = (* TODO: disambiguate exec vs other variable by adding exec_VARNAME. *) (* TODO: provide compile option for library libary_byte_args_VARNAME... *) List.iter (function | Executable (cs, bs, _) -> if var_choose bs.bs_build then var_ignore (var_redefine (* We don't save this variable *) ~dump:false ~short_desc:(fun () -> Printf.sprintf (f_ "Filename of executable '%s'") cs.cs_name) (OASISUtils.varname_of_string cs.cs_name) (fun () -> let fn_opt = fold ~ctxt BExec cs.cs_name (fun _ fn -> Some fn) None in match fn_opt with | Some fn -> fn | None -> raise (PropList.Not_set (cs.cs_name, Some (Printf.sprintf (f_ "Executable '%s' not yet built.") cs.cs_name))))) | Library _ | Object _ | Flag _ | Test _ | SrcRepo _ | Doc _ -> ()) pkg.sections end module BaseTest = struct (* # 22 "src/base/BaseTest.ml" *) open BaseEnv open BaseMessage open OASISTypes open OASISGettext let test ~ctxt lst pkg extra_args = let one_test (failure, n) (test_plugin, cs, test) = if var_choose ~name:(Printf.sprintf (f_ "test %s run") cs.cs_name) ~printer:string_of_bool test.test_run then begin let () = info (f_ "Running test '%s'") cs.cs_name in let back_cwd = match test.test_working_directory with | Some dir -> let cwd = Sys.getcwd () in let chdir d = info (f_ "Changing directory to '%s'") d; Sys.chdir d in chdir dir; fun () -> chdir cwd | None -> fun () -> () in try let failure_percent = BaseCustom.hook test.test_custom (test_plugin ~ctxt pkg (cs, test)) extra_args in back_cwd (); (failure_percent +. failure, n + 1) with e -> begin back_cwd (); raise e end end else begin info (f_ "Skipping test '%s'") cs.cs_name; (failure, n) end in let failed, n = List.fold_left one_test (0.0, 0) lst in let failure_percent = if n = 0 then 0.0 else failed /. (float_of_int n) in let msg = Printf.sprintf (f_ "Tests had a %.2f%% failure rate") (100. *. failure_percent) in if failure_percent > 0.0 then failwith msg else info "%s" msg; (* Possible explanation why the tests where not run. *) if OASISFeatures.package_test OASISFeatures.flag_tests pkg && not (bool_of_string (BaseStandardVar.tests ())) && lst <> [] then BaseMessage.warning "Tests are turned off, consider enabling with \ 'ocaml setup.ml -configure --enable-tests'" end module BaseDoc = struct (* # 22 "src/base/BaseDoc.ml" *) open BaseEnv open BaseMessage open OASISTypes open OASISGettext let doc ~ctxt lst pkg extra_args = let one_doc (doc_plugin, cs, doc) = if var_choose ~name:(Printf.sprintf (f_ "documentation %s build") cs.cs_name) ~printer:string_of_bool doc.doc_build then begin info (f_ "Building documentation '%s'") cs.cs_name; BaseCustom.hook doc.doc_custom (doc_plugin ~ctxt pkg (cs, doc)) extra_args end in List.iter one_doc lst; if OASISFeatures.package_test OASISFeatures.flag_docs pkg && not (bool_of_string (BaseStandardVar.docs ())) && lst <> [] then BaseMessage.warning "Docs are turned off, consider enabling with \ 'ocaml setup.ml -configure --enable-docs'" end module BaseSetup = struct (* # 22 "src/base/BaseSetup.ml" *) open OASISContext open BaseEnv open BaseMessage open OASISTypes open OASISGettext open OASISUtils type std_args_fun = ctxt:OASISContext.t -> package -> string array -> unit type ('a, 'b) section_args_fun = name * (ctxt:OASISContext.t -> package -> (common_section * 'a) -> string array -> 'b) type t = { configure: std_args_fun; build: std_args_fun; doc: ((doc, unit) section_args_fun) list; test: ((test, float) section_args_fun) list; install: std_args_fun; uninstall: std_args_fun; clean: std_args_fun list; clean_doc: (doc, unit) section_args_fun list; clean_test: (test, unit) section_args_fun list; distclean: std_args_fun list; distclean_doc: (doc, unit) section_args_fun list; distclean_test: (test, unit) section_args_fun list; package: package; oasis_fn: string option; oasis_version: string; oasis_digest: Digest.t option; oasis_exec: string option; oasis_setup_args: string list; setup_update: bool; } (* Associate a plugin function with data from package *) let join_plugin_sections filter_map lst = List.rev (List.fold_left (fun acc sct -> match filter_map sct with | Some e -> e :: acc | None -> acc) [] lst) (* Search for plugin data associated with a section name *) let lookup_plugin_section plugin action nm lst = try List.assoc nm lst with Not_found -> failwithf (f_ "Cannot find plugin %s matching section %s for %s action") plugin nm action let configure ~ctxt t args = (* Run configure *) BaseCustom.hook t.package.conf_custom (fun () -> (* Reload if preconf has changed it *) begin try unload (); load ~ctxt (); with _ -> () end; (* Run plugin's configure *) t.configure ~ctxt t.package args; (* Dump to allow postconf to change it *) dump ~ctxt ()) (); (* Reload environment *) unload (); load ~ctxt (); (* Save environment *) print (); (* Replace data in file *) BaseFileAB.replace ~ctxt t.package.files_ab let build ~ctxt t args = BaseCustom.hook t.package.build_custom (t.build ~ctxt t.package) args let doc ~ctxt t args = BaseDoc.doc ~ctxt (join_plugin_sections (function | Doc (cs, e) -> Some (lookup_plugin_section "documentation" (s_ "build") cs.cs_name t.doc, cs, e) | _ -> None) t.package.sections) t.package args let test ~ctxt t args = BaseTest.test ~ctxt (join_plugin_sections (function | Test (cs, e) -> Some (lookup_plugin_section "test" (s_ "run") cs.cs_name t.test, cs, e) | _ -> None) t.package.sections) t.package args let all ~ctxt t args = let rno_doc = ref false in let rno_test = ref false in let arg_rest = ref [] in Arg.parse_argv ~current:(ref 0) (Array.of_list ((Sys.executable_name^" all") :: (Array.to_list args))) [ "-no-doc", Arg.Set rno_doc, s_ "Don't run doc target"; "-no-test", Arg.Set rno_test, s_ "Don't run test target"; "--", Arg.Rest (fun arg -> arg_rest := arg :: !arg_rest), s_ "All arguments for configure."; ] (failwithf (f_ "Don't know what to do with '%s'")) ""; info "Running configure step"; configure ~ctxt t (Array.of_list (List.rev !arg_rest)); info "Running build step"; build ~ctxt t [||]; (* Load setup.log dynamic variables *) BaseDynVar.init ~ctxt t.package; if not !rno_doc then begin info "Running doc step"; doc ~ctxt t [||] end else begin info "Skipping doc step" end; if not !rno_test then begin info "Running test step"; test ~ctxt t [||] end else begin info "Skipping test step" end let install ~ctxt t args = BaseCustom.hook t.package.install_custom (t.install ~ctxt t.package) args let uninstall ~ctxt t args = BaseCustom.hook t.package.uninstall_custom (t.uninstall ~ctxt t.package) args let reinstall ~ctxt t args = uninstall ~ctxt t args; install ~ctxt t args let clean, distclean = let failsafe f a = try f a with e -> warning (f_ "Action fail with error: %s") (match e with | Failure msg -> msg | e -> Printexc.to_string e) in let generic_clean ~ctxt t cstm mains docs tests args = BaseCustom.hook ~failsafe:true cstm (fun () -> (* Clean section *) List.iter (function | Test (cs, test) -> let f = try List.assoc cs.cs_name tests with Not_found -> fun ~ctxt:_ _ _ _ -> () in failsafe (f ~ctxt t.package (cs, test)) args | Doc (cs, doc) -> let f = try List.assoc cs.cs_name docs with Not_found -> fun ~ctxt:_ _ _ _ -> () in failsafe (f ~ctxt t.package (cs, doc)) args | Library _ | Object _ | Executable _ | Flag _ | SrcRepo _ -> ()) t.package.sections; (* Clean whole package *) List.iter (fun f -> failsafe (f ~ctxt t.package) args) mains) () in let clean ~ctxt t args = generic_clean ~ctxt t t.package.clean_custom t.clean t.clean_doc t.clean_test args in let distclean ~ctxt t args = (* Call clean *) clean ~ctxt t args; (* Call distclean code *) generic_clean ~ctxt t t.package.distclean_custom t.distclean t.distclean_doc t.distclean_test args; (* Remove generated source files. *) List.iter (fun fn -> if ctxt.srcfs#file_exists fn then begin info (f_ "Remove '%s'") (ctxt.srcfs#string_of_filename fn); ctxt.srcfs#remove fn end) ([BaseEnv.default_filename; BaseLog.default_filename] @ (List.rev_map BaseFileAB.to_filename t.package.files_ab)) in clean, distclean let version ~ctxt:_ (t: t) _ = print_endline t.oasis_version let update_setup_ml, no_update_setup_ml_cli = let b = ref true in b, ("-no-update-setup-ml", Arg.Clear b, s_ " Don't try to update setup.ml, even if _oasis has changed.") (* TODO: srcfs *) let default_oasis_fn = "_oasis" let update_setup_ml t = let oasis_fn = match t.oasis_fn with | Some fn -> fn | None -> default_oasis_fn in let oasis_exec = match t.oasis_exec with | Some fn -> fn | None -> "oasis" in let ocaml = Sys.executable_name in let setup_ml, args = match Array.to_list Sys.argv with | setup_ml :: args -> setup_ml, args | [] -> failwith (s_ "Expecting non-empty command line arguments.") in let ocaml, setup_ml = if Sys.executable_name = Sys.argv.(0) then (* We are not running in standard mode, probably the script * is precompiled. *) "ocaml", "setup.ml" else ocaml, setup_ml in let no_update_setup_ml_cli, _, _ = no_update_setup_ml_cli in let do_update () = let oasis_exec_version = OASISExec.run_read_one_line ~ctxt:!BaseContext.default ~f_exit_code: (function | 0 -> () | 1 -> failwithf (f_ "Executable '%s' is probably an old version \ of oasis (< 0.3.0), please update to version \ v%s.") oasis_exec t.oasis_version | 127 -> failwithf (f_ "Cannot find executable '%s', please install \ oasis v%s.") oasis_exec t.oasis_version | n -> failwithf (f_ "Command '%s version' exited with code %d.") oasis_exec n) oasis_exec ["version"] in if OASISVersion.comparator_apply (OASISVersion.version_of_string oasis_exec_version) (OASISVersion.VGreaterEqual (OASISVersion.version_of_string t.oasis_version)) then begin (* We have a version >= for the executable oasis, proceed with * update. *) (* TODO: delegate this check to 'oasis setup'. *) if Sys.os_type = "Win32" then failwithf (f_ "It is not possible to update the running script \ setup.ml on Windows. Please update setup.ml by \ running '%s'.") (String.concat " " (oasis_exec :: "setup" :: t.oasis_setup_args)) else begin OASISExec.run ~ctxt:!BaseContext.default ~f_exit_code: (fun n -> if n <> 0 then failwithf (f_ "Unable to update setup.ml using '%s', \ please fix the problem and retry.") oasis_exec) oasis_exec ("setup" :: t.oasis_setup_args); OASISExec.run ~ctxt:!BaseContext.default ocaml (setup_ml :: args) end end else failwithf (f_ "The version of '%s' (v%s) doesn't match the version of \ oasis used to generate the %s file. Please install at \ least oasis v%s.") oasis_exec oasis_exec_version setup_ml t.oasis_version in if !update_setup_ml then begin try match t.oasis_digest with | Some dgst -> if Sys.file_exists oasis_fn && dgst <> Digest.file default_oasis_fn then begin do_update (); true end else false | None -> false with e -> error (f_ "Error when updating setup.ml. If you want to avoid this error, \ you can bypass the update of %s by running '%s %s %s %s'") setup_ml ocaml setup_ml no_update_setup_ml_cli (String.concat " " args); raise e end else false let setup t = let catch_exn = ref true in let act_ref = ref (fun ~ctxt:_ _ -> failwithf (f_ "No action defined, run '%s %s -help'") Sys.executable_name Sys.argv.(0)) in let extra_args_ref = ref [] in let allow_empty_env_ref = ref false in let arg_handle ?(allow_empty_env=false) act = Arg.Tuple [ Arg.Rest (fun str -> extra_args_ref := str :: !extra_args_ref); Arg.Unit (fun () -> allow_empty_env_ref := allow_empty_env; act_ref := act); ] in try let () = Arg.parse (Arg.align ([ "-configure", arg_handle ~allow_empty_env:true configure, s_ "[options*] Configure the whole build process."; "-build", arg_handle build, s_ "[options*] Build executables and libraries."; "-doc", arg_handle doc, s_ "[options*] Build documents."; "-test", arg_handle test, s_ "[options*] Run tests."; "-all", arg_handle ~allow_empty_env:true all, s_ "[options*] Run configure, build, doc and test targets."; "-install", arg_handle install, s_ "[options*] Install libraries, data, executables \ and documents."; "-uninstall", arg_handle uninstall, s_ "[options*] Uninstall libraries, data, executables \ and documents."; "-reinstall", arg_handle reinstall, s_ "[options*] Uninstall and install libraries, data, \ executables and documents."; "-clean", arg_handle ~allow_empty_env:true clean, s_ "[options*] Clean files generated by a build."; "-distclean", arg_handle ~allow_empty_env:true distclean, s_ "[options*] Clean files generated by a build and configure."; "-version", arg_handle ~allow_empty_env:true version, s_ " Display version of OASIS used to generate this setup.ml."; "-no-catch-exn", Arg.Clear catch_exn, s_ " Don't catch exception, useful for debugging."; ] @ (if t.setup_update then [no_update_setup_ml_cli] else []) @ (BaseContext.args ()))) (failwithf (f_ "Don't know what to do with '%s'")) (s_ "Setup and run build process current package\n") in (* Instantiate the context. *) let ctxt = !BaseContext.default in (* Build initial environment *) load ~ctxt ~allow_empty:!allow_empty_env_ref (); (** Initialize flags *) List.iter (function | Flag (cs, {flag_description = hlp; flag_default = choices}) -> begin let apply ?short_desc () = var_ignore (var_define ~cli:CLIEnable ?short_desc (OASISUtils.varname_of_string cs.cs_name) (fun () -> string_of_bool (var_choose ~name:(Printf.sprintf (f_ "default value of flag %s") cs.cs_name) ~printer:string_of_bool choices))) in match hlp with | Some hlp -> apply ~short_desc:(fun () -> hlp) () | None -> apply () end | _ -> ()) t.package.sections; BaseStandardVar.init t.package; BaseDynVar.init ~ctxt t.package; if not (t.setup_update && update_setup_ml t) then !act_ref ~ctxt t (Array.of_list (List.rev !extra_args_ref)) with e when !catch_exn -> error "%s" (Printexc.to_string e); exit 1 end module BaseCompat = struct (* # 22 "src/base/BaseCompat.ml" *) (** Compatibility layer to provide a stable API inside setup.ml. This layer allows OASIS to change in between minor versions (e.g. 0.4.6 -> 0.4.7) but still provides a stable API inside setup.ml. This enables to write functions that manipulate setup_t inside setup.ml. See deps.ml for an example. The module opened by default will depend on the version of the _oasis. E.g. if we have "OASISFormat: 0.3", the module Compat_0_3 will be opened and the function Compat_0_3 will be called. If setup.ml is generated with the -nocompat, no module will be opened. @author Sylvain Le Gall *) module Compat_0_4 = struct let rctxt = ref !BaseContext.default module BaseSetup = struct module Original = BaseSetup open OASISTypes type std_args_fun = package -> string array -> unit type ('a, 'b) section_args_fun = name * (package -> (common_section * 'a) -> string array -> 'b) type t = { configure: std_args_fun; build: std_args_fun; doc: ((doc, unit) section_args_fun) list; test: ((test, float) section_args_fun) list; install: std_args_fun; uninstall: std_args_fun; clean: std_args_fun list; clean_doc: (doc, unit) section_args_fun list; clean_test: (test, unit) section_args_fun list; distclean: std_args_fun list; distclean_doc: (doc, unit) section_args_fun list; distclean_test: (test, unit) section_args_fun list; package: package; oasis_fn: string option; oasis_version: string; oasis_digest: Digest.t option; oasis_exec: string option; oasis_setup_args: string list; setup_update: bool; } let setup t = let mk_std_args_fun f = fun ~ctxt pkg args -> rctxt := ctxt; f pkg args in let mk_section_args_fun l = List.map (fun (nm, f) -> nm, (fun ~ctxt pkg sct args -> rctxt := ctxt; f pkg sct args)) l in let t' = { Original. configure = mk_std_args_fun t.configure; build = mk_std_args_fun t.build; doc = mk_section_args_fun t.doc; test = mk_section_args_fun t.test; install = mk_std_args_fun t.install; uninstall = mk_std_args_fun t.uninstall; clean = List.map mk_std_args_fun t.clean; clean_doc = mk_section_args_fun t.clean_doc; clean_test = mk_section_args_fun t.clean_test; distclean = List.map mk_std_args_fun t.distclean; distclean_doc = mk_section_args_fun t.distclean_doc; distclean_test = mk_section_args_fun t.distclean_test; package = t.package; oasis_fn = t.oasis_fn; oasis_version = t.oasis_version; oasis_digest = t.oasis_digest; oasis_exec = t.oasis_exec; oasis_setup_args = t.oasis_setup_args; setup_update = t.setup_update; } in Original.setup t' end let adapt_setup_t setup_t = let module O = BaseSetup.Original in let mk_std_args_fun f = fun pkg args -> f ~ctxt:!rctxt pkg args in let mk_section_args_fun l = List.map (fun (nm, f) -> nm, (fun pkg sct args -> f ~ctxt:!rctxt pkg sct args)) l in { BaseSetup. configure = mk_std_args_fun setup_t.O.configure; build = mk_std_args_fun setup_t.O.build; doc = mk_section_args_fun setup_t.O.doc; test = mk_section_args_fun setup_t.O.test; install = mk_std_args_fun setup_t.O.install; uninstall = mk_std_args_fun setup_t.O.uninstall; clean = List.map mk_std_args_fun setup_t.O.clean; clean_doc = mk_section_args_fun setup_t.O.clean_doc; clean_test = mk_section_args_fun setup_t.O.clean_test; distclean = List.map mk_std_args_fun setup_t.O.distclean; distclean_doc = mk_section_args_fun setup_t.O.distclean_doc; distclean_test = mk_section_args_fun setup_t.O.distclean_test; package = setup_t.O.package; oasis_fn = setup_t.O.oasis_fn; oasis_version = setup_t.O.oasis_version; oasis_digest = setup_t.O.oasis_digest; oasis_exec = setup_t.O.oasis_exec; oasis_setup_args = setup_t.O.oasis_setup_args; setup_update = setup_t.O.setup_update; } end module Compat_0_3 = struct include Compat_0_4 end end # 5662 "setup.ml" module InternalConfigurePlugin = struct (* # 22 "src/plugins/internal/InternalConfigurePlugin.ml" *) (** Configure using internal scheme @author Sylvain Le Gall *) open BaseEnv open OASISTypes open OASISUtils open OASISGettext open BaseMessage (** Configure build using provided series of check to be done and then output corresponding file. *) let configure ~ctxt:_ pkg argv = let var_ignore_eval var = let _s: string = var () in () in let errors = ref SetString.empty in let buff = Buffer.create 13 in let add_errors fmt = Printf.kbprintf (fun b -> errors := SetString.add (Buffer.contents b) !errors; Buffer.clear b) buff fmt in let warn_exception e = warning "%s" (Printexc.to_string e) in (* Check tools *) let check_tools lst = List.iter (function | ExternalTool tool -> begin try var_ignore_eval (BaseCheck.prog tool) with e -> warn_exception e; add_errors (f_ "Cannot find external tool '%s'") tool end | InternalExecutable nm1 -> (* Check that matching tool is built *) List.iter (function | Executable ({cs_name = nm2; _}, {bs_build = build; _}, _) when nm1 = nm2 -> if not (var_choose build) then add_errors (f_ "Cannot find buildable internal executable \ '%s' when checking build depends") nm1 | _ -> ()) pkg.sections) lst in let build_checks sct bs = if var_choose bs.bs_build then begin if bs.bs_compiled_object = Native then begin try var_ignore_eval BaseStandardVar.ocamlopt with e -> warn_exception e; add_errors (f_ "Section %s requires native compilation") (OASISSection.string_of_section sct) end; (* Check tools *) check_tools bs.bs_build_tools; (* Check depends *) List.iter (function | FindlibPackage (findlib_pkg, version_comparator) -> begin try var_ignore_eval (BaseCheck.package ?version_comparator findlib_pkg) with e -> warn_exception e; match version_comparator with | None -> add_errors (f_ "Cannot find findlib package %s") findlib_pkg | Some ver_cmp -> add_errors (f_ "Cannot find findlib package %s (%s)") findlib_pkg (OASISVersion.string_of_comparator ver_cmp) end | InternalLibrary nm1 -> (* Check that matching library is built *) List.iter (function | Library ({cs_name = nm2; _}, {bs_build = build; _}, _) when nm1 = nm2 -> if not (var_choose build) then add_errors (f_ "Cannot find buildable internal library \ '%s' when checking build depends") nm1 | _ -> ()) pkg.sections) bs.bs_build_depends end in (* Parse command line *) BaseArgExt.parse argv (BaseEnv.args ()); (* OCaml version *) begin match pkg.ocaml_version with | Some ver_cmp -> begin try var_ignore_eval (BaseCheck.version "ocaml" ver_cmp BaseStandardVar.ocaml_version) with e -> warn_exception e; add_errors (f_ "OCaml version %s doesn't match version constraint %s") (BaseStandardVar.ocaml_version ()) (OASISVersion.string_of_comparator ver_cmp) end | None -> () end; (* Findlib version *) begin match pkg.findlib_version with | Some ver_cmp -> begin try var_ignore_eval (BaseCheck.version "findlib" ver_cmp BaseStandardVar.findlib_version) with e -> warn_exception e; add_errors (f_ "Findlib version %s doesn't match version constraint %s") (BaseStandardVar.findlib_version ()) (OASISVersion.string_of_comparator ver_cmp) end | None -> () end; (* Make sure the findlib version is fine for the OCaml compiler. *) begin let ocaml_ge4 = OASISVersion.version_compare (OASISVersion.version_of_string (BaseStandardVar.ocaml_version ())) (OASISVersion.version_of_string "4.0.0") >= 0 in if ocaml_ge4 then let findlib_lt132 = OASISVersion.version_compare (OASISVersion.version_of_string (BaseStandardVar.findlib_version())) (OASISVersion.version_of_string "1.3.2") < 0 in if findlib_lt132 then add_errors "OCaml >= 4.0.0 requires Findlib version >= 1.3.2" end; (* FlexDLL *) if BaseStandardVar.os_type () = "Win32" || BaseStandardVar.os_type () = "Cygwin" then begin try var_ignore_eval BaseStandardVar.flexlink with e -> warn_exception e; add_errors (f_ "Cannot find 'flexlink'") end; (* Check build depends *) List.iter (function | Executable (_, bs, _) | Library (_, bs, _) as sct -> build_checks sct bs | Doc (_, doc) -> if var_choose doc.doc_build then check_tools doc.doc_build_tools | Test (_, test) -> if var_choose test.test_run then check_tools test.test_tools | _ -> ()) pkg.sections; (* Check if we need native dynlink (presence of libraries that compile to native) *) begin let has_cmxa = List.exists (function | Library (_, bs, _) -> var_choose bs.bs_build && (bs.bs_compiled_object = Native || (bs.bs_compiled_object = Best && bool_of_string (BaseStandardVar.is_native ()))) | _ -> false) pkg.sections in if has_cmxa then var_ignore_eval BaseStandardVar.native_dynlink end; (* Check errors *) if SetString.empty != !errors then begin List.iter (fun e -> error "%s" e) (SetString.elements !errors); failwithf (fn_ "%d configuration error" "%d configuration errors" (SetString.cardinal !errors)) (SetString.cardinal !errors) end end module InternalInstallPlugin = struct (* # 22 "src/plugins/internal/InternalInstallPlugin.ml" *) (** Install using internal scheme @author Sylvain Le Gall *) (* TODO: rewrite this module with OASISFileSystem. *) open BaseEnv open BaseStandardVar open BaseMessage open OASISTypes open OASISFindlib open OASISGettext open OASISUtils let exec_hook = ref (fun (cs, bs, exec) -> cs, bs, exec) let lib_hook = ref (fun (cs, bs, dn, lib) -> cs, bs, dn, lib, []) let obj_hook = ref (fun (cs, bs, dn, obj) -> cs, bs, dn, obj, []) let doc_hook = ref (fun (cs, doc) -> cs, doc) let install_file_ev = "install-file" let install_dir_ev = "install-dir" let install_findlib_ev = "install-findlib" (* TODO: this can be more generic and used elsewhere. *) let win32_max_command_line_length = 8000 let split_install_command ocamlfind findlib_name meta files = if Sys.os_type = "Win32" then (* Arguments for the first command: *) let first_args = ["install"; findlib_name; meta] in (* Arguments for remaining commands: *) let other_args = ["install"; findlib_name; "-add"] in (* Extract as much files as possible from [files], [len] is the current command line length: *) let rec get_files len acc files = match files with | [] -> (List.rev acc, []) | file :: rest -> let len = len + 1 + String.length file in if len > win32_max_command_line_length then (List.rev acc, files) else get_files len (file :: acc) rest in (* Split the command into several commands. *) let rec split args files = match files with | [] -> [] | _ -> (* Length of "ocamlfind install [META|-add]" *) let len = List.fold_left (fun len arg -> len + 1 (* for the space *) + String.length arg) (String.length ocamlfind) args in match get_files len [] files with | ([], _) -> failwith (s_ "Command line too long.") | (firsts, others) -> let cmd = args @ firsts in (* Use -add for remaining commands: *) let () = let findlib_ge_132 = OASISVersion.comparator_apply (OASISVersion.version_of_string (BaseStandardVar.findlib_version ())) (OASISVersion.VGreaterEqual (OASISVersion.version_of_string "1.3.2")) in if not findlib_ge_132 then failwithf (f_ "Installing the library %s require to use the \ flag '-add' of ocamlfind because the command \ line is too long. This flag is only available \ for findlib 1.3.2. Please upgrade findlib from \ %s to 1.3.2") findlib_name (BaseStandardVar.findlib_version ()) in let cmds = split other_args others in cmd :: cmds in (* The first command does not use -add: *) split first_args files else ["install" :: findlib_name :: meta :: files] let install = let in_destdir fn = try (* Practically speaking destdir is prepended at the beginning of the target filename *) (destdir ())^fn with PropList.Not_set _ -> fn in let install_file ~ctxt ?(prepend_destdir=true) ?tgt_fn src_file envdir = let tgt_dir = if prepend_destdir then in_destdir (envdir ()) else envdir () in let tgt_file = Filename.concat tgt_dir (match tgt_fn with | Some fn -> fn | None -> Filename.basename src_file) in (* Create target directory if needed *) OASISFileUtil.mkdir_parent ~ctxt (fun dn -> info (f_ "Creating directory '%s'") dn; BaseLog.register ~ctxt install_dir_ev dn) (Filename.dirname tgt_file); (* Really install files *) info (f_ "Copying file '%s' to '%s'") src_file tgt_file; OASISFileUtil.cp ~ctxt src_file tgt_file; BaseLog.register ~ctxt install_file_ev tgt_file in (* Install the files for a library. *) let install_lib_files ~ctxt findlib_name files = let findlib_dir = let dn = let findlib_destdir = OASISExec.run_read_one_line ~ctxt (ocamlfind ()) ["printconf" ; "destdir"] in Filename.concat findlib_destdir findlib_name in fun () -> dn in let () = if not (OASISFileUtil.file_exists_case (findlib_dir ())) then failwithf (f_ "Directory '%s' doesn't exist for findlib library %s") (findlib_dir ()) findlib_name in let f dir file = let basename = Filename.basename file in let tgt_fn = Filename.concat dir basename in (* Destdir is already include in printconf. *) install_file ~ctxt ~prepend_destdir:false ~tgt_fn file findlib_dir in List.iter (fun (dir, files) -> List.iter (f dir) files) files ; in (* Install data into defined directory *) let install_data ~ctxt srcdir lst tgtdir = let tgtdir = OASISHostPath.of_unix (var_expand tgtdir) in List.iter (fun (src, tgt_opt) -> let real_srcs = OASISFileUtil.glob ~ctxt:!BaseContext.default (Filename.concat srcdir src) in if real_srcs = [] then failwithf (f_ "Wildcard '%s' doesn't match any files") src; List.iter (fun fn -> install_file ~ctxt fn (fun () -> match tgt_opt with | Some s -> OASISHostPath.of_unix (var_expand s) | None -> tgtdir)) real_srcs) lst in let make_fnames modul sufx = List.fold_right begin fun sufx accu -> (OASISString.capitalize_ascii modul ^ sufx) :: (OASISString.uncapitalize_ascii modul ^ sufx) :: accu end sufx [] in (** Install all libraries *) let install_libs ~ctxt pkg = let find_first_existing_files_in_path bs lst = let path = OASISHostPath.of_unix bs.bs_path in List.find OASISFileUtil.file_exists_case (List.map (Filename.concat path) lst) in let files_of_modules new_files typ cs bs modules = List.fold_left (fun acc modul -> begin try (* Add uncompiled header from the source tree *) [find_first_existing_files_in_path bs (make_fnames modul [".mli"; ".ml"])] with Not_found -> warning (f_ "Cannot find source header for module %s \ in %s %s") typ modul cs.cs_name; [] end @ List.fold_left (fun acc fn -> try find_first_existing_files_in_path bs [fn] :: acc with Not_found -> acc) acc (make_fnames modul [".annot";".cmti";".cmt"])) new_files modules in let files_of_build_section (f_data, new_files) typ cs bs = let extra_files = List.map (fun fn -> try find_first_existing_files_in_path bs [fn] with Not_found -> failwithf (f_ "Cannot find extra findlib file %S in %s %s ") fn typ cs.cs_name) bs.bs_findlib_extra_files in let f_data () = (* Install data associated with the library *) install_data ~ctxt bs.bs_path bs.bs_data_files (Filename.concat (datarootdir ()) pkg.name); f_data () in f_data, new_files @ extra_files in let files_of_library (f_data, acc) data_lib = let cs, bs, lib, dn, lib_extra = !lib_hook data_lib in if var_choose bs.bs_install && BaseBuilt.is_built ~ctxt BaseBuilt.BLib cs.cs_name then begin (* Start with lib_extra *) let new_files = lib_extra in let new_files = files_of_modules new_files "library" cs bs lib.lib_modules in let f_data, new_files = files_of_build_section (f_data, new_files) "library" cs bs in let new_files = (* Get generated files *) BaseBuilt.fold ~ctxt BaseBuilt.BLib cs.cs_name (fun acc fn -> fn :: acc) new_files in let acc = (dn, new_files) :: acc in let f_data () = (* Install data associated with the library *) install_data ~ctxt bs.bs_path bs.bs_data_files (Filename.concat (datarootdir ()) pkg.name); f_data () in (f_data, acc) end else begin (f_data, acc) end and files_of_object (f_data, acc) data_obj = let cs, bs, obj, dn, obj_extra = !obj_hook data_obj in if var_choose bs.bs_install && BaseBuilt.is_built ~ctxt BaseBuilt.BObj cs.cs_name then begin (* Start with obj_extra *) let new_files = obj_extra in let new_files = files_of_modules new_files "object" cs bs obj.obj_modules in let f_data, new_files = files_of_build_section (f_data, new_files) "object" cs bs in let new_files = (* Get generated files *) BaseBuilt.fold ~ctxt BaseBuilt.BObj cs.cs_name (fun acc fn -> fn :: acc) new_files in let acc = (dn, new_files) :: acc in let f_data () = (* Install data associated with the object *) install_data ~ctxt bs.bs_path bs.bs_data_files (Filename.concat (datarootdir ()) pkg.name); f_data () in (f_data, acc) end else begin (f_data, acc) end in (* Install one group of library *) let install_group_lib grp = (* Iterate through all group nodes *) let rec install_group_lib_aux data_and_files grp = let data_and_files, children = match grp with | Container (_, children) -> data_and_files, children | Package (_, cs, bs, `Library lib, dn, children) -> files_of_library data_and_files (cs, bs, lib, dn), children | Package (_, cs, bs, `Object obj, dn, children) -> files_of_object data_and_files (cs, bs, obj, dn), children in List.fold_left install_group_lib_aux data_and_files children in (* Findlib name of the root library *) let findlib_name = findlib_of_group grp in (* Determine root library *) let root_lib = root_of_group grp in (* All files to install for this library *) let f_data, files = install_group_lib_aux (ignore, []) grp in (* Really install, if there is something to install *) if files = [] then begin warning (f_ "Nothing to install for findlib library '%s'") findlib_name end else begin let meta = (* Search META file *) let _, bs, _ = root_lib in let res = Filename.concat bs.bs_path "META" in if not (OASISFileUtil.file_exists_case res) then failwithf (f_ "Cannot find file '%s' for findlib library %s") res findlib_name; res in let files = (* Make filename shorter to avoid hitting command max line length * too early, esp. on Windows. *) (* TODO: move to OASISHostPath as make_relative. *) let remove_prefix p n = let plen = String.length p in let nlen = String.length n in if plen <= nlen && String.sub n 0 plen = p then begin let fn_sep = if Sys.os_type = "Win32" then '\\' else '/' in let cutpoint = plen + (if plen < nlen && n.[plen] = fn_sep then 1 else 0) in String.sub n cutpoint (nlen - cutpoint) end else begin n end in List.map (fun (dir, fn) -> (dir, List.map (remove_prefix (Sys.getcwd ())) fn)) files in let ocamlfind = ocamlfind () in let nodir_files, dir_files = List.fold_left (fun (nodir, dir) (dn, lst) -> match dn with | Some dn -> nodir, (dn, lst) :: dir | None -> lst @ nodir, dir) ([], []) (List.rev files) in info (f_ "Installing findlib library '%s'") findlib_name; List.iter (OASISExec.run ~ctxt ocamlfind) (split_install_command ocamlfind findlib_name meta nodir_files); install_lib_files ~ctxt findlib_name dir_files; BaseLog.register ~ctxt install_findlib_ev findlib_name end; (* Install data files *) f_data (); in let group_libs, _, _ = findlib_mapping pkg in (* We install libraries in groups *) List.iter install_group_lib group_libs in let install_execs ~ctxt pkg = let install_exec data_exec = let cs, bs, _ = !exec_hook data_exec in if var_choose bs.bs_install && BaseBuilt.is_built ~ctxt BaseBuilt.BExec cs.cs_name then begin let exec_libdir () = Filename.concat (libdir ()) pkg.name in BaseBuilt.fold ~ctxt BaseBuilt.BExec cs.cs_name (fun () fn -> install_file ~ctxt ~tgt_fn:(cs.cs_name ^ ext_program ()) fn bindir) (); BaseBuilt.fold ~ctxt BaseBuilt.BExecLib cs.cs_name (fun () fn -> install_file ~ctxt fn exec_libdir) (); install_data ~ctxt bs.bs_path bs.bs_data_files (Filename.concat (datarootdir ()) pkg.name) end in List.iter (function | Executable (cs, bs, exec)-> install_exec (cs, bs, exec) | _ -> ()) pkg.sections in let install_docs ~ctxt pkg = let install_doc data = let cs, doc = !doc_hook data in if var_choose doc.doc_install && BaseBuilt.is_built ~ctxt BaseBuilt.BDoc cs.cs_name then begin let tgt_dir = OASISHostPath.of_unix (var_expand doc.doc_install_dir) in BaseBuilt.fold ~ctxt BaseBuilt.BDoc cs.cs_name (fun () fn -> install_file ~ctxt fn (fun () -> tgt_dir)) (); install_data ~ctxt Filename.current_dir_name doc.doc_data_files doc.doc_install_dir end in List.iter (function | Doc (cs, doc) -> install_doc (cs, doc) | _ -> ()) pkg.sections in fun ~ctxt pkg _ -> install_libs ~ctxt pkg; install_execs ~ctxt pkg; install_docs ~ctxt pkg (* Uninstall already installed data *) let uninstall ~ctxt _ _ = let uninstall_aux (ev, data) = if ev = install_file_ev then begin if OASISFileUtil.file_exists_case data then begin info (f_ "Removing file '%s'") data; Sys.remove data end else begin warning (f_ "File '%s' doesn't exist anymore") data end end else if ev = install_dir_ev then begin if Sys.file_exists data && Sys.is_directory data then begin if Sys.readdir data = [||] then begin info (f_ "Removing directory '%s'") data; OASISFileUtil.rmdir ~ctxt data end else begin warning (f_ "Directory '%s' is not empty (%s)") data (String.concat ", " (Array.to_list (Sys.readdir data))) end end else begin warning (f_ "Directory '%s' doesn't exist anymore") data end end else if ev = install_findlib_ev then begin info (f_ "Removing findlib library '%s'") data; OASISExec.run ~ctxt (ocamlfind ()) ["remove"; data] end else begin failwithf (f_ "Unknown log event '%s'") ev; end; BaseLog.unregister ~ctxt ev data in (* We process event in reverse order *) List.iter uninstall_aux (List.rev (BaseLog.filter ~ctxt [install_file_ev; install_dir_ev])); List.iter uninstall_aux (List.rev (BaseLog.filter ~ctxt [install_findlib_ev])) end # 6465 "setup.ml" module OCamlbuildCommon = struct (* # 22 "src/plugins/ocamlbuild/OCamlbuildCommon.ml" *) (** Functions common to OCamlbuild build and doc plugin *) open OASISGettext open BaseEnv open BaseStandardVar open OASISTypes type extra_args = string list let ocamlbuild_clean_ev = "ocamlbuild-clean" let ocamlbuildflags = var_define ~short_desc:(fun () -> "OCamlbuild additional flags") "ocamlbuildflags" (fun () -> "") (** Fix special arguments depending on environment *) let fix_args args extra_argv = List.flatten [ if (os_type ()) = "Win32" then [ "-classic-display"; "-no-log"; "-no-links"; ] else []; if OASISVersion.comparator_apply (OASISVersion.version_of_string (ocaml_version ())) (OASISVersion.VLesser (OASISVersion.version_of_string "3.11.1")) then [ "-install-lib-dir"; (Filename.concat (standard_library ()) "ocamlbuild") ] else []; if not (bool_of_string (is_native ())) || (os_type ()) = "Win32" then [ "-byte-plugin" ] else []; args; if bool_of_string (debug ()) then ["-tag"; "debug"] else []; if bool_of_string (tests ()) then ["-tag"; "tests"] else []; if bool_of_string (profile ()) then ["-tag"; "profile"] else []; OASISString.nsplit (ocamlbuildflags ()) ' '; Array.to_list extra_argv; ] (** Run 'ocamlbuild -clean' if not already done *) let run_clean ~ctxt extra_argv = let extra_cli = String.concat " " (Array.to_list extra_argv) in (* Run if never called with these args *) if not (BaseLog.exists ~ctxt ocamlbuild_clean_ev extra_cli) then begin OASISExec.run ~ctxt (ocamlbuild ()) (fix_args ["-clean"] extra_argv); BaseLog.register ~ctxt ocamlbuild_clean_ev extra_cli; at_exit (fun () -> try BaseLog.unregister ~ctxt ocamlbuild_clean_ev extra_cli with _ -> ()) end (** Run ocamlbuild, unregister all clean events *) let run_ocamlbuild ~ctxt args extra_argv = (* TODO: enforce that target in args must be UNIX encoded i.e. toto/index.html *) OASISExec.run ~ctxt (ocamlbuild ()) (fix_args args extra_argv); (* Remove any clean event, we must run it again *) List.iter (fun (e, d) -> BaseLog.unregister ~ctxt e d) (BaseLog.filter ~ctxt [ocamlbuild_clean_ev]) (** Determine real build directory *) let build_dir extra_argv = let rec search_args dir = function | "-build-dir" :: dir :: tl -> search_args dir tl | _ :: tl -> search_args dir tl | [] -> dir in search_args "_build" (fix_args [] extra_argv) end module OCamlbuildPlugin = struct (* # 22 "src/plugins/ocamlbuild/OCamlbuildPlugin.ml" *) (** Build using ocamlbuild @author Sylvain Le Gall *) open OASISTypes open OASISGettext open OASISUtils open OASISString open BaseEnv open OCamlbuildCommon open BaseStandardVar let cond_targets_hook = ref (fun lst -> lst) let build ~ctxt extra_args pkg argv = (* Return the filename in build directory *) let in_build_dir fn = Filename.concat (build_dir argv) fn in (* Return the unix filename in host build directory *) let in_build_dir_of_unix fn = in_build_dir (OASISHostPath.of_unix fn) in let cond_targets = List.fold_left (fun acc -> function | Library (cs, bs, lib) when var_choose bs.bs_build -> begin let evs, unix_files = BaseBuilt.of_library in_build_dir_of_unix (cs, bs, lib) in let tgts = List.flatten (List.filter (fun l -> l <> []) (List.map (List.filter (fun fn -> ends_with ~what:".cma" fn || ends_with ~what:".cmxs" fn || ends_with ~what:".cmxa" fn || ends_with ~what:(ext_lib ()) fn || ends_with ~what:(ext_dll ()) fn)) unix_files)) in match tgts with | _ :: _ -> (evs, tgts) :: acc | [] -> failwithf (f_ "No possible ocamlbuild targets for library %s") cs.cs_name end | Object (cs, bs, obj) when var_choose bs.bs_build -> begin let evs, unix_files = BaseBuilt.of_object in_build_dir_of_unix (cs, bs, obj) in let tgts = List.flatten (List.filter (fun l -> l <> []) (List.map (List.filter (fun fn -> ends_with ~what:".cmo" fn || ends_with ~what:".cmx" fn)) unix_files)) in match tgts with | _ :: _ -> (evs, tgts) :: acc | [] -> failwithf (f_ "No possible ocamlbuild targets for object %s") cs.cs_name end | Executable (cs, bs, exec) when var_choose bs.bs_build -> begin let evs, _, _ = BaseBuilt.of_executable in_build_dir_of_unix (cs, bs, exec) in let target ext = let unix_tgt = (OASISUnixPath.concat bs.bs_path (OASISUnixPath.chop_extension exec.exec_main_is))^ext in let evs = (* Fix evs, we want to use the unix_tgt, without copying *) List.map (function | BaseBuilt.BExec, nm, _ when nm = cs.cs_name -> BaseBuilt.BExec, nm, [[in_build_dir_of_unix unix_tgt]] | ev -> ev) evs in evs, [unix_tgt] in (* Add executable *) let acc = match bs.bs_compiled_object with | Native -> (target ".native") :: acc | Best when bool_of_string (is_native ()) -> (target ".native") :: acc | Byte | Best -> (target ".byte") :: acc in acc end | Library _ | Object _ | Executable _ | Test _ | SrcRepo _ | Flag _ | Doc _ -> acc) [] (* Keep the pkg.sections ordered *) (List.rev pkg.sections); in (* Check and register built files *) let check_and_register (bt, bnm, lst) = List.iter (fun fns -> if not (List.exists OASISFileUtil.file_exists_case fns) then failwithf (fn_ "Expected built file %s doesn't exist." "None of expected built files %s exists." (List.length fns)) (String.concat (s_ " or ") (List.map (Printf.sprintf "'%s'") fns))) lst; (BaseBuilt.register ~ctxt bt bnm lst) in (* Run the hook *) let cond_targets = !cond_targets_hook cond_targets in (* Run a list of target... *) run_ocamlbuild ~ctxt (List.flatten (List.map snd cond_targets) @ extra_args) argv; (* ... and register events *) List.iter check_and_register (List.flatten (List.map fst cond_targets)) let clean ~ctxt pkg extra_args = run_clean ~ctxt extra_args; List.iter (function | Library (cs, _, _) -> BaseBuilt.unregister ~ctxt BaseBuilt.BLib cs.cs_name | Executable (cs, _, _) -> BaseBuilt.unregister ~ctxt BaseBuilt.BExec cs.cs_name; BaseBuilt.unregister ~ctxt BaseBuilt.BExecLib cs.cs_name | _ -> ()) pkg.sections end module OCamlbuildDocPlugin = struct (* # 22 "src/plugins/ocamlbuild/OCamlbuildDocPlugin.ml" *) (* Create documentation using ocamlbuild .odocl files @author Sylvain Le Gall *) open OASISTypes open OASISGettext open OCamlbuildCommon type run_t = { extra_args: string list; run_path: unix_filename; } let doc_build ~ctxt run _ (cs, _) argv = let index_html = OASISUnixPath.make [ run.run_path; cs.cs_name^".docdir"; "index.html"; ] in let tgt_dir = OASISHostPath.make [ build_dir argv; OASISHostPath.of_unix run.run_path; cs.cs_name^".docdir"; ] in run_ocamlbuild ~ctxt (index_html :: run.extra_args) argv; List.iter (fun glb -> match OASISFileUtil.glob ~ctxt (Filename.concat tgt_dir glb) with | (_ :: _) as filenames -> BaseBuilt.register ~ctxt BaseBuilt.BDoc cs.cs_name [filenames] | [] -> ()) ["*.html"; "*.css"] let doc_clean ~ctxt _ _ (cs, _) argv = run_clean ~ctxt argv; BaseBuilt.unregister ~ctxt BaseBuilt.BDoc cs.cs_name end # 6837 "setup.ml" module CustomPlugin = struct (* # 22 "src/plugins/custom/CustomPlugin.ml" *) (** Generate custom configure/build/doc/test/install system @author *) open BaseEnv open OASISGettext open OASISTypes type t = { cmd_main: command_line conditional; cmd_clean: (command_line option) conditional; cmd_distclean: (command_line option) conditional; } let run = BaseCustom.run let main ~ctxt:_ t _ extra_args = let cmd, args = var_choose ~name:(s_ "main command") t.cmd_main in run cmd args extra_args let clean ~ctxt:_ t _ extra_args = match var_choose t.cmd_clean with | Some (cmd, args) -> run cmd args extra_args | _ -> () let distclean ~ctxt:_ t _ extra_args = match var_choose t.cmd_distclean with | Some (cmd, args) -> run cmd args extra_args | _ -> () module Build = struct let main ~ctxt t pkg extra_args = main ~ctxt t pkg extra_args; List.iter (fun sct -> let evs = match sct with | Library (cs, bs, lib) when var_choose bs.bs_build -> begin let evs, _ = BaseBuilt.of_library OASISHostPath.of_unix (cs, bs, lib) in evs end | Executable (cs, bs, exec) when var_choose bs.bs_build -> begin let evs, _, _ = BaseBuilt.of_executable OASISHostPath.of_unix (cs, bs, exec) in evs end | _ -> [] in List.iter (fun (bt, bnm, lst) -> BaseBuilt.register ~ctxt bt bnm lst) evs) pkg.sections let clean ~ctxt t pkg extra_args = clean ~ctxt t pkg extra_args; (* TODO: this seems to be pretty generic (at least wrt to ocamlbuild * considering moving this to BaseSetup? *) List.iter (function | Library (cs, _, _) -> BaseBuilt.unregister ~ctxt BaseBuilt.BLib cs.cs_name | Executable (cs, _, _) -> BaseBuilt.unregister ~ctxt BaseBuilt.BExec cs.cs_name; BaseBuilt.unregister ~ctxt BaseBuilt.BExecLib cs.cs_name | _ -> ()) pkg.sections let distclean ~ctxt t pkg extra_args = distclean ~ctxt t pkg extra_args end module Test = struct let main ~ctxt t pkg (cs, _) extra_args = try main ~ctxt t pkg extra_args; 0.0 with Failure s -> BaseMessage.warning (f_ "Test '%s' fails: %s") cs.cs_name s; 1.0 let clean ~ctxt t pkg _ extra_args = clean ~ctxt t pkg extra_args let distclean ~ctxt t pkg _ extra_args = distclean ~ctxt t pkg extra_args end module Doc = struct let main ~ctxt t pkg (cs, _) extra_args = main ~ctxt t pkg extra_args; BaseBuilt.register ~ctxt BaseBuilt.BDoc cs.cs_name [] let clean ~ctxt t pkg (cs, _) extra_args = clean ~ctxt t pkg extra_args; BaseBuilt.unregister ~ctxt BaseBuilt.BDoc cs.cs_name let distclean ~ctxt t pkg _ extra_args = distclean ~ctxt t pkg extra_args end end # 6969 "setup.ml" open OASISTypes;; let setup_t = { BaseSetup.configure = InternalConfigurePlugin.configure; build = OCamlbuildPlugin.build []; test = [ ("all", CustomPlugin.Test.main { CustomPlugin.cmd_main = [(OASISExpr.EBool true, ("make", ["test-all"]))]; cmd_clean = [(OASISExpr.EBool true, None)]; cmd_distclean = [(OASISExpr.EBool true, None)] }) ]; doc = [ ("gen", OCamlbuildDocPlugin.doc_build {OCamlbuildDocPlugin.extra_args = []; run_path = "src"}) ]; install = InternalInstallPlugin.install; uninstall = InternalInstallPlugin.uninstall; clean = [OCamlbuildPlugin.clean]; clean_test = [ ("all", CustomPlugin.Test.clean { CustomPlugin.cmd_main = [(OASISExpr.EBool true, ("make", ["test-all"]))]; cmd_clean = [(OASISExpr.EBool true, None)]; cmd_distclean = [(OASISExpr.EBool true, None)] }) ]; clean_doc = [ ("gen", OCamlbuildDocPlugin.doc_clean {OCamlbuildDocPlugin.extra_args = []; run_path = "src"}) ]; distclean = []; distclean_test = [ ("all", CustomPlugin.Test.distclean { CustomPlugin.cmd_main = [(OASISExpr.EBool true, ("make", ["test-all"]))]; cmd_clean = [(OASISExpr.EBool true, None)]; cmd_distclean = [(OASISExpr.EBool true, None)] }) ]; distclean_doc = []; package = { oasis_version = "0.3"; ocaml_version = None; version = "0.5"; license = OASISLicense.DEP5License (OASISLicense.DEP5Unit { OASISLicense.license = "BSD-3-clause"; excption = None; version = OASISLicense.NoVersion }); findlib_version = None; alpha_features = []; beta_features = []; name = "gen"; license_file = Some "LICENSE"; copyrights = []; maintainers = []; authors = ["Simon Cruanes"]; homepage = Some "https://github.com/c-cube/gen"; bugreports = None; synopsis = "Simple, efficient iterators for OCaml"; description = None; tags = []; categories = []; files_ab = []; sections = [ Flag ({ cs_name = "bench"; cs_data = PropList.Data.create (); cs_plugin_data = [] }, { flag_description = Some "build benchmark"; flag_default = [(OASISExpr.EBool true, false)] }); Library ({ cs_name = "gen"; cs_data = PropList.Data.create (); cs_plugin_data = [] }, { bs_build = [(OASISExpr.EBool true, true)]; bs_install = [(OASISExpr.EBool true, true)]; bs_path = "src"; bs_compiled_object = Best; bs_build_depends = []; bs_build_tools = [ExternalTool "ocamlbuild"]; bs_interface_patterns = [ { OASISSourcePatterns.Templater.atoms = [ OASISSourcePatterns.Templater.Text ""; OASISSourcePatterns.Templater.Expr (OASISSourcePatterns.Templater.Call ("capitalize_file", OASISSourcePatterns.Templater.Ident "module")); OASISSourcePatterns.Templater.Text ".mli" ]; origin = "${capitalize_file module}.mli" }; { OASISSourcePatterns.Templater.atoms = [ OASISSourcePatterns.Templater.Text ""; OASISSourcePatterns.Templater.Expr (OASISSourcePatterns.Templater.Call ("uncapitalize_file", OASISSourcePatterns.Templater.Ident "module")); OASISSourcePatterns.Templater.Text ".mli" ]; origin = "${uncapitalize_file module}.mli" } ]; bs_implementation_patterns = [ { OASISSourcePatterns.Templater.atoms = [ OASISSourcePatterns.Templater.Text ""; OASISSourcePatterns.Templater.Expr (OASISSourcePatterns.Templater.Call ("capitalize_file", OASISSourcePatterns.Templater.Ident "module")); OASISSourcePatterns.Templater.Text ".ml" ]; origin = "${capitalize_file module}.ml" }; { OASISSourcePatterns.Templater.atoms = [ OASISSourcePatterns.Templater.Text ""; OASISSourcePatterns.Templater.Expr (OASISSourcePatterns.Templater.Call ("uncapitalize_file", OASISSourcePatterns.Templater.Ident "module")); OASISSourcePatterns.Templater.Text ".ml" ]; origin = "${uncapitalize_file module}.ml" }; { OASISSourcePatterns.Templater.atoms = [ OASISSourcePatterns.Templater.Text ""; OASISSourcePatterns.Templater.Expr (OASISSourcePatterns.Templater.Call ("capitalize_file", OASISSourcePatterns.Templater.Ident "module")); OASISSourcePatterns.Templater.Text ".mll" ]; origin = "${capitalize_file module}.mll" }; { OASISSourcePatterns.Templater.atoms = [ OASISSourcePatterns.Templater.Text ""; OASISSourcePatterns.Templater.Expr (OASISSourcePatterns.Templater.Call ("uncapitalize_file", OASISSourcePatterns.Templater.Ident "module")); OASISSourcePatterns.Templater.Text ".mll" ]; origin = "${uncapitalize_file module}.mll" }; { OASISSourcePatterns.Templater.atoms = [ OASISSourcePatterns.Templater.Text ""; OASISSourcePatterns.Templater.Expr (OASISSourcePatterns.Templater.Call ("capitalize_file", OASISSourcePatterns.Templater.Ident "module")); OASISSourcePatterns.Templater.Text ".mly" ]; origin = "${capitalize_file module}.mly" }; { OASISSourcePatterns.Templater.atoms = [ OASISSourcePatterns.Templater.Text ""; OASISSourcePatterns.Templater.Expr (OASISSourcePatterns.Templater.Call ("uncapitalize_file", OASISSourcePatterns.Templater.Ident "module")); OASISSourcePatterns.Templater.Text ".mly" ]; origin = "${uncapitalize_file module}.mly" } ]; bs_c_sources = []; bs_data_files = []; bs_findlib_extra_files = []; bs_ccopt = [(OASISExpr.EBool true, [])]; bs_cclib = [(OASISExpr.EBool true, [])]; bs_dlllib = [(OASISExpr.EBool true, [])]; bs_dllpath = [(OASISExpr.EBool true, [])]; bs_byteopt = [(OASISExpr.EBool true, [])]; bs_nativeopt = [(OASISExpr.EBool true, [])] }, { lib_modules = [ "Gen"; "GenLabels"; "GenClone"; "GenMList"; "Gen_intf"; "GenLabels_intf"; "GenM"; "GenM_intf" ]; lib_pack = false; lib_internal_modules = []; lib_findlib_parent = None; lib_findlib_name = None; lib_findlib_directory = None; lib_findlib_containers = [] }); Doc ({ cs_name = "gen"; cs_data = PropList.Data.create (); cs_plugin_data = [] }, { doc_type = (`Doc, "ocamlbuild", Some "0.3"); doc_custom = { pre_command = [(OASISExpr.EBool true, None)]; post_command = [(OASISExpr.EBool true, None)] }; doc_build = [ (OASISExpr.ENot (OASISExpr.EFlag "docs"), false); (OASISExpr.EFlag "docs", true) ]; doc_install = [(OASISExpr.EBool true, true)]; doc_install_dir = "$docdir"; doc_title = "Containers docs"; doc_authors = []; doc_abstract = None; doc_format = OtherDoc; doc_data_files = []; doc_build_tools = [ExternalTool "ocamlbuild"; ExternalTool "ocamldoc"] }); Executable ({ cs_name = "run_qtest"; cs_data = PropList.Data.create (); cs_plugin_data = [] }, { bs_build = [ (OASISExpr.EBool true, false); (OASISExpr.EFlag "tests", true) ]; bs_install = [(OASISExpr.EBool true, false)]; bs_path = "qtest/"; bs_compiled_object = Native; bs_build_depends = [ InternalLibrary "gen"; FindlibPackage ("oUnit", None); FindlibPackage ("qcheck", None) ]; bs_build_tools = [ExternalTool "ocamlbuild"]; bs_interface_patterns = [ { OASISSourcePatterns.Templater.atoms = [ OASISSourcePatterns.Templater.Text ""; OASISSourcePatterns.Templater.Expr (OASISSourcePatterns.Templater.Call ("capitalize_file", OASISSourcePatterns.Templater.Ident "module")); OASISSourcePatterns.Templater.Text ".mli" ]; origin = "${capitalize_file module}.mli" }; { OASISSourcePatterns.Templater.atoms = [ OASISSourcePatterns.Templater.Text ""; OASISSourcePatterns.Templater.Expr (OASISSourcePatterns.Templater.Call ("uncapitalize_file", OASISSourcePatterns.Templater.Ident "module")); OASISSourcePatterns.Templater.Text ".mli" ]; origin = "${uncapitalize_file module}.mli" } ]; bs_implementation_patterns = [ { OASISSourcePatterns.Templater.atoms = [ OASISSourcePatterns.Templater.Text ""; OASISSourcePatterns.Templater.Expr (OASISSourcePatterns.Templater.Call ("capitalize_file", OASISSourcePatterns.Templater.Ident "module")); OASISSourcePatterns.Templater.Text ".ml" ]; origin = "${capitalize_file module}.ml" }; { OASISSourcePatterns.Templater.atoms = [ OASISSourcePatterns.Templater.Text ""; OASISSourcePatterns.Templater.Expr (OASISSourcePatterns.Templater.Call ("uncapitalize_file", OASISSourcePatterns.Templater.Ident "module")); OASISSourcePatterns.Templater.Text ".ml" ]; origin = "${uncapitalize_file module}.ml" }; { OASISSourcePatterns.Templater.atoms = [ OASISSourcePatterns.Templater.Text ""; OASISSourcePatterns.Templater.Expr (OASISSourcePatterns.Templater.Call ("capitalize_file", OASISSourcePatterns.Templater.Ident "module")); OASISSourcePatterns.Templater.Text ".mll" ]; origin = "${capitalize_file module}.mll" }; { OASISSourcePatterns.Templater.atoms = [ OASISSourcePatterns.Templater.Text ""; OASISSourcePatterns.Templater.Expr (OASISSourcePatterns.Templater.Call ("uncapitalize_file", OASISSourcePatterns.Templater.Ident "module")); OASISSourcePatterns.Templater.Text ".mll" ]; origin = "${uncapitalize_file module}.mll" }; { OASISSourcePatterns.Templater.atoms = [ OASISSourcePatterns.Templater.Text ""; OASISSourcePatterns.Templater.Expr (OASISSourcePatterns.Templater.Call ("capitalize_file", OASISSourcePatterns.Templater.Ident "module")); OASISSourcePatterns.Templater.Text ".mly" ]; origin = "${capitalize_file module}.mly" }; { OASISSourcePatterns.Templater.atoms = [ OASISSourcePatterns.Templater.Text ""; OASISSourcePatterns.Templater.Expr (OASISSourcePatterns.Templater.Call ("uncapitalize_file", OASISSourcePatterns.Templater.Ident "module")); OASISSourcePatterns.Templater.Text ".mly" ]; origin = "${uncapitalize_file module}.mly" } ]; bs_c_sources = []; bs_data_files = []; bs_findlib_extra_files = []; bs_ccopt = [(OASISExpr.EBool true, [])]; bs_cclib = [(OASISExpr.EBool true, [])]; bs_dlllib = [(OASISExpr.EBool true, [])]; bs_dllpath = [(OASISExpr.EBool true, [])]; bs_byteopt = [(OASISExpr.EBool true, [])]; bs_nativeopt = [(OASISExpr.EBool true, [])] }, {exec_custom = false; exec_main_is = "run_qtest.ml"}); Test ({ cs_name = "all"; cs_data = PropList.Data.create (); cs_plugin_data = [] }, { test_type = (`Test, "custom", Some "0.4"); test_command = [(OASISExpr.EBool true, ("make", ["test-all"]))]; test_custom = { pre_command = [(OASISExpr.EBool true, None)]; post_command = [(OASISExpr.EBool true, None)] }; test_working_directory = None; test_run = [ (OASISExpr.ENot (OASISExpr.EFlag "tests"), false); (OASISExpr.EFlag "tests", false); (OASISExpr.EAnd (OASISExpr.EFlag "tests", OASISExpr.EFlag "tests"), true) ]; test_tools = [ ExternalTool "ocamlbuild"; InternalExecutable "run_qtest" ] }); Executable ({ cs_name = "run_benchs"; cs_data = PropList.Data.create (); cs_plugin_data = [] }, { bs_build = [ (OASISExpr.EBool true, false); (OASISExpr.EFlag "bench", true) ]; bs_install = [(OASISExpr.EBool true, false)]; bs_path = "bench/"; bs_compiled_object = Native; bs_build_depends = [ InternalLibrary "gen"; FindlibPackage ("benchmark", None) ]; bs_build_tools = [ExternalTool "ocamlbuild"]; bs_interface_patterns = [ { OASISSourcePatterns.Templater.atoms = [ OASISSourcePatterns.Templater.Text ""; OASISSourcePatterns.Templater.Expr (OASISSourcePatterns.Templater.Call ("capitalize_file", OASISSourcePatterns.Templater.Ident "module")); OASISSourcePatterns.Templater.Text ".mli" ]; origin = "${capitalize_file module}.mli" }; { OASISSourcePatterns.Templater.atoms = [ OASISSourcePatterns.Templater.Text ""; OASISSourcePatterns.Templater.Expr (OASISSourcePatterns.Templater.Call ("uncapitalize_file", OASISSourcePatterns.Templater.Ident "module")); OASISSourcePatterns.Templater.Text ".mli" ]; origin = "${uncapitalize_file module}.mli" } ]; bs_implementation_patterns = [ { OASISSourcePatterns.Templater.atoms = [ OASISSourcePatterns.Templater.Text ""; OASISSourcePatterns.Templater.Expr (OASISSourcePatterns.Templater.Call ("capitalize_file", OASISSourcePatterns.Templater.Ident "module")); OASISSourcePatterns.Templater.Text ".ml" ]; origin = "${capitalize_file module}.ml" }; { OASISSourcePatterns.Templater.atoms = [ OASISSourcePatterns.Templater.Text ""; OASISSourcePatterns.Templater.Expr (OASISSourcePatterns.Templater.Call ("uncapitalize_file", OASISSourcePatterns.Templater.Ident "module")); OASISSourcePatterns.Templater.Text ".ml" ]; origin = "${uncapitalize_file module}.ml" }; { OASISSourcePatterns.Templater.atoms = [ OASISSourcePatterns.Templater.Text ""; OASISSourcePatterns.Templater.Expr (OASISSourcePatterns.Templater.Call ("capitalize_file", OASISSourcePatterns.Templater.Ident "module")); OASISSourcePatterns.Templater.Text ".mll" ]; origin = "${capitalize_file module}.mll" }; { OASISSourcePatterns.Templater.atoms = [ OASISSourcePatterns.Templater.Text ""; OASISSourcePatterns.Templater.Expr (OASISSourcePatterns.Templater.Call ("uncapitalize_file", OASISSourcePatterns.Templater.Ident "module")); OASISSourcePatterns.Templater.Text ".mll" ]; origin = "${uncapitalize_file module}.mll" }; { OASISSourcePatterns.Templater.atoms = [ OASISSourcePatterns.Templater.Text ""; OASISSourcePatterns.Templater.Expr (OASISSourcePatterns.Templater.Call ("capitalize_file", OASISSourcePatterns.Templater.Ident "module")); OASISSourcePatterns.Templater.Text ".mly" ]; origin = "${capitalize_file module}.mly" }; { OASISSourcePatterns.Templater.atoms = [ OASISSourcePatterns.Templater.Text ""; OASISSourcePatterns.Templater.Expr (OASISSourcePatterns.Templater.Call ("uncapitalize_file", OASISSourcePatterns.Templater.Ident "module")); OASISSourcePatterns.Templater.Text ".mly" ]; origin = "${uncapitalize_file module}.mly" } ]; bs_c_sources = []; bs_data_files = []; bs_findlib_extra_files = []; bs_ccopt = [(OASISExpr.EBool true, [])]; bs_cclib = [(OASISExpr.EBool true, [])]; bs_dlllib = [(OASISExpr.EBool true, [])]; bs_dllpath = [(OASISExpr.EBool true, [])]; bs_byteopt = [(OASISExpr.EBool true, [])]; bs_nativeopt = [(OASISExpr.EBool true, [])] }, {exec_custom = false; exec_main_is = "run_benchs.ml"}); SrcRepo ({ cs_name = "head"; cs_data = PropList.Data.create (); cs_plugin_data = [] }, { src_repo_type = Git; src_repo_location = "https://github.com/c-cube/gen"; src_repo_browser = Some "https://github.com/c-cube/gen/tree/master/src"; src_repo_module = None; src_repo_branch = None; src_repo_tag = None; src_repo_subdir = None }) ]; disable_oasis_section = []; conf_type = (`Configure, "internal", Some "0.4"); conf_custom = { pre_command = [(OASISExpr.EBool true, None)]; post_command = [(OASISExpr.EBool true, None)] }; build_type = (`Build, "ocamlbuild", Some "0.4"); build_custom = { pre_command = [(OASISExpr.EBool true, Some (("make", ["qtest-gen"])))]; post_command = [(OASISExpr.EBool true, None)] }; install_type = (`Install, "internal", Some "0.4"); install_custom = { pre_command = [(OASISExpr.EBool true, None)]; post_command = [(OASISExpr.EBool true, None)] }; uninstall_custom = { pre_command = [(OASISExpr.EBool true, None)]; post_command = [(OASISExpr.EBool true, None)] }; clean_custom = { pre_command = [(OASISExpr.EBool true, None)]; post_command = [(OASISExpr.EBool true, None)] }; distclean_custom = { pre_command = [(OASISExpr.EBool true, None)]; post_command = [(OASISExpr.EBool true, None)] }; plugins = [(`Extra, "META", Some "0.3"); (`Extra, "DevFiles", Some "0.3")]; schema_data = PropList.Data.create (); plugin_data = [] }; oasis_fn = Some "_oasis"; oasis_version = "0.4.10"; oasis_digest = Some "a\160Z`\015\243J!L\248\195\131\001\150\174\185"; oasis_exec = None; oasis_setup_args = []; setup_update = false };; let setup () = BaseSetup.setup setup_t;; # 7630 "setup.ml" let setup_t = BaseCompat.Compat_0_3.adapt_setup_t setup_t open BaseCompat.Compat_0_3 (* OASIS_STOP *) let () = setup ();; gen-0.5/src/000077500000000000000000000000001317735675300127375ustar00rootroot00000000000000gen-0.5/src/META000066400000000000000000000004571317735675300134160ustar00rootroot00000000000000# OASIS_START # DO NOT EDIT (digest: 269012fc28325763b841a31b10f860fc) version = "0.5" description = "Simple, efficient iterators for OCaml" archive(byte) = "gen.cma" archive(byte, plugin) = "gen.cma" archive(native) = "gen.cmxa" archive(native, plugin) = "gen.cmxs" exists_if = "gen.cma" # OASIS_STOP gen-0.5/src/gen.ml000066400000000000000000001437701317735675300140560ustar00rootroot00000000000000 (* This file is free software, part of gen. See file "license" for more details. *) (** {1 Restartable generators} *) (** {2 Global type declarations} *) type 'a t = unit -> 'a option type 'a gen = 'a t module type S = Gen_intf.S (*$inject let pint i = string_of_int i let pilist l = let b = Buffer.create 15 in let fmt = Format.formatter_of_buffer b in Format.fprintf fmt "%a@?" (Gen.pp Format.pp_print_int) (Gen.of_list l); Buffer.contents b let pi2list l = let b = Buffer.create 15 in let fmt = Format.formatter_of_buffer b in Format.fprintf fmt "%a@?" (Gen.pp (fun fmt (a,b) -> Format.fprintf fmt "%d,%d" a b)) (Gen.of_list l); Buffer.contents b let pstrlist l = let b = Buffer.create 15 in let fmt = Format.formatter_of_buffer b in Format.fprintf fmt "%a@?" (Gen.pp Format.pp_print_string) (Gen.of_list l); Buffer.contents b *) (** {2 Transient generators} *) let empty () = None (*$T empty empty |> to_list = [] *) let singleton x = let first = ref true in fun () -> if !first then (first := false; Some x) else None (*$T singleton singleton 1 |> to_list = [1] singleton "foo" |> to_list = ["foo"] *) (*$R let gen = Gen.singleton 42 in OUnit.assert_equal (Some 42) (Gen.get gen); OUnit.assert_equal None (Gen.get gen); let gen = Gen.singleton 42 in OUnit.assert_equal 1 (Gen.length gen); *) let return = singleton let repeat x () = Some x (*$T repeat repeat 42 |> take 3 |> to_list = [42; 42; 42] *) let repeatedly f () = Some (f ()) (*$T repeatedly repeatedly (let r = ref 0 in fun () -> incr r; !r) \ |> take 5 |> to_list = [1;2;3;4;5] *) let iterate x f = let cur = ref x in fun () -> let x = !cur in cur := f !cur; Some x (*$T iterate iterate 0 ((+)1) |> take 5 |> to_list = [0;1;2;3;4] *) let next gen = gen () let get gen = gen () let get_exn gen = match gen () with | Some x -> x | None -> raise (Invalid_argument "Gen.get_exn") (*$R get_exn let g = of_list [1;2;3] in assert_equal 1 (get_exn g); assert_equal 2 (get_exn g); assert_equal 3 (get_exn g); assert_raises (Invalid_argument "Gen.get_exn") (fun () -> get_exn g) *) let junk gen = ignore (gen ()) let rec fold f acc gen = match gen () with | None -> acc | Some x -> fold f (f acc x) gen (*$Q (Q.list Q.small_int) (fun l -> \ of_list l |> fold (fun l x->x::l) [] = List.rev l) *) let reduce f g = let acc = match g () with | None -> raise (Invalid_argument "reduce") | Some x -> x in fold f acc g (* Dual of {!fold}, with a deconstructing operation *) let unfold f acc = let acc = ref acc in fun () -> match f !acc with | None -> None | Some (x, acc') -> acc := acc'; Some x (*$T unfold unfold (fun (prev,cur) -> Some (prev, (cur,prev+cur))) (0,1) \ |> take 7 |> to_list = [0; 1; 1; 2; 3; 5; 8] *) let init ?(limit=max_int) f = let r = ref 0 in fun () -> if !r >= limit then None else let x = f !r in let _ = incr r in Some x (*$T init init ~limit:5 (fun i->i) |> to_list = [0;1;2;3;4] *) let rec iter f gen = match gen() with | None -> () | Some x -> f x; iter f gen (*$R iter let e = Restart.(1 -- 10) in OUnit.assert_equal ~printer:pint 10 (Restart.length e); OUnit.assert_equal [1;2] Restart.(to_list (1 -- 2)); OUnit.assert_equal [1;2;3;4;5] (Restart.to_list (Restart.take 5 e)); *) let iteri f gen = let rec iteri i = match gen() with | None -> () | Some x -> f i x; iteri (i+1) in iteri 0 let is_empty gen = match gen () with | None -> true | Some _ -> false (*$T is_empty empty not (is_empty (singleton 2)) *) let length gen = fold (fun acc _ -> acc + 1) 0 gen (*$Q (Q.list Q.small_int) (fun l -> \ of_list l |> length = List.length l) *) (* useful state *) module RunState = struct type 'a t = | Init | Run of 'a | Stop end let scan f acc g = let open RunState in let state = ref Init in fun () -> match !state with | Init -> state := Run acc; Some acc | Stop -> None | Run acc -> match g() with | None -> state := Stop; None | Some x -> let acc' = f acc x in state := Run acc'; Some acc' (*$T scan scan (fun acc x -> x+1::acc) [] (1--5) |> to_list \ = [[]; [2]; [3;2]; [4;3;2]; [5;4;3;2]; [6;5;4;3;2]] *) let unfold_scan f acc g = let open RunState in let state = ref (Run acc) in fun () -> match !state with | Init -> assert false | Stop -> None | Run acc -> match g() with | None -> state := Stop; None | Some x -> let acc', y = f acc x in state := Run acc'; Some y (*$T unfold_scan unfold_scan (fun acc x -> x+acc,acc) 0 (1--5) |> to_list \ = [0; 1; 3; 6; 10] *) (** {3 Lazy} *) let map f gen = let stop = ref false in fun () -> if !stop then None else match gen() with | None -> stop:= true; None | Some x -> Some (f x) (*$Q map (Q.list Q.small_int) (fun l -> \ let f x = x*2 in \ of_list l |> map f |> to_list = List.map f l) *) (*$R let e = 1 -- 10 in let e' = e >>| string_of_int in OUnit.assert_equal ~printer:pstrlist ["9"; "10"] (Gen.to_list (Gen.drop 8 e')); *) let mapi f = let cnt = ref 0 in let cnt_map x = let i = !cnt in cnt := i + 1; f i x in map cnt_map (*$Q mapi (Q.list Q.small_int) (fun l -> \ let len = List.length l in \ let f i x = i+x+1 in \ of_list l |> mapi f |> to_list |> fun l' -> List.fold_left (+) 0 l'= \ len*(len+1)/2 + List.fold_left (+) 0 l) *) let fold_map f s gen = map (let state = ref s in fun x -> state := f (!state) x; !state) gen (*$T fold_map (+) 0 (1--3) |> to_list = [1;3;6] *) let append gen1 gen2 = let first = ref true in fun () -> if !first then match gen1() with | (Some _) as x -> x | None -> first:=false; gen2() else gen2() (*$Q (Q.pair (Q.list Q.small_int)(Q.list Q.small_int)) (fun (l1,l2) -> \ append (of_list l1) (of_list l2) |> to_list = l1 @ l2) *) (*$R let e = Gen.append (1 -- 5) (6 -- 10) in OUnit.assert_equal [10;9;8;7;6;5;4;3;2;1] (Gen.to_rev_list e); *) let flatten next_gen = let open RunState in let state = ref Init in (* get next element *) let rec next () = match !state with | Init -> get_next_gen() | Run gen -> begin match gen () with | None -> get_next_gen () | (Some _) as x -> x end | Stop -> None and get_next_gen() = match next_gen() with | None -> state := Stop; None | Some gen -> state := Run gen; next() in next let flat_map f next_elem = let open RunState in let state = ref Init in let rec next() = match !state with | Init -> get_next_gen() | Run gen -> begin match gen () with | None -> get_next_gen () | (Some _) as x -> x end | Stop -> None and get_next_gen() = match next_elem() with | None -> state:=Stop; None | Some x -> begin try state := Run (f x) with e -> state := Stop; raise e end; next() in next (*$Q flat_map (Q.list Q.small_int) (fun l -> \ let f x = of_list [x;x*2] in \ eq (map f (of_list l) |> flatten) (flat_map f (of_list l))) *) (*$T flat_map (fun x -> if x mod 1_500_000=0 then singleton x else empty) (1 -- 6_000_000) \ |> to_list = [1_500_000; 3_000_000; 4_500_000; 6_000_000] *) (*$R let e = 1 -- 3 in let e' = e >>= (fun x -> x -- (x+1)) in OUnit.assert_equal [1;2;2;3;3;4] (Gen.to_list e'); *) let mem ?(eq=(=)) x gen = let rec mem eq x gen = match gen() with | Some y -> eq x y || mem eq x gen | None -> false in mem eq x gen let take n gen = assert (n >= 0); let count = ref 0 in (* how many yielded elements *) fun () -> if !count = n || !count = ~-1 then None else match gen() with | None -> count := ~-1; None (* indicate stop *) | (Some _) as x -> incr count; x (*$Q (Q.pair Q.small_int (Q.list Q.small_int)) (fun (n,l) -> \ of_list l |> take n |> length = Pervasives.min n (List.length l)) *) (* call [gen] at most [n] times, and stop *) let rec __drop n gen = if n = 0 then () else match gen() with | Some _ -> __drop (n-1) gen | None -> () let drop n gen = assert (n >= 0); let dropped = ref false in fun () -> if !dropped then gen() else begin (* drop [n] elements and yield the next element *) dropped := true; __drop n gen; gen() end (*$Q (Q.pair Q.small_int (Q.list Q.small_int)) (fun (n,l) -> \ let g1,g2 = take n (of_list l), drop n (of_list l) in \ append g1 g2 |> to_list = l) *) let nth n gen = assert (n>=0); __drop n gen; match gen () with | None -> raise Not_found | Some x -> x (*$= nth & ~printer:string_of_int 4 (nth 4 (0--10)) 8 (nth 8 (0--10)) *) (*$T (try ignore (nth 11 (1--10)); false with Not_found -> true) *) let take_nth n gen = assert (n>=1); let i = ref n in let rec next() = match gen() with | None -> None | (Some _) as res when !i = n -> i:=1; res | Some _ -> incr i; next() in next let filter p gen = let rec next () = (* wrap exception into option, for next to be tailrec *) match gen() with | None -> None | (Some x) as res -> if p x then res (* yield element *) else next () (* discard element *) in next (*$T filter (fun x ->x mod 2 = 0) (1--10) |> to_list = [2;4;6;8;10] *) let take_while p gen = let stop = ref false in fun () -> if !stop then None else match gen() with | (Some x) as res -> if p x then res else (stop := true; None) | None -> stop:=true; None (*$T take_while (fun x ->x<10) (1--1000) |> eq (1--9) *) let fold_while f s gen = let state = ref s in let rec consume gen = match gen() with | None -> () | Some x -> let acc, cont = f !state x in state := acc; match cont with | `Stop -> () | `Continue -> consume gen in consume gen; !state (*$T fold_while (fun acc b -> if b then acc+1, `Continue else acc, `Stop) 0 \ (of_list [true;true;false;true]) = 2 *) module DropWhileState = struct type t = | Stop | Drop | Yield end (* state machine starts at Drop: Drop: - If next element doesn't satisfy predicate, goto yield - if no more elements, goto stop Yield: - if there is a next element, yield it - if no more elements, goto stop Stop: just return None *) let drop_while p gen = let open DropWhileState in let state = ref Drop in let rec next () = match !state with | Stop -> None | Drop -> begin match gen () with | None -> state := Stop; None | (Some x) as res -> if p x then next() else (state:=Yield; res) end | Yield -> begin match gen () with | None -> state := Stop; None | Some _ as res -> res end in next (*$T drop_while (fun x-> x<10) (1--20) |> eq (10--20) *) let filter_map f gen = (* tailrec *) let rec next () = match gen() with | None -> None | Some x -> match f x with | None -> next() | (Some _) as res -> res in next (*$T filter_map (fun x-> if x mod 2 = 0 then Some (string_of_int x) else None) (1--10) \ |> to_list = List.map string_of_int [2;4;6;8;10] *) (*$R let f x = if x mod 2 = 0 then Some (string_of_int x) else None in let e = Gen.filter_map f (1 -- 10) in OUnit.assert_equal ["2"; "4"; "6"; "8"; "10"] (Gen.to_list e); *) let zip_index gen = let r = ref ~-1 in fun () -> match gen() with | None -> None | Some x -> incr r; Some (!r, x) (*$T zip_index (1--5) |> to_list = [0,1; 1,2; 2,3; 3,4; 4,5] *) let unzip gen = let stop = ref false in let q1 = Queue.create () in let q2 = Queue.create () in let next_left () = if Queue.is_empty q1 then if !stop then None else match gen() with | Some (x,y) -> Queue.push y q2; Some x | None -> stop := true; None else Some (Queue.pop q1) in let next_right () = if Queue.is_empty q2 then if !stop then None else match gen() with | Some (x,y) -> Queue.push x q1; Some y | None -> stop := true; None else Some (Queue.pop q2) in next_left, next_right (*$T unzip (of_list [1,2;3,4]) |> (fun (x,y)-> to_list x, to_list y) \ = ([1;3], [2;4]) *) (*$Q (Q.list (Q.pair Q.small_int Q.small_int)) (fun l -> \ of_list l |> unzip |> (fun (x,y) -> to_list x,to_list y) = \ List.split l) *) (* [partition p l] returns the elements that satisfy [p], and the elements that do not satisfy [p] *) let partition p gen = let qtrue = Queue.create () in let qfalse = Queue.create () in let stop = ref false in let rec nexttrue () = if Queue.is_empty qtrue then if !stop then None else match gen() with | (Some x) as res -> if p x then res else (Queue.push x qfalse; nexttrue()) | None -> stop:=true; None else Some (Queue.pop qtrue) and nextfalse() = if Queue.is_empty qfalse then if !stop then None else match gen() with | (Some x) as res -> if p x then (Queue.push x qtrue; nextfalse()) else res | None -> stop:= true; None else Some (Queue.pop qfalse) in nexttrue, nextfalse (*$T partition (fun x -> x mod 2 = 0) (1--10) |> \ (fun (x,y)->to_list x, to_list y) = ([2;4;6;8;10], [1;3;5;7;9]) *) let rec for_all p gen = match gen() with | None -> true | Some x -> p x && for_all p gen let rec exists p gen = match gen() with | None -> false | Some x -> p x || exists p gen let min ?(lt=fun x y -> x < y) gen = let first = match gen () with | Some x -> x | None -> raise (Invalid_argument "min") in fold (fun min x -> if lt x min then x else min) first gen (*$T min (of_list [1;4;6;0;11; -2]) = ~-2 (try ignore (min empty); false with Invalid_argument _ -> true) *) let max ?(lt=fun x y -> x < y) gen = let first = match gen () with | Some x -> x | None -> raise (Invalid_argument "max") in fold (fun max x -> if lt max x then x else max) first gen (*$T max (of_list [1;4;6;0;11; -2]) = 11 (try ignore (max empty); false with Invalid_argument _ -> true) *) let eq ?(eq=(=)) gen1 gen2 = let rec check () = match gen1(), gen2() with | None, None -> true | Some x1, Some x2 when eq x1 x2 -> check () | _ -> false in check () (*$Q (Q.pair (Q.list Q.small_int)(Q.list Q.small_int)) (fun (l1,l2) -> \ eq (of_list l1)(of_list l2) = (l1 = l2)) *) let lexico ?(cmp=Pervasives.compare) gen1 gen2 = let rec lexico () = match gen1(), gen2() with | None, None -> 0 | Some x1, Some x2 -> let c = cmp x1 x2 in if c <> 0 then c else lexico () | Some _, None -> 1 | None, Some _ -> -1 in lexico () let compare ?cmp gen1 gen2 = lexico ?cmp gen1 gen2 (*$Q (Q.pair (Q.list Q.small_int)(Q.list Q.small_int)) (fun (l1,l2) -> \ let sign x = if x < 0 then -1 else if x=0 then 0 else 1 in \ sign (compare (of_list l1)(of_list l2)) = sign (Pervasives.compare l1 l2)) *) let rec find p e = match e () with | None -> None | Some x when p x -> Some x | Some _ -> find p e (*$T find (fun x -> x>=5) (1--10) = Some 5 find (fun x -> x>5) (1--4) = None *) let sum e = let rec sum acc = match e() with | None -> acc | Some x -> sum (x+acc) in sum 0 (*$T sum (1--10) = 55 *) (** {2 Multiple Iterators} *) let map2 f e1 e2 = fun () -> match e1(), e2() with | Some x, Some y -> Some (f x y) | _ -> None (*$T map2 (+) (1--5) (1--4) |> eq (of_list [2;4;6;8]) map2 (+) (1--5) (repeat 0) |> eq (1--5) *) let rec iter2 f e1 e2 = match e1(), e2() with | Some x, Some y -> f x y; iter2 f e1 e2 | _ -> () (*$T iter2 let r = ref 0 in iter2 (fun _ _ -> incr r) (1--10) (4--6); !r = 3 *) let rec fold2 f acc e1 e2 = match e1(), e2() with | Some x, Some y -> fold2 f (f acc x y) e1 e2 | _ -> acc let rec for_all2 p e1 e2 = match e1(), e2() with | Some x, Some y -> p x y && for_all2 p e1 e2 | _ -> true let rec exists2 p e1 e2 = match e1(), e2() with | Some x, Some y -> p x y || exists2 p e1 e2 | _ -> false let zip_with f a b = let stop = ref false in fun () -> if !stop then None else match a(), b() with | Some xa, Some xb -> Some (f xa xb) | _ -> stop:=true; None let zip a b = zip_with (fun x y -> x,y) a b (*$Q (Q.list Q.small_int) (fun l -> \ zip_with (fun x y->x,y) (of_list l) (of_list l) \ |> unzip |> fst |> to_list = l) *) (*$R let e = Gen.zip_with (+) (Gen.repeat 1) (4--7) in OUnit.assert_equal [5;6;7;8] (Gen.to_list e); *) (** {3 Complex combinators} *) module MergeState = struct type 'a t = { gens : 'a gen Queue.t; mutable state : my_state; } and my_state = | NewGen (* obtain a new generator and push it in queue *) | YieldAndNew (* yield element from queue, then behave like NewGen *) | Yield (* just yield elements from queue *) | Stop (* no more elements *) end (* state machine starts at NewGen: NewGen: use next_gen to push a new gen into the queue Yield: while the queue is not empty: pop gen g from it if g is empty continue else: pop element x from g push g at back of queue yield x YieldAndNew: mix of Yield and NewGen. if next_gen is exhausted, goto Yield; if queue is empty, goto NewGen Stop: do nothing *) let merge next_gen = let open MergeState in let state = {gens = Queue.create(); state=NewGen;}in (* recursive function to get next element *) let rec next () = match state.state with | Stop -> None | Yield -> (* only yield from generators in state.gens *) if Queue.is_empty state.gens then (state.state <- Stop; None) else let gen = Queue.pop state.gens in begin match gen () with | None -> next() | (Some _) as res -> Queue.push gen state.gens; (* put gen back in queue *) res end | NewGen -> begin match next_gen() with | None -> state.state <- Yield; (* exhausted *) next() | Some gen -> Queue.push gen state.gens; state.state <- YieldAndNew; next() end | YieldAndNew -> (* yield element from queue, then get a new generator *) if Queue.is_empty state.gens then (state.state <- NewGen; next()) else let gen = Queue.pop state.gens in begin match gen () with | None -> state.state <- NewGen; next() | (Some _) as res -> Queue.push gen state.gens; state.state <- NewGen; res end in next (*$T merge (of_list [of_list [1;3;5]; of_list [2;4;6]; of_list [7;8;9]]) \ |> to_list |> List.sort Pervasives.compare = [1;2;3;4;5;6;7;8;9] *) (*$R let e = of_list [1--3; 4--6; 7--9] in let e' = merge e in OUnit.assert_equal [1;2;3;4;5;6;7;8;9] (to_list e' |> List.sort Pervasives.compare); *) let intersection ?(cmp=Pervasives.compare) gen1 gen2 = let x1 = ref (gen1 ()) in let x2 = ref (gen2 ()) in let rec next () = match !x1, !x2 with | Some y1, Some y2 -> let c = cmp y1 y2 in if c = 0 (* equal elements, yield! *) then (x1 := gen1(); x2 := gen2(); Some y1) else if c < 0 (* drop y1 *) then (x1 := gen1 (); next ()) else (* drop y2 *) (x2 := gen2(); next ()) | _ -> None in next (*$T intersection (of_list [1;1;2;3;4;8]) (of_list [1;2;4;5;6;7;8;9]) \ |> to_list = [1;2;4;8] *) let sorted_merge ?(cmp=Pervasives.compare) gen1 gen2 = let x1 = ref (gen1 ()) in let x2 = ref (gen2 ()) in fun () -> match !x1, !x2 with | None, None -> None | (Some y1)as r1, ((Some y2) as r2) -> if cmp y1 y2 <= 0 then (x1 := gen1 (); r1) else (x2 := gen2 (); r2) | (Some _)as r, None -> x1 := gen1 (); r | None, ((Some _)as r) -> x2 := gen2 (); r (*$T sorted_merge (of_list [1;2;2;3;5;10;100]) (of_list [2;4;5;6;11]) \ |> to_list = [1;2;2;2;3;4;5;5;6;10;11;100] *) (*$R [Gen.of_list [1;3;5]; Gen.of_list [0;1;1;3;4;6;10]; Gen.of_list [2;2;11]] |> Gen.sorted_merge_n ?cmp:None |> Gen.to_list |> OUnit.assert_equal ~printer:pilist [0;1;1;1;2;2;3;3;4;5;6;10;11] *) (** {4 Mutable heap (taken from heap.ml to avoid dependencies)} *) module Heap = struct type 'a t = { mutable tree : 'a tree; cmp : 'a -> 'a -> int; } (** A pairing tree heap with the given comparison function *) and 'a tree = | Empty | Node of 'a * 'a tree * 'a tree let empty ~cmp = { tree = Empty; cmp; } let is_empty h = match h.tree with | Empty -> true | Node _ -> false let rec union ~cmp t1 t2 = match t1, t2 with | Empty, _ -> t2 | _, Empty -> t1 | Node (x1, l1, r1), Node (x2, l2, r2) -> if cmp x1 x2 <= 0 then Node (x1, union ~cmp t2 r1, l1) else Node (x2, union ~cmp t1 r2, l2) let insert h x = h.tree <- union ~cmp:h.cmp (Node (x, Empty, Empty)) h.tree let pop h = match h.tree with | Empty -> raise Not_found | Node (x, l, r) -> h.tree <- union ~cmp:h.cmp l r; x end let sorted_merge_n ?(cmp=Pervasives.compare) l = (* make a heap of (value, generator) *) let cmp (v1,_) (v2,_) = cmp v1 v2 in let heap = Heap.empty ~cmp in (* add initial values *) List.iter (fun gen' -> match gen'() with | Some x -> Heap.insert heap (x, gen') | None -> ()) l; fun () -> if Heap.is_empty heap then None else begin let x, gen = Heap.pop heap in match gen() with | Some y -> Heap.insert heap (y, gen); (* insert next value *) Some x | None -> Some x (* gen empty, drop it *) end (*$T sorted_merge_n [of_list [1;2;2;3;5;10;100]; of_list [2;4;5;6;11]; (6--10)] \ |> to_list = [1;2;2;2;3;4;5;5;6;6;7;8;9;10;10;11;100] *) let round_robin ?(n=2) gen = (* array of queues, together with their index *) let qs = Array.init n (fun _ -> Queue.create ()) in let cur = ref 0 in (* get next element for the i-th queue *) let rec next i = let q = qs.(i) in if Queue.is_empty q then update_to_i i (* consume generator *) else Some(Queue.pop q) (* consume [gen] until some element for [i]-th generator is available. *) and update_to_i i = match gen() with | None -> None | Some x -> let j = !cur in cur := (j+1) mod n; (* move cursor to next generator *) let q = qs.(j) in if j = i then begin assert (Queue.is_empty q); Some x (* return the element *) end else begin Queue.push x q; update_to_i i (* continue consuming [gen] *) end in (* generators *) let l = Array.mapi (fun i _ -> (fun () -> next i)) qs in Array.to_list l (*$T round_robin ~n:3 (1--12) |> List.map to_list = \ [[1;4;7;10]; [2;5;8;11]; [3;6;9;12]] *) (*$R let e = Restart.round_robin ~n:2 Restart.(1--10) in match e with | [a;b] -> OUnit.assert_equal [1;3;5;7;9] (Gen.to_list a); OUnit.assert_equal [2;4;6;8;10] (Gen.to_list b) | _ -> OUnit.assert_failure "wrong list lenght" *) (*$R let e = Restart.round_robin ~n:3 Restart.(1 -- 999) in let l = List.map Gen.length e in OUnit.assert_equal [333;333;333] l; *) (* Duplicate the enum into [n] generators (default 2). The generators share the same underlying instance of the enum, so the optimal case is when they are consumed evenly *) let tee ?(n=2) gen = (* array of queues, together with their index *) let qs = Array.init n (fun _ -> Queue.create ()) in let finished = ref false in (* is [gen] exhausted? *) (* get next element for the i-th queue *) let rec next i = if Queue.is_empty qs.(i) then if !finished then None else get_next i (* consume generator *) else Queue.pop qs.(i) (* consume one more element *) and get_next i = match gen() with | Some _ as res -> for j = 0 to n-1 do if j <> i then Queue.push res qs.(j) done; res | None -> finished := true; None in (* generators *) let l = Array.mapi (fun i _ -> (fun () -> next i)) qs in Array.to_list l (*$T tee ~n:3 (1--12) |> List.map to_list = \ [to_list (1--12); to_list (1--12); to_list (1--12)] *) module InterleaveState = struct type 'a t = | Only of 'a gen | Both of 'a gen * 'a gen * bool ref | Stop end (* Yield elements from a and b alternatively *) let interleave gen_a gen_b = let open InterleaveState in let state = ref (Both (gen_a, gen_b, ref true)) in let rec next() = match !state with | Stop -> None | Only g -> begin match g() with | None -> state := Stop; None | (Some _) as res -> res end | Both (g1, g2, r) -> match (if !r then g1() else g2()) with | None -> state := if !r then Only g2 else Only g1; next() | (Some _) as res -> r := not !r; (* swap *) res in next (*$T interleave (repeat 0) (1--5) |> take 10 |> to_list = \ [0;1;0;2;0;3;0;4;0;5] *) (*$R let e1 = Gen.of_list [1;3;5;7;9] in let e2 = Gen.of_list [2;4;6;8;10] in let e = Gen.interleave e1 e2 in OUnit.assert_equal [1;2;3;4;5;6;7;8;9;10] (Gen.to_list e); *) module IntersperseState = struct type 'a t = | Start | YieldElem of 'a option | YieldSep of 'a option (* next val *) | Stop end (* Put [x] between elements of [enum] *) let intersperse x gen = let open IntersperseState in let state = ref Start in let rec next() = match !state with | Stop -> None | YieldElem res -> begin match gen() with | None -> state := Stop | Some _ as res' -> state := YieldSep res' end; res | YieldSep res -> state := YieldElem res; Some x | Start -> match gen() with | None -> state := Stop; None | Some _ as res -> state := YieldElem res; next() in next (*$T intersperse 0 (1--5) |> to_list = [1;0;2;0;3;0;4;0;5] *) (*$R let e = 1 -- 5 in let e' = Gen.intersperse 0 e in OUnit.assert_equal [1;0;2;0;3;0;4;0;5] (Gen.to_list e'); *) (* Cartesian product *) let product gena genb = let all_a = ref [] in let all_b = ref [] in (* cur: current state, i.e., what we have to do next. Can be stop, getLeft/getRight (to obtain next element from first/second generator), or prodLeft/prodRIght to compute the product of an element with a list of already met elements *) let cur = ref `GetLeft in let rec next () = match !cur with | `Stop -> None | `GetLeft -> begin match gena() with | None -> cur := `GetRightOrStop | Some a -> all_a := a :: !all_a; cur := `ProdLeft (a, !all_b) end; next () | `GetRight | `GetRightOrStop -> (* TODO: test *) begin match genb() with | None when !cur = `GetRightOrStop -> cur := `Stop | None -> cur := `GetLeft | Some b -> all_b := b::!all_b; cur := `ProdRight (b, !all_a) end; next () | `ProdLeft (_, []) -> cur := `GetRight; next() | `ProdLeft (x, y::l) -> cur := `ProdLeft (x, l); Some (x, y) | `ProdRight (_, []) -> cur := `GetLeft; next() | `ProdRight (y, x::l) -> cur := `ProdRight (y, l); Some (x, y) in next (*$T product (1--3) (of_list ["a"; "b"]) |> to_list \ |> List.sort Pervasives.compare = \ [1, "a"; 1, "b"; 2, "a"; 2, "b"; 3, "a"; 3, "b"] *) (*$R let printer = pi2list in let e = Gen.product (1--3) (4--5) in OUnit.assert_equal ~printer [1,4; 1,5; 2,4; 2,5; 3,4; 3,5] (List.sort Pervasives.compare (Gen.to_list e)); *) (* Group equal consecutive elements together. *) let group ?(eq=(=)) gen = match gen() with | None -> fun () -> None | Some x -> let cur = ref [x] in let rec next () = (* try to get an element *) let next_x = if !cur = [] then None else gen() in match next_x, !cur with | None, [] -> None | None, l -> cur := []; (* stop *) Some l | Some x, y::_ when eq x y -> cur := x::!cur; next () (* same group *) | Some x, l -> cur := [x]; Some l in next (*$T group (of_list [0;0;0;1;0;2;2;3;4;5;5;5;5;10]) |> to_list = \ [[0;0;0];[1];[0];[2;2];[3];[4];[5;5;5;5];[10]] *) let uniq ?(eq=(=)) gen = let open RunState in let state = ref Init in let rec next() = match !state with | Stop -> None | Init -> begin match gen() with | None -> state:= Stop; None | (Some x) as res -> state := Run x; res end | Run x -> begin match gen() with | None -> state:= Stop; None | (Some y) as res -> if eq x y then next() (* ignore duplicate *) else (state := Run y; res) end in next (*$T uniq (of_list [0;0;0;1;0;2;2;3;4;5;5;5;5;10]) |> to_list = \ [0;1;0;2;3;4;5;10] *) let sort ?(cmp=Pervasives.compare) gen = (* build heap *) let h = Heap.empty ~cmp in iter (Heap.insert h) gen; fun () -> if Heap.is_empty h then None else Some (Heap.pop h) (*$T sort (of_list [0;0;0;1;0;2;2;3;4;5;5;5;-42;5;10]) |> to_list = \ [-42;0;0;0;0;1;2;2;3;4;5;5;5;5;10] *) (* NOTE: using a set is not really possible, because once we have built the set there is no simple way to iterate on it *) let sort_uniq ?(cmp=Pervasives.compare) gen = uniq ~eq:(fun x y -> cmp x y = 0) (sort ~cmp gen) (*$T sort_uniq (of_list [0;0;0;1;0;2;2;3;4;5;42;5;5;42;5;10]) |> to_list = \ [0;1;2;3;4;5;10;42] *) let chunks n e = let rec next () = match e() with | None -> None | Some x -> let a = Array.make n x in fill a 1 and fill a i = (* fill the array. [i]: current index to fill *) if i = n then Some a else match e() with | None -> Some (Array.sub a 0 i) (* last array is not full *) | Some x -> a.(i) <- x; fill a (i+1) in next (*$T chunks 25 (0--100) |> map Array.to_list |> to_list = \ List.map to_list [(0--24); (25--49);(50--74);(75--99);(100--100)] *) (*$Q Q.(list int) (fun l -> \ of_list l |> chunks 25 |> flat_map of_array |> to_list = l) *) (* state of the permutation machine. One machine manages one element [x], and depends on a deeper machine [g] that generates permutations of the list minus this element (down to the empty list). The machine can do two things: - insert the element in the current list of [g], at any position - obtain the next list of [g] *) (* TODO: check https://en.wikipedia.org/wiki/Heap's_algorithm , might be better *) module PermState = struct type 'a state = | Done | Base (* bottom machine, yield [] *) | Insert of 'a insert_state and 'a insert_state = { x : 'a; mutable l : 'a list; mutable n : int; (* idx for insertion *) len : int; (* len of [l] *) sub : 'a t; } and 'a t = { mutable st : 'a state; } end let permutations g = let open PermState in (* make a machine for n elements. Invariant: n=len(l) *) let rec make_machine n l = match l with | [] -> assert (n=0); {st=Base} | x :: tail -> let sub = make_machine (n-1) tail in let st = match next sub () with | None -> Done | Some l -> Insert {x;n=0;l;len=n;sub} in {st;} (* next element of the machine *) and next m () = match m.st with | Done -> None | Base -> m.st <- Done; Some [] | Insert ({x;len;n;l;sub} as state) -> if n=len then match next sub () with | None -> m.st <- Done; None | Some l -> state.l <- l; state.n <- 0; next m () else ( state.n <- state.n + 1; Some (insert x n l) ) and insert x n l = match n, l with | 0, _ -> x::l | _, [] -> assert false | _, y::tail -> y :: insert x (n-1) tail in let l = fold (fun acc x->x::acc) [] g in next (make_machine (List.length l) l) (*$T permutations permutations (1--3) |> to_list |> List.sort Pervasives.compare = \ [[1;2;3]; [1;3;2]; [2;1;3]; [2;3;1]; [3;1;2]; [3;2;1]] permutations empty |> to_list = [[]] permutations (singleton 1) |> to_list = [[1]] *) (* Credits to Bernardo Freitas Paulo da Costa for [permutations_heap]! B.R.Heap's algorithm for permutations, cf http://en.wikipedia.org/wiki/Heap%27s_algorithm. Continuation-based recursive formula, model for the state manipulations below: {[ let rec heap_perm k a n = match n with | 0 -> k a | n -> for i = 0 to n-1 do heap_perm k a (n-1); let j = (if n mod 2 = 1 then 0 else i) in let t = a.(j) in a.(j) <- a.(n-1); a.(n-1) <- t done ]} *) (* The state of the permutation machine, containing - the array [a] we're permuting, in the "current permutation"; - the level of recursion [n]: we can permute elements with index < [n] - the stack of values of indices to permute [i] in the list [is] The permutation stops when we have no more elements in the stack [is]. *) module HeapPermState = struct type 'a state = { elts : 'a array; mutable n : int; mutable is : int list; } end let permutations_heap g = let open HeapPermState in let l = fold (fun acc x->x::acc) [] g in let a = Array.of_list l in let rec next st () = match st.n with | 0 -> begin match st.is with | [] | _::[] -> assert false | 0::i::is' -> (* "Pop state" before returning next element *) st.is <- (i+1)::is'; st.n <- 1; Some (Array.copy a) | _::_::_ -> assert false end | n -> match st.is with | [] -> None | i::is' when i = n -> (* Pop state at end of loop *) st.is <- is'; st.n <- n+1; begin match st.is with | [] -> None (* last loop *) | i::is' -> let j = (if st.n mod 2 = 1 then 0 else i) in let tmp = st.elts.(j) in st.elts.(j) <- st.elts.(n); st.elts.(n) <- tmp; st.is <- (i+1)::is'; next st () end | _::_ -> (* Recurse down and start new loop *) st.n <- n-1; st.is <- 0 :: st.is; next st () in let n = Array.length a in if n = 0 then empty else next {elts = a; n=n; is=[0]} (*$T permutations_heap permutations_heap (1--3) |> to_list |> List.sort Pervasives.compare = \ [[|1;2;3|]; [|1;3;2|]; [|2;1;3|]; [|2;3;1|]; [|3;1;2|]; [|3;2;1|]] permutations_heap empty |> to_list = [] permutations_heap (singleton 1) |> to_list = [[|1|]] *) module CombState = struct type 'a state = | Done | Base | Add of 'a * 'a t * 'a t (* add x at beginning of first; then switch to second *) | Follow of 'a t (* just forward *) and 'a t = { mutable st : 'a state } end let combinations n g = let open CombState in assert (n >= 0); let rec make_state n l = match n, l with | 0, _ -> {st=Base} | _, [] -> {st=Done} | _, x::tail -> let m1 = make_state (n-1) tail in let m2 = make_state n tail in {st=Add(x,m1,m2)} and next m () = match m.st with | Done -> None | Base -> m.st <- Done; Some [] | Follow m -> begin match next m () with | None -> m.st <- Done; None | Some _ as res -> res end | Add (x, m1, m2) -> match next m1 () with | None -> m.st <- Follow m2; next m () | Some l -> Some (x::l) in let l = fold (fun acc x->x::acc) [] g in next (make_state n l) (*$T combinations 2 (1--4) |> map (List.sort Pervasives.compare) \ |> to_list |> List.sort Pervasives.compare = \ [[1;2]; [1;3]; [1;4]; [2;3]; [2;4]; [3;4]] combinations 0 (1--4) |> to_list = [[]] combinations 1 (singleton 1) |> to_list = [[1]] *) module PowerSetState = struct type 'a state = | Done | Base | Add of 'a * 'a t (* add x before any result of m *) | AddTo of 'a list * 'a * 'a t (* yield x::list, then back to Add(x,m) *) and 'a t = { mutable st : 'a state } end let power_set g = let open PowerSetState in let rec make_state l = match l with | [] -> {st=Base} | x::tail -> let m = make_state tail in {st=Add(x,m)} and next m () = match m.st with | Done -> None | Base -> m.st <- Done; Some [] | Add (x,m') -> begin match next m' () with | None -> m.st <- Done; None | Some l as res -> m.st <- AddTo(l,x,m'); res end | AddTo (l, x, m') -> m.st <- Add (x,m'); Some (x::l) in let l = fold (fun acc x->x::acc) [] g in next (make_state l) (*$T power_set (1--3) |> map (List.sort Pervasives.compare) \ |> to_list |> List.sort Pervasives.compare = \ [[]; [1]; [1;2]; [1;2;3]; [1;3]; [2]; [2;3]; [3]] power_set empty |> to_list = [[]] power_set (singleton 1) |> map (List.sort Pervasives.compare) \ |> to_list |> List.sort Pervasives.compare = [[]; [1]] *) (** {3 Conversion} *) let of_list l = let l = ref l in fun () -> match !l with | [] -> None | x::l' -> l := l'; Some x let to_rev_list gen = fold (fun acc x -> x :: acc) [] gen (*$Q (Q.list Q.small_int) (fun l -> \ to_rev_list (of_list l) = List.rev l) *) let to_list gen = List.rev (to_rev_list gen) let to_array gen = let l = to_rev_list gen in match l with | [] -> [| |] | _ -> let a = Array.of_list l in let n = Array.length a in (* reverse array *) for i = 0 to (n-1) / 2 do let tmp = a.(i) in a.(i) <- a.(n-i-1); a.(n-i-1) <- tmp done; a let of_array ?(start=0) ?len a = let len = match len with | None -> Array.length a - start | Some n -> assert (n + start < Array.length a); n in let i = ref start in fun () -> if !i >= start + len then None else (let x = a.(!i) in incr i; Some x) (*$Q (Q.array Q.small_int) (fun a -> \ of_array a |> to_array = a) *) let of_string ?(start=0) ?len s = let len = match len with | None -> String.length s - start | Some n -> assert (n + start < String.length s); n in let i = ref start in fun () -> if !i >= start + len then None else (let x = s.[!i] in incr i; Some x) let to_buffer buf g = iter (Buffer.add_char buf) g let to_string s = let buf = Buffer.create 16 in to_buffer buf s; Buffer.contents buf let rand_int i = repeatedly (fun () -> Random.int i) let int_range ?(step=1) i j = if step = 0 then raise (Invalid_argument "Gen.int_range"); let (>) = if step > 0 then (>) else (<) in let r = ref i in fun () -> let x = !r in if x > j then None else begin r := !r + step; Some x end (*$= & ~printer:Q.Print.(list int) [1;2;3;4] (int_range 1 4 |> to_list) [4;3;2;1] (int_range ~step:~-1 4 1 |> to_list) [6;4;2] (int_range 6 1 ~step:~-2 |> to_list) [] (int_range 4 1 |> to_list) *) let lines g = let buf = Buffer.create 32 in let stop = ref false in let rec next() = if !stop then None else match g() with | None -> stop := true; (* only return a non-empty line *) if Buffer.length buf =0 then None else Some (Buffer.contents buf) | Some '\n' -> let s = Buffer.contents buf in Buffer.clear buf; Some s | Some c -> Buffer.add_char buf c; next () in next (*$= & ~printer:Q.Print.(list string) ["abc"; "de"; ""] (lines (of_string "abc\nde\n\n") |> to_list) *) let unlines g = let st = ref `Next in fun () -> match !st with | `Stop -> None | `Next -> begin match g() with | None -> st := `Stop; None | Some "" -> Some '\n' (* empty line *) | Some s -> st := `Consume (s, 1); Some s.[0] end | `Consume (s, i) when i=String.length s -> st := `Next; Some '\n' | `Consume (s, i) -> st := `Consume (s, i+1); Some s.[i] (*$Q Q.printable_string (fun s -> \ of_string s |> lines |> unlines |> to_string |> String.trim = String.trim s) *) let pp ?(start="") ?(stop="") ?(sep=",") ?(horizontal=false) pp_elem formatter gen = (if horizontal then Format.pp_open_hbox formatter () else Format.pp_open_hvbox formatter 0); Format.pp_print_string formatter start; let rec next is_first = match gen() with | Some x -> if not is_first then begin Format.pp_print_string formatter sep; Format.pp_print_space formatter (); pp_elem formatter x end else pp_elem formatter x; next false | None -> () in next true; Format.pp_print_string formatter stop; Format.pp_close_box formatter () module Infix = struct let (--) = int_range ~step:1 let (>>=) x f = flat_map f x let (>>|) x f = map f x let (>|=) x f = map f x end include Infix module Restart = struct type 'a t = unit -> 'a gen type 'a restartable = 'a t let lift f e = f (e ()) let lift2 f e1 e2 = f (e1 ()) (e2 ()) let empty () = empty let singleton x () = singleton x let return = singleton let iterate x f () = iterate x f let repeat x () = repeat x let unfold f acc () = unfold f acc let init ?limit f () = init ?limit f let cycle enum = assert (not (is_empty (enum ()))); fun () -> let gen = ref (enum ()) in (* start cycle *) let rec next () = match (!gen) () with | (Some _) as res -> res | None -> gen := enum(); next() in next let is_empty e = is_empty (e ()) let fold f acc e = fold f acc (e ()) let reduce f e = reduce f (e ()) let scan f acc e () = scan f acc (e ()) let unfold_scan f acc e () = unfold_scan f acc (e()) let iter f e = iter f (e ()) let iteri f e = iteri f (e ()) let length e = length (e ()) let map f e () = map f (e ()) let mapi f e () = mapi f (e ()) let fold_map f s e () = fold_map f s (e ()) let append e1 e2 () = append (e1 ()) (e2 ()) let flatten e () = flatten (e ()) let flat_map f e () = flat_map f (e ()) let mem ?eq x e = mem ?eq x (e ()) let take n e () = take n (e ()) let drop n e () = drop n (e ()) let nth n e = nth n (e ()) let take_nth n e () = take_nth n (e ()) let filter p e () = filter p (e ()) let take_while p e () = take_while p (e ()) let fold_while f s e = fold_while f s (e ()) let drop_while p e () = drop_while p (e ()) let filter_map f e () = filter_map f (e ()) let zip_with f e1 e2 () = zip_with f (e1 ()) (e2 ()) let zip e1 e2 () = zip (e1 ()) (e2 ()) let zip_index e () = zip_index (e ()) let unzip e = map fst e, map snd e let partition p e = filter p e, filter (fun x -> not (p x)) e let for_all p e = for_all p (e ()) let exists p e = exists p (e ()) let for_all2 p e1 e2 = for_all2 p (e1 ()) (e2 ()) let exists2 p e1 e2 = exists2 p (e1 ()) (e2 ()) let map2 f e1 e2 () = map2 f (e1()) (e2()) let iter2 f e1 e2 = iter2 f (e1()) (e2()) let fold2 f acc e1 e2 = fold2 f acc (e1()) (e2()) let min ?lt e = min ?lt (e ()) let max ?lt e = max ?lt (e ()) let ___eq = eq let eq ?eq e1 e2 = ___eq ?eq (e1 ()) (e2 ()) let lexico ?cmp e1 e2 = lexico ?cmp (e1 ()) (e2 ()) let compare ?cmp e1 e2 = compare ?cmp (e1 ()) (e2 ()) let sum e = sum (e()) let find f e = find f (e()) let merge e () = merge (e ()) let intersection ?cmp e1 e2 () = intersection ?cmp (e1 ()) (e2 ()) let sorted_merge ?cmp e1 e2 () = sorted_merge ?cmp (e1 ()) (e2 ()) let sorted_merge_n ?cmp l () = sorted_merge_n ?cmp (List.map (fun g -> g()) l) let tee ?n e = tee ?n (e ()) let round_robin ?n e = round_robin ?n (e ()) let interleave e1 e2 () = interleave (e1 ()) (e2 ()) let intersperse x e () = intersperse x (e ()) let product e1 e2 () = product (e1 ()) (e2 ()) let group ?eq e () = group ?eq (e ()) let uniq ?eq e () = uniq ?eq (e ()) let sort ?(cmp=Pervasives.compare) enum = fun () -> sort ~cmp (enum ()) let sort_uniq ?(cmp=Pervasives.compare) e = let e' = sort ~cmp e in uniq ~eq:(fun x y -> cmp x y = 0) e' let chunks n e () = chunks n (e()) let permutations g () = permutations (g ()) let permutations_heap g () = permutations_heap (g ()) let combinations n g () = combinations n (g()) let power_set g () = power_set (g()) let of_list l () = of_list l let to_rev_list e = to_rev_list (e ()) let to_list e = to_list (e ()) let to_array e = to_array (e ()) let of_array ?start ?len a () = of_array ?start ?len a let of_string ?start ?len s () = of_string ?start ?len s let to_string s = to_string (s ()) let to_buffer buf s = to_buffer buf (s ()) let rand_int i () = rand_int i let int_range ?step i j () = int_range ?step i j let lines g () = lines (g()) let unlines g () = unlines (g()) module Infix = struct let (--) = int_range ~step:1 let (>>=) x f = flat_map f x let (>>|) x f = map f x let (>|=) x f = map f x end include Infix let pp ?start ?stop ?sep ?horizontal pp_elem fmt e = pp ?start ?stop ?sep ?horizontal pp_elem fmt (e ()) let of_gen ?caching ?max_chunk_size g = let cached = ref None in fun () -> match !cached with | Some mlist -> GenMList.to_gen mlist | None -> let mlist = GenMList.of_gen_lazy ?caching ?max_chunk_size g in cached := Some mlist; GenMList.to_gen mlist end (** {2 Generator functions} *) let start g = g () (** Store content of the generator in an enum *) let persistent gen = let l = GenMList.of_gen gen in fun () -> GenMList.to_gen l (*$T let g = 1--10 in let g' = persistent g in \ Restart.to_list g' = Restart.to_list g' let g = 1--10 in let g' = persistent g in \ Restart.to_list g' = [1;2;3;4;5;6;7;8;9;10] *) (*$R let i = ref 0 in let gen () = let j = !i in if j > 5 then None else (incr i; Some j) in let e = Gen.persistent gen in OUnit.assert_equal [0;1;2;3;4;5] (Restart.to_list e); OUnit.assert_equal [0;1;2;3;4;5] (Restart.to_list e); OUnit.assert_equal [0;1;2;3;4;5] (Restart.to_list e); *) let persistent_lazy ?caching ?max_chunk_size gen = let l = GenMList.of_gen_lazy ?caching ?max_chunk_size gen in fun () -> GenMList.to_gen l (*$T let g = 1--1_000_000_000 in let g' = persistent_lazy g in \ (g' () |> take 100 |> to_list = (1--100 |> to_list)) && \ (g' () |> take 200 |> to_list = (1--200 |> to_list)) *) let peek g = let state = ref `Start in let rec next() = match !state with | `Stop -> None | `At x -> begin match g() with | None -> state := `Stop; Some (x,None) | Some y as res -> state := `At y; Some (x, res) end | `Start -> begin match g() with | None -> state := `Stop; None | Some x -> state := `At x; next() end in next (*$= & ~printer:Q.Print.(list (pair int (option int))) [] (peek (of_list []) |> to_list) [1, Some 2; 2, Some 3; 3, Some 4; 4, None] (peek (1 -- 4) |> to_list) *) (*$Q Q.(list int) (fun l -> \ l = [] || (of_list l |> peek |> filter_map snd |> to_list = List.tl l)) *) let queue_to_array_ q = if Queue.is_empty q then [||] else ( let x = Queue.peek q in let a = Array.make (Queue.length q) x in let i = ref 0 in Queue.iter (fun x -> a.(!i) <- x; incr i) q; a ) let peek_n n g = if n<1 then invalid_arg "peek_n"; let state = ref `Start in let q = Queue.create() in let rec next () = match !state with | `Start -> fill n; state := if Queue.is_empty q then `Stop else `Continue; next () | `Continue -> assert (not (Queue.is_empty q)); let x = Queue.pop q in fill 1; state := if Queue.is_empty q then `Stop else `Continue; Some (x, queue_to_array_ q) | `Stop -> None (* add [n] elements to [f] if possible *) and fill i = assert (i + Queue.length q <= n); if i>0 then match g() with | None -> () | Some x -> Queue.push x q; fill (i-1) in next (*$= & ~printer:Q.Print.(list (pair int (array int))) [] (peek_n 1 (of_list []) |> to_list) [1, [|2;3|]; 2, [|3;4|]; 3, [|4|]; 4, [||]] (peek_n 2 (1 -- 4) |> to_list) [1, [|2;3;4|]; 2, [|3;4;5|]; 3, [|4;5|]; 4, [|5|]; 5,[||]] \ (peek_n 3 (1 -- 5) |> to_list) *) (*$QR Q.(list small_int) (fun l -> let l' = of_list l |> peek_n 10 |> filter_map (fun (_,a) -> if a=[||] then None else Some a.(0)) |> to_list in l = [] || l' = List.tl l) *) (** {2 Basic IO} *) module IO = struct let with_file_in ?(mode=0o644) ?(flags=[]) filename f = let ic = open_in_gen flags mode filename in try let x = f ic in close_in_noerr ic; x with e -> close_in_noerr ic; raise e let with_in ?mode ?flags filename f = with_file_in ?mode ?flags filename (fun ic -> let next() = try Some (input_char ic) with End_of_file -> None in f next ) let with_lines ?mode ?flags filename f = with_file_in ?mode ?flags filename (fun ic -> let next() = try Some (input_line ic) with End_of_file -> None in f next ) let with_file_out ?(mode=0o644) ?(flags=[Open_creat;Open_wronly]) filename f = let oc = open_out_gen flags mode filename in try let x = f oc in close_out oc; x with e -> close_out_noerr oc; raise e let write_str ?mode ?flags ?(sep="") filename g = with_file_out ?mode ?flags filename (fun oc -> iteri (fun i s -> if i>0 then output_string oc sep; output_string oc s ) g ) let write ?mode ?flags filename g = with_file_out ?mode ?flags filename (fun oc -> iter (fun c -> output_char oc c) g ) let write_lines ?mode ?flags filename g = with_file_out ?mode ?flags filename (fun oc -> iter (fun s -> output_string oc s; output_char oc '\n') g ) end gen-0.5/src/gen.mldylib000066400000000000000000000002331317735675300150640ustar00rootroot00000000000000# OASIS_START # DO NOT EDIT (digest: bd697a51498f01cda75ad40b61e3c47d) Gen GenLabels GenClone GenMList Gen_intf GenLabels_intf GenM GenM_intf # OASIS_STOP gen-0.5/src/gen.mli000066400000000000000000000120101317735675300142050ustar00rootroot00000000000000 (* This file is free software, part of gen. See file "license" for more details. *) (** {1 Generators} Values of type ['a Gen.t] represent a possibly infinite sequence of values of type 'a. One can only iterate once on the sequence, as it is consumed by iteration/deconstruction/access. [None] is returned when the generator is exhausted. The submodule {!Restart} provides utilities to work with {b restartable generators}, that is, functions [unit -> 'a Gen.t] that allow to build as many generators from the same source as needed. *) (** {2 Global type declarations} *) type 'a t = unit -> 'a option (** A generator may be called several times, yielding the next value each time. It returns [None] when no elements remain *) type 'a gen = 'a t module type S = Gen_intf.S (** {2 Transient generators} *) val get : 'a t -> 'a option (** Get the next value *) val next : 'a t -> 'a option (** Synonym for {!get} *) val get_exn : 'a t -> 'a (** Get the next value, or fails @raise Invalid_argument if no element remains *) val junk : 'a t -> unit (** Drop the next value, discarding it. *) val repeatedly : (unit -> 'a) -> 'a t (** Call the same function an infinite number of times (useful for instance if the function is a random generator). *) include S with type 'a t := 'a gen (** Operations on {b transient} generators *) (** {2 Restartable generators} A {i restartable generator} is a function that produces copies of the same generator, on demand. It has the type [unit -> 'a gen] and it is assumed that every generated returned by the function behaves the same (that is, that it traverses the same sequence of elements). *) module Restart : sig type 'a t = unit -> 'a gen type 'a restartable = 'a t include S with type 'a t := 'a restartable val cycle : 'a t -> 'a t (** Cycle through the enum, endlessly. The enum must not be empty. *) val lift : ('a gen -> 'b) -> 'a t -> 'b val lift2 : ('a gen -> 'b gen -> 'c) -> 'a t -> 'b t -> 'c val of_gen : ?caching:bool -> ?max_chunk_size:int -> 'a gen -> 'a t (** Use {!persistent_lazy} to convert a one-shot generator into a restartable one. See {!GenMList.of_gen_lazy} for more details on parameters. @since 0.4 *) end (** {2 Utils} *) val persistent : 'a t -> 'a Restart.t (** Store content of the transient generator in memory, to be able to iterate on it several times later. If possible, consider using combinators from {!Restart} directly instead. *) val persistent_lazy : ?caching:bool -> ?max_chunk_size:int -> 'a t -> 'a Restart.t (** Same as {!persistent}, but consumes the generator on demand (by chunks). This allows to make a restartable generator out of an ephemeral one, without paying a big cost upfront (nor even consuming it fully). Optional parameters: see {!GenMList.of_gen_lazy}. @since 0.2.2 *) val peek : 'a t -> ('a * 'a option) t (** [peek g] transforms the generator [g] into a generator of [x, Some next] if [x] was followed by [next] in [g], or [x, None] if [x] was the last element of [g] @since 0.4 *) val peek_n : int -> 'a t -> ('a * 'a array) t (** [peek_n n g] iterates on [g], returning along with each element the array of the (at most) [n] elements that follow it immediately @raise Invalid_argument if the int is [< 1] @since 0.4 *) val start : 'a Restart.t -> 'a t (** Create a new transient generator. [start gen] is the same as [gen ()] but is included for readability. *) (** {2 Basic IO} Very basic interface to manipulate files as sequence of chunks/lines. @since 0.2.3 *) module IO : sig val with_in : ?mode:int -> ?flags:open_flag list -> string -> (char t -> 'a) -> 'a (** [with_in filename f] opens [filename] and calls [f g], where [g] is a generator of characters from the file. The generator is only valid within the scope in which [f] is called. *) val with_lines : ?mode:int -> ?flags:open_flag list -> string -> (string t -> 'a) -> 'a (** [with_lines filename f] opens file [filename] and calls [f g], where [g] is a generator that iterates on the lines from the file. Do not use the generator outside of the scope of [f] @since 0.4 *) val write_str : ?mode:int -> ?flags:open_flag list -> ?sep:string -> string -> string t -> unit (** [write_to filename g] writes all strings from [g] into the given file. It takes care of opening and closing the file. Does not add [sep] after the last string. @param mode default [0o644] @param flags used by [open_out_gen]. Default: [[Open_creat;Open_wronly]]. @param sep separator between each string (e.g. newline) *) val write : ?mode:int -> ?flags:open_flag list -> string -> char t -> unit (** Same as {!write_str} but with individual characters *) val write_lines : ?mode:int -> ?flags:open_flag list -> string -> string t -> unit (** [write_lines file g] is similar to [write_str file g ~sep:"\n"] but also adds ['\n'] at the end of the file @since 0.4 *) end gen-0.5/src/gen.mllib000066400000000000000000000002331317735675300145270ustar00rootroot00000000000000# OASIS_START # DO NOT EDIT (digest: bd697a51498f01cda75ad40b61e3c47d) Gen GenLabels GenClone GenMList Gen_intf GenLabels_intf GenM GenM_intf # OASIS_STOP gen-0.5/src/gen.odocl000066400000000000000000000002331317735675300145300ustar00rootroot00000000000000# OASIS_START # DO NOT EDIT (digest: bd697a51498f01cda75ad40b61e3c47d) Gen GenLabels GenClone GenMList Gen_intf GenLabels_intf GenM GenM_intf # OASIS_STOP gen-0.5/src/genClone.ml000066400000000000000000000044241317735675300150270ustar00rootroot00000000000000 (* This file is free software, part of gen. See file "license" for more details. *) (** {1 Clonable Generators} *) type 'a gen = unit -> 'a option class virtual ['a] t = object method virtual gen : 'a gen (** Generator of values tied to this copy *) method virtual clone : 'a t (** Clone the internal state *) end (** A generator that can be cloned as many times as required. *) type 'a clonable = 'a t (** Alias to {!'a t} *) (** {2 Prepend method} *) type 'a prependable = < gen : 'a gen; clone : 'a prependable; prepend : 'a -> unit (** Add value at front position *) > (* helper function for {!to_prependable} *) let rec to_prependable c = let g = c#gen in let st = ref `Fwd in (* state: forward *) let next () = match !st with | `Fwd -> g() | `Yield [] -> assert false | `Yield [x] -> st := `Fwd; Some x | `Yield (x::l) -> st := `Yield l; Some x in object method gen = next method clone = to_prependable (c#clone) method prepend x = st := match !st with | `Fwd -> `Yield [x] | `Yield l -> `Yield (x::l) end (** {2 Misc} *) let rec map f c = let g = c#gen in let next () = match g() with | None -> None | Some x -> Some (f x) in object method gen = next method clone = map f c#clone end (** {2 Basic IO} *) module IO = struct let with_in ?(mode=0o644) ?(flags=[]) filename f = let ic = open_in_gen flags mode filename in let timestamp = ref 0 in (* make a generator at offset [i] *) let rec make i : _ clonable = let state = ref `Not_started in let rec next() = match !state with | `Not_started -> (* initialize by restoring state *) seek_in ic i; incr timestamp; state := `Started !timestamp; next() | `Started t -> (* check whether another iterator was used more recently *) if t < !timestamp then failwith "invalidated iterator"; try Some (input_char ic) with End_of_file -> None in object method clone = let i = pos_in ic in make i method gen = next end in try let x = f (make 0) in close_in_noerr ic; x with e -> close_in_noerr ic; raise e end gen-0.5/src/genClone.mli000066400000000000000000000040261317735675300151760ustar00rootroot00000000000000 (* This file is free software, part of gen. See file "license" for more details. *) (** {1 Clonable Generators} Utils to save the internal state of a generator, and restart from this state. This will and should not work on {i any} iterator, but for some of them (e.g. reading from a file, see {!IO}) it makes a lot of sense. @since 0.2.3 *) type 'a gen = unit -> 'a option type 'a t = < gen : 'a gen; (** Generator of values tied to this copy *) clone : 'a t; (** Clone the internal state *) > (** A generator that can be cloned as many times as required. *) type 'a clonable = 'a t (** Alias to {!'a t} *) (** {2 Prepend method} *) type 'a prependable = < gen : 'a gen; clone : 'a prependable; prepend : 'a -> unit (** Add value at front position *) > val to_prependable : 'a t -> 'a prependable (** {2 Misc} *) val map : ('a -> 'b) -> 'a t -> 'b t (** {2 Low-level Persistency} Example: {[ let g = 1 -- 1000 ;; val g : int t = let c = g |> MList.of_gen_lazy |> MList.to_clonable;; val c : int clonable = c#next |> take 500 |> to_list;; - : int list = [1; 2; 3; .....; 500] let c' = c#clone ;; val c' : int clonable = c |> to_list;; - : int list = [501; 502; ....; 1000] c'#gen |> to_list;; (* c consumed, but not c' *) - : int list = [501; 502; ....; 1000] c#gen |> to_list;; - : int list = [] ]}*) (** {2 IO} *) module IO : sig val with_in : ?mode:int -> ?flags:open_flag list -> string -> (char t -> 'a) -> 'a (** [read filename f] opens [filename] and calls [f g], where [g] is a clonable generator of characters from the file. It can be cloned by calling [g#save] (which saves the position in the file), and used with [g#next]. Distinct clones of [g] shouldn't be used at the same time (otherwise [Failure _] will be raised). Both the generator and save points are only valid within the scope in which [f] is called. *) end gen-0.5/src/genLabels.ml000066400000000000000000000000141317735675300151600ustar00rootroot00000000000000include Gen gen-0.5/src/genLabels.mli000066400000000000000000000101201317735675300153300ustar00rootroot00000000000000 (* This file is free software, part of gen. See file "license" for more details. *) (** {1 Generators} Label version of {!Gen} @since 0.2.4 *) (** {2 Global type declarations} *) type 'a t = unit -> 'a option (** A generator may be called several times, yielding the next value each time. It returns [None] when no elements remain *) type 'a gen = 'a t module type S = GenLabels_intf.S (** {2 Transient generators} *) val get : 'a t -> 'a option (** Get the next value *) val next : 'a t -> 'a option (** Synonym for {!get} *) val get_exn : 'a t -> 'a (** Get the next value, or fails @raise Invalid_argument if no element remains *) val junk : 'a t -> unit (** Drop the next value, discarding it. *) val repeatedly : (unit -> 'a) -> 'a t (** Call the same function an infinite number of times (useful for instance if the function is a random generator). *) include S with type 'a t := 'a gen (** Operations on {b transient} generators *) (** {2 Restartable generators} *) module Restart : sig type 'a t = unit -> 'a gen type 'a restartable = 'a t include S with type 'a t := 'a restartable val cycle : 'a t -> 'a t (** Cycle through the enum, endlessly. The enum must not be empty. *) val lift : ('a gen -> 'b) -> 'a t -> 'b val lift2 : ('a gen -> 'b gen -> 'c) -> 'a t -> 'b t -> 'c end (** {2 Utils} *) val persistent : 'a t -> 'a Restart.t (** Store content of the transient generator in memory, to be able to iterate on it several times later. If possible, consider using combinators from {!Restart} directly instead. *) val persistent_lazy : ?caching:bool -> ?max_chunk_size:int -> 'a t -> 'a Restart.t (** Same as {!persistent}, but consumes the generator on demand (by chunks). This allows to make a restartable generator out of an ephemeral one, without paying a big cost upfront (nor even consuming it fully). Optional parameters: see {!GenMList.of_gen_lazy}. @since 0.2.2 *) val peek : 'a t -> ('a * 'a option) t (** [peek g] transforms the generator [g] into a generator of [x, Some next] if [x] was followed by [next] in [g], or [x, None] if [x] was the last element of [g] @since 0.4 *) val peek_n : n:int -> 'a t -> ('a * 'a array) t (** [peek_n ~n g] iterates on [g], returning along with each element the array of the (at most) [n] elements that follow it immediately @raise Invalid_argument if the int is [< 1] @since 0.4 *) val start : 'a Restart.t -> 'a t (** Create a new transient generator. [start gen] is the same as [gen ()] but is included for readability. *) (** {2 Basic IO} Very basic interface to manipulate files as sequence of chunks/lines. *) module IO : sig val with_in : ?mode:int -> ?flags:open_flag list -> file:string -> (char t -> 'a) -> 'a (** [with_in ~file f] opens [file] and calls [f g], where [g] is a generator of characters from the file. The generator is only valid within the scope in which [f] is called. *) val with_lines : ?mode:int -> ?flags:open_flag list -> file:string -> (string t -> 'a) -> 'a (** [with_lines ~file f] opens file [file] and calls [f g], where [g] is a generator that iterates on the lines from the file. Do not use the generator outside of the scope of [f] @since 0.4 *) val write_str : ?mode:int -> ?flags:open_flag list -> ?sep:string -> file:string -> string t -> unit (** [write_to ~file g] writes all strings from [g] into the given file. It takes care of opening and closing the file. Does not add [sep] after the last string. @param mode default [0o644] @param flags used by [open_out_gen]. Default: [[Open_creat;Open_wronly]]. @param sep separator between each string (e.g. newline) *) val write : ?mode:int -> ?flags:open_flag list -> file:string -> char t -> unit (** Same as {!write_str} but with individual characters *) val write_lines : ?mode:int -> ?flags:open_flag list -> file:string -> string t -> unit (** [write_lines ~file g] is similar to [write_str file g ~sep:"\n"] but also adds ['\n'] at the end of the file @since 0.4 *) end gen-0.5/src/genLabels_intf.ml000066400000000000000000000316121317735675300162100ustar00rootroot00000000000000 (* This file is free software, part of gen. See file "license" for more details. *) (** {1 Common signature for transient and restartable generators} The signature {!S} abstracts on a type ['a t], where the [t] can be the type of transient or restartable generators. Some functions specify explicitely that they use ['a gen] (transient generators). *) type 'a gen = unit -> 'a option module type S = sig type 'a t val empty : 'a t (** Empty generator, with no elements *) val singleton : 'a -> 'a t (** One-element generator *) val return : 'a -> 'a t (** Alias to {!singleton} @since 0.3 *) val repeat : 'a -> 'a t (** Repeat same element endlessly *) val iterate : 'a -> ('a -> 'a) -> 'a t (** [iterate x f] is [[x; f x; f (f x); f (f (f x)); ...]] *) val unfold : ('b -> ('a * 'b) option) -> 'b -> 'a t (** Dual of {!fold}, with a deconstructing operation. It keeps on unfolding the ['b] value into a new ['b], and a ['a] which is yielded, until [None] is returned. *) val init : ?limit:int -> (int -> 'a) -> 'a t (** Calls the function, starting from 0, on increasing indices. If [limit] is provided and is a positive int, iteration will stop at the limit (excluded). For instance [init ~limit:4 id] will yield 0, 1, 2, and 3. *) (** {2 Basic combinators} {b Note}: those combinators, applied to generators (not restartable generators) {i consume} their argument. Sometimes they consume it lazily, sometimes eagerly, but in any case once [f gen] has been called (with [f] a combinator), [gen] shouldn't be used anymore. *) val is_empty : _ t -> bool (** Check whether the gen is empty. Pops an element, if any *) val fold : f:('b -> 'a -> 'b) -> init:'b -> 'a t -> 'b (** Fold on the generator, tail-recursively. Consumes the generator. *) val reduce : f:('a -> 'a -> 'a) -> 'a t -> 'a (** Fold on non-empty sequences. Consumes the generator. @raise Invalid_argument on an empty gen *) val scan : f:('b -> 'a -> 'b) -> init:'b -> 'a t -> 'b t (** Like {!fold}, but keeping successive values of the accumulator. Consumes the generator. *) val unfold_scan : ('b -> 'a -> 'b * 'c) -> 'b -> 'a t -> 'c t (** A mix of {!unfold} and {!scan}. The current state is combined with the current element to produce a new state, and an output value of type 'c. @since 0.2.2 *) val iter : f:('a -> unit) -> 'a t -> unit (** Iterate on the gen, consumes it. *) val iteri : f:(int -> 'a -> unit) -> 'a t -> unit (** Iterate on elements with their index in the gen, from 0, consuming it. *) val length : _ t -> int (** Length of an gen (linear time), consuming it *) val map : f:('a -> 'b) -> 'a t -> 'b t (** Lazy map. No iteration is performed now, the function will be called when the result is traversed. *) val mapi : f:(int -> 'a -> 'b) -> 'a t -> 'b t (** Lazy map with indexing starting from 0. No iteration is performed now, the function will be called when the result is traversed. @since 0.5 *) val fold_map : f:('b -> 'a -> 'b) -> init:'b -> 'a t -> 'b t (** Lazy fold and map. No iteration is performed now, the function will be called when the result is traversed. The result is an iterator over the successive states of the fold. @since 0.2.4 *) val append : 'a t -> 'a t -> 'a t (** Append the two gens; the result contains the elements of the first, then the elements of the second gen. *) val flatten : 'a gen t -> 'a t (** Flatten the generator of generators *) val flat_map : f:('a -> 'b gen) -> 'a t -> 'b t (** Monadic bind; each element is transformed to a sub-gen which is then iterated on, before the next element is processed, and so on. *) val mem : ?eq:('a -> 'a -> bool) -> x:'a -> 'a t -> bool (** Is the given element, member of the gen? *) val take : int -> 'a t -> 'a t (** Take at most n elements *) val drop : int -> 'a t -> 'a t (** Drop n elements *) val nth : int -> 'a t -> 'a (** n-th element, or Not_found @raise Not_found if the generator contains less than [n] arguments *) val take_nth : int -> 'a t -> 'a t (** [take_nth n g] returns every element of [g] whose index is a multiple of [n]. For instance [take_nth 2 (1--10) |> to_list] will return [1;3;5;7;9] *) val filter : f:('a -> bool) -> 'a t -> 'a t (** Filter out elements that do not satisfy the predicate. *) val take_while : f:('a -> bool) -> 'a t -> 'a t (** Take elements while they satisfy the predicate. The initial generator itself is not to be used anymore after this. *) val fold_while : f:('a -> 'b -> 'a * [`Stop | `Continue]) -> init:'a -> 'b t -> 'a (** Fold elements until (['a, `Stop]) is indicated by the accumulator. @since 0.2.4 *) val drop_while : f:('a -> bool) -> 'a t -> 'a t (** Drop elements while they satisfy the predicate. The initial generator itself should not be used anymore, only the result of [drop_while]. *) val filter_map : f:('a -> 'b option) -> 'a t -> 'b t (** Maps some elements to 'b, drop the other ones *) val zip_index : 'a t -> (int * 'a) t (** Zip elements with their index in the gen *) val unzip : ('a * 'b) t -> 'a t * 'b t (** Unzip into two sequences, splitting each pair *) val partition : f:('a -> bool) -> 'a t -> 'a t * 'a t (** [partition p l] returns the elements that satisfy [p], and the elements that do not satisfy [p] *) val for_all : f:('a -> bool) -> 'a t -> bool (** Is the predicate true for all elements? *) val exists : f:('a -> bool) -> 'a t -> bool (** Is the predicate true for at least one element? *) val min : ?lt:('a -> 'a -> bool) -> 'a t -> 'a (** Minimum element, according to the given comparison function. @raise Invalid_argument if the generator is empty *) val max : ?lt:('a -> 'a -> bool) -> 'a t -> 'a (** Maximum element, see {!min} @raise Invalid_argument if the generator is empty *) val eq : ?eq:('a -> 'a -> bool) -> 'a t -> 'a t -> bool (** Equality of generators. *) val lexico : ?cmp:('a -> 'a -> int) -> 'a t -> 'a t -> int (** Lexicographic comparison of generators. If a generator is a prefix of the other one, it is considered smaller. *) val compare : ?cmp:('a -> 'a -> int) -> 'a t -> 'a t -> int (** Synonym for {! lexico} *) val find : f:('a -> bool) -> 'a t -> 'a option (** [find p e] returns the first element of [e] to satisfy [p], or None. *) val sum : int t -> int (** Sum of all elements *) (** {2 Multiple iterators} *) val map2 : f:('a -> 'b -> 'c) -> 'a t -> 'b t -> 'c t (** Map on the two sequences. Stops once one of them is exhausted.*) val iter2 : f:('a -> 'b -> unit) -> 'a t -> 'b t -> unit (** Iterate on the two sequences. Stops once one of them is exhausted.*) val fold2 : f:('acc -> 'a -> 'b -> 'acc) -> init:'acc -> 'a t -> 'b t -> 'acc (** Fold the common prefix of the two iterators *) val for_all2 : f:('a -> 'b -> bool) -> 'a t -> 'b t -> bool (** Succeeds if all pairs of elements satisfy the predicate. Ignores elements of an iterator if the other runs dry. *) val exists2 : f:('a -> 'b -> bool) -> 'a t -> 'b t -> bool (** Succeeds if some pair of elements satisfy the predicate. Ignores elements of an iterator if the other runs dry. *) val zip_with : f:('a -> 'b -> 'c) -> 'a t -> 'b t -> 'c t (** Combine common part of the gens (stops when one is exhausted) *) val zip : 'a t -> 'b t -> ('a * 'b) t (** Zip together the common part of the gens *) (** {2 Complex combinators} *) val merge : 'a gen t -> 'a t (** Pick elements fairly in each sub-generator. The merge of gens [e1, e2, ... ] picks elements in [e1], [e2], in [e3], [e1], [e2] .... Once a generator is empty, it is skipped; when they are all empty, and none remains in the input, their merge is also empty. For instance, [merge [1;3;5] [2;4;6]] will be, in disorder, [1;2;3;4;5;6]. *) val intersection : ?cmp:('a -> 'a -> int) -> 'a t -> 'a t -> 'a t (** Intersection of two sorted sequences. Only elements that occur in both inputs appear in the output *) val sorted_merge : ?cmp:('a -> 'a -> int) -> 'a t -> 'a t -> 'a t (** Merge two sorted sequences into a sorted sequence *) val sorted_merge_n : ?cmp:('a -> 'a -> int) -> 'a t list -> 'a t (** Sorted merge of multiple sorted sequences *) val tee : ?n:int -> 'a t -> 'a gen list (** Duplicate the gen into [n] generators (default 2). The generators share the same underlying instance of the gen, so the optimal case is when they are consumed evenly *) val round_robin : ?n:int -> 'a t -> 'a gen list (** Split the gen into [n] generators in a fair way. Elements with [index = k mod n] with go to the k-th gen. [n] default value is 2. *) val interleave : 'a t -> 'a t -> 'a t (** [interleave a b] yields an element of [a], then an element of [b], and so on. When a generator is exhausted, this behaves like the other generator. *) val intersperse : 'a -> 'a t -> 'a t (** Put the separator element between all elements of the given gen *) val product : 'a t -> 'b t -> ('a * 'b) t (** Cartesian product, in no predictable order. Works even if some of the arguments are infinite. *) val group : ?eq:('a -> 'a -> bool) -> 'a t -> 'a list t (** Group equal consecutive elements together. *) val uniq : ?eq:('a -> 'a -> bool) -> 'a t -> 'a t (** Remove consecutive duplicate elements. Basically this is like [fun e -> map List.hd (group e)]. *) val sort : ?cmp:('a -> 'a -> int) -> 'a t -> 'a t (** Sort according to the given comparison function. The gen must be finite. *) val sort_uniq : ?cmp:('a -> 'a -> int) -> 'a t -> 'a t (** Sort and remove duplicates. The gen must be finite. *) val chunks : int -> 'a t -> 'a array t (** [chunks n e] returns a generator of arrays of length [n], composed of successive elements of [e]. The last array may be smaller than [n] *) val permutations : 'a t -> 'a list t (** Permutations of the gen. @since 0.2.2 *) val permutations_heap : 'a t -> 'a array t (** Permutations of the gen, using Heap's algorithm. @since 0.2.3 *) val combinations : int -> 'a t -> 'a list t (** Combinations of given length. The ordering of the elements within each combination is unspecified. Example (ignoring ordering): [combinations 2 (1--3) |> to_list = [[1;2]; [1;3]; [2;3]]] @since 0.2.2 *) val power_set : 'a t -> 'a list t (** All subsets of the gen (in no particular order). The ordering of the elements within each subset is unspecified. @since 0.2.2 *) (** {2 Basic conversion functions} *) val of_list : 'a list -> 'a t (** Enumerate elements of the list *) val to_list : 'a t -> 'a list (** non tail-call trasnformation to list, in the same order *) val to_rev_list : 'a t -> 'a list (** Tail call conversion to list, in reverse order (more efficient) *) val to_array : 'a t -> 'a array (** Convert the gen to an array (not very efficient) *) val of_array : ?start:int -> ?len:int -> 'a array -> 'a t (** Iterate on (a slice of) the given array *) val of_string : ?start:int -> ?len:int -> string -> char t (** Iterate on bytes of the string *) val to_string : char t -> string (** Convert into a string *) val to_buffer : Buffer.t -> char t -> unit (** Consumes the iterator and writes to the buffer *) val rand_int : int -> int t (** Random ints in the given range. *) val int_range : ?step:int -> int -> int -> int t (** [int_range ~step a b] generates integers between [a] and [b], included, with steps of length [step] (1 if omitted). [a] is assumed to be smaller than [b]. [step] must not be null, but it can be negative for decreasing integers. *) val lines : char t -> string t (** Group together chars belonging to the same line @since 0.3 *) val unlines : string t -> char t (** Explode lines into their chars, adding a ['\n'] after each one @since 0.3 *) module Infix : sig val (--) : int -> int -> int t (** Synonym for {! int_range ~by:1} *) val (>>=) : 'a t -> ('a -> 'b gen) -> 'b t (** Monadic bind operator *) val (>>|) : 'a t -> ('a -> 'b) -> 'b t (** Infix map operator @since 0.2.3 *) val (>|=) : 'a t -> ('a -> 'b) -> 'b t (** Infix map operator @since 0.2.3 *) end val (--) : int -> int -> int t (** Synonym for {! int_range ~by:1} *) val (>>=) : 'a t -> ('a -> 'b gen) -> 'b t (** Monadic bind operator *) val (>>|) : 'a t -> ('a -> 'b) -> 'b t (** Infix map operator @since 0.2.3 *) val (>|=) : 'a t -> ('a -> 'b) -> 'b t (** Infix map operator @since 0.2.3 *) val pp : ?start:string -> ?stop:string -> ?sep:string -> ?horizontal:bool -> (Format.formatter -> 'a -> unit) -> Format.formatter -> 'a t -> unit (** Pretty print the content of the generator on a formatter. *) end gen-0.5/src/genM.ml000066400000000000000000000032661317735675300141660ustar00rootroot00000000000000 (* This file is free software, part of gen. See file "license" for more details. *) (** {1 Monadic Interface} *) module type MONAD = GenM_intf.MONAD module Make(M : MONAD) = struct module M = M let (>>=) = M.(>>=) let (>|=) = M.(>|=) type +'a t = unit -> 'a option M.t let return x = let first = ref true in fun () -> if !first then ( first := false; M.return (Some x) ) else M.return None let sequence_m g () = match g() with | None -> M.return None | Some act -> act >|= fun x -> Some x let map f g () = g() >|= function | None -> None | Some x -> Some (f x) let flat_map f g = let rec next f g () = g() >>= function | None -> M.return None (* done *) | Some x -> let cur = f x in map_from f g cur () and map_from f g cur () = let res = cur() in res >>= function | None -> next f g () | Some _ -> res in next f g let rec fold f acc g = g() >>= function | None -> M.return acc | Some x -> let acc = f acc x in fold f acc g let rec fold_m f acc g = g() >>= function | None -> M.return acc | Some x -> f acc x >>= fun acc -> fold_m f acc g let rec iter f g = g() >>= function | None -> M.return () | Some x -> f x; iter f g let rec iter_s f g = g() >>= function | None -> M.return () | Some x -> f x >>= fun () -> iter_s f g let rec iter_p f g = g() >>= function | None -> M.return () | Some x -> let _ = f x in iter_p f g module Infix = struct let (>|=) x f = map f x let (>>=) x f = flat_map f x end include Infix end gen-0.5/src/genM.mli000066400000000000000000000003761317735675300143360ustar00rootroot00000000000000 (* This file is free software, part of gen. See file "license" for more details. *) (** {1 Monadic Interface} {b status: experimental} @since 0.4 *) module type MONAD = GenM_intf.MONAD module Make(M : MONAD) : GenM_intf.S with module M = M gen-0.5/src/genMList.ml000066400000000000000000000066501317735675300150220ustar00rootroot00000000000000 (* This file is free software, part of gen. See file "license" for more details. *) (** {1 Efficient Mutable Lists} *) type 'a gen = unit -> 'a option type 'a clonable = < gen : 'a gen; (** Generator of values tied to this copy *) clone : 'a clonable; (** Clone the internal state *) > type 'a node = | Nil | Cons of 'a array * int ref * 'a node ref | Cons1 of 'a * 'a node ref | Suspend of 'a gen type 'a t = { start : 'a node ref; (* first node. *) mutable chunk_size : int; max_chunk_size : int; } let _make ~max_chunk_size gen = { start = ref (Suspend gen); chunk_size = 8; max_chunk_size; } let _make_no_buffer gen = { start = ref (Suspend gen); chunk_size = 1; max_chunk_size = 1; } (* increment the size of chunks *) let _incr_chunk_size mlist = if mlist.chunk_size < mlist.max_chunk_size then mlist.chunk_size <- 2 * mlist.chunk_size (* read one chunk of input; return the corresponding node. will potentially change [mlist.chunk_size]. *) let _read_chunk mlist gen = match gen() with | None -> Nil (* done *) | Some x when mlist.max_chunk_size = 1 -> let tail = ref (Suspend gen) in let node = Cons1 (x, tail) in node | Some x -> (* new list node *) let r = ref 1 in let a = Array.make mlist.chunk_size x in let tail = ref (Suspend gen) in let stop = ref false in let node = Cons (a, r, tail) in (* read the rest of the chunk *) while not !stop && !r < mlist.chunk_size do match gen() with | None -> tail := Nil; stop := true | Some x -> a.(!r) <- x; incr r; done; _incr_chunk_size mlist; node (* eager construction *) let of_gen gen = let mlist = _make ~max_chunk_size:4096 gen in let rec _fill prev = match _read_chunk mlist gen with | Nil -> prev := Nil | Suspend _ -> assert false | Cons1 (_, prev') as node -> prev := node; _fill prev' | Cons (_, _, prev') as node -> prev := node; _fill prev' in _fill mlist.start; mlist (* lazy construction *) let of_gen_lazy ?(max_chunk_size=2048) ?(caching=true) gen = if caching then let max_chunk_size = max max_chunk_size 2 in _make ~max_chunk_size gen else _make_no_buffer gen let to_gen l = let cur = ref l.start in let i = ref 0 in let rec next() = match ! !cur with | Nil -> None | Cons1 (x, l') -> cur := l'; Some x | Cons (a,n,l') -> if !i = !n then begin cur := l'; i := 0; next() end else begin let y = a.(!i) in incr i; Some y end | Suspend gen -> let node = _read_chunk l gen in !cur := node; next() in next let to_clonable l : 'a clonable = let rec make node i = let cur = ref node and i = ref i in let rec next() = match ! !cur with | Nil -> None | Cons (a,n,l') -> if !i = !n then begin cur := l'; i := 0; next() end else begin let y = a.(!i) in i := !i+1; Some y end | Cons1 (x, l') -> cur := l'; Some x | Suspend gen -> let node = _read_chunk l gen in (!cur) := node; next() in object method gen = next method clone = make !cur !i end in make l.start 0 gen-0.5/src/genMList.mli000066400000000000000000000034751317735675300151750ustar00rootroot00000000000000 (* This file is free software, part of gen. See file "license" for more details. *) (** {1 Efficient Mutable Lists} Unrolled lists, append-only, used for storing the content of a generator. Example: {[ let g = 1 -- 1000 ;; val g : int t = let c = g |> MList.of_gen_lazy |> MList.to_clonable;; val c : int clonable = c#next |> take 500 |> to_list;; - : int list = [1; 2; 3; .....; 500] let c' = c#clone ;; val c' : int clonable = c |> to_list;; - : int list = [501; 502; ....; 1000] c'#gen |> to_list;; (* c consumed, but not c' *) - : int list = [501; 502; ....; 1000] c#gen |> to_list;; - : int list = [] ]} @since 0.2.3 *) type 'a gen = unit -> 'a option type 'a clonable = < gen : 'a gen; (** Generator of values tied to this copy *) clone : 'a clonable; (** Clone the internal state *) > type 'a t (** An internal append-only storage of elements of type 'a, produced from a generator *) val of_gen : 'a gen -> 'a t (** [of_gen g] consumes [g] to build a mlist *) val of_gen_lazy : ?max_chunk_size:int -> ?caching:bool -> 'a gen -> 'a t (** [of_gen_lazy g] makes a mlist that will read from [g] as required, until [g] is exhausted. Do not use [g] directly after this, or some elements will be absent from the mlist! @param caching if true or absent, values are read from the generator by chunks of increasing size. If false, values are read one by one. @param max_chunk_size if provided and [caching = true], sets the (maximal) size of the internal chunks *) val to_gen : 'a t -> 'a gen (** Iterate on the mlist. This function can be called many times without any problem, the mlist isn't consumable! *) val to_clonable : 'a t -> 'a clonable gen-0.5/src/genM_intf.ml000066400000000000000000000022761317735675300152060ustar00rootroot00000000000000 (* This file is free software, part of gen. See file "license" for more details. *) type 'a gen = unit -> 'a option module type MONAD = sig type +'a t val return : 'a -> 'a t val (>>=) : 'a t -> ('a -> 'b t) -> 'b t val (>|=) : 'a t -> ('a -> 'b) -> 'b t end module type S = sig module M : MONAD type +'a t = unit -> 'a option M.t (** A value of type ['a t] is an iterator over values of type ['a] that live in the monad [M.t]. For instance, if [M] is [Lwt], accessing each element might require some IO operation (reading a file, etc.) *) val return : 'a -> 'a t val sequence_m : 'a M.t gen -> 'a t (** From a generator of actions, return an effectful generator *) val map : ('a -> 'b) -> 'a t -> 'b t val flat_map : ('a -> 'b t) -> 'a t -> 'b t val fold : ('a -> 'b -> 'a) -> 'a -> 'b t -> 'a M.t val fold_m : ('a -> 'b -> 'a M.t) -> 'a -> 'b t -> 'a M.t val iter : ('a -> unit) -> 'a t -> unit M.t val iter_s : ('a -> unit M.t) -> 'a t -> unit M.t val iter_p : ('a -> unit M.t) -> 'a t -> unit M.t module Infix : sig val (>>=) : 'a t -> ('a -> 'b t) -> 'b t val (>|=) : 'a t -> ('a -> 'b) -> 'b t end include module type of Infix end gen-0.5/src/gen_intf.ml000066400000000000000000000316771317735675300151000ustar00rootroot00000000000000 (* This file is free software, part of gen. See file "license" for more details. *) (** {1 Common signature for transient and restartable generators} The signature {!S} abstracts on a type ['a t], where the [t] can be the type of transient or restartable generators. Some functions specify explicitely that they use ['a gen] (transient generators). *) type 'a gen = unit -> 'a option module type S = sig type 'a t val empty : 'a t (** Empty generator, with no elements *) val singleton : 'a -> 'a t (** One-element generator *) val return : 'a -> 'a t (** Alias to {!singleton} @since 0.3 *) val repeat : 'a -> 'a t (** Repeat same element endlessly *) val iterate : 'a -> ('a -> 'a) -> 'a t (** [iterate x f] is [[x; f x; f (f x); f (f (f x)); ...]] *) val unfold : ('b -> ('a * 'b) option) -> 'b -> 'a t (** Dual of {!fold}, with a deconstructing operation. It keeps on unfolding the ['b] value into a new ['b], and a ['a] which is yielded, until [None] is returned. *) val init : ?limit:int -> (int -> 'a) -> 'a t (** Calls the function, starting from 0, on increasing indices. If [limit] is provided and is a positive int, iteration will stop at the limit (excluded). For instance [init ~limit:4 id] will yield 0, 1, 2, and 3. *) (** {2 Basic combinators} {b Note}: those combinators, applied to generators (not restartable generators) {i consume} their argument. Sometimes they consume it lazily, sometimes eagerly, but in any case once [f gen] has been called (with [f] a combinator), [gen] shouldn't be used anymore. *) val is_empty : _ t -> bool (** Check whether the gen is empty. Pops an element, if any *) val fold : ('b -> 'a -> 'b) -> 'b -> 'a t -> 'b (** Fold on the generator, tail-recursively. Consumes the generator. *) val reduce : ('a -> 'a -> 'a) -> 'a t -> 'a (** Fold on non-empty sequences. Consumes the generator. @raise Invalid_argument on an empty gen *) val scan : ('b -> 'a -> 'b) -> 'b -> 'a t -> 'b t (** Like {!fold}, but keeping successive values of the accumulator. Consumes the generator. *) val unfold_scan : ('b -> 'a -> 'b * 'c) -> 'b -> 'a t -> 'c t (** A mix of {!unfold} and {!scan}. The current state is combined with the current element to produce a new state, and an output value of type 'c. @since 0.2.2 *) val iter : ('a -> unit) -> 'a t -> unit (** Iterate on the gen, consumes it. *) val iteri : (int -> 'a -> unit) -> 'a t -> unit (** Iterate on elements with their index in the gen, from 0, consuming it. *) val length : _ t -> int (** Length of an gen (linear time), consuming it *) val map : ('a -> 'b) -> 'a t -> 'b t (** Lazy map. No iteration is performed now, the function will be called when the result is traversed. *) val mapi : (int -> 'a -> 'b) -> 'a t -> 'b t (** Lazy map with indexing starting from 0. No iteration is performed now, the function will be called when the result is traversed. @since 0.5 *) val fold_map : ('b -> 'a -> 'b) -> 'b -> 'a t -> 'b t (** Lazy fold and map. No iteration is performed now, the function will be called when the result is traversed. The result is an iterator over the successive states of the fold. @since 0.2.4 *) val append : 'a t -> 'a t -> 'a t (** Append the two gens; the result contains the elements of the first, then the elements of the second gen. *) val flatten : 'a gen t -> 'a t (** Flatten the generator of generators *) val flat_map : ('a -> 'b gen) -> 'a t -> 'b t (** Monadic bind; each element is transformed to a sub-gen which is then iterated on, before the next element is processed, and so on. *) val mem : ?eq:('a -> 'a -> bool) -> 'a -> 'a t -> bool (** Is the given element, member of the gen? *) val take : int -> 'a t -> 'a t (** Take at most n elements *) val drop : int -> 'a t -> 'a t (** Drop n elements *) val nth : int -> 'a t -> 'a (** n-th element, or Not_found @raise Not_found if the generator contains less than [n] arguments *) val take_nth : int -> 'a t -> 'a t (** [take_nth n g] returns every element of [g] whose index is a multiple of [n]. For instance [take_nth 2 (1--10) |> to_list] will return [1;3;5;7;9] *) val filter : ('a -> bool) -> 'a t -> 'a t (** Filter out elements that do not satisfy the predicate. *) val take_while : ('a -> bool) -> 'a t -> 'a t (** Take elements while they satisfy the predicate. The initial generator itself is not to be used anymore after this. *) val fold_while : ('a -> 'b -> 'a * [`Stop | `Continue]) -> 'a -> 'b t -> 'a (** Fold elements until (['a, `Stop]) is indicated by the accumulator. @since 0.2.4 *) val drop_while : ('a -> bool) -> 'a t -> 'a t (** Drop elements while they satisfy the predicate. The initial generator itself should not be used anymore, only the result of [drop_while]. *) val filter_map : ('a -> 'b option) -> 'a t -> 'b t (** Maps some elements to 'b, drop the other ones *) val zip_index : 'a t -> (int * 'a) t (** Zip elements with their index in the gen *) val unzip : ('a * 'b) t -> 'a t * 'b t (** Unzip into two sequences, splitting each pair *) val partition : ('a -> bool) -> 'a t -> 'a t * 'a t (** [partition p l] returns the elements that satisfy [p], and the elements that do not satisfy [p] *) val for_all : ('a -> bool) -> 'a t -> bool (** Is the predicate true for all elements? *) val exists : ('a -> bool) -> 'a t -> bool (** Is the predicate true for at least one element? *) val min : ?lt:('a -> 'a -> bool) -> 'a t -> 'a (** Minimum element, according to the given comparison function. @raise Invalid_argument if the generator is empty *) val max : ?lt:('a -> 'a -> bool) -> 'a t -> 'a (** Maximum element, see {!min} @raise Invalid_argument if the generator is empty *) val eq : ?eq:('a -> 'a -> bool) -> 'a t -> 'a t -> bool (** Equality of generators. *) val lexico : ?cmp:('a -> 'a -> int) -> 'a t -> 'a t -> int (** Lexicographic comparison of generators. If a generator is a prefix of the other one, it is considered smaller. *) val compare : ?cmp:('a -> 'a -> int) -> 'a t -> 'a t -> int (** Synonym for {! lexico} *) val find : ('a -> bool) -> 'a t -> 'a option (** [find p e] returns the first element of [e] to satisfy [p], or None. *) val sum : int t -> int (** Sum of all elements *) (** {2 Multiple iterators} *) val map2 : ('a -> 'b -> 'c) -> 'a t -> 'b t -> 'c t (** Map on the two sequences. Stops once one of them is exhausted.*) val iter2 : ('a -> 'b -> unit) -> 'a t -> 'b t -> unit (** Iterate on the two sequences. Stops once one of them is exhausted.*) val fold2 : ('acc -> 'a -> 'b -> 'acc) -> 'acc -> 'a t -> 'b t -> 'acc (** Fold the common prefix of the two iterators *) val for_all2 : ('a -> 'b -> bool) -> 'a t -> 'b t -> bool (** Succeeds if all pairs of elements satisfy the predicate. Ignores elements of an iterator if the other runs dry. *) val exists2 : ('a -> 'b -> bool) -> 'a t -> 'b t -> bool (** Succeeds if some pair of elements satisfy the predicate. Ignores elements of an iterator if the other runs dry. *) val zip_with : ('a -> 'b -> 'c) -> 'a t -> 'b t -> 'c t (** Combine common part of the gens (stops when one is exhausted) *) val zip : 'a t -> 'b t -> ('a * 'b) t (** Zip together the common part of the gens *) (** {2 Complex combinators} *) val merge : 'a gen t -> 'a t (** Pick elements fairly in each sub-generator. The merge of gens [e1, e2, ... ] picks elements in [e1], [e2], in [e3], [e1], [e2] .... Once a generator is empty, it is skipped; when they are all empty, and none remains in the input, their merge is also empty. For instance, [merge [1;3;5] [2;4;6]] will be, in disorder, [1;2;3;4;5;6]. *) val intersection : ?cmp:('a -> 'a -> int) -> 'a t -> 'a t -> 'a t (** Intersection of two sorted sequences. Only elements that occur in both inputs appear in the output *) val sorted_merge : ?cmp:('a -> 'a -> int) -> 'a t -> 'a t -> 'a t (** Merge two sorted sequences into a sorted sequence *) val sorted_merge_n : ?cmp:('a -> 'a -> int) -> 'a t list -> 'a t (** Sorted merge of multiple sorted sequences *) val tee : ?n:int -> 'a t -> 'a gen list (** Duplicate the gen into [n] generators (default 2). The generators share the same underlying instance of the gen, so the optimal case is when they are consumed evenly *) val round_robin : ?n:int -> 'a t -> 'a gen list (** Split the gen into [n] generators in a fair way. Elements with [index = k mod n] with go to the k-th gen. [n] default value is 2. *) val interleave : 'a t -> 'a t -> 'a t (** [interleave a b] yields an element of [a], then an element of [b], and so on. When a generator is exhausted, this behaves like the other generator. *) val intersperse : 'a -> 'a t -> 'a t (** Put the separator element between all elements of the given gen *) val product : 'a t -> 'b t -> ('a * 'b) t (** Cartesian product, in no predictable order. Works even if some of the arguments are infinite. *) val group : ?eq:('a -> 'a -> bool) -> 'a t -> 'a list t (** Group equal consecutive elements together. *) val uniq : ?eq:('a -> 'a -> bool) -> 'a t -> 'a t (** Remove consecutive duplicate elements. Basically this is like [fun e -> map List.hd (group e)]. *) val sort : ?cmp:('a -> 'a -> int) -> 'a t -> 'a t (** Sort according to the given comparison function. The gen must be finite. *) val sort_uniq : ?cmp:('a -> 'a -> int) -> 'a t -> 'a t (** Sort and remove duplicates. The gen must be finite. *) val chunks : int -> 'a t -> 'a array t (** [chunks n e] returns a generator of arrays of length [n], composed of successive elements of [e]. The last array may be smaller than [n] *) val permutations : 'a t -> 'a list t (** Permutations of the gen. @since 0.2.2 *) val permutations_heap : 'a t -> 'a array t (** Permutations of the gen, using Heap's algorithm. @since 0.2.3 *) val combinations : int -> 'a t -> 'a list t (** Combinations of given length. The ordering of the elements within each combination is unspecified. Example (ignoring ordering): [combinations 2 (1--3) |> to_list = [[1;2]; [1;3]; [2;3]]] @since 0.2.2 *) val power_set : 'a t -> 'a list t (** All subsets of the gen (in no particular order). The ordering of the elements within each subset is unspecified. @since 0.2.2 *) (** {2 Basic conversion functions} *) val of_list : 'a list -> 'a t (** Enumerate elements of the list *) val to_list : 'a t -> 'a list (** non tail-call trasnformation to list, in the same order *) val to_rev_list : 'a t -> 'a list (** Tail call conversion to list, in reverse order (more efficient) *) val to_array : 'a t -> 'a array (** Convert the gen to an array (not very efficient) *) val of_array : ?start:int -> ?len:int -> 'a array -> 'a t (** Iterate on (a slice of) the given array *) val of_string : ?start:int -> ?len:int -> string -> char t (** Iterate on bytes of the string *) val to_string : char t -> string (** Convert into a string *) val to_buffer : Buffer.t -> char t -> unit (** Consumes the iterator and writes to the buffer *) val rand_int : int -> int t (** Random ints in the given range. *) val int_range : ?step:int -> int -> int -> int t (** [int_range ~step a b] generates integers between [a] and [b], included, with steps of length [step] (1 if omitted). [a] is assumed to be smaller than [b], otherwise the result will be empty. @raise Invalid_argument if [step=0] @param step step between two numbers; must not be zero, but it can be negative for decreasing ranges (@since 0.5). *) val lines : char t -> string t (** Group together chars belonging to the same line @since 0.3 *) val unlines : string t -> char t (** Explode lines into their chars, adding a ['\n'] after each one @since 0.3 *) module Infix : sig val (--) : int -> int -> int t (** Synonym for {! int_range ~by:1} *) val (>>=) : 'a t -> ('a -> 'b gen) -> 'b t (** Monadic bind operator *) val (>>|) : 'a t -> ('a -> 'b) -> 'b t (** Infix map operator @since 0.2.3 *) val (>|=) : 'a t -> ('a -> 'b) -> 'b t (** Infix map operator @since 0.2.3 *) end val (--) : int -> int -> int t (** Synonym for {! int_range ~by:1} *) val (>>=) : 'a t -> ('a -> 'b gen) -> 'b t (** Monadic bind operator *) val (>>|) : 'a t -> ('a -> 'b) -> 'b t (** Infix map operator @since 0.2.3 *) val (>|=) : 'a t -> ('a -> 'b) -> 'b t (** Infix map operator @since 0.2.3 *) val pp : ?start:string -> ?stop:string -> ?sep:string -> ?horizontal:bool -> (Format.formatter -> 'a -> unit) -> Format.formatter -> 'a t -> unit (** Pretty print the content of the generator on a formatter. *) end