why3session_latex.ml 14.2 KB
Newer Older
Andrei Paskevich's avatar
Andrei Paskevich committed
1 2 3 4 5 6 7 8 9 10
(********************************************************************)
(*                                                                  *)
(*  The Why3 Verification Platform   /   The Why3 Development Team  *)
(*  Copyright 2010-2012   --   INRIA - CNRS - Paris-Sud University  *)
(*                                                                  *)
(*  This software is distributed under the terms of the GNU Lesser  *)
(*  General Public License version 2.1, with the special exception  *)
(*  on linking described in file LICENSE.                           *)
(*                                                                  *)
(********************************************************************)
11 12 13 14 15 16 17 18

open Why3
open Why3session_lib
open Format


module S = Session

19 20
let opt_style = ref 1
let opt_output_dir = ref ""
21
let opt_longtable = ref false
22 23 24 25 26 27 28 29
let opt_elements = ref None

let add_element s =
  let l = match !opt_elements with
    | None -> [s]
    | Some r -> s :: r
  in
  opt_elements := Some l
30 31

let spec =
32
  ("-style",
33
   Arg.Set_int opt_style,
34 35
   "<n> sets output style (1 or 2, default 1)") ::
  ("-o",
36
   Arg.Set_string opt_output_dir,
37
   "<dir> where to produce LaTeX files (default: session dir)") ::
Andrei Paskevich's avatar
Andrei Paskevich committed
38
  ("-e",
39 40
   Arg.String add_element,
   "<path> produce a table for the element denoted by <path>") ::
41 42
  ("-longtable",
   Arg.Set opt_longtable,
MARCHE Claude's avatar
MARCHE Claude committed
43
   " use 'longtable' environment instead of 'tabular'") ::
44
  common_options
45 46 47 48 49 50 51 52 53 54 55 56 57 58


(* Statistics in LaTeX*)

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 0

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

59 60 61 62
let file_depth f =
  List.fold_left (fun depth t -> max depth (theory_depth t)) 0
    f.S.file_theories

63 64 65 66 67
let provers_latex_stats_goal provers goal =
  S.goal_iter_proof_attempt (fun a ->
    Hashtbl.replace provers a.S.proof_prover a.S.proof_prover) goal

let provers_latex_stats provers theory =
68 69 70
  S.theory_iter_proof_attempt (fun a ->
    Hashtbl.replace provers a.S.proof_prover a.S.proof_prover) theory

71 72 73 74
let provers_latex_stats_file provers file =
  S.file_iter_proof_attempt (fun a ->
    Hashtbl.replace provers a.S.proof_prover a.S.proof_prover) file

75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93
let protect s =
  let b = Buffer.create 7 in
  for i = 0 to String.length s - 1 do
    match s.[i] with
	'_' -> Buffer.add_string b "\\_"
      | c -> Buffer.add_char b c
  done;
  Buffer.contents b


let column n depth provers =
  if n == 1 then
    if depth > 1 then
      (List.length provers) + depth
    else
      (List.length provers) + depth + 1
  else
    (List.length provers) +  1

94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110
let print_head n depth provers fmt =
  if n == 1 then
    if (depth > 1) then
      fprintf fmt "\\hline \\multicolumn{%d}{|c|}{Proof obligations } "
        depth
    else
      fprintf fmt "\\hline \\multicolumn{%d}{|c|}{Proof obligations } "
        (depth + 1)
  else
    fprintf fmt "\\hline Proof obligations ";
  List.iter (fun a -> fprintf fmt "& \\provername{%a} " Whyconf.print_prover a)
    provers;
  fprintf fmt "\\\\ @."

let print_tabular_head n depth provers fmt =
  fprintf fmt "\\begin{tabular}";
  fprintf fmt "{| l |";
111
  for _i = 0 to (List.length provers) + depth do fprintf fmt "c |" done;
112 113 114 115 116 117
  fprintf fmt "}@.";
  print_head n depth provers fmt

let print_tabular_foot fmt =
  fprintf fmt "\\hline \\end{tabular}@."

118 119 120 121 122 123 124

