Safe Haskell	None
Language	Haskell2010

Unison.Server.Doc

Synopsis

type Nat = Word64
type SSyntaxText = SyntaxText' Reference
type Doc = DocG RenderedSpecialForm
type EvaluatedDoc v = DocG (EvaluatedSpecialForm v)
type SrcRefs = Ref (UnisonHash, DisplayObject SyntaxText Src)
data DocG specialForm
- = Word Text
- | Code (DocG specialForm)
- | CodeBlock Text (DocG specialForm)
- | Bold (DocG specialForm)
- | Italic (DocG specialForm)
- | Strikethrough (DocG specialForm)
- | Style Text (DocG specialForm)
- | Anchor Text (DocG specialForm)
- | Blockquote (DocG specialForm)
- | Blankline
- | Linebreak
- | SectionBreak
- | Tooltip (DocG specialForm) (DocG specialForm)
- | Aside (DocG specialForm)
- | Callout (Maybe (DocG specialForm)) (DocG specialForm)
- | Table [[DocG specialForm]]
- | Folded Bool (DocG specialForm) (DocG specialForm)
- | Paragraph [DocG specialForm]
- | BulletedList [DocG specialForm]
- | NumberedList Nat [DocG specialForm]
- | Section (DocG specialForm) [DocG specialForm]
- | NamedLink (DocG specialForm) (DocG specialForm)
- | Image (DocG specialForm) (DocG specialForm) (Maybe (DocG specialForm))
- | Special specialForm
- | Join [DocG specialForm]
- | UntitledSection [DocG specialForm]
- | Column [DocG specialForm]
- | Group (DocG specialForm)
type UnisonHash = Text
data Ref a
- = Term a
- | Type a
data MediaSource = MediaSource {
- mediaSourceUrl :: Text
- mediaSourceMimeType :: Maybe Text
}
data RenderedSpecialForm
- = Source [SrcRefs]
- | FoldedSource [SrcRefs]
- | Example SyntaxText
- | ExampleBlock SyntaxText
- | Link SyntaxText
- | Signature [SyntaxText]
- | SignatureInline SyntaxText
- | Eval SyntaxText SyntaxText
- | EvalInline SyntaxText SyntaxText
- | Embed SyntaxText
- | EmbedInline SyntaxText
- | Video [MediaSource] (Map Text Text)
- | FrontMatter (Map Text [Text])
- | LaTeXInline Text
- | Svg Text
- | RenderError (RenderError SyntaxText)
data EvaluatedSpecialForm v
- = ESource [EvaluatedSrc v]
- | EFoldedSource [EvaluatedSrc v]
- | EExample (Term v ())
- | EExampleBlock (Term v ())
- | ELink (Either (Term v ()) LabeledDependency)
- | ESignature [(Referent, Type v ())]
- | ESignatureInline (Referent, Type v ())
- | EEval (Term v ()) (Maybe (Term v ()))
- | EEvalInline (Term v ()) (Maybe (Term v ()))
- | EEmbed (Term v ())
- | EEmbedInline (Term v ())
- | EVideo [MediaSource] (Map Text Text)
- | EFrontMatter (Map Text [Text])
- | ELaTeXInline Text
- | ESvg Text
- | ERenderError (RenderError (Term v ()))
data Src = Src SyntaxText SyntaxText
evalAndRenderDoc :: (Var v, Monad m) => PrettyPrintEnvDecl -> (Reference -> m (Maybe (Term v ()))) -> (Referent -> m (Maybe (Type v ()))) -> (Term v () -> m (Maybe (Term v ()))) -> (Reference -> m (Maybe (Decl v ()))) -> Term v () -> m Doc
renderDoc :: Var v => PrettyPrintEnvDecl -> EvaluatedDoc v -> Doc
evalDoc :: (Var v, Monad m) => (Reference -> m (Maybe (Term v ()))) -> (Referent -> m (Maybe (Type v ()))) -> (Term v () -> m (Maybe (Term v ()))) -> (Reference -> m (Maybe (Decl v ()))) -> Term v () -> m (EvaluatedDoc v)
data RenderError trm = InvalidTerm trm
data EvaluatedSrc v
- = EvaluatedSrcDecl (EvaluatedDecl v)
- | EvaluatedSrcTerm (EvaluatedTerm v)
data EvaluatedDecl v
- = MissingDecl Reference
- | BuiltinDecl Reference
- | FoundDecl Reference (Decl v ())
data EvaluatedTerm v
- = MissingTerm Reference
- | BuiltinTypeSig Reference (Type v ())
- | MissingBuiltinTypeSig Reference
- | FoundTerm Reference (Type v ()) (Term v ())
dependencies :: Ord v => EvaluatedDoc v -> Set LabeledDependency
dependenciesSpecial :: Ord v => EvaluatedSpecialForm v -> Set LabeledDependency

Documentation

type Nat = Word64 Source #

type SSyntaxText = SyntaxText' Reference Source #

type Doc = DocG RenderedSpecialForm Source #

