aboutsummaryrefslogtreecommitdiffstats
path: root/src/common/Statemonad.v
blob: c667fd98af551cf49e49544b017d046c96544340 (plain)
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
(*
 * Vericert: Verified high-level synthesis.
 * Copyright (C) 2020 Yann Herklotz <yann@yannherklotz.com>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 *)

From compcert Require Errors.
From vericert Require Import Monad.
From Coq Require Import Lists.List.

Module Type State.
  Parameter st : Type.
  Parameter st_prop : st -> st -> Prop.

  Axiom st_refl : forall s, st_prop s s.
  Axiom st_trans : forall s1 s2 s3, st_prop s1 s2 -> st_prop s2 s3 -> st_prop s1 s3.
End State.

Module Statemonad(S : State) <: Monad.

  Inductive res (A: Type) (s: S.st): Type :=
  | Error : Errors.errmsg -> res A s
  | OK : A -> forall (s' : S.st), S.st_prop s s' -> res A s.

  Arguments OK [A s].
  Arguments Error [A s].

  Definition mon (A: Type) : Type := forall (s: S.st), res A s.

  Definition ret {A: Type} (x: A) : mon A :=
    fun (s : S.st) => OK x s (S.st_refl s).

  Definition bind {A B: Type} (g: A -> mon B) (f: mon A) : mon B :=
    fun (s : S.st) =>
      match f s with
      | Error msg => Error msg
      | OK a s' i =>
        match g a s' with
        | Error msg => Error msg
        | OK b s'' i' => OK b s'' (S.st_trans s s' s'' i i')
        end
      end.

  Definition bind2 {A B C: Type} (g: A -> B -> mon C) (f: mon (A * B)) : mon C :=
    bind (fun xy => g (fst xy) (snd xy)) (f: mon (A * B)).

  Definition handle_error {A: Type} (f g: mon A) : mon A :=
    fun (s : S.st) =>
      match f s with
      | OK a s' i => OK a s' i
      | Error _ => g s
      end.

  Definition error {A: Type} (err: Errors.errmsg) : mon A := fun (s: S.st) => Error err.

  Definition get : mon S.st := fun s => OK s s (S.st_refl s).

  Definition set (s: S.st) (i: forall s', S.st_prop  s' s) : mon unit :=
    fun s' => OK tt s (i s').

  Definition run_mon {A: Type} (s: S.st) (m: mon A): Errors.res A :=
    match m s with
    | OK a s' i => Errors.OK a
    | Error err => Errors.Error err
    end.

  #[global] Instance statemonad_ret : MRet mon := @ret.
  #[global] Instance statemonad_bind : MBind mon := @bind.

End Statemonad.