let print_result_prov proofs prov fmt=
  List.iter (fun p ->
  try
    let pr = S.PHprover.find proofs p in
    let s = pr.S.proof_state in
      match s with
125
	| Session.Done res ->
126 127
	    begin
	      match res.Call_provers.pr_answer with
Claude Marche's avatar
Claude Marche committed
128 129 130 131 132 133 134 135 136 137 138 139 140 141
		| Call_provers.Valid ->
                  fprintf fmt "& \\valid{%.2f} " res.Call_provers.pr_time
		| Call_provers.Invalid ->
                  fprintf fmt "& \\invalid{%.2f} " res.Call_provers.pr_time
		| Call_provers.Timeout ->
                  fprintf fmt "& \\timeout{%ds} " pr.S.proof_timelimit
		| Call_provers.OutOfMemory ->
                  fprintf fmt "& \\outofmemory{%dM} " pr.S.proof_memlimit
		| Call_provers.Unknown _ ->
                  fprintf fmt "& \\unknown{%.2f} " res.Call_provers.pr_time
		| Call_provers.Failure _ ->
                  fprintf fmt "& \\failure "
		| Call_provers.HighFailure ->
                  fprintf fmt "& \\highfailure "
Andrei Paskevich's avatar
Andrei Paskevich committed
142

143
	    end
144
	| Session.InternalFailure _ -> fprintf fmt "& Internal Failure"
145 146 147 148
	| Session.Interrupted -> fprintf fmt "& Not yet run"
	| Session.Unedited -> fprintf fmt "& Not yet edited"
	| Session.Scheduled | Session.Running
	| Session.JustEdited -> assert false
149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166
  with Not_found -> fprintf fmt "& \\noresult") prov;
  fprintf fmt "\\\\ @."


let rec goal_latex_stat fmt prov depth depth_max subgoal g =
  let column = column 1 depth prov
  in
    if depth > 0 then
      if subgoal > 0 then
	fprintf fmt "\\cline{%d-%d} @." (depth + 1) column
      else ()
    else
      fprintf fmt "\\hline @.";
    if depth_max > 1 then
      begin
	if subgoal > 0 then
	  begin
	    if(depth < depth_max)  then
167
	      for _i = 1 to depth do
168
                fprintf fmt " & "
169 170
              done
	    else
171
	      for _i = 1 to depth - 1 do
172
                fprintf fmt " & "
173 174 175 176 177
              done
	  end
	else
	  if(depth < depth_max) then
	    if depth > 0 then
178
              fprintf fmt " & "
179 180 181 182
      end
    else
      begin
	if subgoal > 0  then
183
	  for _i = 1 to depth do fprintf fmt " & " done
184
	else
185
	  if depth > 0 then fprintf fmt " & "
186 187 188 189
      end;
    if (depth <= 1) then
      fprintf fmt "\\explanation{%s} " (protect (S.goal_expl g))
    else
190
      fprintf fmt " " ;
191 192 193 194 195 196
    let proofs = g.S.goal_external_proofs in
      if (S.PHprover.length proofs) > 0 then
	begin
	  if depth_max <= 1 then
	    begin
	      if depth > 0 then
197
		for _i = depth to (depth_max - depth) do
198
                  fprintf fmt "& " done
199
	      else
200
		for _i = depth to (depth_max - depth - 1) do
201
                  fprintf fmt "& " done
202 203 204
	    end
	  else
	    if depth > 0 then
205
	      for _i = depth to (depth_max - depth - 1) do
206
		fprintf fmt "& " done
207
	    else
208
	      for _i = depth to (depth_max - depth - 2) do
209
		fprintf fmt "& " done;
210 211 212 213 214 215 216 217 218 219 220 221 222 223
	  print_result_prov proofs prov fmt;
	end;
      let tr = g.S.goal_transformations in
	if S.PHstr.length tr > 0 then
	  if S.PHprover.length proofs > 0 then
	    fprintf fmt "\\cline{%d-%d} @." (depth + 2) column;
	S.PHstr.iter (fun _st tr ->
          let goals = tr.S.transf_goals in
	  let _ = List.fold_left (fun subgoal g ->
              goal_latex_stat fmt prov (depth + 1) depth_max (subgoal) g;
               subgoal + 1) 0 goals in
	    () ) tr


224
let style_2_row fmt ?(transf=false) depth prov subgoal expl=
225
  let column = column 2 depth prov in
226
  if depth > 0 || transf then
227 228 229
    fprintf fmt "\\cline{%d-%d} @." 2 column
  else
    fprintf fmt "\\hline @.";
230
  for _i = 1 to depth do fprintf fmt "\\quad" done;
231 232 233
  let macro = if transf then "transformation" else "explanation" in
  if depth = 0 || transf then
    fprintf fmt "\\%s{%s} " macro expl
234
  else
235
    fprintf fmt "\\subgoal{%s}{%d} " expl (subgoal + 1)
Claude Marche's avatar
Claude Marche committed
236 237

let rec goal_latex2_stat fmt prov depth depth_max subgoal g =
238
  let proofs = g.S.goal_external_proofs in
