License	BSD-3-Clause
Safe Haskell	Safe-Inferred
Language	Haskell2010

Swarm.Doc.Keyword

Contents

Formatted keyword lists

Description

Collect keywords for documentation generation and testing.

Synopsis

data EditorType
- = Emacs
- | VSCode
- | Vim
keywordsCommands :: EditorType -> Text
keywordsDirections :: EditorType -> Text
operatorNames :: EditorType -> Text
builtinFunctionList :: EditorType -> Text

Documentation

data EditorType Source #

An enumeration of the editors supported by Swarm (currently, Emacs, VS Code and Vim).

Constructors

Emacs
VSCode
Vim

Instances

Instances details

Bounded EditorType Source #
Instance details Defined in Swarm.Doc.Keyword Methods minBound :: EditorType # maxBound :: EditorType #
Enum EditorType Source #
Instance details Defined in Swarm.Doc.Keyword Methods succ :: EditorType -> EditorType # pred :: EditorType -> EditorType # toEnum :: Int -> EditorType # fromEnum :: EditorType -> Int # enumFrom :: EditorType -> [EditorType] # enumFromThen :: EditorType -> EditorType -> [EditorType] # enumFromTo :: EditorType -> EditorType -> [EditorType] # enumFromThenTo :: EditorType -> EditorType -> EditorType -> [EditorType] #
Show EditorType Source #
Instance details Defined in Swarm.Doc.Keyword Methods showsPrec :: Int -> EditorType -> ShowS # show :: EditorType -> String # showList :: [EditorType] -> ShowS #
Eq EditorType Source #
Instance details Defined in Swarm.Doc.Keyword Methods (==) :: EditorType -> EditorType -> Bool # (/=) :: EditorType -> EditorType -> Bool #

Formatted keyword lists

keywordsCommands :: EditorType -> Text Source #

Get formatted list of basic functions/commands.

keywordsDirections :: EditorType -> Text Source #

Get formatted list of directions.

operatorNames :: EditorType -> Text Source #

A list of the names of all the operators in the language. These are reflective of how the different editors treat operators, keywords, symbols etc differently. In order to get the list of operators supported by Swarm language irrespective of an editor, map constSyntax operators should suffice.

builtinFunctionList :: EditorType -> Text Source #