Safe Haskell	Safe-Inferred
Language	Haskell2010

Unison.Server.Syntax

Contents

Orphan instances

Description

Duplicate of the Unison.Util.SyntaxText module, but we expect these to evolve separately. This is the version which is outward facing to the server frontend.

Synopsis

type SyntaxText = AnnotatedText Element
type SyntaxSegment = Segment Element
convertElement :: Element Reference -> Element
type UnisonHash = Text
type HashQualifiedName = Text
data Element
- = NumericLiteral
- | TextLiteral
- | BytesLiteral
- | CharLiteral
- | BooleanLiteral
- | Blank
- | Var
- | TypeReference UnisonHash
- | DataConstructorReference UnisonHash
- | AbilityConstructorReference UnisonHash
- | TermReference UnisonHash
- | Op SeqOp
- | AbilityBraces
- | ControlKeyword
- | TypeOperator
- | BindingEquals
- | TypeAscriptionColon
- | DataTypeKeyword
- | DataTypeParams
- | Unit
- | DataTypeModifier
- | UseKeyword
- | UsePrefix
- | UseSuffix
- | HashQualifier HashQualifiedName
- | DelayForceChar
- | DelimiterChar
- | Parenthesis
- | LinkKeyword
- | DocDelimiter
- | DocKeyword
syntax :: Element -> SyntaxText -> SyntaxText
firstReference :: SyntaxText -> Maybe UnisonHash
reference :: SyntaxSegment -> Maybe UnisonHash
toPlain :: SyntaxText -> String
toPlainText :: SyntaxText -> Text
toHtml :: SyntaxText -> Html ()
nameToHtml :: Name -> Html ()
segmentToHtml :: SyntaxSegment -> Html ()
elementToClassName :: Element -> Text

Documentation

type SyntaxText = AnnotatedText Element Source #

type SyntaxSegment = Segment Element Source #

convertElement :: Element Reference -> Element Source #

type UnisonHash = Text Source #

type HashQualifiedName = Text Source #

data Element Source #

The elements of the Unison grammar, for syntax highlighting purposes

Instances

Instances details

FromJSON Element Source #
Instance details Defined in Unison.Server.Syntax Methods parseJSON :: Value -> Parser Element # parseJSONList :: Value -> Parser [Element] #
ToJSON Element Source #
Instance details Defined in Unison.Server.Syntax Methods toJSON :: Element -> Value # toEncoding :: Element -> Encoding # toJSONList :: [Element] -> Value # toEncodingList :: [Element] -> Encoding #
Generic Element Source #
Instance details Defined in Unison.Server.Syntax Associated Types type Rep Element :: Type -> Type # Methods from :: Element -> Rep Element x # to :: Rep Element x -> Element #
Show Element Source #
Instance details Defined in Unison.Server.Syntax Methods showsPrec :: Int -> Element -> ShowS # show :: Element -> String # showList :: [Element] -> ShowS #
Eq Element Source #
Instance details Defined in Unison.Server.Syntax Methods (==) :: Element -> Element -> Bool # (/=) :: Element -> Element -> Bool #
Ord Element Source #
Instance details Defined in Unison.Server.Syntax Methods compare :: Element -> Element -> Ordering # (<) :: Element -> Element -> Bool # (<=) :: Element -> Element -> Bool # (>) :: Element -> Element -> Bool # (>=) :: Element -> Element -> Bool # max :: Element -> Element -> Element # min :: Element -> Element -> Element #
ToSchema Element Source #
Instance details Defined in Unison.Server.Syntax Methods declareNamedSchema :: Proxy Element -> Declare (Definitions Schema) NamedSchema #
ToSchema SyntaxText Source #
Instance details Defined in Unison.Server.Syntax Methods declareNamedSchema :: Proxy SyntaxText -> Declare (Definitions Schema) NamedSchema #
FromJSON (AnnotatedText Element) Source #
Instance details Defined in Unison.Server.Syntax Methods parseJSON :: Value -> Parser (AnnotatedText Element) # parseJSONList :: Value -> Parser [AnnotatedText Element] #
ToJSON (AnnotatedText Element) Source #
Instance details Defined in Unison.Server.Syntax Methods toJSON :: AnnotatedText Element -> Value # toEncoding :: AnnotatedText Element -> Encoding # toJSONList :: [AnnotatedText Element] -> Value # toEncodingList :: [AnnotatedText Element] -> Encoding #
type Rep Element Source #
Instance details Defined in Unison.Server.Syntax type Rep Element = D1 ('MetaData "Element" "Unison.Server.Syntax" "unison-share-api-0.0.0-C8EhduMcnIVLJzlEB6yMhH" 'False) ((((C1 ('MetaCons "NumericLiteral" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "TextLiteral" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "BytesLiteral" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "CharLiteral" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "BooleanLiteral" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Blank" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Var" 'PrefixI 'False) (U1 :: Type -> Type)))) :+: (((C1 ('MetaCons "TypeReference" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UnisonHash)) :+: C1 ('MetaCons "DataConstructorReference" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UnisonHash))) :+: (C1 ('MetaCons "AbilityConstructorReference" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UnisonHash)) :+: C1 ('MetaCons "TermReference" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UnisonHash)))) :+: ((C1 ('MetaCons "Op" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SeqOp)) :+: C1 ('MetaCons "AbilityBraces" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "ControlKeyword" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "TypeOperator" 'PrefixI 'False) (U1 :: Type -> Type))))) :+: ((((C1 ('MetaCons "BindingEquals" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "TypeAscriptionColon" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "DataTypeKeyword" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "DataTypeParams" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "Unit" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "DataTypeModifier" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "UseKeyword" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "UsePrefix" 'PrefixI 'False) (U1 :: Type -> Type)))) :+: (((C1 ('MetaCons "UseSuffix" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "HashQualifier" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HashQualifiedName))) :+: (C1 ('MetaCons "DelayForceChar" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "DelimiterChar" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "Parenthesis" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "LinkKeyword" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "DocDelimiter" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "DocKeyword" 'PrefixI 'False) (U1 :: Type -> Type))))))

