ribosome-0.9.9.9: Neovim plugin framework for Polysemy
Safe HaskellSafe-Inferred
LanguageHaskell2010

Ribosome.Syntax

Description

Data types and combinators for Ribosome.Api.Syntax.

Synopsis

Documentation

data Syntax Source #

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

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

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

Instances

data Highlight Source #

Options for a highlight group.

Constructors

Highlight 

Fields

Instances

Instances details
Show Highlight Source # 
Instance details

Defined in Ribosome.Data.Syntax

Eq Highlight Source # 
Instance details

Defined in Ribosome.Data.Syntax

data SyntaxItem Source #

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

Instances

Instances details
Show SyntaxItem Source # 
Instance details

Defined in Ribosome.Data.Syntax

Eq SyntaxItem Source # 
Instance details

Defined in Ribosome.Data.Syntax

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.