File: variable.lisp

package info (click to toggle)
albert 0.4.10.1
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 1,556 kB
  • ctags: 2,014
  • sloc: lisp: 13,587; ansic: 7,729; xml: 843; makefile: 99; sh: 28
file content (216 lines) | stat: -rw-r--r-- 6,347 bytes parent folder | download | duplicates (2)
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
;;; -*- Mode: Lisp; Syntax: ANSI-Common-Lisp; Package: SPRES-IMPL -*-

#|

DESC: spres/rules/variable.lisp - the rules for methods
Copyright (c) 2000-2001 - Stig Erik Sand

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.

|#

(in-package :spres-impl)


(def-rule-info 
    ((:key :full-variable/docbook)
     (:name present-object)
     (:desc "Presents a full variable.")
     (:req
      (?class sdoc-variable)
      (?document-type docbook-document)
      (?context (eql :full))
;;      (eq ?prog-lang :java)
      ;; assertion, we should be below a class, ie a refsect1
      ;; move later to a real assertion?
      ;;(eq ?rec-state :refsect1)
      )
     
     (:variation :never-print-execute)
     )
    
    ;; assertion, we should be below a class, ie a refsect1
    (unless (or (eq ?rec-state :refsect1)
		(eq ?rec-state :refsect2))
      (warn "Weird recstate for variable: ~s" ?rec-state)
      (return-from present-object nil))


    (let* ((obj-name (get-object-name obj))
	   (doc-list (slot-value obj 'doc))
	   (not-wanted (list "mod" "type"))
	   (info-list (get-info-except-types (slot-value obj 'info)
					     not-wanted))
	   (loc-list (slot-value obj 'location))
	   (show-loc (and loc-list (tl-show-location? :variable)))
	   (formal-pres nil)
	   (exportclass "")
	   (experiment t)
	   )

      (when (or doc-list info-list)
	(setf formal-pres t))
      
      (when (and show-loc (not (has-spres-flag? :dont-print-location)))
	(setf formal-pres t))

      (when (is-exported? obj obj-name)
	(setf exportclass " class=\"exported\""))

      
      (when (or formal-pres experiment)
	;; hack
	(unless obj-name
	  (setq obj-name "{not named}"))
	(put doc
	     " <formalpara" exportclass ">" (eol)
	     "  <title>"
	     (get-simple-anchor doc (make-obj-id doc obj ?parent))
	     obj-name
	     "  </title>" (eol)))
      
      (put doc "  <para>" (eol))
      (tree-put doc `(:programlisting nil
		      ,(get-variable-signature doc obj :linked nil :style :intuitive)))

      
      (when formal-pres
	(put doc
	     "   <variablelist>" (eol)
	     "    <title></title>" (eol))
	(db-present-doc-list  doc-list doc :variable :suppress-wrapper t)
	(unless (has-spres-flag? :dont-print-location)
	  (db-print-location loc-list doc :variable :suppress-wrapper t))
        (db-present-info-list info-list doc :variable :suppress-wrapper t)
        (put doc "   </variablelist>" (eol)))
      
      (put doc "  </para>" (eol))
      (when (or formal-pres experiment)
	(put doc " </formalpara>" (eol)))
      ))


;; this is a quick rip of the above rule, replace later
(def-rule-info 
    ((:key :full-typespec/docbook)
     (:name present-object)
     (:desc "Presents a full typespec.")
     (:req
      (?class sdoc-typespec)
      (?document-type docbook-document)
      (?context (eql :full))
      ;;(eq ?rec-state :refsect1)
      )
     (:variation
      :never-print-execute))

    ;; assertion, we should be below a class, ie a refsect1
    (unless (eq ?rec-state :refsect1)
      ;;(warn "Weird recstate for typespec: ~s" ?rec-state)
      (return-from present-object nil))

  
    (let* ((obj-name (get-object-name obj))
	   (doc-list (slot-value obj 'doc))
	   (not-wanted (list "mod" "type"))
	   (info-list (get-info-except-types (slot-value obj 'info)
					     not-wanted))
	   (loc-list (slot-value obj 'location))
	   (show-loc (and loc-list (tl-show-location? :variable)))
	   (formal-pres (or doc-list info-list show-loc))
	   )
		     

      (when formal-pres
	;; hack
	(unless obj-name
	  (setq obj-name "{not named}"))
	(put doc
	     "<formalpara>" (eol)
	     "<title>"
	     (get-simple-anchor doc (make-obj-id doc obj ?parent))
	     obj-name
	     "</title>" (eol)))
      
      (put doc "<para>" (eol))
      (tree-put doc `(:programlisting nil
		      ,(strcat "typespec " obj-name)))
;;		      ,(get-variable-signature doc obj :linked nil :style :intuitive)))

      
      (when formal-pres
	(put doc "<variablelist>" (eol))
	(db-present-doc-list  doc-list doc :variable :suppress-wrapper t)
	(db-print-location loc-list doc :variable :suppress-wrapper t)
        (db-present-info-list info-list doc :variable :suppress-wrapper t)
        (put doc "</variablelist>" (eol)))
      
      (put doc "</para>" (eol))
      (when formal-pres
	(put doc "</formalpara>" (eol)))
      ))


;; this is a rip of the above.. replace with something better later
(def-rule-info 
    ((:key :full-enum/docbook)
     (:name present-object)
     (:desc "Presents a full enum.")
     (:req
      (?class sdoc-enum)
      (?document-type docbook-document)
      (?context (eql :full))
      ;;(eq ?rec-state :refsect1)
      )
     (:variation
      :never-print-execute))

    ;; assertion, we should be below a class, ie a refsect1
    (unless (eq ?rec-state :refsect1)
      ;;(warn "Weird recstate for enum: ~s" ?rec-state)
      (return-from present-object nil))
  
    (let* ((obj-name (get-object-name obj))
	   (doc-list (slot-value obj 'doc))
;;	   (not-wanted (list "mod" "type"))
;;	   (info-list (get-info-except-types (slot-value obj 'info)
;;					     not-wanted))
	   (loc-list (slot-value obj 'location))
	   (show-loc (and loc-list (tl-show-location? :variable)))
	   (formal-pres nil) ;;(or doc-list info-list show-loc))
	   )
		     

      (when formal-pres
	;; hack
	(unless obj-name
	  (setq obj-name "{not named}"))
	(put doc
	     "<formalpara>" (eol)
	     "<title>"
	     (get-simple-anchor doc (make-obj-id doc obj ?parent))
	     obj-name
	     "</title>" (eol)))
      
      (put doc "<para>" (eol))
      (tree-put doc `(:programlisting nil
		      ,(strcat "enum " obj-name)))
;;		      ,(get-variable-signature doc obj :linked nil :style :intuitive)))

      
      (when formal-pres
	(put doc "<variablelist>" (eol))
	(db-present-doc-list  doc-list doc :variable :suppress-wrapper t)
	(db-print-location loc-list doc :variable :suppress-wrapper t)
;;        (db-present-info-list info-list doc :variable :suppress-wrapper t)
        (put doc "</variablelist>" (eol)))
      
      (put doc "</para>" (eol))
      (when formal-pres
	(put doc "</formalpara>" (eol)))
      ))