why3session_latex.ml 15 KB
Newer Older
1 2
(**************************************************************************)
(*                                                                        *)
MARCHE Claude's avatar
MARCHE Claude committed
3
(*  Copyright (C) 2010-2012                                               *)
4 5 6
(*    François Bobot                                                      *)
(*    Jean-Christophe Filliâtre                                           *)
(*    Claude Marché                                                       *)
MARCHE Claude's avatar
MARCHE Claude committed
7
(*    Guillaume Melquiond                                                 *)
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
(*    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.                  *)
(*                                                                        *)
(**************************************************************************)

open Why3
open Why3session_lib
open Format


module S = Session

28 29
let opt_style = ref 1
let opt_output_dir = ref ""
30
let opt_longtable = ref false
31 32 33 34 35 36 37 38
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
39 40

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


(* 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

68 69 70 71
let file_depth f =
  List.fold_left (fun depth t -> max depth (theory_depth t)) 0
    f.S.file_theories

72 73 74 75 76
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 =
77 78 79
  S.theory_iter_proof_attempt (fun a ->
    Hashtbl.replace provers a.S.proof_prover a.S.proof_prover) theory

80 81 82 83
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

84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102
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

103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119
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 |";
120
  for _i = 0 to (List.length provers) + depth do fprintf fmt "c |" done;
121 122 123 124 125 126
  fprintf fmt "}@.";
  print_head n depth provers fmt

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

127 128 129 130 131 132 133

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
134
	| Session.Done res ->
135 136
	    begin
	      match res.Call_provers.pr_answer with
Claude Marche's avatar
Claude Marche committed
137 138 139 140 141 142 143 144 145 146 147 148 149 150
		| 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
151

152
	    end
153
	| Session.InternalFailure _ -> fprintf fmt "& Internal Failure"
154 155 156 157
	| Session.Interrupted -> fprintf fmt "& Not yet run"
	| Session.Unedited -> fprintf fmt "& Not yet edited"
	| Session.Scheduled | Session.Running
	| Session.JustEdited -> assert false
158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175
  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
176
	      for _i = 1 to depth do
177
                fprintf fmt " & "
178 179
              done
	    else
180
	      for _i = 1 to depth - 1 do
181
                fprintf fmt " & "
182 183 184 185 186
              done
	  end
	else
	  if(depth < depth_max) then
	    if depth > 0 then
187
              fprintf fmt " & "
188 189 190 191
      end
    else
      begin
	if subgoal > 0  then
192
	  for _i = 1 to depth do fprintf fmt " & " done
193
	else
194
	  if depth > 0 then fprintf fmt " & "
195 196 197 198
      end;
    if (depth <= 1) then
      fprintf fmt "\\explanation{%s} " (protect (S.goal_expl g))
    else
199
      fprintf fmt " " ;
200 201 202 203 204 205
    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
206
		for _i = depth to (depth_max - depth) do
207
                  fprintf fmt "& " done
208
	      else
209
		for _i = depth to (depth_max - depth - 1) do
210
                  fprintf fmt "& " done
211 212 213
	    end
	  else
	    if depth > 0 then
214
	      for _i = depth to (depth_max - depth - 1) do
215
		fprintf fmt "& " done
216
	    else
217
	      for _i = depth to (depth_max - depth - 2) do
218
		fprintf fmt "& " done;
219 220 221 222 223 224 225 226 227 228 229 230 231 232
	  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


233
let style_2_row fmt ?(transf=false) depth prov subgoal expl=
234
  let column = column 2 depth prov in
235
  if depth > 0 || transf then
236 237 238
    fprintf fmt "\\cline{%d-%d} @." 2 column
  else
    fprintf fmt "\\hline @.";
239
  for _i = 1 to depth do fprintf fmt "\\quad" done;
240 241 242
  let macro = if transf then "transformation" else "explanation" in
  if depth = 0 || transf then
    fprintf fmt "\\%s{%s} " macro expl
243
  else
244
    fprintf fmt "\\subgoal{%s}{%d} " expl (subgoal + 1)
Claude Marche's avatar
Claude Marche committed
245 246

let rec goal_latex2_stat fmt prov depth depth_max subgoal g =
247
  let proofs = g.S.goal_external_proofs in
248 249 250 251 252 253 254 255 256 257 258 259
  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;
260 261 262 263
  let tr = g.S.goal_transformations in
  if S.PHstr.length tr > 0 then
    begin
      S.PHstr.iter (fun _st tr ->
264 265
        style_2_row fmt ~transf:true (depth+1) prov subgoal 
          (protect tr.S.transf_name);
Claude Marche's avatar
Claude Marche committed
266 267
	fprintf fmt "& \\multicolumn{%d}{|c|}{}\\\\ @."
          (List.length prov);
268 269 270 271 272 273
	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
274 275
 else
    if (S.PHprover.length proofs) == 0 && depth <> 0 then
276
      fprintf fmt "\\\\ @."
277

278 279
let latex_tabular_goal n fmt depth provers g =
  print_tabular_head n depth provers fmt;
280
  if n == 1 then
281
    goal_latex_stat fmt provers 0 depth 0 g
282
  else
283 284
    goal_latex2_stat fmt provers 0 depth  0 g;
  print_tabular_foot fmt
285

286
let latex_tabular_aux n fmt depth provers t =
287 288 289
  if n == 1 then
    List.iter (goal_latex_stat fmt provers 0 depth 0) t.S.theory_goals
  else
290 291 292 293 294 295 296 297 298 299 300
    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;
301
  print_tabular_foot fmt
302 303 304 305 306


let latex_longtable n fmt depth name provers t=
  fprintf fmt "\\begin{longtable}";
  fprintf fmt "{| l |";
307
  for _i = 0 to (List.length provers) + depth do fprintf fmt "c |" done;
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 343 344 345 346 347 348 349 350 351
  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

352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372
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

373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396
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



397 398 399 400 401 402 403 404 405 406 407 408 409 410 411
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
412
          List.map (fun g -> (g.S.goal_name.Ident.id_string,g))
413 414 415 416 417 418 419 420 421
            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
422
    | [] -> file_latex_stat_all n table dir f
423 424 425 426 427 428 429 430 431 432 433 434 435 436
    | 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;
437 438
  let re_dot = Str.regexp "\\." in
  match Str.split re_dot e with
439 440
    | [] -> ()
    | f :: r ->
441 442 443 444 445
      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
446
          if fname = f then
447 448 449 450 451 452 453
            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
454

455 456
let print_latex_statistics n table dir session =
  let files = session.S.session_files in
457 458 459 460 461
  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
462 463 464 465 466 467 468 469



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
470 471 472 473
  let dir = if !opt_output_dir = "" then project_dir else
      !opt_output_dir
  in
  print_latex_statistics !opt_style (table ()) dir session
474 475

let run () =
MARCHE Claude's avatar
MARCHE Claude committed
476
  let _,_,should_exit1 = read_env_spec () in
477 478 479 480 481 482
  if should_exit1 then exit 1;
  iter_files run_one


let cmd =
  { cmd_spec = spec;
483 484
    cmd_desc = "output session in LaTeX format.";
    cmd_name = "latex";
485 486
    cmd_run  = run;
  }