annotate src/compiler.sig @ 1579:e1f4ac9ca34b

Note a parsing restriction in the manual
author Adam Chlipala <adam@chlipala.net>
date Fri, 21 Oct 2011 08:36:10 -0400
parents 659a2f71f5e5
children 154cfe2eb366
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
adam@1540 68 val beforeC : (unit -> unit) ref
adam@1540 69 (* This function is called before beginning C compilation.
adam@1540 70 * The current use is for MLton to compact its heap here, to avoid hogging
adam@1540 71 * space after all the interesting ML code is done. *)
adam@1540 72
adamc@201 73 type ('src, 'dst) phase
adamc@201 74 type ('src, 'dst) transform
adamc@55 75
adamc@201 76 val transform : ('src, 'dst) phase -> string -> ('src, 'dst) transform
adamc@270 77 val o : ('b, 'c) transform * ('a, 'b) transform -> ('a, 'c) transform
adamc@1 78
adamc@346 79 val check : ('src, 'dst) transform -> 'src -> unit
adamc@201 80 val run : ('src, 'dst) transform -> 'src -> 'dst option
adamc@201 81 val runPrint : ('src, 'dst) transform -> 'src -> unit
adam@1362 82 val runPrintToFile : ('src, 'dst) transform -> 'src -> string -> unit
adamc@201 83 val time : ('src, 'dst) transform -> 'src -> unit
adamc@201 84 val timePrint : ('src, 'dst) transform -> 'src -> unit
adamc@56 85
adam@1362 86 val runPrintCoreFuncs : ('src, Core.file) transform -> 'src -> unit
adam@1362 87
adamc@244 88 val parseUr : (string, Source.file) phase
adamc@244 89 val parseUrs : (string, Source.sgn_item list) phase
adamc@270 90 val parseUrp : (string, job) phase
adamc@1082 91 val parseUrp' : (string, {Job : job, Libs : string list}) phase
adamc@201 92
adamc@201 93 val parse : (job, Source.file) phase
adamc@201 94 val elaborate : (Source.file, Elab.file) phase
adamc@448 95 val unnest : (Elab.file, Elab.file) phase
adamc@313 96 val termination : (Elab.file, Elab.file) phase
adamc@201 97 val explify : (Elab.file, Expl.file) phase
adamc@201 98 val corify : (Expl.file, Core.file) phase
adamc@454 99 val core_untangle : (Core.file, Core.file) phase
adamc@202 100 val shake : (Core.file, Core.file) phase
adamc@607 101 val rpcify : (Core.file, Core.file) phase
adamc@202 102 val tag : (Core.file, Core.file) phase
adamc@202 103 val reduce : (Core.file, Core.file) phase
adamc@315 104 val unpoly : (Core.file, Core.file) phase
adamc@1186 105 val especialize : (Core.file, Core.file) phase
adamc@202 106 val specialize : (Core.file, Core.file) phase
adamc@692 107 val marshalcheck : (Core.file, Core.file) phase
adamc@732 108 val effectize : (Core.file, Core.file) phase
adamc@1170 109 val css : (Core.file, Css.report) phase
adamc@202 110 val monoize : (Core.file, Mono.file) phase
adamc@202 111 val mono_opt : (Mono.file, Mono.file) phase
adamc@202 112 val untangle : (Mono.file, Mono.file) phase
adamc@202 113 val mono_reduce : (Mono.file, Mono.file) phase
adamc@202 114 val mono_shake : (Mono.file, Mono.file) phase
adamc@1200 115 val iflow : (Mono.file, Mono.file) phase
adamc@567 116 val jscomp : (Mono.file, Mono.file) phase
adamc@506 117 val fuse : (Mono.file, Mono.file) phase
adamc@377 118 val pathcheck : (Mono.file, Mono.file) phase
adamc@202 119 val cjrize : (Mono.file, Cjr.file) phase
adamc@643 120 val scriptcheck : (Cjr.file, Cjr.file) phase
adamc@282 121 val prepare : (Cjr.file, Cjr.file) phase
adamc@879 122 val checknest : (Cjr.file, Cjr.file) phase
adamc@274 123 val sqlify : (Mono.file, Cjr.file) phase
adamc@201 124
adamc@270 125 val toParseJob : (string, job) transform
adamc@1082 126 val toParseJob' : (string, {Job : job, Libs : string list}) transform
adamc@270 127 val toParse : (string, Source.file) transform
adamc@270 128 val toElaborate : (string, Elab.file) transform
adamc@448 129 val toUnnest : (string, Elab.file) transform
adamc@313 130 val toTermination : (string, Elab.file) transform
adamc@270 131 val toExplify : (string, Expl.file) transform
adamc@270 132 val toCorify : (string, Core.file) transform
adamc@454 133 val toCore_untangle : (string, Core.file) transform
adamc@270 134 val toShake1 : (string, Core.file) transform
adam@1362 135 val toEspecialize1' : (string, Core.file) transform
adam@1362 136 val toShake1' : (string, Core.file) transform
adamc@607 137 val toRpcify : (string, Core.file) transform
adamc@642 138 val toCore_untangle2 : (string, Core.file) transform
adamc@642 139 val toShake2 : (string, Core.file) transform
adamc@1062 140 val toEspecialize1 : (string, Core.file) transform
adamc@1062 141 val toCore_untangle3 : (string, Core.file) transform
adamc@1062 142 val toShake3 : (string, Core.file) transform
adamc@270 143 val toTag : (string, Core.file) transform
adamc@270 144 val toReduce : (string, Core.file) transform
adamc@1186 145 val toShakey : (string, Core.file) transform
adamc@1272 146 val toUnpoly : (string, Core.file) transform
adamc@1272 147 val toSpecialize : (string, Core.file) transform
adamc@1062 148 val toShake4 : (string, Core.file) transform
adamc@1272 149 val toEspecialize2 : (string, Core.file) transform
adamc@1272 150 val toShake4' : (string, Core.file) transform
adamc@1276 151 val toSpecialize2 : (string, Core.file) transform
adamc@1272 152 val toUnpoly2 : (string, Core.file) transform
adamc@1272 153 val toShake4'' : (string, Core.file) transform
adamc@1272 154 val toEspecialize3 : (string, Core.file) transform
adamc@898 155 val toReduce2 : (string, Core.file) transform
adamc@1062 156 val toShake5 : (string, Core.file) transform
adamc@692 157 val toMarshalcheck : (string, Core.file) transform
adamc@732 158 val toEffectize : (string, Core.file) transform
adamc@1170 159 val toCss : (string, Css.report) transform
adamc@270 160 val toMonoize : (string, Mono.file) transform
adamc@270 161 val toMono_opt1 : (string, Mono.file) transform
adamc@270 162 val toUntangle : (string, Mono.file) transform
adamc@270 163 val toMono_reduce : (string, Mono.file) transform
adamc@270 164 val toMono_shake : (string, Mono.file) transform
adamc@572 165 val toMono_opt2 : (string, Mono.file) transform
adamc@1200 166 val toIflow : (string, Mono.file) transform
adamc@567 167 val toJscomp : (string, Mono.file) transform
adamc@572 168 val toMono_opt3 : (string, Mono.file) transform
adamc@506 169 val toFuse : (string, Mono.file) transform
adamc@506 170 val toUntangle2 : (string, Mono.file) transform
adamc@601 171 val toMono_reduce2 : (string, Mono.file) transform
adamc@506 172 val toMono_shake2 : (string, Mono.file) transform
adamc@916 173 val toMono_opt4 : (string, Mono.file) transform
adamc@1017 174 val toMono_reduce3 : (string, Mono.file) transform
adamc@916 175 val toFuse2 : (string, Mono.file) transform
adamc@916 176 val toUntangle3 : (string, Mono.file) transform
adamc@916 177 val toMono_shake3 : (string, Mono.file) transform
adamc@377 178 val toPathcheck : (string, Mono.file) transform
adamc@270 179 val toCjrize : (string, Cjr.file) transform
adamc@643 180 val toScriptcheck : (string, Cjr.file) transform
adamc@282 181 val toPrepare : (string, Cjr.file) transform
adamc@879 182 val toChecknest : (string, Cjr.file) transform
adamc@274 183 val toSqlify : (string, Cjr.file) transform
adamc@1 184
adamc@1079 185 val debug : bool ref
adamc@1235 186 val doIflow : bool ref
adamc@1079 187
adamc@1089 188 val addPath : string * string -> unit
adamc@1090 189 val addModuleRoot : string * string -> unit
adamc@1089 190
adamc@1266 191 val moduleOf : string -> string
adamc@1266 192
adamc@1 193 end