annotate src/compiler.sig @ 2003:8e45bb2c9046

New release
author Adam Chlipala <adam@chlipala.net>
date Sat, 26 Apr 2014 09:42:35 -0400
parents 0652f295e0fa
children a9159911c3ba 606af2c9b828
rev   line source
adam@1677 1 (* Copyright (c) 2008-2012, 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,
adam@1725 43 linker : string option,
adamc@765 44 headers : string list,
adamc@766 45 scripts : string list,
adamc@765 46 clientToServer : Settings.ffi list,
adamc@765 47 effectful : Settings.ffi list,
adamc@1171 48 benignEffectful : Settings.ffi list,
adamc@765 49 clientOnly : Settings.ffi list,
adamc@765 50 serverOnly : Settings.ffi list,
adamc@768 51 jsFuncs : (Settings.ffi * string) list,
adamc@769 52 rewrites : Settings.rewrite list,
adamc@769 53 filterUrl : Settings.rule list,
adamc@866 54 filterMime : Settings.rule list,
adam@1465 55 filterRequest : Settings.rule list,
adam@1465 56 filterResponse : Settings.rule list,
adam@1799 57 filterEnv : Settings.rule list,
adamc@866 58 protocol : string option,
adamc@1164 59 dbms : string option,
adamc@1183 60 sigFile : string option,
adam@1294 61 safeGets : string list,
adam@1332 62 onError : (string * string list * string) option,
adam@1332 63 minHeap : int
adamc@270 64 }
adamc@1045 65 val compile : string -> bool
adamc@1045 66 val compiler : string -> unit
adamc@742 67 val compileC : {cname : string, oname : string, ename : string, libs : string,
adam@1725 68 profile : bool, debug : bool, linker : string option, link : string list} -> bool
adamc@29 69
adam@1540 70 val beforeC : (unit -> unit) ref
adam@1540 71 (* This function is called before beginning C compilation.
adam@1540 72 * The current use is for MLton to compact its heap here, to avoid hogging
adam@1540 73 * space after all the interesting ML code is done. *)
adam@1540 74
adamc@201 75 type ('src, 'dst) phase
adamc@201 76 type ('src, 'dst) transform
adamc@55 77
adamc@201 78 val transform : ('src, 'dst) phase -> string -> ('src, 'dst) transform
adamc@270 79 val o : ('b, 'c) transform * ('a, 'b) transform -> ('a, 'c) transform
adamc@1 80
adamc@346 81 val check : ('src, 'dst) transform -> 'src -> unit
adamc@201 82 val run : ('src, 'dst) transform -> 'src -> 'dst option
adamc@201 83 val runPrint : ('src, 'dst) transform -> 'src -> unit
adam@1362 84 val runPrintToFile : ('src, 'dst) transform -> 'src -> string -> unit
adamc@201 85 val time : ('src, 'dst) transform -> 'src -> unit
adamc@201 86 val timePrint : ('src, 'dst) transform -> 'src -> unit
adamc@56 87
adam@1362 88 val runPrintCoreFuncs : ('src, Core.file) transform -> 'src -> unit
adam@1362 89
adamc@244 90 val parseUr : (string, Source.file) phase
adamc@244 91 val parseUrs : (string, Source.sgn_item list) phase
adamc@270 92 val parseUrp : (string, job) phase
adamc@1082 93 val parseUrp' : (string, {Job : job, Libs : string list}) phase
adamc@201 94
adamc@201 95 val parse : (job, Source.file) phase
adamc@201 96 val elaborate : (Source.file, Elab.file) phase
adamc@448 97 val unnest : (Elab.file, Elab.file) phase
adamc@313 98 val termination : (Elab.file, Elab.file) phase
adamc@201 99 val explify : (Elab.file, Expl.file) phase
adamc@201 100 val corify : (Expl.file, Core.file) phase
adamc@454 101 val core_untangle : (Core.file, Core.file) phase
adamc@202 102 val shake : (Core.file, Core.file) phase
adamc@607 103 val rpcify : (Core.file, Core.file) phase
adamc@202 104 val tag : (Core.file, Core.file) phase
adamc@202 105 val reduce : (Core.file, Core.file) phase
adamc@315 106 val unpoly : (Core.file, Core.file) phase
adamc@1186 107 val especialize : (Core.file, Core.file) phase
adamc@202 108 val specialize : (Core.file, Core.file) phase
adamc@692 109 val marshalcheck : (Core.file, Core.file) phase
adamc@732 110 val effectize : (Core.file, Core.file) phase
adamc@1170 111 val css : (Core.file, Css.report) phase
adamc@202 112 val monoize : (Core.file, Mono.file) phase
adamc@202 113 val mono_opt : (Mono.file, Mono.file) phase
adamc@202 114 val untangle : (Mono.file, Mono.file) phase
adamc@202 115 val mono_reduce : (Mono.file, Mono.file) phase
adamc@202 116 val mono_shake : (Mono.file, Mono.file) phase
adamc@1200 117 val iflow : (Mono.file, Mono.file) phase
adam@1800 118 val namejs : (Mono.file, Mono.file) phase
adam@1845 119 val scriptcheck : (Mono.file, Mono.file) phase
adamc@567 120 val jscomp : (Mono.file, Mono.file) phase
adamc@506 121 val fuse : (Mono.file, Mono.file) phase
adamc@377 122 val pathcheck : (Mono.file, Mono.file) phase
adam@1595 123 val sidecheck : (Mono.file, Mono.file) phase
adam@1856 124 val sigcheck : (Mono.file, Mono.file) phase
adamc@202 125 val cjrize : (Mono.file, Cjr.file) phase
adamc@282 126 val prepare : (Cjr.file, Cjr.file) phase
adamc@879 127 val checknest : (Cjr.file, Cjr.file) phase
adamc@274 128 val sqlify : (Mono.file, Cjr.file) phase
adamc@201 129
adamc@270 130 val toParseJob : (string, job) transform
adamc@1082 131 val toParseJob' : (string, {Job : job, Libs : string list}) transform
adamc@270 132 val toParse : (string, Source.file) transform
adamc@270 133 val toElaborate : (string, Elab.file) transform
adamc@448 134 val toUnnest : (string, Elab.file) transform
adamc@313 135 val toTermination : (string, Elab.file) transform
adamc@270 136 val toExplify : (string, Expl.file) transform
adamc@270 137 val toCorify : (string, Core.file) transform
adamc@454 138 val toCore_untangle : (string, Core.file) transform
adamc@270 139 val toShake1 : (string, Core.file) transform
adam@1362 140 val toEspecialize1' : (string, Core.file) transform
adam@1362 141 val toShake1' : (string, Core.file) transform
adamc@607 142 val toRpcify : (string, Core.file) transform
adamc@642 143 val toCore_untangle2 : (string, Core.file) transform
adamc@642 144 val toShake2 : (string, Core.file) transform
adamc@1062 145 val toEspecialize1 : (string, Core.file) transform
adamc@1062 146 val toCore_untangle3 : (string, Core.file) transform
adamc@1062 147 val toShake3 : (string, Core.file) transform
adamc@270 148 val toTag : (string, Core.file) transform
adamc@270 149 val toReduce : (string, Core.file) transform
adamc@1186 150 val toShakey : (string, Core.file) transform
adamc@1272 151 val toUnpoly : (string, Core.file) transform
adamc@1272 152 val toSpecialize : (string, Core.file) transform
adamc@1062 153 val toShake4 : (string, Core.file) transform
adamc@1272 154 val toEspecialize2 : (string, Core.file) transform
adamc@1272 155 val toShake4' : (string, Core.file) transform
adamc@1276 156 val toSpecialize2 : (string, Core.file) transform
adamc@1272 157 val toUnpoly2 : (string, Core.file) transform
adamc@1272 158 val toShake4'' : (string, Core.file) transform
adamc@1272 159 val toEspecialize3 : (string, Core.file) transform
adamc@898 160 val toReduce2 : (string, Core.file) transform
adamc@1062 161 val toShake5 : (string, Core.file) transform
adamc@692 162 val toMarshalcheck : (string, Core.file) transform
adamc@732 163 val toEffectize : (string, Core.file) transform
adamc@1170 164 val toCss : (string, Css.report) transform
adamc@270 165 val toMonoize : (string, Mono.file) transform
adamc@270 166 val toMono_opt1 : (string, Mono.file) transform
adamc@270 167 val toUntangle : (string, Mono.file) transform
adamc@270 168 val toMono_reduce : (string, Mono.file) transform
adamc@270 169 val toMono_shake : (string, Mono.file) transform
adamc@572 170 val toMono_opt2 : (string, Mono.file) transform
adamc@1200 171 val toIflow : (string, Mono.file) transform
adam@1800 172 val toNamejs : (string, Mono.file) transform
adam@1800 173 val toNamejs_untangle : (string, Mono.file) transform
adam@1845 174 val toScriptcheck : (string, Mono.file) transform
adamc@567 175 val toJscomp : (string, Mono.file) transform
adamc@572 176 val toMono_opt3 : (string, Mono.file) transform
adamc@506 177 val toFuse : (string, Mono.file) transform
adamc@506 178 val toUntangle2 : (string, Mono.file) transform
adamc@601 179 val toMono_reduce2 : (string, Mono.file) transform
adamc@506 180 val toMono_shake2 : (string, Mono.file) transform
adamc@916 181 val toMono_opt4 : (string, Mono.file) transform
adamc@1017 182 val toMono_reduce3 : (string, Mono.file) transform
adamc@916 183 val toFuse2 : (string, Mono.file) transform
adamc@916 184 val toUntangle3 : (string, Mono.file) transform
adamc@916 185 val toMono_shake3 : (string, Mono.file) transform
adamc@377 186 val toPathcheck : (string, Mono.file) transform
adam@1595 187 val toSidecheck : (string, Mono.file) transform
adam@1856 188 val toSigcheck : (string, Mono.file) transform
adamc@270 189 val toCjrize : (string, Cjr.file) transform
adamc@282 190 val toPrepare : (string, Cjr.file) transform
adamc@879 191 val toChecknest : (string, Cjr.file) transform
adamc@274 192 val toSqlify : (string, Cjr.file) transform
adamc@1 193
adamc@1079 194 val debug : bool ref
adam@1677 195 val dumpSource : bool ref
ezyang@1739 196 val enableBoot : unit -> unit
adam@1677 197
adamc@1235 198 val doIflow : bool ref
adamc@1079 199
adamc@1089 200 val addPath : string * string -> unit
adamc@1090 201 val addModuleRoot : string * string -> unit
adamc@1089 202
adamc@1266 203 val moduleOf : string -> string
adamc@1266 204
adam@1961 205 val setStop : string -> unit
adam@1961 206 (* Stop compilation after this phase. *)
adam@1961 207
adamc@1 208 end