Mercurial > urweb

annotate src/compiler.sig @ 1309:127561e4aef1

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