infer_clone/infer/src/IR/Io_infer.mli

(*
 * Copyright (c) 2009 - 2013 Monoidics ltd.
 * Copyright (c) 2013 - present Facebook, Inc.
 * All rights reserved.
 *
 * This source code is licensed under the BSD style license found in the
 * LICENSE file in the root directory of this source tree. An additional grant
 * of patent rights can be found in the PATENTS file in the same directory.
 *)

open! IStd

(** Module to handle IO. Includes html and xml modules. *)

module Html : sig
  val close : Unix.File_descr.t * Format.formatter -> unit
  (** Close an Html file *)

  val create :
    DB.Results_dir.path_kind -> DB.Results_dir.path -> Unix.File_descr.t * Format.formatter
  (** Create a new html file *)

  val modified_during_analysis : SourceFile.t -> DB.Results_dir.path -> bool
  (** Return true if the html file was modified since the beginning of the analysis *)

  val node_filename : Typ.Procname.t -> int -> string
  (** File name for the node, given the procedure name and node id *)

  val open_out : SourceFile.t -> DB.Results_dir.path -> Unix.File_descr.t * Format.formatter
  (** Open an Html file to append data *)

  val pp_line_link :
    ?with_name:bool -> ?text:string option -> SourceFile.t -> DB.Results_dir.path
    -> Format.formatter -> int -> unit
  (** Print an html link to the given line number of the current source file *)

  val pp_hline : Format.formatter -> unit -> unit
  (** Print a horizontal line *)

  val pp_end_color : Format.formatter -> unit -> unit
  (** Print end color *)

  val pp_node_link :
    DB.Results_dir.path -> Typ.Procname.t -> description:string -> preds:int list -> succs:int list
    -> exn:int list -> isvisited:bool -> isproof:bool -> Format.formatter -> int -> unit
  (** Print an html link to the given node.
      Usage: [pp_node_link path_to_root ... fmt id].
      [path_to_root] is the path to the dir for the procedure in the spec db.
      [id] is the node identifier. *)

  val pp_proc_link : DB.Results_dir.path -> Typ.Procname.t -> Format.formatter -> string -> unit
  (** Print an html link to the given proc *)

  val pp_session_link :
    ?with_name:bool -> ?proc_name:Typ.Procname.t -> SourceFile.t -> string list -> Format.formatter
    -> int * int * int -> unit
  (** Print an html link given node id and session *)

  val pp_start_color : Format.formatter -> Pp.color -> unit
  (** Print start color *)
end

(** Create and print xml trees *)
module Xml : sig
  val tag_err : string

  val tag_file : string

  val tag_in_calls : string

  val tag_line : string

  val tag_loc : string

  val tag_name : string

  val tag_name_id : string

  val tag_out_calls : string

  val tag_proof_coverage : string

  val tag_proof_trace : string

  val tag_rank : string

  val tag_signature : string

  val tag_specs : string

  val tag_symop : string

  val tag_time : string

  val tag_to : string

  val tag_top : string

  val tag_weight : string
end