model_parser.mli 10.6 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

type float_type =
  | Plus_infinity
  | Minus_infinity
  | Plus_zero
  | Minus_zero
  | Not_a_number
  | Float_value of string * string * string
25
  | Float_hexa of string * float
26

27
val interp_float: ?interp:bool -> string -> string -> string -> float_type
28

29 30
type model_value =
 | Integer of string
31
 | Decimal of (string * string)
32
 | Fraction of (string * string)
33
 | Float of float_type
34
 | Boolean of bool
35
 | Array of model_array
36
 | Record of model_record
37
 | Proj of model_proj
38
 | Bitvector of string
39
 | Apply of string * model_value list
40
 | Unparsed of string
41
and  arr_index = {
42
  arr_index_key : string;
43 44 45 46 47 48
  arr_index_value : model_value;
}
and model_array = {
  arr_others  : model_value;
  arr_indices : arr_index list;
}
49 50
and model_proj = (proj_name * model_value)
and proj_name = string
51 52
and model_record = (field_name * model_value) list
and field_name = string
53

54 55
val array_create_constant :
  value : model_value ->
56 57 58
  model_array
(** Creates constant array with all indices equal to the parameter value. *)

59 60
val array_add_element :
  array : model_array ->
61
  index : string      ->
62
  value : model_value ->
63
  model_array
64
(** Adds an element to the array.
65
    @param array : the array to that the element will be added
66

67 68 69 70 71 72 73 74
    @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

75 76

(*
77
***************************************************************
78 79 80
**  Model elements
***************************************************************
*)
81

82
type model_element_kind =
83 84 85
| Result
  (* Result of a function call (if the counter-example is for postcondition)  *)
| Old
86 87 88 89
  (* 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.*)
90 91
| Other

92 93 94 95 96 97
(** 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. *)
Guillaume Melquiond's avatar
Guillaume Melquiond committed
98
  men_attrs : Ident.Sattr.t;
99
}
100

101 102
(** Counter-example model elements. Each element represents
    a counter-example for a single source-code element.*)
103
type model_element = {
104
  me_name       : model_element_name;
105
    (** Information about the name of the model element  *)
106
  me_value      : model_value;
107
    (** Counter-example value for the element. *)
108
  me_location   : Loc.position option;
109
    (** Source-code location of the element. *)
110
  me_term       : Term.term option;
111
    (** Why term corresponding to the element.  *)
112 113
}

114
val create_model_element :
115 116
  name      : string ->
  value     : model_value ->
117
  attrs     : Ident.Sattr.t ->
118
  ?location : Loc.position ->
119 120
  ?term     : Term.term ->
  unit ->
121
  model_element
122
(** Creates a counter-example model element.
123 124 125 126
    @param name : the name of the source-code element

    @param value  : counter-example value for the element

127 128
    @param location : source-code location of the element

129 130
    @param term : why term corresponding to the element
*)
131

132
(*
133
***************************************************************
134 135
**  Model definitions
***************************************************************
136 137
*)
type model
138

139 140
val is_model_empty : model -> bool
val default_model : model
141 142

(*
143
***************************************************************
144 145 146
**  Quering the model
***************************************************************
*)
147

148
val print_model :
149
  ?me_name_trans:(model_element_name -> string) ->
Guillaume Melquiond's avatar
Guillaume Melquiond committed
150
  print_attrs:bool ->
151
  Format.formatter ->
152
  model ->
153 154 155 156
  unit
(** Prints the counter-example model

    @param me_name_trans the transformation of the model elements
157 158
      names. The input is information about model element name. The
      output is the name of the model element that should be displayed.
159
    @param model the counter-example model to print
Guillaume Melquiond's avatar
Guillaume Melquiond committed
160 161
    @param print_attrs: when set to true, the name is printed together with the
    attrs associated to the specific ident.
162 163
*)

164 165 166 167
val print_model_human :
  ?me_name_trans:(model_element_name -> string) ->
  Format.formatter ->
  model ->
Guillaume Melquiond's avatar
Guillaume Melquiond committed
168
  print_attrs:bool ->
169 170 171 172 173
  unit
(** Same as print_model but is intended to be human readable.

*)

174
val print_model_json :
175
  ?me_name_trans:(model_element_name -> string) ->
176
  ?vc_line_trans:(int -> string) ->
177
  Format.formatter ->
178
  model ->
179 180
  unit
(** Prints counter-example model to json format.
181

182
    @param me_name_trans see print_model
183 184 185 186 187 188 189 190 191 192
    @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.
193
    @param model the counter-example model to print.
Guillaume Melquiond's avatar
Guillaume Melquiond committed
194
    @param print_attrs if set to true, add attrs associated to the name id to
195
      the counterexample output
196

197 198 199 200 201 202 203 204 205 206 207 208
    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)
209
        - "old": Old value of function argument (if the counter-example is for postcondition)
210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230
        - "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"
            }
          ]
      }
    }
231
*)
232

233
val interleave_with_source :
Guillaume Melquiond's avatar
Guillaume Melquiond committed
234
  print_attrs:bool ->
235 236
  ?start_comment:string ->
  ?end_comment:string ->
237
  ?me_name_trans:(model_element_name -> string) ->
238
  model ->
239
  rel_filename:string ->
240
  source_code:string ->
241 242
  locations:(Loc.position * 'a) list ->
  string * (Loc.position * 'a) list
243 244 245 246 247 248 249 250 251 252
(** 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
253
    @param rel_filename the file name of the source relative to the session
254
    @param source_code the input source code
255
    @param locations the source locations that are found in the code
256 257

    @return the source code with added comments with information
258 259 260
    about counter-example model. The second part of the pair are
    locations modified so that it takes into account that counterexamples
    were added.
261
*)
262 263

(*
264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283
***************************************************************
**  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.
*)

(*
***************************************************************
284 285 286 287
** Registering model parser
***************************************************************
*)
type model_parser =  string -> Printer.printer_mapping -> model
288 289
(** Parses the input string into model elements, estabilishes
    a mapping between these elements and mapping from printer
290 291
    and builds model data structure.
*)
292

293
type raw_model_parser =
294
  Ident.ident Wstdlib.Mstr.t -> ((string * string) list) Wstdlib.Mstr.t ->
295
    string list -> Ident.Sattr.t Wstdlib.Mstr.t -> string -> model_element list
296 297 298 299 300 301 302 303 304
(** Parses the input string into model elements.
    [raw_model_parser: proj->record_map->noarg_cons->s->mel]
    [proj]: is the list of projections
    [record_map]: is a map associating the name of printed projections to the
      fields (couple of printed field and model_trace name).
    [noarg_cons]: List of constructors with no arguments (collected to avoid
      confusion between variable and constructors)
    [s]: model
    [mel]: collected model
305
 *)
306

307 308
val register_remove_field:
  (Ident.Sattr.t * model_value -> Ident.Sattr.t * model_value) -> unit
309

310
val register_model_parser : desc:Pp.formatted -> string -> raw_model_parser -> unit
311 312 313 314

val lookup_model_parser : string -> model_parser

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