Safe Haskell	None
Language	Haskell2010

Curly.Core.Documentation

Contents

The Documentation format
Rendering documentation
- Styles
- Rendering
Metadata
Formatted Strings

Synopsis

The Documentation format

data DocNode a Source #

A documentation node (similar to a HTML node, but simpler)

Constructors

DocTag String [(String, String)] [a]

Instances

Functor DocNode Source #
Methods map :: (a -> b) -> DocNode a -> DocNode b #
Foldable DocNode Source #
Methods fold :: Monoid m => DocNode m -> m #
Traversable DocNode Source #
Methods sequence :: Applicative f => DocNode (f a) -> f (DocNode a) #
Serializable Bytes a => Serializable Bytes (DocNode a) Source #
Methods encode :: Proxy Bytes -> DocNode a -> StreamBuilder Bytes #
Format Bytes a => Format Bytes (DocNode a) Source #
Methods datum :: Parser Bytes (DocNode a) #
Serializable Bytes a => Serializable Bytes (Free DocNode a) Source #
Methods encode :: Proxy Bytes -> Free DocNode a -> StreamBuilder Bytes #
Format Bytes a => Format Bytes (Free DocNode a) Source #
Methods datum :: Parser Bytes (Free DocNode a) #
Eq a => Eq (DocNode a) Source #
Methods (==) :: DocNode a -> DocNode a -> Bool # (/=) :: DocNode a -> DocNode a -> Bool #
Ord a => Ord (DocNode a) Source #
Methods compare :: DocNode a -> DocNode a -> Ordering # (<) :: DocNode a -> DocNode a -> Bool # (<=) :: DocNode a -> DocNode a -> Bool # (>) :: DocNode a -> DocNode a -> Bool # (>=) :: DocNode a -> DocNode a -> Bool # max :: DocNode a -> DocNode a -> DocNode a # min :: DocNode a -> DocNode a -> DocNode a #
Show a => Show (DocNode a) Source #
Methods showsPrec :: Int -> DocNode a -> ShowS # show :: DocNode a -> String # showList :: [DocNode a] -> ShowS #
Generic (DocNode a) Source #
Associated Types type Rep (DocNode a) :: * -> * # Methods from :: DocNode a -> Rep (DocNode a) x # to :: Rep (DocNode a) x -> DocNode a #
Documented a => Documented (Free DocNode a) Source #
Methods document :: Free DocNode a -> Documentation Source #
type Rep (DocNode a) Source #
type Rep (DocNode a) = D1 (MetaData "DocNode" "Curly.Core.Documentation" "curly-core-0.7.2-5Alk9IYXOqrI6xJCLJNJpU" False) (C1 (MetaCons "DocTag" PrefixI False) ((::) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)) ((::) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(String, String)])) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [a])))))

type Documentation = Free DocNode String Source #

class Documented t where Source #

Minimal complete definition

document

Methods

document :: t -> Documentation Source #

Instances

Documented Int Source #
Methods document :: Int -> Documentation Source #
Documented String Source #
Methods document :: String -> Documentation Source #
Documented Metadata Source #
Methods document :: Metadata -> Documentation Source #
Documented GlobalID Source #
Methods document :: GlobalID -> Documentation Source #
Documented LibraryID Source #
Methods document :: LibraryID -> Documentation Source #
Documented Builtin Source #
Methods document :: Builtin -> Documentation Source #
Documented CurlyParserException Source #
Methods document :: CurlyParserException -> Documentation Source #
Identifier s => Documented (Type s) Source #
Methods document :: Type s -> Documentation Source #
Identifier s => Documented (Strictness s) Source #
Methods document :: Strictness s -> Documentation Source #
Documented (Symbol s) Source #
Methods document :: Symbol s -> Documentation Source #
Documented a => Documented (Module a) Source #
Methods document :: Module a -> Documentation Source #
Documented a => Documented (Free DocNode a) Source #
Methods document :: Free DocNode a -> Documentation Source #
(Documented s, Documented a) => Documented (Expression s a) Source #
Methods document :: Expression s a -> Documentation Source #

docNodeAttrs :: Lens' (DocNode a) [(String, String)] Source #

docNodeSubs :: Lens [a] [b] (DocNode a) (DocNode b) Source #

docTag :: String -> [(String, String)] -> [Free DocNode a] -> Free DocNode a Source #

docTag' :: String -> [Free DocNode a] -> Free DocNode a Source #

nodoc :: String -> Documentation Source #

mkDoc Source #

Arguments

:: String	The root tag name
-> String	Documentation in textual format
-> Documentation

showRawDoc :: Documentation -> String Source #

docAtom :: (ParseStream s, StreamChar s ~ Char, Monad m) => ParserT s m Documentation Source #

docLine :: (ParseStream s, StreamChar s ~ Char, Monad m) => String -> [(String, String)] -> ParserT s m Documentation Source #

docFormat :: (ParseStream s, StreamChar s ~ Char, Monad m) => String -> [Char] -> ParserT s m Documentation Source #

type DocParams = Forest (Map String) Documentation Source #

type DocPatterns = Map String ([String], Documentation) Source #

evalDoc :: DocParams -> Documentation -> Maybe Documentation Source #

evalDocWithPatterns :: DocPatterns -> DocParams -> Documentation -> Maybe Documentation Source #

Rendering documentation

Styles

data TagStyle Source #

Constructors

