why3session_html.ml 17.4 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
(**************************************************************************)
(*                                                                        *)
(*  Copyright (C) 2010-2011                                               *)
(*    François Bobot                                                      *)
(*    Jean-Christophe Filliâtre                                           *)
(*    Claude Marché                                                       *)
(*    Andrei Paskevich                                                    *)
(*                                                                        *)
(*  This software is free software; you can redistribute it and/or        *)
(*  modify it under the terms of the GNU Library General Public           *)
(*  License version 2.1, with the special exception on linking            *)
(*  described in file LICENSE.                                            *)
(*                                                                        *)
(*  This software is distributed in the hope that it will be useful,      *)
(*  but WITHOUT ANY WARRANTY; without even the implied warranty of        *)
(*  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.                  *)
(*                                                                        *)
(**************************************************************************)

20
open Format
21
open Why3
22
open Why3session_lib
23

24 25
module S = Session

26
let output_dir = ref ""
27
let opt_context = ref false
28

29
type style = SimpleTree | Jstree | Table
30

31 32
let opt_style = ref Table
let default_style = "table"
33 34

let set_opt_style = function
35
  | "simple" -> opt_style := SimpleTree
36
  | "jstree" -> opt_style := Jstree
37 38 39 40 41
  | "table" -> opt_style := Table
  | _ -> 
    eprintf "Unknown html style, ignored@."

let () = set_opt_style default_style
42

43 44 45 46 47 48 49 50 51
let opt_pp = ref []

let set_opt_pp_in,set_opt_pp_cmd,set_opt_pp_out =
  let suf = ref "" in
  let cmd = ref "" in
  (fun s -> suf := s),
  (fun s -> cmd := s),
  (fun s -> opt_pp := (!suf,(!cmd,s))::!opt_pp)

52
let spec =
53 54
  ("-o",
   Arg.Set_string output_dir,
55 56 57
   " The directory to output the files ('-' for stdout)") ::
  ("--context", Arg.Set opt_context,
   " Add context around the generated code in order to allow direct \
58
    visualisation (header, css, ...). It also add in the directory \
59
    all the needed external file. It can't be set with stdout output") ::
60 61 62 63 64
  ("--style", Arg.Symbol (["simpletree";"jstree";"table"], set_opt_style),
   " Set the style to use, defaults to '" ^ default_style ^ "'."
(* "'simple' use only 'ul' and 'il' tag. 'jstree' use \
    the 'jstree' plugin of the javascript library 'jquery'." *)
) ::
65
  ("--add_pp", Arg.Tuple
66 67 68 69 70 71
    [Arg.String set_opt_pp_in;
     Arg.String set_opt_pp_cmd;
     Arg.String set_opt_pp_out],
  "<suffix> <cmd> <out_suffix> \
Add for the given prefix the given pretty-printer, \
the new file as the given out_suffix. cmd must contain '%i' which will be \
72 73 74
replace by the input file and '%o' which will be replaced by the output file.") ::
  ("--coqdoc",
   Arg.Unit (fun ()->
75
    opt_pp := (".v",("coqdoc --no-index --html -o %o %i",".html"))::!opt_pp),
76
  " same as '--add_pp .v \"coqdoc --no-index --html -o %o %i\" .html'") ::
77
  common_options
78

François Bobot's avatar
François Bobot committed
79
open Session
80 81
open Util

82
type context =
83
    (string ->
François Bobot's avatar
François Bobot committed
84
     (formatter -> notask session -> unit) -> notask session
85 86
     -> unit, formatter, unit) format

87 88 89 90 91 92 93 94 95 96 97
let run_file (context : context) print_session fname =
  let project_dir = Session.get_project_dir fname in
  let session = Session.read_session project_dir in
  let output_dir =
    if !output_dir = "" then project_dir else !output_dir
  in
  let basename = Filename.basename project_dir in
  let cout =
    if output_dir = "-" then stdout else
      open_out (Filename.concat output_dir (basename^".html"))
  in
98 99 100 101 102 103 104 105
  let fmt = formatter_of_out_channel cout in
  if !opt_context
  then fprintf fmt context basename (print_session basename) session
  else print_session basename fmt session;
  pp_print_flush fmt ();
  if output_dir <> "-" then close_out cout


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
module Table =
struct


  let rec transf_depth tr =
    List.fold_left
      (fun depth g -> max depth (goal_depth g)) 0 tr.S.transf_goals
  and goal_depth g =
    S.PHstr.fold
      (fun _st tr depth -> max depth (1 + transf_depth tr))
      g.S.goal_transformations 1

  let theory_depth t =
    List.fold_left
      (fun depth g -> max depth (goal_depth g)) 0 t.S.theory_goals

  let rec provers_stats provers theory =
    S.theory_iter_proof_attempt (fun a ->
      Hashtbl.replace provers a.S.proof_prover a.S.proof_prover) theory

  let print_prover = Whyconf.print_prover


  let color_of_status ?(dark=false) fmt b = 
    fprintf fmt "%s" (if b then 
        if dark then "008000" else "C0FFC0" 
      else "FF0000")

let print_results fmt provers proofs =
  List.iter (fun p ->
    fprintf fmt "<td bgcolor=\"#";
    begin
      try
        let pr = S.PHprover.find proofs p in
        let s = pr.S.proof_state in
        match s with
	  | S.Done res ->
	    begin
	      match res.Call_provers.pr_answer with
		| Call_provers.Valid ->
                  fprintf fmt "C0FFC0\">%.2f" res.Call_provers.pr_time
		| Call_provers.Invalid ->
                  fprintf fmt "FF0000\">Invalid"
		| Call_provers.Timeout ->
                  fprintf fmt "FF8000\">Timeout"
		| Call_provers.Unknown _ ->
MARCHE Claude's avatar
MARCHE Claude committed
152
                  fprintf fmt "FF8000\">%.2f" res.Call_provers.pr_time
153
		| _ ->
MARCHE Claude's avatar
MARCHE Claude committed
154
                  fprintf fmt "FF8000\">Failure "
155
	    end
MARCHE Claude's avatar
MARCHE Claude committed
156 157
	  | _ -> fprintf fmt "E0E0E0\">Undone"
      with Not_found -> fprintf fmt "E0E0E0\">---"
158 159 160
    end;
    fprintf fmt "</td>") provers

MARCHE Claude's avatar
MARCHE Claude committed
161 162 163 164 165 166 167
let rec num_lines acc tr =
  List.fold_left
    (fun acc g -> 1 + 
      PHstr.fold (fun _ tr acc -> 1 + num_lines acc tr) 
      g.goal_transformations acc)
    acc tr.transf_goals

168 169 170
  let rec print_transf fmt depth max_depth provers tr =
    fprintf fmt "<tr>";
    for i=1 to 0 (* depth-1 *) do fprintf fmt "<td></td>" done;
MARCHE Claude's avatar
MARCHE Claude committed
171 172 173 174 175
    fprintf fmt "<td bgcolor=\"#%a\" colspan=\"%d\">" 
      (color_of_status ~dark:false) tr.S.transf_verified 
      (max_depth - depth + 1);
    (* for i=1 to depth-1 do fprintf fmt "&nbsp;&nbsp;&nbsp;&nbsp;" done; *)
    fprintf fmt "%s</td>" tr.transf_name ;
176 177 178 179
    for i=1 (* depth *) to (*max_depth - 1 + *) List.length provers do
      fprintf fmt "<td bgcolor=\"#E0E0E0\"></td>"
    done;
    fprintf fmt "</tr>@\n";
MARCHE Claude's avatar
MARCHE Claude committed
180 181 182 183 184 185 186 187 188 189 190 191 192 193
    fprintf fmt "<td rowspan=\"%d\">&nbsp;&nbsp;</td>" (num_lines 0 tr);
    let (_:bool) = List.fold_left
      (fun is_first g ->
        print_goal fmt is_first (depth+1) max_depth provers g;
        false)
      true tr.transf_goals
    in ()

  and print_goal fmt is_first depth max_depth provers g =
    if not is_first then fprintf fmt "<tr>";
    (* for i=1 to 0 (\* depth-1 *\) do fprintf fmt "<td></td>" done; *)
    fprintf fmt "<td bgcolor=\"#%a\" colspan=\"%d\">" 
      (color_of_status ~dark:false) g.S.goal_verified (max_depth - depth + 1);
    (* for i=1 to depth-1 do fprintf fmt "&nbsp;&nbsp;&nbsp;&nbsp;" done; *)
194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215
    fprintf fmt "%s</td>" (S.goal_expl g);
(*    for i=depth to max_depth-1 do fprintf fmt "<td></td>" done; *)
    print_results fmt provers g.goal_external_proofs;
    fprintf fmt "</tr>@\n";
    PHstr.iter
      (fun _ tr -> print_transf fmt depth max_depth provers tr)
      g.goal_transformations

  let print_theory fmt th =
    let depth = theory_depth th in
    if depth > 0 then
    let provers = Hashtbl.create 9 in
    provers_stats provers th;
    let provers =
      Hashtbl.fold (fun _ pr acc -> pr :: acc) provers []
    in
    let provers = List.sort Whyconf.Prover.compare provers in
    let name = th.S.theory_name.Ident.id_string in
    fprintf fmt "<h2><font color=\"#%a\">Theory \"%s\": %s</font></h2>@\n" 
      (color_of_status ~dark:true) th.S.theory_verified
      name (if th.S.theory_verified then "fully verified" else "not fully verified")
    ;
MARCHE Claude's avatar
MARCHE Claude committed
216

217
    fprintf fmt "<table border=\"1\"><tr><td colspan=\"%d\">Obligations</td>" depth;
MARCHE Claude's avatar
MARCHE Claude committed
218
    (* fprintf fmt "<table border=\"1\"><tr><td>Obligations</td>"; *)
219 220 221 222
    List.iter
      (fun pr -> fprintf fmt "<td text-rotation=\"90\">%a</td>" print_prover pr)
      provers;
    fprintf fmt "</td></tr>@\n";
MARCHE Claude's avatar
MARCHE Claude committed
223
    List.iter (print_goal fmt true 1 depth provers) th.theory_goals;
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 254 255 256
    fprintf fmt "</table>@\n"

  let print_file fmt f =
    (* fprintf fmt "<h1>File %s</h1>@\n" f.file_name; *)
    fprintf fmt "%a"
      (Pp.print_list Pp.newline print_theory) f.file_theories

  let print_session name fmt s =
    fprintf fmt "<h1>Why3 Proof Results for Project \"%s\"</h1>@\n" name;
    fprintf fmt "%a"
      (Pp.print_iter2 PHstr.iter Pp.newline Pp.nothing Pp.nothing
         print_file) s.session_files


  let context : context = "<!DOCTYPE html
PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\"
\"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">
<html xmlns=\"http://www.w3.org/1999/xhtml\">
<head>
<title>Why3 session of %s</title>
</head>
<body>
%a
</body>
</html>
"

  let run_one = run_file context print_session

end



257 258 259
module Simple =
struct

260
  let print_prover = Whyconf.print_prover
261 262

  let print_proof_status fmt = function
François Bobot's avatar
François Bobot committed
263
    | Undone _ -> fprintf fmt "Undone"
264 265 266
    | Done pr -> fprintf fmt "Done : %a" Call_provers.print_prover_result pr
    | InternalFailure exn ->
      fprintf fmt "Failure : %a"Exn_printer.exn_printer exn
267

268 269
  let print_proof_attempt fmt pa =
    fprintf fmt "<li>%a : %a</li>"
François Bobot's avatar
François Bobot committed
270
      print_prover pa.proof_prover
271 272 273 274 275
      print_proof_status pa.proof_state

  let rec print_transf fmt tr =
    fprintf fmt "<li>%s : <ul>%a</ul></li>"
      tr.transf_name
François Bobot's avatar
François Bobot committed
276
      (Pp.print_list Pp.newline print_goal) tr.transf_goals
277 278 279

  and print_goal fmt g =
    fprintf fmt "<li>%s : <ul>%a%a</ul></li>"
François Bobot's avatar
François Bobot committed
280 281
      g.goal_name.Ident.id_string
      (Pp.print_iter2 PHprover.iter Pp.newline Pp.nothing
282
         Pp.nothing print_proof_attempt)
François Bobot's avatar
François Bobot committed
283 284
      g.goal_external_proofs
      (Pp.print_iter2 PHstr.iter Pp.newline Pp.nothing
285
         Pp.nothing print_transf)
François Bobot's avatar
François Bobot committed
286
      g.goal_transformations
287 288 289

  let print_theory fmt th =
    fprintf fmt "<li>%s : <ul>%a</ul></li>"
François Bobot's avatar
François Bobot committed
290 291
      th.theory_name.Ident.id_string
      (Pp.print_list Pp.newline print_goal) th.theory_goals
292 293 294 295

  let print_file fmt f =
    fprintf fmt "<li>%s : <ul>%a</ul></li>"
      f.file_name
François Bobot's avatar
François Bobot committed
296
      (Pp.print_list Pp.newline print_theory) f.file_theories
297 298 299

  let print_session _name fmt s =
    fprintf fmt "<ul>%a</ul>"
François Bobot's avatar
François Bobot committed
300 301
      (Pp.print_iter2 PHstr.iter Pp.newline Pp.nothing Pp.nothing
         print_file) s.session_files
302 303 304


  let context : context = "<!DOCTYPE html
305 306 307 308
PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\"
\"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">
<html xmlns=\"http://www.w3.org/1999/xhtml\">
<head>
309
<title>Why3 session of %s</title>
310 311 312 313 314 315
</head>
<body>
%a
</body>
</html>
"
316

317
  let run_one = run_file context print_session
318

319
end
320

321

322 323 324
module Jstree =
struct

325 326 327 328 329
  let print_verified fmt b =
    if b
    then fprintf fmt "class='verified'"
    else fprintf fmt "class='notverified'"

330
  let print_prover = Whyconf.print_prover
331 332

  let print_proof_status fmt = function
François Bobot's avatar
François Bobot committed
333
    | Undone _ -> fprintf fmt "<span class='notverified'>Undone</span>"
334 335
    | Done pr -> fprintf fmt "<span class='verified'>Done : %a</span>"
      Call_provers.print_prover_result pr
336
    | InternalFailure exn ->
337 338
      fprintf fmt "<span class='notverified'>Failure : %a</span>"
        Exn_printer.exn_printer exn
339

340 341 342 343 344 345 346 347 348 349 350 351 352 353
  let cmd_regexp = Str.regexp "%\\(.\\)"

  let pp_run input cmd output =
    let replace s = match Str.matched_group 1 s with
      | "%" -> "%"
      | "i" -> input
      | "o" -> output
      | _ -> failwith "unknown format specifier, use %%i, %%o"
    in
    let cmd = Str.global_substitute cmd_regexp replace cmd in
    let c = Sys.command cmd in
    if c <> 0 then
      eprintf "[Error] '%s' stopped abnormaly : code %i" cmd c

354 355
 let edited_dst = Filename.concat !output_dir "edited"

356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375
  let find_pp edited =
    let basename = Filename.basename edited in
    try
      let suff,(cmd,suff_out) =
        List.find (fun (s,_) -> ends_with basename s) !opt_pp in
      let base =
        String.sub basename 0 (String.length basename - String.length suff) in
      let base_dst = (base^suff_out) in
      if !opt_context then
        pp_run edited cmd (Filename.concat edited_dst base_dst);
      base_dst
    with Not_found ->
      eprintf "Default %s@." basename;
      (** default printer *)
      let base = try Filename.chop_extension basename with _ -> basename in
      let base_dst = base^".txt" in
      if !opt_context then
        Sysutil.copy_file edited (Filename.concat edited_dst base_dst);
      base_dst

376
  let print_proof_attempt fmt pa =
François Bobot's avatar
François Bobot committed
377
    match pa.proof_edited_as with
378 379
      | None ->
        fprintf fmt "@[<hov><li rel='prover' ><a href='#'>%a : %a</a></li>@]"
François Bobot's avatar
François Bobot committed
380
          print_prover pa.proof_prover
381 382 383 384 385 386
          print_proof_status pa.proof_state
      | Some f ->
        let output = find_pp f in
        fprintf fmt "@[<hov><li rel='prover' ><a href='#' \
onclick=\"showedited('%s'); return false;\">%a : %a</a></li>@]"
          output
François Bobot's avatar
François Bobot committed
387
          print_prover pa.proof_prover
388
          print_proof_status pa.proof_state
389 390 391

  let rec print_transf fmt tr =
    fprintf fmt
392 393 394
      "@[<hov><li rel='transf'><a href='#'>\
<span %a>%s</span></a>@,<ul>%a</ul></li>@]"
      print_verified tr.transf_verified
395
      tr.transf_name
François Bobot's avatar
François Bobot committed
396
      (Pp.print_list Pp.newline print_goal) tr.transf_goals
397 398 399

  and print_goal fmt g =
    fprintf fmt
400 401 402
      "@[<hov><li rel='goal'><a href='#'>\
<span %a>%s</a></a>@,<ul>%a%a</ul></li>@]"
      print_verified g.goal_verified
François Bobot's avatar
François Bobot committed
403 404
      g.goal_name.Ident.id_string
      (Pp.print_iter2 PHprover.iter Pp.newline Pp.nothing
405
         Pp.nothing print_proof_attempt)
François Bobot's avatar
François Bobot committed
406 407
      g.goal_external_proofs
      (Pp.print_iter2 PHstr.iter Pp.newline Pp.nothing
408
         Pp.nothing print_transf)
François Bobot's avatar
François Bobot committed
409
      g.goal_transformations
410 411 412

  let print_theory fmt th =
    fprintf fmt
413 414 415
      "@[<hov><li rel='theory'><a href='#'>\
<span %a>%s</span></a>@,<ul>%a</ul></li>@]"
      print_verified th.theory_verified
François Bobot's avatar
François Bobot committed
416 417
      th.theory_name.Ident.id_string
      (Pp.print_list Pp.newline print_goal) th.theory_goals
418 419

  let print_file fmt f =
420 421 422 423
    fprintf fmt
      "@[<hov><li rel='file'><a href='#'>\
<span %a>%s</span></a>@,<ul>%a</ul></li>@]"
      print_verified f.file_verified
424
      f.file_name
François Bobot's avatar
François Bobot committed
425
      (Pp.print_list Pp.newline print_theory) f.file_theories
426 427 428 429

  let print_session_aux name fmt s =
    fprintf fmt "@[<hov><ul><a href='#'>%s</a>@,%a</ul>@]"
      name
François Bobot's avatar
François Bobot committed
430 431
      (Pp.print_iter2 PHstr.iter Pp.newline Pp.nothing Pp.nothing print_file)
      s.session_files
432 433 434 435 436 437 438 439 440 441 442 443 444 445


  let print_session name fmt s =
    fprintf fmt
      "<a href='#' onclick=\"$('#%s_session').jstree('open_all');\">
expand all
</a> <a href='#' onclick=\"$('#%s_session').jstree('close_all');\">
close all
</a>
<div id=\"%s_session\" class=\"session\">
%a
</div>
<script type=\"text/javascript\" class=\"source\">
$(function () {
446
  $(\"#%s_session\").jstree({
447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480
      \"types\" : {
	   \"types\" : {
	   \"file\" : {
		\"icon\" : { \"image\" : \"images/folder16.png\"},
		      },
	   \"theory\" : {
		\"icon\" : { \"image\" : \"images/folder16.png\"},
		      },
	   \"goal\" : {
		\"icon\" : { \"image\" : \"images/file16.png\"},
		      },
	   \"prover\" : {
		\"icon\" : { \"image\" : \"images/wizard16.png\"},
		      },
	   \"transf\" : {
		\"icon\" : { \"image\" : \"images/configure16.png\"},
		      },
                        }
                },
      \"plugins\" : [\"themes\",\"html_data\",\"types\"]
        });
});
</script>
"
  name name name (print_session_aux name) s name


  let context : context = "<!DOCTYPE html
PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\"
\"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">
<html xmlns=\"http://www.w3.org/1999/xhtml\">
<head>
    <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />
    <title>Why3 session of %s</title>
481 482
    <link rel=\"stylesheet\" type=\"text/css\"
     href=\"javascript/session.css\" />
483
    <script type=\"text/javascript\" src=\"javascript/jquery.js\"></script>
484 485 486 487
    <script type=\"text/javascript\" src=\"javascript/jquery.jstree.js\">\
</script>
    <script type=\"text/javascript\" src=\"javascript/session.js\">\
</script>
488 489 490
</head>
<body>
%a
491 492 493 494 495 496 497 498
<iframe src=\"\"  id='edited'>
<p>Your browser does not support iframes.</p>
</iframe>
<script type=\"text/javascript\" class=\"source\">
$(function () {
  $('#edited').hide()
})
</script>
499 500 501 502
</body>
</html>
"

503
  let run_files config =
504 505
    if !opt_context then
      if not (Sys.file_exists edited_dst) then Unix.mkdir edited_dst 0o755;
506
    iter_files (run_file context print_session);
507
    if !opt_context then
508
      let data_dir = Whyconf.datadir (Whyconf.get_main config) in
509 510
      (** copy images *)
      let img_dir_src = Filename.concat data_dir "images" in
