annotate src/compiler.sig @ 1161:2ae57fa551be

Update manual with Gian's experience building in OS X
author Adam Chlipala <adamc@hcoop.net>
date Tue, 09 Feb 2010 09:51:21 -0500
parents e77079953308
children 8679ba87cf3c
rev   line source
adamc@1082 1 (* Copyright (c) 2008-2009, 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@765 47 clientOnly : Settings.ffi list,
adamc@765 48 serverOnly : Settings.ffi list,
adamc@768 49 jsFuncs : (Settings.ffi * string) list,
adamc@769 50 rewrites : Settings.rewrite list,
adamc@769 51 filterUrl : Settings.rule list,
adamc@866 52 filterMime : Settings.rule list,
adamc@866 53 protocol : string option,
adamc@866 54 dbms : string option
adamc@270 55 }
adamc@1045 56 val compile : string -> bool
adamc@1045 57 val compiler : string -> unit
adamc@742 58 val compileC : {cname : string, oname : string, ename : string, libs : string,
adamc@1045 59 profile : bool, debug : bool, link : string list} -> bool
adamc@29 60
adamc@201 61 type ('src, 'dst) phase
adamc@201 62 type ('src, 'dst) transform
adamc@55 63
adamc@201 64 val transform : ('src, 'dst) phase -> string -> ('src, 'dst) transform
adamc@270 65 val o : ('b, 'c) transform * ('a, 'b) transform -> ('a, 'c) transform
adamc@1 66
adamc@346 67 val check : ('src, 'dst) transform -> 'src -> unit
adamc@201 68 val run : ('src, 'dst) transform -> 'src -> 'dst option
adamc@201 69 val runPrint : ('src, 'dst) transform -> 'src -> unit
adamc@201 70 val time : ('src, 'dst) transform -> 'src -> unit
adamc@201 71 val timePrint : ('src, 'dst) transform -> 'src -> unit
adamc@56 72
adamc@244 73 val parseUr : (string, Source.file) phase
adamc@244 74 val parseUrs : (string, Source.sgn_item list) phase
adamc@270 75 val parseUrp : (string, job) phase
adamc@1082 76 val parseUrp' : (string, {Job : job, Libs : string list}) phase
adamc@201 77
adamc@201 78 val parse : (job, Source.file) phase
adamc@201 79 val elaborate : (Source.file, Elab.file) phase
adamc@448 80 val unnest : (Elab.file, Elab.file) phase
adamc@313 81 val termination : (Elab.file, Elab.file) phase
adamc@201 82 val explify : (Elab.file, Expl.file) phase
adamc@201 83 val corify : (Expl.file, Core.file) phase
adamc@454 84 val core_untangle : (Core.file, Core.file) phase
adamc@202 85 val shake : (Core.file, Core.file) phase
adamc@607 86 val rpcify : (Core.file, Core.file) phase
adamc@202 87 val tag : (Core.file, Core.file) phase
adamc@202 88 val reduce : (Core.file, Core.file) phase
adamc@315 89 val unpoly : (Core.file, Core.file) phase
adamc@202 90 val specialize : (Core.file, Core.file) phase
adamc@692 91 val marshalcheck : (Core.file, Core.file) phase
adamc@732 92 val effectize : (Core.file, Core.file) phase
adamc@202 93 val monoize : (Core.file, Mono.file) phase
adamc@202 94 val mono_opt : (Mono.file, Mono.file) phase
adamc@202 95 val untangle : (Mono.file, Mono.file) phase
adamc@202 96 val mono_reduce : (Mono.file, Mono.file) phase
adamc@202 97 val mono_shake : (Mono.file, Mono.file) phase
adamc@567 98 val jscomp : (Mono.file, Mono.file) phase
adamc@506 99 val fuse : (Mono.file, Mono.file) phase
adamc@377 100 val pathcheck : (Mono.file, Mono.file) phase
adamc@202 101 val cjrize : (Mono.file, Cjr.file) phase
adamc@643 102 val scriptcheck : (Cjr.file, Cjr.file) phase
adamc@282 103 val prepare : (Cjr.file, Cjr.file) phase
adamc@879 104 val checknest : (Cjr.file, Cjr.file) phase
adamc@274 105 val sqlify : (Mono.file, Cjr.file) phase
adamc@201 106
adamc@270 107 val toParseJob : (string, job) transform
adamc@1082 108 val toParseJob' : (string, {Job : job, Libs : string list}) transform
adamc@270 109 val toParse : (string, Source.file) transform
adamc@270 110 val toElaborate : (string, Elab.file) transform
adamc@448 111 val toUnnest : (string, Elab.file) transform
adamc@313 112 val toTermination : (string, Elab.file) transform
adamc@270 113 val toExplify : (string, Expl.file) transform
adamc@270 114 val toCorify : (string, Core.file) transform
adamc@454 115 val toCore_untangle : (string, Core.file) transform
adamc@270 116 val toShake1 : (string, Core.file) transform
adamc@607 117 val toRpcify : (string, Core.file) transform
adamc@642 118 val toCore_untangle2 : (string, Core.file) transform
adamc@642 119 val toShake2 : (string, Core.file) transform
adamc@1062 120 val toEspecialize1 : (string, Core.file) transform
adamc@1062 121 val toCore_untangle3 : (string, Core.file) transform
adamc@1062 122 val toShake3 : (string, Core.file) transform
adamc@270 123 val toTag : (string, Core.file) transform
adamc@270 124 val toReduce : (string, Core.file) transform
adamc@315 125 val toUnpoly : (string, Core.file) transform
adamc@315 126 val toSpecialize : (string, Core.file) transform
adamc@1062 127 val toShake4 : (string, Core.file) transform
adamc@1062 128 val toEspecialize2 : (string, Core.file) transform
adamc@898 129 val toReduce2 : (string, Core.file) transform
adamc@1062 130 val toShake5 : (string, Core.file) transform
adamc@692 131 val toMarshalcheck : (string, Core.file) transform
adamc@732 132 val toEffectize : (string, Core.file) transform
adamc@270 133 val toMonoize : (string, Mono.file) transform
adamc@270 134 val toMono_opt1 : (string, Mono.file) transform
adamc@270 135 val toUntangle : (string, Mono.file) transform
adamc@270 136 val toMono_reduce : (string, Mono.file) transform
adamc@270 137 val toMono_shake : (string, Mono.file) transform
adamc@572 138 val toMono_opt2 : (string, Mono.file) transform
adamc@567 139 val toJscomp : (string, Mono.file) transform
adamc@572 140 val toMono_opt3 : (string, Mono.file) transform
adamc@506 141 val toFuse : (string, Mono.file) transform
adamc@506 142 val toUntangle2 : (string, Mono.file) transform
adamc@601 143 val toMono_reduce2 : (string, Mono.file) transform
adamc@506 144 val toMono_shake2 : (string, Mono.file) transform
adamc@916 145 val toMono_opt4 : (string, Mono.file) transform
adamc@1017 146 val toMono_reduce3 : (string, Mono.file) transform
adamc@916 147 val toFuse2 : (string, Mono.file) transform
adamc@916 148 val toUntangle3 : (string, Mono.file) transform
adamc@916 149 val toMono_shake3 : (string, Mono.file) transform
adamc@377 150 val toPathcheck : (string, Mono.file) transform
adamc@270 151 val toCjrize : (string, Cjr.file) transform
adamc@643 152 val toScriptcheck : (string, Cjr.file) transform
adamc@282 153 val toPrepare : (string, Cjr.file) transform
adamc@879 154 val toChecknest : (string, Cjr.file) transform
adamc@274 155 val toSqlify : (string, Cjr.file) transform
adamc@1 156
adamc@1079 157 val debug : bool ref
adamc@1079 158
adamc@1089 159 val addPath : string * string -> unit
adamc@1090 160 val addModuleRoot : string * string -> unit
adamc@1089 161
adamc@1 162 end