package goblint

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

Source file logs.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
(** Logging, which isn't for presenting analysis results. *)

module Level =
struct
  type t =
    | Debug
    | Info
    | Warning
    | Error
    | Result
  [@@deriving eq, hash, show { with_path = false }, enum]
  (* TODO: fix ord Error: https://github.com/ocaml-ppx/ppx_deriving/issues/254 *)

  let compare x y = Stdlib.compare (to_enum x) (to_enum y)

  let of_string = function
    | "debug" -> Debug
    | "info" -> Info
    | "warning" -> Warning
    | "error" -> Error
    | "result" -> Result
    | _ -> invalid_arg "Logs.Level.of_string"

  let current = ref Debug

  let should_log l =
    compare l !current >= 0

  let stag = function
    | Error -> "red"
    | Warning -> "yellow"
    | Info -> "blue"
    | Debug -> "white" (* non-bright white is actually some gray *)
    | Result -> "reset"
end

module Result =
struct
  let use_stdout = ref true (* TODO: disable in server mode *)
end


module type Kind =
sig
  type b
  type c
  val log: Level.t -> ('a, b, c, unit) format4 -> 'a
end

module PrettyKind =
struct
  open GoblintCil

  type b = unit
  type c = Pretty.doc
  let log level fmt =
    if Level.should_log level then (
      if !AnsiColors.stderr then
        prerr_string (List.assoc (Level.stag level) AnsiColors.table);
      Printf.eprintf "[%s] " (Level.show level);
      (* Pretty.eprintf returns doc instead of unit *)
      let finish doc =
        Pretty.fprint stderr ~width:max_int doc;
        if !AnsiColors.stderr then
          prerr_string (List.assoc "reset" AnsiColors.table);
        prerr_newline ()
      in
      Pretty.gprintf finish fmt
    )
    else
      GobPretty.igprintf () fmt
end

module FormatKind =
struct
  type b = Format.formatter
  type c = unit
  let log level fmt =
    if Level.should_log level then (
      Format.eprintf "@{<%s>[%a] " (Level.stag level) Level.pp level;
      let finish ppf =
        Format.fprintf ppf "@}\n%!"
      in
      Format.kfprintf finish Format.err_formatter fmt
    )
    else
      Format.ifprintf Format.err_formatter fmt
end

module BatteriesKind =
struct
  type b = unit BatIO.output
  type c = unit
  let log level fmt =
    if Level.should_log level then (
      if !AnsiColors.stderr then
        prerr_string (List.assoc (Level.stag level) AnsiColors.table);
      BatPrintf.eprintf "[%s] " (Level.show level);
      let finish out =
        if !AnsiColors.stderr then
          prerr_string (List.assoc "reset" AnsiColors.table);
        BatPrintf.fprintf out "\n%!"
      in
      BatPrintf.kfprintf finish BatIO.stderr fmt
    )
    else
      BatPrintf.ifprintf BatIO.stderr fmt
end


module MakeKind (Kind: Kind) =
struct
  open Kind

  let log = log

  (* must eta-expand to get proper (non-weak) polymorphism for format *)
  let debug fmt = log Debug fmt
  let info fmt = log Info fmt
  let warn fmt = log Warning fmt
  let error fmt = log Error fmt

  let newline () =
    prerr_newline ()
end

module Pretty =
struct
  include MakeKind (PrettyKind)

  open GoblintCil

  let result fmt =
    if !Result.use_stdout then (
      let finish doc =
        Pretty.fprint stdout ~width:max_int doc;
        print_newline ()
      in
      Pretty.gprintf finish fmt
    )
    else
      log Result fmt
end

module Format =
struct
  include MakeKind (FormatKind)

  let result fmt =
    if !Result.use_stdout then (
      let finish ppf =
        Format.fprintf ppf "\n%!"
      in
      Format.kfprintf finish Format.std_formatter fmt
    )
    else
      log Result fmt
end

module Batteries =
struct
  include MakeKind (BatteriesKind)

  let result fmt =
    if !Result.use_stdout then (
      let finish out =
        BatPrintf.fprintf out "\n%!"
      in
      BatPrintf.kfprintf finish BatIO.stdout fmt
    )
    else
      log Result fmt
end

include Pretty (* current default *)
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct