Mercurial > urweb

annotate src/settings.sig @ 1460:4f4f104259fb

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Renumber version in CHANGELOG, since I wasn't ready to release as soon as I expected
author Adam Chlipala <adam@chlipala.net>
date Tue, 17 May 2011 16:02:19 -0400
parents 66092ce45a76
children 2f5fd248588d
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
adam@1433 77 val allJsFuncs : unit -> (ffi * string) list
adamc@765 78
adamc@768 79 datatype pattern_kind = Exact | Prefix
adamc@768 80 datatype action = Allow | Deny
adamc@768 81 type rule = { action : action, kind : pattern_kind, pattern : string }
adamc@768 82
adamc@768 83 datatype path_kind = Any | Url | Table | Sequence | View | Relation | Cookie | Style
adamc@768 84 type rewrite = { pkind : path_kind, kind : pattern_kind, from : string, to : string }
adamc@768 85
adamc@768 86 (* Rules for rewriting URLs from canonical forms *)
adamc@768 87 val setRewriteRules : rewrite list -> unit
adamc@768 88 val rewrite : path_kind -> string -> string
adamc@768 89
adamc@769 90 (* Validating URLs and MIME types *)
adamc@769 91 val setUrlRules : rule list -> unit
adamc@770 92 val getUrlRules : unit -> rule list
adamc@769 93 val checkUrl : string -> bool
adamc@769 94
adamc@769 95 val setMimeRules : rule list -> unit
adamc@770 96 val getMimeRules : unit -> rule list
adamc@769 97 val checkMime : string -> bool
adamc@769 98
adamc@855 99 (* Web protocols that generated programs may speak *)
adamc@855 100 type protocol = {
adamc@1095 101 name : string, (* Call it this on the command line *)
adamc@1096 102 compile : string, (* Pass these `gcc -c' arguments *)
adamc@1095 103 linkStatic : string, (* Pass these static linker arguments *)
adamc@1095 104 linkDynamic : string,(* Pass these dynamic linker arguments *)
adamc@1164 105 persistent : bool, (* Multiple requests per process? *)
adamc@1164 106 code : unit -> Print.PD.pp_desc (* Extra code to include in C files *)
adamc@855 107 }
adamc@855 108 val addProtocol : protocol -> unit
adamc@856 109 val setProtocol : string -> unit
adamc@855 110 val currentProtocol : unit -> protocol
adamc@855 111
adamc@866 112 (* Different DBMSes *)
adamc@867 113 datatype sql_type =
adamc@867 114 Int
adamc@867 115 | Float
adamc@867 116 | String
adamc@1011 117 | Char
adamc@867 118 | Bool
adamc@867 119 | Time
adamc@867 120 | Blob
adamc@867 121 | Channel
adamc@867 122 | Client
adamc@867 123 | Nullable of sql_type
adamc@867 124
adamc@873 125 val p_sql_ctype : sql_type -> string
adamc@867 126 val isBlob : sql_type -> bool
adamc@870 127 val isNotNull : sql_type -> bool
adamc@867 128
adam@1293 129 datatype failure_mode = Error | None
adam@1293 130
adamc@866 131 type dbms = {
adamc@866 132 name : string,
adamc@866 133 (* Call it this on the command line *)
adamc@866 134 header : string,
adamc@866 135 (* Include this C header file *)
adamc@866 136 link : string,
adamc@866 137 (* Pass these linker arguments *)
adamc@873 138 p_sql_type : sql_type -> string,
adamc@870 139 init : {dbstring : string,
adamc@870 140 prepared : (string * int) list,
adamc@870 141 tables : (string * (string * sql_type) list) list,
adamc@872 142 views : (string * (string * sql_type) list) list,
adamc@870 143 sequences : string list} -> Print.PD.pp_desc,
adamc@874 144 (* Define uw_client_init(), uw_db_init(), uw_db_close(), uw_db_begin(), uw_db_commit(), and uw_db_rollback() *)
adamc@873 145 query : {loc : ErrorMsg.span, cols : sql_type list,
adamc@880 146 doCols : ({loc : ErrorMsg.span, wontLeakStrings : bool, col : int, typ : sql_type} -> Print.PD.pp_desc)
adamc@867 147 -> Print.PD.pp_desc}
adamc@867 148 -> Print.PD.pp_desc,
adamc@867 149 queryPrepared : {loc : ErrorMsg.span, id : int, query : string,
adamc@873 150 inputs : sql_type list, cols : sql_type list,
adamc@880 151 doCols : ({loc : ErrorMsg.span, wontLeakStrings : bool, col : int,
adamc@880 152 typ : sql_type} -> Print.PD.pp_desc)
adamc@879 153 -> Print.PD.pp_desc,
adamc@879 154 nested : bool}
adamc@868 155 -> Print.PD.pp_desc,
adam@1293 156 dml : ErrorMsg.span * failure_mode -> Print.PD.pp_desc,
adamc@868 157 dmlPrepared : {loc : ErrorMsg.span, id : int, dml : string,
adam@1293 158 inputs : sql_type list, mode : failure_mode} -> Print.PD.pp_desc,
adamc@878 159 nextval : {loc : ErrorMsg.span, seqE : Print.PD.pp_desc, seqName : string option} -> Print.PD.pp_desc,
adamc@874 160 nextvalPrepared : {loc : ErrorMsg.span, id : int, query : string} -> Print.PD.pp_desc,
adamc@1073 161 setval : {loc : ErrorMsg.span, seqE : Print.PD.pp_desc, count : Print.PD.pp_desc} -> Print.PD.pp_desc,
adamc@874 162 sqlifyString : string -> string,
adamc@874 163 p_cast : string * sql_type -> string,
adamc@874 164 p_blank : int * sql_type -> string (* Prepared statement input *),
adamc@877 165 supportsDeleteAs : bool,
adamc@886 166 supportsUpdateAs : bool,
adamc@877 167 createSequence : string -> string,
adamc@878 168 textKeysNeedLengths : bool,
adamc@879 169 supportsNextval : bool,
adamc@882 170 supportsNestedPrepared : bool,
adamc@890 171 sqlPrefix : string,
adamc@1014 172 supportsOctetLength : bool,
adamc@1014 173 trueString : string,
adamc@1196 174 falseString : string,
adamc@1196 175 onlyUnion : bool,
adamc@1196 176 nestedRelops : bool
adamc@866 177 }
adamc@857 178
adamc@866 179 val addDbms : dbms -> unit
adamc@866 180 val setDbms : string -> unit
adamc@866 181 val currentDbms : unit -> dbms
adamc@858 182
adamc@891 183 val setDbstring : string option -> unit
adamc@891 184 val getDbstring : unit -> string option
adamc@891 185
adamc@891 186 val setExe : string option -> unit
adamc@891 187 val getExe : unit -> string option
adamc@891 188
adamc@891 189 val setSql : string option -> unit
adamc@891 190 val getSql : unit -> string option
adamc@891 191
adamc@1016 192 val setCoreInline : int -> unit
adamc@1016 193 val getCoreInline : unit -> int
adamc@1016 194
adamc@1016 195 val setMonoInline : int -> unit
adamc@1016 196 val getMonoInline : unit -> int
adamc@1016 197
adamc@1095 198 val setStaticLinking : bool -> unit
adamc@1095 199 val getStaticLinking : unit -> bool
adamc@1095 200
adamc@1114 201 val setDeadlines : bool -> unit
adamc@1114 202 val getDeadlines : unit -> bool
adamc@1114 203
adamc@1164 204 val setSigFile : string option -> unit
adamc@1164 205 val getSigFile : unit -> string option
adamc@1164 206
adamc@1183 207 (* Which GET-able functions should be allowed to have side effects? *)
adamc@1183 208 val setSafeGets : string list -> unit
adamc@1183 209 val isSafeGet : string -> bool
adamc@1183 210
adam@1294 211 val setOnError : (string * string list * string) option -> unit
adam@1294 212 val getOnError : unit -> (string * string list * string) option
adam@1307 213
adam@1307 214 val addLimit : string * int -> unit
adam@1307 215 val limits : unit -> (string * int) list
adam@1332 216
adam@1332 217 val setMinHeap : int -> unit
adam@1332 218 val getMinHeap : unit -> int
adam@1393 219
adam@1393 220 val addAlwaysInline : string -> unit
adam@1393 221 val checkAlwaysInline : string -> bool
adamc@764 222 end