fr.jeremyschoffen.prose.alpha.compilation.core — fr.jeremyschoffen/prose-alpha 30

Api providing generic compilation utilities.

*compilation-out* clj/s

Dynamic var that must be bound to an implementation of the Output protocol. It is used as the output of the emit! function.

*implementation* clj/s

Map containing the default functions of a compiler implementation.

It has 4 keys:

• :name: the name of the implementation (a keyword)
• :default-emit-str!: function that compiles plain text. The escaping logic is intended to live here.
• :default-emit-tag!: function that compiles a regular tag.
• :default-emit-special!: function that compiles a special tag

By default this var provides functions that throw exceptions forcing specific implementations to define them.

bind-output clj macro

(bind-output out & body)

Bind *compilation-out* to out and execute body in this environment.

emit! clj/s

(emit! & args)

Emit text to *compilation-out*.

args are emitted in sequence, nil values are discarded.

emit-doc! clj/s

(emit-doc! node)

Emit a document to *compilation-out*. The *implementation* also needs to be bound.

emit-seq! clj/s

(emit-seq! ss)

emit-special! clj/s multimethod

Generic emit-special! function using the specific implementation from *implementation* by default.

This function dispatches on a pair of value constructed like this: [(:name *implementation*) (:type node)], node being a map, the only argument of the function.

emit-str! clj/s

(emit-str! s)

Generic emit! function using the specific implementation from *implementation*.

emit-tag! clj/s multimethod

Generic emit-tag! function using the specific implementation from *implementation* by default.

This function dispatches on a pair of value constructed like this: [(:name *implementation*) (:tag node)], node being a map, the only argument of the function.

Output clj/s protocol

append! clj/s

(append! this text)

text-environment clj macro

(text-environment & body)

Binds *compilation-out* to a stringbuilder using text-output

text-output clj/s≠

(text-output)

clj

Create a text output intended to be a possible binding for *compilation-out* using a java java.lang.StringBuilder.

with-implementation clj macro

(with-implementation i & body)

Binds the dynamic var *implementation* to i.

See *implementation* for specifics.