Safe Haskell	Safe-Inferred
Language	Haskell2010

Ribosome.Syntax

Description

Data types and combinators for Ribosome.Api.Syntax.

Synopsis

data Syntax = Syntax {
- syntaxItems :: [SyntaxItem]
- syntaxHighlights :: [Highlight]
- syntaxHiLinks :: [HiLink]
}
data HiLink = HiLink {
- hlGroup :: Text
- hlTarget :: Text
}
data Highlight = Highlight {
- hiGroup :: Text
- hiValues :: Map Text Text
}
data SyntaxItem = SyntaxItem {
- siDetail :: SyntaxItemDetail
- siOptions :: [Text]
- siParams :: Map Text Text
}
data SyntaxItemDetail
- = Keyword {
  - kwGroup :: Text
  - kwKeyword :: Text
  - kwOptions :: [Text]
  }
- | Match {
  - matchGroup :: Text
  - matchPattern :: Text
  }
- | Region {
  - regionGroup :: Text
  - regionStart :: Text
  - regionEnd :: Text
  - regionSkip :: Maybe Text
  - regionStartOffset :: Text
  - regionEndOffset :: Text
  }
- | Verbatim {
  - verbatimCommand :: Text
  }
syntaxItem :: SyntaxItemDetail -> SyntaxItem
syntaxKeyword :: Text -> Text -> SyntaxItem
syntaxMatch :: Text -> Text -> SyntaxItem
syntaxRegionOffset :: Text -> Text -> Text -> Maybe Text -> Text -> Text -> SyntaxItem
syntaxRegion :: Text -> Text -> Text -> Maybe Text -> SyntaxItem
syntaxVerbatim :: Text -> SyntaxItem
syntaxHighlight :: Text -> [(Text, Text)] -> Highlight

Documentation

data Syntax Source #

A set of syntax settings, consisting of syntax items like keyword and match, highlights and highlight links.

Constructors

Syntax
Fields syntaxItems :: [SyntaxItem] syntaxHighlights :: [Highlight] syntaxHiLinks :: [HiLink]

Instances

Instances details

Generic Syntax Source #
Instance details Defined in Ribosome.Data.Syntax Associated Types type Rep Syntax :: Type -> Type # Methods from :: Syntax -> Rep Syntax x # to :: Rep Syntax x -> Syntax #
Show Syntax Source #
Instance details Defined in Ribosome.Data.Syntax Methods showsPrec :: Int -> Syntax -> ShowS # show :: Syntax -> String # showList :: [Syntax] -> ShowS #
Default Syntax Source #
Instance details Defined in Ribosome.Data.Syntax Methods def :: Syntax #
Eq Syntax Source #
Instance details Defined in Ribosome.Data.Syntax Methods (==) :: Syntax -> Syntax -> Bool # (/=) :: Syntax -> Syntax -> Bool #
type Rep Syntax Source #
Instance details Defined in Ribosome.Data.Syntax type Rep Syntax = D1 ('MetaData "Syntax" "Ribosome.Data.Syntax" "ribosome-0.9.9.9-2kHabuyTX5NGSYChGwh5iS" 'False) (C1 ('MetaCons "Syntax" 'PrefixI 'True) (S1 ('MetaSel ('Just "syntaxItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [SyntaxItem]) :: (S1 ('MetaSel ('Just "syntaxHighlights") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Highlight]) :: S1 ('MetaSel ('Just "syntaxHiLinks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [HiLink]))))

data HiLink Source #

Options for a :highlight link command.

Constructors

HiLink
Fields hlGroup :: Text hlTarget :: Text

Instances

Instances details

Show HiLink Source #
Instance details Defined in Ribosome.Data.Syntax Methods showsPrec :: Int -> HiLink -> ShowS # show :: HiLink -> String # showList :: [HiLink] -> ShowS #
Eq HiLink Source #
Instance details Defined in Ribosome.Data.Syntax Methods (==) :: HiLink -> HiLink -> Bool # (/=) :: HiLink -> HiLink -> Bool #

data Highlight Source #

Options for a highlight group.

Constructors

Highlight
Fields hiGroup :: Text hiValues :: Map Text Text

Instances

Instances details

Show Highlight Source #
Instance details Defined in Ribosome.Data.Syntax Methods showsPrec :: Int -> Highlight -> ShowS # show :: Highlight -> String # showList :: [Highlight] -> ShowS #
Eq Highlight Source #
Instance details Defined in Ribosome.Data.Syntax Methods (==) :: Highlight -> Highlight -> Bool # (/=) :: Highlight -> Highlight -> Bool #

data SyntaxItem Source #

A syntax item like keyword or match, bundled with options for the :syntax command.

Constructors

SyntaxItem
Fields siDetail :: SyntaxItemDetail siOptions :: [Text] siParams :: Map Text Text

Instances

Instances details

Show SyntaxItem Source #
Instance details Defined in Ribosome.Data.Syntax Methods showsPrec :: Int -> SyntaxItem -> ShowS # show :: SyntaxItem -> String # showList :: [SyntaxItem] -> ShowS #
Eq SyntaxItem Source #
Instance details Defined in Ribosome.Data.Syntax Methods (==) :: SyntaxItem -> SyntaxItem -> Bool # (/=) :: SyntaxItem -> SyntaxItem -> Bool #

data SyntaxItemDetail Source #

Different kinds of syntax items.

Constructors

Keyword
Fields kwGroup :: Text kwKeyword :: Text kwOptions :: [Text]
Match
Fields matchGroup :: Text matchPattern :: Text
Region
Fields regionGroup :: Text regionStart :: Text regionEnd :: Text regionSkip :: Maybe Text regionStartOffset :: Text regionEndOffset :: Text
Verbatim
Fields verbatimCommand :: Text

Instances

Instances details

Show SyntaxItemDetail Source #
Instance details Defined in Ribosome.Data.Syntax Methods showsPrec :: Int -> SyntaxItemDetail -> ShowS # show :: SyntaxItemDetail -> String # showList :: [SyntaxItemDetail] -> ShowS #
Eq SyntaxItemDetail Source #
Instance details Defined in Ribosome.Data.Syntax Methods (==) :: SyntaxItemDetail -> SyntaxItemDetail -> Bool # (/=) :: SyntaxItemDetail -> SyntaxItemDetail -> Bool #

syntaxItem :: SyntaxItemDetail -> SyntaxItem Source #

Construct a default SyntaxItem from a SyntaxItemDetail.

syntaxKeyword :: Text -> Text -> SyntaxItem Source #

Construct a simple keyword syntax item.

syntaxMatch :: Text -> Text -> SyntaxItem Source #

Construct a simple match syntax item.

syntaxRegionOffset :: Text -> Text -> Text -> Maybe Text -> Text -> Text -> SyntaxItem Source #

Construct a region syntax item with offsets.

syntaxRegion :: Text -> Text -> Text -> Maybe Text -> SyntaxItem Source #

Construct a simple region syntax item.

syntaxVerbatim :: Text -> SyntaxItem Source #

Construct a simple verbatim syntax item.

syntaxHighlight :: Text -> [(Text, Text)] -> Highlight Source #

Construct a syntax highlight.