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 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.

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 Text 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

FromJSON ContainingModule

Methods

parseJSON :: Value -> Parser ContainingModule

asContainingModule :: Parse Text 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.

fromQualified :: Qualified a -> (ContainingModule, a)

data Namespace

Constructors

ValueLevel

TypeLevel

KindLevel

Instances

Eq Namespace

Methods

(==) :: Namespace -> Namespace -> Bool

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

Ord Namespace

Methods

compare :: Namespace -> Namespace -> Ordering

(<) :: Namespace -> Namespace -> Bool

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

(>) :: Namespace -> Namespace -> Bool

(>=) :: Namespace -> Namespace -> Bool

max :: Namespace -> Namespace -> Namespace

min :: Namespace -> Namespace -> Namespace

Show Namespace

Methods

showsPrec :: Int -> Namespace -> ShowS

show :: Namespace -> String

showList :: [Namespace] -> ShowS

Generic Namespace

Associated Types

type Rep Namespace :: * -> *

Methods

from :: Namespace -> Rep Namespace x

to :: Rep Namespace x -> Namespace

ToJSON Namespace

Methods

toJSON :: Namespace -> Value

toEncoding :: Namespace -> Encoding

FromJSON Namespace

Methods

parseJSON :: Value -> Parser Namespace

NFData Namespace

Methods

rnf :: Namespace -> ()

type Rep Namespace

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

data Link

Constructors

NoLink

Link ContainingModule

Instances

Eq Link

Methods

(==) :: Link -> Link -> Bool

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

Ord Link

Methods

compare :: Link -> Link -> Ordering

(<) :: Link -> Link -> Bool

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

(>) :: Link -> Link -> Bool

(>=) :: Link -> Link -> Bool

max :: Link -> Link -> Link

min :: Link -> Link -> Link

Show Link

Methods

showsPrec :: Int -> Link -> ShowS

show :: Link -> String

showList :: [Link] -> ShowS

ToJSON Link

Methods

toJSON :: Link -> Value

toEncoding :: Link -> Encoding

FromJSON Link

Methods

parseJSON :: Value -> Parser Link

type FixityAlias = Qualified (Either (ProperName TypeName) (Either Ident (ProperName ConstructorName)))

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 Text 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.

parens :: RenderedCode -> RenderedCode

Wrap a RenderedCode value in parens.

syntax :: Text -> RenderedCode

keyword :: Text -> RenderedCode

keywordForall :: RenderedCode

keywordData :: RenderedCode

keywordNewtype :: RenderedCode

keywordType :: RenderedCode

keywordClass :: RenderedCode

keywordInstance :: RenderedCode

keywordWhere :: RenderedCode

keywordFixity :: Associativity -> RenderedCode

keywordKind :: RenderedCode

keywordAs :: RenderedCode

ident :: Qualified Ident -> RenderedCode

dataCtor :: Qualified (ProperName ConstructorName) -> RenderedCode

typeCtor :: Qualified (ProperName TypeName) -> RenderedCode

typeOp :: Qualified (OpName TypeOpName) -> RenderedCode

typeVar :: Text -> RenderedCode

kind :: Qualified (ProperName KindName) -> RenderedCode

alias :: FixityAlias -> RenderedCode

aliasName :: FixityAlias -> Text -> RenderedCode