Mercurial > urweb

annotate src/compiler.sig @ 1509:dbb461e55eda

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Document tutorial features
author Adam Chlipala <adam@chlipala.net>
date Sun, 17 Jul 2011 13:48:00 -0400
parents 2f5fd248588d
children 659a2f71f5e5
rev   line source
adamc@1183 1 (* Copyright (c) 2008-2010, Adam Chlipala
adamc@1 2 * All rights reserved.
adamc@1 3 *
adamc@1 4 * Redistribution and use in source and binary forms, with or without
adamc@1 5 * modification, are permitted provided that the following conditions are met:
adamc@1 6 *
adamc@1 7 * - Redistributions of source code must retain the above copyright notice,
adamc@1 8 * this list of conditions and the following disclaimer.
adamc@1 9 * - Redistributions in binary form must reproduce the above copyright notice,
adamc@1 10 * this list of conditions and the following disclaimer in the documentation
adamc@1 11 * and/or other materials provided with the distribution.
adamc@1 12 * - The names of contributors may not be used to endorse or promote products
adamc@1 13 * derived from this software without specific prior written permission.
adamc@1 14 *
adamc@1 15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
adamc@1 16 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
adamc@1 17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
adamc@1 18 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
adamc@1 19 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
adamc@1 20 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
adamc@1 21 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
adamc@1 22 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
adamc@1 23 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
adamc@1 24 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
adamc@1 25 * POSSIBILITY OF SUCH DAMAGE.
adamc@1 26 *)
adamc@1 27
adamc@244 28 (* Ur/Web main compiler interface *)
adamc@1 29
adamc@1 30 signature COMPILER = sig
adamc@1 31
adamc@270 32 type job = {
adamc@385 33 prefix : string,
adamc@270 34 database : string option,
adamc@274 35 sources : string list,
adamc@274 36 exe : string,
adamc@274 37 sql : string option,
adamc@502 38 debug : bool,
adamc@673 39 profile : bool,
adamc@764 40 timeout : int,
adamc@764 41 ffi : string list,
adamc@764 42 link : string list,
adamc@765 43 headers : string list,
adamc@766 44 scripts : string list,
adamc@765 45 clientToServer : Settings.ffi list,
adamc@765 46 effectful : Settings.ffi list,
adamc@1171 47 benignEffectful : Settings.ffi list,
adamc@765 48 clientOnly : Settings.ffi list,
adamc@765 49 serverOnly : Settings.ffi list,
adamc@768 50 jsFuncs : (Settings.ffi * string) list,
adamc@769 51 rewrites : Settings.rewrite list,
adamc@769 52 filterUrl : Settings.rule list,
adamc@866 53 filterMime : Settings.rule list,
adam@1465 54 filterRequest : Settings.rule list,
adam@1465 55 filterResponse : Settings.rule list,
adamc@866 56 protocol : string option,
adamc@1164 57 dbms : string option,
adamc@1183 58 sigFile : string option,
adam@1294 59 safeGets : string list,
adam@1332 60 onError : (string * string list * string) option,
adam@1332 61 minHeap : int
adamc@270 62 }
adamc@1045 63 val compile : string -> bool
adamc@1045 64 val compiler : string -> unit
adamc@742 65 val compileC : {cname : string, oname : string, ename : string, libs : string,
adamc@1045 66 profile : bool, debug : bool, link : string list} -> bool
adamc@29 67
adamc@201 68 type ('src, 'dst) phase
adamc@201 69 type ('src, 'dst) transform
adamc@55 70
adamc@201 71 val transform : ('src, 'dst) phase -> string -> ('src, 'dst) transform
adamc@270 72 val o : ('b, 'c) transform * ('a, 'b) transform -> ('a, 'c) transform
adamc@1 73
adamc@346 74 val check : ('src, 'dst) transform -> 'src -> unit
adamc@201 75 val run : ('src, 'dst) transform -> 'src -> 'dst option
adamc@201 76 val runPrint : ('src, 'dst) transform -> 'src -> unit
adam@1362 77 val runPrintToFile : ('src, 'dst) transform -> 'src -> string -> unit
adamc@201 78 val time : ('src, 'dst) transform -> 'src -> unit
adamc@201 79 val timePrint : ('src, 'dst) transform -> 'src -> unit
adamc@56 80
adam@1362 81 val runPrintCoreFuncs : ('src, Core.file) transform -> 'src -> unit
adam@1362 82
adamc@244 83 val parseUr : (string, Source.file) phase
adamc@244 84 val parseUrs : (string, Source.sgn_item list) phase
adamc@270 85 val parseUrp : (string, job) phase
adamc@1082 86 val parseUrp' : (string, {Job : job, Libs : string list}) phase
adamc@201 87
adamc@201 88 val parse : (job, Source.file) phase
adamc@201 89 val elaborate : (Source.file, Elab.file) phase
adamc@448 90 val unnest : (Elab.file, Elab.file) phase
adamc@313 91 val termination : (Elab.file, Elab.file) phase
adamc@201 92 val explify : (Elab.file, Expl.file) phase
adamc@201 93 val corify : (Expl.file, Core.file) phase
adamc@454 94 val core_untangle : (Core.file, Core.file) phase
adamc@202 95 val shake : (Core.file, Core.file) phase
adamc@607 96 val rpcify : (Core.file, Core.file) phase
adamc@202 97 val tag : (Core.file, Core.file) phase
adamc@202 98 val reduce : (Core.file, Core.file) phase
adamc@315 99 val unpoly : (Core.file, Core.file) phase
adamc@1186 100 val especialize : (Core.file, Core.file) phase
adamc@202 101 val specialize : (Core.file, Core.file) phase
adamc@692 102 val marshalcheck : (Core.file, Core.file) phase
adamc@732 103 val effectize : (Core.file, Core.file) phase
adamc@1170 104 val css : (Core.file, Css.report) phase
adamc@202 105 val monoize : (Core.file, Mono.file) phase
adamc@202 106 val mono_opt : (Mono.file, Mono.file) phase
adamc@202 107 val untangle : (Mono.file, Mono.file) phase
adamc@202 108 val mono_reduce : (Mono.file, Mono.file) phase
adamc@202 109 val mono_shake : (Mono.file, Mono.file) phase
adamc@1200 110 val iflow : (Mono.file, Mono.file) phase
adamc@567 111 val jscomp : (Mono.file, Mono.file) phase
adamc@506 112 val fuse : (Mono.file, Mono.file) phase
adamc@377 113 val pathcheck : (Mono.file, Mono.file) phase
adamc@202 114 val cjrize : (Mono.file, Cjr.file) phase
adamc@643 115 val scriptcheck : (Cjr.file, Cjr.file) phase
adamc@282 116 val prepare : (Cjr.file, Cjr.file) phase
adamc@879 117 val checknest : (Cjr.file, Cjr.file) phase
adamc@274 118 val sqlify : (Mono.file, Cjr.file) phase
adamc@201 119
adamc@270 120 val toParseJob : (string, job) transform
adamc@1082 121 val toParseJob' : (string, {Job : job, Libs : string list}) transform
adamc@270 122 val toParse : (string, Source.file) transform
adamc@270 123 val toElaborate : (string, Elab.file) transform
adamc@448 124 val toUnnest : (string, Elab.file) transform
adamc@313 125 val toTermination : (string, Elab.file) transform
adamc@270 126 val toExplify : (string, Expl.file) transform
adamc@270 127 val toCorify : (string, Core.file) transform
adamc@454 128 val toCore_untangle : (string, Core.file) transform
adamc@270 129 val toShake1 : (string, Core.file) transform
adam@1362 130 val toEspecialize1' : (string, Core.file) transform
adam@1362 131 val toShake1' : (string, Core.file) transform
adamc@607 132 val toRpcify : (string, Core.file) transform
adamc@642 133 val toCore_untangle2 : (string, Core.file) transform
adamc@642 134 val toShake2 : (string, Core.file) transform
adamc@1062 135 val toEspecialize1 : (string, Core.file) transform
adamc@1062 136 val toCore_untangle3 : (string, Core.file) transform
adamc@1062 137 val toShake3 : (string, Core.file) transform
adamc@270 138 val toTag : (string, Core.file) transform
adamc@270 139 val toReduce : (string, Core.file) transform
adamc@1186 140 val toShakey : (string, Core.file) transform
adamc@1272 141 val toUnpoly : (string, Core.file) transform
adamc@1272 142 val toSpecialize : (string, Core.file) transform
adamc@1062 143 val toShake4 : (string, Core.file) transform
adamc@1272 144 val toEspecialize2 : (string, Core.file) transform
adamc@1272 145 val toShake4' : (string, Core.file) transform
adamc@1276 146 val toSpecialize2 : (string, Core.file) transform
adamc@1272 147 val toUnpoly2 : (string, Core.file) transform
adamc@1272 148 val toShake4'' : (string, Core.file) transform
adamc@1272 149 val toEspecialize3 : (string, Core.file) transform
adamc@898 150 val toReduce2 : (string, Core.file) transform
adamc@1062 151 val toShake5 : (string, Core.file) transform
adamc@692 152 val toMarshalcheck : (string, Core.file) transform
adamc@732 153 val toEffectize : (string, Core.file) transform
adamc@1170 154 val toCss : (string, Css.report) transform
adamc@270 155 val toMonoize : (string, Mono.file) transform
adamc@270 156 val toMono_opt1 : (string, Mono.file) transform
adamc@270 157 val toUntangle : (string, Mono.file) transform
adamc@270 158 val toMono_reduce : (string, Mono.file) transform
adamc@270 159 val toMono_shake : (string, Mono.file) transform
adamc@572 160 val toMono_opt2 : (string, Mono.file) transform
adamc@1200 161 val toIflow : (string, Mono.file) transform
adamc@567 162 val toJscomp : (string, Mono.file) transform
adamc@572 163 val toMono_opt3 : (string, Mono.file) transform
adamc@506 164 val toFuse : (string, Mono.file) transform
adamc@506 165 val toUntangle2 : (string, Mono.file) transform
adamc@601 166 val toMono_reduce2 : (string, Mono.file) transform
adamc@506 167 val toMono_shake2 : (string, Mono.file) transform
adamc@916 168 val toMono_opt4 : (string, Mono.file) transform
adamc@1017 169 val toMono_reduce3 : (string, Mono.file) transform
adamc@916 170 val toFuse2 : (string, Mono.file) transform
adamc@916 171 val toUntangle3 : (string, Mono.file) transform
adamc@916 172 val toMono_shake3 : (string, Mono.file) transform
adamc@377 173 val toPathcheck : (string, Mono.file) transform
adamc@270 174 val toCjrize : (string, Cjr.file) transform
adamc@643 175 val toScriptcheck : (string, Cjr.file) transform
adamc@282 176 val toPrepare : (string, Cjr.file) transform
adamc@879 177 val toChecknest : (string, Cjr.file) transform
adamc@274 178 val toSqlify : (string, Cjr.file) transform
adamc@1 179
adamc@1079 180 val debug : bool ref
adamc@1235 181 val doIflow : bool ref
adamc@1079 182
adamc@1089 183 val addPath : string * string -> unit
adamc@1090 184 val addModuleRoot : string * string -> unit
adamc@1089 185
adamc@1266 186 val moduleOf : string -> string
adamc@1266 187
adamc@1 188 end