Language.PureScript.Docs.RenderedCode.Types

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

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 String

Ident String ContainingModule

Ctor String ContainingModule

Kind String

Keyword String

Space

Instances

Eq RenderedCodeElement

Methods

(==) :: RenderedCodeElement -> RenderedCodeElement -> Bool

(/=) :: RenderedCodeElement -> RenderedCodeElement -> Bool

Ord RenderedCodeElement

Methods

compare :: RenderedCodeElement -> RenderedCodeElement -> Ordering

(<) :: RenderedCodeElement -> RenderedCodeElement -> Bool

(<=) :: RenderedCodeElement -> RenderedCodeElement -> Bool

(>) :: RenderedCodeElement -> RenderedCodeElement -> Bool

(>=) :: RenderedCodeElement -> RenderedCodeElement -> Bool

max :: RenderedCodeElement -> RenderedCodeElement -> RenderedCodeElement

min :: RenderedCodeElement -> RenderedCodeElement -> RenderedCodeElement

Show RenderedCodeElement

Methods

showsPrec :: Int -> RenderedCodeElement -> ShowS

show :: RenderedCodeElement -> String

showList :: [RenderedCodeElement] -> ShowS

ToJSON RenderedCodeElement

Methods

toJSON :: RenderedCodeElement -> Value

toEncoding :: RenderedCodeElement -> Encoding

asRenderedCodeElement :: Parse String RenderedCodeElement

data ContainingModule

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

Constructors

ThisModule

OtherModule ModuleName

Instances

Eq ContainingModule

Methods

(==) :: ContainingModule -> ContainingModule -> Bool

(/=) :: ContainingModule -> ContainingModule -> Bool

Ord ContainingModule

Methods

compare :: ContainingModule -> ContainingModule -> Ordering

(<) :: ContainingModule -> ContainingModule -> Bool

(<=) :: ContainingModule -> ContainingModule -> Bool

(>) :: ContainingModule -> ContainingModule -> Bool

(>=) :: ContainingModule -> ContainingModule -> Bool

max :: ContainingModule -> ContainingModule -> ContainingModule

min :: ContainingModule -> ContainingModule -> ContainingModule

Show ContainingModule

Methods

showsPrec :: Int -> ContainingModule -> ShowS

show :: ContainingModule -> String

showList :: [ContainingModule] -> ShowS

ToJSON ContainingModule

Methods

toJSON :: ContainingModule -> Value

toEncoding :: ContainingModule -> Encoding

asContainingModule :: Parse e ContainingModule

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.

fromContainingModule :: ModuleName -> ContainingModule -> ModuleName

A version of fromMaybe for ContainingModule values.

data RenderedCode

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

Instances

Eq RenderedCode

Methods

(==) :: RenderedCode -> RenderedCode -> Bool

(/=) :: RenderedCode -> RenderedCode -> Bool

Ord RenderedCode

Methods

compare :: RenderedCode -> RenderedCode -> Ordering

(<) :: RenderedCode -> RenderedCode -> Bool

(<=) :: RenderedCode -> RenderedCode -> Bool

(>) :: RenderedCode -> RenderedCode -> Bool

(>=) :: RenderedCode -> RenderedCode -> Bool

max :: RenderedCode -> RenderedCode -> RenderedCode

min :: RenderedCode -> RenderedCode -> RenderedCode

Show RenderedCode

Methods

showsPrec :: Int -> RenderedCode -> ShowS

show :: RenderedCode -> String

showList :: [RenderedCode] -> ShowS

Monoid RenderedCode

Methods

mempty :: RenderedCode

mappend :: RenderedCode -> RenderedCode -> RenderedCode

mconcat :: [RenderedCode] -> RenderedCode

ToJSON RenderedCode

Methods

toJSON :: RenderedCode -> Value

toEncoding :: RenderedCode -> Encoding

asRenderedCode :: Parse String RenderedCode

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.

syntax :: String -> RenderedCode

ident :: String -> RenderedCode

ident' :: String -> ContainingModule -> RenderedCode

ctor :: String -> ContainingModule -> RenderedCode

kind :: String -> RenderedCode

keyword :: String -> RenderedCode

keywordForall :: RenderedCode

keywordData :: RenderedCode

keywordNewtype :: RenderedCode

keywordType :: RenderedCode

keywordClass :: RenderedCode

keywordInstance :: RenderedCode

keywordWhere :: RenderedCode

keywordFixity :: Associativity -> RenderedCode