Safe Haskell	None
Language	Haskell98

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 Source #

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 Source #
Methods (==) :: RenderedCodeElement -> RenderedCodeElement -> Bool # (/=) :: RenderedCodeElement -> RenderedCodeElement -> Bool #
Ord RenderedCodeElement Source #
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 Source #
Methods showsPrec :: Int -> RenderedCodeElement -> ShowS # show :: RenderedCodeElement -> String # showList :: [RenderedCodeElement] -> ShowS #
ToJSON RenderedCodeElement Source #
Methods toJSON :: RenderedCodeElement -> Value # toEncoding :: RenderedCodeElement -> Encoding #

asRenderedCodeElement :: Parse String RenderedCodeElement Source #

data ContainingModule Source #

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 Source #
Methods (==) :: ContainingModule -> ContainingModule -> Bool # (/=) :: ContainingModule -> ContainingModule -> Bool #
Ord ContainingModule Source #
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 Source #
Methods showsPrec :: Int -> ContainingModule -> ShowS # show :: ContainingModule -> String # showList :: [ContainingModule] -> ShowS #
ToJSON ContainingModule Source #
Methods toJSON :: ContainingModule -> Value # toEncoding :: ContainingModule -> Encoding #

asContainingModule :: Parse e ContainingModule Source #

containingModuleToMaybe :: ContainingModule -> Maybe ModuleName Source #

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

maybeToContainingModule :: Maybe ModuleName -> ContainingModule Source #

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

fromContainingModule :: ModuleName -> ContainingModule -> ModuleName Source #

A version of fromMaybe for ContainingModule values.

data RenderedCode Source #

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

Instances

Eq RenderedCode Source #
Methods (==) :: RenderedCode -> RenderedCode -> Bool # (/=) :: RenderedCode -> RenderedCode -> Bool #
Ord RenderedCode Source #
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 Source #
Methods showsPrec :: Int -> RenderedCode -> ShowS # show :: RenderedCode -> String # showList :: [RenderedCode] -> ShowS #
Monoid RenderedCode Source #
Methods mempty :: RenderedCode # mappend :: RenderedCode -> RenderedCode -> RenderedCode # mconcat :: [RenderedCode] -> RenderedCode #
ToJSON RenderedCode Source #
Methods toJSON :: RenderedCode -> Value # toEncoding :: RenderedCode -> Encoding #

asRenderedCode :: Parse String RenderedCode Source #

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

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 Source #

A RenderedCode fragment representing a space.

syntax :: String -> RenderedCode Source #

ident :: String -> RenderedCode Source #

ident' :: String -> ContainingModule -> RenderedCode Source #

ctor :: String -> ContainingModule -> RenderedCode Source #

kind :: String -> RenderedCode Source #

keyword :: String -> RenderedCode Source #

keywordForall :: RenderedCode Source #

keywordData :: RenderedCode Source #

keywordNewtype :: RenderedCode Source #

keywordType :: RenderedCode Source #

keywordClass :: RenderedCode Source #

keywordInstance :: RenderedCode Source #

keywordWhere :: RenderedCode Source #

keywordFixity :: Associativity -> RenderedCode Source #