package mopsa

  1. Overview
  2. Docs
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Source file print.ml

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
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
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
(****************************************************************************)
(*                                                                          *)
(* This file is part of MOPSA, a Modular Open Platform for Static Analysis. *)
(*                                                                          *)
(* Copyright (C) 2017-2019 The MOPSA Project.                               *)
(*                                                                          *)
(* This program is free software: you can redistribute it and/or modify     *)
(* it under the terms of the GNU Lesser General Public License as published *)
(* by the Free Software Foundation, either version 3 of the License, or     *)
(* (at your option) any later version.                                      *)
(*                                                                          *)
(* This program 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.  See the            *)
(* GNU Lesser General Public License for more details.                      *)
(*                                                                          *)
(* You should have received a copy of the GNU Lesser General Public License *)
(* along with this program.  If not, see <http://www.gnu.org/licenses/>.    *)
(*                                                                          *)
(****************************************************************************)

(** Print - pretty-printing of expressions values *)

open Mopsa_utils
open Ast.Var
open Ast.Expr
open Yojson.Basic
module Map = MapExtPoly
module Set = SetExtPoly


(****************************************************************************)
(**                          {1 Print objects}                              *)
(****************************************************************************)

type symbols = {
  sopen : string;
  ssep   : string;
  sbind  : string;
  sclose   : string;
}

type ('k,'v) map = ('k,'v) Map.t
type 'v set = 'v Set.t

type print_object =
  | Empty
  | Bool   of bool
  | Int    of Z.t
  | Float  of float
  | String of string
  | Var    of var
  | Map    of (print_object, print_object) map * symbols
  | List   of print_object list * symbols
  | Set    of print_object set * symbols

let default_map_symbols = { sopen = ""; ssep = ","; sclose = ""; sbind = ":" }

let default_list_symbols = { sopen = "["; ssep = ","; sclose = "]"; sbind = "" }

let default_set_symbols = { sopen = "{"; ssep = ","; sclose = "}"; sbind = "" }

let rec compare_print_object o1 o2 =
  match o1,o2 with
  | Empty, Empty -> 0
  | Bool b1, Bool b2 -> compare b1 b2
  | Int n1, Int n2 -> Z.compare n1 n2
  | Float f1, Float f2 -> compare f1 f2
  | String s1, String s2 -> String.compare s1 s2
  | Var v1, Var v2 -> compare_var v1 v2
  | Map(m1,_), Map(m2,_) -> Map.compare compare_print_object m1 m2
  | List(l1,_), List(l2,_) -> Compare.list compare_print_object l1 l2
  | Set(s1,_), Set(s2,_) -> Set.compare s1 s2
  | _ -> compare o1 o2

(****************************************************************************)
(**                            {1 Printers}                                 *)
(****************************************************************************)

type printer = {
  mutable body : print_object;
  mutable prev_exprs: ExprSet.t;
}

let get_printed_object printer = printer.body

let empty_printer () =
  { body = Empty;
    prev_exprs = ExprSet.empty }

let get_printed_exprs printer =
  ExprSet.elements printer.prev_exprs

let add_printed_expr printer exp =
  printer.prev_exprs <- ExprSet.add exp printer.prev_exprs

let mem_printed_expr printer exp =
  ExprSet.mem exp printer.prev_exprs


(****************************************************************************)
(**                           {1 Print paths}                               *)
(****************************************************************************)

type print_selector =
  | Key of string
  | Index of int
  | Obj of print_object

type print_path = print_selector list

let rec find_print_object path obj =
  match path, obj with
  | [],_ -> obj

  (* Maps *)
  | Key k::tl, Map (m,_) -> find_print_object tl (Map.find (String k) m)
  | Key k::tl, Empty -> Empty
  | Key _::_,_ -> Exceptions.panic "find_print_object: key selector on non-map object"

  | Obj o::tl, Map (m,_) -> find_print_object tl (Map.find o m)
  | Obj o::tl, Empty -> Empty
  | Obj _::_,_ -> Exceptions.panic "find_print_object: obj selector on non-map object"

  (* Lists *)
  | Index i::tl, List (l,_) -> begin try find_print_object tl (List.nth l i) with Failure _ -> raise Not_found end
  | Index i::tl, Empty -> Empty
  | Index _::_,_ -> Exceptions.panic "find_print_object: index selector on non-list object"


let rec match_print_object_keys re obj =
  match obj with
  | Map (map,sym) ->
    let map' =
      Map.fold
        (fun k v acc ->
           match k with
           | String s ->
             if Str.string_match re s 0
             then Map.add k v acc
             else acc
           | _ -> acc
        ) map (Map.empty ~compare:compare_print_object) in
    if Map.is_empty map' then Empty else Map(map',sym)

  | List(list,sym) ->
    let list' =
      List.fold_left
        (fun acc v ->
           let v' = match_print_object_keys re v in
           match v' with
           | Empty -> acc
           | _     -> v' :: acc
        ) [] list in
    if list' = [] then Empty else List(List.rev list',sym)

  | Set(set,sym) ->
    let set' =
      Set.fold
        (fun v acc ->
           let v' = match_print_object_keys re v in
           match v' with
           | Empty -> acc
           | _     -> Set.add v' acc
        ) set (Set.empty compare_print_object) in
    if Set.is_empty set' then Empty else Set(set',sym)

  | Empty | Int _ | Bool _ | Float _ | String _ | Var _ -> obj