239 240 241 242 243 244 245 246 247 248 249 250
  if S.PHprover.length proofs > 0 then
    begin
      style_2_row fmt depth prov subgoal (protect (S.goal_expl g));
      print_result_prov proofs prov fmt
    end
 else
    if depth = 0 then
      begin
        style_2_row fmt depth prov subgoal (protect (S.goal_expl g));
	fprintf fmt "& \\multicolumn{%d}{|c|}{}\\\\ @."
          (List.length prov)
      end;
251 252 253 254
  let tr = g.S.goal_transformations in
  if S.PHstr.length tr > 0 then
    begin
      S.PHstr.iter (fun _st tr ->
Andrei Paskevich's avatar
Andrei Paskevich committed
255
        style_2_row fmt ~transf:true (depth+1) prov subgoal
256
          (protect tr.S.transf_name);
Claude Marche's avatar
Claude Marche committed
257 258
	fprintf fmt "& \\multicolumn{%d}{|c|}{}\\\\ @."
          (List.length prov);
259 260 261 262 263 264
	let goals = tr.S.transf_goals in
	let _ = List.fold_left (fun subgoal g ->
	  goal_latex2_stat fmt prov (depth + 1) depth_max (subgoal) g;
	  subgoal + 1) 0 goals in
	() ) tr
    end
265 266
 else
    if (S.PHprover.length proofs) == 0 && depth <> 0 then
267
      fprintf fmt "\\\\ @."
268

269 270
let latex_tabular_goal n fmt depth provers g =
  print_tabular_head n depth provers fmt;
271
  if n == 1 then
272
    goal_latex_stat fmt provers 0 depth 0 g
273
  else
274 275
    goal_latex2_stat fmt provers 0 depth  0 g;
  print_tabular_foot fmt
276

277
let latex_tabular_aux n fmt depth provers t =
278 279 280
  if n == 1 then
    List.iter (goal_latex_stat fmt provers 0 depth 0) t.S.theory_goals
  else
281 282 283 284 285 286 287 288 289 290 291
    List.iter (goal_latex2_stat fmt provers 0 depth  0) t.S.theory_goals

let latex_tabular n fmt depth provers t =
  print_tabular_head n depth provers fmt;
  latex_tabular_aux n fmt depth provers t;
  print_tabular_foot fmt


let latex_tabular_file n fmt depth provers f =
  print_tabular_head n depth provers fmt;
  List.iter (latex_tabular_aux n fmt depth provers) f.S.file_theories;
292
  print_tabular_foot fmt
293 294 295 296 297


let latex_longtable n fmt depth name provers t=
  fprintf fmt "\\begin{longtable}";
  fprintf fmt "{| l |";
298
  for _i = 0 to (List.length provers) + depth do fprintf fmt "c |" done;
299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342
  fprintf fmt "}@.";
  (** First head *)
  print_head n depth provers fmt;
  fprintf fmt "\\hline \\endfirsthead @.";
  (** Other heads : "Continued... " added *)
  fprintf fmt "\\multicolumn{%d}{r}{\\textit{Continued from previous page}} \
\\\\ @." (List.length provers + 1) ;
  fprintf fmt "\\hline @.";
  print_head n depth provers fmt;
  fprintf fmt "\\hline \\endhead @.";
  (** Other foots : "Continued..." added *)
  fprintf fmt "\\hline \\multicolumn{%d}{r}{\\textit{Continued on next page}} \
\\\\ @." (List.length provers);
  (** Last foot : nothing *)
  fprintf fmt "\\endfoot \\endlastfoot @.";
  if n == 1 then
    List.iter (goal_latex_stat fmt provers 0 depth 0) t.S.theory_goals
  else
    List.iter (goal_latex2_stat fmt provers 0 depth  0) t.S.theory_goals;
  fprintf fmt "\\hline \\caption{%s statistics} @." (protect name);
  fprintf fmt "\\label{%s} \\end{longtable}@." (protect name)


let theory_latex_stat n table dir t =
  let provers = Hashtbl.create 9 in
  provers_latex_stats provers t;
  let provers = Hashtbl.fold (fun _ pr acc -> pr :: acc)
    provers [] in
  let provers = List.sort Whyconf.Prover.compare provers in
  let depth = theory_depth  t in
  let name = t.S.theory_name.Ident.id_string in
  let ch = open_out (Filename.concat dir(name^".tex")) in
  let fmt = formatter_of_out_channel ch in
    if table = "tabular" then
      begin
      latex_tabular n fmt depth provers t
      end
    else
      latex_longtable n fmt depth name provers t;
    close_out ch

let file_latex_stat n table  dir f =
   List.iter (theory_latex_stat n table dir) f.S.file_theories

