5 ;;; (c) 2013 Straylight/Edgeware
8 ;;;----- Licensing notice ---------------------------------------------------
10 ;;; This file is part of the Sensible 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 (with-module-environment (module)
83 (hook-output module reason sequencer)
84 (invoke-sequencer-items sequencer stream))))
86 ;;;--------------------------------------------------------------------------
87 ;;; Output implementation.
89 (defmethod hook-output progn ((module module) reason sequencer)
91 ;; Ask the module's items to sequence themselves.
92 (dolist (item (module-items module))
93 (hook-output item reason sequencer)))
95 (defmethod hook-output progn ((frag code-fragment-item) reason sequencer)
97 ;; Output fragments when their reasons are called up.
98 (when (eq reason (code-fragment-reason frag))
99 (dolist (constraint (code-fragment-constraints frag))
100 (add-sequencer-constraint sequencer constraint))
101 (add-sequencer-item-function sequencer (code-fragment-name frag)
103 (write (code-fragment frag)
108 (defmethod hook-output progn ((module module) (reason (eql :h)) sequencer)
109 (sequence-output (stream sequencer)
114 (:typedefs :start) :typedefs (:typedefs :end)
115 (:includes :start) :includes (:includes :end)
116 (:early-user :start) :early-user (:early-user :end)
117 (:classes :start) (:classes :end)
118 (:user :start) :user (:user :end)
124 /* -*- mode: c; indent-tabs-mode: nil -*-
126 * Header file generated by SOD for ~A
128 (namestring (module-name module))))
138 (or (get-property (module-pset module) :guard :id)
139 (guard-name (or (stream-pathname stream)
140 (guess-output-file module "H"))))))
142 (banner "That's all, folks" stream)
151 (banner "Forward type declarations" stream))
156 (banner "External header files" stream))
160 (defmethod hook-output progn ((module module) (reason (eql :c)) sequencer)
161 (sequence-output (stream sequencer)
165 (:includes :start) :includes (:includes :end)
166 (:early-user :start) :early-user (:early-user :end)
167 (:classes :start) (:classes :end)
168 (:user :start) :user (:user :end)
173 /* -*- mode: c; indent-tabs-mode: nil -*-
175 * Implementation file generated by SOD for ~A
177 (namestring (module-name module))))
180 (banner "That's all, folks" stream :blank-line-p nil))
183 (banner "External header files" stream))
187 ;;;--------------------------------------------------------------------------
190 (defvar *output-types* nil
191 "List of known output types.")
193 (export 'declare-output-type)
194 (defun declare-output-type (reason pathname)
195 "Record that REASON is a valid user-level output type.
197 The output file name will be constructed by merging the module's pathname
199 (setf (get reason 'output-type) pathname))
201 (export 'output-type-pathname)
202 (defun output-type-pathname (reason)
203 "Return the PATHNAME template for the output type REASON.
205 Report an error if there is no such output type."
206 (or (get reason 'output-type)
207 (error "Unknown output type `~(~A~)'" reason)))
209 (define-clear-the-decks reset-output-types
210 "Clear out the registered output types."
211 (dolist (reason *output-types*) (remprop reason 'output-type))
212 (setf *output-types* nil)
213 (declare-output-type :c (make-pathname :type "C" :case :common))
214 (declare-output-type :h (make-pathname :type "H" :case :common)))
216 ;;;----- That's all, folks --------------------------------------------------