annotate src/demo.sml @ 1329:9be9da2df74b

Clarifying some C FFI details in manual
author Adam Chlipala <adam@chlipala.net>
date Sat, 11 Dec 2010 11:00:05 -0500
parents 4359e185d3af
children 4dd5d23bace2
rev   line source
adamc@1151 1 (* Copyright (c) 2008-2010, Adam Chlipala
adamc@380 2 * All rights reserved.
adamc@380 3 *
adamc@380 4 * Redistribution and use in source and binary forms, with or without
adamc@380 5 * modification, are permitted provided that the following conditions are met:
adamc@380 6 *
adamc@380 7 * - Redistributions of source code must retain the above copyright notice,
adamc@380 8 * this list of conditions and the following disclaimer.
adamc@380 9 * - Redistributions in binary form must reproduce the above copyright notice,
adamc@380 10 * this list of conditions and the following disclaimer in the documentation
adamc@380 11 * and/or other materials provided with the distribution.
adamc@380 12 * - The names of contributors may not be used to endorse or promote products
adamc@380 13 * derived from this software without specific prior written permission.
adamc@380 14 *
adamc@380 15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
adamc@380 16 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
adamc@380 17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
adamc@380 18 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
adamc@380 19 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
adamc@380 20 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
adamc@380 21 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
adamc@380 22 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
adamc@380 23 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
adamc@380 24 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
adamc@380 25 * POSSIBILITY OF SUCH DAMAGE.
adamc@380 26 *)
adamc@380 27
adamc@380 28 structure Demo :> DEMO = struct
adamc@380 29
adam@1301 30 val noEmacs = ref false
adam@1301 31
adamc@1079 32 fun make' {prefix, dirname, guided} =
adamc@380 33 let
adamc@380 34 val prose = OS.Path.joinDirFile {dir = dirname,
adamc@380 35 file = "prose"}
adamc@380 36 val inf = TextIO.openIn prose
adamc@380 37
adamc@380 38 val outDir = OS.Path.concat (dirname, "out")
adamc@380 39
adamc@380 40 val () = if OS.FileSys.access (outDir, []) then
adamc@380 41 ()
adamc@380 42 else
adamc@380 43 OS.FileSys.mkDir outDir
adamc@380 44
adamc@380 45 val fname = OS.Path.joinDirFile {dir = outDir,
adamc@380 46 file = "index.html"}
adamc@380 47
adamc@380 48 val out = TextIO.openOut fname
adamc@773 49 val () = (TextIO.output (out, "<frameset cols=\"15%,85%\">\n");
adamc@380 50 TextIO.output (out, "<frame src=\"demos.html\">\n");
adamc@380 51 TextIO.output (out, "<frame src=\"intro.html\" name=\"staging\">\n");
adamc@380 52 TextIO.output (out, "</frameset>\n");
adamc@380 53 TextIO.closeOut out)
adamc@380 54
adamc@380 55 val fname = OS.Path.joinDirFile {dir = outDir,
adamc@380 56 file = "demos.html"}
adamc@380 57
adamc@380 58 val demosOut = TextIO.openOut fname
adamc@381 59 val () = (TextIO.output (demosOut, "<html><body>\n\n");
adamc@380 60 TextIO.output (demosOut, "<li> <a target=\"staging\" href=\"intro.html\">Intro</a></li>\n\n"))
adamc@380 61
adamc@384 62 val fname = OS.Path.joinDirFile {dir = dirname,
adamc@384 63 file = "demo.urs"}
adamc@384 64 val ursOut = TextIO.openOut fname
adamc@384 65 val () = (TextIO.output (ursOut, "val main : unit -> transaction page\n");
adamc@384 66 TextIO.closeOut ursOut)
adamc@384 67
adamc@384 68 val fname = OS.Path.joinDirFile {dir = dirname,
adamc@384 69 file = "demo.ur"}
adamc@384 70 val urOut = TextIO.openOut fname
adamc@384 71 val () = TextIO.output (urOut, "fun main () = return <xml><body>\n")
adamc@384 72
adamc@380 73 fun mergeWith f (o1, o2) =
adamc@380 74 case (o1, o2) of
adamc@380 75 (NONE, _) => o2
adamc@380 76 | (_, NONE) => o1
adamc@380 77 | (SOME v1, SOME v2) => SOME (f (v1, v2))
adamc@380 78
adamc@380 79 fun combiner (combined : Compiler.job, urp : Compiler.job) = {
adamc@385 80 prefix = prefix,
adamc@380 81 database = mergeWith (fn (v1, v2) =>
adamc@380 82 if v1 = v2 then
adamc@380 83 v1
adamc@380 84 else
adamc@380 85 raise Fail "Different demos want to use different database strings")
adamc@380 86 (#database combined, #database urp),
adamc@380 87 sources = foldl (fn (file, files) =>
adamc@380 88 if List.exists (fn x => x = file) files then
adamc@380 89 files
adamc@380 90 else
adamc@380 91 files @ [file])
adamc@380 92 (#sources combined) (#sources urp),
adamc@891 93 exe = case Settings.getExe () of
adamc@891 94 NONE => OS.Path.joinDirFile {dir = dirname,
adamc@891 95 file = "demo.exe"}
adamc@891 96 | SOME s => s,
adamc@891 97 sql = SOME (case Settings.getSql () of
adamc@891 98 NONE => OS.Path.joinDirFile {dir = dirname,
adamc@891 99 file = "demo.sql"}
adamc@891 100 | SOME s => s),
adamc@863 101 debug = Settings.getDebug (),
adamc@673 102 timeout = Int.max (#timeout combined, #timeout urp),
adamc@764 103 profile = false,
adamc@764 104 ffi = [],
adamc@764 105 link = [],
adamc@765 106 headers = [],
adamc@766 107 scripts = [],
adamc@765 108 clientToServer = [],
adamc@765 109 effectful = [],
adamc@1171 110 benignEffectful = [],
adamc@765 111 clientOnly = [],
adamc@765 112 serverOnly = [],
adamc@768 113 jsFuncs = [],
adamc@774 114 rewrites = #rewrites combined @ #rewrites urp,
adamc@769 115 filterUrl = #filterUrl combined @ #filterUrl urp,
adamc@866 116 filterMime = #filterMime combined @ #filterMime urp,
adamc@866 117 protocol = mergeWith #2 (#protocol combined, #protocol urp),
adamc@1164 118 dbms = mergeWith #2 (#dbms combined, #dbms urp),
adamc@1183 119 sigFile = mergeWith #2 (#sigFile combined, #sigFile urp),
adam@1294 120 safeGets = [],
adam@1294 121 onError = NONE
adamc@380 122 }
adamc@380 123
adamc@380 124 val parse = Compiler.run (Compiler.transform Compiler.parseUrp "Demo parseUrp")
adamc@380 125
adamc@380 126 fun capitalize "" = ""
adamc@380 127 | capitalize s = str (Char.toUpper (String.sub (s, 0)))
adamc@380 128 ^ String.extract (s, 1, NONE)
adamc@380 129
adamc@380 130 fun startUrp urp =
adamc@380 131 let
adamc@380 132 val base = OS.Path.base urp
adamc@380 133 val name = capitalize base
adamc@380 134
adamc@380 135 val () = (TextIO.output (demosOut, "<li> <a target=\"staging\" href=\"");
adamc@380 136 TextIO.output (demosOut, base);
adamc@380 137 TextIO.output (demosOut, ".html\">");
adamc@380 138 TextIO.output (demosOut, name);
adamc@380 139 TextIO.output (demosOut, "</a></li>\n"))
adamc@380 140
adamc@384 141 val () = (TextIO.output (urOut, " <li> <a link={");
adamc@384 142 TextIO.output (urOut, name);
adamc@384 143 TextIO.output (urOut, ".main ()}>");
adamc@384 144 TextIO.output (urOut, name);
adamc@384 145 TextIO.output (urOut, "</a></li>\n"))
adamc@384 146
adamc@380 147 val urp_file = OS.Path.joinDirFile {dir = dirname,
adamc@380 148 file = urp}
adamc@380 149
adamc@380 150 val out = OS.Path.joinBaseExt {base = base,
adamc@380 151 ext = SOME "html"}
adamc@380 152 val out = OS.Path.joinDirFile {dir = outDir,
adamc@380 153 file = out}
adamc@380 154 val out = TextIO.openOut out
adamc@380 155
adamc@501 156 val () = (TextIO.output (out, "<frameset rows=\"");
adamc@501 157 TextIO.output (out, if guided then
adamc@501 158 "*,100"
adamc@501 159 else
adamc@501 160 "50%,*");
adamc@501 161 TextIO.output (out, "\">\n");
adamc@380 162 TextIO.output (out, "<frame src=\"");
adamc@380 163 TextIO.output (out, prefix);
adamc@380 164 TextIO.output (out, "/");
adamc@380 165 TextIO.output (out, name);
adamc@380 166 TextIO.output (out, "/main\" name=\"showcase\">\n");
adamc@380 167 TextIO.output (out, "<frame src=\"");
adamc@380 168 TextIO.output (out, base);
adamc@380 169 TextIO.output (out, ".desc.html\">\n");
adamc@380 170 TextIO.output (out, "</frameset>\n");
adamc@380 171 TextIO.closeOut out)
adamc@380 172 val () = TextIO.closeOut out
adamc@380 173
adamc@380 174 val out = OS.Path.joinBaseExt {base = base,
adamc@380 175 ext = SOME "desc"}
adamc@380 176 val out = OS.Path.joinBaseExt {base = out,
adamc@380 177 ext = SOME "html"}
adamc@380 178 val out = TextIO.openOut (OS.Path.joinDirFile {dir = outDir,
adamc@380 179 file = out})
adamc@380 180 in
adamc@380 181 case parse (OS.Path.base urp_file) of
adamc@380 182 NONE => raise Fail ("Can't parse " ^ urp_file)
adamc@380 183 | SOME urpData =>
adamc@380 184 (TextIO.output (out, "<html><head>\n<title>");
adamc@380 185 TextIO.output (out, name);
adamc@380 186 TextIO.output (out, "</title>\n</head><body>\n\n<h1>");
adamc@380 187 TextIO.output (out, name);
adamc@380 188 TextIO.output (out, "</h1>\n\n<center>[ <a target=\"showcase\" href=\"");
adamc@382 189 TextIO.output (out, prefix);
adamc@382 190 TextIO.output (out, "/");
adamc@382 191 TextIO.output (out, name);
adamc@382 192 TextIO.output (out, "/main\">Application</a>");
adamc@382 193 TextIO.output (out, " | <a target=\"showcase\" href=\"");
adamc@380 194 TextIO.output (out, urp);
adamc@380 195 TextIO.output (out, ".html\"><tt>");
adamc@380 196 TextIO.output (out, urp);
adamc@380 197 TextIO.output (out, "</tt></a>");
adamc@380 198 app (fn file =>
adamc@380 199 let
adamc@380 200 fun ifEx s =
adamc@380 201 let
adamc@380 202 val src = OS.Path.joinBaseExt {base = file,
adamc@380 203 ext = SOME s}
adamc@380 204 val src' = OS.Path.file src
adamc@380 205 in
adamc@1151 206 if String.isPrefix (OS.Path.mkAbsolute {path = dirname,
adamc@1151 207 relativeTo = OS.FileSys.getDir ()}) src
adamc@943 208 andalso OS.FileSys.access (src, []) then
adamc@380 209 (TextIO.output (out, " | <a target=\"showcase\" href=\"");
adamc@380 210 TextIO.output (out, src');
adamc@380 211 TextIO.output (out, ".html\"><tt>");
adamc@380 212 TextIO.output (out, src');
adamc@380 213 TextIO.output (out, "</tt></a>"))
adamc@380 214 else
adamc@1156 215 ()
adamc@380 216 end
adamc@380 217 in
adamc@380 218 ifEx "urs";
adamc@380 219 ifEx "ur"
adamc@380 220 end) (#sources urpData);
adamc@380 221 TextIO.output (out, " ]</center>\n\n");
adamc@380 222
adamc@380 223 (urpData, out))
adamc@380 224 end
adamc@380 225
adamc@380 226 fun endUrp out =
adamc@380 227 (TextIO.output (out, "\n</body></html>\n");
adamc@380 228 TextIO.closeOut out)
adamc@380 229
adamc@380 230 fun readUrp (combined, out) =
adamc@380 231 let
adamc@380 232 fun finished () = endUrp out
adamc@380 233
adamc@380 234 fun readUrp' () =
adamc@380 235 case TextIO.inputLine inf of
adamc@384 236 NONE => (finished ();
adamc@384 237 combined)
adamc@380 238 | SOME line =>
adamc@380 239 if String.isSuffix ".urp\n" line then
adamc@380 240 let
adamc@380 241 val urp = String.substring (line, 0, size line - 1)
adamc@380 242 val (urpData, out) = startUrp urp
adamc@380 243 in
adamc@380 244 finished ();
adamc@380 245
adamc@380 246 readUrp (combiner (combined, urpData),
adamc@380 247 out)
adamc@380 248 end
adamc@380 249 else
adamc@380 250 (TextIO.output (out, line);
adamc@380 251 readUrp' ())
adamc@380 252 in
adamc@380 253 readUrp' ()
adamc@380 254 end
adamc@380 255
adamc@380 256 val indexFile = OS.Path.joinDirFile {dir = outDir,
adamc@380 257 file = "intro.html"}
adamc@380 258
adamc@380 259 val out = TextIO.openOut indexFile
adamc@380 260 val () = TextIO.output (out, "<html><head>\n<title>Ur/Web Demo</title>\n</head><body>\n\n")
adamc@380 261
adamc@380 262 fun readIndex () =
adamc@380 263 let
adamc@380 264 fun finished () = (TextIO.output (out, "\n</body></html>\n");
adamc@380 265 TextIO.closeOut out)
adamc@380 266 in
adamc@380 267 case TextIO.inputLine inf of
adamc@384 268 NONE => (finished ();
adamc@384 269 NONE)
adamc@380 270 | SOME line =>
adamc@380 271 if String.isSuffix ".urp\n" line then
adamc@380 272 let
adamc@380 273 val urp = String.substring (line, 0, size line - 1)
adamc@380 274 val (urpData, out) = startUrp urp
adamc@380 275 in
adamc@380 276 finished ();
adamc@380 277
adamc@384 278 SOME (readUrp (urpData,
adamc@384 279 out))
adamc@380 280 end
adamc@380 281 else
adamc@380 282 (TextIO.output (out, line);
adamc@380 283 readIndex ())
adamc@380 284 end
adamc@381 285
adamc@381 286 fun prettyPrint () =
adamc@381 287 let
adamc@381 288 val dir = Posix.FileSys.opendir dirname
adamc@381 289
adamc@381 290 fun loop () =
adamc@381 291 case Posix.FileSys.readdir dir of
adamc@381 292 NONE => Posix.FileSys.closedir dir
adamc@381 293 | SOME file =>
adamc@381 294 let
adamc@381 295 fun doit f =
adamc@381 296 f (OS.Path.joinDirFile {dir = dirname,
adamc@381 297 file = file},
adamc@382 298 OS.Path.mkAbsolute
adamc@382 299 {relativeTo = OS.FileSys.getDir (),
adamc@382 300 path = OS.Path.joinDirFile {dir = outDir,
adamc@382 301 file = OS.Path.joinBaseExt {base = file,
adamc@382 302 ext = SOME "html"}}})
adamc@382 303
adamc@382 304 fun highlight () =
adamc@382 305 doit (fn (src, html) =>
adamc@382 306 let
adamc@410 307 val dirty =
adamc@410 308 let
adamc@410 309 val srcSt = Posix.FileSys.stat src
adamc@410 310 val htmlSt = Posix.FileSys.stat html
adamc@410 311 in
adamc@410 312 Time.> (Posix.FileSys.ST.mtime srcSt,
adamc@410 313 Posix.FileSys.ST.mtime htmlSt)
adamc@410 314 end handle OS.SysErr _ => true
adamc@410 315
adamc@382 316 val cmd = "emacs --eval \"(progn "
adamc@382 317 ^ "(global-font-lock-mode t) "
adamc@382 318 ^ "(add-to-list 'load-path \\\""
adamc@382 319 ^ Config.sitelisp
adamc@382 320 ^ "/\\\") "
adamc@382 321 ^ "(load \\\"urweb-mode-startup\\\") "
adamc@382 322 ^ "(urweb-mode) "
adamc@382 323 ^ "(find-file \\\""
adamc@382 324 ^ src
adamc@382 325 ^ "\\\") "
adamc@382 326 ^ "(switch-to-buffer (htmlize-buffer)) "
adamc@382 327 ^ "(write-file \\\""
adamc@382 328 ^ html
adamc@382 329 ^ "\\\") "
adamc@382 330 ^ "(kill-emacs))\""
adamc@382 331 in
adamc@410 332 if dirty then
adamc@410 333 (print (">>> " ^ cmd ^ "\n");
adamc@410 334 ignore (OS.Process.system cmd))
adamc@410 335 else
adamc@410 336 ()
adamc@382 337 end)
adam@1301 338
adam@1301 339 val highlight = fn () => if !noEmacs then () else highlight ()
adamc@381 340 in
adamc@384 341 if OS.Path.base file = "demo" then
adamc@384 342 ()
adamc@384 343 else case OS.Path.ext file of
adamc@384 344 SOME "urp" =>
adamc@384 345 doit (fn (src, html) =>
adamc@384 346 let
adamc@384 347 val inf = TextIO.openIn src
adamc@384 348 val out = TextIO.openOut html
adamc@381 349
adamc@384 350 fun loop () =
adamc@384 351 case TextIO.inputLine inf of
adamc@384 352 NONE => ()
adamc@384 353 | SOME line => (TextIO.output (out, line);
adamc@384 354 loop ())
adamc@384 355 in
adamc@384 356 TextIO.output (out, "<html><body>\n\n<pre>");
adamc@384 357 loop ();
adamc@384 358 TextIO.output (out, "</pre>\n\n</body></html>");
adamc@381 359
adamc@384 360 TextIO.closeIn inf;
adamc@384 361 TextIO.closeOut out
adamc@384 362 end)
adamc@384 363 | SOME "urs" => highlight ()
adamc@384 364 | SOME "ur" => highlight ()
adamc@384 365 | _ => ();
adamc@381 366 loop ()
adamc@381 367 end
adamc@381 368 in
adamc@381 369 loop ()
adamc@381 370 end
adamc@380 371 in
adamc@384 372 case readIndex () of
adamc@384 373 NONE => raise Fail "No demo applications!"
adamc@384 374 | SOME combined =>
adamc@384 375 let
adamc@384 376 val () = (TextIO.output (urOut, "</body></xml>\n");
adamc@384 377 TextIO.closeOut urOut)
adamc@384 378
adamc@384 379 val fname = OS.Path.joinDirFile {dir = dirname,
adamc@384 380 file = "demo.urp"}
adamc@384 381 val outf = TextIO.openOut fname
adamc@776 382
adamc@776 383 fun filters kind =
adamc@776 384 app (fn rule : Settings.rule =>
adamc@776 385 (TextIO.output (outf, case #action rule of
adamc@776 386 Settings.Allow => "allow"
adamc@776 387 | Settings.Deny => "deny");
adamc@776 388 TextIO.output (outf, " ");
adamc@776 389 TextIO.output (outf, kind);
adamc@776 390 TextIO.output (outf, " ");
adamc@776 391 TextIO.output (outf, #pattern rule);
adamc@776 392 case #kind rule of
adamc@776 393 Settings.Exact => ()
adamc@776 394 | Settings.Prefix => TextIO.output (outf, "*");
adamc@776 395 TextIO.output (outf, "\n")))
adamc@384 396 in
adamc@384 397 Option.app (fn db => (TextIO.output (outf, "database ");
adamc@384 398 TextIO.output (outf, db);
adamc@384 399 TextIO.output (outf, "\n")))
adamc@384 400 (#database combined);
adamc@384 401 TextIO.output (outf, "sql demo.sql\n");
adamc@385 402 TextIO.output (outf, "prefix ");
adamc@385 403 TextIO.output (outf, prefix);
adamc@385 404 TextIO.output (outf, "\n");
adamc@774 405 app (fn rule =>
adamc@774 406 (TextIO.output (outf, "rewrite ");
adamc@774 407 TextIO.output (outf, case #pkind rule of
adamc@774 408 Settings.Any => "any"
adamc@774 409 | Settings.Url => "url"
adamc@774 410 | Settings.Table => "table"
adamc@774 411 | Settings.Sequence => "sequence"
adamc@774 412 | Settings.View => "view"
adamc@774 413 | Settings.Relation => "relation"
adamc@774 414 | Settings.Cookie => "cookie"
adamc@774 415 | Settings.Style => "style");
adamc@774 416 TextIO.output (outf, " ");
adamc@774 417 TextIO.output (outf, #from rule);
adamc@774 418 case #kind rule of
adamc@774 419 Settings.Exact => ()
adamc@774 420 | Settings.Prefix => TextIO.output (outf, "*");
adamc@774 421 TextIO.output (outf, " ");
adamc@774 422 TextIO.output (outf, #to rule);
adamc@774 423 TextIO.output (outf, "\n"))) (#rewrites combined);
adamc@776 424 filters "url" (#filterUrl combined);
adamc@776 425 filters "mime" (#filterMime combined);
adamc@384 426 TextIO.output (outf, "\n");
adamc@384 427
adamc@384 428 app (fn s =>
adamc@384 429 let
adamc@384 430 val s = OS.Path.mkAbsolute {relativeTo = OS.FileSys.getDir (),
adamc@384 431 path = s}
adamc@384 432 in
adamc@384 433 TextIO.output (outf, s);
adamc@384 434 TextIO.output (outf, "\n")
adamc@384 435 end)
adamc@384 436 (#sources combined);
adamc@384 437 TextIO.output (outf, "\n");
adamc@384 438 TextIO.output (outf, "demo\n");
adamc@384 439
adamc@384 440 TextIO.closeOut outf;
adamc@384 441
adamc@1079 442 let
adamc@1079 443 val b = Compiler.compile (OS.Path.base fname)
adamc@1079 444 in
adamc@1079 445 TextIO.output (demosOut, "\n</body></html>\n");
adamc@1079 446 TextIO.closeOut demosOut;
adamc@1079 447 if b then
adamc@1079 448 prettyPrint ()
adamc@1079 449 else
adamc@1079 450 ();
adamc@1079 451 b
adamc@1079 452 end
adamc@1079 453 end
adamc@380 454 end
adamc@380 455
adamc@1079 456 fun make args = if make' args then
adamc@1079 457 ()
adamc@1079 458 else
adamc@1079 459 OS.Process.exit OS.Process.failure
adamc@1079 460
adamc@380 461 end