package crs

  1. Overview
  2. Docs
A tool for managing inline review comments embedded in source code

Install 

dune-project
 Dependency

github.com Readme Changelog Edit opam file Versions (4)

Authors

  1. M
    Mathieu Barbin

Maintainers

  1. M
    Mathieu Barbin <opensource@mbarbin.org>

Sources

crs-0.0.20260307.tbz
sha256=77f77c61e908a6716fa876f5648f662ffaf7e24be4a7889fd6b53121592311bb
sha512=5fc6252650571c4127ebb1e61fecf78c5d4ce35e2832dff47125cda1448e07ea6d4da5e3a9a28643e3491d3594b0ee8857214241f98bd0296ada2c35ea8daa4b

doc/src/crs.cr-comment/filter.ml.html

Source file filter.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
(********************************************************************************)
(*  crs - A tool for managing inline review comments embedded in source code    *)
(*  Copyright (C) 2024-2026 Mathieu Barbin <mathieu.barbin@gmail.com>           *)
(*                                                                              *)
(*  This file is part of crs.                                                   *)
(*                                                                              *)
(*  crs 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.                                        *)
(*                                                                              *)
(*  crs 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.        *)
(********************************************************************************)

type t =
  | All
  | Invalid
  | CRs
  | XCRs
  | Now
  | Soon
  | Someday

let variant_constructor_name = function
  | All -> "All"
  | Invalid -> "Invalid"
  | CRs -> "CRs"
  | XCRs -> "XCRs"
  | Now -> "Now"
  | Soon -> "Soon"
  | Someday -> "Someday"
;;

let variant_constructor_rank = function
  | All -> 0
  | Invalid -> 1
  | CRs -> 2
  | XCRs -> 3
  | Now -> 4
  | Soon -> 5
  | Someday -> 6
;;

let all = [ All; Invalid; CRs; XCRs; Now; Soon; Someday ]

let compare t1 t2 =
  Int.compare (variant_constructor_rank t1) (variant_constructor_rank t2)
;;

let equal t1 t2 = Int.equal (variant_constructor_rank t1) (variant_constructor_rank t2)
let to_dyn t = Dyn.Variant (variant_constructor_name t, [])
let to_string t = String.lowercase_ascii (variant_constructor_name t)

let shorthand = function
  | All -> 'a'
  | Invalid -> 'i'
  | CRs -> 'c'
  | XCRs -> 'x'
  | Now -> 'w'
  | Soon -> 'o'
  | Someday -> 'd'
;;

let matches t ~cr =
  match t with
  | All -> true
  | Invalid ->
    (match Cr_comment0.header cr with
     | Error _ -> true
     | Ok _ -> false)
  | CRs ->
    (match Cr_comment0.header cr with
     | Error _ -> false
     | Ok h ->
       (match Cr_comment0.Header.status h with
        | XCR -> false
        | CR ->
          (match Cr_comment0.Header.qualifier h with
           | None -> true
           | Soon | Someday -> false)))
  | XCRs ->
    (match Cr_comment0.header cr with
     | Error _ -> false
     | Ok h ->
       (match Cr_comment0.Header.status h with
        | CR -> false
        | XCR -> true))
  | Now ->
    (match Cr_comment0.header cr with
     | Error _ -> false
     | Ok h ->
       (match Cr_comment0.Header.status h with
        | XCR -> true
        | CR ->
          (match Cr_comment0.Header.qualifier h with
           | None -> true
           | Soon | Someday -> false)))
  | Soon ->
    (match Cr_comment0.header cr with
     | Error _ -> false
     | Ok h ->
       (match Cr_comment0.Header.status h with
        | XCR -> false
        | CR ->
          (match Cr_comment0.Header.qualifier h with
           | Soon -> true
           | None | Someday -> false)))
  | Someday ->
    (match Cr_comment0.header cr with
     | Error _ -> false
     | Ok h ->
       (match Cr_comment0.Header.status h with
        | XCR -> false
        | CR ->
          (match Cr_comment0.Header.qualifier h with
           | Someday -> true
           | None | Soon -> false)))
;;