5 ;;; (c) 2013 Straylight/Edgeware
8 ;;;----- Licensing notice ---------------------------------------------------
10 ;;; This file is part of the Sensble Object Design, an object system for C.
12 ;;; SOD is free software; you can redistribute it and/or modify
13 ;;; it under the terms of the GNU General Public License as published by
14 ;;; the Free Software Foundation; either version 2 of the License, or
15 ;;; (at your option) any later version.
17 ;;; SOD is distributed in the hope that it will be useful,
18 ;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;;; GNU General Public License for more details.
22 ;;; You should have received a copy of the GNU General Public License
23 ;;; along with SOD; if not, write to the Free Software Foundation,
24 ;;; Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
28 ;;;--------------------------------------------------------------------------
32 (defun banner (title output &key (blank-line-p t))
33 "Write a banner to the OUTPUT stream, starting a new section called TITLE.
35 If BLANK-LINE-P is false, then leave a blank line after the banner. (This
36 is useful for a final banner at the end of a file.)"
37 (format output "~&/*----- ~A ~A*/~%"
39 (make-string (- 77 2 5 1 (length title) 1 2)
40 :initial-element #\-))
45 (defun guard-name (filename)
46 "Return a sensible inclusion guard name for FILENAME."
47 (with-output-to-string (guard)
48 (let* ((pathname (make-pathname :name (pathname-name filename)
49 :type (pathname-type filename)))
50 (name (namestring pathname))
52 (dotimes (i (length name))
53 (let ((ch (char name i)))
54 (cond ((alphanumericp ch)
55 (write-char (char-upcase ch) guard)
58 (write-char #\_ guard)
59 (setf uscore t))))))))
61 (defun guess-output-file (module type)
62 "Guess the filename to use for a file TYPE, generated from MODULE.
64 Here, TYPE is a filetype string. The result is returned as a pathname."
65 (merge-pathnames (make-pathname :type type :case :common)
66 (module-name module)))
68 ;;;--------------------------------------------------------------------------
69 ;;; Main output interface.
71 (export 'output-module)
72 (defun output-module (module reason stream)
73 "Write the MODULE to STREAM, giving the output machinery the REASON.
75 This is the top-level interface for producing output."
76 (let ((sequencer (make-instance 'sequencer))
77 (stream (if (typep stream 'position-aware-output-stream)
79 (make-instance 'position-aware-output-stream
81 :file (stream-pathname stream)))))
82 (hook-output module reason sequencer)
83 (invoke-sequencer-items sequencer stream)))
85 ;;;--------------------------------------------------------------------------
86 ;;; Output implementation.
88 (defmethod hook-output progn ((module module) reason sequencer)
90 ;; Ask the module's items to sequence themselves.
91 (dolist (item (module-items module))
92 (hook-output item reason sequencer)))
94 (defmethod hook-output progn ((frag code-fragment-item) reason sequencer)
96 ;; Output fragments when their reasons are called up.
97 (when (eq reason (code-fragment-reason frag))
98 (dolist (constraint (code-fragment-constraints frag))
99 (add-sequencer-constraint sequencer constraint))
100 (add-sequencer-item-function sequencer (code-fragment-name frag)
102 (write (code-fragment frag)
107 (defmethod hook-output progn ((module module) (reason (eql :h)) sequencer)
108 (sequence-output (stream sequencer)
113 (:typedefs :start) :typedefs (:typedefs :end)
114 (:includes :start) :includes (:includes :end)
115 (:classes :start) :classes (:classes :end)
123 * Header file generated by SOD for ~A
125 (namestring (module-name module))))
135 (or (get-property (module-pset module) :guard :id)
136 (guard-name (or (stream-pathname stream)
137 (guess-output-file module "H"))))))
139 (banner "That's all, folks" stream)
148 (banner "Forward type declarations" stream))
153 (banner "External header files" stream))
157 (defmethod hook-output progn ((module module) (reason (eql :c)) sequencer)
158 (sequence-output (stream sequencer)
162 (:includes :start) :includes (:includes :end)
163 (:classes :start) (:classes :end)
170 * Implementation file generated by SOD for ~A
172 (namestring (module-name module))))
175 (banner "That's all, folks" stream :blank-line-p nil))
178 (banner "External header files" stream))
182 ;;;----- That's all, folks --------------------------------------------------