Source file preprocess.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
(*********************************************************************************)
(*  Dunolint - A tool to lint and help manage files in dune projects             *)
(*  Copyright (C) 2024-2025 Mathieu Barbin <mathieu.barbin@gmail.com>            *)
(*                                                                               *)
(*  This file is part of Dunolint.                                               *)
(*                                                                               *)
(*  Dunolint 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 any later   *)
(*  version, with the LGPL-3.0 Linking Exception.                                *)
(*                                                                               *)
(*  Dunolint 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  *)
(*  and the file `NOTICE.md` at the root of this repository for more details.    *)
(*                                                                               *)
(*  You should have received a copy of the GNU Lesser General Public License     *)
(*  and the LGPL-3.0 Linking Exception along with this library. If not, see      *)
(*  <http://www.gnu.org/licenses/> and <https://spdx.org>, respectively.         *)
(*********************************************************************************)

module State = struct
  type t =
    | No_preprocessing
    | Pps of Pps.t
    | Unhandled of Sexp.t
  [@@deriving sexp_of]
end

type t = { mutable state : State.t } [@@deriving sexp_of]

let state t = t.state
let set_state t ~state = t.state <- state

let create ?pps () =
  { state =
      (match pps with
       | Some pps -> Pps pps
       | None -> No_preprocessing)
  }
;;

let field_name = "preprocess"

let read ~sexps_rewriter ~field =
  let args = Dunolinter.Sexp_handler.get_args ~field_name ~sexps_rewriter ~field in
  match args with
  | [ Atom "no_preprocessing" ] -> { state = No_preprocessing }
  | [ (List (Atom "pps" :: _) as field) ] ->
    let pps = Pps.read ~sexps_rewriter ~field in
    { state = Pps pps }
  | [ sexp ] -> { state = Unhandled sexp }
  | _ ->
    let loc = Sexps_rewriter.loc sexps_rewriter field in
    Err.raise
      ~loc
      Pp.O.
        [ Pp.text "Unexpected "
          ++ Pp_tty.kwd (module String) field_name
          ++ Pp.text " field value."
        ]
;;

let write (t : t) =
  let args =
    match t.state with
    | No_preprocessing -> [ Sexp.Atom "no_preprocessing" ]
    | Pps pps -> [ Pps.write pps ]
    | Unhandled sexp -> [ sexp ]
  in
  Sexp.List (Atom field_name :: args)
;;

let rewrite t ~sexps_rewriter ~field =
  let args = Dunolinter.Sexp_handler.get_args ~field_name ~sexps_rewriter ~field in
  let file_rewriter = Sexps_rewriter.file_rewriter sexps_rewriter in
  match args with
  | [ (Atom "no_preprocessing" as arg) ] ->
    (match t.state with
     | No_preprocessing -> ()
     | Pps pps ->
       File_rewriter.replace
         file_rewriter
         ~range:(Sexps_rewriter.range sexps_rewriter arg)
         ~text:(Pps.write pps |> Sexp.to_string)
     | Unhandled _ -> ())
  | [ (List (Atom "pps" :: _) as field) ] ->
    let loc = Sexps_rewriter.loc sexps_rewriter field in
    (match t.state with
     | No_preprocessing ->
       File_rewriter.replace file_rewriter ~range:(Loc.range loc) ~text:"no_preprocessing"
     | Pps pps -> Pps.rewrite pps ~sexps_rewriter ~field
     | Unhandled _ -> ())
  | [ arg ] ->
    let loc = Sexps_rewriter.loc sexps_rewriter arg in
    (match t.state with
     | No_preprocessing ->
       File_rewriter.replace file_rewriter ~range:(Loc.range loc) ~text:"no_preprocessing"
     | Pps pps ->
       File_rewriter.replace
         file_rewriter
         ~range:(Sexps_rewriter.range sexps_rewriter arg)
         ~text:(Pps.write pps |> Sexp.to_string)
     | Unhandled _ -> ())
  | _ ->
    let loc = Sexps_rewriter.loc sexps_rewriter field in
    Err.raise
      ~loc
      Pp.O.
        [ Pp.text "Unexpected "
          ++ Pp_tty.kwd (module String) field_name
          ++ Pp.text " field value."
        ]
;;

type predicate = Dune.Preprocess.Predicate.t

let eval t ~predicate =
  match (predicate : predicate) with
  | `no_preprocessing ->
    (match t.state with
     | No_preprocessing -> true |> Dunolint.Trilang.const
     | Pps _ | Unhandled _ -> false |> Dunolint.Trilang.const)
  | `pps condition ->
    (match t.state with
     | Pps pps ->
       Dunolint.Trilang.eval condition ~f:(fun predicate -> Pps.eval pps ~predicate)
     | No_preprocessing | Unhandled _ -> false |> Dunolint.Trilang.const)
;;

let enforce =
  Dunolinter.Linter.enforce
    (module Dune.Preprocess.Predicate)
    ~eval
    ~enforce:(fun t predicate ->
      match predicate with
      | Not (`no_preprocessing | `pps _) -> Eval
      | T `no_preprocessing ->
        t.state <- No_preprocessing;
        Ok
      | T (`pps condition) ->
        (match t.state with
         | Pps pps -> Pps.enforce pps ~condition
         | No_preprocessing | Unhandled _ ->
           let pps = Pps.create ~args:[] in
           Pps.enforce pps ~condition;
           t.state <- Pps pps);
        Ok)
;;