model_parser.mli 9.97 KB
Newer Older
1 2 3
(********************************************************************)
(*                                                                  *)
(*  The Why3 Verification Platform   /   The Why3 Development Team  *)
Guillaume Melquiond's avatar
Guillaume Melquiond committed
4
(*  Copyright 2010-2018   --   Inria - CNRS - Paris-Sud University  *)
5 6 7 8 9 10 11
(*                                                                  *)
(*  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.                           *)
(*                                                                  *)
(********************************************************************)

12
(*
13
***************************************************************
14 15 16
**  Counter-example model values
****************************************************************
*)
17 18 19 20 21 22 23 24 25

type float_type =
  | Plus_infinity
  | Minus_infinity
  | Plus_zero
  | Minus_zero
  | Not_a_number
  | Float_value of string * string * string

26 27
type model_value =
 | Integer of string
28
 | Decimal of (string * string)
29
 | Float of float_type
30
 | Boolean of bool
31
 | Array of model_array
32
 | Record of model_record
33
 | Bitvector of string
34
 | Unparsed of string
35
and  arr_index = {
36
  arr_index_key : string;
37 38 39 40 41 42
  arr_index_value : model_value;
}
and model_array = {
  arr_others  : model_value;
  arr_indices : arr_index list;
}
43 44 45 46
and model_record ={
  discrs : model_value list;
  fields : model_value list;
}
47

48 49
val array_create_constant :
  value : model_value ->
50 51 52
  model_array
(** Creates constant array with all indices equal to the parameter value. *)

53 54
val array_add_element :
  array : model_array ->
55
  index : string      ->
56
  value : model_value ->
57
  model_array
58
(** Adds an element to the array.
59
    @param array : the array to that the element will be added
60

61 62 63 64 65 66 67 68
    @param index : the index on which the element will be added.
    Note that the index must be of value model_value.Integer

    @param value : the value of the element to be added
*)

val print_model_value : Format.formatter -> model_value -> unit

69 70

(*
71
***************************************************************
72 73 74
**  Model elements
***************************************************************
*)
75

76
type model_element_kind =
77 78 79
| Result
  (* Result of a function call (if the counter-example is for postcondition)  *)
| Old
80 81 82 83
  (* Old value of function argument (if the counter-example is for postcondition) *)
| Error_message
  (* The model element represents error message, not source-code element.
     The error message is saved in the name of the model element.*)
84 85
| Other

86 87 88 89 90 91 92
(** Information about the name of the model element *)
type model_element_name = {
  men_name   : string;
    (** The name of the source-code element.  *)
  men_kind   : model_element_kind;
    (** The kind of model element. *)
}
93

94 95
(** Counter-example model elements. Each element represents
    a counter-example for a single source-code element.*)
96
type model_element = {
97 98
  me_name     : model_element_name;
    (** Information about the name of the model element  *)
99 100 101 102
  me_value    : model_value;
    (** Counter-example value for the element. *)
  me_location : Loc.position option;
    (** Source-code location of the element. *)
103 104
  me_term     : Term.term option;
    (** Why term corresponding to the element.  *)
105 106
}

107 108 109 110
val create_model_element :
  name     : string ->
  value    : model_value ->
  ?location : Loc.position ->
111 112
  ?term     : Term.term ->
  unit ->
113
  model_element
114
(** Creates a counter-example model element.
115 116 117 118
    @param name : the name of the source-code element

    @param value  : counter-example value for the element

119 120
    @param location : source-code location of the element

121
    @param term : why term corresponding to the element *)
122

123
(*
124
***************************************************************
125 126
**  Model definitions
***************************************************************
127 128
*)
type model
129

130 131
val is_model_empty : model -> bool
val default_model : model
132 133

(*
134
***************************************************************
135 136 137
**  Quering the model
***************************************************************
*)
138

139
val print_model :
140
  ?me_name_trans:(model_element_name -> string) ->
141
  Format.formatter ->
142
  model ->
143 144 145 146
  unit
(** Prints the counter-example model

    @param me_name_trans the transformation of the model elements
147 148
      names. The input is information about model element name. The
      output is the name of the model element that should be displayed.
149 150 151
    @param model the counter-example model to print
*)

152 153 154 155 156 157 158 159 160 161
val print_model_human :
  ?me_name_trans:(model_element_name -> string) ->
  Format.formatter ->
  model ->
  unit
(** Same as print_model but is intended to be human readable.

*)


162
val model_to_string :
163
  ?me_name_trans:(model_element_name -> string) ->
164 165 166
  model ->
  string
(** See print_model  *)
167

168
val print_model_vc_term :
169
  ?me_name_trans: (model_element_name -> string) ->
170 171 172 173 174 175 176 177 178 179 180 181
  ?sep: string ->
  Format.formatter ->
  model ->
  unit
(** Prints counter-example model elements related to term that
    triggers VC.

    @param sep separator of counter-example model elements
    @param me_name_trans see print_model
    @model the counter-example model.
*)

182
val model_vc_term_to_string :
183
  ?me_name_trans: (model_element_name -> string) ->
184 185 186 187 188 189 190 191
  ?sep: string ->
  model ->
  string
(** Gets string with counter-example model elements related to term that
    triggers VC.
    See print_model_vc_term
*)

192
val print_model_json :
193
  ?me_name_trans:(model_element_name -> string) ->
194
  ?vc_line_trans:(int -> string) ->
195
  Format.formatter ->
196
  model ->
197 198
  unit
(** Prints counter-example model to json format.
199

200
    @param me_name_trans see print_model
201 202 203 204 205 206 207 208 209 210
    @param vc_line_trans the transformation from the line number corresponding
      to the term that triggers VC before splitting VC to the name of JSON field
      storing counterexample information related to this term. By default, this
      information is stored in JSON field corresponding to this line, i.e.,
      the transformation is string_of_int.
      Note that the exact line of the construct that triggers VC may not be
      known. This can happen if the term that triggers VC spans multiple lines
      and it is splitted.
      This transformation can be used to store the counterexample information
      related to this term in dedicated JSON field.
211 212
    @model the counter-example model to print.

213 214 215 216 217 218 219 220 221 222 223 224
    The format is the following:
    - counterexample is JSON object with fields indexed by names of files
      storing values of counterexample_file
    - counterexample_file is JSON object with fields indexed by line numbers
      storing values of counterexample_line
    - counterexample_line is JSON array (ordered list) with elements
      corresponding to counterexample_element
    - counterexample_element is JSON object with following fields
      - "name": name of counterexample element
      - "value": value of counterexample element
      - "kind": kind of counterexample element:
        - "result": Result of a function call (if the counter-example is for postcondition)
225
        - "old": Old value of function argument (if the counter-example is for postcondition)
226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246
        - "error_message": The model element represents error message, not source-code element.
            The error message is saved in the name of the model element
        - "other"

    Example:
    {
      "records.adb": {
          "84": [
            {
              "name": "A.A",
              "value": "255",
              "kind": "other"
            },
            {
              "name": "B.B",
              "value": "0",
              "kind": "other"
            }
          ]
      }
    }
247
*)
248

249
val model_to_string_json :
250
  ?me_name_trans:(model_element_name -> string) ->
251
  ?vc_line_trans:(int -> string) ->
252 253 254
  model ->
  string
(** See print_model_json *)
255

256
val interleave_with_source :
257 258
  ?start_comment:string ->
  ?end_comment:string ->
259
  ?me_name_trans:(model_element_name -> string) ->
260
  model ->
261 262
  filename:string ->
  source_code:string ->
263
  string
264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279
(** Given a source code and a counter-example model interleaves
    the source code with information in about the counter-example.
    That is, for each location in counter-example trace creates
    a comment in the output source code with information about
    values of counter-example model elements.

    @param start_comment the string that starts a comment
    @param end_comment the string that ends a comment
    @param me_name_trans see print_model
    @param model counter-example model
    @param filename the file name of the source
    @param source_code the input source code

    @return the source code with added comments with information
    about counter-example model
*)
280 281

(*
282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301
***************************************************************
**  Filtering the model
***************************************************************
*)
val model_for_positions_and_decls : model ->
  positions: Loc.position list -> model
(** Given a model and a list of source-code positions returns model
    that contains only elements from the input model that are on these
    positions plus for every file in the model, elements that are
    in the positions of function declarations. Elements with other
    positions are filtered out.

    Assumes that for each file the element on the first line of the model
    has position of function declaration.

    Only filename and line number is used to identify positions.
*)

(*
***************************************************************
302 303 304 305
** Registering model parser
***************************************************************
*)
type model_parser =  string -> Printer.printer_mapping -> model
306 307
(** Parses the input string into model elements, estabilishes
    a mapping between these elements and mapping from printer
308 309
    and builds model data structure.
*)
310

311 312
type raw_model_parser =  string -> model_element list
(** Parses the input string into model elements. *)
313

314
val register_model_parser : desc:Pp.formatted -> string -> raw_model_parser -> unit
315 316 317 318

val lookup_model_parser : string -> model_parser

val list_model_parsers : unit -> (string * Pp.formatted) list