(****************************************************************************)
(**                    {1 Generic print functions}                          *)
(****************************************************************************)

let rec is_leaf = function
  | Empty | Bool _ | Int _ | Float _ | String _ | Var _ -> true
  | Map _ -> false
  | List(l,_) -> List.for_all is_leaf l
  | Set(s,_) -> Set.for_all is_leaf s

let rec is_atomic = function
  | Empty | Bool _ | Int _ | Float _ | String _ | Var _ -> true
  | _ -> false

let is_empty = function
  | Empty -> true
  | _ -> false

let rec pp_print_object fmt = function
  | Empty    -> ()
  | Bool b   -> Format.pp_print_bool fmt b
  | Int n    -> Z.pp_print fmt n
  | Float f  -> Format.pp_print_float fmt f
  | String s -> Format.pp_print_string fmt s
  | Var v    -> pp_var fmt v
  | Map (m,sym) ->
    let sopen = if sym.sopen = "" then "" else sym.sopen ^ " " in
    let sclose = if sym.sclose = "" then "" else " " ^ sym.sclose in
    Format.(
      fprintf fmt "%s @[<v>%a@] %s"
        sopen
        (pp_print_list ~pp_sep:(fun fmt () -> fprintf fmt "%s@ " sym.ssep)
           (fun fmt (k,v) ->
              if is_leaf v then
                fprintf fmt "@[<hov2>%a %s @,%a@]"
                  pp_print_object k sym.sbind
                  pp_print_object v
              else
                fprintf fmt "@[<v2>%a %s @,%a@]"
                  pp_print_object k sym.sbind
                  pp_print_object v
           )
        ) (Map.bindings m)
        sclose
    )
  | List (l,sym) ->
    let sopen = if sym.sopen = "" then "" else sym.sopen ^ " " in
    let sclose = if sym.sclose = "" then "" else " " ^ sym.sclose in
    Format.(
      fprintf fmt "%s@[<hv>%a@]%s"
        sopen
        (pp_print_list ~pp_sep:(fun fmt () -> fprintf fmt "%s@ " sym.ssep)
           pp_print_object
        ) l
        sclose
    )
  | Set (s,sym) ->
    let sopen = if sym.sopen = "" then "" else sym.sopen ^ " " in
    let sclose = if sym.sclose = "" then "" else " " ^ sym.sclose in
    Format.(
      fprintf fmt "%s @[<hv>%a@] %s"
        sopen
        (pp_print_list ~pp_sep:(fun fmt () -> fprintf fmt "%s@ " sym.ssep)
           pp_print_object
        ) (Set.elements s)
        sclose
    )
let rec merge o1 o2 =
  if compare o1 o2 = 0 then
    o1
  else
  if is_empty o1 then o2 else
  if is_empty o2 then o1 else
  if is_atomic o1 && is_atomic o2 then
    List([o1; o2], default_list_symbols)
  else
    match o1, o2 with
    | Empty, o | o, Empty ->
      o
    | List(l1, sym1), List(l2, sym2) ->
      List(l1 @ l2, sym1)
    | List(l, sym), o | o, List(l, sym) ->
      List(o :: l, sym)
    | Map(m1, sym1), Map(m2, sym2) ->
      let m =
        Map.map2zo
          (fun k1 v1 -> v1)
          (fun k2 v2 -> v2)
          (fun k v1 v2 -> merge v1 v2)
          m1 m2
      in
      Map(m, sym1)
    | Set(s1, sym1), Set(s2, sym2) ->
      Set(Set.union s1 s2, sym1)
    | Set(s, sym), o | o, Set(s, sym) ->
      Set(Set.add o s, sym)
    | _ ->
      Exceptions.panic "merge:@\n  @[%a@]@\nand@\n  @[%a@]"
        pp_print_object o1
        pp_print_object o2

let rec singleton path obj =
  match path with
  | [] ->
    obj

  | Key k :: tl ->
    Map (Map.singleton ~compare:compare_print_object (String k) (singleton tl obj), default_map_symbols)

  | Index i :: tl ->
    if i = 0 then List ([singleton tl obj], default_list_symbols)
    else List (List.init (i - 1) (fun _ -> Empty) @ [singleton tl obj], default_list_symbols)

  | Obj o :: tl ->
    Map (Map.singleton ~compare:compare_print_object o (singleton tl obj), default_map_symbols)


let pprint ?(path=[]) printer obj =
  printer.body <- merge (singleton path obj) printer.body


let pflush fmt printer = pp_print_object fmt printer.body

let format f fmt x =
  let printer = empty_printer () in
  f printer x;
  pflush fmt printer

let unformat ?(path=[]) f printer x =
  Format.kasprintf (fun str ->
      pprint printer (String str) ~path
    ) "%a" f x

