Safe Haskell	None
Language	Haskell2010

Curly.Core.Library

Contents

Modules
Libraries
- Documentation
Files
Repositories

Synopsis

Modules

Chunked data and Future Extensions

newtype Chunked a Source #

Constructors

Chunked
Fields getChunked :: a

Instances

Serializable Bytes a => Serializable Bytes (Chunked a) Source #
Methods encode :: Proxy Bytes -> Chunked a -> StreamBuilder Bytes #
Format Bytes a => Format Bytes (Chunked a) Source #
Methods datum :: Parser Bytes (Chunked a) #

data Extension a Source #

Instances

Serializable Bytes a => Serializable Bytes (Extension a) Source #
Methods encode :: Proxy Bytes -> Extension a -> StreamBuilder Bytes #
(ExtensionDefault a, Format Bytes a) => Format Bytes (Extension a) Source #
Methods datum :: Parser Bytes (Extension a) #
ExtensionDefault a => ExtensionDefault (Extension a) Source #
Methods extensionDefault :: Extension a Source #

data FutureExtensionTail Source #

Instances

ExtensionDefault FutureExtensionTail Source #
Methods extensionDefault :: FutureExtensionTail Source #
Serializable Bytes FutureExtensionTail Source #
Methods encode :: Proxy Bytes -> FutureExtensionTail -> StreamBuilder Bytes #
Format Bytes FutureExtensionTail Source #
Methods datum :: Parser Bytes FutureExtensionTail #

class ExtensionDefault t where Source #

Minimal complete definition

extensionDefault

Methods

extensionDefault :: t Source #

Instances

ExtensionDefault FutureExtensionTail Source #
Methods extensionDefault :: FutureExtensionTail Source #
ExtensionDefault (Maybe a) Source #
Methods extensionDefault :: Maybe a Source #
ExtensionDefault a => ExtensionDefault (Extension a) Source #
Methods extensionDefault :: Extension a Source #
(ExtensionDefault a, ExtensionDefault b) => ExtensionDefault (a, b) Source #
Methods extensionDefault :: (a, b) Source #

type FutureExtension = Extension FutureExtensionTail Source #

Nodes

newtype ModDir s a Source #

Constructors

ModDir [(s, a)]

Instances

(Serializable Bytes s, Serializable Bytes a) => Serializable Bytes (Free (ModDir s) a) Source #
Methods encode :: Proxy Bytes -> Free (ModDir s) a -> StreamBuilder Bytes #
(Serializable Bytes s, Serializable Bytes a) => Serializable Bytes (ModDir s a) Source #
Methods encode :: Proxy Bytes -> ModDir s a -> StreamBuilder Bytes #
(Format Bytes s, Format Bytes a) => Format Bytes (Free (ModDir s) a) Source #
Methods datum :: Parser Bytes (Free (ModDir s) a) #
(Format Bytes s, Format Bytes a) => Format Bytes (ModDir s a) Source #
Methods datum :: Parser Bytes (ModDir s a) #
Functor (ModDir s) Source #
Methods map :: (a -> b) -> ModDir s a -> ModDir s b #
Ord s => SemiApplicative (Zip (ModDir s)) Source #
Methods (<*>) :: Zip (ModDir s) (a -> b) -> Zip (ModDir s) a -> Zip (ModDir s) b #
Foldable (ModDir s) Source #
Methods fold :: Monoid m => ModDir s m -> m #
Traversable (ModDir s) Source #
Methods sequence :: Applicative f => ModDir s (f a) -> f (ModDir s a) #
Documented a => Documented (Module a) Source #
Methods document :: Module a -> Documentation Source #
(Show a, Show s) => Show (ModDir s a) Source #
Methods showsPrec :: Int -> ModDir s a -> ShowS # show :: ModDir s a -> String # showList :: [ModDir s a] -> ShowS #
Semigroup (ModDir s a) Source #
Methods (+) :: ModDir s a -> ModDir s a -> ModDir s a #
Monoid (ModDir s a) Source #
Methods zero :: ModDir s a #

i'ModDir :: Iso [(s, a)] [(s', a')] (ModDir s a) (ModDir s' a') Source #

type Module a = Free (ModDir String) a Source #

type Mountain = Module FileLibrary Source #

type Context = Module (GlobalID, LeafExpr GlobalID) Source #

context :: Mountain -> Context Source #

localContext :: (?mountain :: Mountain) => Context Source #

atM :: Eq s => s -> a -> Traversal' (ModDir s a) a Source #

