Safe Haskell	Safe-Inferred
Language	Haskell2010

Ribosome.Data.Mapping

Description

Data types for Neovim mappings

Synopsis

newtype MappingLhs = MappingLhs {
- unMappingLhs :: Text
}
newtype MappingId = MappingId {
- unMappingId :: Text
}
data MapMode
- = MapDefault
- | MapNormal
- | MapInsertCmdline
- | MapInsert
- | MapCmdline
- | MapLangArg
- | MapVisual
- | MapSelect
- | MapVisualSelect
- | MapOperator
mapModePrefix :: MapMode -> Text
mapModeSuffix :: MapMode -> Text
mapModeShortName :: MapMode -> Text
data MappingAction
- = MappingCall RpcName
- | MappingEvent EventName
data MappingSpec = MappingSpec {
- lhs :: MappingLhs
- mode :: NonEmpty MapMode
}
data Mapping = Mapping {
- action :: MappingAction
- spec :: MappingSpec
- id :: Maybe MappingId
- opts :: Map Text Object
}

Documentation

newtype MappingLhs Source #

The sequence of keys that triggers a mapping.

Constructors

MappingLhs
Fields unMappingLhs :: Text

Instances

Instances details

IsString MappingLhs Source #
Instance details Defined in Ribosome.Data.Mapping Methods fromString :: String -> MappingLhs #
Show MappingLhs Source #
Instance details Defined in Ribosome.Data.Mapping Methods showsPrec :: Int -> MappingLhs -> ShowS # show :: MappingLhs -> String # showList :: [MappingLhs] -> ShowS #
Eq MappingLhs Source #
Instance details Defined in Ribosome.Data.Mapping Methods (==) :: MappingLhs -> MappingLhs -> Bool # (/=) :: MappingLhs -> MappingLhs -> Bool #
Ord MappingLhs Source #
Instance details Defined in Ribosome.Data.Mapping Methods compare :: MappingLhs -> MappingLhs -> Ordering # (<) :: MappingLhs -> MappingLhs -> Bool # (<=) :: MappingLhs -> MappingLhs -> Bool # (>) :: MappingLhs -> MappingLhs -> Bool # (>=) :: MappingLhs -> MappingLhs -> Bool # max :: MappingLhs -> MappingLhs -> MappingLhs # min :: MappingLhs -> MappingLhs -> MappingLhs #

newtype MappingId Source #

This ID type is intended to carry information about what buffer or other component triggered a mapping, if needed.

Constructors

MappingId
Fields unMappingId :: Text

Instances

Instances details

IsString MappingId Source #
Instance details Defined in Ribosome.Data.Mapping Methods fromString :: String -> MappingId #
Show MappingId Source #
Instance details Defined in Ribosome.Data.Mapping Methods showsPrec :: Int -> MappingId -> ShowS # show :: MappingId -> String # showList :: [MappingId] -> ShowS #
Eq MappingId Source #
Instance details Defined in Ribosome.Data.Mapping Methods (==) :: MappingId -> MappingId -> Bool # (/=) :: MappingId -> MappingId -> Bool #
Ord MappingId Source #
Instance details Defined in Ribosome.Data.Mapping Methods compare :: MappingId -> MappingId -> Ordering # (<) :: MappingId -> MappingId -> Bool # (<=) :: MappingId -> MappingId -> Bool # (>) :: MappingId -> MappingId -> Bool # (>=) :: MappingId -> MappingId -> Bool # max :: MappingId -> MappingId -> MappingId # min :: MappingId -> MappingId -> MappingId #
MsgpackDecode MappingId Source #
Instance details Defined in Ribosome.Data.Mapping Methods fromMsgpack :: Object -> Either Text MappingId # missingKey :: String -> Object -> Either Text MappingId #
MsgpackEncode MappingId Source #
Instance details Defined in Ribosome.Data.Mapping Methods toMsgpack :: MappingId -> Object #

data MapMode Source #

All possible variants of Neovim's map commands, causing mappings to be registered for different modes.

Constructors

MapDefault	`:map` – normal, visual, select and operator-pending
MapNormal	`:nmap` – normal
MapInsertCmdline	`:map!` – insert and cmdline
MapInsert	`:imap` – insert
MapCmdline	`:cmap` – cmdline
MapLangArg	`:lmap` – insert, cmdline, lang-arg
MapVisual	`:xmap` – visual
MapSelect	`:smap` – select
MapVisualSelect	`:vmap` – visual and select
MapOperator	`:omap` – operator-pending

Instances

Instances details

Enum MapMode Source #
Instance details Defined in Ribosome.Data.Mapping Methods succ :: MapMode -> MapMode # pred :: MapMode -> MapMode # toEnum :: Int -> MapMode # fromEnum :: MapMode -> Int # enumFrom :: MapMode -> [MapMode] # enumFromThen :: MapMode -> MapMode -> [MapMode] # enumFromTo :: MapMode -> MapMode -> [MapMode] # enumFromThenTo :: MapMode -> MapMode -> MapMode -> [MapMode] #
Show MapMode Source #
Instance details Defined in Ribosome.Data.Mapping Methods showsPrec :: Int -> MapMode -> ShowS # show :: MapMode -> String # showList :: [MapMode] -> ShowS #
Default MapMode Source #
Instance details Defined in Ribosome.Data.Mapping Methods def :: MapMode #
Eq MapMode Source #
Instance details Defined in Ribosome.Data.Mapping Methods (==) :: MapMode -> MapMode -> Bool # (/=) :: MapMode -> MapMode -> Bool #
Ord MapMode Source #
Instance details Defined in Ribosome.Data.Mapping Methods compare :: MapMode -> MapMode -> Ordering # (<) :: MapMode -> MapMode -> Bool # (<=) :: MapMode -> MapMode -> Bool # (>) :: MapMode -> MapMode -> Bool # (>=) :: MapMode -> MapMode -> Bool # max :: MapMode -> MapMode -> MapMode # min :: MapMode -> MapMode -> MapMode #

