package forester
A tool for tending mathematical forests
Install
Dune Dependency
Authors
Maintainers
Sources
4.2.0.tar.gz
md5=7543fe7acbdfeb2056dc0b774965239f
sha512=2317bf84588692bbbd40e5fa944faab4889474e4a058e336bd1165f6dd8e55e8979affab098248c87354acdc3b6e6927305553ff5ab6b002b6739719814ec080
doc/src/forester.frontend/Forest.ml.html
Source file Forest.ml
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253
open Eio.Std open Forester_prelude open Forester_core open Forester_render module M = Addr_map type config = {env : Eio_unix.Stdenv.base; assets_dirs : Eio.Fs.dir_ty Eio.Path.t list; theme_dir : Eio.Fs.dir_ty Eio.Path.t; root : string option; stylesheet : string; ignore_tex_cache : bool; no_assets: bool; no_theme: bool} type raw_forest = Code.tree list type forest = {trees : Sem.tree M.t; run_query : Sem.query -> Addr_set.t} module LaTeX_queue = LaTeX_queue.Make () let plant_forest (trees : raw_forest) : forest = let module Ev = Eval.Make () in let add_tree addr tree trees = if M.mem addr trees then begin Reporter.emitf Duplicate_tree "skipping duplicate tree at address `%a`" pp_addr addr; trees end else M.add addr tree trees in let unexpanded_trees = let alg acc (tree : Code.tree) = match tree.addr with | Some addr -> add_tree (User_addr addr) tree acc | None -> acc in List.fold_left alg M.empty trees in let (_, trees) = let import_graph = Import_graph.build_import_graph trees in let task addr (units, trees) = let tree = M.find_opt addr unexpanded_trees in match tree with | None -> units, trees | Some tree -> let units, syn = Expand.expand_tree units tree in let tree, emitted_trees = Ev.eval_tree ~addr ~source_path:tree.source_path syn in let add trees (tree : Sem.tree) = add_tree tree.fm.addr tree trees in units, List.fold_left add trees @@ tree :: emitted_trees in Import_graph.Topo.fold task import_graph (Expand.UnitMap.empty, M.empty) in {trees; run_query = Ev.run_query} let rec random_not_in keys = let attempt = Random.int (36*36*36*36 - 1) in if Seq.fold_left (fun x y -> x || y) false (Seq.map (fun k -> k = attempt) keys) then random_not_in keys else attempt let split_addr addr = (* primitively check for address of form YYYY-MM-DD *) let date_regex = Str.regexp {|^[0-9][0-9][0-9][0-9]-[0-9][0-9]-[0-9][0-9]$|} in if Str.string_match date_regex addr 0 then (addr, None) else match String.rindex_opt addr '-' with | Some i -> let prefix = String.sub addr 0 i and suffix = String.sub addr (i + 1) (String.length addr - i - 1) in begin match BaseN.Base36.int_of_string suffix with | Some key -> prefix, Some key | None -> addr, None end | _ -> addr, None let next_addr ~prefix ~mode (forest : string Seq.t) = let keys = forest |> Seq.filter_map @@ fun addr -> let prefix', key = split_addr addr in if prefix = prefix' then key else None in let next = match mode with | `Sequential -> 1 + Seq.fold_left max 0 keys | `Random -> random_not_in keys in prefix ^ "-" ^ BaseN.Base36.string_of_int next let create_tree ~cfg ~addrs ~dest ~prefix ~template ~mode = let next = next_addr addrs ~prefix ~mode in let fname = next ^ ".tree" in let now = Date.now () in let template_content = match template with | None -> "" | Some name -> Eio.Path.load Eio.Path.(Eio.Stdenv.cwd cfg.env / "templates" / (name ^ ".tree")) in let body = Format.asprintf "\\date{%a}\n" Date.pp now in let create = `Exclusive 0o644 in let path = Eio.Path.(dest / fname) in Eio.Path.save ~create path @@ body ^ template_content; next let complete ~forest prefix = forest.trees |> M.filter_map (fun _ -> Sem.Util.peek_title) |> M.filter (fun _ -> String.starts_with ~prefix) |> M.to_seq |> Seq.filter_map (fun (addr, x) -> Addr.to_user_addr addr |> Option.map (fun s -> s, x)) module Prefix_map = Map.Make (String) let prefixes ~addrs = let cat_maybes = List.fold_left (fun acc x -> match x with Some x -> x :: acc | None -> acc) [] in let split_and_add_to_map map addr = let prefix, ix = split_addr addr in Prefix_map.add_to_list prefix ix map in addrs |> Seq.fold_left split_and_add_to_map Prefix_map.empty |> Prefix_map.map cat_maybes let taxa ~forest = forest.trees |> M.filter_map (fun _ -> Sem.Util.taxon) |> M.to_seq |> Seq.filter_map (fun (addr, x) -> Addr.to_user_addr addr |> Option.map (fun s -> s, x)) let ~forest = forest.trees |> M.map Sem.Util.tags |> M.filter (fun _ -> fun -> not @@ List.is_empty tags) |> M.to_seq |> Seq.filter_map (fun (addr, x) -> Addr.to_user_addr addr |> Option.map (fun s -> s, x)) let render_json ~cfg ~cwd docs = let root = cfg.root in Yojson.Basic.to_file "./output/forest.json" @@ Render_json.render_trees ~dev:false ~root docs let fname = String.starts_with ~prefix:"." fname let copy_theme ~env ~theme_dir = let cwd = Eio.Stdenv.cwd env in Eio.Path.read_dir theme_dir |> List.iter @@ fun fname -> if not @@ is_hidden_file fname then Eio.Path.native @@ Eio.Path.(theme_dir / fname) |> Option.iter @@ fun source -> Eio_util.copy_to_dir ~env ~cwd ~source ~dest_dir:"output" let copy_assets ~env ~assets_dirs = let cwd = Eio.Stdenv.cwd env in assets_dirs |> List.iter @@ fun assets_dir -> Eio.Path.read_dir assets_dir |> List.iter @@ fun fname -> if not @@ is_hidden_file fname then let path = Eio.Path.(assets_dir / fname) in let source = Eio.Path.native_exn path in Eio_util.copy_to_dir ~env ~cwd ~source ~dest_dir:"build"; Eio_util.copy_to_dir ~env ~cwd ~source ~dest_dir:"output" let copy_resources ~env = let cwd = Eio.Stdenv.cwd env in Eio.Path.read_dir Eio.Path.(cwd / "build") |> List.iter @@ fun fname -> if not @@ is_hidden_file fname then let ext = Filename.extension fname in let fp = Format.sprintf "build/%s" fname in let dest_opt = match ext with | ".svg" -> Some "output/resources" | _ -> None in dest_opt |> Option.iter @@ fun dest_dir -> if not @@ Eio_util.file_exists Eio.Path.(cwd / dest_dir / fname) then Eio_util.copy_to_dir ~cwd ~env ~source:fp ~dest_dir let last_changed env forest scope = let (let*) = Option.bind in let* tree = M.find_opt scope forest.trees in let* source_path = tree.fm.source_path in let path = Eio.Path.(Eio.Stdenv.fs env / source_path) in let stat = Eio.Path.stat ~follow:true path in let* mtime = Some stat.mtime in let* ptime = Ptime.of_float_s mtime in let (yyyy, mm, dd) = ptime |> Ptime.to_date_time |> fst in Some (Date.{yyyy; mm = Some mm; dd = Some dd}) let render_trees ~cfg ~(forest : forest) ~render_only : unit = let env = cfg.env in let cwd = Eio.Stdenv.cwd env in Eio_util.ensure_dir @@ Eio.Path.(cwd / "build"); Eio_util.ensure_dir_path cwd ["output"; "resources"]; let module I = struct let root, trees, run_query, last_changed, enqueue_latex = cfg.root, forest.trees, forest.run_query, last_changed env forest, LaTeX_queue.enqueue end in let module C = Compile.Make (I) () in let module Sxml = Serialise_xml_tree.Make (I) () in let render_tree (tree : Sem.tree) = let addr = tree.fm.addr in let create = `Or_truncate 0o644 in let path = Eio.Path.(cwd / "output" / Serialise_xml_tree.route ~root:cfg.root addr) in Eio.Path.with_open_out ~create path @@ fun flow -> Eio.Buf_write.with_flow flow @@ fun writer -> let fmt = Eio_util.formatter_of_writer writer in tree |> C.compile_tree |> Sxml.pp ~stylesheet:cfg.stylesheet fmt in let trees = match render_only with | None -> forest.trees |> M.to_seq |> Seq.map snd |> List.of_seq | Some addrs -> addrs |> List.map @@ fun addr -> match M.find_opt addr forest.trees with | Some tree -> tree | None -> Reporter.fatalf Tree_not_found "Could not find tree with address `%a` when rendering forest" pp_addr addr in trees |> Sem.Util.sort |> List.iter render_tree; render_json ~cfg ~cwd forest.trees; if not cfg.no_assets then copy_assets ~env ~assets_dirs:cfg.assets_dirs; if not cfg.no_theme then copy_theme ~env ~theme_dir:cfg.theme_dir; let _ = LaTeX_queue.process ~env ~ignore_tex_cache:cfg.ignore_tex_cache in copy_resources ~env
sectionYPositions = computeSectionYPositions($el), 10)"
x-init="setTimeout(() => sectionYPositions = computeSectionYPositions($el), 10)"
>