/usr/share/acl2-8.0dfsg/books/xdoc/prepare-topic.lisp is in acl2-books-source 8.0dfsg-1.
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 | ; XDOC Documentation System for ACL2
; Copyright (C) 2009-2015 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/
;
; License: (An MIT/X11-style license)
;
; Permission is hereby granted, free of charge, to any person obtaining a
; copy of this software and associated documentation files (the "Software"),
; to deal in the Software without restriction, including without limitation
; the rights to use, copy, modify, merge, publish, distribute, sublicense,
; and/or sell copies of the Software, and to permit persons to whom the
; Software is furnished to do so, subject to the following conditions:
;
; The above copyright notice and this permission notice shall be included in
; all copies or substantial portions of the Software.
;
; THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
; IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
; FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
; AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
; LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
; FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
; DEALINGS IN THE SOFTWARE.
;
; Original author: Jared Davis <jared@centtech.com>
(in-package "XDOC")
(include-book "base")
(include-book "std/osets/top" :dir :system)
(include-book "preprocess")
(include-book "parse-xml")
(include-book "xdoc-error")
(program)
(set-state-ok t)
(defun find-children-aux (par topics acc)
; At the top level, gather names of all xdoc topics in topics which have parent
; par. I.e., this finds the immediate children. In general, we accumulate
; those child names into acc; so at the top level, the child names will appear
; in the result in the reverse order from how they appear as names in topics.
(cond ((atom topics)
acc)
((member-eq par (cdr (assoc-eq :parents (car topics))))
(find-children-aux par
(cdr topics)
(cons (cdr (assoc-eq :name (car topics)))
acc)))
(t
(find-children-aux par (cdr topics) acc))))
(defun suborder-indicates-chronological-p (suborder)
; Returns true if and only if we are to list children in the order in which
; they were defined, rather than alphabetically.
(if (consp suborder)
(cdr (last suborder))
suborder))
(defun find-children (par all-topics suborder)
; Gather names of immediate children topics and sort them. Suborder is used
; for deciding whether to sort alphabetically or by order of appearance in
; all-topics (last ones first, where if a name is duplicated then its most
; recent appearance in all-topics (i.e., closest to the front of the list) is
; the significant one).
; Note that defxdoc (actually defxdoc-fn) pushes a new entry on the front of
; the xdoc table fetched by get-xdoc-table, which is called by all-xdoc-topics
; (in xdoc/defxdoc-raw-impl.lsp), which is called by the xdoc macro in
; xdoc/top.lisp. Presumably other utilities, not just defxdoc, also push new
; topics on the front of the xdoc table. So we assume that all-topics has the
; most recent entries at the front.
(let ((children-names ; ordered as per comment above on "name is duplicated"
(find-children-aux par all-topics nil)))
(cond ((suborder-indicates-chronological-p suborder)
(remove-duplicates-eq children-names))
(t (mergesort children-names)))))
(defconst *xml-entity-stuff*
"<!DOCTYPE xdoc [
<!ENTITY ndash \"–\">
<!ENTITY mdash \"—\">
<!ENTITY rarr \"→\">
<!ENTITY nbsp \" \">
<!ENTITY lsquo \"‘\">
<!ENTITY rsquo \"’\">
<!ENTITY ldquo \"“\">
<!ENTITY rdquo \"”\">
]>
")
(defun gather-topic-names (x)
(if (atom x)
nil
(cons (cdr (assoc :name (car x)))
(gather-topic-names (cdr x)))))
(defun topics-fal (x)
(make-fast-alist (pairlis$ (gather-topic-names x) x)))
; ------------------ Making Flat Indexes ------------------------
(defun index-add-topic (x topics-fal disable-autolinking-p index-pkg state acc)
; X is a single topic entry in the xdoc table. Index-pkg says the base package
; for symbols seen from 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 name topics-fal disable-autolinking-p 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 topics-fal disable-autolinking-p index-pkg state
acc)
; X is a list of topics. Index-pkg says the base package for these symbols.
(b* (((when (atom x))
(mv acc state))
((mv acc state)
(index-add-topic (car x) topics-fal disable-autolinking-p index-pkg
state acc)))
(index-add-topics (cdr x) topics-fal disable-autolinking-p index-pkg state
acc)))
(defun index-topics (x title topics-fal disable-autolinking-p 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 topics-fal disable-autolinking-p
index-pkg state acc))
(acc (str::revappend-chars "</index>" acc))
(acc (cons #\Newline acc)))
(mv acc state)))
(defun add-parents (parents base-pkg acc)
(b* (((when (atom parents))
acc)
(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 topics-fal)
; Given a list of topic names, get their entries. Requires that all topics
; exist!
(b* (((when (atom names))
nil)
(look (hons-get (car names) topics-fal))
((unless look)
(er hard? 'gather-topics "Failed to find topic ~x0." (car names))))
(cons (cdr look)
(gather-topics (cdr names) topics-fal))))
(defun check-topic-syntax (x)
(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)))
(suborder (cdr (assoc :suborder x)))
(ctx 'check-topic-syntax)
((unless (symbolp name))
(er hard? ctx "Name is not a symbol: ~x0" x))
((unless (symbolp base-pkg))
(er hard? ctx "Base-pkg is not a symbol: ~x0" x))
((unless (symbol-listp parents))
(er hard? ctx "Parents are not a symbol-listp: ~x0" x))
((unless (stringp short))
(er hard? ctx "Short is not a string or nil: ~x0" x))
((unless (stringp long))
(er hard? ctx "Long is not a string or nil: ~x0" x))
((unless (symbol-listp (fix-true-list suborder)))
(er hard? ctx "Suborder list contains a non-symbol: ~x0" x)))
t))
(defun apply-suborder (suborder children-names)
;; should return some permutation of children-names
(cond ((atom suborder)
children-names)
((member (car suborder) children-names)
(cons (car suborder)
(apply-suborder (cdr suborder)
(remove (car suborder) children-names))))
(t
(apply-suborder (cdr suborder) children-names))))
(defun gentle-subsetp-eq (x y)
; This is just subsetp-eq, except that x need not be a true-list.
(cond ((atom x) t)
((member-eq (car x) y)
(gentle-subsetp-eq (cdr x) y))
(t nil)))
(defun preprocess-topic (x all-topics topics-fal disable-autolinking-p state)
(b* ((- (check-topic-syntax x))
(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)))
(suborder (cdr (assoc :suborder 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.xsl\"?>" acc))
(acc (cons #\Newline acc))
(acc (str::revappend-chars *xml-entity-stuff* 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))
((mv short-acc state)
(preprocess-main short name
topics-fal disable-autolinking-p
base-pkg state nil))
(short-str (str::rchars-to-string short-acc))
((mv err &) (parse-xml short-str))
(state
(if (and err (xdoc-verbose-p))
(pprogn
; The following message formerly started with "WARNING" instead of "; xdoc
; error". But we want to be consistent with the macro xdoc-error, to make it
; easy for users to search for a single string in the error log, namely, "xdoc
; error". For the user, the difference between parsing errors and preprocessor
; errors seems small, not worth requiring searching for two different things.
(prog2$ (note-xdoc-error) state)
(fms "~|~%; xdoc error: problem with :short in topic ~x0:~%"
(list (cons #\0 name))
*standard-co* state nil)
(princ$ err *standard-co* state)
(fms "~%~%" nil *standard-co* state nil))
state))
(acc (b* (((unless err)
(append short-acc acc))
(acc (str::revappend-chars "<b>Markup error in :short: </b><code>" acc))
(acc (simple-html-encode-str err 0 (length err) acc))
(acc (str::revappend-chars "</code>" acc)))
acc))
(acc (str::revappend-chars "</short>" acc))
(acc (cons #\Newline acc))
(acc (str::revappend-chars "<long>" acc))
((mv long-acc state)
(preprocess-main long name
topics-fal disable-autolinking-p
base-pkg state nil))
(long-str (str::rchars-to-string long-acc))
((mv err &) (parse-xml long-str))
(state
(if (and err (xdoc-verbose-p))
(pprogn
(prog2$ (note-xdoc-error) state)
; See comment above regarding the use of "; xdoc error" instead of "WARNING"
; just below.
(fms "~|~%; xdoc error: problem with :long in topic ~x0:~%"
(list (cons #\0 name))
*standard-co* state nil)
(princ$ err *standard-co* state)
(fms "~%~%" nil *standard-co* state nil))
state))
(acc (b* (((unless err)
(append long-acc acc))
(acc (str::revappend-chars "<h3>Markup error in :long</h3><code>" acc))
(acc (simple-html-encode-str err 0 (length err) acc))
(acc (str::revappend-chars "</code>" acc)))
acc))
(acc (str::revappend-chars "</long>" acc))
(acc (cons #\Newline acc))
(children-names
;; note: all children-names are known to be existing topics, since
;; otherwise we wouldn't have found them. topics mentioned in
;; suborder, however, may not exist
(find-children name all-topics suborder))
(- (and (xdoc-verbose-p)
(not (gentle-subsetp-eq suborder children-names))
(cw "~|~%WARNING: in topic ~x0, subtopic order mentions topics that ~
are not children: ~&1.~%"
name (set-difference$ (fix-true-list suborder) children-names))))
(children-names
;; this returns a permutation of the original children-names, so they
;; must all exist
(apply-suborder suborder children-names))
(children-topics
;; safe to call gather-topics because we know all children-names exist.
(gather-topics children-names topics-fal))
((mv acc state)
(if (not children-topics)
(mv acc state)
(index-topics children-topics "Subtopics"
topics-fal disable-autolinking-p
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 (str::rchars-to-string acc) state)))
|