Safe Haskell	None
Language	Haskell2010

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

data RenderedCodeElement
- = Syntax Text
- | Keyword Text
- | Space
- | Symbol Namespace Text Link
asRenderedCodeElement :: Parse Text RenderedCodeElement
data ContainingModule
- = ThisModule
- | OtherModule ModuleName
asContainingModule :: Parse Text ContainingModule
containingModuleToMaybe :: ContainingModule -> Maybe ModuleName
maybeToContainingModule :: Maybe ModuleName -> ContainingModule
fromContainingModule :: ModuleName -> ContainingModule -> ModuleName
fromQualified :: Qualified a -> (ContainingModule, a)
data Namespace
- = ValueLevel
- | TypeLevel
- | KindLevel
data Link
- = NoLink
- | Link ContainingModule
type FixityAlias = Qualified (Either (ProperName TypeName) (Either Ident (ProperName ConstructorName)))
data RenderedCode
asRenderedCode :: Parse Text RenderedCode
outputWith :: Monoid a => (RenderedCodeElement -> a) -> RenderedCode -> a
sp :: RenderedCode
parens :: RenderedCode -> RenderedCode
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

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 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 Source #
Instance details Defined in Language.PureScript.Docs.RenderedCode.Types Methods (==) :: RenderedCodeElement -> RenderedCodeElement -> Bool # (/=) :: RenderedCodeElement -> RenderedCodeElement -> Bool #
Ord RenderedCodeElement Source #
Instance details Defined in Language.PureScript.Docs.RenderedCode.Types 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 #
Instance details Defined in Language.PureScript.Docs.RenderedCode.Types Methods showsPrec :: Int -> RenderedCodeElement -> ShowS # show :: RenderedCodeElement -> String # showList :: [RenderedCodeElement] -> ShowS #
ToJSON RenderedCodeElement Source #
Instance details Defined in Language.PureScript.Docs.RenderedCode.Types Methods toJSON :: RenderedCodeElement -> Value # toEncoding :: RenderedCodeElement -> Encoding # toJSONList :: [RenderedCodeElement] -> Value # toEncodingList :: [RenderedCodeElement] -> Encoding #

asRenderedCodeElement :: Parse Text 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 #
Instance details Defined in Language.PureScript.Docs.RenderedCode.Types Methods (==) :: ContainingModule -> ContainingModule -> Bool # (/=) :: ContainingModule -> ContainingModule -> Bool #
Ord ContainingModule Source #
Instance details Defined in Language.PureScript.Docs.RenderedCode.Types 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 #
Instance details Defined in Language.PureScript.Docs.RenderedCode.Types Methods showsPrec :: Int -> ContainingModule -> ShowS # show :: ContainingModule -> String # showList :: [ContainingModule] -> ShowS #
ToJSON ContainingModule Source #
Instance details Defined in Language.PureScript.Docs.RenderedCode.Types Methods toJSON :: ContainingModule -> Value # toEncoding :: ContainingModule -> Encoding # toJSONList :: [ContainingModule] -> Value # toEncodingList :: [ContainingModule] -> Encoding #
FromJSON ContainingModule Source #
Instance details Defined in Language.PureScript.Docs.RenderedCode.Types Methods parseJSON :: Value -> Parser ContainingModule # parseJSONList :: Value -> Parser [ContainingModule] #

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

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

data Namespace Source #

Constructors

ValueLevel
TypeLevel
KindLevel

Instances

