purescript-0.11.5: PureScript Programming Language Compiler

Safe HaskellNone
LanguageHaskell2010

Language.PureScript.Docs.RenderedCode.Types

Description

Data types and functions for representing a simplified form of PureScript code, intended for use in e.g. HTML documentation.

Synopsis

Documentation

data RenderedCodeElement #

A single element in a rendered code fragment. The intention is to support multiple output formats. For example, plain text, or highlighted HTML.

Constructors

Syntax Text 
Keyword Text 
Space 
Symbol Namespace Text Link

Any symbol which you might or might not want to link to, in any namespace (value, type, or kind). Note that this is not related to the kind called Symbol for type-level strings.

containingModuleToMaybe :: ContainingModule -> Maybe ModuleName #

Convert a ContainingModule to a Maybe ModuleName, using the obvious isomorphism.

maybeToContainingModule :: Maybe ModuleName -> ContainingModule #

Convert a Maybe ModuleName to a ContainingModule, using the obvious isomorphism.

data Namespace #

Instances

Eq Namespace # 
Ord Namespace # 
Show Namespace # 
Generic Namespace # 

Associated Types

type Rep Namespace :: * -> * #

ToJSON Namespace # 
FromJSON Namespace # 
NFData Namespace # 

Methods

rnf :: Namespace -> () #

type Rep Namespace # 
type Rep Namespace = D1 (MetaData "Namespace" "Language.PureScript.Docs.RenderedCode.Types" "purescript-0.11.5-GSbpj2HrH1jE4iAZlndlxC" False) ((:+:) (C1 (MetaCons "ValueLevel" PrefixI False) U1) ((:+:) (C1 (MetaCons "TypeLevel" PrefixI False) U1) (C1 (MetaCons "KindLevel" PrefixI False) U1)))

data Link #

outputWith :: Monoid a => (RenderedCodeElement -> a) -> RenderedCode -> a #

This function allows conversion of a RenderedCode value into a value of some other type (for example, plain text, or HTML). The first argument is a function specifying how each individual RenderedCodeElement should be rendered.

sp :: RenderedCode #

A RenderedCode fragment representing a space.

parens :: RenderedCode -> RenderedCode #

Wrap a RenderedCode value in parens.