annotate src/compiler.sig @ 544:4154b4dc62c6

Finish documenting queries; remove a stray [unit] argument
author Adam Chlipala <adamc@hcoop.net>
date Sun, 07 Dec 2008 10:02:04 -0500
parents 4929cf86bc03
children 1901db85acb4
rev   line source
adamc@1 1 (* Copyright (c) 2008, 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@502 39 profile : bool
adamc@270 40 }
adamc@270 41 val compile : string -> unit
adamc@502 42 val compileC : {cname : string, oname : string, ename : string, libs : string, profile : bool} -> unit
adamc@29 43
adamc@201 44 type ('src, 'dst) phase
adamc@201 45 type ('src, 'dst) transform
adamc@55 46
adamc@201 47 val transform : ('src, 'dst) phase -> string -> ('src, 'dst) transform
adamc@270 48 val o : ('b, 'c) transform * ('a, 'b) transform -> ('a, 'c) transform
adamc@1 49
adamc@346 50 val check : ('src, 'dst) transform -> 'src -> unit
adamc@201 51 val run : ('src, 'dst) transform -> 'src -> 'dst option
adamc@201 52 val runPrint : ('src, 'dst) transform -> 'src -> unit
adamc@201 53 val time : ('src, 'dst) transform -> 'src -> unit
adamc@201 54 val timePrint : ('src, 'dst) transform -> 'src -> unit
adamc@56 55
adamc@244 56 val parseUr : (string, Source.file) phase
adamc@244 57 val parseUrs : (string, Source.sgn_item list) phase
adamc@270 58 val parseUrp : (string, job) phase
adamc@201 59
adamc@201 60 val parse : (job, Source.file) phase
adamc@201 61 val elaborate : (Source.file, Elab.file) phase
adamc@448 62 val unnest : (Elab.file, Elab.file) phase
adamc@313 63 val termination : (Elab.file, Elab.file) phase
adamc@201 64 val explify : (Elab.file, Expl.file) phase
adamc@201 65 val corify : (Expl.file, Core.file) phase
adamc@443 66 val especialize : (Core.file, Core.file) phase
adamc@454 67 val core_untangle : (Core.file, Core.file) phase
adamc@202 68 val shake : (Core.file, Core.file) phase
adamc@202 69 val tag : (Core.file, Core.file) phase
adamc@202 70 val reduce : (Core.file, Core.file) phase
adamc@315 71 val unpoly : (Core.file, Core.file) phase
adamc@202 72 val specialize : (Core.file, Core.file) phase
adamc@202 73 val monoize : (Core.file, Mono.file) phase
adamc@202 74 val mono_opt : (Mono.file, Mono.file) phase
adamc@202 75 val untangle : (Mono.file, Mono.file) phase
adamc@202 76 val mono_reduce : (Mono.file, Mono.file) phase
adamc@202 77 val mono_shake : (Mono.file, Mono.file) phase
adamc@506 78 val fuse : (Mono.file, Mono.file) phase
adamc@377 79 val pathcheck : (Mono.file, Mono.file) phase
adamc@202 80 val cjrize : (Mono.file, Cjr.file) phase
adamc@282 81 val prepare : (Cjr.file, Cjr.file) phase
adamc@274 82 val sqlify : (Mono.file, Cjr.file) phase
adamc@201 83
adamc@270 84 val toParseJob : (string, job) transform
adamc@270 85 val toParse : (string, Source.file) transform
adamc@270 86 val toElaborate : (string, Elab.file) transform
adamc@448 87 val toUnnest : (string, Elab.file) transform
adamc@313 88 val toTermination : (string, Elab.file) transform
adamc@270 89 val toExplify : (string, Expl.file) transform
adamc@270 90 val toCorify : (string, Core.file) transform
adamc@443 91 val toEspecialize : (string, Core.file) transform
adamc@454 92 val toCore_untangle : (string, Core.file) transform
adamc@270 93 val toShake1 : (string, Core.file) transform
adamc@270 94 val toTag : (string, Core.file) transform
adamc@270 95 val toReduce : (string, Core.file) transform
adamc@315 96 val toUnpoly : (string, Core.file) transform
adamc@315 97 val toSpecialize : (string, Core.file) transform
adamc@270 98 val toShake2 : (string, Core.file) transform
adamc@270 99 val toMonoize : (string, Mono.file) transform
adamc@270 100 val toMono_opt1 : (string, Mono.file) transform
adamc@270 101 val toUntangle : (string, Mono.file) transform
adamc@270 102 val toMono_reduce : (string, Mono.file) transform
adamc@270 103 val toMono_shake : (string, Mono.file) transform
adamc@270 104 val toMono_opt2 : (string, Mono.file) transform
adamc@506 105 val toFuse : (string, Mono.file) transform
adamc@506 106 val toUntangle2 : (string, Mono.file) transform
adamc@506 107 val toMono_shake2 : (string, Mono.file) transform
adamc@377 108 val toPathcheck : (string, Mono.file) transform
adamc@270 109 val toCjrize : (string, Cjr.file) transform
adamc@282 110 val toPrepare : (string, Cjr.file) transform
adamc@274 111 val toSqlify : (string, Cjr.file) transform
adamc@1 112
adamc@1 113 end