Skylighting.Modding

Functions for making alterations to skylighting-core values (SyntaxMap, Syntax, Context, Rule, etc.).

Syntax maps

type SyntaxMap = Map Text Syntax

A map of syntaxes, keyed by full name.

syntaxMap :: Syntax -> SyntaxMap

Convert a Syntax into a SyntaxMap that contains only that one syntax.

addSyntax :: Syntax -> SyntaxMap -> SyntaxMap

Adds one Syntax to a SyntaxMap, or replaces a context of the same name if one exists.

modifySyntax

Arguments

:: Text

The name of the syntax to modify

-> (Syntax -> Syntax)

-> SyntaxMap

-> SyntaxMap

Modify a SyntaxMap by looking up a particular syntax by name, applying some function to it, and placing the resulting syntax into the map in place of the original syntax.

Syntax fields

modifySyntaxContexts :: (ContextMap -> ContextMap) -> Syntax -> Syntax

Apply a function to the sContexts field of a Syntax.

Context maps

type ContextMap = Map Text Context

A map of contexts, keyed by cName.

This is the type of sContexts.

contextMap :: Context -> ContextMap

Convert a Context into a ContextMap that contains only that one context.

addContext :: Context -> ContextMap -> ContextMap

Adds one Context to a ContextMap, or replaces a context of the same name if one exists.

modifyContext

Arguments

:: Text

The name of the context to modify

-> (Context -> Context)

-> ContextMap

-> ContextMap

Modify a SyntaxMap by looking up a particular syntax by name, applying some function to it, and placing the resulting syntax into the map in place of the original syntax.

Rules

replaceKeywordRule :: Rule -> Context -> Context

Alters a Context by replacing any Rule that looks like a typical keyword rule (as determined by isKeywordRule) with the given rule.

isKeywordRule :: Rule -> Bool

Determines whether a Rule looks like a typical rule for keywords:

1. rAttribute = KeywordTok
2. rMatcher is of the Keyword variety