Mercurial > urweb

annotate src/settings.sig @ 1328:c5799b1e4c58

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update manual to track uw_register_transactional() change
author Adam Chlipala <adam@chlipala.net>
date Sat, 04 Dec 2010 11:18:19 -0500
parents d2ad997ca157
children 4dd5d23bace2
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
adamc@764 38
adamc@765 39 (* How many seconds should the server wait before assuming a Comet client has left? *)
adamc@764 40 val setTimeout : int -> unit
adamc@764 41 val getTimeout : unit -> int
adamc@764 42
adamc@765 43 (* Which C header files are needed? *)
adamc@764 44 val setHeaders : string list -> unit
adamc@764 45 val getHeaders : unit -> string list
adamc@764 46
adamc@766 47 (* Which extra JavaScript URLs should be included? *)
adamc@766 48 val setScripts : string list -> unit
adamc@766 49 val getScripts : unit -> string list
adamc@766 50
adamc@765 51 type ffi = string * string
adamc@765 52
adamc@765 53 (* Which FFI types may be sent from clients to servers? *)
adamc@765 54 val setClientToServer : ffi list -> unit
adamc@765 55 val mayClientToServer : ffi -> bool
adamc@765 56
adamc@765 57 (* Which FFI functions have side effects? *)
adamc@765 58 val setEffectful : ffi list -> unit
adamc@765 59 val isEffectful : ffi -> bool
adamc@765 60
adamc@1171 61 (* Which FFI functions should not have their calls removed or reordered, but cause no lasting effects? *)
adamc@1171 62 val setBenignEffectful : ffi list -> unit
adamc@1171 63 val isBenignEffectful : ffi -> bool
adamc@1171 64
adamc@765 65 (* Which FFI functions may only be run in clients? *)
adamc@765 66 val setClientOnly : ffi list -> unit
adamc@765 67 val isClientOnly : ffi -> bool
adamc@765 68
adamc@765 69 (* Which FFI functions may only be run on servers? *)
adamc@765 70 val setServerOnly : ffi list -> unit
adamc@765 71 val isServerOnly : ffi -> bool
adamc@765 72
adamc@765 73 (* Which FFI functions may be run in JavaScript? (JavaScript function names included) *)
adamc@765 74 val setJsFuncs : (ffi * string) list -> unit
adamc@765 75 val jsFunc : ffi -> string option
adamc@765 76
adamc@768 77 datatype pattern_kind = Exact | Prefix
adamc@768 78 datatype action = Allow | Deny
adamc@768 79 type rule = { action : action, kind : pattern_kind, pattern : string }
adamc@768 80
adamc@768 81 datatype path_kind = Any | Url | Table | Sequence | View | Relation | Cookie | Style
adamc@768 82 type rewrite = { pkind : path_kind, kind : pattern_kind, from : string, to : string }
adamc@768 83
adamc@768 84 (* Rules for rewriting URLs from canonical forms *)
adamc@768 85 val setRewriteRules : rewrite list -> unit
adamc@768 86 val rewrite : path_kind -> string -> string
adamc@768 87
adamc@769 88 (* Validating URLs and MIME types *)
adamc@769 89 val setUrlRules : rule list -> unit
adamc@770 90 val getUrlRules : unit -> rule list
adamc@769 91 val checkUrl : string -> bool
adamc@769 92
adamc@769 93 val setMimeRules : rule list -> unit
adamc@770 94 val getMimeRules : unit -> rule list
adamc@769 95 val checkMime : string -> bool
adamc@769 96
adamc@855 97 (* Web protocols that generated programs may speak *)
adamc@855 98 type protocol = {
adamc@1095 99 name : string, (* Call it this on the command line *)
adamc@1096 100 compile : string, (* Pass these `gcc -c' arguments *)
adamc@1095 101 linkStatic : string, (* Pass these static linker arguments *)
adamc@1095 102 linkDynamic : string,(* Pass these dynamic linker arguments *)
adamc@1164 103 persistent : bool, (* Multiple requests per process? *)
adamc@1164 104 code : unit -> Print.PD.pp_desc (* Extra code to include in C files *)
adamc@855 105 }
adamc@855 106 val addProtocol : protocol -> unit
adamc@856 107 val setProtocol : string -> unit
adamc@855 108 val currentProtocol : unit -> protocol
adamc@855 109
adamc@866 110 (* Different DBMSes *)
adamc@867 111 datatype sql_type =
adamc@867 112 Int
adamc@867 113 | Float
adamc@867 114 | String
adamc@1011 115 | Char
adamc@867 116 | Bool
adamc@867 117 | Time
adamc@867 118 | Blob
adamc@867 119 | Channel
adamc@867 120 | Client
adamc@867 121 | Nullable of sql_type
adamc@867 122
adamc@873 123 val p_sql_ctype : sql_type -> string
adamc@867 124 val isBlob : sql_type -> bool
adamc@870 125 val isNotNull : sql_type -> bool
adamc@867 126
adam@1293 127 datatype failure_mode = Error | None
adam@1293 128
adamc@866 129 type dbms = {
adamc@866 130 name : string,
adamc@866 131 (* Call it this on the command line *)
adamc@866 132 header : string,
adamc@866 133 (* Include this C header file *)
adamc@866 134 link : string,
adamc@866 135 (* Pass these linker arguments *)
adamc@873 136 p_sql_type : sql_type -> string,
adamc@870 137 init : {dbstring : string,
adamc@870 138 prepared : (string * int) list,
adamc@870 139 tables : (string * (string * sql_type) list) list,
adamc@872 140 views : (string * (string * sql_type) list) list,
adamc@870 141 sequences : string list} -> Print.PD.pp_desc,
adamc@874 142 (* Define uw_client_init(), uw_db_init(), uw_db_close(), uw_db_begin(), uw_db_commit(), and uw_db_rollback() *)
adamc@873 143 query : {loc : ErrorMsg.span, cols : sql_type list,
adamc@880 144 doCols : ({loc : ErrorMsg.span, wontLeakStrings : bool, col : int, typ : sql_type} -> Print.PD.pp_desc)
adamc@867 145 -> Print.PD.pp_desc}
adamc@867 146 -> Print.PD.pp_desc,
adamc@867 147 queryPrepared : {loc : ErrorMsg.span, id : int, query : string,
adamc@873 148 inputs : sql_type list, cols : sql_type list,
adamc@880 149 doCols : ({loc : ErrorMsg.span, wontLeakStrings : bool, col : int,
adamc@880 150 typ : sql_type} -> Print.PD.pp_desc)
adamc@879 151 -> Print.PD.pp_desc,
adamc@879 152 nested : bool}
adamc@868 153 -> Print.PD.pp_desc,
adam@1293 154 dml : ErrorMsg.span * failure_mode -> Print.PD.pp_desc,
adamc@868 155 dmlPrepared : {loc : ErrorMsg.span, id : int, dml : string,
adam@1293 156 inputs : sql_type list, mode : failure_mode} -> Print.PD.pp_desc,
adamc@878 157 nextval : {loc : ErrorMsg.span, seqE : Print.PD.pp_desc, seqName : string option} -> Print.PD.pp_desc,
adamc@874 158 nextvalPrepared : {loc : ErrorMsg.span, id : int, query : string} -> Print.PD.pp_desc,
adamc@1073 159 setval : {loc : ErrorMsg.span, seqE : Print.PD.pp_desc, count : Print.PD.pp_desc} -> Print.PD.pp_desc,
adamc@874 160 sqlifyString : string -> string,
adamc@874 161 p_cast : string * sql_type -> string,
adamc@874 162 p_blank : int * sql_type -> string (* Prepared statement input *),
adamc@877 163 supportsDeleteAs : bool,
adamc@886 164 supportsUpdateAs : bool,
adamc@877 165 createSequence : string -> string,
adamc@878 166 textKeysNeedLengths : bool,
adamc@879 167 supportsNextval : bool,
adamc@882 168 supportsNestedPrepared : bool,
adamc@890 169 sqlPrefix : string,
adamc@1014 170 supportsOctetLength : bool,
adamc@1014 171 trueString : string,
adamc@1196 172 falseString : string,
adamc@1196 173 onlyUnion : bool,
adamc@1196 174 nestedRelops : bool
adamc@866 175 }
adamc@857 176
adamc@866 177 val addDbms : dbms -> unit
adamc@866 178 val setDbms : string -> unit
adamc@866 179 val currentDbms : unit -> dbms
adamc@858 180
adamc@891 181 val setDbstring : string option -> unit
adamc@891 182 val getDbstring : unit -> string option
adamc@891 183
adamc@891 184 val setExe : string option -> unit
adamc@891 185 val getExe : unit -> string option
adamc@891 186
adamc@891 187 val setSql : string option -> unit
adamc@891 188 val getSql : unit -> string option
adamc@891 189
adamc@1016 190 val setCoreInline : int -> unit
adamc@1016 191 val getCoreInline : unit -> int
adamc@1016 192
adamc@1016 193 val setMonoInline : int -> unit
adamc@1016 194 val getMonoInline : unit -> int
adamc@1016 195
adamc@1095 196 val setStaticLinking : bool -> unit
adamc@1095 197 val getStaticLinking : unit -> bool
adamc@1095 198
adamc@1114 199 val setDeadlines : bool -> unit
adamc@1114 200 val getDeadlines : unit -> bool
adamc@1114 201
adamc@1164 202 val setSigFile : string option -> unit
adamc@1164 203 val getSigFile : unit -> string option
adamc@1164 204
adamc@1183 205 (* Which GET-able functions should be allowed to have side effects? *)
adamc@1183 206 val setSafeGets : string list -> unit
adamc@1183 207 val isSafeGet : string -> bool
adamc@1183 208
adam@1294 209 val setOnError : (string * string list * string) option -> unit
adam@1294 210 val getOnError : unit -> (string * string list * string) option
adam@1307 211
adam@1307 212 val addLimit : string * int -> unit
adam@1307 213 val limits : unit -> (string * int) list
adamc@764 214 end