Yi.Mode.Common

Common functions used by modes.

Documentation

type TokenBasedMode tok = Mode (Tree (Tok tok))

fundamentalMode :: Mode syntax

The only built in mode of yi

anyExtension

Arguments

:: [String]

List of extensions

-> FilePath

Path to compare against

-> a

File contents. Currently unused but see extensionOrContentsMatch.

-> Bool

When applied to an extensions list, creates a modeApplies function.

extensionOrContentsMatch :: [String] -> Parser () -> FilePath -> YiString -> Bool

When applied to an extensions list and regular expression pattern, creates a modeApplies function.

linearSyntaxMode

Arguments

:: Show s

=> s

Starting state

-> TokenLexer AlexState s (Tok t) AlexInput

-> (t -> StyleName)

-> TokenBasedMode t

Specialised version of linearSyntaxMode' for the common case, wrapping up into a Lexer with commonLexer.

hookModes :: (AnyMode -> Bool) -> BufferM () -> [AnyMode] -> [AnyMode]

Adds a hook to all matching hooks in a list

applyModeHooks :: [(AnyMode -> Bool, BufferM ())] -> [AnyMode] -> [AnyMode]

Apply a list of mode hooks to a list of AnyModes

lookupMode :: AnyMode -> YiM AnyMode

Check whether a mode of the same name is already in modeTable and returns the original mode, if it isn't the case.

styleMode :: Show (l s) => StyleLexer l s t i -> TokenBasedMode t

extensionMatches :: [String] -> FilePath -> Bool

Determines if the file's extension is one of the extensions in the list.

shebangParser :: Parser a -> Parser ()

Generate a parser for shebang patterns the generated parser will match only if the shebang is at the start of a line

Examples

shebangParser "runhaskell"

generates a parser that matches "#!/usr/bin/env runhaskell\n" (but also "djsjfaj\n\n\n\r\n#! /usr/bin/env runhaskell \ndkasfkda\n\r\nkasfaj")

Note: You can get ("runhaskell" :: Parser String) by using the OverloadedStrings extension

shebangParser "python"

generates a parser that matches "#!/usr/bin/env python\n"

Note: it doesn't match "#!/usr/bin/env python2\n" (that's why the newline is required)

It is also possible to use more complex parsers:

shebangParser ("python" *> ("2" <|> "3" <|> ""))

generates a parser that matches any of:

• "#!/usr/bin/env python\n"
• "#!/usr/bin/env python2\n"
• "#!/usr/bin/env python3\n"