purescript-0.15.15: 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.

Role Text 

data ContainingModule #

This type is isomorphic to Maybe ModuleName. It makes code a bit easier to read, as the meaning is more explicit.

Instances

Instances details
FromJSON ContainingModule # 
Instance details

Defined in Language.PureScript.Docs.RenderedCode.Types

ToJSON ContainingModule # 
Instance details

Defined in Language.PureScript.Docs.RenderedCode.Types

Show ContainingModule # 
Instance details

Defined in Language.PureScript.Docs.RenderedCode.Types

Eq ContainingModule # 
Instance details

Defined in Language.PureScript.Docs.RenderedCode.Types

Ord ContainingModule # 
Instance details

Defined in Language.PureScript.Docs.RenderedCode.Types

maybeToContainingModule :: Maybe ModuleName -> ContainingModule #

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

data Namespace #

Constructors

ValueLevel 
TypeLevel 

Instances

Instances details
FromJSON Namespace # 
Instance details

Defined in Language.PureScript.Docs.RenderedCode.Types

ToJSON Namespace # 
Instance details

Defined in Language.PureScript.Docs.RenderedCode.Types

NFData Namespace # 
Instance details

Defined in Language.PureScript.Docs.RenderedCode.Types

Methods

rnf :: Namespace -> () #

Generic Namespace # 
Instance details

Defined in Language.PureScript.Docs.RenderedCode.Types

Associated Types

type Rep Namespace 
Instance details

Defined in Language.PureScript.Docs.RenderedCode.Types

type Rep Namespace = D1 ('MetaData "Namespace" "Language.PureScript.Docs.RenderedCode.Types" "purescript-0.15.15-8K0LbmS63k4ILju2RsIrDp" 'False) (C1 ('MetaCons "ValueLevel" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "TypeLevel" 'PrefixI 'False) (U1 :: Type -> Type))
Show Namespace # 
Instance details

Defined in Language.PureScript.Docs.RenderedCode.Types

Eq Namespace # 
Instance details

Defined in Language.PureScript.Docs.RenderedCode.Types

Ord Namespace # 
Instance details

Defined in Language.PureScript.Docs.RenderedCode.Types

type Rep Namespace # 
Instance details

Defined in Language.PureScript.Docs.RenderedCode.Types

type Rep Namespace = D1 ('MetaData "Namespace" "Language.PureScript.Docs.RenderedCode.Types" "purescript-0.15.15-8K0LbmS63k4ILju2RsIrDp" 'False) (C1 ('MetaCons "ValueLevel" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "TypeLevel" 'PrefixI 'False) (U1 :: Type -> Type))

data Link #

Instances

data RenderedCode #

A type representing a highly simplified version of PureScript code, intended for use in output formats like plain text or HTML.

Instances

Instances details
ToJSON RenderedCode # 
Instance details

Defined in Language.PureScript.Docs.RenderedCode.Types

Monoid RenderedCode # 
Instance details

Defined in Language.PureScript.Docs.RenderedCode.Types

Semigroup RenderedCode # 
Instance details

Defined in Language.PureScript.Docs.RenderedCode.Types

Show RenderedCode # 
Instance details

Defined in Language.PureScript.Docs.RenderedCode.Types

Eq RenderedCode # 
Instance details

Defined in Language.PureScript.Docs.RenderedCode.Types

Ord RenderedCode # 
Instance details

Defined in Language.PureScript.Docs.RenderedCode.Types

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.