Eq Namespace Source #
Instance details Defined in Language.PureScript.Docs.RenderedCode.Types Methods (==) :: Namespace -> Namespace -> Bool # (/=) :: Namespace -> Namespace -> Bool #
Ord Namespace Source #
Instance details Defined in Language.PureScript.Docs.RenderedCode.Types 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 Source #
Instance details Defined in Language.PureScript.Docs.RenderedCode.Types Methods showsPrec :: Int -> Namespace -> ShowS # show :: Namespace -> String # showList :: [Namespace] -> ShowS #
Generic Namespace Source #
Instance details Defined in Language.PureScript.Docs.RenderedCode.Types Associated Types type Rep Namespace :: Type -> Type # Methods from :: Namespace -> Rep Namespace x # to :: Rep Namespace x -> Namespace #
NFData Namespace Source #
Instance details Defined in Language.PureScript.Docs.RenderedCode.Types Methods rnf :: Namespace -> () #
ToJSON Namespace Source #
Instance details Defined in Language.PureScript.Docs.RenderedCode.Types Methods toJSON :: Namespace -> Value # toEncoding :: Namespace -> Encoding # toJSONList :: [Namespace] -> Value # toEncodingList :: [Namespace] -> Encoding #
FromJSON Namespace Source #
Instance details Defined in Language.PureScript.Docs.RenderedCode.Types Methods parseJSON :: Value -> Parser Namespace # parseJSONList :: Value -> Parser [Namespace] #
type Rep Namespace Source #
Instance details Defined in Language.PureScript.Docs.RenderedCode.Types type Rep Namespace = D1 (MetaData "Namespace" "Language.PureScript.Docs.RenderedCode.Types" "purescript-0.13.0-1whdl2565Nb1wvlLK7uK18" False) (C1 (MetaCons "ValueLevel" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "TypeLevel" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "KindLevel" PrefixI False) (U1 :: Type -> Type)))

data Link Source #

Constructors

NoLink
Link ContainingModule

Instances

Eq Link Source #
Instance details Defined in Language.PureScript.Docs.RenderedCode.Types Methods (==) :: Link -> Link -> Bool # (/=) :: Link -> Link -> Bool #
Ord Link Source #
Instance details Defined in Language.PureScript.Docs.RenderedCode.Types 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 Source #
Instance details Defined in Language.PureScript.Docs.RenderedCode.Types Methods showsPrec :: Int -> Link -> ShowS # show :: Link -> String # showList :: [Link] -> ShowS #
ToJSON Link Source #
Instance details Defined in Language.PureScript.Docs.RenderedCode.Types Methods toJSON :: Link -> Value # toEncoding :: Link -> Encoding # toJSONList :: [Link] -> Value # toEncodingList :: [Link] -> Encoding #
FromJSON Link Source #
Instance details Defined in Language.PureScript.Docs.RenderedCode.Types Methods parseJSON :: Value -> Parser Link # parseJSONList :: Value -> Parser [Link] #

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

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 #
Instance details Defined in Language.PureScript.Docs.RenderedCode.Types Methods (==) :: RenderedCode -> RenderedCode -> Bool # (/=) :: RenderedCode -> RenderedCode -> Bool #
Ord RenderedCode Source #
Instance details Defined in Language.PureScript.Docs.RenderedCode.Types 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 #
Instance details Defined in Language.PureScript.Docs.RenderedCode.Types Methods showsPrec :: Int -> RenderedCode -> ShowS # show :: RenderedCode -> String # showList :: [RenderedCode] -> ShowS #
Semigroup RenderedCode Source #
Instance details Defined in Language.PureScript.Docs.RenderedCode.Types Methods (<>) :: RenderedCode -> RenderedCode -> RenderedCode # sconcat :: NonEmpty RenderedCode -> RenderedCode # stimes :: Integral b => b -> RenderedCode -> RenderedCode #
Monoid RenderedCode Source #
Instance details Defined in Language.PureScript.Docs.RenderedCode.Types Methods mempty :: RenderedCode # mappend :: RenderedCode -> RenderedCode -> RenderedCode # mconcat :: [RenderedCode] -> RenderedCode #
ToJSON RenderedCode Source #
Instance details Defined in Language.PureScript.Docs.RenderedCode.Types Methods toJSON :: RenderedCode -> Value # toEncoding :: RenderedCode -> Encoding # toJSONList :: [RenderedCode] -> Value # toEncodingList :: [RenderedCode] -> Encoding #

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

parens :: RenderedCode -> RenderedCode Source #

Wrap a RenderedCode value in parens.

syntax :: Text -> RenderedCode Source #

keyword :: Text -> RenderedCode Source #

keywordForall :: RenderedCode Source #

keywordData :: RenderedCode Source #

keywordNewtype :: RenderedCode Source #

keywordType :: RenderedCode Source #

keywordClass :: RenderedCode Source #

keywordInstance :: RenderedCode Source #