Mercurial > urweb

annotate src/settings.sig @ 1380:ede95ecb4000

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Thanks to Vag Vagoff, catch some cases of an obsolete notation for guarded types in the manual
author Adam Chlipala <adam@chlipala.net>
date Thu, 06 Jan 2011 08:55:53 -0500
parents 44a12a321150
children 802c179dac1f
rev   line source
adam@1307 1 (* Copyright (c) 2008-2010, Adam Chlipala
adamc@764 2 * All rights reserved.
adamc@764 3 *
adamc@764 4 * Redistribution and use in source and binary forms, with or without
adamc@764 5 * modification, are permitted provided that the following conditions are met:
adamc@764 6 *
adamc@764 7 * - Redistributions of source code must retain the above copyright notice,
adamc@764 8 * this list of conditions and the following disclaimer.
adamc@764 9 * - Redistributions in binary form must reproduce the above copyright notice,
adamc@764 10 * this list of conditions and the following disclaimer in the documentation
adamc@764 11 * and/or other materials provided with the distribution.
adamc@764 12 * - The names of contributors may not be used to endorse or promote products
adamc@764 13 * derived from this software without specific prior written permission.
adamc@764 14 *
adamc@764 15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
adamc@764 16 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
adamc@764 17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
adamc@764 18 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
adamc@764 19 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
adamc@764 20 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
adamc@764 21 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
adamc@764 22 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
adamc@764 23 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
adamc@764 24 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
adamc@764 25 * POSSIBILITY OF SUCH DAMAGE.
adamc@764 26 *)
adamc@764 27
adamc@764 28 signature SETTINGS = sig
adamc@764 29
adamc@866 30 val setDebug : bool -> unit
adamc@866 31 val getDebug : unit -> bool
adamc@866 32
adamc@866 33 val clibFile : string -> string
adamc@866 34
adamc@765 35 (* How do all application URLs begin? *)
adamc@764 36 val setUrlPrefix : string -> unit
adamc@764 37 val getUrlPrefix : unit -> string
adam@1370 38 val getUrlPrePrefix : unit -> string
adamc@764 39
adamc@765 40 (* How many seconds should the server wait before assuming a Comet client has left? *)
adamc@764 41 val setTimeout : int -> unit
adamc@764 42 val getTimeout : unit -> int
adamc@764 43
adamc@765 44 (* Which C header files are needed? *)
adamc@764 45 val setHeaders : string list -> unit
adamc@764 46 val getHeaders : unit -> string list
adamc@764 47
adamc@766 48 (* Which extra JavaScript URLs should be included? *)
adamc@766 49 val setScripts : string list -> unit
adamc@766 50 val getScripts : unit -> string list
adamc@766 51
adamc@765 52 type ffi = string * string
adamc@765 53
adamc@765 54 (* Which FFI types may be sent from clients to servers? *)
adamc@765 55 val setClientToServer : ffi list -> unit
adamc@765 56 val mayClientToServer : ffi -> bool
adamc@765 57
adamc@765 58 (* Which FFI functions have side effects? *)
adamc@765 59 val setEffectful : ffi list -> unit
adamc@765 60 val isEffectful : ffi -> bool
adamc@765 61
adamc@1171 62 (* Which FFI functions should not have their calls removed or reordered, but cause no lasting effects? *)
adamc@1171 63 val setBenignEffectful : ffi list -> unit
adamc@1171 64 val isBenignEffectful : ffi -> bool
adamc@1171 65
adamc@765 66 (* Which FFI functions may only be run in clients? *)
adamc@765 67 val setClientOnly : ffi list -> unit
adamc@765 68 val isClientOnly : ffi -> bool
adamc@765 69
adamc@765 70 (* Which FFI functions may only be run on servers? *)
adamc@765 71 val setServerOnly : ffi list -> unit
adamc@765 72 val isServerOnly : ffi -> bool
adamc@765 73
adamc@765 74 (* Which FFI functions may be run in JavaScript? (JavaScript function names included) *)
adamc@765 75 val setJsFuncs : (ffi * string) list -> unit
adamc@765 76 val jsFunc : ffi -> string option
adamc@765 77
adamc@768 78 datatype pattern_kind = Exact | Prefix
adamc@768 79 datatype action = Allow | Deny
adamc@768 80 type rule = { action : action, kind : pattern_kind, pattern : string }
adamc@768 81
adamc@768 82 datatype path_kind = Any | Url | Table | Sequence | View | Relation | Cookie | Style
adamc@768 83 type rewrite = { pkind : path_kind, kind : pattern_kind, from : string, to : string }
adamc@768 84
adamc@768 85 (* Rules for rewriting URLs from canonical forms *)
adamc@768 86 val setRewriteRules : rewrite list -> unit
adamc@768 87 val rewrite : path_kind -> string -> string
adamc@768 88
adamc@769 89 (* Validating URLs and MIME types *)
adamc@769 90 val setUrlRules : rule list -> unit
adamc@770 91 val getUrlRules : unit -> rule list
adamc@769 92 val checkUrl : string -> bool
adamc@769 93
adamc@769 94 val setMimeRules : rule list -> unit
adamc@770 95 val getMimeRules : unit -> rule list
adamc@769 96 val checkMime : string -> bool
adamc@769 97
adamc@855 98 (* Web protocols that generated programs may speak *)
adamc@855 99 type protocol = {
adamc@1095 100 name : string, (* Call it this on the command line *)
adamc@1096 101 compile : string, (* Pass these `gcc -c' arguments *)
adamc@1095 102 linkStatic : string, (* Pass these static linker arguments *)
adamc@1095 103 linkDynamic : string,(* Pass these dynamic linker arguments *)
adamc@1164 104 persistent : bool, (* Multiple requests per process? *)
adamc@1164 105 code : unit -> Print.PD.pp_desc (* Extra code to include in C files *)
adamc@855 106 }
adamc@855 107 val addProtocol : protocol -> unit
adamc@856 108 val setProtocol : string -> unit
adamc@855 109 val currentProtocol : unit -> protocol
adamc@855 110
adamc@866 111 (* Different DBMSes *)
adamc@867 112 datatype sql_type =
adamc@867 113 Int
adamc@867 114 | Float
adamc@867 115 | String
adamc@1011 116 | Char
adamc@867 117 | Bool
adamc@867 118 | Time
adamc@867 119 | Blob
adamc@867 120 | Channel
adamc@867 121 | Client
adamc@867 122 | Nullable of sql_type
adamc@867 123
adamc@873 124 val p_sql_ctype : sql_type -> string
adamc@867 125 val isBlob : sql_type -> bool
adamc@870 126 val isNotNull : sql_type -> bool
adamc@867 127
adam@1293 128 datatype failure_mode = Error | None
adam@1293 129
adamc@866 130 type dbms = {
adamc@866 131 name : string,
adamc@866 132 (* Call it this on the command line *)
adamc@866 133 header : string,
adamc@866 134 (* Include this C header file *)
adamc@866 135 link : string,
adamc@866 136 (* Pass these linker arguments *)
adamc@873 137 p_sql_type : sql_type -> string,
adamc@870 138 init : {dbstring : string,
adamc@870 139 prepared : (string * int) list,
adamc@870 140 tables : (string * (string * sql_type) list) list,
adamc@872 141 views : (string * (string * sql_type) list) list,
adamc@870 142 sequences : string list} -> Print.PD.pp_desc,
adamc@874 143 (* Define uw_client_init(), uw_db_init(), uw_db_close(), uw_db_begin(), uw_db_commit(), and uw_db_rollback() *)
adamc@873 144 query : {loc : ErrorMsg.span, cols : sql_type list,
adamc@880 145 doCols : ({loc : ErrorMsg.span, wontLeakStrings : bool, col : int, typ : sql_type} -> Print.PD.pp_desc)
adamc@867 146 -> Print.PD.pp_desc}
adamc@867 147 -> Print.PD.pp_desc,
adamc@867 148 queryPrepared : {loc : ErrorMsg.span, id : int, query : string,
adamc@873 149 inputs : sql_type list, cols : sql_type list,
adamc@880 150 doCols : ({loc : ErrorMsg.span, wontLeakStrings : bool, col : int,
adamc@880 151 typ : sql_type} -> Print.PD.pp_desc)
adamc@879 152 -> Print.PD.pp_desc,
adamc@879 153 nested : bool}
adamc@868 154 -> Print.PD.pp_desc,
adam@1293 155 dml : ErrorMsg.span * failure_mode -> Print.PD.pp_desc,
adamc@868 156 dmlPrepared : {loc : ErrorMsg.span, id : int, dml : string,
adam@1293 157 inputs : sql_type list, mode : failure_mode} -> Print.PD.pp_desc,
adamc@878 158 nextval : {loc : ErrorMsg.span, seqE : Print.PD.pp_desc, seqName : string option} -> Print.PD.pp_desc,
adamc@874 159 nextvalPrepared : {loc : ErrorMsg.span, id : int, query : string} -> Print.PD.pp_desc,
adamc@1073 160 setval : {loc : ErrorMsg.span, seqE : Print.PD.pp_desc, count : Print.PD.pp_desc} -> Print.PD.pp_desc,
adamc@874 161 sqlifyString : string -> string,
adamc@874 162 p_cast : string * sql_type -> string,
adamc@874 163 p_blank : int * sql_type -> string (* Prepared statement input *),
adamc@877 164 supportsDeleteAs : bool,
adamc@886 165 supportsUpdateAs : bool,
adamc@877 166 createSequence : string -> string,
adamc@878 167 textKeysNeedLengths : bool,
adamc@879 168 supportsNextval : bool,
adamc@882 169 supportsNestedPrepared : bool,
adamc@890 170 sqlPrefix : string,
adamc@1014 171 supportsOctetLength : bool,
adamc@1014 172 trueString : string,
adamc@1196 173 falseString : string,
adamc@1196 174 onlyUnion : bool,
adamc@1196 175 nestedRelops : bool
adamc@866 176 }
adamc@857 177
adamc@866 178 val addDbms : dbms -> unit
adamc@866 179 val setDbms : string -> unit
adamc@866 180 val currentDbms : unit -> dbms
adamc@858 181
adamc@891 182 val setDbstring : string option -> unit
adamc@891 183 val getDbstring : unit -> string option
adamc@891 184
adamc@891 185 val setExe : string option -> unit
adamc@891 186 val getExe : unit -> string option
adamc@891 187
adamc@891 188 val setSql : string option -> unit
adamc@891 189 val getSql : unit -> string option
adamc@891 190
adamc@1016 191 val setCoreInline : int -> unit
adamc@1016 192 val getCoreInline : unit -> int
adamc@1016 193
adamc@1016 194 val setMonoInline : int -> unit
adamc@1016 195 val getMonoInline : unit -> int
adamc@1016 196
adamc@1095 197 val setStaticLinking : bool -> unit
adamc@1095 198 val getStaticLinking : unit -> bool
adamc@1095 199
adamc@1114 200 val setDeadlines : bool -> unit
adamc@1114 201 val getDeadlines : unit -> bool
adamc@1114 202
adamc@1164 203 val setSigFile : string option -> unit
adamc@1164 204 val getSigFile : unit -> string option
adamc@1164 205
adamc@1183 206 (* Which GET-able functions should be allowed to have side effects? *)
adamc@1183 207 val setSafeGets : string list -> unit
adamc@1183 208 val isSafeGet : string -> bool
adamc@1183 209
adam@1294 210 val setOnError : (string * string list * string) option -> unit
adam@1294 211 val getOnError : unit -> (string * string list * string) option
adam@1307 212
adam@1307 213 val addLimit : string * int -> unit
adam@1307 214 val limits : unit -> (string * int) list
adam@1332 215
adam@1332 216 val setMinHeap : int -> unit
adam@1332 217 val getMinHeap : unit -> int
adamc@764 218 end