File: api-html.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 (150 lines) | stat: -rw-r--r-- 4,501 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
;;; -*- Mode: Lisp; Syntax: Common-Lisp; Package: APISPEC -*-

#|

DESC: apispec/api-html.lisp - the code for generating html of the API
Copyright (c) 2000 - 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 :sds-api-apispec)

(defmethod output-declarations ((obj apispec-toplevel) (lang api-lang-html) stream some-name)
  (declare (ignore some-name))
  
  (let* ((api-name (string-downcase (car (apispec-toplevel.name obj))))
	 (up-api-name (string-upcase api-name)))
    

    (format stream "<title>~a api</title>~2%" api-name)
    
    (format stream "<body bgcolor=white>~2%")
    (format stream "<h1 align=center>~a API</h1>~2%" up-api-name)

    
    (let ((classes (apispec-toplevel.classes obj)))
      (dolist (c classes)
	(output-declarations c lang stream api-name)))

    
    ))

(defvar *colours* '("blue" "red" "green" "purple" "brown" 
		    "darkgreen" "darkblue" "orange" "pink" "lightgreen" "lightblue"))

(defmethod output-declarations ((obj apispec-class) (lang api-lang-html) stream some-name)
  
  (declare (ignore some-name))

  (let* ((elmname (string-downcase (car (apispec-class.elmname obj))))
	 (name (string-downcase (car (apispec-class.name obj))))
	 (class-desc (car (apispec-class.doc obj)))
	 (vars (apispec-class.vars obj))
	 (varlen (length vars))
	 (attrs (apispec-class.attrs obj))
	 (attrlen (length attrs))
	 (subs (apispec-class.subelems obj))
	 (sublen (length subs))
	 (i-docs (apispec-class.infodoc obj))
	 (i-doclen (length i-docs))
	 (c-tbl (make-hash-table :test #'equal))
	 (c-cnt 0)
	 )


    
    (format stream "<h3>Class: ~a</h3>~%" name)


    (format stream "<table bgcolor=\"#f0f0f0\">~%")

    (when elmname
      (format stream "<tr><td><b>XML elementname:</b></td><td colspan=4> ~a</td></tr>~%"
	    elmname))

    (when class-desc
      (format stream "<tr><td><b>Desc:</b></td><td colspan=4> ~a</td></tr>~%"
	    class-desc))
    
    (when (plusp varlen)
      (format stream "<tr><td><b>Variables</b></td><td>Name:</td><td>Type:</td><td>&nbsp;</td><td>Desc:</td></tr>~%")
    
      (dolist (v vars)

	(let ((col (elt *colours* c-cnt))
	      (varname (car (apispec-var.name v))))
	  
	  (setf (gethash varname c-tbl) col)
	  (incf c-cnt)
	  
	  (format stream "<tr><td>&nbsp;</td><td><font color=~a>~a</font></td> <td>~a</td><td>&nbsp;</td><td>~a</td></tr>"
		  col
		  varname
		  (car (apispec-var.type v))
		  (let ((val (car (apispec-var.doc v))))
		    (if val val "&nbsp;"))
		  ))))
    
    (when (plusp attrlen)
      (format stream "<tr><td><b>Attributes</b></td><td>Name:</td><td>Type:</td><td>Variable:</td><td>Desc:</td></tr>~%")
    
      (dolist (v attrs)
	(let* ((varname (car (apispec-attr.var v)))
	       (varcol (gethash varname c-tbl)))
	(format stream "<tr><td>&nbsp;</td><td>~a</td> <td>~a</td><td><font color=~a>~a</font></td><td>~a</td></tr>"
		(car (apispec-attr.name v))
		(car (apispec-attr.type v))
		varcol
		varname
		(let ((val (car (apispec-attr.doc v))))
		  (if val val "&nbsp;"))
		))))

    (when (plusp sublen)
      (format stream "<tr><td><b>Subelements</b></td><td>Name:</td><td>Type:</td><td>Variable:</td><td>Desc:</td></tr>~%")
    
      (dolist (v subs)
	(let* ((varname (car (apispec-subelem.var v)))
	       (varcol (gethash varname c-tbl)))
	(format stream "<tr><td>&nbsp;</td><td>~a</td> <td>~a</td><td><font color=~a>~a</font></td><td>~a</td></tr>"
		(car (apispec-subelem.name v))
		(car (apispec-subelem.type v))
		varcol
		varname
		(let ((val (car (apispec-subelem.doc v))))
		  (if val val "&nbsp;"))
		))))

    (when (plusp i-doclen)
      (format stream "<tr><td><b>Known Info</b></td><td>Type:</td><td>Value:</td><td>Info:</td><td>Desc:</td></tr>~%")
    
      (dolist (v i-docs)
	(let ((ty (car (apispec-infodoc.type v)))
	      (va (car (apispec-infodoc.value v)))
	      (in (car (apispec-infodoc.info v)))
	      (ex (car (apispec-infodoc.expl v))))
	      
	(format stream "<tr><td>&nbsp;</td><td>~a</td> <td>~a</td><td>~a</font></td><td>~a</td></tr>"
		(if ty ty "&nbsp;")
		(if va va "&nbsp;")
		(if in in "&nbsp;")
		(if ex ex "&nbsp;")
		))))


 
    (format stream "</table>~2%")
    ))


  
(defmethod output-code ((obj apispec-toplevel) (lang api-lang-html) stream some-name)

  ;; hack
  (output-declarations obj lang stream some-name))