511
      let img_dir_dst = Filename.concat !output_dir "images" in
512 513 514 515 516 517 518 519
      if not (Sys.file_exists img_dir_dst) then Unix.mkdir img_dir_dst 0o755;
      List.iter (fun img_name ->
        let from = Filename.concat img_dir_src img_name in
        let to_  = Filename.concat img_dir_dst img_name in
        Sysutil.copy_file from to_)
        ["folder16.png";"file16.png";"wizard16.png";"configure16.png"];
      (** copy javascript *)
      let js_dir_src = Filename.concat data_dir "javascript" in
520
      let js_dir_dst = Filename.concat !output_dir "javascript" in
521 522 523 524 525
      Sysutil.copy_dir js_dir_src js_dir_dst

end


526 527

let run () =
528
  let _,config,should_exit1 = read_env_spec () in
529
  if should_exit1 then exit 1;
530 531 532 533
  match !opt_style with
    | Table -> iter_files Table.run_one
    | SimpleTree -> iter_files Simple.run_one
    | Jstree -> Jstree.run_files config
534 535 536 537 538 539 540 541


let cmd =
  { cmd_spec = spec;
    cmd_desc = "output session in HTML format.";
    cmd_name = "html";
    cmd_run  = run;
  }
542 543 544 545 546 547 548


(*
Local Variables:
compile-command: "unset LANG; make -C ../.. bin/why3session.byte"
End:
*)