A doc rendered down to SyntaxText.

type EvaluatedDoc v = DocG (EvaluatedSpecialForm v) Source #

A doc which has been evaluated and includes all information necessary to be rendered.

type SrcRefs = Ref (UnisonHash, DisplayObject SyntaxText Src) Source #

data DocG specialForm Source #

A doc parameterized by its special forms.

Constructors

Word Text
Code (DocG specialForm)
CodeBlock Text (DocG specialForm)
Bold (DocG specialForm)
Italic (DocG specialForm)
Strikethrough (DocG specialForm)
Style Text (DocG specialForm)
Anchor Text (DocG specialForm)
Blockquote (DocG specialForm)
Blankline
Linebreak
SectionBreak
Tooltip (DocG specialForm) (DocG specialForm)
Aside (DocG specialForm)
Callout (Maybe (DocG specialForm)) (DocG specialForm)
Table [[DocG specialForm]]
Folded Bool (DocG specialForm) (DocG specialForm)
Paragraph [DocG specialForm]
BulletedList [DocG specialForm]
NumberedList Nat [DocG specialForm]
Section (DocG specialForm) [DocG specialForm]
NamedLink (DocG specialForm) (DocG specialForm)
Image (DocG specialForm) (DocG specialForm) (Maybe (DocG specialForm))
Special specialForm
Join [DocG specialForm]
UntitledSection [DocG specialForm]
Column [DocG specialForm]
Group (DocG specialForm)

Instances

Instances details

Functor DocG Source #

Instance details

Defined in Unison.Server.Doc

Methods

fmap :: (a -> b) -> DocG a -> DocG b #

(<$) :: a -> DocG b -> DocG a #

Foldable DocG Source #

Instance details

Defined in Unison.Server.Doc

Methods

fold :: Monoid m => DocG m -> m #

foldMap :: Monoid m => (a -> m) -> DocG a -> m #

foldMap' :: Monoid m => (a -> m) -> DocG a -> m #

foldr :: (a -> b -> b) -> b -> DocG a -> b #

foldr' :: (a -> b -> b) -> b -> DocG a -> b #

foldl :: (b -> a -> b) -> b -> DocG a -> b #

foldl' :: (b -> a -> b) -> b -> DocG a -> b #

foldr1 :: (a -> a -> a) -> DocG a -> a #

foldl1 :: (a -> a -> a) -> DocG a -> a #

toList :: DocG a -> [a] #

null :: DocG a -> Bool #

length :: DocG a -> Int #

elem :: Eq a => a -> DocG a -> Bool #

maximum :: Ord a => DocG a -> a #

minimum :: Ord a => DocG a -> a #

sum :: Num a => DocG a -> a #

product :: Num a => DocG a -> a #

Traversable DocG Source #

Instance details

Defined in Unison.Server.Doc

Methods

traverse :: Applicative f => (a -> f b) -> DocG a -> f (DocG b) #

sequenceA :: Applicative f => DocG (f a) -> f (DocG a) #

mapM :: Monad m => (a -> m b) -> DocG a -> m (DocG b) #

sequence :: Monad m => DocG (m a) -> m (DocG a) #

FromJSON specialForm => FromJSON (DocG specialForm) Source #

Instance details

Defined in Unison.Server.Doc

Methods

parseJSON :: Value -> Parser (DocG specialForm) #

parseJSONList :: Value -> Parser [DocG specialForm] #

omittedField :: Maybe (DocG specialForm) #

ToJSON specialForm => ToJSON (DocG specialForm) Source #

Instance details

Defined in Unison.Server.Doc

Methods

toJSON :: DocG specialForm -> Value #

toEncoding :: DocG specialForm -> Encoding #

toJSONList :: [DocG specialForm] -> Value #

toEncodingList :: [DocG specialForm] -> Encoding #

omitField :: DocG specialForm -> Bool #

Generic (DocG specialForm) Source #

Instance details

Defined in Unison.Server.Doc

Associated Types

type Rep (DocG specialForm)

Instance details

Defined in Unison.Server.Doc

Methods

from :: DocG specialForm -> Rep (DocG specialForm) x #

to :: Rep (DocG specialForm) x -> DocG specialForm #

Show specialForm => Show (DocG specialForm) Source #

Instance details

Defined in Unison.Server.Doc

Methods

showsPrec :: Int -> DocG specialForm -> ShowS #

show :: DocG specialForm -> String #

showList :: [DocG specialForm] -> ShowS #

Eq specialForm => Eq (DocG specialForm) Source #

Instance details

Defined in Unison.Server.Doc

Methods

(==) :: DocG specialForm -> DocG specialForm -> Bool #

(/=) :: DocG specialForm -> DocG specialForm -> Bool #

Ord specialForm => Ord (DocG specialForm) Source #

Instance details

Defined in Unison.Server.Doc

Methods

compare :: DocG specialForm -> DocG specialForm -> Ordering #

(<) :: DocG specialForm -> DocG specialForm -> Bool #

