catala/compiler/lcalc/ast.mli

(* This file is part of the Catala compiler, a specification language for tax
   and social benefits computation rules. Copyright (C) 2020 Inria, contributor:
   Denis Merigoux <denis.merigoux@inria.fr>

   Licensed under the Apache License, Version 2.0 (the "License"); you may not
   use this file except in compliance with the License. You may obtain a copy of
   the License at

   http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
   WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
   License for the specific language governing permissions and limitations under
   the License. *)

open Shared_ast

(** Abstract syntax tree for the lambda calculus *)

(** {1 Abstract syntax tree} *)

type 'm naked_expr = (lcalc, 'm) naked_gexpr
and 'm expr = (lcalc, 'm) gexpr

type 'm program = 'm expr Shared_ast.program

(** {1 Option-related management}*)

(** {2 Term building and management for the [option] monad}*)

module OptionMonad : sig
  val return : mark:'m mark -> ('a any, 'm) boxed_gexpr -> ('a, 'm) boxed_gexpr
  val empty : mark:'m mark -> ('a any, 'm) boxed_gexpr

  val bind_var :
    mark:'m mark ->
    ('a any, 'm) boxed_gexpr ->
    ('a, 'm) gexpr Var.t ->
    ('a, 'm) boxed_gexpr ->
    ('a, 'm) boxed_gexpr

  val bind :
    mark:'m mark ->
    var_name:string ->
    ('a any, 'm) boxed_gexpr ->
    ('a, 'm) boxed_gexpr ->
    ('a, 'm) boxed_gexpr

  val bind_cont :
    mark:'m mark ->
    var_name:string ->
    (('a any, 'm) gexpr Var.t -> ('a, 'm) boxed_gexpr) ->
    ('a, 'm) boxed_gexpr ->
    ('a, 'm) boxed_gexpr

  val mbind_mvar :
    mark:'m mark ->
    ('a any, 'm) boxed_gexpr ->
    ('a, 'm) gexpr Var.t list ->
    ('a, 'm) boxed_gexpr list ->
    ('a, 'm) boxed_gexpr

  val mbind :
    mark:'m mark ->
    var_name:string ->
    ('a any, 'm) boxed_gexpr ->
    ('a, 'm) boxed_gexpr list ->
    ('a, 'm) boxed_gexpr

  val mbind_cont :
    mark:'m mark ->
    var_name:string ->
    (('a any, 'm) gexpr Var.t list -> ('a, 'm) boxed_gexpr) ->
    ('a, 'm) boxed_gexpr list ->
    ('a, 'm) boxed_gexpr

  val error_on_empty :
    mark:'m mark ->
    var_name:string ->
    ?toplevel:bool ->
    ((< exceptions : yes ; .. > as 'a), 'm) boxed_gexpr ->
    ('a, 'm) boxed_gexpr

  val map :
    mark:'m mark ->
    var_name:string ->
    ((< exceptions : no ; .. > as 'a), 'm) boxed_gexpr ->
    ('a, 'm) boxed_gexpr ->
    ('a, 'm) boxed_gexpr

  val mmap_mvar :
    mark:'m mark ->
    ('a any, 'm) boxed_gexpr ->
    ('a, 'm) gexpr Var.t list ->
    ('a, 'm) boxed_gexpr list ->
    ('a, 'm) boxed_gexpr

  val mmap :
    mark:'m mark ->
    var_name:string ->
    ('a any, 'm) boxed_gexpr ->
    ('a, 'm) boxed_gexpr list ->
    ('a, 'm) boxed_gexpr
end