TagStyle
Fields _tagColor :: (Maybe TermColor, Maybe TermColor) _tagDisplay :: Maybe TagDisplay _tagIsBold :: Maybe Bool _tagIsUnderlined :: Maybe Bool _tagIsItalic :: Maybe Bool _tagPrefix :: Maybe String _tagIndent :: Maybe Int _tagIsRawText :: Maybe Bool _tagWordWrap :: Maybe Int

Instances

Semigroup TagStyle Source #
Methods (+) :: TagStyle -> TagStyle -> TagStyle #
Monoid TagStyle Source #
Methods zero :: TagStyle #

data TermColor Source #

Constructors

Black
Red
Green
Yellow
Blue
Magenta
Cyan
White
ColorNumber Int

data TagDisplay Source #

Constructors

Inline
Block Bool

type Style = Map String TagStyle Source #

defaultStyle :: Style Source #

tagColor :: Lens' TagStyle (Maybe TermColor, Maybe TermColor) Source #

tagDisplay :: Lens' TagStyle (Maybe TagDisplay) Source #

tagIsBold :: Lens' TagStyle (Maybe Bool) Source #

tagIsUnderlined :: Lens' TagStyle (Maybe Bool) Source #

tagIndent :: Lens' TagStyle (Maybe Int) Source #

tagPrefix :: Lens' TagStyle (Maybe String) Source #

tagIsItalic :: Lens' TagStyle (Maybe Bool) Source #

tagWordWrap :: Lens' TagStyle (Maybe Int) Source #

Rendering

class Terminal trm where Source #

Minimal complete definition

setBold, setUnderlined, setItalic, setForegroundColor, setBackgroundColor, restoreDefaultColors

Methods

setBold :: trm -> Bool -> String Source #

setUnderlined :: trm -> Bool -> String Source #

setItalic :: trm -> Bool -> String Source #

setForegroundColor :: trm -> TermColor -> String Source #

setBackgroundColor :: trm -> TermColor -> String Source #

restoreDefaultColors :: trm -> String Source #

Instances

Terminal DummyTerminal Source #
Methods setBold :: DummyTerminal -> Bool -> String Source # setUnderlined :: DummyTerminal -> Bool -> String Source # setItalic :: DummyTerminal -> Bool -> String Source # setForegroundColor :: DummyTerminal -> TermColor -> String Source # setBackgroundColor :: DummyTerminal -> TermColor -> String Source # restoreDefaultColors :: DummyTerminal -> String Source #

data DummyTerminal Source #

Constructors

DummyTerminal

Instances

Terminal DummyTerminal Source #
Methods setBold :: DummyTerminal -> Bool -> String Source # setUnderlined :: DummyTerminal -> Bool -> String Source # setItalic :: DummyTerminal -> Bool -> String Source # setForegroundColor :: DummyTerminal -> TermColor -> String Source # setBackgroundColor :: DummyTerminal -> TermColor -> String Source # restoreDefaultColors :: DummyTerminal -> String Source #

docString :: Terminal trm => trm -> Style -> Documentation -> String Source #

pretty :: Documented t => t -> String Source #

Metadata

newtype Metadata Source #

Constructors

Metadata (Forest (Map String) String)

Instances

Read Metadata Source #
Methods readsPrec :: Int -> ReadS Metadata # readList :: ReadS [Metadata] # readPrec :: ReadPrec Metadata # readListPrec :: ReadPrec [Metadata] #
Show Metadata Source #
Methods showsPrec :: Int -> Metadata -> ShowS # show :: Metadata -> String # showList :: [Metadata] -> ShowS #
Semigroup Metadata Source #
Methods (+) :: Metadata -> Metadata -> Metadata #
Monoid Metadata Source #
Methods zero :: Metadata #
Documented Metadata Source #
Methods document :: Metadata -> Documentation Source #
Serializable Bytes Metadata Source #
Methods encode :: Proxy Bytes -> Metadata -> StreamBuilder Bytes #
Format Bytes Metadata Source #
Methods datum :: Parser Bytes Metadata #
DataMap Metadata String (Free (Map String) String) Source #
Methods at :: String -> Lens' Metadata (Maybe (Free (Map String) String)) #

i'Metadata :: Iso' (Forest (Map String) String) Metadata Source #

Formatted Strings

class Show a => FormatArg a where Source #

A class for all types that can be formatted to a string

Minimal complete definition

argClass

Methods

argClass :: a -> Char Source #

showFormat :: a -> String Source #

Instances

FormatArg Double Source #
Methods argClass :: Double -> Char Source # showFormat :: Double -> String Source #
FormatArg Float Source #
Methods argClass :: Float -> Char Source # showFormat :: Float -> String Source #
FormatArg Int Source #
Methods argClass :: Int -> Char Source # showFormat :: Int -> String Source #
FormatArg String Source #
Methods argClass :: String -> Char Source # showFormat :: String -> String Source #
FormatArg PortNumber Source #
Methods argClass :: PortNumber -> Char Source # showFormat :: PortNumber -> String Source #
FormatArg KeyFingerprint Source #
Methods argClass :: KeyFingerprint -> Char Source # showFormat :: KeyFingerprint -> String Source #

class FormatType a where Source #

A base class for the format function

Minimal complete definition

format'

Methods

format' :: String -> String -> a Source #

Instances

FormatType String Source #
Methods format' :: String -> String -> String Source #
(FormatArg a, FormatType r) => FormatType (a -> r) Source #
Methods format' :: String -> String -> a -> r Source #

format :: FormatType r => String -> r Source #

A function that mimics sprintf-style formatting for Haskell