(<=) :: DocG specialForm -> DocG specialForm -> Bool #

(>) :: DocG specialForm -> DocG specialForm -> Bool #

(>=) :: DocG specialForm -> DocG specialForm -> Bool #

max :: DocG specialForm -> DocG specialForm -> DocG specialForm #

min :: DocG specialForm -> DocG specialForm -> DocG specialForm #

ToSchema specialForm => ToSchema (DocG specialForm) Source #

Instance details

Defined in Unison.Server.Doc

Methods

declareNamedSchema :: Proxy (DocG specialForm) -> Declare (Definitions Schema) NamedSchema #

type Rep (DocG specialForm) Source #

Instance details

Defined in Unison.Server.Doc

type UnisonHash = Text Source #

data Ref a Source #

Constructors

Term a
Type a

Instances

Instances details

Functor Ref Source #

Instance details

Defined in Unison.Server.Doc

Methods

fmap :: (a -> b) -> Ref a -> Ref b #

(<$) :: a -> Ref b -> Ref a #

Foldable Ref Source #

Instance details

Defined in Unison.Server.Doc

Methods

fold :: Monoid m => Ref m -> m #

foldMap :: Monoid m => (a -> m) -> Ref a -> m #

foldMap' :: Monoid m => (a -> m) -> Ref a -> m #

foldr :: (a -> b -> b) -> b -> Ref a -> b #

foldr' :: (a -> b -> b) -> b -> Ref a -> b #

foldl :: (b -> a -> b) -> b -> Ref a -> b #

foldl' :: (b -> a -> b) -> b -> Ref a -> b #

foldr1 :: (a -> a -> a) -> Ref a -> a #

foldl1 :: (a -> a -> a) -> Ref a -> a #

toList :: Ref a -> [a] #

null :: Ref a -> Bool #

length :: Ref a -> Int #

elem :: Eq a => a -> Ref a -> Bool #

maximum :: Ord a => Ref a -> a #

minimum :: Ord a => Ref a -> a #

sum :: Num a => Ref a -> a #

product :: Num a => Ref a -> a #

Traversable Ref Source #

Instance details

Defined in Unison.Server.Doc

Methods

traverse :: Applicative f => (a -> f b) -> Ref a -> f (Ref b) #

sequenceA :: Applicative f => Ref (f a) -> f (Ref a) #

mapM :: Monad m => (a -> m b) -> Ref a -> m (Ref b) #

sequence :: Monad m => Ref (m a) -> m (Ref a) #

FromJSON a => FromJSON (Ref a) Source #

Instance details

Defined in Unison.Server.Doc

Methods

parseJSON :: Value -> Parser (Ref a) #

parseJSONList :: Value -> Parser [Ref a] #

omittedField :: Maybe (Ref a) #

ToJSON a => ToJSON (Ref a) Source #

Instance details

Defined in Unison.Server.Doc

Methods

toJSON :: Ref a -> Value #

toEncoding :: Ref a -> Encoding #

toJSONList :: [Ref a] -> Value #

toEncodingList :: [Ref a] -> Encoding #

omitField :: Ref a -> Bool #

Generic (Ref a) Source #

Instance details

Defined in Unison.Server.Doc

Associated Types

type Rep (Ref a)

Instance details

Defined in Unison.Server.Doc

type Rep (Ref a) = D1 ('MetaData "Ref" "Unison.Server.Doc" "unison-share-api-0.0.0-9fFxz1kl0ay2hTWczK4vVA" 'False) (C1 ('MetaCons "Term" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a)) :+: C1 ('MetaCons "Type" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a)))

Methods

from :: Ref a -> Rep (Ref a) x #

to :: Rep (Ref a) x -> Ref a #

Show a => Show (Ref a) Source #

Instance details

Defined in Unison.Server.Doc

Methods

showsPrec :: Int -> Ref a -> ShowS #

show :: Ref a -> String #

showList :: [Ref a] -> ShowS #

Eq a => Eq (Ref a) Source #

Instance details

Defined in Unison.Server.Doc

Methods

(==) :: Ref a -> Ref a -> Bool #

(/=) :: Ref a -> Ref a -> Bool #

Ord a => Ord (Ref a) Source #

Instance details

Defined in Unison.Server.Doc

Methods

compare :: Ref a -> Ref a -> Ordering #

(<) :: Ref a -> Ref a -> Bool #

(<=) :: Ref a -> Ref a -> Bool #

(>) :: Ref a -> Ref a -> Bool #

(>=) :: Ref a -> Ref a -> Bool #

max :: Ref a -> Ref a -> Ref a #

min :: Ref a -> Ref a -> Ref a #

ToSchema a => ToSchema (Ref a) Source #

Instance details

Defined in Unison.Server.Doc

Methods

declareNamedSchema :: Proxy (Ref a) -> Declare (Definitions Schema) NamedSchema #

type Rep (Ref a) Source #

Instance details

Defined in Unison.Server.Doc

