1 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
3 ;;; Free Software published under an MIT-like license. See LICENSE ;;;
5 ;;; Copyright (c) 2012 Google, Inc. All rights reserved. ;;;
7 ;;; Original author: Scott McKay ;;;
9 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
11 (in-package "PROTO-IMPL")
14 ;;; Protobufs schema pretty printing
16 (defun write-schema (protobuf &rest keys
17 &key (stream *standard-output*) (type :proto) &allow-other-keys)
18 "Writes the object 'protobuf' (schema, message, enum, etc) onto the
19 stream 'stream' in the format given by 'type' (:proto, :text, etc)."
20 (let ((*protobuf* protobuf))
21 (apply #'write-schema-as type protobuf stream keys)))
23 (defgeneric write-schema-as (type protobuf stream &key indentation &allow-other-keys)
25 "Writes the protobuf object 'protobuf' (schema, message, enum, etc) onto
26 the given stream 'stream' in the format given by 'type' (:proto, :text, etc).
27 If 'more' is true, this means there are more enum values, fields, etc to
28 be written after the current one."))
30 (defgeneric write-schema-header (type schema stream)
32 "Writes a header for the schema onto the given stream 'stream'
33 in the format given by 'type' (:proto, :text, etc)."))
35 (defgeneric write-schema-documentation (type docstring stream &key indentation)
37 "Writes the docstring as a \"block comment\" onto the given stream 'stream'
38 in the format given by 'type' (:proto, :text, etc)."))
41 ;;; Pretty print a schema as a .proto file
43 (defmethod write-schema-as ((type (eql :proto)) (schema protobuf-schema) stream
45 (with-prefixed-accessors (documentation syntax package imports options) (proto- schema)
47 (write-schema-documentation type documentation stream :indentation indentation))
49 (format stream "~&syntax = \"~A\";~%~%" syntax))
51 (format stream "~&package ~A;~%~%" (substitute #\_ #\- package)))
53 (dolist (import imports)
54 (format stream "~&import \"~A\";~%" import))
56 (write-schema-header type schema stream)
58 (dolist (option options)
59 (format stream "~&option ~:/protobuf-option/;~%" option))
61 (loop for (enum . more) on (proto-enums schema) doing
62 (write-schema-as type enum stream :indentation indentation :more more)
64 (loop for (alias . more) on (proto-type-aliases schema) doing
65 (write-schema-as type alias stream :indentation indentation :more more)
67 (loop for (msg . more) on (proto-messages schema) doing
68 (write-schema-as type msg stream :indentation indentation :more more)
70 (loop for (svc . more) on (proto-services schema) doing
71 (write-schema-as type svc stream :indentation indentation :more more)
74 (defmethod write-schema-documentation ((type (eql :proto)) docstring stream
76 (let ((lines (split-string docstring :separators '(#\newline #\return))))
78 (format stream "~&~@[~VT~]// ~A~%"
79 (and (not (zerop indentation)) indentation) line))))
81 ;; Lisp was born in 1958 :-)
82 (defvar *lisp-options* '(("lisp_package" string 195801)
83 ("lisp_name" string 195802)
84 ("lisp_alias" string 195803)
85 ("lisp_type" string 195804)
86 ("lisp_class" string 195805)
87 ("lisp_slot" string 195806)))
89 (defvar *option-types* '(("ctype" symbol)
92 ("optimize_for" symbol)
95 ("stream_type" string)
96 ;; Keep the rest of these in alphabetical order
97 ("cc_api_version" integer)
98 ("cc_generic_services" symbol)
99 ("go_api_version" integer)
100 ("go_generic_services" symbol)
101 ("go_package" string)
102 ("java_api_version" integer)
103 ("java_generic_services" symbol)
104 ("java_java5_enums" boolean)
105 ("java_multiple_files" boolean)
106 ("java_outer_classname" string)
107 ("java_package" string)
108 ("java_use_javaproto2" boolean)
109 ("py_api_version" integer)
110 ("py_generic_services" symbol)))
112 (defmethod write-schema-header ((type (eql :proto)) (schema protobuf-schema) stream)
113 (when (any-lisp-option schema)
114 (format stream "~&import \"net/proto2/proto/descriptor.proto\";~%~%")
115 (format stream "~&extend proto2.MessageOptions {~%")
116 (loop for (option type index) in *lisp-options* doing
117 (format stream "~& optional ~(~A~) ~A = ~D;~%" type option index))
118 (format stream "~&}~%~%")))
120 (defgeneric any-lisp-option (schema)
122 "Returns true iff there is anything in the schema that would require that
123 the .proto file include and extend 'MessageOptions'.")
124 (:method ((schema protobuf-schema))
125 (labels ((find-one (protobuf)
126 (dolist (enum (proto-enums protobuf))
127 (with-prefixed-accessors (name class alias-for) (proto- enum)
129 (and class (not (string-equal name (class-name->proto class))) class))
130 (return-from any-lisp-option t))))
131 (dolist (msg (proto-messages protobuf))
132 (with-prefixed-accessors (name class alias-for) (proto- msg)
134 (and class (not (string-equal name (class-name->proto class))) class))
135 (return-from any-lisp-option t))))
136 (map () #'find-one (proto-messages protobuf))))
140 (defun cl-user::protobuf-option (stream option colon-p atsign-p)
141 (let* ((type (or (second (find (proto-name option) *option-types* :key #'first :test #'string=))
142 (proto-type option)))
143 (value (proto-value option)))
144 (cond (colon-p ;~:/protobuf-option/ -- .proto format
146 (cond ((find (proto-name option) *lisp-options* :key #'first :test #'string=)
148 ((symbol) "(~A)~@[ = ~A~]")
149 ((boolean) "(~A)~@[ = ~(~A~)~]")
151 (cond ((typep value 'standard-object)
152 ;; If the value is an instance of some class,
153 ;; then it must be some sort of complex option,
154 ;; so print the value using the text format
156 (with-output-to-string (s)
157 (print-text-format value nil
158 :stream s :print-name nil :suppress-line-breaks t)))
161 "(~A)~@[ = ~S~]")))))
164 ((symbol) "~A~@[ = ~A~]")
165 ((boolean) "~A~@[ = ~(~A~)~]")
167 (cond ((typep value 'standard-object)
169 (with-output-to-string (s)
170 (print-text-format value nil
171 :stream s :print-name nil :suppress-line-breaks t)))
173 (t "~A~@[ = ~S~]"))))))))
174 (format stream fmt-control (proto-name option) value)))
175 (atsign-p ;~@/protobuf-option/ -- string/value format
176 (let ((fmt-control (if (eq type 'symbol) "~(~S~) ~A" "~(~S~) ~S")))
177 (format stream fmt-control (proto-name option) value)))
178 (t ;~/protobuf-option/ -- keyword/value format
179 (let ((fmt-control (if (eq type 'symbol) "~(:~A~) ~A" "~(:~A~) ~S")))
180 (format stream fmt-control (proto-name option) value))))))
182 (defun cl-user::source-location (stream location colon-p atsign-p)
183 (declare (ignore colon-p atsign-p))
184 (format stream "(~S ~D ~D)"
185 (source-location-pathname location)
186 (source-location-start-pos location) (source-location-end-pos location)))
188 (defmethod write-schema-as ((type (eql :proto)) (enum protobuf-enum) stream
189 &key (indentation 0) more)
190 (declare (ignore more))
191 (with-prefixed-accessors (name class alias-for documentation options) (proto- enum)
193 (write-schema-documentation type documentation stream :indentation indentation))
194 (format stream "~&~@[~VT~]enum ~A {~%"
195 (and (not (zerop indentation)) indentation)
196 (maybe-qualified-name enum))
197 (let ((other (and class (not (string-equal name (class-name->proto class))) class)))
199 (format stream "~&~VToption (lisp_name) = \"~A:~A\";~%"
200 (+ indentation 2) (package-name (symbol-package class)) (symbol-name class))))
202 (format stream "~&~VToption (lisp_alias) = \"~A:~A\";~%"
203 (+ indentation 2) (package-name (symbol-package alias-for)) (symbol-name alias-for)))
204 (dolist (option options)
205 (format stream "~&option ~:/protobuf-option/;~%" option))
206 (loop for (value . more) on (proto-values enum) doing
207 (write-schema-as type value stream :indentation (+ indentation 2) :more more))
208 (format stream "~&~@[~VT~]}~%"
209 (and (not (zerop indentation)) indentation))))
211 (defparameter *protobuf-enum-comment-column* 56)
212 (defmethod write-schema-as ((type (eql :proto)) (val protobuf-enum-value) stream
213 &key (indentation 0) more)
214 (declare (ignore more))
215 (with-prefixed-accessors (name documentation index) (proto- val)
216 (format stream "~&~@[~VT~]~A = ~D;~:[~2*~;~VT// ~A~]~%"
217 (and (not (zerop indentation)) indentation)
218 (maybe-qualified-name val) index
219 documentation *protobuf-enum-comment-column* documentation)))
221 (defmethod write-schema-as ((type (eql :proto)) (alias protobuf-type-alias) stream
222 &key (indentation 0) more)
223 (declare (ignore more))
224 (with-prefixed-accessors (name lisp-type proto-type) (proto- alias)
225 (let ((comment (format nil "Note: there is an alias ~A that maps Lisp ~(~S~) to Protobufs ~(~A~)"
226 name lisp-type proto-type)))
227 (write-schema-documentation type comment stream :indentation indentation))
228 (format stream "~&~@[~VT~]~%"
229 (and (not (zerop indentation)) indentation))))
231 (defmethod write-schema-as ((type (eql :proto)) (message protobuf-message) stream
232 &key (indentation 0) more index arity)
233 (declare (ignore more arity))
234 (let ((*protobuf* message))
235 (with-prefixed-accessors (name class alias-for message-type documentation options) (proto- message)
236 (cond ((eq message-type :group)
237 ;; If we've got a group, the printer for fields has already
238 ;; printed a partial line (nice modularity, huh?)
239 (format stream "group ~A = ~D {~%" name index)
240 (let ((other (and class (not (string-equal name (class-name->proto class))) class)))
242 (format stream "~&~VToption (lisp_name) = \"~A:~A\";~%"
243 (+ indentation 2) (package-name (symbol-package class)) (symbol-name class))))
245 (format stream "~&~VToption (lisp_alias) = \"~A:~A\";~%"
246 (+ indentation 2) (package-name (symbol-package alias-for)) (symbol-name alias-for)))
247 (dolist (option options)
248 (format stream "~&~VToption ~:/protobuf-option/;~%"
249 (+ indentation 2) option))
250 (loop for (enum . more) on (proto-enums message) doing
251 (write-schema-as type enum stream :indentation (+ indentation 2) :more more))
252 (loop for (field . more) on (proto-fields message) doing
253 (write-schema-as type field stream
254 :indentation (+ indentation 2) :more more :message message))
255 (format stream "~&~@[~VT~]}~%"
256 (and (not (zerop indentation)) indentation)))
259 (write-schema-documentation type documentation stream :indentation indentation))
260 (format stream "~&~@[~VT~]~A ~A {~%"
261 (and (not (zerop indentation)) indentation)
262 (if (eq message-type :message) "message" "extend")
263 (maybe-qualified-name message))
264 (let ((other (and class (not (string-equal name (class-name->proto class))) class)))
266 (format stream "~&~VToption (lisp_name) = \"~A:~A\";~%"
267 (+ indentation 2) (package-name (symbol-package class)) (symbol-name class))))
269 (format stream "~&~VToption (lisp_alias) = \"~A:~A\";~%"
270 (+ indentation 2) (package-name (symbol-package alias-for)) (symbol-name alias-for)))
271 (dolist (option options)
272 (format stream "~&~VToption ~:/protobuf-option/;~%"
273 (+ indentation 2) option))
274 (cond ((eq message-type :extends)
275 (loop for (field . more) on (proto-extended-fields message) doing
276 (write-schema-as type field stream
277 :indentation (+ indentation 2) :more more
280 (loop for (enum . more) on (proto-enums message) doing
281 (write-schema-as type enum stream :indentation (+ indentation 2) :more more))
282 (loop for (msg . more) on (proto-messages message) doing
283 (unless (eq (proto-message-type msg) :group)
284 (write-schema-as type msg stream :indentation (+ indentation 2) :more more)))
285 (loop for (field . more) on (proto-fields message) doing
286 (write-schema-as type field stream
287 :indentation (+ indentation 2) :more more
289 (loop for (extension . more) on (proto-extensions message) doing
290 (write-schema-as type extension stream :indentation (+ indentation 2) :more more))))
291 (format stream "~&~@[~VT~]}~%"
292 (and (not (zerop indentation)) indentation)))))))
294 (defun maybe-qualified-name (x &optional name)
295 "Given a message, return a fully qualified name if the short name
296 is not sufficient to name the message in the current scope."
298 ((or protobuf-message protobuf-enum protobuf-enum-value
300 (cond ((string= (make-qualified-name (proto-parent x) (proto-name x))
301 (proto-qualified-name x))
304 (proto-qualified-name x))))
307 (defparameter *protobuf-field-comment-column* 56)
308 (defmethod write-schema-as ((type (eql :proto)) (field protobuf-field) stream
309 &key (indentation 0) more message)
310 (declare (ignore more))
311 (with-prefixed-accessors (name documentation required type index packed options) (proto- field)
312 (let* ((class (if (eq (proto-class field) 'boolean) :bool (proto-class field)))
313 (msg (and (not (keywordp class))
314 (or (find-message message class)
315 (find-enum message class)
316 (find-type-alias message class)))))
317 (cond ((and (typep msg 'protobuf-message)
318 (eq (proto-message-type msg) :group))
319 (format stream "~&~@[~VT~]~(~A~) "
320 (and (not (zerop indentation)) indentation) required)
321 (write-schema-as :proto msg stream :indentation indentation :index index :arity required))
323 (let* ((defaultp (if (proto-alias-for message)
324 ;; Special handling for imported CLOS classes
325 (if (eq (proto-required field) :optional)
327 (and (proto-default field)
328 (not (equalp (proto-default field) #()))
329 (not (empty-default-p field))))
330 (not (empty-default-p field))))
331 (default (proto-default field))
332 (default (and defaultp
333 (cond ((and (typep msg 'protobuf-enum)
334 (or (stringp default) (symbolp default)))
335 (let ((e (find default (proto-values msg)
336 :key #'proto-name :test #'string=)))
337 (and e (proto-name e))))
339 (if (boolean-true-p default) "true" "false"))
341 (default (and defaultp
342 (if (stringp default) (escape-string default) default))))
343 (if (typep msg 'protobuf-type-alias)
344 (format stream "~&~@[~VT~]~(~A~) ~(~A~) ~A = ~D~
345 ~:[~*~; [default = ~S]~]~@[ [packed = true]~*~]~{ [~:/protobuf-option/]~};~
346 ~:[~2*~;~VT// ~A~]~%"
347 (and (not (zerop indentation)) indentation)
348 required (proto-proto-type msg) name index
349 defaultp default packed options
350 t *protobuf-field-comment-column*
351 (format nil "alias maps Lisp ~(~S~) to Protobufs ~(~A~)"
352 (proto-lisp-type msg) (proto-proto-type msg)))
353 (format stream (if (and (keywordp class) (not (eq class :bool)))
354 ;; Keyword class means a primitive type, print default with ~S
355 "~&~@[~VT~]~(~A~) ~A ~A = ~D~
356 ~:[~*~; [default = ~S]~]~@[ [packed = true]~*~]~{ [~:/protobuf-option/]~};~
357 ~:[~2*~;~VT// ~A~]~%"
358 ;; Non-keyword class means an enum type, print default with ~A"
359 "~&~@[~VT~]~(~A~) ~A ~A = ~D~
360 ~:[~*~; [default = ~A]~]~@[ [packed = true]~*~]~{ [~:/protobuf-option/]~};~
361 ~:[~2*~;~VT// ~A~]~%")
362 (and (not (zerop indentation)) indentation)
363 required (maybe-qualified-name msg type) name index
364 defaultp default packed options
365 documentation *protobuf-field-comment-column* documentation))))))))
367 (defun escape-string (string)
368 (if (every #'(lambda (ch) (and (standard-char-p ch) (graphic-char-p ch))) string)
370 (with-output-to-string (s)
371 (loop for ch across string
372 as esc = (escape-char ch)
373 do (format s "~A" esc)))))
375 (defmethod write-schema-as ((type (eql :proto)) (extension protobuf-extension) stream
376 &key (indentation 0) more)
377 (declare (ignore more))
378 (with-prefixed-accessors (from to) (proto-extension- extension)
379 (format stream "~&~@[~VT~]extensions ~D~:[~*~; to ~D~];~%"
380 (and (not (zerop indentation)) indentation)
381 from (not (eql from to)) (if (eql to #.(1- (ash 1 29))) "max" to))))
383 (defmethod write-schema-as ((type (eql :proto)) (service protobuf-service) stream
384 &key (indentation 0) more)
385 (declare (ignore more))
386 (with-prefixed-accessors (name documentation) (proto- service)
388 (write-schema-documentation type documentation stream :indentation indentation))
389 (format stream "~&~@[~VT~]service ~A {~%"
390 (and (not (zerop indentation)) indentation) name)
391 (loop for (method . more) on (proto-methods service) doing
392 (write-schema-as type method stream :indentation (+ indentation 2) :more more))
393 (format stream "~&~@[~VT~]}~%"
394 (and (not (zerop indentation)) indentation))))
396 (defmethod write-schema-as ((type (eql :proto)) (method protobuf-method) stream
397 &key (indentation 0) more)
398 (declare (ignore more))
399 (with-prefixed-accessors
400 (name documentation input-name output-name streams-name options) (proto- method)
401 (let* ((imsg (find-message *protobuf* input-name))
402 (omsg (find-message *protobuf* output-name))
403 (smsg (find-message *protobuf* streams-name))
404 (iname (maybe-qualified-name imsg))
405 (oname (maybe-qualified-name omsg))
406 (sname (maybe-qualified-name smsg)))
408 (write-schema-documentation type documentation stream :indentation indentation))
409 (format stream "~&~@[~VT~]rpc ~A (~@[~A~])~@[ streams (~A)~]~@[ returns (~A)~]"
410 (and (not (zerop indentation)) indentation)
411 name iname sname oname)
413 (format stream " {~%")
414 (dolist (option options)
415 (format stream "~&~@[~VT~]option ~:/protobuf-option/;~%"
416 (+ indentation 2) option))
417 (format stream "~@[~VT~]}"
418 (and (not (zerop indentation)) indentation)))
420 (format stream ";~%"))))))
423 ;;; Pretty print a schema as a .lisp file
425 (defvar *show-lisp-enum-indexes* t)
426 (defvar *show-lisp-field-indexes* t)
427 (defvar *use-common-lisp-package* nil)
429 (defmethod write-schema-as ((type (eql :lisp)) (schema protobuf-schema) stream
431 (show-field-indexes *show-lisp-field-indexes*)
432 (show-enum-indexes *show-lisp-enum-indexes*)
433 (use-common-lisp *use-common-lisp-package*))
434 (with-prefixed-accessors (name class documentation package lisp-package imports) (proto- schema)
435 (let* ((optimize (let ((opt (find-option schema "optimize_for")))
436 (and opt (cond ((string= opt "SPEED") :speed)
437 ((string= opt "CODE_SIZE") :space)
439 (options (remove-if #'(lambda (x) (string= (proto-name x) "optimize_for"))
440 (proto-options schema)))
441 (pkg (and package (if (stringp package) package (string package))))
442 (lisp-pkg (and lisp-package (if (stringp lisp-package) lisp-package (string lisp-package))))
443 (*show-lisp-enum-indexes* show-enum-indexes)
444 (*show-lisp-field-indexes* show-field-indexes)
445 (*use-common-lisp-package* use-common-lisp)
446 (*protobuf-package* (find-proto-package lisp-pkg))
447 ;; If *protobuf-package* has not been defined, print symbols
448 ;; from :common-lisp if *use-common-lisp-package* is true; or
449 ;; :keyword otherwise. This ensures that all symbols will be
450 ;; read back correctly.
451 ;; (The :keyword package does not use any other packages, so
452 ;; all symbols will be printed with package prefixes.
453 ;; Keywords are always printed as :keyword.)
454 (*package* (or *protobuf-package*
455 (when *use-common-lisp-package* (find-package :common-lisp))
456 (find-package :keyword))))
457 (when (or lisp-pkg pkg)
458 (let ((pkg (string-upcase (or lisp-pkg pkg))))
459 (format stream "~&(cl:eval-when (:execute :compile-toplevel :load-toplevel)~
460 ~% (cl:unless (cl:find-package \"~A\")~
461 ~% (cl:defpackage ~A (:use~@[ ~(~S~)~]))))~
462 ~%(cl:in-package \"~A\")~
463 ~%(cl:export '(~{~A~^~% ~}))~%~%"
464 pkg pkg (and *use-common-lisp-package* :common-lisp) pkg
468 (package-name (symbol-package sym))
470 (collect-exports schema)))))
472 (write-schema-documentation type documentation stream :indentation indentation))
473 (format stream "~&(proto:define-schema ~(~A~)" (or class name))
474 (if (or pkg lisp-pkg imports optimize options documentation)
475 (format stream "~% (")
476 (format stream " ("))
479 (format stream "~A:package \"~A\"" spaces pkg)
480 (when (or lisp-pkg imports optimize options documentation)
484 (format stream "~A:lisp-package \"~A\"" spaces lisp-pkg)
485 (when (or imports optimize options documentation)
489 (cond ((= (length imports) 1)
490 (format stream "~A:import \"~A\"" spaces (car imports)))
492 (format stream "~A:import (~{\"~A\"~^ ~})" spaces imports)))
493 (when (or optimize options documentation)
497 (format stream "~A:optimize ~(~S~)" spaces optimize)
498 (when (or options documentation)
502 (format stream "~A:options (~{~/protobuf-option/~^ ~})" spaces options)
507 (format stream "~A:documentation ~S" spaces documentation)))
509 (loop for (enum . more) on (proto-enums schema) doing
510 (write-schema-as type enum stream :indentation 2 :more more))
511 (loop for (alias . more) on (proto-type-aliases schema) doing
512 (write-schema-as type alias stream :indentation 2 :more more))
513 (loop for (msg . more) on (proto-messages schema) doing
514 (write-schema-as type msg stream :indentation 2 :more more))
515 (loop for (svc . more) on (proto-services schema) doing
516 (write-schema-as type svc stream :indentation 2 :more more)))
517 (format stream ")~%")))
519 (defmethod write-schema-documentation ((type (eql :lisp)) docstring stream
520 &key (indentation 0))
521 (let ((lines (split-string docstring :separators '(#\newline #\return))))
523 (format stream "~&~@[~VT~];; ~A~%"
524 (and (not (zerop indentation)) indentation) line))))
526 (defmethod write-schema-header ((type (eql :lisp)) (schema protobuf-schema) stream)
527 (declare (ignorable type stream))
530 (defmethod write-schema-as ((type (eql :lisp)) (enum protobuf-enum) stream
531 &key (indentation 0) more)
532 (declare (ignore more))
534 (with-prefixed-accessors (name class alias-for
535 documentation source-location) (proto- enum)
537 (write-schema-documentation type documentation stream :indentation indentation))
538 (format stream "~@[~VT~](proto:define-enum ~(~S~)"
539 (and (not (zerop indentation)) indentation) class)
540 (let ((other (and name (string/= name (class-name->proto class)) name)))
541 (cond ((or other alias-for documentation source-location)
542 (format stream "~%~@[~VT~](~:[~2*~;:name ~S~@[~%~VT~]~]~
543 ~:[~2*~;:alias-for ~(~S~)~@[~%~VT~]~]~
544 ~:[~2*~;:documentation ~S~@[~%~VT~]~]~
545 ~:[~*~;:source-location ~/source-location/~])"
547 other other (and (or alias-for documentation source-location) (+ indentation 5))
548 alias-for alias-for (and (or documentation source-location) (+ indentation 5))
549 documentation documentation (and source-location (+ indentation 5))
550 source-location source-location))
552 (format stream " ()"))))
553 (loop for (value . more) on (proto-values enum) doing
554 (write-schema-as type value stream :indentation (+ indentation 2) :more more)
557 (format stream ")")))
559 (defmethod write-schema-as ((type (eql :lisp)) (val protobuf-enum-value) stream
560 &key (indentation 0) more)
561 (declare (ignore more))
562 (with-prefixed-accessors (value index) (proto- val)
563 (if *show-lisp-enum-indexes*
564 (format stream "~&~@[~VT~](~(~A~) ~D)"
565 (and (not (zerop indentation)) indentation) value index)
566 (format stream "~&~@[~VT~]~(~A~)"
567 (and (not (zerop indentation)) indentation) value))))
569 (defmethod write-schema-as ((type (eql :lisp)) (alias protobuf-type-alias) stream
570 &key (indentation 0) more)
571 (declare (ignore more))
573 (with-prefixed-accessors (class lisp-type proto-type serializer deserializer) (proto- alias)
574 (format stream "~@[~VT~](proto:define-type-alias ~(~S~)"
575 (and (not (zerop indentation)) indentation) class)
576 (format stream " ()") ;no options yet
577 (format stream "~%~@[~VT~]:lisp-type ~(~S~)~
578 ~%~@[~VT~]:proto-type ~(~A~)~
579 ~%~@[~VT~]:serializer ~(~S~)~
580 ~%~@[~VT~]:deserializer ~(~S~))"
581 (+ indentation 2) lisp-type
582 (+ indentation 2) proto-type
583 (+ indentation 2) serializer
584 (+ indentation 2) deserializer)))
586 (defmethod write-schema-as ((type (eql :lisp)) (message protobuf-message) stream
587 &key (indentation 0) more index arity)
588 (declare (ignore more))
589 (let ((*protobuf* message))
590 (with-prefixed-accessors (name class alias-for conc-name message-type
591 documentation source-location) (proto- message)
592 (cond ((eq message-type :group)
594 (write-schema-documentation type documentation stream :indentation indentation))
595 (format stream "~&~@[~VT~](proto:define-group ~(~S~)"
596 (and (not (zerop indentation)) indentation) class)
597 (let ((other (and name (string/= name (class-name->proto class)) name)))
598 (format stream "~%~@[~VT~](:index ~D~@[~%~VT~]~
599 :arity ~(~S~)~@[~%~VT~]~
600 ~:[~2*~;:name ~S~@[~%~VT~]~]~
601 ~:[~2*~;:alias-for ~(~S~)~@[~%~VT~]~]~
602 ~:[~2*~;:conc-name ~(~S~)~@[~%~VT~]~]~
603 ~:[~2*~;:documentation ~S~@[~%~VT~]~]~
604 ~:[~*~;:source-location ~/source-location/~])"
606 index (+ indentation 5)
607 arity (and (or other alias-for conc-name documentation source-location) (+ indentation 5))
608 other other (and (or alias-for conc-name documentation source-location) (+ indentation 5))
609 alias-for alias-for (and (or conc-name documentation source-location) (+ indentation 5))
610 conc-name conc-name (and (or documentation source-location) (+ indentation 5))
611 documentation documentation (and source-location (+ indentation 5))
612 source-location source-location))
613 (loop for (enum . more) on (proto-enums message) doing
614 (write-schema-as type enum stream :indentation (+ indentation 2) :more more)
617 (loop for (field . more) on (proto-fields message) doing
618 (write-schema-as type field stream
619 :indentation (+ indentation 2) :more more
625 (write-schema-documentation type documentation stream :indentation indentation))
626 (format stream "~&~@[~VT~](proto:define-~A ~(~S~)"
627 (and (not (zerop indentation)) indentation)
628 (if (eq message-type :message) "message" "extend") class)
629 (let ((other (and name (string/= name (class-name->proto class)) name)))
630 (cond ((eq message-type :extends)
631 (format stream " ()"))
632 ((or other alias-for conc-name documentation source-location)
633 (format stream "~%~@[~VT~](~:[~2*~;:name ~S~@[~%~VT~]~]~
634 ~:[~2*~;:alias-for ~(~S~)~@[~%~VT~]~]~
635 ~:[~2*~;:conc-name ~(~S~)~@[~%~VT~]~]~
636 ~:[~2*~;:documentation ~S~@[~%~VT~]~]~
637 ~:[~*~;:source-location ~/source-location/~])"
639 other other (and (or alias-for conc-name documentation source-location) (+ indentation 5))
640 alias-for alias-for (and (or conc-name documentation source-location) (+ indentation 5))
641 conc-name conc-name (and (or documentation source-location) (+ indentation 5))
642 documentation documentation (and source-location (+ indentation 5))
643 source-location source-location))
645 (format stream " ()"))))
646 (cond ((eq message-type :extends)
647 (loop for (field . more) on (proto-extended-fields message) doing
648 (write-schema-as type field stream
649 :indentation (+ indentation 2) :more more
654 (loop for (enum . more) on (proto-enums message) doing
655 (write-schema-as type enum stream :indentation (+ indentation 2) :more more)
658 (loop for (msg . more) on (proto-messages message) doing
659 (unless (eq (proto-message-type msg) :group)
660 (write-schema-as type msg stream :indentation (+ indentation 2) :more more)
663 (loop for (field . more) on (proto-fields message) doing
664 (write-schema-as type field stream
665 :indentation (+ indentation 2) :more more
669 (loop for (extension . more) on (proto-extensions message) doing
670 (write-schema-as type extension stream :indentation (+ indentation 2) :more more)
672 (terpri stream)))))))
673 (format stream ")"))))
675 (defparameter *protobuf-slot-comment-column* 56)
676 (defmethod write-schema-as ((type (eql :lisp)) (field protobuf-field) stream
677 &key (indentation 0) more message)
678 (with-prefixed-accessors (value required index packed options documentation) (proto- field)
679 (let* ((class (if (eq (proto-class field) 'boolean) :bool (proto-class field)))
680 (msg (and (not (keywordp class))
681 (or (find-message message class)
682 (find-enum message class)
683 (find-type-alias message class))))
684 (type (let ((cl (case class
691 ((:fixed32) 'fixed32)
692 ((:fixed64) 'fixed64)
693 ((:sfixed32) 'sfixed32)
694 ((:sfixed64) 'sfixed64)
696 ((:double) 'double-float)
699 ((:bytes) 'byte-vector)
702 (cond ((eq required :optional)
704 ((eq required :repeated)
705 (if (vector-field-p field)
709 (cond ((and (typep msg 'protobuf-message)
710 (eq (proto-message-type msg) :group))
711 (write-schema-as :lisp msg stream :indentation indentation :index index :arity required))
713 (let* ((defaultp (if (proto-alias-for message)
714 (if (eq (proto-required field) :optional)
716 (and (proto-default field)
717 (not (equalp (proto-default field) #()))
718 (not (empty-default-p field))))
719 (not (empty-default-p field))))
720 (default (proto-default field))
721 (default (and defaultp
722 (cond ((and (typep msg 'protobuf-enum)
723 (or (stringp default) (symbolp default)))
724 (let ((e (find default (proto-values msg)
725 :key #'proto-name :test #'string=)))
726 (and e (proto-value e))))
728 (boolean-true-p default))
730 (default (and defaultp
731 (if (stringp default) (escape-string default) default)))
732 (conc-name (proto-conc-name message))
733 (reader (when (and (not (eq (proto-reader field) value))
734 (not (string-equal (proto-reader field)
735 (format nil "~A~A" conc-name value))))
736 (proto-reader field)))
737 (writer (when (and (not (eq (proto-writer field) value))
738 (not (string-equal (proto-writer field)
739 (format nil "~A~A" conc-name value))))
740 (proto-writer field)))
741 (slot-name (if *show-lisp-field-indexes*
742 (format nil "(~(~S~) ~D)" value index)
743 (format nil "~(~S~)" value))))
744 (format stream (if (and (keywordp class) (not (eq class :bool)))
745 ;; Keyword class means a primitive type, print default with ~S
746 "~&~@[~VT~](~A :type ~(~S~)~:[~*~; :default ~S~]~
747 ~@[ :reader ~(~S~)~]~@[ :writer ~(~S~)~]~@[ :packed ~(~S~)~]~
748 ~@[ :options (~{~/protobuf-option/~^ ~})~])~
750 ;; Non-keyword class means an enum type, print default with ~(~S~)
751 "~&~@[~VT~](~A :type ~(~S~)~:[~*~; :default ~(~S~)~]~
752 ~@[ :reader ~(~S~)~]~@[ :writer ~(~S~)~]~@[ :packed ~(~S~)~]~
753 ~@[ :options (~{~/protobuf-option/~^ ~})~])~
755 (and (not (zerop indentation)) indentation)
756 slot-name type defaultp default reader writer packed options
757 ;; Don't write the comment if we'll insert a close paren after it
758 (and more documentation) *protobuf-slot-comment-column* documentation)))))))
760 (defmethod write-schema-as ((type (eql :lisp)) (extension protobuf-extension) stream
761 &key (indentation 0) more)
762 (declare (ignore more))
763 (with-prefixed-accessors (from to) (proto-extension- extension)
764 (format stream "~&~@[~VT~](proto:define-extension ~D ~D)"
765 (and (not (zerop indentation)) indentation)
766 from (if (eql to #.(1- (ash 1 29))) "max" to))))
768 (defmethod write-schema-as ((type (eql :lisp)) (service protobuf-service) stream
769 &key (indentation 0) more)
770 (declare (ignore more))
771 (with-prefixed-accessors (class documentation name source-location) (proto- service)
773 (write-schema-documentation type documentation stream :indentation indentation))
774 (format stream "~&~@[~VT~](proto:define-service ~(~S~)"
775 (and (not (zerop indentation)) indentation) (proto-class service))
776 (let ((other (and name (string/= name (class-name->proto (proto-class service))) name)))
777 (cond ((or documentation other source-location)
778 (format stream "~%~@[~VT~](~:[~2*~;:documentation ~S~@[~%~VT~]~]~
779 ~:[~2*~;:name ~S~@[~%~VT~]~]~
780 ~:[~*~;:source-location ~/source-location/~])"
782 documentation documentation (and (or documentation source-location) (+ indentation 5))
783 other other (and source-location (+ indentation 5))
784 source-location source-location))
786 (format stream " ()"))))
787 (loop for (method . more) on (proto-methods service) doing
788 (write-schema-as type method stream :indentation (+ indentation 2) :more more)
791 (format stream ")")))
793 (defmethod write-schema-as ((type (eql :lisp)) (method protobuf-method) stream
794 &key (indentation 0) more)
795 (declare (ignore more))
796 (with-prefixed-accessors (class input-type output-type streams-type
797 name input-name output-name streams-name
798 options documentation source-location) (proto- method)
800 (write-schema-documentation type documentation stream :indentation indentation))
801 (format stream "~&~@[~VT~](~(~S~) (" (and (not (zerop indentation)) indentation) class)
802 (if (and input-name (string/= (class-name->proto input-type) input-name))
803 (format stream "(~(~S~) :name ~S) => " input-type input-name)
804 (format stream "~(~S~) => " input-type))
805 (if (and output-name (string/= (class-name->proto output-type) output-name))
806 (format stream "(~(~S~) :name ~S)" output-type output-name)
807 (format stream "~(~S~)" output-type))
809 (if (and streams-name (string/= (class-name->proto streams-type) streams-name))
810 (format stream " :streams (~(~S~) :name ~S)" streams-type streams-name)
811 (format stream " :streams ~(~S~)" streams-type)))
813 (when (and name (string/= (class-name->proto name) name))
814 (format stream "~%~VT:name ~S"
815 (+ indentation 2) name))
817 (format stream "~%~VT:options (~{~/protobuf-option/~^ ~})"
818 (+ indentation 2) options))
819 (format stream ")")))
822 ;;; Collect symbols to be exported
824 (defgeneric collect-exports (schema)
826 "Collect all the symbols that should be exported from a Protobufs package"))
828 (defmethod collect-exports ((schema protobuf-schema))
831 (append (mapcan #'collect-exports (proto-enums schema))
832 (mapcan #'collect-exports (proto-messages schema))
833 (mapcan #'collect-exports (proto-services schema))))
836 ;; Export just the type name
837 (defmethod collect-exports ((enum protobuf-enum))
838 (list (proto-class enum)))
840 ;; Export the class name and all of the accessor names
841 (defmethod collect-exports ((message protobuf-message))
842 (append (list (proto-class message))
843 (mapcan #'collect-exports (proto-messages message))
844 (mapcan #'collect-exports (proto-fields message))))
846 ;; Export just the slot accessor name
847 (defmethod collect-exports ((field protobuf-field))
848 (list (or (proto-reader field)
849 (proto-slot field))))
851 ;; Export the names of all the methods
852 (defmethod collect-exports ((service protobuf-service))
853 (mapcan #'collect-exports (proto-methods service)))
855 ;; Export just the method name
856 (defmethod collect-exports ((method protobuf-method))
857 (list (proto-client-stub method) (proto-server-stub method)))