Mercurial > urweb

annotate src/settings.sig @ 2307:6ae9a2784a45

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Return to working version mode
author Adam Chlipala <adam@chlipala.net>
date Sun, 20 Dec 2015 14:39:50 -0500
parents 6fb9232ade99
children
rev   line source
adam@1848 1 (* Copyright (c) 2008-2011, 2013, 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
adam@1682 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
adam@1682 29
adam@2192 30 (* Call this when compiling a new project, e.g. with the Ur/Web daemon or from the SML/NJ REPL.
adam@2192 31 * Some settings stay, but most are reset, especially files cached for the app to serve. *)
adam@2192 32 val reset : unit -> unit
adam@2192 33
ezyang@1739 34 (* XXX these should be unit -> string too *)
ezyang@1739 35 val configBin : string ref
ezyang@1739 36 val configLib : string ref
ezyang@1739 37 val configSrcLib : string ref
ezyang@1739 38 val configInclude : string ref
ezyang@1739 39 val configSitelisp : string ref
ezyang@1739 40
ezyang@1739 41 val libUr : unit -> string
ezyang@1739 42 val libC : unit -> string
ezyang@1739 43 val libJs : unit -> string
ezyang@1739 44
adamc@866 45 val setDebug : bool -> unit
adamc@866 46 val getDebug : unit -> bool
adam@1682 47
ezyang@1739 48 val libFile : string -> string
adamc@866 49 val clibFile : string -> string
adamc@866 50
adamc@765 51 (* How do all application URLs begin? *)
adamc@764 52 val setUrlPrefix : string -> unit
adamc@764 53 val getUrlPrefix : unit -> string
adam@1370 54 val getUrlPrePrefix : unit -> string
adam@1637 55 val getUrlPrefixFull : unit -> string
adam@1637 56 (* The full prefix is the value that was set explicitly, while the "pre"
adam@1637 57 * prefix gets the protocol/host/port part and the unqualified prefix gets
adam@1637 58 * the URI. *)
adamc@764 59
adamc@765 60 (* How many seconds should the server wait before assuming a Comet client has left? *)
adamc@764 61 val setTimeout : int -> unit
adamc@764 62 val getTimeout : unit -> int
adamc@764 63
adamc@765 64 (* Which C header files are needed? *)
adamc@764 65 val setHeaders : string list -> unit
adamc@764 66 val getHeaders : unit -> string list
adamc@764 67
adamc@766 68 (* Which extra JavaScript URLs should be included? *)
adamc@766 69 val setScripts : string list -> unit
adamc@766 70 val getScripts : unit -> string list
adamc@766 71
adamc@765 72 type ffi = string * string
adamc@765 73
adamc@765 74 (* Which FFI types may be sent from clients to servers? *)
adamc@765 75 val setClientToServer : ffi list -> unit
adamc@765 76 val mayClientToServer : ffi -> bool
adamc@765 77
adamc@765 78 (* Which FFI functions have side effects? *)
adamc@765 79 val setEffectful : ffi list -> unit
adam@1878 80 val addEffectful : ffi -> unit
adamc@765 81 val isEffectful : ffi -> bool
adamc@765 82
adamc@1171 83 (* Which FFI functions should not have their calls removed or reordered, but cause no lasting effects? *)
adamc@1171 84 val setBenignEffectful : ffi list -> unit
adam@2010 85 val addBenignEffectful : ffi -> unit
adamc@1171 86 val isBenignEffectful : ffi -> bool
adamc@1171 87
adamc@765 88 (* Which FFI functions may only be run in clients? *)
adamc@765 89 val setClientOnly : ffi list -> unit
adam@2010 90 val addClientOnly : ffi -> unit
adamc@765 91 val isClientOnly : ffi -> bool
adamc@765 92
adamc@765 93 (* Which FFI functions may only be run on servers? *)
adamc@765 94 val setServerOnly : ffi list -> unit
adam@2010 95 val addServerOnly : ffi -> unit
adamc@765 96 val isServerOnly : ffi -> bool
adamc@765 97
adamc@765 98 (* Which FFI functions may be run in JavaScript? (JavaScript function names included) *)
adamc@765 99 val setJsFuncs : (ffi * string) list -> unit
adam@2010 100 val addJsFunc : ffi * string -> unit
adamc@765 101 val jsFunc : ffi -> string option
adam@1433 102 val allJsFuncs : unit -> (ffi * string) list
adamc@765 103
adamc@768 104 datatype pattern_kind = Exact | Prefix
adamc@768 105 datatype action = Allow | Deny
adamc@768 106 type rule = { action : action, kind : pattern_kind, pattern : string }
adamc@768 107
adamc@768 108 datatype path_kind = Any | Url | Table | Sequence | View | Relation | Cookie | Style
adam@1752 109 type rewrite = { pkind : path_kind, kind : pattern_kind, from : string, to : string, hyphenate : bool }
adamc@768 110
adamc@768 111 (* Rules for rewriting URLs from canonical forms *)
adamc@768 112 val setRewriteRules : rewrite list -> unit
adamc@768 113 val rewrite : path_kind -> string -> string
adamc@768 114
adamc@769 115 (* Validating URLs and MIME types *)
adamc@769 116 val setUrlRules : rule list -> unit
adamc@770 117 val getUrlRules : unit -> rule list
adamc@769 118 val checkUrl : string -> bool
adamc@769 119
adamc@769 120 val setMimeRules : rule list -> unit
adamc@770 121 val getMimeRules : unit -> rule list
adamc@769 122 val checkMime : string -> bool
adamc@769 123
adam@1465 124 val setRequestHeaderRules : rule list -> unit
adam@1465 125 val getRequestHeaderRules : unit -> rule list
adam@1465 126 val checkRequestHeader : string -> bool
adam@1465 127
adam@1465 128 val setResponseHeaderRules : rule list -> unit
adam@1465 129 val getResponseHeaderRules : unit -> rule list
adam@1465 130 val checkResponseHeader : string -> bool
adam@1465 131
adam@1799 132 val setEnvVarRules : rule list -> unit
adam@1799 133 val getEnvVarRules : unit -> rule list
adam@1799 134 val checkEnvVar : string -> bool
adam@1799 135
adamc@855 136 (* Web protocols that generated programs may speak *)
adamc@855 137 type protocol = {
adamc@1095 138 name : string, (* Call it this on the command line *)
adamc@1096 139 compile : string, (* Pass these `gcc -c' arguments *)
adamc@1095 140 linkStatic : string, (* Pass these static linker arguments *)
adamc@1095 141 linkDynamic : string,(* Pass these dynamic linker arguments *)
adamc@1164 142 persistent : bool, (* Multiple requests per process? *)
adamc@1164 143 code : unit -> Print.PD.pp_desc (* Extra code to include in C files *)
adamc@855 144 }
adamc@855 145 val addProtocol : protocol -> unit
adamc@856 146 val setProtocol : string -> unit
adamc@855 147 val currentProtocol : unit -> protocol
adamc@855 148
adamc@866 149 (* Different DBMSes *)
adamc@867 150 datatype sql_type =
adamc@867 151 Int
adamc@867 152 | Float
adamc@867 153 | String
adamc@1011 154 | Char
adamc@867 155 | Bool
adamc@867 156 | Time
adamc@867 157 | Blob
adamc@867 158 | Channel
adamc@867 159 | Client
adamc@867 160 | Nullable of sql_type
adamc@867 161
adamc@873 162 val p_sql_ctype : sql_type -> string
adamc@867 163 val isBlob : sql_type -> bool
adamc@870 164 val isNotNull : sql_type -> bool
adamc@867 165
adam@1293 166 datatype failure_mode = Error | None
adam@1293 167
adamc@866 168 type dbms = {
adamc@866 169 name : string,
adamc@866 170 (* Call it this on the command line *)
adam@1682 171 randomFunction : string,
adam@1682 172 (* DBMS's name for random number-generating function *)
adamc@866 173 header : string,
adamc@866 174 (* Include this C header file *)
adamc@866 175 link : string,
adamc@866 176 (* Pass these linker arguments *)
adamc@873 177 p_sql_type : sql_type -> string,
adamc@870 178 init : {dbstring : string,
adamc@870 179 prepared : (string * int) list,
adamc@870 180 tables : (string * (string * sql_type) list) list,
adamc@872 181 views : (string * (string * sql_type) list) list,
adamc@870 182 sequences : string list} -> Print.PD.pp_desc,
adamc@874 183 (* Define uw_client_init(), uw_db_init(), uw_db_close(), uw_db_begin(), uw_db_commit(), and uw_db_rollback() *)
adamc@873 184 query : {loc : ErrorMsg.span, cols : sql_type list,
adamc@880 185 doCols : ({loc : ErrorMsg.span, wontLeakStrings : bool, col : int, typ : sql_type} -> Print.PD.pp_desc)
adamc@867 186 -> Print.PD.pp_desc}
adamc@867 187 -> Print.PD.pp_desc,
adamc@867 188 queryPrepared : {loc : ErrorMsg.span, id : int, query : string,
adamc@873 189 inputs : sql_type list, cols : sql_type list,
adamc@880 190 doCols : ({loc : ErrorMsg.span, wontLeakStrings : bool, col : int,
adamc@880 191 typ : sql_type} -> Print.PD.pp_desc)
adamc@879 192 -> Print.PD.pp_desc,
adamc@879 193 nested : bool}
adamc@868 194 -> Print.PD.pp_desc,
adam@1293 195 dml : ErrorMsg.span * failure_mode -> Print.PD.pp_desc,
adamc@868 196 dmlPrepared : {loc : ErrorMsg.span, id : int, dml : string,
adam@1293 197 inputs : sql_type list, mode : failure_mode} -> Print.PD.pp_desc,
adamc@878 198 nextval : {loc : ErrorMsg.span, seqE : Print.PD.pp_desc, seqName : string option} -> Print.PD.pp_desc,
adamc@874 199 nextvalPrepared : {loc : ErrorMsg.span, id : int, query : string} -> Print.PD.pp_desc,
adamc@1073 200 setval : {loc : ErrorMsg.span, seqE : Print.PD.pp_desc, count : Print.PD.pp_desc} -> Print.PD.pp_desc,
adamc@874 201 sqlifyString : string -> string,
adamc@874 202 p_cast : string * sql_type -> string,
adamc@874 203 p_blank : int * sql_type -> string (* Prepared statement input *),
adamc@877 204 supportsDeleteAs : bool,
adamc@886 205 supportsUpdateAs : bool,
adamc@877 206 createSequence : string -> string,
adamc@878 207 textKeysNeedLengths : bool,
adamc@879 208 supportsNextval : bool,
adamc@882 209 supportsNestedPrepared : bool,
adamc@890 210 sqlPrefix : string,
adamc@1014 211 supportsOctetLength : bool,
adamc@1014 212 trueString : string,
adamc@1196 213 falseString : string,
adamc@1196 214 onlyUnion : bool,
adam@1777 215 nestedRelops : bool,
adam@1777 216 windowFunctions : bool
adamc@866 217 }
adamc@857 218
adamc@866 219 val addDbms : dbms -> unit
adamc@866 220 val setDbms : string -> unit
adamc@866 221 val currentDbms : unit -> dbms
adamc@858 222
adamc@891 223 val setDbstring : string option -> unit
adamc@891 224 val getDbstring : unit -> string option
adamc@891 225
adamc@891 226 val setExe : string option -> unit
adamc@891 227 val getExe : unit -> string option
adamc@891 228
adamc@891 229 val setSql : string option -> unit
adamc@891 230 val getSql : unit -> string option
adamc@891 231
adamc@1016 232 val setCoreInline : int -> unit
adamc@1016 233 val getCoreInline : unit -> int
adamc@1016 234
adamc@1016 235 val setMonoInline : int -> unit
adamc@1016 236 val getMonoInline : unit -> int
adamc@1016 237
adamc@1095 238 val setStaticLinking : bool -> unit
adamc@1095 239 val getStaticLinking : unit -> bool
adamc@1095 240
adamc@1114 241 val setDeadlines : bool -> unit
adamc@1114 242 val getDeadlines : unit -> bool
adamc@1114 243
adamc@1164 244 val setSigFile : string option -> unit
adamc@1164 245 val getSigFile : unit -> string option
adamc@1164 246
adamc@1183 247 (* Which GET-able functions should be allowed to have side effects? *)
adamc@1183 248 val setSafeGets : string list -> unit
adamc@1183 249 val isSafeGet : string -> bool
adamc@1183 250
adam@1294 251 val setOnError : (string * string list * string) option -> unit
adam@1294 252 val getOnError : unit -> (string * string list * string) option
adam@1307 253
adam@1307 254 val addLimit : string * int -> unit
adam@1307 255 val limits : unit -> (string * int) list
adam@1332 256
adam@1332 257 val setMinHeap : int -> unit
adam@1332 258 val getMinHeap : unit -> int
adam@1393 259
adam@1393 260 val addAlwaysInline : string -> unit
adam@1393 261 val checkAlwaysInline : string -> bool
adam@1478 262
adam@1966 263 val addNeverInline : string -> unit
adam@1966 264 val checkNeverInline : string -> bool
adam@1966 265
adam@1478 266 val addNoXsrfProtection : string -> unit
adam@1478 267 val checkNoXsrfProtection : string -> bool
adam@1629 268
adam@1629 269 val setTimeFormat : string -> unit
adam@1629 270 val getTimeFormat : unit -> string
grrwlf@1871 271
adam@1953 272 val getCCompiler : unit -> string
adam@1953 273 val setCCompiler : string -> unit
adam@1953 274
adam@1953 275 val setMangleSql : bool -> unit
adam@1953 276 val mangleSql : string -> string
adam@1953 277 val mangleSqlCatalog : string -> string
adam@1953 278 val mangleSqlTable : string -> string
adam@1956 279
adam@1956 280 val setIsHtml5 : bool -> unit
adam@1956 281 val getIsHtml5 : unit -> bool
adam@2010 282
adam@2010 283 val setLessSafeFfi : bool -> unit
adam@2010 284 val getLessSafeFfi : unit -> bool
adam@2046 285
ziv@2213 286 val setSqlcache : bool -> unit
ziv@2213 287 val getSqlcache : unit -> bool
ziv@2213 288
adam@2046 289 val setFilePath : string -> unit
adam@2046 290 (* Sets the directory where we look for files being added below. *)
adam@2046 291
adam@2046 292 val addFile : {Uri : string, LoadFromFilename : string} -> unit
adam@2046 293 val listFiles : unit -> {Uri : string, ContentType : string option, LastModified : Time.time, Bytes : Word8Vector.vector} list
adam@2197 294
adam@2197 295 val addJsFile : string (* filename *) -> unit
adam@2197 296 val listJsFiles : unit -> {Filename : string, Content : string} list
adamc@764 297 end