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
|
; 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>
; base.lisp -- This file is only intended mainly to avoid a circular dependence
; between top.lisp and topics.lisp. Ordinary users should include top.lisp
; instead.
(in-package "XDOC")
(set-state-ok t)
(table xdoc 'doc nil)
(table xdoc 'default-parents nil)
(table xdoc 'post-defxdoc-event nil)
(table xdoc 'resource-dirs nil)
(defun get-xdoc-table (world)
(declare (xargs :mode :program))
(cdr (assoc-eq 'doc (table-alist 'xdoc world))))
(defmacro set-default-parents (&rest parents)
`(table xdoc 'default-parents
(let ((parents ',parents))
(cond ((symbol-listp parents)
parents)
((and (consp parents)
(atom (cdr parents))
(symbol-listp (car parents)))
(car parents))
(t
(er hard? 'set-default-parents
"Expected a symbol-listp, but found ~x0" parents))))))
(defun get-default-parents (world)
(declare (xargs :mode :program))
(cdr (assoc-eq 'default-parents (table-alist 'xdoc world))))
(defun check-defxdoc-args (name parents short long pkg)
(declare (xargs :guard t))
(or (and (not (symbolp name))
"name is not a symbol!")
(and (not (symbol-listp parents))
":parents are not a symbol list")
(and short (not (stringp short))
":short is not a string (or nil)")
(and long (not (stringp long))
":long is not a string (or nil)")
(and pkg (or (not (stringp pkg)) (equal pkg "") (not (pkg-witness pkg)))
":pkg is not a string that is a known package (or nil)")))
(defun guard-for-defxdoc (name parents short long pkg)
(declare (xargs :guard t))
(let* ((err (check-defxdoc-args name parents short long pkg)))
(or (not err)
(cw "~s0~%" err))))
(defun normalize-bookname (bookname state)
(let* ((dir-system (acl2::f-get-global 'acl2::system-books-dir state))
(lds (length dir-system)))
;; Eventually we could do something fancier to support
;; add-include-book-dirs, but this is probably fine for the Community
;; Books, at least.
(if (and (stringp dir-system)
(stringp bookname)
(<= lds (length bookname))
(equal dir-system (subseq bookname 0 lds)))
(concatenate 'string "[books]/"
(subseq bookname lds nil))
bookname)))
(defun defxdoc-fn (name parents short long pkg no-override state)
(declare (xargs :mode :program :stobjs state))
(let* ((err (check-defxdoc-args name parents short long pkg)))
(if err
(er hard? 'defxdoc
"Bad defxdoc arguments: ~s0" err)
(let* ((world (w state))
(pkg (or pkg (acl2::f-get-global 'acl2::current-package state)))
(info (acl2::f-get-global 'acl2::certify-book-info state))
(bookname (if info
(acl2::access acl2::certify-book-info info :full-book-name)
"Current Interactive Session"))
(bookname (normalize-bookname bookname state))
(parents (or parents (get-default-parents (w state))))
(entry (list (cons :name name)
(cons :base-pkg (acl2::pkg-witness pkg))
(cons :parents parents)
(cons :short short)
(cons :long long)
(cons :from bookname)))
(table-event
`(table xdoc 'doc
,(if no-override
`(let ((topics (get-xdoc-table world)))
(if (find-topic ',name topics)
topics
(cons ',entry topics)))
`(cons ',entry (get-xdoc-table world)))))
(post-event
(cdr (assoc-eq 'post-defxdoc-event (table-alist 'xdoc world)))))
`(progn
,table-event
,@(and post-event (list post-event))
(value-triple '(defxdoc ,name)))))))
(defmacro defxdoc (name &key parents short long pkg no-override)
`(with-output :off (event summary)
(make-event
(defxdoc-fn ',name ',parents ,short ,long ,pkg ,no-override state))))
(defun defxdoc-raw-fn (name parents short long pkg)
(declare (xargs :guard t)
(ignore name parents short long pkg))
(er hard? 'defxdoc-raw-fn
"Under-the-hood definition of defxdoc-raw-fn not installed. You ~
probably need to load the defxdoc-raw book."))
(defun defxdoc-raw-after-check (name parents short long pkg)
(let* ((err (check-defxdoc-args name parents short long pkg)))
(if err
(er hard? 'defxdoc-raw
"Bad defxdoc-raw arguments: ~s0~%" err)
(defxdoc-raw-fn name parents short long pkg))))
(defmacro defxdoc-raw (name &key parents short long pkg)
`(defxdoc-raw-after-check ',name ',parents ,short ,long ,pkg))
(defun find-topic (name x)
(declare (xargs :mode :program))
; 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)))))
|
