annotate src/demo.sml @ 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 b6111b688060
children 8679ba87cf3c
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
adamc@1079 30 fun make' {prefix, dirname, guided} =
adamc@380 31 let
adamc@380 32 val prose = OS.Path.joinDirFile {dir = dirname,
adamc@380 33 file = "prose"}
adamc@380 34 val inf = TextIO.openIn prose
adamc@380 35
adamc@380 36 val outDir = OS.Path.concat (dirname, "out")
adamc@380 37
adamc@380 38 val () = if OS.FileSys.access (outDir, []) then
adamc@380 39 ()
adamc@380 40 else
adamc@380 41 OS.FileSys.mkDir outDir
adamc@380 42
adamc@380 43 val fname = OS.Path.joinDirFile {dir = outDir,
adamc@380 44 file = "index.html"}
adamc@380 45
adamc@380 46 val out = TextIO.openOut fname
adamc@773 47 val () = (TextIO.output (out, "<frameset cols=\"15%,85%\">\n");
adamc@380 48 TextIO.output (out, "<frame src=\"demos.html\">\n");
adamc@380 49 TextIO.output (out, "<frame src=\"intro.html\" name=\"staging\">\n");
adamc@380 50 TextIO.output (out, "</frameset>\n");
adamc@380 51 TextIO.closeOut out)
adamc@380 52
adamc@380 53 val fname = OS.Path.joinDirFile {dir = outDir,
adamc@380 54 file = "demos.html"}
adamc@380 55
adamc@380 56 val demosOut = TextIO.openOut fname
adamc@381 57 val () = (TextIO.output (demosOut, "<html><body>\n\n");
adamc@380 58 TextIO.output (demosOut, "<li> <a target=\"staging\" href=\"intro.html\">Intro</a></li>\n\n"))
adamc@380 59
adamc@384 60 val fname = OS.Path.joinDirFile {dir = dirname,
adamc@384 61 file = "demo.urs"}
adamc@384 62 val ursOut = TextIO.openOut fname
adamc@384 63 val () = (TextIO.output (ursOut, "val main : unit -> transaction page\n");
adamc@384 64 TextIO.closeOut ursOut)
adamc@384 65
adamc@384 66 val fname = OS.Path.joinDirFile {dir = dirname,
adamc@384 67 file = "demo.ur"}
adamc@384 68 val urOut = TextIO.openOut fname
adamc@384 69 val () = TextIO.output (urOut, "fun main () = return <xml><body>\n")
adamc@384 70
adamc@380 71 fun mergeWith f (o1, o2) =
adamc@380 72 case (o1, o2) of
adamc@380 73 (NONE, _) => o2
adamc@380 74 | (_, NONE) => o1
adamc@380 75 | (SOME v1, SOME v2) => SOME (f (v1, v2))
adamc@380 76
adamc@380 77 fun combiner (combined : Compiler.job, urp : Compiler.job) = {
adamc@385 78 prefix = prefix,
adamc@380 79 database = mergeWith (fn (v1, v2) =>
adamc@380 80 if v1 = v2 then
adamc@380 81 v1
adamc@380 82 else
adamc@380 83 raise Fail "Different demos want to use different database strings")
adamc@380 84 (#database combined, #database urp),
adamc@380 85 sources = foldl (fn (file, files) =>
adamc@380 86 if List.exists (fn x => x = file) files then
adamc@380 87 files
adamc@380 88 else
adamc@380 89 files @ [file])
adamc@380 90 (#sources combined) (#sources urp),
adamc@891 91 exe = case Settings.getExe () of
adamc@891 92 NONE => OS.Path.joinDirFile {dir = dirname,
adamc@891 93 file = "demo.exe"}
adamc@891 94 | SOME s => s,
adamc@891 95 sql = SOME (case Settings.getSql () of
adamc@891 96 NONE => OS.Path.joinDirFile {dir = dirname,
adamc@891 97 file = "demo.sql"}
adamc@891 98 | SOME s => s),
adamc@863 99 debug = Settings.getDebug (),
adamc@673 100 timeout = Int.max (#timeout combined, #timeout urp),
adamc@764 101 profile = false,
adamc@764 102 ffi = [],
adamc@764 103 link = [],
adamc@765 104 headers = [],
adamc@766 105 scripts = [],
adamc@765 106 clientToServer = [],
adamc@765 107 effectful = [],
adamc@765 108 clientOnly = [],
adamc@765 109 serverOnly = [],
adamc@768 110 jsFuncs = [],
adamc@774 111 rewrites = #rewrites combined @ #rewrites urp,
adamc@769 112 filterUrl = #filterUrl combined @ #filterUrl urp,
adamc@866 113 filterMime = #filterMime combined @ #filterMime urp,
adamc@866 114 protocol = mergeWith #2 (#protocol combined, #protocol urp),
adamc@866 115 dbms = mergeWith #2 (#dbms combined, #dbms urp)
adamc@380 116 }
adamc@380 117
adamc@380 118 val parse = Compiler.run (Compiler.transform Compiler.parseUrp "Demo parseUrp")
adamc@380 119
adamc@380 120 fun capitalize "" = ""
adamc@380 121 | capitalize s = str (Char.toUpper (String.sub (s, 0)))
adamc@380 122 ^ String.extract (s, 1, NONE)
adamc@380 123
adamc@380 124 fun startUrp urp =
adamc@380 125 let
adamc@380 126 val base = OS.Path.base urp
adamc@380 127 val name = capitalize base
adamc@380 128
adamc@380 129 val () = (TextIO.output (demosOut, "<li> <a target=\"staging\" href=\"");
adamc@380 130 TextIO.output (demosOut, base);
adamc@380 131 TextIO.output (demosOut, ".html\">");
adamc@380 132 TextIO.output (demosOut, name);
adamc@380 133 TextIO.output (demosOut, "</a></li>\n"))
adamc@380 134
adamc@384 135 val () = (TextIO.output (urOut, " <li> <a link={");
adamc@384 136 TextIO.output (urOut, name);
adamc@384 137 TextIO.output (urOut, ".main ()}>");
adamc@384 138 TextIO.output (urOut, name);
adamc@384 139 TextIO.output (urOut, "</a></li>\n"))
adamc@384 140
adamc@380 141 val urp_file = OS.Path.joinDirFile {dir = dirname,
adamc@380 142 file = urp}
adamc@380 143
adamc@380 144 val out = OS.Path.joinBaseExt {base = base,
adamc@380 145 ext = SOME "html"}
adamc@380 146 val out = OS.Path.joinDirFile {dir = outDir,
adamc@380 147 file = out}
adamc@380 148 val out = TextIO.openOut out
adamc@380 149
adamc@501 150 val () = (TextIO.output (out, "<frameset rows=\"");
adamc@501 151 TextIO.output (out, if guided then
adamc@501 152 "*,100"
adamc@501 153 else
adamc@501 154 "50%,*");
adamc@501 155 TextIO.output (out, "\">\n");
adamc@380 156 TextIO.output (out, "<frame src=\"");
adamc@380 157 TextIO.output (out, prefix);
adamc@380 158 TextIO.output (out, "/");
adamc@380 159 TextIO.output (out, name);
adamc@380 160 TextIO.output (out, "/main\" name=\"showcase\">\n");
adamc@380 161 TextIO.output (out, "<frame src=\"");
adamc@380 162 TextIO.output (out, base);
adamc@380 163 TextIO.output (out, ".desc.html\">\n");
adamc@380 164 TextIO.output (out, "</frameset>\n");
adamc@380 165 TextIO.closeOut out)
adamc@380 166 val () = TextIO.closeOut out
adamc@380 167
adamc@380 168 val out = OS.Path.joinBaseExt {base = base,
adamc@380 169 ext = SOME "desc"}
adamc@380 170 val out = OS.Path.joinBaseExt {base = out,
adamc@380 171 ext = SOME "html"}
adamc@380 172 val out = TextIO.openOut (OS.Path.joinDirFile {dir = outDir,
adamc@380 173 file = out})
adamc@380 174 in
adamc@380 175 case parse (OS.Path.base urp_file) of
adamc@380 176 NONE => raise Fail ("Can't parse " ^ urp_file)
adamc@380 177 | SOME urpData =>
adamc@380 178 (TextIO.output (out, "<html><head>\n<title>");
adamc@380 179 TextIO.output (out, name);
adamc@380 180 TextIO.output (out, "</title>\n</head><body>\n\n<h1>");
adamc@380 181 TextIO.output (out, name);
adamc@380 182 TextIO.output (out, "</h1>\n\n<center>[ <a target=\"showcase\" href=\"");
adamc@382 183 TextIO.output (out, prefix);
adamc@382 184 TextIO.output (out, "/");
adamc@382 185 TextIO.output (out, name);
adamc@382 186 TextIO.output (out, "/main\">Application</a>");
adamc@382 187 TextIO.output (out, " | <a target=\"showcase\" href=\"");
adamc@380 188 TextIO.output (out, urp);
adamc@380 189 TextIO.output (out, ".html\"><tt>");
adamc@380 190 TextIO.output (out, urp);
adamc@380 191 TextIO.output (out, "</tt></a>");
adamc@380 192 app (fn file =>
adamc@380 193 let
adamc@380 194 fun ifEx s =
adamc@380 195 let
adamc@380 196 val src = OS.Path.joinBaseExt {base = file,
adamc@380 197 ext = SOME s}
adamc@380 198 val src' = OS.Path.file src
adamc@380 199 in
adamc@1151 200 if String.isPrefix (OS.Path.mkAbsolute {path = dirname,
adamc@1151 201 relativeTo = OS.FileSys.getDir ()}) src
adamc@943 202 andalso OS.FileSys.access (src, []) then
adamc@380 203 (TextIO.output (out, " | <a target=\"showcase\" href=\"");
adamc@380 204 TextIO.output (out, src');
adamc@380 205 TextIO.output (out, ".html\"><tt>");
adamc@380 206 TextIO.output (out, src');
adamc@380 207 TextIO.output (out, "</tt></a>"))
adamc@380 208 else
adamc@1156 209 ()
adamc@380 210 end
adamc@380 211 in
adamc@380 212 ifEx "urs";
adamc@380 213 ifEx "ur"
adamc@380 214 end) (#sources urpData);
adamc@380 215 TextIO.output (out, " ]</center>\n\n");
adamc@380 216
adamc@380 217 (urpData, out))
adamc@380 218 end
adamc@380 219
adamc@380 220 fun endUrp out =
adamc@380 221 (TextIO.output (out, "\n</body></html>\n");
adamc@380 222 TextIO.closeOut out)
adamc@380 223
adamc@380 224 fun readUrp (combined, out) =
adamc@380 225 let
adamc@380 226 fun finished () = endUrp out
adamc@380 227
adamc@380 228 fun readUrp' () =
adamc@380 229 case TextIO.inputLine inf of
adamc@384 230 NONE => (finished ();
adamc@384 231 combined)
adamc@380 232 | SOME line =>
adamc@380 233 if String.isSuffix ".urp\n" line then
adamc@380 234 let
adamc@380 235 val urp = String.substring (line, 0, size line - 1)
adamc@380 236 val (urpData, out) = startUrp urp
adamc@380 237 in
adamc@380 238 finished ();
adamc@380 239
adamc@380 240 readUrp (combiner (combined, urpData),
adamc@380 241 out)
adamc@380 242 end
adamc@380 243 else
adamc@380 244 (TextIO.output (out, line);
adamc@380 245 readUrp' ())
adamc@380 246 in
adamc@380 247 readUrp' ()
adamc@380 248 end
adamc@380 249
adamc@380 250 val indexFile = OS.Path.joinDirFile {dir = outDir,
adamc@380 251 file = "intro.html"}
adamc@380 252
adamc@380 253 val out = TextIO.openOut indexFile
adamc@380 254 val () = TextIO.output (out, "<html><head>\n<title>Ur/Web Demo</title>\n</head><body>\n\n")
adamc@380 255
adamc@380 256 fun readIndex () =
adamc@380 257 let
adamc@380 258 fun finished () = (TextIO.output (out, "\n</body></html>\n");
adamc@380 259 TextIO.closeOut out)
adamc@380 260 in
adamc@380 261 case TextIO.inputLine inf of
adamc@384 262 NONE => (finished ();
adamc@384 263 NONE)
adamc@380 264 | SOME line =>
adamc@380 265 if String.isSuffix ".urp\n" line then
adamc@380 266 let
adamc@380 267 val urp = String.substring (line, 0, size line - 1)
adamc@380 268 val (urpData, out) = startUrp urp
adamc@380 269 in
adamc@380 270 finished ();
adamc@380 271
adamc@384 272 SOME (readUrp (urpData,
adamc@384 273 out))
adamc@380 274 end
adamc@380 275 else
adamc@380 276 (TextIO.output (out, line);
adamc@380 277 readIndex ())
adamc@380 278 end
adamc@381 279
adamc@381 280 fun prettyPrint () =
adamc@381 281 let
adamc@381 282 val dir = Posix.FileSys.opendir dirname
adamc@381 283
adamc@381 284 fun loop () =
adamc@381 285 case Posix.FileSys.readdir dir of
adamc@381 286 NONE => Posix.FileSys.closedir dir
adamc@381 287 | SOME file =>
adamc@381 288 let
adamc@381 289 fun doit f =
adamc@381 290 f (OS.Path.joinDirFile {dir = dirname,
adamc@381 291 file = file},
adamc@382 292 OS.Path.mkAbsolute
adamc@382 293 {relativeTo = OS.FileSys.getDir (),
adamc@382 294 path = OS.Path.joinDirFile {dir = outDir,
adamc@382 295 file = OS.Path.joinBaseExt {base = file,
adamc@382 296 ext = SOME "html"}}})
adamc@382 297
adamc@382 298 fun highlight () =
adamc@382 299 doit (fn (src, html) =>
adamc@382 300 let
adamc@410 301 val dirty =
adamc@410 302 let
adamc@410 303 val srcSt = Posix.FileSys.stat src
adamc@410 304 val htmlSt = Posix.FileSys.stat html
adamc@410 305 in
adamc@410 306 Time.> (Posix.FileSys.ST.mtime srcSt,
adamc@410 307 Posix.FileSys.ST.mtime htmlSt)
adamc@410 308 end handle OS.SysErr _ => true
adamc@410 309
adamc@382 310 val cmd = "emacs --eval \"(progn "
adamc@382 311 ^ "(global-font-lock-mode t) "
adamc@382 312 ^ "(add-to-list 'load-path \\\""
adamc@382 313 ^ Config.sitelisp
adamc@382 314 ^ "/\\\") "
adamc@382 315 ^ "(load \\\"urweb-mode-startup\\\") "
adamc@382 316 ^ "(urweb-mode) "
adamc@382 317 ^ "(find-file \\\""
adamc@382 318 ^ src
adamc@382 319 ^ "\\\") "
adamc@382 320 ^ "(switch-to-buffer (htmlize-buffer)) "
adamc@382 321 ^ "(write-file \\\""
adamc@382 322 ^ html
adamc@382 323 ^ "\\\") "
adamc@382 324 ^ "(kill-emacs))\""
adamc@382 325 in
adamc@410 326 if dirty then
adamc@410 327 (print (">>> " ^ cmd ^ "\n");
adamc@410 328 ignore (OS.Process.system cmd))
adamc@410 329 else
adamc@410 330 ()
adamc@382 331 end)
adamc@381 332 in
adamc@384 333 if OS.Path.base file = "demo" then
adamc@384 334 ()
adamc@384 335 else case OS.Path.ext file of
adamc@384 336 SOME "urp" =>
adamc@384 337 doit (fn (src, html) =>
adamc@384 338 let
adamc@384 339 val inf = TextIO.openIn src
adamc@384 340 val out = TextIO.openOut html
adamc@381 341
adamc@384 342 fun loop () =
adamc@384 343 case TextIO.inputLine inf of
adamc@384 344 NONE => ()
adamc@384 345 | SOME line => (TextIO.output (out, line);
adamc@384 346 loop ())
adamc@384 347 in
adamc@384 348 TextIO.output (out, "<html><body>\n\n<pre>");
adamc@384 349 loop ();
adamc@384 350 TextIO.output (out, "</pre>\n\n</body></html>");
adamc@381 351
adamc@384 352 TextIO.closeIn inf;
adamc@384 353 TextIO.closeOut out
adamc@384 354 end)
adamc@384 355 | SOME "urs" => highlight ()
adamc@384 356 | SOME "ur" => highlight ()
adamc@384 357 | _ => ();
adamc@381 358 loop ()
adamc@381 359 end
adamc@381 360 in
adamc@381 361 loop ()
adamc@381 362 end
adamc@380 363 in
adamc@384 364 case readIndex () of
adamc@384 365 NONE => raise Fail "No demo applications!"
adamc@384 366 | SOME combined =>
adamc@384 367 let
adamc@384 368 val () = (TextIO.output (urOut, "</body></xml>\n");
adamc@384 369 TextIO.closeOut urOut)
adamc@384 370
adamc@384 371 val fname = OS.Path.joinDirFile {dir = dirname,
adamc@384 372 file = "demo.urp"}
adamc@384 373 val outf = TextIO.openOut fname
adamc@776 374
adamc@776 375 fun filters kind =
adamc@776 376 app (fn rule : Settings.rule =>
adamc@776 377 (TextIO.output (outf, case #action rule of
adamc@776 378 Settings.Allow => "allow"
adamc@776 379 | Settings.Deny => "deny");
adamc@776 380 TextIO.output (outf, " ");
adamc@776 381 TextIO.output (outf, kind);
adamc@776 382 TextIO.output (outf, " ");
adamc@776 383 TextIO.output (outf, #pattern rule);
adamc@776 384 case #kind rule of
adamc@776 385 Settings.Exact => ()
adamc@776 386 | Settings.Prefix => TextIO.output (outf, "*");
adamc@776 387 TextIO.output (outf, "\n")))
adamc@384 388 in
adamc@384 389 Option.app (fn db => (TextIO.output (outf, "database ");
adamc@384 390 TextIO.output (outf, db);
adamc@384 391 TextIO.output (outf, "\n")))
adamc@384 392 (#database combined);
adamc@384 393 TextIO.output (outf, "sql demo.sql\n");
adamc@385 394 TextIO.output (outf, "prefix ");
adamc@385 395 TextIO.output (outf, prefix);
adamc@385 396 TextIO.output (outf, "\n");
adamc@774 397 app (fn rule =>
adamc@774 398 (TextIO.output (outf, "rewrite ");
adamc@774 399 TextIO.output (outf, case #pkind rule of
adamc@774 400 Settings.Any => "any"
adamc@774 401 | Settings.Url => "url"
adamc@774 402 | Settings.Table => "table"
adamc@774 403 | Settings.Sequence => "sequence"
adamc@774 404 | Settings.View => "view"
adamc@774 405 | Settings.Relation => "relation"
adamc@774 406 | Settings.Cookie => "cookie"
adamc@774 407 | Settings.Style => "style");
adamc@774 408 TextIO.output (outf, " ");
adamc@774 409 TextIO.output (outf, #from rule);
adamc@774 410 case #kind rule of
adamc@774 411 Settings.Exact => ()
adamc@774 412 | Settings.Prefix => TextIO.output (outf, "*");
adamc@774 413 TextIO.output (outf, " ");
adamc@774 414 TextIO.output (outf, #to rule);
adamc@774 415 TextIO.output (outf, "\n"))) (#rewrites combined);
adamc@776 416 filters "url" (#filterUrl combined);
adamc@776 417 filters "mime" (#filterMime combined);
adamc@384 418 TextIO.output (outf, "\n");
adamc@384 419
adamc@384 420 app (fn s =>
adamc@384 421 let
adamc@384 422 val s = OS.Path.mkAbsolute {relativeTo = OS.FileSys.getDir (),
adamc@384 423 path = s}
adamc@384 424 in
adamc@384 425 TextIO.output (outf, s);
adamc@384 426 TextIO.output (outf, "\n")
adamc@384 427 end)
adamc@384 428 (#sources combined);
adamc@384 429 TextIO.output (outf, "\n");
adamc@384 430 TextIO.output (outf, "demo\n");
adamc@384 431
adamc@384 432 TextIO.closeOut outf;
adamc@384 433
adamc@1079 434 let
adamc@1079 435 val b = Compiler.compile (OS.Path.base fname)
adamc@1079 436 in
adamc@1079 437 TextIO.output (demosOut, "\n</body></html>\n");
adamc@1079 438 TextIO.closeOut demosOut;
adamc@1079 439 if b then
adamc@1079 440 prettyPrint ()
adamc@1079 441 else
adamc@1079 442 ();
adamc@1079 443 b
adamc@1079 444 end
adamc@1079 445 end
adamc@380 446 end
adamc@380 447
adamc@1079 448 fun make args = if make' args then
adamc@1079 449 ()
adamc@1079 450 else
adamc@1079 451 OS.Process.exit OS.Process.failure
adamc@1079 452
adamc@380 453 end