343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363
let standalone_goal_latex_stat n _table dir g =
  let provers = Hashtbl.create 9 in
  provers_latex_stats_goal provers g;
  let provers = Hashtbl.fold (fun _ pr acc -> pr :: acc)
    provers [] in
  let provers = List.sort Whyconf.Prover.compare provers in
  let depth = goal_depth g in
  let name = g.S.goal_name.Ident.id_string in
  let ch = open_out (Filename.concat dir(name^".tex")) in
  let fmt = formatter_of_out_channel ch in
  latex_tabular_goal n fmt depth provers g;
(*
  if table = "tabular" then
  begin
  latex_tabular_goal n fmt depth provers g
  end
  else
  latex_longtable_goal n fmt depth name provers g;
*)
close_out ch

364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387
let file_latex_stat_all n _table dir f =
  let provers = Hashtbl.create 9 in
  provers_latex_stats_file provers f;
  let provers = Hashtbl.fold (fun _ pr acc -> pr :: acc)
    provers [] in
  let provers = List.sort Whyconf.Prover.compare provers in
  let depth = file_depth f in
  let name = Filename.basename f.S.file_name in
  let ch = open_out (Filename.concat dir(name^".tex")) in
  let fmt = formatter_of_out_channel ch in
  latex_tabular_file n fmt depth provers f;
(*
    if table = "tabular" then
      begin
      latex_tabular n fmt depth provers t
      end
    else
      latex_longtable n fmt depth name provers t;

*)
    close_out ch



388 389 390 391 392 393 394 395 396 397 398 399 400 401 402
let element_latex_stat_goal g n table dir r =
  begin
    match r with
      | [] -> ()
      | _ ->
        eprintf "Warning: only main goals are supported@.:"
  end;
  standalone_goal_latex_stat n table dir g

let element_latex_stat_theory th n table dir e =
  match e with
    | [] -> theory_latex_stat n table dir th
    | g :: r ->
      try
        let goals =
Andrei Paskevich's avatar
Andrei Paskevich committed
403
          List.map (fun g -> (g.S.goal_name.Ident.id_string,g))
404 405 406 407 408 409 410 411 412
            th.S.theory_goals
        in
        let g = List.assoc g goals in
        element_latex_stat_goal g n table dir r
      with Not_found ->
        eprintf "Warning: goal not found in path: %s@." g

let element_latex_stat_file f n table dir e =
  match e with
413
    | [] -> file_latex_stat_all n table dir f
414 415 416 417 418 419 420 421 422 423 424 425 426 427
    | th :: r ->
      try
        let ths =
          List.map (fun th -> (th.S.theory_name.Ident.id_string,th))
            f.S.file_theories
        in
        let th = List.assoc th ths in
        element_latex_stat_theory th n table dir r
      with Not_found ->
        eprintf "Warning: theory not found in path: %s@." th


let element_latex_stat files n table dir e =
  eprintf "Element %s@." e;
428 429
  let re_dot = Str.regexp "\\." in
  match Str.split re_dot e with
430 431
    | [] -> ()
    | f :: r ->
432 433 434 435 436
      let found = ref false in
      S.PHstr.iter
        (fun fname file ->
          let fname = Filename.basename fname in
          let fname = List.hd (Str.split re_dot fname) in
Andrei Paskevich's avatar
Andrei Paskevich committed
437
          if fname = f then
438 439 440 441 442 443 444
            begin
              found := true;
              element_latex_stat_file file n table dir r
            end)
        files;
      if not !found then
        eprintf "Warning: file not found for element %s@." e
445

446 447
let print_latex_statistics n table dir session =
  let files = session.S.session_files in
448 449 450 451 452
  match !opt_elements with
    | None ->
      S.PHstr.iter (fun _ f -> file_latex_stat n table dir f) files
    | Some l ->
      List.iter (element_latex_stat files n table dir) l
453 454 455 456 457 458 459 460



let table () = if !opt_longtable then "longtable" else "tabular"

let run_one fname =
  let project_dir = Session.get_project_dir fname in
  let session = Session.read_session project_dir in
461 462 463 464
  let dir = if !opt_output_dir = "" then project_dir else
      !opt_output_dir
  in
  print_latex_statistics !opt_style (table ()) dir session
465 466

let run () =
MARCHE Claude's avatar
MARCHE Claude committed
467
  let _,_,should_exit1 = read_env_spec () in
468 469 470 471 472 473
  if should_exit1 then exit 1;
  iter_files run_one


let cmd =
  { cmd_spec = spec;
474 475
    cmd_desc = "output session in LaTeX format.";
    cmd_name = "latex";
476 477
    cmd_run  = run;
  }