Commit | Line | Data |
---|---|---|
dea4d055 MW |
1 | ;;; -*-lisp-*- |
2 | ;;; | |
3 | ;;; Module protocol implementation | |
4 | ;;; | |
5 | ;;; (c) 2009 Straylight/Edgeware | |
6 | ;;; | |
7 | ||
8 | ;;;----- Licensing notice --------------------------------------------------- | |
9 | ;;; | |
10 | ;;; This file is part of the Sensble Object Design, an object system for C. | |
11 | ;;; | |
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. | |
16 | ;;; | |
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. | |
21 | ;;; | |
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. | |
25 | ||
26 | (cl:in-package #:sod) | |
27 | ||
28 | ;;;-------------------------------------------------------------------------- | |
29 | ;;; Module basics. | |
30 | ||
31 | (defmethod module-import ((module module)) | |
32 | (dolist (item (module-items module)) | |
33 | (module-import item))) | |
34 | ||
35 | (defmethod add-to-module ((module module) item) | |
36 | (setf (module-items module) | |
37 | (nconc (module-items module) (list item))) | |
38 | (module-import item)) | |
39 | ||
40 | (defmethod shared-initialize :after ((module module) slot-names &key pset) | |
41 | "Tick off known properties on the property set." | |
42 | (declare (ignore slot-names)) | |
43 | (dolist (prop '(:guard)) | |
44 | (get-property pset prop nil))) | |
45 | ||
46 | (defmethod finalize-module ((module module)) | |
47 | (let* ((pset (module-pset module)) | |
52a79ab8 | 48 | (class (get-property pset :module-class :symbol 'module))) |
dea4d055 MW |
49 | |
50 | ;; Always call `change-class', even if it's the same one; this will | |
51 | ;; exercise the property-set fiddling in `shared-initialize' and we can | |
52 | ;; catch unknown-property errors. | |
53 | (change-class module class :state t :pset pset) | |
54 | (check-unused-properties pset) | |
55 | module)) | |
56 | ||
57 | ;;;-------------------------------------------------------------------------- | |
58 | ;;; Module objects. | |
59 | ||
60 | (defparameter *module-map* (make-hash-table :test #'equal) | |
61 | "Hash table mapping true names to module objects.") | |
62 | ||
63 | (defun build-module | |
64 | (name thunk &key (truename (probe-file name)) location) | |
65 | "Construct a new module. | |
66 | ||
bf090e02 MW |
67 | This is the functionality underlying `define-module': see that macro for |
68 | full information." | |
69 | ||
70 | ;; Check for an import cycle. | |
71 | (when truename | |
72 | (let ((existing (gethash truename *module-map*))) | |
73 | (cond ((null existing)) | |
74 | ((eq (module-state existing) t) | |
75 | (return-from build-module existing)) | |
76 | (t | |
77 | (error "Module ~A already being imported at ~A" | |
78 | name (module-state existing)))))) | |
79 | ||
80 | ;; Construct the new module. | |
dea4d055 MW |
81 | (let ((*module* (make-instance 'module |
82 | :name (pathname name) | |
83 | :state (file-location location)))) | |
84 | (when truename | |
85 | (setf (gethash truename *module-map*) *module*)) | |
86 | (unwind-protect | |
9ec578d9 MW |
87 | (with-module-environment () |
88 | (module-import *builtin-module*) | |
89 | (funcall thunk) | |
90 | (finalize-module *module*)) | |
dea4d055 MW |
91 | (when (and truename (not (eq (module-state *module*) t))) |
92 | (remhash truename *module-map*))))) | |
93 | ||
9ec578d9 MW |
94 | (defun call-with-module-environment (thunk &optional (module *module*)) |
95 | "Invoke THUNK with bindings for the module variables in scope. | |
96 | ||
97 | This is the guts of `with-module-environment', which you should probably | |
98 | use instead." | |
99 | (progv | |
100 | (mapcar #'car *module-bindings-alist*) | |
101 | (module-variables module) | |
102 | (unwind-protect (funcall thunk) | |
103 | (setf (module-variables module) | |
104 | (mapcar (compose #'car #'symbol-value) | |
105 | *module-bindings-alist*))))) | |
106 | ||
239fa5bd MW |
107 | (defun call-with-temporary-module (thunk) |
108 | "Invoke THUNK in the context of a temporary module, returning its values. | |
109 | ||
110 | This is mainly useful for testing things which depend on module variables. | |
111 | This is the functionality underlying `with-temporary-module'." | |
112 | (let ((*module* (make-instance 'module | |
113 | :name "<temp>" | |
114 | :state nil))) | |
9ec578d9 MW |
115 | (with-module-environment () |
116 | (module-import *builtin-module*) | |
117 | (funcall thunk)))) | |
239fa5bd | 118 | |
dea4d055 MW |
119 | ;;;-------------------------------------------------------------------------- |
120 | ;;; Type definitions. | |
121 | ||
122 | (export 'type-item) | |
123 | (defclass type-item () | |
124 | ((name :initarg :name :type string :reader type-name)) | |
125 | (:documentation | |
126 | "A note that a module exports a type. | |
127 | ||
128 | We can only export simple types, so we only need to remember the name. | |
129 | The magic simple-type cache will ensure that we get the same type object | |
130 | when we do the import.")) | |
131 | ||
132 | (defmethod module-import ((item type-item)) | |
133 | (let* ((name (type-name item)) | |
134 | (def (gethash name *module-type-map*)) | |
135 | (type (make-simple-type name))) | |
136 | (cond ((not def) | |
137 | (setf (gethash name *module-type-map*) type)) | |
138 | ((not (eq def type)) | |
139 | (error "Conflicting types `~A'" name))))) | |
140 | ||
141 | (defmethod module-import ((class sod-class)) | |
142 | (record-sod-class class)) | |
143 | ||
144 | ;;;-------------------------------------------------------------------------- | |
145 | ;;; Code fragments. | |
146 | ||
88b38efd | 147 | (export '(c-fragment c-fragment-text)) |
dea4d055 | 148 | (defclass c-fragment () |
88b38efd MW |
149 | ((location :initarg :location :type file-location :reader file-location) |
150 | (text :initarg :text :type string :reader c-fragment-text)) | |
dea4d055 MW |
151 | (:documentation |
152 | "Represents a fragment of C code to be written to an output file. | |
153 | ||
154 | A C fragment is aware of its original location, and will bear proper #line | |
155 | markers when written out.")) | |
156 | ||
157 | (defun output-c-excursion (stream location thunk) | |
158 | "Invoke THUNK surrounding it by writing #line markers to STREAM. | |
159 | ||
160 | The first marker describes LOCATION; the second refers to the actual | |
161 | output position in STREAM. If LOCATION doesn't provide a line number then | |
162 | no markers are output after all. If the output stream isn't | |
163 | position-aware then no final marker is output." | |
164 | ||
165 | (let* ((location (file-location location)) | |
166 | (line (file-location-line location)) | |
167 | (filename (file-location-filename location))) | |
168 | (cond (line | |
d07588d4 MW |
169 | (when (typep stream 'position-aware-stream) |
170 | (format stream "~&#line ~D~@[ ~S~]~%" line filename)) | |
dea4d055 MW |
171 | (funcall thunk) |
172 | (when (typep stream 'position-aware-stream) | |
173 | (fresh-line stream) | |
174 | (format stream "~&#line ~D ~S~%" | |
175 | (1+ (position-aware-stream-line stream)) | |
9ec578d9 MW |
176 | (let ((path (stream-pathname stream))) |
177 | (if path (namestring path) "<sod-output>"))))) | |
dea4d055 MW |
178 | (t |
179 | (funcall thunk))))) | |
180 | ||
181 | (defmethod print-object ((fragment c-fragment) stream) | |
182 | (let ((text (c-fragment-text fragment)) | |
88b38efd | 183 | (location (file-location fragment))) |
dea4d055 MW |
184 | (if *print-escape* |
185 | (print-unreadable-object (fragment stream :type t) | |
186 | (when location | |
187 | (format stream "~A " location)) | |
188 | (cond ((< (length text) 40) | |
189 | (prin1 text stream) stream) | |
190 | (t | |
191 | (prin1 (subseq text 0 37) stream) | |
192 | (write-string "..." stream)))) | |
193 | (output-c-excursion stream location | |
194 | (lambda () (write-string text stream)))))) | |
195 | ||
196 | (defmethod make-load-form ((fragment c-fragment) &optional environment) | |
197 | (make-load-form-saving-slots fragment :environment environment)) | |
198 | ||
199 | (export 'code-fragment-item) | |
200 | (defclass code-fragment-item () | |
201 | ((fragment :initarg :fragment :type c-fragment :reader code-fragment) | |
202 | (reason :initarg :reason :type keyword :reader code-fragment-reason) | |
203 | (name :initarg :name :type t :reader code-fragment-name) | |
204 | (constraints :initarg :constraints :type list | |
205 | :reader code-fragment-constraints)) | |
206 | (:documentation | |
207 | "A plain fragment of C to be dropped in at top-level.")) | |
208 | ||
209 | (defmacro define-fragment ((reason name) &body things) | |
210 | (categorize (thing things) | |
211 | ((constraints (listp thing)) | |
212 | (frags (typep thing '(or string c-fragment)))) | |
213 | (when (null frags) | |
214 | (error "Missing code fragment")) | |
215 | (when (cdr frags) | |
216 | (error "Multiple code fragments")) | |
217 | `(add-to-module | |
218 | *module* | |
219 | (make-instance 'code-fragment-item | |
220 | :fragment ',(car frags) | |
221 | :name ,name | |
222 | :reason ,reason | |
223 | :constraints (list ,@(mapcar (lambda (constraint) | |
224 | (cons 'list constraint)) | |
225 | constraints)))))) | |
226 | ||
bf090e02 MW |
227 | ;;;-------------------------------------------------------------------------- |
228 | ;;; File searching. | |
229 | ||
230 | (export '*module-dirs*) | |
231 | (defparameter *module-dirs* nil | |
232 | "A list of directories (as pathname designators) to search for files. | |
233 | ||
234 | Both SOD module files and Lisp extension files are searched for in this | |
235 | list. The search works by merging the requested pathname with each | |
236 | element of this list in turn. The list is prefixed by the pathname of the | |
237 | requesting file, so that it can refer to other files relative to wherever | |
238 | it was found. | |
239 | ||
240 | See `find-file' for the grubby details.") | |
241 | ||
242 | (export 'find-file) | |
243 | (defun find-file (scanner name what thunk) | |
244 | "Find a file called NAME on the module search path, and call THUNK on it. | |
245 | ||
246 | The file is searched for relative to the SCANNER's current file, and also | |
247 | in the directories mentioned in the `*module-dirs*' list. If the file is | |
248 | found, then THUNK is invoked with two arguments: the name we used to find | |
249 | it (which might be relative to the starting directory) and the truename | |
250 | found by `probe-file'. | |
251 | ||
252 | If the file wasn't found, or there was some kind of error, then an error | |
253 | is signalled; WHAT should be a noun phrase describing the kind of thing we | |
254 | were looking for, suitable for inclusion in the error message. | |
255 | ||
256 | While `find-file' establishes condition handlers for its own purposes, | |
257 | THUNK is not invoked with any additional handlers defined." | |
258 | ||
259 | (handler-case | |
260 | (dolist (dir (cons (pathname (scanner-filename scanner)) *module-dirs*) | |
261 | (values nil nil)) | |
262 | (let* ((path (merge-pathnames name dir)) | |
263 | (probe (probe-file path))) | |
264 | (when probe | |
265 | (return (values path probe))))) | |
266 | (file-error (error) | |
267 | (error "Error searching for ~A ~S: ~A" what (namestring name) error)) | |
268 | (:no-error (path probe) | |
269 | (cond ((null path) | |
270 | (error "Failed to find ~A ~S" what (namestring name))) | |
271 | (t | |
272 | (funcall thunk path probe)))))) | |
273 | ||
dea4d055 | 274 | ;;;----- That's all, folks -------------------------------------------------- |