atMs :: Eq s => [s] -> Traversal' (Free (ModDir s) a) (Free (ModDir s) a) Source #

fromPList :: Eq s => [([s], Free (ModDir s) a)] -> Free (ModDir s) a Source #

Leaves

data ModLeaf s a Source #

Instances

(Identifier s, Identifier s') => HasIdents s s' (ModLeaf s a) (ModLeaf s' a) Source #
Methods ff'idents :: FixFold s s' (ModLeaf s a) (ModLeaf s' a) Source #
(Identifier s, Serializable Bytes s, Serializable Bytes a) => Serializable Bytes (ModLeaf s a) Source #
Methods encode :: Proxy Bytes -> ModLeaf s a -> StreamBuilder Bytes #
(Identifier s, Format Bytes s, Format Bytes a) => Format Bytes (ModLeaf s a) Source #
Methods datum :: Parser Bytes (ModLeaf s a) #
Functor (ModLeaf s) Source #
Methods map :: (a -> b) -> ModLeaf s a -> ModLeaf s b #
Foldable (ModLeaf s) Source #
Methods fold :: Monoid m => ModLeaf s m -> m #
Traversable (ModLeaf s) Source #
Methods sequence :: Applicative f => ModLeaf s (f a) -> f (ModLeaf s a) #
Generic (ModLeaf s a) Source #
Associated Types type Rep (ModLeaf s a) :: * -> * # Methods from :: ModLeaf s a -> Rep (ModLeaf s a) x # to :: Rep (ModLeaf s a) x -> ModLeaf s a #
type Rep (ModLeaf s a) Source #
type Rep (ModLeaf s a) = D1 (MetaData "ModLeaf" "Curly.Core.Library" "curly-core-0.7.2-5Alk9IYXOqrI6xJCLJNJpU" False) (C1 (MetaCons "ModLeaf" PrefixI True) ((::) ((::) (S1 (MetaSel (Just Symbol "_leafDoc") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Documentation)) ((::) (S1 (MetaSel (Just Symbol "_leafPos") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 SourceRange)) (S1 (MetaSel (Just Symbol "_leafType") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Type s))))) ((::) ((::) (S1 (MetaSel (Just Symbol "_leafIsFamily") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool)) (S1 (MetaSel (Just Symbol "_leafStrictness") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Strictness s)))) ((::) (S1 (MetaSel (Just Symbol "_leafExtension") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Extension (Maybe Documentation, FutureExtension)))) (S1 (MetaSel (Just Symbol "_leafVal") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 a))))))

type SourcePos = (Int, Int, Int) Source #

data SourceRange Source #

Constructors

SourceRange (Maybe String) SourcePos SourcePos
NoRange

Instances

Semigroup SourceRange Source #
Methods (+) :: SourceRange -> SourceRange -> SourceRange #
Monoid SourceRange Source #
Methods zero :: SourceRange #
Serializable Bytes SourceRange Source #
Methods encode :: Proxy Bytes -> SourceRange -> StreamBuilder Bytes #
Format Bytes SourceRange Source #
Methods datum :: Parser Bytes SourceRange #

undefLeaf :: String -> LeafExpr GlobalID Source #

undefSymLeaf :: String -> Maybe LibraryID -> LeafExpr GlobalID Source #

leafVal :: Lens a b (ModLeaf s a) (ModLeaf s b) Source #

leafDoc :: Lens' (ModLeaf s a) Documentation Source #

leafPos :: Lens' (ModLeaf s a) SourceRange Source #

leafType :: Lens' (ModLeaf s a) (Type s) Source #

leafStrictness :: Lens' (ModLeaf s a) (Strictness s) Source #

leafIsFamily :: Lens' (ModLeaf s a) Bool Source #

Libraries

data GlobalID Source #

Constructors

GlobalID String (Maybe (String, LibraryID))

Instances

