Ribosome.Data.Syntax

Data types for the Neovim syntax API.

Documentation

data SyntaxItemDetail

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

Show SyntaxItemDetail

Defined in Ribosome.Data.Syntax

Methods

showsPrec :: Int -> SyntaxItemDetail -> ShowS

show :: SyntaxItemDetail -> String

showList :: [SyntaxItemDetail] -> ShowS

Eq SyntaxItemDetail

Defined in Ribosome.Data.Syntax

Methods

(==) :: SyntaxItemDetail -> SyntaxItemDetail -> Bool

(/=) :: SyntaxItemDetail -> SyntaxItemDetail -> Bool

data SyntaxItem

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

Show SyntaxItem

Defined in Ribosome.Data.Syntax

Methods

showsPrec :: Int -> SyntaxItem -> ShowS

show :: SyntaxItem -> String

showList :: [SyntaxItem] -> ShowS

Eq SyntaxItem

Defined in Ribosome.Data.Syntax

Methods

(==) :: SyntaxItem -> SyntaxItem -> Bool

(/=) :: SyntaxItem -> SyntaxItem -> Bool

data Highlight

Options for a highlight group.

Constructors

Highlight

Fields

• hiGroup :: Text
• hiValues :: Map Text Text

Instances

Show Highlight

Defined in Ribosome.Data.Syntax

Methods

showsPrec :: Int -> Highlight -> ShowS

show :: Highlight -> String

showList :: [Highlight] -> ShowS

Eq Highlight

Defined in Ribosome.Data.Syntax

Methods

(==) :: Highlight -> Highlight -> Bool

(/=) :: Highlight -> Highlight -> Bool

data HiLink

Options for a :highlight link command.

Constructors

HiLink

Fields

• hlGroup :: Text
• hlTarget :: Text

Instances

Show HiLink

Defined in Ribosome.Data.Syntax

Methods

showsPrec :: Int -> HiLink -> ShowS

show :: HiLink -> String

showList :: [HiLink] -> ShowS

Eq HiLink

Defined in Ribosome.Data.Syntax

Methods

(==) :: HiLink -> HiLink -> Bool

(/=) :: HiLink -> HiLink -> Bool

data Syntax

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

Generic Syntax

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

Defined in Ribosome.Data.Syntax

Methods

showsPrec :: Int -> Syntax -> ShowS

show :: Syntax -> String

showList :: [Syntax] -> ShowS

Default Syntax

Defined in Ribosome.Data.Syntax

Methods

def :: Syntax

Eq Syntax

Defined in Ribosome.Data.Syntax

Methods

(==) :: Syntax -> Syntax -> Bool

(/=) :: Syntax -> Syntax -> Bool

type Rep Syntax

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