ghc-9.10.0.20240426: The GHC API
Copyright(c) The University of Glasgow 2001
LicenseBSD-style (see the file LICENSE)
MaintainerJeffrey Young <jeffrey.young@iohk.io> Luite Stegeman <luite.stegeman@iohk.io> Sylvain Henry <sylvain.henry@iohk.io> Josh Meredith <josh.meredith@iohk.io>
Stabilityexperimental
Safe HaskellNone
LanguageGHC2021

GHC.JS.Ppr

Description

  • Domain and Purpose

    GHC.JS.Ppr defines the code generation facilities for the JavaScript backend. That is, this module exports a function from the JS backend IR to JavaScript compliant concrete syntax that can readily be executed by nodejs or called in a browser.

  • Design

    This module follows the architecture and style of the other backends in GHC: it intances Outputable for the relevant types, creates a class that describes a morphism from the IR domain to JavaScript concrete Syntax and then generates that syntax on a case by case basis.

  • How to use

    The key functions are renderJS, jsToDoc, and the RenderJS record. Use the RenderJS record and jsToDoc to define a custom renderers for specific parts of the backend, for example in Opt a custom renderer ensures all Ident generated by the linker optimization pass are prefixed differently than the default. Use renderJS to generate JavaScript concrete syntax in the general case, suitable for human consumption.

Synopsis

Documentation

renderJs :: JsToDoc a => a -> SDoc Source #

Render a syntax tree as a pretty-printable document (simply showing the resultant doc produces a nice, well formatted String).

renderPrefixJs :: JsToDoc a => a -> SDoc Source #

Render a syntax tree as a pretty-printable document, using a given prefix to all generated names. Use this with distinct prefixes to ensure distinct generated names between independent calls to render(Prefix)Js.

renderPrefixJs' :: (JsToDoc a, JsRender doc) => RenderJs doc -> a -> doc Source #

class JsToDoc a where Source #

Methods

jsToDocR :: JsRender doc => RenderJs doc -> a -> doc Source #

Instances

Instances details
JsToDoc Ident Source # 
Instance details

Defined in GHC.JS.Ppr

Methods

jsToDocR :: JsRender doc => RenderJs doc -> Ident -> doc Source #

JsToDoc JExpr Source # 
Instance details

Defined in GHC.JS.Ppr

Methods

jsToDocR :: JsRender doc => RenderJs doc -> JExpr -> doc Source #

JsToDoc JStat Source # 
Instance details

Defined in GHC.JS.Ppr

Methods

jsToDocR :: JsRender doc => RenderJs doc -> JStat -> doc Source #

JsToDoc JVal Source # 
Instance details

Defined in GHC.JS.Ppr

Methods

jsToDocR :: JsRender doc => RenderJs doc -> JVal -> doc Source #

JsToDoc [JExpr] Source # 
Instance details

Defined in GHC.JS.Ppr

Methods

jsToDocR :: JsRender doc => RenderJs doc -> [JExpr] -> doc Source #

JsToDoc [JStat] Source # 
Instance details

Defined in GHC.JS.Ppr

Methods

jsToDocR :: JsRender doc => RenderJs doc -> [JStat] -> doc Source #

data RenderJs doc Source #

Constructors

RenderJs 

Fields

class IsLine doc => JsRender doc where Source #

JsRender controls the differences in whitespace between HLine and SDoc. Generally, this involves the indentation and newlines in the human-readable SDoc implementation being replaced in the HLine version by the minimal whitespace required for valid JavaScript syntax.

Methods

(<+?>) :: doc -> doc -> doc Source #

Concatenate with an optional single space

($$$) :: doc -> doc -> doc Source #

Concatenate with an optional newline

jcat :: [doc] -> doc Source #

Concatenate these docs, either vertically (SDoc) or horizontally (HLine)

jnest :: doc -> doc Source #

Optionally indent the following

addSemi :: doc -> doc Source #

Append semi-colon (and line-break in HLine mode)

Instances

Instances details
JsRender HLine Source # 
Instance details

Defined in GHC.JS.Ppr

JsRender SDoc Source # 
Instance details

Defined in GHC.JS.Ppr

jsToDoc :: JsToDoc a => a -> SDoc Source #

interSemi :: JsRender doc => [doc] -> doc Source #

braceNest :: JsRender doc => doc -> doc Source #

The structure `{body}`, optionally indented over multiple lines

hangBrace :: JsRender doc => doc -> doc -> doc Source #

The structure `hdr {body}`, optionally indented over multiple lines

Orphan instances

Outputable JExpr Source # 
Instance details

Methods

ppr :: JExpr -> SDoc Source #

Outputable JVal Source # 
Instance details

Methods

ppr :: JVal -> SDoc Source #