Eq GlobalID Source #
Methods (==) :: GlobalID -> GlobalID -> Bool # (/=) :: GlobalID -> GlobalID -> Bool #
Ord GlobalID Source #
Methods compare :: GlobalID -> GlobalID -> Ordering # (<) :: GlobalID -> GlobalID -> Bool # (<=) :: GlobalID -> GlobalID -> Bool # (>) :: GlobalID -> GlobalID -> Bool # (>=) :: GlobalID -> GlobalID -> Bool # max :: GlobalID -> GlobalID -> GlobalID # min :: GlobalID -> GlobalID -> GlobalID #
Show GlobalID Source #
Methods showsPrec :: Int -> GlobalID -> ShowS # show :: GlobalID -> String # showList :: [GlobalID] -> ShowS #
Generic GlobalID Source #
Associated Types type Rep GlobalID :: * -> * # Methods from :: GlobalID -> Rep GlobalID x # to :: Rep GlobalID x -> GlobalID #
NFData GlobalID Source #
Methods rnf :: GlobalID -> () #
Documented GlobalID Source #
Methods document :: GlobalID -> Documentation Source #
Identifier GlobalID Source #
Methods pureIdent :: String -> GlobalID Source # identName :: GlobalID -> String Source #
Serializable Bytes GlobalID Source #
Methods encode :: Proxy Bytes -> GlobalID -> StreamBuilder Bytes #
Format Bytes GlobalID Source #
Methods datum :: Parser Bytes GlobalID #
type Rep GlobalID Source #
type Rep GlobalID = D1 (MetaData "GlobalID" "Curly.Core" "curly-core-0.7.2-5Alk9IYXOqrI6xJCLJNJpU" False) (C1 (MetaCons "GlobalID" PrefixI False) ((:*:) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (String, LibraryID))))))

isLibData :: LibraryID -> Bytes -> Bool Source #

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

data Library Source #

Instances

Semigroup Library Source #
Methods (+) :: Library -> Library -> Library #
Monoid Library Source #
Methods zero :: Library #
Serializable Bytes Library Source #
Methods encode :: Proxy Bytes -> Library -> StreamBuilder Bytes #
Format Bytes Library Source #
Methods datum :: Parser Bytes Library #

metadata :: Lens' Library Metadata Source #

imports :: Lens' Library Context Source #

exports :: Lens' Library Context Source #

symbols :: Lens' Library (Map String (LeafExpr GlobalID)) Source #

implicits :: Lens' Library (InstanceMap GlobalID (Maybe LibraryID, LeafExpr GlobalID)) Source #

addImport :: Context -> Library -> Library Source #

addExport :: Module String -> Library -> Library Source #

setExports :: Module String -> Library -> Library Source #

defSymbol :: Semantic e String (String, Maybe (NameExpr GlobalID)) => String -> SourceRange -> Maybe (Type GlobalID) -> Bool -> e -> Library -> Library Source #

libSymbol :: Library -> GlobalID -> Maybe (LeafExpr GlobalID) Source #

exprIn :: Semantic e String (String, Maybe (NameExpr GlobalID)) => Library -> e -> NameExpr GlobalID Source #

optExprIn :: Semantic e String (String, Maybe (NameExpr GlobalID)) => Library -> e -> NameExpr GlobalID Source #

builtinsLib :: FileLibrary Source #

Documentation

type LeafExpr s = ModLeaf s (NameExpr s) Source #

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 #

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

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

descSymbol :: String -> Documentation -> Library -> Library 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 #

mkDoc Source #

Arguments

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

Files

data FileLibrary Source #

A library with cached versions of its library ID and serialized self

Instances

Eq FileLibrary Source #
Methods (==) :: FileLibrary -> FileLibrary -> Bool # (/=) :: FileLibrary -> FileLibrary -> Bool #
Ord FileLibrary Source #
Methods compare :: FileLibrary -> FileLibrary -> Ordering # (<) :: FileLibrary -> FileLibrary -> Bool # (<=) :: FileLibrary -> FileLibrary -> Bool # (>) :: FileLibrary -> FileLibrary -> Bool # (>=) :: FileLibrary -> FileLibrary -> Bool # max :: FileLibrary -> FileLibrary -> FileLibrary # min :: FileLibrary -> FileLibrary -> FileLibrary #

flLibrary :: Lens' FileLibrary Library Source #

flID :: Lens' FileLibrary LibraryID Source #

flBytes :: Lens' FileLibrary Bytes Source #

flFromSource :: Lens' FileLibrary Bool Source #

flSource :: Lens' FileLibrary (Maybe String) Source #

rawLibrary :: Bool -> Library -> Bytes -> Maybe String -> FileLibrary Source #

fileLibrary :: Library -> Maybe String -> FileLibrary Source #

Repositories

type Template = Documentation Source #

defaultTemplate :: Template Source #

showTemplate :: Terminal trm => trm -> Style -> DocPatterns -> Metadata -> Template -> Maybe String Source #

showDummyTemplate :: Metadata -> Template -> Maybe String Source #

findLib :: LibraryID -> Maybe FileLibrary Source #

findSym :: GlobalID -> Maybe (LeafExpr GlobalID) Source #

availableLibs :: IO [(LibraryID, Metadata)] Source #

libraryVCS :: IORef VCSBackend Source #