helm/software/components/binaries/transcript/engine.ml

   1 (* Copyright (C) 2000, HELM Team.
   2  *
   3  * This file is part of HELM, an Hypertextual, Electronic
   4  * Library of Mathematics, developed at the Computer Science
   5  * Department, University of Bologna, Italy.
   6  *
   7  * HELM is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation; either version 2
  10  * of the License, or (at your option) any later version.
  11  *
  12  * HELM is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with HELM; if not, write to the Free Software
  19  * Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  20  * MA  02111-1307, USA.
  21  *
  22  * For details, see the HELM World-Wide-Web page,
  23  * http://cs.unibo.it/helm/.
  24  *)
  25
  26 module R  = Helm_registry
  27 module X  = HExtlib
  28 module T  = Types
  29 module G  = Grafite
  30 module HG = Http_getter
  31
  32 module O = Options
  33
  34 type script = {
  35    name    : string;
  36    is_ma   : bool;
  37    contents: T.items
  38 }
  39
  40 type status = {
  41    heading_path: string;
  42    heading_lines: int;
  43    input_package: string;
  44    output_package: string;
  45    input_base_uri: string;
  46    output_base_uri: string;
  47    input_path: string;
  48    output_path: string;
  49    input_type: T.input_kind;
  50    output_type: T.output_kind;
  51    input_ext: string;
  52    remove_lines: int;
  53    excludes: string list;
  54    includes: (string * string) list;
  55    coercions: (string * string) list;
  56    files: string list;
  57    requires: (string * string) list;
  58    scripts: script array
  59 }
  60
  61 let default_script = {
  62    name = ""; is_ma = false; contents = []
  63 }
  64
  65 let default_scripts = 2
  66
  67 let load_registry registry =
  68    let suffix = ".conf.xml" in
  69    let registry =
  70       if Filename.check_suffix registry suffix then registry
  71       else registry ^ suffix
  72    in
  73    Printf.eprintf "reading configuration %s ...\n" registry; flush stderr;
  74    R.load_from registry
  75
  76 let set_files st =
  77    let eof ich = try Some (input_line ich) with End_of_file -> None in
  78    let trim l = Filename.chop_extension (Str.string_after l 2) in
  79    let cmd = Printf.sprintf "cd %s && find -name '*%s'" st.input_path st.input_ext in
  80    let ich = Unix.open_process_in cmd in
  81    let rec aux files = match eof ich with
  82       | None   -> List.rev files
  83       | Some l ->
  84          let l = trim l in
  85          if List.mem l st.excludes then aux files else aux (l :: files)
  86    in
  87    let files = aux [] in
  88    let _ = Unix.close_process_in ich in
  89    {st with files = files}
  90
  91 let set_requires st =
  92    let map file = (Filename.basename file, file) in
  93    let requires = List.rev_map map st.files in
  94    {st with requires = requires}
  95
  96 let init () =
  97    let transcript_dir = Filename.dirname Sys.argv.(0) in
  98    let default_registry = Filename.concat transcript_dir "transcript" in
  99    let matita_registry = Filename.concat !O.cwd "matita" in
 100    load_registry default_registry;
 101    load_registry matita_registry;
 102    HG.init ()
 103
 104 let make registry =
 105    let id x = x in
 106    let get_pairs = R.get_list (R.pair id id) in
 107    let get_input_type key1 key2 =
 108       match R.get_string key1, R.get_string key2 with
 109          | "gallina8", _ -> T.Gallina8, ".v", []
 110          | "grafite", "" -> T.Grafite "", ".ma", []
 111          | "grafite", s  -> T.Grafite s, ".ma", [s]
 112          | _          -> failwith "unknown input type"
 113    in
 114    let get_output_type key =
 115       match R.get_string key with
 116          | "procedural"  -> T.Procedural
 117          | "declarative" -> T.Declarative
 118          | _             -> failwith "unknown output type"
 119    in
 120    load_registry registry;
 121    let input_type, input_ext, excludes =
 122       get_input_type "package.input_type" "package.theory_file"
 123    in
 124    let st = {
 125       heading_path = R.get_string "transcript.heading_path";
 126       heading_lines = R.get_int "transcript.heading_lines";
 127       input_package = R.get_string "package.input_name";
 128       output_package = R.get_string "package.output_name";
 129       input_base_uri = R.get_string "package.input_base_uri";
 130       output_base_uri = R.get_string "package.output_base_uri";
 131       input_path = R.get_string "package.input_path";
 132       output_path = R.get_string "package.output_path";
 133       input_type = input_type;
 134       output_type = get_output_type "package.output_type";
 135       input_ext = input_ext;
 136       remove_lines = R.get_int "package.heading_lines";
 137       excludes = excludes;
 138       includes = get_pairs "package.include";
 139       coercions = get_pairs "package.coercion";
 140       files = [];
 141       requires = [];
 142       scripts = Array.make default_scripts default_script
 143    } in
 144    let st = {st with
 145       heading_path = Filename.concat !O.cwd st.heading_path;
 146       input_path = Filename.concat !O.cwd st.input_path;
 147       output_path = Filename.concat !O.cwd st.output_path
 148    } in
 149    prerr_endline "reading file names ...";
 150    let st = set_files st in
 151    let st = set_requires st in
 152    st
 153
 154 let get_index st name =
 155    let rec get_index name i =
 156       if i >= Array.length st.scripts then None else
 157       if st.scripts.(i).name = name then Some i else
 158       get_index name (succ i)
 159    in
 160    match get_index name 0, get_index "" 0 with
 161       | Some i, _ | _, Some i -> i
 162       | None, None            -> failwith "not enought script entries"
 163
 164 let is_ma st name =
 165    let i = get_index st name in
 166    let script = st.scripts.(i) in
 167    st.scripts.(i) <- {script with is_ma = true}
 168
 169 let set_items st name items =
 170    let i = get_index st name in
 171    let script = st.scripts.(i) in
 172    let contents = List.rev_append items script.contents in
 173    st.scripts.(i) <- {script with name = name; contents = contents}
 174
 175 let set_heading st name =
 176    let heading = st.heading_path, st.heading_lines in
 177    set_items st name [T.Heading heading]
 178
 179 let require st name inc =
 180    set_items st name [T.Include inc]
 181
 182 let get_coercion st str =
 183    try List.assoc str st.coercions with Not_found -> ""
 184
 185 let make_path path =
 186    List.fold_left Filename.concat "" (List.rev path)
 187
 188 let make_prefix path =
 189    String.concat "__" (List.rev path) ^ "__"
 190
 191 let make_script_name st script name =
 192    let ext = if script.is_ma then ".ma" else ".mma" in
 193    Filename.concat st.output_path (name ^ ext)
 194
 195 let commit st name =
 196    let i = get_index st name in
 197    let script = st.scripts.(i) in
 198    let path = Filename.concat st.output_path (Filename.dirname name) in
 199    let name = make_script_name st script name in
 200    let cmd = Printf.sprintf "mkdir -p %s" path in
 201    let _ = Sys.command cmd in
 202    let och = open_out name in
 203    G.commit st.output_type och script.contents;
 204    close_out och;
 205    st.scripts.(i) <- default_script
 206
 207 let produce st =
 208    let init name = set_heading st name in
 209    let partition = function
 210       | T.Coercion (false, _)
 211       | T.Notation (false, _) -> false
 212       | _                     -> true
 213    in
 214    let get_items = match st.input_type with
 215       | T.Gallina8  -> Gallina8Parser.items Gallina8Lexer.token
 216       | T.Grafite _ -> GrafiteParser.items GrafiteLexer.token
 217    in
 218    let produce st name =
 219       let in_base_uri = Filename.concat st.input_base_uri name in
 220       let out_base_uri = Filename.concat st.output_base_uri name in
 221       let filter path = function
 222          | T.Inline (b, k, obj, p, f)   ->
 223             let obj, p =
 224                if b then Filename.concat (make_path path) obj, make_prefix path
 225                else obj, p
 226             in
 227             let s = obj ^ G.string_of_inline_kind k in
 228             path, Some (T.Inline (b, k, Filename.concat in_base_uri s, p, f))
 229          | T.Include s                  ->
 230             begin
 231                try path, Some (T.Include (List.assoc s st.requires))
 232                with Not_found -> path, None
 233             end
 234          | T.Coercion (b, obj)          ->
 235             let str = get_coercion st obj in
 236             if str <> "" then path, Some (T.Coercion (b, str)) else
 237             let base_uri = if b then out_base_uri else in_base_uri in
 238             let s = obj ^ G.string_of_inline_kind T.Con in
 239             path, Some (T.Coercion (b, Filename.concat base_uri s))
 240          | T.Section (b, id, _) as item ->
 241             let path = if b then id :: path else List.tl path in
 242             path, Some item
 243          | T.Verbatim s                 ->
 244             let pat, templ = st.input_base_uri, st.output_base_uri in
 245             path, Some (T.Verbatim (Pcre.replace ~pat ~templ s))
 246          | item                         -> path, Some item
 247       in
 248       let set_includes st name =
 249          try require st name (List.assoc name st.includes)
 250          with Not_found -> ()
 251       in
 252       let rec remove_lines ich n =
 253          if n > 0 then let _ =  input_line ich in remove_lines ich (pred n)
 254       in
 255       Printf.eprintf "processing file name: %s ...\n" name; flush stderr;
 256       let file = Filename.concat st.input_path name in
 257       let ich = open_in (file ^ st.input_ext) in
 258       begin try remove_lines ich st.remove_lines with End_of_file -> () end;
 259       let lexbuf = Lexing.from_channel ich in
 260       try
 261          let items = get_items lexbuf in close_in ich;
 262          let _, rev_items = X.list_rev_map_filter_fold filter [] items in
 263          let items = List.rev rev_items in
 264          let local_items, global_items = List.partition partition items in
 265          let comment = T.Line (Printf.sprintf "From %s" name) in
 266          if global_items <> [] then
 267             set_items st st.input_package (comment :: global_items);
 268          init name;
 269          begin match st.input_type with
 270             | T.Grafite "" -> require st name file
 271             | _            -> require st name st.input_package
 272          end;
 273          set_includes st name; set_items st name local_items; commit st name
 274       with e ->
 275          prerr_endline (Printexc.to_string e); close_in ich
 276    in
 277    is_ma st st.input_package;
 278    init st.input_package; require st st.input_package "preamble";
 279    match st.input_type with
 280       | T.Grafite "" ->
 281          List.iter (produce st) st.files
 282       | T.Grafite s  ->
 283          let theory = Filename.concat st.input_path s in
 284          require st st.input_package theory;
 285          List.iter (produce st) st.files;
 286          commit st st.input_package
 287       | _            ->
 288          List.iter (produce st) st.files;
 289          commit st st.input_package