mapModePrefix :: MapMode -> Text Source #

The character representing a map mode prefixing a map command.

mapModeSuffix :: MapMode -> Text Source #

The bang suffixing the insert+cmdline map cmd.

mapModeShortName :: MapMode -> Text Source #

The character representing a map mode when passing it to an api function.

data MappingAction Source #

The action that should be performed when a mapping is triggered.

Constructors

MappingCall RpcName	The name of the `RpcHandler` that should be called when the mapping is triggered.
MappingEvent EventName	The event to publish when the mapping is triggered.

Instances

Instances details

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

data MappingSpec Source #

The configuration for a mapping that is specific to Neovim.

Constructors

MappingSpec
Fields lhs :: MappingLhs The key sequence that triggers the mapping. mode :: NonEmpty MapMode The modes in which the mapping should be installed.

Instances

Instances details

IsString MappingSpec Source #
Instance details Defined in Ribosome.Data.Mapping Methods fromString :: String -> MappingSpec #
Generic MappingSpec Source #
Instance details Defined in Ribosome.Data.Mapping Associated Types type Rep MappingSpec :: Type -> Type # Methods from :: MappingSpec -> Rep MappingSpec x # to :: Rep MappingSpec x -> MappingSpec #
Show MappingSpec Source #
Instance details Defined in Ribosome.Data.Mapping Methods showsPrec :: Int -> MappingSpec -> ShowS # show :: MappingSpec -> String # showList :: [MappingSpec] -> ShowS #
Eq MappingSpec Source #
Instance details Defined in Ribosome.Data.Mapping Methods (==) :: MappingSpec -> MappingSpec -> Bool # (/=) :: MappingSpec -> MappingSpec -> Bool #
Ord MappingSpec Source #
Instance details Defined in Ribosome.Data.Mapping Methods compare :: MappingSpec -> MappingSpec -> Ordering # (<) :: MappingSpec -> MappingSpec -> Bool # (<=) :: MappingSpec -> MappingSpec -> Bool # (>) :: MappingSpec -> MappingSpec -> Bool # (>=) :: MappingSpec -> MappingSpec -> Bool # max :: MappingSpec -> MappingSpec -> MappingSpec # min :: MappingSpec -> MappingSpec -> MappingSpec #
type Rep MappingSpec Source #
Instance details Defined in Ribosome.Data.Mapping type Rep MappingSpec = D1 ('MetaData "MappingSpec" "Ribosome.Data.Mapping" "ribosome-0.9.9.9-2kHabuyTX5NGSYChGwh5iS" 'False) (C1 ('MetaCons "MappingSpec" 'PrefixI 'True) (S1 ('MetaSel ('Just "lhs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MappingLhs) :*: S1 ('MetaSel ('Just "mode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (NonEmpty MapMode))))

data Mapping Source #

This type associates a sequence of keys and a mode for a Neovim mapping with an RPC handler or event. It is intended to be used with mappingFor or eventMapping and activateBufferMapping.

Constructors

Mapping
Fields action :: MappingAction The action to take when the mapping is triggered. spec :: MappingSpec The Neovim related configuration for the mapping, i.e. its key sequence and modes. id :: Maybe MappingId An optional string identifying the source of the mapping, for example when adding it to multiple buffers. opts :: Map Text Object Options like `remap`, `nowait` or `desc`.

Instances

Instances details

Generic Mapping Source #
Instance details Defined in Ribosome.Data.Mapping Associated Types type Rep Mapping :: Type -> Type # Methods from :: Mapping -> Rep Mapping x # to :: Rep Mapping x -> Mapping #
Show Mapping Source #
Instance details Defined in Ribosome.Data.Mapping Methods showsPrec :: Int -> Mapping -> ShowS # show :: Mapping -> String # showList :: [Mapping] -> ShowS #
Eq Mapping Source #
Instance details Defined in Ribosome.Data.Mapping Methods (==) :: Mapping -> Mapping -> Bool # (/=) :: Mapping -> Mapping -> Bool #
type Rep Mapping Source #
Instance details Defined in Ribosome.Data.Mapping type Rep Mapping = D1 ('MetaData "Mapping" "Ribosome.Data.Mapping" "ribosome-0.9.9.9-2kHabuyTX5NGSYChGwh5iS" 'False) (C1 ('MetaCons "Mapping" 'PrefixI 'True) ((S1 ('MetaSel ('Just "action") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MappingAction) :: S1 ('MetaSel ('Just "spec") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MappingSpec)) :: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe MappingId)) :*: S1 ('MetaSel ('Just "opts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map Text Object)))))