let pbox f x =
  let printer = empty_printer () in
  f printer x;
  printer.body

let fbox fmt =
  Format.kasprintf (fun str ->
      pbox (fun printer str -> pprint printer (String str)) str
    ) fmt

let fprint ?(path=[]) printer fmt =
  Format.kasprintf (fun str ->
      pprint ~path printer (String str)
    ) fmt

let sprint f x =
  Format.asprintf "%a" (format f) x

let fkey fmt =
  Format.kasprintf (fun str ->
      Key str
    ) fmt

let pkey f x =
  fkey "%a" (format f) x


(****************************************************************************)
(**                      {1 Typed print functions}                          *)
(****************************************************************************)

let pp_int ?(path=[]) printer n =
  pprint ~path printer (Int (Z.of_int n))

let pp_z ?(path=[]) printer z =
  pprint ~path printer (Int z)

let pp_bool ?(path=[]) printer b =
  pprint ~path printer (Bool b)

let pp_float ?(path=[]) printer f =
  pprint ~path printer (Float f)

let pp_string ?(path=[]) printer str =
  pprint ~path printer (String str)

let pp_variable ?(path=[]) printer v =
  pprint ~path printer (Var v)

let pp_obj_list ?(path=[]) ?(lopen=default_list_symbols.sopen) ?(lsep=default_list_symbols.ssep) ?(lclose=default_list_symbols.sclose) printer l =
  pprint ~path printer
    (List (l, {default_list_symbols with sopen=lopen; ssep=lsep; sclose=lclose}))

let pp_list ?(path=[]) ?(lopen=default_list_symbols.sopen) ?(lsep=default_list_symbols.ssep) ?(lclose=default_list_symbols.sclose) f printer l =
  pp_obj_list ~path ~lopen ~lsep ~lclose printer
    (List.map (pbox f) l)

let pp_obj_map ?(path=[]) ?(mopen=default_map_symbols.sopen) ?(msep=default_list_symbols.ssep) ?(mclose=default_map_symbols.sclose) ?(mbind=default_map_symbols.sbind) printer l =
  let m = Map.of_list compare_print_object l in
  pprint ~path printer (Map (m, {sopen=mopen; ssep=msep; sclose=mclose; sbind=mbind}))

let pp_map ?(path=[]) ?(mopen=default_map_symbols.sopen) ?(msep=default_list_symbols.ssep) ?(mclose=default_map_symbols.sclose) ?(mbind=default_map_symbols.sbind) fk fv printer l =
  pp_obj_map ~path ~mopen ~msep ~mclose ~mbind printer
    (List.map (fun (k,v) -> (pbox fk k,pbox fv v)) l)

let pp_mapi ?(path=[]) ?(mopen=default_map_symbols.sopen) ?(msep=default_list_symbols.ssep) ?(mclose=default_map_symbols.sclose) ?(mbind=default_map_symbols.sbind) fk fv printer l =
  pp_obj_map ~path ~mopen ~msep ~mclose ~mbind printer
    (List.map (fun (k,v) -> (pbox fk k,pbox fv (k, v))) l)

let pp_obj_set ?(path=[]) ?(sopen=default_set_symbols.sopen) ?(ssep=default_set_symbols.ssep) ?(sclose=default_set_symbols.sclose) printer s =
  pprint ~path printer
    (Set (s, {default_set_symbols with sopen; ssep; sclose}))

let pp_set ?(path=[]) ?(sopen=default_set_symbols.sopen) ?(ssep=default_set_symbols.ssep) ?(sclose=default_set_symbols.sclose) f printer s =
  let l = List.map (pbox f) (Set.elements s) in
  pp_obj_set ~path ~sopen ~ssep ~sclose printer (Set.of_list compare_print_object l)


(****************************************************************************)
(**                              {1 JSON}                                   *)
(****************************************************************************)

let rec print_object_to_json = function
  | Empty     -> `Null
  | Bool b    -> `Bool b
  | Int n     -> `Int (Z.to_int n)
  | Float f   -> `Float f
  | String s  -> `String s
  | Var v     -> `String (Format.asprintf "%a" pp_var v)
  | Map (m,_) ->
    `Assoc (
      Map.bindings m |>
      List.map (fun (k,v) ->
          let k = Format.asprintf "%a" pp_print_object k in
          k, print_object_to_json v
        )
    )
  | List (l,_) -> `List (List.map print_object_to_json l)
  | Set (s,_) -> `List (Set.elements s |> List.map print_object_to_json)

let rec json_to_print_object = function
  | `Null -> Empty
  | `Bool b -> Bool b
  | `Int n -> Int (Z.of_int n)
  | `Float f -> Float f
  | `String s -> String s
  | `Assoc a ->
    let m = List.map (fun (k,v) -> (String k,json_to_print_object v)) a |>
            Map.of_list compare_print_object in
    Map(m,default_map_symbols)
  | `List l -> List(List.map json_to_print_object l,default_list_symbols)
OCaml

Innovation. Community. Security.