Mercurial > urweb

annotate src/compiler.sig @ 1400:c57414e39321

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Updating documentation in preparation for a release
author Adam Chlipala <adam@chlipala.net>
date Sun, 16 Jan 2011 12:06:38 -0500
parents fd34210bc3e5
children 2f5fd248588d
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,
adamc@866 54 protocol : string option,
adamc@1164 55 dbms : string option,
adamc@1183 56 sigFile : string option,
adam@1294 57 safeGets : string list,
adam@1332 58 onError : (string * string list * string) option,
adam@1332 59 minHeap : int
adamc@270 60 }
adamc@1045 61 val compile : string -> bool
adamc@1045 62 val compiler : string -> unit
adamc@742 63 val compileC : {cname : string, oname : string, ename : string, libs : string,
adamc@1045 64 profile : bool, debug : bool, link : string list} -> bool
adamc@29 65
adamc@201 66 type ('src, 'dst) phase
adamc@201 67 type ('src, 'dst) transform
adamc@55 68
adamc@201 69 val transform : ('src, 'dst) phase -> string -> ('src, 'dst) transform
adamc@270 70 val o : ('b, 'c) transform * ('a, 'b) transform -> ('a, 'c) transform
adamc@1 71
adamc@346 72 val check : ('src, 'dst) transform -> 'src -> unit
adamc@201 73 val run : ('src, 'dst) transform -> 'src -> 'dst option
adamc@201 74 val runPrint : ('src, 'dst) transform -> 'src -> unit
adam@1362 75 val runPrintToFile : ('src, 'dst) transform -> 'src -> string -> unit
adamc@201 76 val time : ('src, 'dst) transform -> 'src -> unit
adamc@201 77 val timePrint : ('src, 'dst) transform -> 'src -> unit
adamc@56 78
adam@1362 79 val runPrintCoreFuncs : ('src, Core.file) transform -> 'src -> unit
adam@1362 80
adamc@244 81 val parseUr : (string, Source.file) phase
adamc@244 82 val parseUrs : (string, Source.sgn_item list) phase
adamc@270 83 val parseUrp : (string, job) phase
adamc@1082 84 val parseUrp' : (string, {Job : job, Libs : string list}) phase
adamc@201 85
adamc@201 86 val parse : (job, Source.file) phase
adamc@201 87 val elaborate : (Source.file, Elab.file) phase
adamc@448 88 val unnest : (Elab.file, Elab.file) phase
adamc@313 89 val termination : (Elab.file, Elab.file) phase
adamc@201 90 val explify : (Elab.file, Expl.file) phase
adamc@201 91 val corify : (Expl.file, Core.file) phase
adamc@454 92 val core_untangle : (Core.file, Core.file) phase
adamc@202 93 val shake : (Core.file, Core.file) phase
adamc@607 94 val rpcify : (Core.file, Core.file) phase
adamc@202 95 val tag : (Core.file, Core.file) phase
adamc@202 96 val reduce : (Core.file, Core.file) phase
adamc@315 97 val unpoly : (Core.file, Core.file) phase
adamc@1186 98 val especialize : (Core.file, Core.file) phase
adamc@202 99 val specialize : (Core.file, Core.file) phase
adamc@692 100 val marshalcheck : (Core.file, Core.file) phase
adamc@732 101 val effectize : (Core.file, Core.file) phase
adamc@1170 102 val css : (Core.file, Css.report) phase
adamc@202 103 val monoize : (Core.file, Mono.file) phase
adamc@202 104 val mono_opt : (Mono.file, Mono.file) phase
adamc@202 105 val untangle : (Mono.file, Mono.file) phase
adamc@202 106 val mono_reduce : (Mono.file, Mono.file) phase
adamc@202 107 val mono_shake : (Mono.file, Mono.file) phase
adamc@1200 108 val iflow : (Mono.file, Mono.file) phase
adamc@567 109 val jscomp : (Mono.file, Mono.file) phase
adamc@506 110 val fuse : (Mono.file, Mono.file) phase
adamc@377 111 val pathcheck : (Mono.file, Mono.file) phase
adamc@202 112 val cjrize : (Mono.file, Cjr.file) phase
adamc@643 113 val scriptcheck : (Cjr.file, Cjr.file) phase
adamc@282 114 val prepare : (Cjr.file, Cjr.file) phase
adamc@879 115 val checknest : (Cjr.file, Cjr.file) phase
adamc@274 116 val sqlify : (Mono.file, Cjr.file) phase
adamc@201 117
adamc@270 118 val toParseJob : (string, job) transform
adamc@1082 119 val toParseJob' : (string, {Job : job, Libs : string list}) transform
adamc@270 120 val toParse : (string, Source.file) transform
adamc@270 121 val toElaborate : (string, Elab.file) transform
adamc@448 122 val toUnnest : (string, Elab.file) transform
adamc@313 123 val toTermination : (string, Elab.file) transform
adamc@270 124 val toExplify : (string, Expl.file) transform
adamc@270 125 val toCorify : (string, Core.file) transform
adamc@454 126 val toCore_untangle : (string, Core.file) transform
adamc@270 127 val toShake1 : (string, Core.file) transform
adam@1362 128 val toEspecialize1' : (string, Core.file) transform
adam@1362 129 val toShake1' : (string, Core.file) transform
adamc@607 130 val toRpcify : (string, Core.file) transform
adamc@642 131 val toCore_untangle2 : (string, Core.file) transform
adamc@642 132 val toShake2 : (string, Core.file) transform
adamc@1062 133 val toEspecialize1 : (string, Core.file) transform
adamc@1062 134 val toCore_untangle3 : (string, Core.file) transform
adamc@1062 135 val toShake3 : (string, Core.file) transform
adamc@270 136 val toTag : (string, Core.file) transform
adamc@270 137 val toReduce : (string, Core.file) transform
adamc@1186 138 val toShakey : (string, Core.file) transform
adamc@1272 139 val toUnpoly : (string, Core.file) transform
adamc@1272 140 val toSpecialize : (string, Core.file) transform
adamc@1062 141 val toShake4 : (string, Core.file) transform
adamc@1272 142 val toEspecialize2 : (string, Core.file) transform
adamc@1272 143 val toShake4' : (string, Core.file) transform
adamc@1276 144 val toSpecialize2 : (string, Core.file) transform
adamc@1272 145 val toUnpoly2 : (string, Core.file) transform
adamc@1272 146 val toShake4'' : (string, Core.file) transform
adamc@1272 147 val toEspecialize3 : (string, Core.file) transform
adamc@898 148 val toReduce2 : (string, Core.file) transform
adamc@1062 149 val toShake5 : (string, Core.file) transform
adamc@692 150 val toMarshalcheck : (string, Core.file) transform
adamc@732 151 val toEffectize : (string, Core.file) transform
adamc@1170 152 val toCss : (string, Css.report) transform
adamc@270 153 val toMonoize : (string, Mono.file) transform
adamc@270 154 val toMono_opt1 : (string, Mono.file) transform
adamc@270 155 val toUntangle : (string, Mono.file) transform
adamc@270 156 val toMono_reduce : (string, Mono.file) transform
adamc@270 157 val toMono_shake : (string, Mono.file) transform
adamc@572 158 val toMono_opt2 : (string, Mono.file) transform
adamc@1200 159 val toIflow : (string, Mono.file) transform
adamc@567 160 val toJscomp : (string, Mono.file) transform
adamc@572 161 val toMono_opt3 : (string, Mono.file) transform
adamc@506 162 val toFuse : (string, Mono.file) transform
adamc@506 163 val toUntangle2 : (string, Mono.file) transform
adamc@601 164 val toMono_reduce2 : (string, Mono.file) transform
adamc@506 165 val toMono_shake2 : (string, Mono.file) transform
adamc@916 166 val toMono_opt4 : (string, Mono.file) transform
adamc@1017 167 val toMono_reduce3 : (string, Mono.file) transform
adamc@916 168 val toFuse2 : (string, Mono.file) transform
adamc@916 169 val toUntangle3 : (string, Mono.file) transform
adamc@916 170 val toMono_shake3 : (string, Mono.file) transform
adamc@377 171 val toPathcheck : (string, Mono.file) transform
adamc@270 172 val toCjrize : (string, Cjr.file) transform
adamc@643 173 val toScriptcheck : (string, Cjr.file) transform
adamc@282 174 val toPrepare : (string, Cjr.file) transform
adamc@879 175 val toChecknest : (string, Cjr.file) transform
adamc@274 176 val toSqlify : (string, Cjr.file) transform
adamc@1 177
adamc@1079 178 val debug : bool ref
adamc@1235 179 val doIflow : bool ref
adamc@1079 180
adamc@1089 181 val addPath : string * string -> unit
adamc@1090 182 val addModuleRoot : string * string -> unit
adamc@1089 183
adamc@1266 184 val moduleOf : string -> string
adamc@1266 185
adamc@1 186 end