/usr/share/acl2-4.3/books/xdoc/save.lisp is in acl2-books-source 4.3-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 | ; XDOC Documentation System for ACL2
; Copyright (C) 2009-2011 Centaur Technology
;
; Contact:
; Centaur Technology Formal Verification Group
; 7600-C N. Capital of Texas Highway, Suite 300, Austin, TX 78731, USA.
; http://www.centtech.com/
;
; This program is free software; you can redistribute it and/or modify it under
; the terms of the GNU General Public License as published by the Free Software
; Foundation; either version 2 of the License, or (at your option) any later
; version. This program is distributed in the hope that it will be useful but
; WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
; FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
; more details. You should have received a copy of the GNU General Public
; License along with this program; if not, write to the Free Software
; Foundation, Inc., 51 Franklin Street, Suite 500, Boston, MA 02110-1335, USA.
;
; Original author: Jared Davis <jared@centtech.com>
; save.lisp
;
; This file defines the XDOC functions for running the preprocessor and saving
; XML files. Note that the save-topics command we introduce cannot actually be
; used unless the mkdir-raw book is loaded first. This is automatically handled
; by the "save" macro in top.lisp.
(in-package "XDOC")
(include-book "mkdir")
(include-book "base")
(include-book "preprocess")
(include-book "parse-xml")
(include-book "tools/progndollar" :dir :system)
(include-book "finite-set-theory/osets/sets" :dir :system)
(set-state-ok t)
(defun cw-princ$ (str)
;; Same as princ$ to *standard-co*, but doesn't require state.
(declare (xargs :guard t))
(mbe :logic nil
:exec
(wormhole 'cw-raw-wormhole
'(lambda (whs) whs)
nil
`(let ((state (princ$ ',str *standard-co* state)))
(value :q))
:ld-prompt nil
:ld-pre-eval-print nil
:ld-post-eval-print nil
:ld-verbose nil)))
(program)
; --------------------- File Copying ----------------------------
(defun stupid-copy-file-aux (in out state)
; In, out are channels. Copy from in to out, one byte at a time.
(mv-let (byte state)
(read-byte$ in state)
(if (not byte)
state
(let ((state (write-byte$ byte out state)))
(stupid-copy-file-aux in out state)))))
(defun stupid-copy-file (src dest state)
; A stupid file copy routine, so we can copy our style files, etc. We avoid
; using "system" because of memory problems with forking on huge images.
(b* (((mv in state) (open-input-channel src :byte state))
((mv out state) (open-output-channel dest :byte state))
(state (stupid-copy-file-aux in out state))
(state (close-input-channel in state))
(state (close-output-channel out state)))
state))
(defun stupid-copy-files (srcdir filenames destdir state)
(if (atom filenames)
state
(b* ((srcfile (acl2::extend-pathname srcdir (car filenames) state))
(destfile (acl2::extend-pathname destdir (car filenames) state))
(state (stupid-copy-file srcfile destfile state)))
(stupid-copy-files srcdir (cdr filenames) destdir state))))
; ---------------- Hierarchical Index Generation ----------------
(defun normalize-parents (x)
; Given an xdoc entry, remove duplicate parents and self-parents.
(let* ((name (cdr (assoc :name x)))
(parents (cdr (assoc :parents x)))
(orig parents)
(parents (if (member-equal name parents)
(prog2$
(cw "; xdoc note: removing self-referencing :parents entry for ~x0.~%" name)
(remove-equal name parents))
parents))
(parents (if (no-duplicatesp-equal parents)
parents
(prog2$
(cw "; xdoc note: removing duplicate :parents for ~x0.~%" name)
(remove-duplicates-equal parents)))))
(if (equal parents orig)
x
(acons :parents parents x))))
(defun normalize-parents-list (x)
; Clean up parents throughout all xdoc topics.
(if (atom x)
nil
(cons (normalize-parents (car x))
(normalize-parents-list (cdr x)))))
(defun find-roots (x)
; Gather names of all doc topics which have no parents.
(if (atom x)
nil
(if (not (cdr (assoc :parents (car x))))
(cons (cdr (assoc :name (car x)))
(find-roots (cdr x)))
(find-roots (cdr x)))))
(defun find-children-aux (par x)
; Gather names of all xdoc topics in x which have parent par. I.e., this finds
; the immediate children.
(if (atom x)
nil
(if (member-equal par (cdr (assoc :parents (car x))))
(cons (cdr (assoc :name (car x)))
(find-children-aux par (cdr x)))
(find-children-aux par (cdr x)))))
(defun find-children (par x)
; Gather names of immediate children topics and sort them.
(sets::mergesort (find-children-aux par x)))
(defun find-topic (name x)
; Look up a particular topic by name in the list of topics.
(if (atom x)
nil
(if (equal (cdr (assoc :name (car x))) name)
(car x)
(find-topic name (cdr x)))))
(mutual-recursion
(defun make-hierarchy-aux (path dir index-pkg all id expand-level acc state)
; - Path is our current location in the hierarchy, and is used to avoid loops.
; (The first element in path is the current topic we are on.)
;
; - Index-pkg is just used for symbol printing.
;
; - All is the list of all xdoc documentation topics.
;
; - ID is a number that we assign to this topic entry for hiding with
; JavaScript. (We don't use names because the topics might be repeated under
; different parents).
;
; - Expand-level is how deep to expand topics, generally 1 by default.
;
; - Acc is the character list we are building.
;
; We return (MV ACC-PRIME ID-PRIME STATE)
(b* ((name (car path))
(id-chars (list* #\t #\o #\p #\i #\c #\- (explode-atom id 10)))
(depth (len path))
(children (find-children name all))
(kind (cond ((not children) "leaf")
((< depth expand-level) "show")
(t "hide")))
((when (member-equal name (cdr path)))
(prog2$
(er hard? 'make-hierarchy "Circular topic hierarchy. Path is ~x0.~%" path)
(mv acc id state)))
(topic (find-topic name all))
(short (cdr (assoc :short topic)))
(base-pkg (cdr (assoc :base-pkg topic)))
(acc (str::revappend-chars "<hindex topic=\"" acc))
(acc (file-name-mangle name acc))
(acc (str::revappend-chars "\" id=\"" acc))
(acc (revappend id-chars acc))
(acc (str::revappend-chars "\" kind=\"" acc))
(acc (str::revappend-chars kind acc))
(acc (str::revappend-chars "\">" acc))
(acc (cons #\Newline acc))
(acc (str::revappend-chars "<hindex_name>" acc))
(acc (sym-mangle-cap name index-pkg acc))
(acc (str::revappend-chars "</hindex_name>" acc))
(acc (cons #\Newline acc))
(acc (str::revappend-chars "<hindex_short id=\"" acc))
(acc (revappend id-chars acc))
(acc (str::revappend-chars "\">" acc))
((mv acc state) (preprocess-main short dir base-pkg state acc))
(acc (str::revappend-chars "</hindex_short>" acc))
(acc (str::revappend-chars "<hindex_children id=\"" acc))
(acc (revappend id-chars acc))
(acc (str::revappend-chars "\" kind=\"" acc))
(acc (str::revappend-chars kind acc))
(acc (str::revappend-chars "\">" acc))
(acc (cons #\Newline acc))
(id (+ id 1))
((mv acc id state)
(make-hierarchy-list-aux children path dir index-pkg all id expand-level acc state))
(acc (str::revappend-chars "</hindex_children>" acc))
(acc (str::revappend-chars "</hindex>" acc))
(acc (cons #\Newline acc)))
(mv acc id state)))
(defun make-hierarchy-list-aux (children path dir index-pkg all id expand-level acc state)
; - Children are the children of this path.
; - Path is our current location in the hierarchy.
(if (atom children)
(mv acc id state)
(b* (((mv acc id state)
(make-hierarchy-aux (cons (car children) path) dir index-pkg all id
expand-level acc state))
((mv acc id state)
(make-hierarchy-list-aux (cdr children) path dir index-pkg all id
expand-level acc state)))
(mv acc id state)))))
(defun save-hierarchy (x dir index-pkg expand-level state)
; X is all topics. We assume all parents are normalized.
(b* ((roots (sets::mergesort (find-roots x)))
(acc nil)
(acc (str::revappend-chars "<?xml version=\"1.0\" encoding=\"UTF-8\"?>" acc))
(acc (cons #\Newline acc))
(acc (str::revappend-chars "<?xml-stylesheet type=\"text/xsl\" href=\"xml-topic-index.xsl\"?>" acc))
(acc (cons #\Newline acc))
(acc (str::revappend-chars "<page>" acc))
(acc (cons #\Newline acc))
(acc (str::revappend-chars "<hindex_root>" acc))
(acc (cons #\Newline acc))
((mv acc & state) (make-hierarchy-list-aux roots nil dir index-pkg x 0
expand-level acc state))
(acc (str::revappend-chars "</hindex_root>" acc))
(acc (cons #\Newline acc))
(acc (str::revappend-chars "</page>" acc))
(acc (cons #\Newline acc))
(filename (acl2::extend-pathname dir "topics.xml" state))
((mv channel state) (open-output-channel filename :character state))
(state (princ$ (reverse (coerce acc 'string)) channel state))
(state (close-output-channel channel state)))
state))
; ------------------ Making Flat Indexes ------------------------
(defun index-add-topic (x dir index-pkg state acc)
; X is a single topic entry in the xdoc table. Index-pkg says the base package
; for symbols seen frmo the index.
(b* ((name (cdr (assoc :name x)))
(short (cdr (assoc :short x)))
(base-pkg (cdr (assoc :base-pkg x)))
(acc (str::revappend-chars "<index_entry>" acc))
(acc (cons #\Newline acc))
(acc (str::revappend-chars "<index_head><see topic=\"" acc))
(acc (file-name-mangle name acc))
(acc (str::revappend-chars "\">" acc))
(acc (sym-mangle-cap name index-pkg acc))
(acc (str::revappend-chars "</see>" acc))
(acc (str::revappend-chars "</index_head>" acc))
(acc (cons #\Newline acc))
(acc (str::revappend-chars "<index_body>" acc))
(acc (cons #\Newline acc))
((mv acc state) (preprocess-main short dir base-pkg state acc))
(acc (cons #\Newline acc))
(acc (str::revappend-chars "</index_body>" acc))
(acc (cons #\Newline acc))
(acc (str::revappend-chars "</index_entry>" acc))
(acc (cons #\Newline acc)))
(mv acc state)))
(defun index-add-topics (x dir index-pkg state acc)
; X is a list of topics. Index-pkg says the base package for these symbols.
(if (atom x)
(mv acc state)
(b* (((mv acc state) (index-add-topic (car x) dir index-pkg state acc)))
(index-add-topics (cdr x) dir index-pkg state acc))))
(defun index-topics (x title dir index-pkg state acc)
; X is a list of topics. Generate <index>...</index> for these topics and
; add to acc.
(b* ((acc (str::revappend-chars "<index title=\"" acc))
(acc (str::revappend-chars title acc))
(acc (str::revappend-chars "\">" acc))
(acc (cons #\Newline acc))
((mv acc state) (index-add-topics x dir index-pkg state acc))
(acc (str::revappend-chars "</index>" acc))
(acc (cons #\Newline acc)))
(mv acc state)))
(defun save-index (x dir index-pkg state)
; Write index.xml for the whole list of all topics.
(b* ((acc nil)
(acc (str::revappend-chars "<?xml version=\"1.0\" encoding=\"UTF-8\"?>" acc))
(acc (cons #\Newline acc))
(acc (str::revappend-chars "<?xml-stylesheet type=\"text/xsl\" href=\"xml-full-index.xsl\"?>" acc))
(acc (cons #\Newline acc))
(acc (str::revappend-chars "<page>" acc))
(acc (cons #\Newline acc))
((mv acc state) (index-topics x "Full Index" dir index-pkg state acc))
(acc (str::revappend-chars "</page>" acc))
(filename (acl2::extend-pathname dir "index.xml" state))
((mv channel state) (open-output-channel filename :character state))
(state (princ$ (reverse (coerce acc 'string)) channel state))
(state (close-output-channel channel state)))
state))
; -------------------- Making Topic Pages -----------------------
(defun add-parents (parents base-pkg acc)
(if (atom parents)
acc
(let* ((acc (str::revappend-chars "<parent topic=\"" acc))
(acc (file-name-mangle (car parents) acc))
(acc (str::revappend-chars "\">" acc))
(acc (sym-mangle-cap (car parents) base-pkg acc))
(acc (str::revappend-chars "</parent>" acc))
(acc (cons #\Newline acc)))
(add-parents (cdr parents) base-pkg acc))))
(defun gather-topics (names all-topics)
; Given a list of topic names, get their entries from the list of all topics.
(cond ((atom all-topics)
nil)
((member (cdr (assoc :name (car all-topics))) names)
(cons (car all-topics)
(gather-topics names (cdr all-topics))))
(t
(gather-topics names (cdr all-topics)))))
(defun preprocess-topic (x all-topics dir state)
(b* ((name (cdr (assoc :name x)))
(base-pkg (cdr (assoc :base-pkg x)))
(short (or (cdr (assoc :short x)) ""))
(long (or (cdr (assoc :long x)) ""))
(parents (cdr (assoc :parents x)))
((unless (symbolp name))
(mv (er hard? 'preprocess-topic "Name is not a string: ~x0.~%" x)
state))
((unless (symbolp base-pkg))
(mv (er hard? 'preprocess-topic "Base-pkg is not a symbol: ~x0.~%" base-pkg)
state))
((unless (symbol-listp parents))
(mv (er hard? 'preprocess-topic "Parents are not a symbol-listp: ~x0.~%" x)
state))
((unless (stringp short))
(mv (er hard? 'preprocess-topic "Short is not a string: ~x0.~%" x)
state))
((unless (stringp long))
(mv (er hard? 'preprocess-topic "Long is not a string: ~x0.~%" x)
state))
(acc nil)
(acc (str::revappend-chars "<?xml version=\"1.0\" encoding=\"UTF-8\"?>" acc))
(acc (cons #\Newline acc))
(acc (str::revappend-chars "<?xml-stylesheet type=\"text/xsl\" href=\"xml-topic.xsl\"?>" acc))
(acc (cons #\Newline acc))
(acc (str::revappend-chars "<page>" acc))
(acc (str::revappend-chars "<topic name=\"" acc))
(acc (sym-mangle-cap name base-pkg acc))
(acc (str::revappend-chars "\">" acc))
(acc (cons #\Newline acc))
(acc (add-parents parents base-pkg acc))
(acc (cons #\Newline acc))
(acc (str::revappend-chars "<short>" acc))
;; Previously: ((mv acc state) (preprocess-main short dir base-pkg state acc))
((mv short-acc state) (preprocess-main short dir base-pkg state nil))
(short-str (reverse (coerce short-acc 'string)))
(acc (append short-acc acc))
((mv err &) (parse-xml short-str))
(- (or (not err)
(acl2::progn$
(cw "~|~%WARNING: problem with :short in topic ~x0:~%" name)
(cw-princ$ err)
(cw "~%~%"))))
(acc (str::revappend-chars "</short>" acc))
(acc (cons #\Newline acc))
(acc (str::revappend-chars "<long>" acc))
;; Previously: ((mv acc state) (preprocess-main long dir base-pkg state acc))
((mv long-acc state) (preprocess-main long dir base-pkg state nil))
(long-str (reverse (coerce long-acc 'string)))
(acc (append long-acc acc))
((mv err &) (parse-xml long-str))
(- (or (not err)
(acl2::progn$
(cw "~|~%WARNING: problem with :long in topic ~x0:~%" name)
(cw-princ$ err)
(cw "~%~%"))))
(acc (str::revappend-chars "</long>" acc))
(acc (cons #\Newline acc))
(children (find-children name all-topics))
(topics (gather-topics children all-topics))
((mv acc state) (if (not topics)
(mv acc state)
(index-topics topics "Subtopics" dir base-pkg state acc)))
(acc (str::revappend-chars "</topic>" acc))
(acc (cons #\Newline acc))
(acc (str::revappend-chars "</page>" acc))
(acc (cons #\Newline acc)))
(mv (reverse (coerce acc 'string)) state)))
(defun save-topic (x all-topics dir state)
(b* ((name (cdr (assoc :name x)))
(- (cw "Saving ~s0::~s1.~%" (symbol-package-name name) (symbol-name name)))
((mv text state) (preprocess-topic x all-topics dir state))
(filename (concatenate 'string
(reverse (coerce (file-name-mangle name nil) 'string))
".xml"))
(fullpath (acl2::extend-pathname dir filename state))
((mv channel state) (open-output-channel fullpath :character state))
(state (princ$ text channel state))
(state (close-output-channel channel state)))
state))
(defun save-topics-aux (x all-topics dir state)
(if (atom x)
state
(let ((state (save-topic (car x) all-topics dir state)))
(save-topics-aux (cdr x) all-topics dir state))))
(defun save-success-file (ntopics dir state)
(b* ((file (acl2::extend-pathname dir "success.txt" state))
((mv out state) (open-output-channel file :character state))
((mv & state) (fmt "Successfully wrote ~x0 topics.~%~%"
(list (cons #\0 ntopics))
out state nil))
(state (close-output-channel out state)))
state))
(defun prepare-dir (dir state)
(b* (((unless (stringp dir))
(prog2$ (er hard? 'prepare-dir "Dir must be a string, but is: ~x0.~%" dir)
state))
(- (cw "; Preparing directory ~s0.~%" dir))
(dir/xml (acl2::extend-pathname dir "xml" state))
(state (mkdir dir state))
(state (mkdir dir/xml state))
;; (dir/support (acl2::extend-pathname dir "support" state))
;; (state (mkdir dir/support state))
(xdoc/support (acl2::extend-pathname *xdoc-dir* "support" state))
;; We copy support/Makefile-trans to dir/Makefile. The "-trans" part of
;; its name is just to prevent people from thinking they can type "make"
;; in the support directory to accomplish anything.
(Makefile-trans (acl2::extend-pathname xdoc/support "Makefile-trans" state))
(Makefile-out (acl2::extend-pathname dir "Makefile" state))
(state (stupid-copy-file Makefile-trans Makefile-out state))
(state (stupid-copy-files xdoc/support
(list "xdoc.css"
"xdoc.js"
"plus.png"
"minus.png"
"leaf.png"
"text-topic.xsl"
"html-core.xsl"
"html-topic.xsl"
"html-full-index.xsl"
"html-brief-index.xsl"
"html-topic-index.xsl"
"xml-topic.xsl"
"xml-topic-index.xsl"
"xml-full-index.xsl")
dir/xml state))
(state (stupid-copy-files xdoc/support
(list "frames2.html"
"frames3.html"
"preview.html")
dir state)))
state))
(defun save-topics (x dir index-pkg expand-level state)
(b* ((state (prepare-dir dir state))
(dir (acl2::extend-pathname dir "xml" state))
(- (cw "; Processing ~x0 topics.~%" (len x)))
;; Note: generate the index after the topic files, so that
;; errors in short messages will be seen there.
(x (time$ (normalize-parents-list x)
:msg "; Normalizing parents: ~st sec, ~sa bytes~%"
:mintime 1/2))
(state (time$ (save-topics-aux x x dir state)
:msg "; Saving topics: ~st sec, ~sa bytes~%"
:mintime 1/2))
(state (time$ (save-index x dir index-pkg state)
:msg "; Saving flat index: ~st sec, ~sa bytes~%"
:mintime 1/2))
(state (time$ (save-hierarchy x dir index-pkg expand-level state)
:msg "; Saving hierarchical index: ~st sec, ~sa bytes~%"))
(state (save-success-file (len x) dir state)))
state))
|