syntax :: Element -> SyntaxText -> SyntaxText Source #

firstReference :: SyntaxText -> Maybe UnisonHash Source #

reference :: SyntaxSegment -> Maybe UnisonHash Source #

toPlain :: SyntaxText -> String Source #

Convert a SyntaxText to a Value, ignoring syntax markup

toPlainText :: SyntaxText -> Text Source #

toHtml :: SyntaxText -> Html () Source #

nameToHtml :: Name -> Html () Source #

segmentToHtml :: SyntaxSegment -> Html () Source #

elementToClassName :: Element -> Text Source #

Orphan instances

FromJSON SeqOp Source #
Instance details Methods parseJSON :: Value -> Parser SeqOp # parseJSONList :: Value -> Parser [SeqOp] #
ToJSON SeqOp Source #
Instance details Methods toJSON :: SeqOp -> Value # toEncoding :: SeqOp -> Encoding # toJSONList :: [SeqOp] -> Value # toEncodingList :: [SeqOp] -> Encoding #
ToSchema SeqOp Source #
Instance details Methods declareNamedSchema :: Proxy SeqOp -> Declare (Definitions Schema) NamedSchema #
FromJSON a => FromJSON (Segment a) Source #
Instance details Methods parseJSON :: Value -> Parser (Segment a) # parseJSONList :: Value -> Parser [Segment a] #
ToJSON a => ToJSON (Segment a) Source #
Instance details Methods toJSON :: Segment a -> Value # toEncoding :: Segment a -> Encoding # toJSONList :: [Segment a] -> Value # toEncodingList :: [Segment a] -> Encoding #
ToSchema r => ToSchema (Seq r) Source #
Instance details Methods declareNamedSchema :: Proxy (Seq r) -> Declare (Definitions Schema) NamedSchema #
ToSchema a => ToSchema (Segment a) Source #
Instance details Methods declareNamedSchema :: Proxy (Segment a) -> Declare (Definitions Schema) NamedSchema #

NumericLiteral
TextLiteral
BytesLiteral
CharLiteral
BooleanLiteral
Blank
Var
TypeReference UnisonHash
DataConstructorReference UnisonHash
AbilityConstructorReference UnisonHash
TermReference UnisonHash
Op SeqOp
AbilityBraces	Constructor Are these even used? \| Request
ControlKeyword
TypeOperator
BindingEquals
TypeAscriptionColon
DataTypeKeyword
DataTypeParams
Unit
DataTypeModifier
UseKeyword
UsePrefix
UseSuffix
HashQualifier HashQualifiedName
DelayForceChar
DelimiterChar
Parenthesis
LinkKeyword
DocDelimiter
DocKeyword