type Rep (Ref a) = D1 ('MetaData "Ref" "Unison.Server.Doc" "unison-share-api-0.0.0-9fFxz1kl0ay2hTWczK4vVA" 'False) (C1 ('MetaCons "Term" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a)) :+: C1 ('MetaCons "Type" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a)))

data MediaSource Source #

Constructors

MediaSource
Fields mediaSourceUrl :: Text mediaSourceMimeType :: Maybe Text

Instances

Instances details

FromJSON MediaSource Source #

Instance details

Defined in Unison.Server.Doc

Methods

parseJSON :: Value -> Parser MediaSource #

parseJSONList :: Value -> Parser [MediaSource] #

omittedField :: Maybe MediaSource #

ToJSON MediaSource Source #

Instance details

Defined in Unison.Server.Doc

Methods

toJSON :: MediaSource -> Value #

toEncoding :: MediaSource -> Encoding #

toJSONList :: [MediaSource] -> Value #

toEncodingList :: [MediaSource] -> Encoding #

omitField :: MediaSource -> Bool #

Generic MediaSource Source #

Instance details

Defined in Unison.Server.Doc

Associated Types

type Rep MediaSource

Instance details

Defined in Unison.Server.Doc

type Rep MediaSource = D1 ('MetaData "MediaSource" "Unison.Server.Doc" "unison-share-api-0.0.0-9fFxz1kl0ay2hTWczK4vVA" 'False) (C1 ('MetaCons "MediaSource" 'PrefixI 'True) (S1 ('MetaSel ('Just "mediaSourceUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "mediaSourceMimeType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))))

Methods

from :: MediaSource -> Rep MediaSource x #

to :: Rep MediaSource x -> MediaSource #

Show MediaSource Source #

Instance details

Defined in Unison.Server.Doc

Methods

showsPrec :: Int -> MediaSource -> ShowS #

show :: MediaSource -> String #

showList :: [MediaSource] -> ShowS #

Eq MediaSource Source #

Instance details

Defined in Unison.Server.Doc

Methods

(==) :: MediaSource -> MediaSource -> Bool #

(/=) :: MediaSource -> MediaSource -> Bool #

Ord MediaSource Source #

Instance details

Defined in Unison.Server.Doc

Methods

compare :: MediaSource -> MediaSource -> Ordering #

(<) :: MediaSource -> MediaSource -> Bool #

(<=) :: MediaSource -> MediaSource -> Bool #

(>) :: MediaSource -> MediaSource -> Bool #

(>=) :: MediaSource -> MediaSource -> Bool #

max :: MediaSource -> MediaSource -> MediaSource #

min :: MediaSource -> MediaSource -> MediaSource #

ToSchema MediaSource Source #

Instance details

Defined in Unison.Server.Doc

Methods

declareNamedSchema :: Proxy MediaSource -> Declare (Definitions Schema) NamedSchema #

type Rep MediaSource Source #

Instance details

Defined in Unison.Server.Doc

type Rep MediaSource = D1 ('MetaData "MediaSource" "Unison.Server.Doc" "unison-share-api-0.0.0-9fFxz1kl0ay2hTWczK4vVA" 'False) (C1 ('MetaCons "MediaSource" 'PrefixI 'True) (S1 ('MetaSel ('Just "mediaSourceUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "mediaSourceMimeType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))))

data RenderedSpecialForm Source #

Instances

Instances details

FromJSON RenderedSpecialForm Source #

Instance details

Defined in Unison.Server.Doc

Methods

parseJSON :: Value -> Parser RenderedSpecialForm #

parseJSONList :: Value -> Parser [RenderedSpecialForm] #

omittedField :: Maybe RenderedSpecialForm #

ToJSON RenderedSpecialForm Source #

Instance details

Defined in Unison.Server.Doc

Methods

toJSON :: RenderedSpecialForm -> Value #

toEncoding :: RenderedSpecialForm -> Encoding #

toJSONList :: [RenderedSpecialForm] -> Value #

toEncodingList :: [RenderedSpecialForm] -> Encoding #

omitField :: RenderedSpecialForm -> Bool #

Generic RenderedSpecialForm Source #

Instance details

Defined in Unison.Server.Doc

Associated Types

type Rep RenderedSpecialForm

Instance details

Defined in Unison.Server.Doc

Methods

from :: RenderedSpecialForm -> Rep RenderedSpecialForm x #

to :: Rep RenderedSpecialForm x -> RenderedSpecialForm #

Show RenderedSpecialForm Source #

Instance details

Defined in Unison.Server.Doc

Methods

showsPrec :: Int -> RenderedSpecialForm -> ShowS #

show :: RenderedSpecialForm -> String #

showList :: [RenderedSpecialForm] -> ShowS #

Eq RenderedSpecialForm Source #

Instance details

Defined in Unison.Server.Doc

Methods

(==) :: RenderedSpecialForm -> RenderedSpecialForm -> Bool #

(/=) :: RenderedSpecialForm -> RenderedSpecialForm -> Bool #

Ord RenderedSpecialForm Source #

Instance details

Defined in Unison.Server.Doc

Methods

compare :: RenderedSpecialForm -> RenderedSpecialForm -> Ordering #

(<) :: RenderedSpecialForm -> RenderedSpecialForm -> Bool #

(<=) :: RenderedSpecialForm -> RenderedSpecialForm -> Bool #

(>) :: RenderedSpecialForm -> RenderedSpecialForm -> Bool #

(>=) :: RenderedSpecialForm -> RenderedSpecialForm -> Bool #

max :: RenderedSpecialForm -> RenderedSpecialForm -> RenderedSpecialForm #

min :: RenderedSpecialForm -> RenderedSpecialForm -> RenderedSpecialForm #

ToSchema RenderedSpecialForm Source #

Instance details

Defined in Unison.Server.Doc

Methods

declareNamedSchema :: Proxy RenderedSpecialForm -> Declare (Definitions Schema) NamedSchema #

type Rep RenderedSpecialForm Source #

Instance details

Defined in Unison.Server.Doc

data EvaluatedSpecialForm v Source #

Constructors

ESource [EvaluatedSrc v]
EFoldedSource [EvaluatedSrc v]
EExample (Term v ())
EExampleBlock (Term v ())
ELink (Either (Term v ()) LabeledDependency)
ESignature [(Referent, Type v ())]
ESignatureInline (Referent, Type v ())
EEval (Term v ()) (Maybe (Term v ()))
EEvalInline (Term v ()) (Maybe (Term v ()))
EEmbed (Term v ())
EEmbedInline (Term v ())
EVideo [MediaSource] (Map Text Text)
EFrontMatter (Map Text [Text])
ELaTeXInline Text
ESvg Text
ERenderError (RenderError (Term v ()))

Instances

Instances details

Generic (EvaluatedSpecialForm v) Source #

Instance details

Defined in Unison.Server.Doc

Associated Types

type Rep (EvaluatedSpecialForm v)

Instance details

Defined in Unison.Server.Doc

Methods

from :: EvaluatedSpecialForm v -> Rep (EvaluatedSpecialForm v) x #

to :: Rep (EvaluatedSpecialForm v) x -> EvaluatedSpecialForm v #

Show v => Show (EvaluatedSpecialForm v) Source #

Instance details

Defined in Unison.Server.Doc

Methods

showsPrec :: Int -> EvaluatedSpecialForm v -> ShowS #

show :: EvaluatedSpecialForm v -> String #

showList :: [EvaluatedSpecialForm v] -> ShowS #

Var v => Eq (EvaluatedSpecialForm v) Source #

Instance details

Defined in Unison.Server.Doc

Methods

(==) :: EvaluatedSpecialForm v -> EvaluatedSpecialForm v -> Bool #

(/=) :: EvaluatedSpecialForm v -> EvaluatedSpecialForm v -> Bool #

Var v => Ord (EvaluatedSpecialForm v) Source #

Instance details

Defined in Unison.Server.Doc

Methods

compare :: EvaluatedSpecialForm v -> EvaluatedSpecialForm v -> Ordering #

(<) :: EvaluatedSpecialForm v -> EvaluatedSpecialForm v -> Bool #

(<=) :: EvaluatedSpecialForm v -> EvaluatedSpecialForm v -> Bool #

(>) :: EvaluatedSpecialForm v -> EvaluatedSpecialForm v -> Bool #

(>=) :: EvaluatedSpecialForm v -> EvaluatedSpecialForm v -> Bool #

max :: EvaluatedSpecialForm v -> EvaluatedSpecialForm v -> EvaluatedSpecialForm v #

min :: EvaluatedSpecialForm v -> EvaluatedSpecialForm v -> EvaluatedSpecialForm v #

type Rep (EvaluatedSpecialForm v) Source #

Instance details

Defined in Unison.Server.Doc

data Src Source #

Constructors

Src SyntaxText SyntaxText

Instances

Instances details

FromJSON Src Source #

Instance details

Defined in Unison.Server.Doc

Methods

parseJSON :: Value -> Parser Src #

parseJSONList :: Value -> Parser [Src] #

omittedField :: Maybe Src #

ToJSON Src Source #

Instance details

Defined in Unison.Server.Doc

Methods

toJSON :: Src -> Value #

toEncoding :: Src -> Encoding #

toJSONList :: [Src] -> Value #

toEncodingList :: [Src] -> Encoding #

omitField :: Src -> Bool #

Generic Src Source #

Instance details

Defined in Unison.Server.Doc

Associated Types

type Rep Src

Instance details

Defined in Unison.Server.Doc

type Rep Src = D1 ('MetaData "Src" "Unison.Server.Doc" "unison-share-api-0.0.0-9fFxz1kl0ay2hTWczK4vVA" 'False) (C1 ('MetaCons "Src" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SyntaxText) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SyntaxText)))

Methods

from :: Src -> Rep Src x #

to :: Rep Src x -> Src #

Show Src Source #

Instance details

Defined in Unison.Server.Doc

Methods

showsPrec :: Int -> Src -> ShowS #

show :: Src -> String #

showList :: [Src] -> ShowS #

Eq Src Source #

Instance details

Defined in Unison.Server.Doc

Methods

(==) :: Src -> Src -> Bool #

(/=) :: Src -> Src -> Bool #

Ord Src Source #

Instance details

Defined in Unison.Server.Doc

Methods

compare :: Src -> Src -> Ordering #

(<) :: Src -> Src -> Bool #

(<=) :: Src -> Src -> Bool #

(>) :: Src -> Src -> Bool #

(>=) :: Src -> Src -> Bool #

max :: Src -> Src -> Src #

min :: Src -> Src -> Src #

ToSchema Src Source #

Instance details

Defined in Unison.Server.Doc

Methods

declareNamedSchema :: Proxy Src -> Declare (Definitions Schema) NamedSchema #

type Rep Src Source #

Instance details

Defined in Unison.Server.Doc

type Rep Src = D1 ('MetaData "Src" "Unison.Server.Doc" "unison-share-api-0.0.0-9fFxz1kl0ay2hTWczK4vVA" 'False) (C1 ('MetaCons "Src" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SyntaxText) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SyntaxText)))

evalAndRenderDoc :: (Var v, Monad m) => PrettyPrintEnvDecl -> (Reference -> m (Maybe (Term v ()))) -> (Referent -> m (Maybe (Type v ()))) -> (Term v () -> m (Maybe (Term v ()))) -> (Reference -> m (Maybe (Decl v ()))) -> Term v () -> m Doc Source #

Evaluate the doc, then render it.

renderDoc :: Var v => PrettyPrintEnvDecl -> EvaluatedDoc v -> Doc Source #

Renders the given doc, which must have been evaluated using evalDoc

evalDoc :: (Var v, Monad m) => (Reference -> m (Maybe (Term v ()))) -> (Referent -> m (Maybe (Type v ()))) -> (Term v () -> m (Maybe (Term v ()))) -> (Reference -> m (Maybe (Decl v ()))) -> Term v () -> m (EvaluatedDoc v) Source #

Evaluates the given doc, expanding transclusions, expressions, etc.

data RenderError trm Source #

Constructors

InvalidTerm trm

Instances

Instances details

FromJSON trm => FromJSON (RenderError trm) Source #

Instance details

Defined in Unison.Server.Doc

Methods

parseJSON :: Value -> Parser (RenderError trm) #

parseJSONList :: Value -> Parser [RenderError trm] #

omittedField :: Maybe (RenderError trm) #

ToJSON trm => ToJSON (RenderError trm) Source #

Instance details

Defined in Unison.Server.Doc

Methods

toJSON :: RenderError trm -> Value #

toEncoding :: RenderError trm -> Encoding #

toJSONList :: [RenderError trm] -> Value #

toEncodingList :: [RenderError trm] -> Encoding #

omitField :: RenderError trm -> Bool #

Generic (RenderError trm) Source #

Instance details

Defined in Unison.Server.Doc

Associated Types

type Rep (RenderError trm)
Instance details Defined in Unison.Server.Doc type Rep (RenderError trm) = D1 ('MetaData "RenderError" "Unison.Server.Doc" "unison-share-api-0.0.0-9fFxz1kl0ay2hTWczK4vVA" 'False) (C1 ('MetaCons "InvalidTerm" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 trm)))

Methods

from :: RenderError trm -> Rep (RenderError trm) x #

to :: Rep (RenderError trm) x -> RenderError trm #

Show trm => Show (RenderError trm) Source #

Instance details

Defined in Unison.Server.Doc

Methods

showsPrec :: Int -> RenderError trm -> ShowS #

show :: RenderError trm -> String #

showList :: [RenderError trm] -> ShowS #

Eq trm => Eq (RenderError trm) Source #

Instance details

Defined in Unison.Server.Doc

Methods

(==) :: RenderError trm -> RenderError trm -> Bool #

(/=) :: RenderError trm -> RenderError trm -> Bool #

Ord trm => Ord (RenderError trm) Source #

Instance details

Defined in Unison.Server.Doc

Methods

compare :: RenderError trm -> RenderError trm -> Ordering #

(<) :: RenderError trm -> RenderError trm -> Bool #

(<=) :: RenderError trm -> RenderError trm -> Bool #

(>) :: RenderError trm -> RenderError trm -> Bool #

(>=) :: RenderError trm -> RenderError trm -> Bool #

max :: RenderError trm -> RenderError trm -> RenderError trm #

min :: RenderError trm -> RenderError trm -> RenderError trm #

ToSchema trm => ToSchema (RenderError trm) Source #

Instance details

Defined in Unison.Server.Doc

Methods

declareNamedSchema :: Proxy (RenderError trm) -> Declare (Definitions Schema) NamedSchema #

type Rep (RenderError trm) Source #

Instance details

Defined in Unison.Server.Doc

type Rep (RenderError trm) = D1 ('MetaData "RenderError" "Unison.Server.Doc" "unison-share-api-0.0.0-9fFxz1kl0ay2hTWczK4vVA" 'False) (C1 ('MetaCons "InvalidTerm" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 trm)))

data EvaluatedSrc v Source #

Constructors

EvaluatedSrcDecl (EvaluatedDecl v)
EvaluatedSrcTerm (EvaluatedTerm v)

Instances

Instances details

Generic (EvaluatedSrc v) Source #

Instance details

Defined in Unison.Server.Doc

Associated Types

type Rep (EvaluatedSrc v)

Instance details

Defined in Unison.Server.Doc

type Rep (EvaluatedSrc v) = D1 ('MetaData "EvaluatedSrc" "Unison.Server.Doc" "unison-share-api-0.0.0-9fFxz1kl0ay2hTWczK4vVA" 'False) (C1 ('MetaCons "EvaluatedSrcDecl" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (EvaluatedDecl v))) :+: C1 ('MetaCons "EvaluatedSrcTerm" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (EvaluatedTerm v))))

Methods

from :: EvaluatedSrc v -> Rep (EvaluatedSrc v) x #

to :: Rep (EvaluatedSrc v) x -> EvaluatedSrc v #

Show v => Show (EvaluatedSrc v) Source #

Instance details

Defined in Unison.Server.Doc

Methods

showsPrec :: Int -> EvaluatedSrc v -> ShowS #

show :: EvaluatedSrc v -> String #

showList :: [EvaluatedSrc v] -> ShowS #

Var v => Eq (EvaluatedSrc v) Source #

Instance details

Defined in Unison.Server.Doc

Methods

(==) :: EvaluatedSrc v -> EvaluatedSrc v -> Bool #

(/=) :: EvaluatedSrc v -> EvaluatedSrc v -> Bool #

Var v => Ord (EvaluatedSrc v) Source #

Instance details

Defined in Unison.Server.Doc

Methods

compare :: EvaluatedSrc v -> EvaluatedSrc v -> Ordering #

(<) :: EvaluatedSrc v -> EvaluatedSrc v -> Bool #

(<=) :: EvaluatedSrc v -> EvaluatedSrc v -> Bool #

(>) :: EvaluatedSrc v -> EvaluatedSrc v -> Bool #

(>=) :: EvaluatedSrc v -> EvaluatedSrc v -> Bool #

max :: EvaluatedSrc v -> EvaluatedSrc v -> EvaluatedSrc v #

min :: EvaluatedSrc v -> EvaluatedSrc v -> EvaluatedSrc v #

type Rep (EvaluatedSrc v) Source #

Instance details

Defined in Unison.Server.Doc

type Rep (EvaluatedSrc v) = D1 ('MetaData "EvaluatedSrc" "Unison.Server.Doc" "unison-share-api-0.0.0-9fFxz1kl0ay2hTWczK4vVA" 'False) (C1 ('MetaCons "EvaluatedSrcDecl" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (EvaluatedDecl v))) :+: C1 ('MetaCons "EvaluatedSrcTerm" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (EvaluatedTerm v))))

data EvaluatedDecl v Source #

Constructors

MissingDecl Reference
BuiltinDecl Reference
FoundDecl Reference (Decl v ())

Instances

Instances details

Generic (EvaluatedDecl v) Source #

Instance details

Defined in Unison.Server.Doc

Associated Types

type Rep (EvaluatedDecl v)

Instance details

Defined in Unison.Server.Doc

type Rep (EvaluatedDecl v) = D1 ('MetaData "EvaluatedDecl" "Unison.Server.Doc" "unison-share-api-0.0.0-9fFxz1kl0ay2hTWczK4vVA" 'False) (C1 ('MetaCons "MissingDecl" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Reference)) :+: (C1 ('MetaCons "BuiltinDecl" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Reference)) :+: C1 ('MetaCons "FoundDecl" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Reference) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Decl v ())))))

Methods

from :: EvaluatedDecl v -> Rep (EvaluatedDecl v) x #

to :: Rep (EvaluatedDecl v) x -> EvaluatedDecl v #

Show v => Show (EvaluatedDecl v) Source #

Instance details

Defined in Unison.Server.Doc

Methods

showsPrec :: Int -> EvaluatedDecl v -> ShowS #

show :: EvaluatedDecl v -> String #

showList :: [EvaluatedDecl v] -> ShowS #

Var v => Eq (EvaluatedDecl v) Source #

Instance details

Defined in Unison.Server.Doc

Methods

(==) :: EvaluatedDecl v -> EvaluatedDecl v -> Bool #

(/=) :: EvaluatedDecl v -> EvaluatedDecl v -> Bool #

Var v => Ord (EvaluatedDecl v) Source #

Instance details

Defined in Unison.Server.Doc

Methods

compare :: EvaluatedDecl v -> EvaluatedDecl v -> Ordering #

(<) :: EvaluatedDecl v -> EvaluatedDecl v -> Bool #

(<=) :: EvaluatedDecl v -> EvaluatedDecl v -> Bool #

(>) :: EvaluatedDecl v -> EvaluatedDecl v -> Bool #

(>=) :: EvaluatedDecl v -> EvaluatedDecl v -> Bool #

max :: EvaluatedDecl v -> EvaluatedDecl v -> EvaluatedDecl v #

min :: EvaluatedDecl v -> EvaluatedDecl v -> EvaluatedDecl v #

type Rep (EvaluatedDecl v) Source #

Instance details

Defined in Unison.Server.Doc

type Rep (EvaluatedDecl v) = D1 ('MetaData "EvaluatedDecl" "Unison.Server.Doc" "unison-share-api-0.0.0-9fFxz1kl0ay2hTWczK4vVA" 'False) (C1 ('MetaCons "MissingDecl" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Reference)) :+: (C1 ('MetaCons "BuiltinDecl" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Reference)) :+: C1 ('MetaCons "FoundDecl" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Reference) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Decl v ())))))

data EvaluatedTerm v Source #

Constructors

MissingTerm Reference
BuiltinTypeSig Reference (Type v ())
MissingBuiltinTypeSig Reference
FoundTerm Reference (Type v ()) (Term v ())

Instances

Instances details

Generic (EvaluatedTerm v) Source #

Instance details

Defined in Unison.Server.Doc

Associated Types

type Rep (EvaluatedTerm v)

Instance details

Defined in Unison.Server.Doc

type Rep (EvaluatedTerm v) = D1 ('MetaData "EvaluatedTerm" "Unison.Server.Doc" "unison-share-api-0.0.0-9fFxz1kl0ay2hTWczK4vVA" 'False) ((C1 ('MetaCons "MissingTerm" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Reference)) :+: C1 ('MetaCons "BuiltinTypeSig" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Reference) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Type v ())))) :+: (C1 ('MetaCons "MissingBuiltinTypeSig" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Reference)) :+: C1 ('MetaCons "FoundTerm" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Reference) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Type v ())) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Term v ()))))))

Methods

from :: EvaluatedTerm v -> Rep (EvaluatedTerm v) x #

to :: Rep (EvaluatedTerm v) x -> EvaluatedTerm v #

Show v => Show (EvaluatedTerm v) Source #

Instance details

Defined in Unison.Server.Doc

Methods

showsPrec :: Int -> EvaluatedTerm v -> ShowS #

show :: EvaluatedTerm v -> String #

showList :: [EvaluatedTerm v] -> ShowS #

Var v => Eq (EvaluatedTerm v) Source #

Instance details

Defined in Unison.Server.Doc

Methods

(==) :: EvaluatedTerm v -> EvaluatedTerm v -> Bool #

(/=) :: EvaluatedTerm v -> EvaluatedTerm v -> Bool #

Var v => Ord (EvaluatedTerm v) Source #

Instance details

Defined in Unison.Server.Doc

Methods

compare :: EvaluatedTerm v -> EvaluatedTerm v -> Ordering #

(<) :: EvaluatedTerm v -> EvaluatedTerm v -> Bool #

(<=) :: EvaluatedTerm v -> EvaluatedTerm v -> Bool #

(>) :: EvaluatedTerm v -> EvaluatedTerm v -> Bool #

(>=) :: EvaluatedTerm v -> EvaluatedTerm v -> Bool #

max :: EvaluatedTerm v -> EvaluatedTerm v -> EvaluatedTerm v #

min :: EvaluatedTerm v -> EvaluatedTerm v -> EvaluatedTerm v #

type Rep (EvaluatedTerm v) Source #

Instance details

Defined in Unison.Server.Doc

type Rep (EvaluatedTerm v) = D1 ('MetaData "EvaluatedTerm" "Unison.Server.Doc" "unison-share-api-0.0.0-9fFxz1kl0ay2hTWczK4vVA" 'False) ((C1 ('MetaCons "MissingTerm" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Reference)) :+: C1 ('MetaCons "BuiltinTypeSig" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Reference) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Type v ())))) :+: (C1 ('MetaCons "MissingBuiltinTypeSig" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Reference)) :+: C1 ('MetaCons "FoundTerm" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Reference) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Type v ())) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Term v ()))))))

dependencies :: Ord v => EvaluatedDoc v -> Set LabeledDependency Source #

dependenciesSpecial :: Ord v => EvaluatedSpecialForm v -> Set LabeledDependency Source #

Determines all dependencies of a special form

Source [SrcRefs]
FoldedSource [SrcRefs]
Example SyntaxText
ExampleBlock SyntaxText
Link SyntaxText
Signature [SyntaxText]
SignatureInline SyntaxText
Eval SyntaxText SyntaxText
EvalInline SyntaxText SyntaxText
Embed SyntaxText
EmbedInline SyntaxText
Video [MediaSource] (Map Text Text)
FrontMatter (Map Text [Text])
LaTeXInline Text
Svg Text
RenderError (RenderError SyntaxText)