annotate src/compiler.sig @ 1283:b04354e24d1b

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