annotate src/elab_env.sig @ 524:a6159d0940f0

Start of manual
author Adam Chlipala <adamc@hcoop.net>
date Thu, 27 Nov 2008 14:38:53 -0500
parents 33d5bd69da00
children 588b9d16b00a
rev   line source
adamc@2 1 (* Copyright (c) 2008, Adam Chlipala
adamc@2 2 * All rights reserved.
adamc@2 3 *
adamc@2 4 * Redistribution and use in source and binary forms, with or without
adamc@2 5 * modification, are permitted provided that the following conditions are met:
adamc@2 6 *
adamc@2 7 * - Redistributions of source code must retain the above copyright notice,
adamc@2 8 * this list of conditions and the following disclaimer.
adamc@2 9 * - Redistributions in binary form must reproduce the above copyright notice,
adamc@2 10 * this list of conditions and the following disclaimer in the documentation
adamc@2 11 * and/or other materials provided with the distribution.
adamc@2 12 * - The names of contributors may not be used to endorse or promote products
adamc@2 13 * derived from this software without specific prior written permission.
adamc@2 14 *
adamc@2 15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
adamc@2 16 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
adamc@2 17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
adamc@2 18 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
adamc@2 19 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
adamc@2 20 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
adamc@2 21 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
adamc@2 22 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
adamc@2 23 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
adamc@2 24 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
adamc@2 25 * POSSIBILITY OF SUCH DAMAGE.
adamc@2 26 *)
adamc@2 27
adamc@2 28 signature ELAB_ENV = sig
adamc@2 29
adamc@13 30 exception SynUnif
adamc@13 31 val liftConInCon : int -> Elab.con -> Elab.con
adamc@13 32
adamc@487 33 val liftConInExp : int -> Elab.exp -> Elab.exp
adamc@448 34 val liftExpInExp : int -> Elab.exp -> Elab.exp
adamc@448 35
adamc@448 36 val subExpInExp : (int * Elab.exp) -> Elab.exp -> Elab.exp
adamc@448 37
adamc@2 38 type env
adamc@2 39
adamc@2 40 val empty : env
adamc@2 41
adamc@2 42 exception UnboundRel of int
adamc@2 43 exception UnboundNamed of int
adamc@2 44
adamc@9 45 datatype 'a var =
adamc@9 46 NotBound
adamc@9 47 | Rel of int * 'a
adamc@9 48 | Named of int * 'a
adamc@9 49
adamc@2 50 val pushCRel : env -> string -> Elab.kind -> env
adamc@2 51 val lookupCRel : env -> int -> string * Elab.kind
adamc@2 52
adamc@11 53 val pushCNamed : env -> string -> Elab.kind -> Elab.con option -> env * int
adamc@11 54 val pushCNamedAs : env -> string -> int -> Elab.kind -> Elab.con option -> env
adamc@11 55 val lookupCNamed : env -> int -> string * Elab.kind * Elab.con option
adamc@9 56
adamc@9 57 val lookupC : env -> string -> Elab.kind var
adamc@9 58
adamc@191 59 val pushDatatype : env -> int -> string list -> (string * int * Elab.con option) list -> env
adamc@157 60 type datatyp
adamc@157 61 val lookupDatatype : env -> int -> datatyp
adamc@171 62 val lookupDatatypeConstructor : datatyp -> int -> string * Elab.con option
adamc@191 63 val datatypeArgs : datatyp -> string list
adamc@157 64 val constructors : datatyp -> (string * int * Elab.con option) list
adamc@157 65
adamc@191 66 val lookupConstructor : env -> string -> (Elab.datatype_kind * int * string list * Elab.con option * int) option
adamc@171 67
adamc@211 68 val pushClass : env -> int -> env
adamc@403 69 val isClass : env -> Elab.con -> bool
adamc@211 70 val resolveClass : env -> Elab.con -> Elab.exp option
adamc@211 71
adamc@9 72 val pushERel : env -> string -> Elab.con -> env
adamc@9 73 val lookupERel : env -> int -> string * Elab.con
adamc@9 74
adamc@9 75 val pushENamed : env -> string -> Elab.con -> env * int
adamc@9 76 val pushENamedAs : env -> string -> int -> Elab.con -> env
adamc@9 77 val lookupENamed : env -> int -> string * Elab.con
adamc@471 78 val checkENamed : env -> int -> bool
adamc@31 79
adamc@9 80 val lookupE : env -> string -> Elab.con var
adamc@2 81
adamc@31 82 val pushSgnNamed : env -> string -> Elab.sgn -> env * int
adamc@31 83 val pushSgnNamedAs : env -> string -> int -> Elab.sgn -> env
adamc@31 84 val lookupSgnNamed : env -> int -> string * Elab.sgn
adamc@31 85
adamc@31 86 val lookupSgn : env -> string -> (int * Elab.sgn) option
adamc@31 87
adamc@31 88 val pushStrNamed : env -> string -> Elab.sgn -> env * int
adamc@31 89 val pushStrNamedAs : env -> string -> int -> Elab.sgn -> env
adamc@31 90 val lookupStrNamed : env -> int -> string * Elab.sgn
adamc@31 91
adamc@31 92 val lookupStr : env -> string -> (int * Elab.sgn) option
adamc@31 93
adamc@447 94 val edeclBinds : env -> Elab.edecl -> env
adamc@13 95 val declBinds : env -> Elab.decl -> env
adamc@31 96 val sgiBinds : env -> Elab.sgn_item -> env
adamc@13 97
adamc@42 98 val hnormSgn : env -> Elab.sgn -> Elab.sgn
adamc@42 99
adamc@34 100 val projectCon : env -> { sgn : Elab.sgn, str : Elab.str, field : string } -> (Elab.kind * Elab.con option) option
adamc@157 101 val projectDatatype : env -> { sgn : Elab.sgn, str : Elab.str, field : string }
adamc@191 102 -> (string list * (string * int * Elab.con option) list) option
adamc@174 103 val projectConstructor : env -> { sgn : Elab.sgn, str : Elab.str, field : string }
adamc@191 104 -> (Elab.datatype_kind * int * string list * Elab.con option * Elab.con) option
adamc@34 105 val projectVal : env -> { sgn : Elab.sgn, str : Elab.str, field : string } -> Elab.con option
adamc@59 106 val projectSgn : env -> { sgn : Elab.sgn, str : Elab.str, field : string } -> Elab.sgn option
adamc@34 107 val projectStr : env -> { sgn : Elab.sgn, str : Elab.str, field : string } -> Elab.sgn option
adamc@88 108 val projectConstraints : env -> { sgn : Elab.sgn, str : Elab.str } -> (Elab.con * Elab.con) list option
adamc@34 109
adamc@109 110 val newNamed : unit -> int
adamc@109 111
adamc@158 112 val chaseMpath : env -> (int * string list) -> Elab.str * Elab.sgn
adamc@158 113
adamc@243 114 val patBinds : env -> Elab.pat -> env
adamc@243 115
adamc@2 116 end