helm/software/helena/src/toplevel/top.ml

   1 (*
   2     ||M||  This file is part of HELM, an Hypertextual, Electronic
   3     ||A||  Library of Mathematics, developed at the Computer Science
   4     ||T||  Department, University of Bologna, Italy.
   5     ||I||
   6     ||T||  HELM is free software; you can redistribute it and/or
   7     ||A||  modify it under the terms of the GNU General Public License
   8     \   /  version 2 or (at your option) any later version.
   9      \ /   This software is distributed as is, NO WARRANTY.
  10       V_______________________________________________________________ *)
  11
  12 module F  = Filename
  13 module P  = Printf
  14
  15 module U  = NUri
  16 module C  = Cps
  17 module L  = Log
  18 module Y  = Time
  19 module G  = Options
  20 module H  = Hierarchy
  21 module E  = Entity
  22 module O  = Output
  23 module S  = Status
  24 module DO = CrgOutput
  25 module TD = TxtCrg
  26 module AA = AutProcess
  27 module AO = AutOutput
  28 module AD = AutCrg
  29 module XL = XmlLibrary
  30 module XD = XmlCrg
  31 module BD = BrgCrg
  32 module BO = BrgOutput
  33 module BR = BrgReduction
  34 module BU = BrgUntrusted
  35 module BG = BrgGrafite
  36 module ZD = BagCrg
  37 module ZO = BagOutput
  38 module ZT = BagType
  39 module ZU = BagUntrusted
  40
  41 type status = {
  42    kst: S.status;
  43    tst: TD.status;
  44    pst: AA.status;
  45    ast: AD.status;
  46    ac : AO.counters;
  47    dc : DO.counters;
  48    bc : BO.counters;
  49    zc : ZO.counters;
  50    och: out_channel option;
  51 }
  52
  53 let level = 0
  54
  55 let bag_error st s msg =
  56    L.error st.kst.S.lenv ZO.specs (L.Warn s :: msg)
  57
  58 let brg_error st s msg =
  59    L.error st.kst.S.lenv BR.specs (L.Warn s :: msg)
  60
  61 let initial_status () = {
  62    kst = S.initial_status ();
  63    tst = TD.initial_status ();
  64    pst = AA.initial_status ();
  65    ast = AD.initial_status ();
  66    ac  = AO.initial_counters;
  67    dc  = DO.initial_counters;
  68    bc  = BO.initial_counters;
  69    zc  = ZO.initial_counters;
  70    och = None;
  71 }
  72
  73 let refresh_status st = {st with
  74    kst = S.refresh_status st.kst;
  75    tst = TD.refresh_status st.tst;
  76    ast = AD.refresh_status st.ast;
  77 }
  78
  79 (* kernel related ***********************************************************)
  80
  81 type kernel_entity = BrgEntity of Brg.entity
  82                    | BagEntity of Bag.entity
  83                    | CrgEntity of Crg.entity
  84
  85 let print_counters st = function
  86    | G.Crg -> DO.print_counters C.start st.dc
  87    | G.Brg -> BO.print_counters C.start st.bc
  88    | G.Bag -> ZO.print_counters C.start st.zc
  89
  90 let xlate_entity st entity = match !G.kernel, entity with
  91    | G.Brg, CrgEntity e ->
  92       let f e = (BrgEntity e) in E.xlate f BD.brg_of_crg e
  93    | G.Bag, CrgEntity e ->
  94       let f e = (BagEntity e) in E.xlate f (ZD.bag_of_crg st.kst.S.lenv) e
  95    | _, entity          -> entity
  96
  97 let pp_progress e =
  98    let f _ na u =
  99       let s = U.string_of_uri u in
 100       let err () = L.warn 2 (P.sprintf "<%s>" s) in
 101       let f i = L.warn 2 (P.sprintf "[%u] <%s>" i s) in
 102       E.apix err f na
 103    in
 104    match e with
 105       | CrgEntity e -> E.common f e
 106       | BrgEntity e -> E.common f e
 107       | BagEntity e -> E.common f e
 108
 109 let count_entity st = function
 110    | BrgEntity e -> {st with bc = BO.count_entity C.start st.bc e}
 111    | BagEntity e -> {st with zc = ZO.count_entity C.start st.zc e}
 112    | CrgEntity e -> {st with dc = DO.count_entity C.start st.dc e}
 113
 114 let export_entity st = function
 115    | CrgEntity e -> XL.export_entity (XD.export_term st.kst.S.lenv) e
 116    | BrgEntity e -> XL.export_entity (BO.export_term st.kst.S.lenv) e
 117    | BagEntity e -> XL.export_entity (ZO.export_term st.kst.S.lenv) e
 118
 119 let type_check st k =
 120    let brg_err msg = brg_error st "Type Error" msg; failwith "Interrupted" in
 121    let bag_err msg = bag_error st "Type Error" msg; failwith "Interrupted" in
 122    let ok _ _ = st in
 123    match k with
 124       | BrgEntity entity -> BU.type_check brg_err ok st.kst entity
 125       | BagEntity entity -> ZU.type_check bag_err ok st.kst entity
 126       | CrgEntity _      -> st
 127
 128 let validate st k =
 129    let brg_err msg = brg_error st "Validation Error" msg; failwith "Interrupted" in
 130    let ok _ = st in
 131    match k with
 132       | BrgEntity entity ->
 133          let st = BU.validate brg_err ok st.kst entity in
 134          begin match st.och with
 135             | None     -> st
 136             | Some och ->
 137                if BG.output_entity st.kst.S.lenv och entity then st
 138                else begin L.warn level "Matita exportation stopped"; {st with och = None} end
 139          end
 140       | BagEntity _      -> st
 141       | CrgEntity _      -> st
 142
 143 (* extended lexer ***********************************************************)
 144
 145 type 'token lexer = {
 146    parse : Lexing.lexbuf -> 'token;
 147    mutable tokbuf: 'token option;
 148    mutable unget : bool
 149 }
 150
 151 let initial_lexer parse = {
 152    parse = parse; tokbuf = None; unget = false
 153 }
 154
 155 let token xl lexbuf = match xl.tokbuf with
 156    | Some token when xl.unget ->
 157       xl.unget <- false; token
 158    | _                        ->
 159       let token = xl.parse lexbuf in
 160       xl.tokbuf <- Some token; token
 161
 162 (* input related ************************************************************)
 163
 164 type input = Text | Automath
 165
 166 type input_entity = TxtEntity of Txt.command
 167                   | AutEntity of Aut.command
 168                   | NoEntity
 169
 170 let type_of_input name =
 171    if F.check_suffix name ".hln" then Text
 172    else if F.check_suffix name ".aut" then
 173       let _ = H.set_sorts 0 ["Set"; "Prop"] in
 174       assert (H.set_graph "Z2");
 175       Automath
 176    else begin
 177       L.warn level (P.sprintf "Unknown file type: %s" name); exit 2
 178    end
 179
 180 let txt_xl = initial_lexer TxtLexer.token
 181
 182 let aut_xl = initial_lexer AutLexer.token
 183
 184 let parbuf = ref [] (* parser buffer *)
 185
 186 let gen_text command =
 187    parbuf := TxtEntity command :: !parbuf
 188
 189 let entity_of_input lexbuf i = match i, !parbuf with
 190    | Automath, _    ->
 191       begin match AutParser.entry (token aut_xl) lexbuf with
 192          | Some e -> aut_xl.unget <- true; AutEntity e
 193          | None   -> NoEntity
 194       end
 195    | Text, []       ->
 196       begin match TxtParser.entry (token txt_xl) lexbuf with
 197          | Some e -> txt_xl.unget <- true; TxtEntity e
 198          | None   -> NoEntity
 199       end
 200    | Text, hd :: tl ->
 201       parbuf := tl; hd
 202
 203 let process_input f st = function
 204    | AutEntity e     ->
 205       let f pst e = f {st with pst = pst} (AutEntity e) in
 206       AA.process_command f st.pst e
 207    | xe              -> f st xe
 208
 209 let count_input st = function
 210    | AutEntity e -> {st with ac = AO.count_command C.start st.ac e}
 211    | xe          -> st
 212
 213 (****************************************************************************)
 214
 215 let version = ref true
 216 let preprocess = ref false
 217 let root = ref ""
 218 let export = ref false
 219 let st = ref (initial_status ())
 220 let streaming = ref false (* parsing style (temporary) *)
 221
 222 let process_2 st entity =
 223    let st = if !G.summary then count_entity st entity else st in
 224    if !export then export_entity st entity;
 225    if !G.stage >= 3 then
 226       let f = if !version then validate else type_check in
 227       f st entity
 228    else st
 229
 230 let process_1 st entity =
 231    if !G.trace >= 3 then pp_progress entity;
 232    let st = if !G.summary then count_entity st entity else st in
 233    if !export && !G.stage = 1 then export_entity st entity;
 234    if !G.stage >= 2 then process_2 st (xlate_entity st entity) else st
 235
 236 let process_0 st entity =
 237    let f st entity =
 238       if !G.stage = 0 then st else
 239       match entity with
 240          | AutEntity e ->
 241             let err ast = {st with ast = ast} in
 242             let g ast e = process_1 {st with ast = ast} (CrgEntity e) in
 243             AD.crg_of_aut err g st.kst st.ast e
 244          | TxtEntity e ->
 245             let crr tst = {st with tst = tst} in
 246             let d tst e = process_1 {st with tst = tst} (CrgEntity e) in
 247             TD.crg_of_txt crr d gen_text st.tst e
 248          | NoEntity    -> assert false
 249    in
 250    let st = if !G.summary then count_input st entity else st in
 251    if !preprocess then process_input f st entity else f st entity
 252
 253 let process_nostreaming st lexbuf input =
 254    let id x = x in
 255    let rec aux1 book = match entity_of_input lexbuf input with
 256       | NoEntity -> List.rev book
 257       | e        -> aux1 (id e :: book)
 258    in
 259    let rec aux2 st = function
 260       | []           -> st
 261       | entity :: tl -> aux2 (process_0 st entity) tl
 262    in
 263    aux2 st (aux1 [])
 264
 265 let process_streaming st lexbuf input =
 266    let rec aux st = match entity_of_input lexbuf input with
 267       | NoEntity -> st
 268       | e        -> aux (process_0 st e)
 269    in
 270    aux st
 271
 272 (****************************************************************************)
 273
 274 let process st name =
 275    let process = if !streaming then process_streaming else process_nostreaming in
 276    let input = type_of_input name in
 277    let ich = open_in name in
 278    let lexbuf = Lexing.from_channel ich in
 279    let st = process st lexbuf input in
 280    close_in ich;
 281 (*   if !G.cc then XL.export_csys st.kst.S.cc; *)
 282    st, input
 283
 284 let main =
 285    let print_version () = L.warn level (G.version_string ^ "\n"); exit 0 in
 286    let set_hierarchy s =
 287       if H.set_graph s then () else
 288          L.warn level (P.sprintf "Unknown type hierarchy: %s" s)
 289    in
 290    let set_kernel = function
 291       | "brg" -> G.kernel := G.Brg
 292       | "bag" -> G.kernel := G.Bag
 293       | s     -> L.warn level (P.sprintf "Unknown kernel version: %s" s)
 294    in
 295    let set_trace i =
 296       if !G.trace = 0 && i > 0 then Y.gmtime G.version_string;
 297       if !G.trace > 0 && i = 0 then Y.utime_stamp "at exit";
 298       G.trace := i;
 299       if i <= 1 then G.summary := false;
 300       if i <= 1 then preprocess := false
 301    in
 302    let set_summary () =
 303       if !G.trace >= 2 then G.summary := true
 304    in
 305    let set_preprocess () =
 306       if !G.trace >= 2 then begin preprocess := true; G.summary := true end
 307    in
 308    let set_stage i = G.stage := i in
 309    let set_madir s = G.ma_dir := s in
 310    let set_xdir s = G.xdir := s in
 311    let set_root s = root := s in
 312    let clear_options () =
 313       export := false; preprocess := false;
 314       root := "";
 315       st := initial_status ();
 316       G.clear (); H.clear (); O.clear_reductions ();
 317       streaming := false;
 318       version := true
 319    in
 320    let set_ma_preamble fname = G.ma_preamble := fname in
 321    let process_file name =
 322       if !G.trace >= 2 then L.warn 1 (P.sprintf "Processing file: %s" name);
 323       if !G.trace >= 2 then Y.utime_stamp "started";
 324       let base_name = Filename.chop_extension (Filename.basename name) in
 325       let cover = F.concat !root base_name in
 326       if !G.stage <= 1 then G.kernel := G.Crg;
 327       G.cover := cover;
 328       if !G.ma_preamble <> "" then st := {!st with och = Some (BG.open_out base_name)};
 329       let sst, input = process (refresh_status !st) name in
 330       st := begin match sst.och with
 331          | None     -> sst
 332          | Some och -> BG.close_out och; {sst with och = None}
 333       end;
 334       if !G.trace >= 2 then Y.utime_stamp "processed";
 335       if !G.summary then begin
 336          AO.print_counters C.start !st.ac;
 337          if !preprocess then AO.print_process_counters C.start !st.pst;
 338          if !G.stage >= 1 then print_counters !st G.Crg;
 339          if !G.stage >= 2 then print_counters !st !G.kernel;
 340          if !G.stage >= 3 then O.print_reductions ()
 341       end
 342    in
 343    let exit () =
 344       if !G.trace >= 1 then Y.utime_stamp "at exit"
 345    in
 346    let help =
 347       "Usage: helena [ -LPVXdgilopqtx1 | -Ts <number> | -MO <dir> | -m <file> | -hkr <string> ]* [ <file> ]*\n\n" ^
 348       "Trace levels: 0 just errors (default), 1 time stamps, 2 processed files, \
 349        3 typing information, 4 reduction information\n\n" ^
 350       "Stages: 0 parsing, 1 to intermediate, 2 to untrusted, 3 to trusted (default)\n"
 351    in
 352    let help_L = " show lexer debug information" in
 353    let help_M = "<dir>  set location of output directory (Grafite) to <dir> (default: current directory)" in
 354    let help_O = "<dir>  set location of output directory (XML) to <dir> (default: current directory)" in
 355    let help_P = " show parser debug information" in
 356    let help_T = "<number>  set trace level (see above)" in
 357    let help_V = " show version information" in
 358    let help_X = " clear options" in
 359
 360    let help_d = " show summary information (requires trace >= 2)" in
 361    let help_g = " always expand global definitions" in
 362    let help_h = "<string>  set type hierarchy (default: \"Z1\")" in
 363    let help_i = " show local references by index" in
 364    let help_k = "<string>  set kernel version (default: \"brg\")" in
 365    let help_l = " disambiguate binders level (Automath)" in
 366    let help_m = "<file>  export kernel entities (Grafite) setting location of preamble to <file> (default: empty)" in
 367    let help_o = " activate sort inclusion (default: false)" in
 368    let help_p = " preprocess source (Automath)" in
 369    let help_q = " disable quotation of identifiers" in
 370    let help_r = "<string>  set initial segment of URI hierarchy (default: empty)" in
 371    let help_s = "<number>  set translation stage (see above)" in
 372    let help_t = " type check [version 1]" in
 373    let help_x = " export kernel entities (XML)" in
 374
 375    let help_1 = " parse files with streaming policy" in
 376    at_exit exit;
 377    Arg.parse [
 378       ("-L", Arg.Set G.debug_lexer, help_L);
 379       ("-M", Arg.String set_madir, help_M);
 380       ("-O", Arg.String set_xdir, help_O);
 381       ("-P", Arg.Set G.debug_parser, help_P);
 382       ("-T", Arg.Int set_trace, help_T);
 383       ("-V", Arg.Unit print_version, help_V);
 384       ("-X", Arg.Unit clear_options, help_X);
 385       ("-d", Arg.Unit set_summary, help_d);
 386       ("-g", Arg.Set G.expand, help_g);
 387       ("-h", Arg.String set_hierarchy, help_h);
 388       ("-i", Arg.Set G.indexes, help_i);
 389       ("-k", Arg.String set_kernel, help_k);
 390       ("-l", Arg.Set G.cc, help_l);
 391       ("-m", Arg.String set_ma_preamble, help_m);
 392       ("-o", Arg.Set G.si, help_o);
 393       ("-p", Arg.Unit set_preprocess, help_p);
 394       ("-q", Arg.Set G.unquote, help_q);
 395       ("-r", Arg.String set_root, help_r);
 396       ("-s", Arg.Int set_stage, help_s);
 397       ("-t", Arg.Clear version, help_t);
 398       ("-x", Arg.Set export, help_x);
 399       ("-1", Arg.Set streaming, help_1);
 400    ] process_file help;