skylighting-core-0.14: syntax highlighting library

Safe Haskell | Safe-Inferred
Language | Haskell2010

Skylighting.Types

Contents

- Syntax descriptions
- Tokens
- Styles
- Format options

Description

Basic types for Skylighting.

Synopsis

- type ContextName = (Text, Text)
- data KeywordAttr = KeywordAttr {
  - keywordCaseSensitive :: !Bool
  - keywordDelims :: !(Set Char)
  }
- data WordSet a
  - = CaseSensitiveWords !(Set a)
  - | CaseInsensitiveWords !(Set a)
- makeWordSet :: (FoldCase a, Ord a) => Bool -> [a] -> WordSet a
- inWordSet :: (FoldCase a, Ord a) => a -> WordSet a -> Bool
- data ListItem
  - = Item !Text
  - | IncludeList !(Text, Text)
- data Matcher
  - = DetectChar !Char
  - | Detect2Chars !Char !Char
  - | AnyChar !(Set Char)
  - | RangeDetect !Char !Char
  - | StringDetect !Text
  - | WordDetect !Text
  - | RegExpr !RE
  - | Keyword !KeywordAttr (Either Text (WordSet Text))
  - | Int
  - | Float
  - | HlCOct
  - | HlCHex
  - | HlCStringChar
  - | HlCChar
  - | LineContinue
  - | IncludeRules !ContextName
  - | DetectSpaces
  - | DetectIdentifier
- data Rule = Rule {
  - rMatcher :: !Matcher
  - rAttribute :: !TokenType
  - rIncludeAttribute :: !Bool
  - rWeakDeliminators :: Set Char
  - rDynamic :: !Bool
  - rCaseSensitive :: !Bool
  - rChildren :: ![Rule]
  - rLookahead :: !Bool
  - rFirstNonspace :: !Bool
  - rColumn :: !(Maybe Int)
  - rContextSwitch :: ![ContextSwitch]
  }
- data Context = Context {
  - cName :: !Text
  - cSyntax :: !Text
  - cRules :: ![Rule]
  - cAttribute :: !TokenType
  - cLineEmptyContext :: ![ContextSwitch]
  - cLineEndContext :: ![ContextSwitch]
  - cLineBeginContext :: ![ContextSwitch]
  - cFallthrough :: !Bool
  - cFallthroughContext :: ![ContextSwitch]
  - cDynamic :: !Bool
  }
- data ContextSwitch
  - = Pop
  - | Push !ContextName
- data Syntax = Syntax {
  - sName :: !Text
  - sFilename :: !String
  - sShortname :: !Text
  - sLists :: !(Map Text [ListItem])
  - sContexts :: !(Map Text Context)
  - sAuthor :: !Text
  - sVersion :: !Text
  - sLicense :: !Text
  - sExtensions :: ![String]
  - sStartingContext :: !Text
  }
- type SyntaxMap = Map Text Syntax
- type Token = (TokenType, Text)
- data TokenType
  - = KeywordTok
  - | DataTypeTok
  - | DecValTok
  - | BaseNTok
  - | FloatTok
  - | ConstantTok
  - | CharTok
  - | SpecialCharTok
  - | StringTok
  - | VerbatimStringTok
  - | SpecialStringTok
  - | ImportTok
  - | CommentTok
  - | DocumentationTok
  - | AnnotationTok
  - | CommentVarTok
  - | OtherTok
  - | FunctionTok
  - | VariableTok
  - | ControlFlowTok
  - | OperatorTok
  - | BuiltInTok
  - | ExtensionTok
  - | PreprocessorTok
  - | AttributeTok
  - | RegionMarkerTok
  - | InformationTok
  - | WarningTok
  - | AlertTok
  - | ErrorTok
  - | NormalTok
- type SourceLine = [Token]
- newtype LineNo = LineNo {
  - lineNo :: Int
  }
- data TokenStyle = TokenStyle {
  - tokenColor :: !(Maybe Color)
  - tokenBackground :: !(Maybe Color)
  - tokenBold :: !Bool
  - tokenItalic :: !Bool
  - tokenUnderline :: !Bool
  }
- defStyle :: TokenStyle
- data Color = RGB Word8 Word8 Word8
- class ToColor a where
  - toColor :: a -> Maybe Color
- class FromColor a where
  - fromColor :: Color -> a
- data Style = Style {
  - tokenStyles :: !(Map TokenType TokenStyle)
  - defaultColor :: !(Maybe Color)
  - backgroundColor :: !(Maybe Color)
  - lineNumberColor :: !(Maybe Color)
  - lineNumberBackgroundColor :: !(Maybe Color)
  }
- data ANSIColorLevel
  - = ANSI16Color
  - | ANSI256Color
  - | ANSITrueColor
- data FormatOptions = FormatOptions {
  - numberLines :: !Bool
  - startNumber :: !Int
  - lineAnchors :: !Bool
  - titleAttributes :: !Bool
  - codeClasses :: ![Text]
  - containerClasses :: ![Text]
  - lineIdPrefix :: !Text
  - ansiColorLevel :: !ANSIColorLevel
  }
- defaultFormatOpts :: FormatOptions

# Syntax descriptions

type ContextName = (Text, Text) #

Full name of a context: the first member of the pair is the full syntax name, the second the context name within that syntax.

data KeywordAttr #

Attributes controlling how keywords are interpreted.

Constructors

KeywordAttr |

Fields

- keywordCaseSensitive :: !Bool
- keywordDelims :: !(Set Char)

#### Instances

Instances details

Data KeywordAttr # |

Instance details

Defined in Skylighting.Types

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> KeywordAttr -> c KeywordAttr

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c KeywordAttr

toConstr :: KeywordAttr -> Constr

dataTypeOf :: KeywordAttr -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c KeywordAttr)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c KeywordAttr)

gmapT :: (forall b. Data b => b -> b) -> KeywordAttr -> KeywordAttr

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> KeywordAttr -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> KeywordAttr -> r

gmapQ :: (forall d. Data d => d -> u) -> KeywordAttr -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> KeywordAttr -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> KeywordAttr -> m KeywordAttr

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> KeywordAttr -> m KeywordAttr

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> KeywordAttr -> m KeywordAttr

Generic KeywordAttr # |
Instance details Defined in Skylighting.Types Associated Types type Rep KeywordAttr :: Type -> Type Methods from :: KeywordAttr -> Rep KeywordAttr x to :: Rep KeywordAttr x -> KeywordAttr
Read KeywordAttr # |
Instance details Defined in Skylighting.Types Methods readsPrec :: Int -> ReadS KeywordAttr readList :: ReadS [KeywordAttr] readPrec :: ReadPrec KeywordAttr readListPrec :: ReadPrec [KeywordAttr]
Show KeywordAttr # |
Instance details Defined in Skylighting.Types Methods showsPrec :: Int -> KeywordAttr -> ShowS show :: KeywordAttr -> String showList :: [KeywordAttr] -> ShowS
Binary KeywordAttr # |
Instance details Defined in Skylighting.Types Methods put :: KeywordAttr -> Put get :: Get KeywordAttr putList :: [KeywordAttr] -> Put
Eq KeywordAttr # |
Instance details Defined in Skylighting.Types Methods (==) :: KeywordAttr -> KeywordAttr -> Bool (/=) :: KeywordAttr -> KeywordAttr -> Bool
Ord KeywordAttr # |
Instance details Defined in Skylighting.Types Methods compare :: KeywordAttr -> KeywordAttr -> Ordering (<) :: KeywordAttr -> KeywordAttr -> Bool (<=) :: KeywordAttr -> KeywordAttr -> Bool (>) :: KeywordAttr -> KeywordAttr -> Bool (>=) :: KeywordAttr -> KeywordAttr -> Bool max :: KeywordAttr -> KeywordAttr -> KeywordAttr min :: KeywordAttr -> KeywordAttr -> KeywordAttr
type Rep KeywordAttr # |

Instance details

Defined in Skylighting.Types

type Rep KeywordAttr = D1 ('MetaData "KeywordAttr" "Skylighting.Types" "skylighting-core-0.14-2VFtdFvK2VbBi7Hr1W0TBh" 'False) (C1 ('MetaCons "KeywordAttr" 'PrefixI 'True) (S1 ('MetaSel ('Just "keywordCaseSensitive") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "keywordDelims") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Set Char))))

data WordSet a #

A set of "words," possibly case insensitive.

Constructors

CaseSensitiveWords !(Set a) |
CaseInsensitiveWords !(Set a) |

#### Instances

Instances details

(Data a, Ord a) => Data (WordSet a) # |

Instance details

Defined in Skylighting.Types

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> WordSet a -> c (WordSet a)

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (WordSet a)

toConstr :: WordSet a -> Constr

dataTypeOf :: WordSet a -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c (WordSet a))

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (WordSet a))

gmapT :: (forall b. Data b => b -> b) -> WordSet a -> WordSet a

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> WordSet a -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> WordSet a -> r

gmapQ :: (forall d. Data d => d -> u) -> WordSet a -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> WordSet a -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> WordSet a -> m (WordSet a)

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> WordSet a -> m (WordSet a)

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> WordSet a -> m (WordSet a)

Generic (WordSet a) # |
Instance details Defined in Skylighting.Types Associated Types type Rep (WordSet a) :: Type -> Type Methods from :: WordSet a -> Rep (WordSet a) x to :: Rep (WordSet a) x -> WordSet a
(Read a, Ord a) => Read (WordSet a) # |
Instance details Defined in Skylighting.Types Methods readsPrec :: Int -> ReadS (WordSet a) readList :: ReadS [WordSet a] readPrec :: ReadPrec (WordSet a) readListPrec :: ReadPrec [WordSet a]
Show a => Show (WordSet a) # |
Instance details Defined in Skylighting.Types Methods showsPrec :: Int -> WordSet a -> ShowS show :: WordSet a -> String showList :: [WordSet a] -> ShowS
Binary a => Binary (WordSet a) # |
Instance details Defined in Skylighting.Types Methods put :: WordSet a -> Put get :: Get (WordSet a) putList :: [WordSet a] -> Put
Eq a => Eq (WordSet a) # |
Instance details Defined in Skylighting.Types Methods (==) :: WordSet a -> WordSet a -> Bool (/=) :: WordSet a -> WordSet a -> Bool
Ord a => Ord (WordSet a) # |
Instance details Defined in Skylighting.Types Methods compare :: WordSet a -> WordSet a -> Ordering (<) :: WordSet a -> WordSet a -> Bool (<=) :: WordSet a -> WordSet a -> Bool (>) :: WordSet a -> WordSet a -> Bool (>=) :: WordSet a -> WordSet a -> Bool max :: WordSet a -> WordSet a -> WordSet a min :: WordSet a -> WordSet a -> WordSet a
type Rep (WordSet a) # |

Instance details

Defined in Skylighting.Types

type Rep (WordSet a) = D1 ('MetaData "WordSet" "Skylighting.Types" "skylighting-core-0.14-2VFtdFvK2VbBi7Hr1W0TBh" 'False) (C1 ('MetaCons "CaseSensitiveWords" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Set a))) :+: C1 ('MetaCons "CaseInsensitiveWords" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Set a))))

makeWordSet :: (FoldCase a, Ord a) => Bool -> [a] -> WordSet a #

A set of words to match (either case-sensitive or case-insensitive).

inWordSet :: (FoldCase a, Ord a) => a -> WordSet a -> Bool #

Test for membership in a `WordSet`.

data ListItem #

A list item is either just a textual value or an included list. IncludeList (x,y) includes list y from syntax with full name x.

Constructors

Item !Text |
IncludeList !(Text, Text) |

#### Instances

Instances details

Data ListItem # |

Instance details

Defined in Skylighting.Types

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListItem -> c ListItem

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListItem

toConstr :: ListItem -> Constr

dataTypeOf :: ListItem -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ListItem)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListItem)

gmapT :: (forall b. Data b => b -> b) -> ListItem -> ListItem

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListItem -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListItem -> r

gmapQ :: (forall d. Data d => d -> u) -> ListItem -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListItem -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListItem -> m ListItem

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListItem -> m ListItem

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListItem -> m ListItem

Generic ListItem # |
Instance details Defined in Skylighting.Types Associated Types type Rep ListItem :: Type -> Type Methods from :: ListItem -> Rep ListItem x to :: Rep ListItem x -> ListItem
Read ListItem # |
Instance details Defined in Skylighting.Types Methods readsPrec :: Int -> ReadS ListItem readList :: ReadS [ListItem] readPrec :: ReadPrec ListItem readListPrec :: ReadPrec [ListItem]
Show ListItem # |
Instance details Defined in Skylighting.Types Methods showsPrec :: Int -> ListItem -> ShowS show :: ListItem -> String showList :: [ListItem] -> ShowS
Binary ListItem # |
Instance details Defined in Skylighting.Types Methods put :: ListItem -> Put get :: Get ListItem putList :: [ListItem] -> Put
Eq ListItem # |
Instance details Defined in Skylighting.Types Methods (==) :: ListItem -> ListItem -> Bool (/=) :: ListItem -> ListItem -> Bool
Ord ListItem # |
Instance details Defined in Skylighting.Types Methods compare :: ListItem -> ListItem -> Ordering (<) :: ListItem -> ListItem -> Bool (<=) :: ListItem -> ListItem -> Bool (>) :: ListItem -> ListItem -> Bool (>=) :: ListItem -> ListItem -> Bool max :: ListItem -> ListItem -> ListItem min :: ListItem -> ListItem -> ListItem
type Rep ListItem # |

Instance details

Defined in Skylighting.Types

type Rep ListItem = D1 ('MetaData "ListItem" "Skylighting.Types" "skylighting-core-0.14-2VFtdFvK2VbBi7Hr1W0TBh" 'False) (C1 ('MetaCons "Item" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text)) :+: C1 ('MetaCons "IncludeList" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Text, Text))))

data Matcher #

Matchers correspond to the element types in a context.

Constructors

DetectChar !Char |
Detect2Chars !Char !Char |
AnyChar !(Set Char) |
RangeDetect !Char !Char |
StringDetect !Text |
WordDetect !Text |
RegExpr !RE |
Keyword !KeywordAttr (Either Text (WordSet Text)) |
Int |
Float |
HlCOct |
HlCHex |
HlCStringChar |
HlCChar |
LineContinue |
IncludeRules !ContextName |
DetectSpaces |
DetectIdentifier |

#### Instances

Instances details

Data Matcher # |

Instance details

Defined in Skylighting.Types

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Matcher -> c Matcher

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Matcher

toConstr :: Matcher -> Constr

dataTypeOf :: Matcher -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Matcher)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Matcher)

gmapT :: (forall b. Data b => b -> b) -> Matcher -> Matcher

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Matcher -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Matcher -> r

gmapQ :: (forall d. Data d => d -> u) -> Matcher -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Matcher -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Matcher -> m Matcher

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Matcher -> m Matcher

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Matcher -> m Matcher

Generic Matcher # |
Instance details Defined in Skylighting.Types Associated Types type Rep Matcher :: Type -> Type Methods from :: Matcher -> Rep Matcher x to :: Rep Matcher x -> Matcher
Read Matcher # |
Instance details Defined in Skylighting.Types Methods readsPrec :: Int -> ReadS Matcher readList :: ReadS [Matcher] readPrec :: ReadPrec Matcher readListPrec :: ReadPrec [Matcher]
Show Matcher # |
Instance details Defined in Skylighting.Types Methods showsPrec :: Int -> Matcher -> ShowS show :: Matcher -> String showList :: [Matcher] -> ShowS
Binary Matcher # |
Instance details Defined in Skylighting.Types Methods put :: Matcher -> Put get :: Get Matcher putList :: [Matcher] -> Put
Eq Matcher # |
Instance details Defined in Skylighting.Types Methods (==) :: Matcher -> Matcher -> Bool (/=) :: Matcher -> Matcher -> Bool
Ord Matcher # |
Instance details Defined in Skylighting.Types Methods compare :: Matcher -> Matcher -> Ordering (<) :: Matcher -> Matcher -> Bool (<=) :: Matcher -> Matcher -> Bool (>) :: Matcher -> Matcher -> Bool (>=) :: Matcher -> Matcher -> Bool max :: Matcher -> Matcher -> Matcher min :: Matcher -> Matcher -> Matcher
type Rep Matcher # |

Instance details

Defined in Skylighting.Types

type Rep Matcher = D1 ('MetaData "Matcher" "Skylighting.Types" "skylighting-core-0.14-2VFtdFvK2VbBi7Hr1W0TBh" 'False) ((((C1 ('MetaCons "DetectChar" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Char)) :+: C1 ('MetaCons "Detect2Chars" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Char) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Char))) :+: (C1 ('MetaCons "AnyChar" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Set Char))) :+: C1 ('MetaCons "RangeDetect" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Char) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Char)))) :+: ((C1 ('MetaCons "StringDetect" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text)) :+: C1 ('MetaCons "WordDetect" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text))) :+: (C1 ('MetaCons "RegExpr" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 RE)) :+: (C1 ('MetaCons "Keyword" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 KeywordAttr) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Either Text (WordSet Text)))) :+: C1 ('MetaCons "Int" 'PrefixI 'False) (U1 :: Type -> Type))))) :+: (((C1 ('MetaCons "Float" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "HlCOct" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "HlCHex" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "HlCStringChar" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "HlCChar" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "LineContinue" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "IncludeRules" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ContextName)) :+: (C1 ('MetaCons "DetectSpaces" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "DetectIdentifier" 'PrefixI 'False) (U1 :: Type -> Type))))))

data Rule #

A rule corresponds to one of the elements of a Kate syntax highlighting "context."

Constructors

Rule |

Fields

- rMatcher :: !Matcher
- rAttribute :: !TokenType
- rIncludeAttribute :: !Bool
- rWeakDeliminators :: Set Char
- rDynamic :: !Bool
- rCaseSensitive :: !Bool
- rChildren :: ![Rule]
- rLookahead :: !Bool
- rFirstNonspace :: !Bool
- rColumn :: !(Maybe Int)
- rContextSwitch :: ![ContextSwitch]

#### Instances

Instances details

Data Rule # |

Instance details

Defined in Skylighting.Types

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Rule -> c Rule

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Rule

toConstr :: Rule -> Constr

dataTypeOf :: Rule -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Rule)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Rule)

gmapT :: (forall b. Data b => b -> b) -> Rule -> Rule

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Rule -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Rule -> r

gmapQ :: (forall d. Data d => d -> u) -> Rule -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Rule -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Rule -> m Rule

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Rule -> m Rule

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Rule -> m Rule

Generic Rule # |
Instance details Defined in Skylighting.Types Associated Types type Rep Rule :: Type -> Type Methods from :: Rule -> Rep Rule x to :: Rep Rule x -> Rule
Read Rule # |
Instance details Defined in Skylighting.Types Methods readsPrec :: Int -> ReadS Rule readList :: ReadS [Rule] readPrec :: ReadPrec Rule readListPrec :: ReadPrec [Rule]
Show Rule # |
Instance details Defined in Skylighting.Types Methods showsPrec :: Int -> Rule -> ShowS show :: Rule -> String showList :: [Rule] -> ShowS
Binary Rule # |
Instance details Defined in Skylighting.Types Methods put :: Rule -> Put get :: Get Rule putList :: [Rule] -> Put
Eq Rule # |
Instance details Defined in Skylighting.Types Methods (==) :: Rule -> Rule -> Bool (/=) :: Rule -> Rule -> Bool
Ord Rule # |
Instance details Defined in Skylighting.Types Methods compare :: Rule -> Rule -> Ordering (<) :: Rule -> Rule -> Bool (<=) :: Rule -> Rule -> Bool (>) :: Rule -> Rule -> Bool (>=) :: Rule -> Rule -> Bool max :: Rule -> Rule -> Rule min :: Rule -> Rule -> Rule
type Rep Rule # |

Instance details

Defined in Skylighting.Types

type Rep Rule = D1 ('MetaData "Rule" "Skylighting.Types" "skylighting-core-0.14-2VFtdFvK2VbBi7Hr1W0TBh" 'False) (C1 ('MetaCons "Rule" 'PrefixI 'True) (((S1 ('MetaSel ('Just "rMatcher") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Matcher) :*: S1 ('MetaSel ('Just "rAttribute") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 TokenType)) :*: (S1 ('MetaSel ('Just "rIncludeAttribute") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool) :*: (S1 ('MetaSel ('Just "rWeakDeliminators") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Set Char)) :*: S1 ('MetaSel ('Just "rDynamic") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool)))) :*: ((S1 ('MetaSel ('Just "rCaseSensitive") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool) :*: (S1 ('MetaSel ('Just "rChildren") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 [Rule]) :*: S1 ('MetaSel ('Just "rLookahead") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool))) :*: (S1 ('MetaSel ('Just "rFirstNonspace") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool) :*: (S1 ('MetaSel ('Just "rColumn") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "rContextSwitch") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 [ContextSwitch]))))))

data Context #

A Context corresponds to a context element in a Kate syntax description.

Constructors

Context |

Fields

- cName :: !Text
- cSyntax :: !Text
- cRules :: ![Rule]
- cAttribute :: !TokenType
- cLineEmptyContext :: ![ContextSwitch]
- cLineEndContext :: ![ContextSwitch]
- cLineBeginContext :: ![ContextSwitch]
- cFallthrough :: !Bool
- cFallthroughContext :: ![ContextSwitch]
- cDynamic :: !Bool

#### Instances

Instances details

Data Context # |

Instance details

Defined in Skylighting.Types

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Context -> c Context

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Context

toConstr :: Context -> Constr

dataTypeOf :: Context -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Context)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Context)

gmapT :: (forall b. Data b => b -> b) -> Context -> Context

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Context -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Context -> r

gmapQ :: (forall d. Data d => d -> u) -> Context -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Context -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Context -> m Context

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Context -> m Context

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Context -> m Context

Generic Context # |
Instance details Defined in Skylighting.Types Associated Types type Rep Context :: Type -> Type Methods from :: Context -> Rep Context x to :: Rep Context x -> Context
Read Context # |
Instance details Defined in Skylighting.Types Methods readsPrec :: Int -> ReadS Context readList :: ReadS [Context] readPrec :: ReadPrec Context readListPrec :: ReadPrec [Context]
Show Context # |
Instance details Defined in Skylighting.Types Methods showsPrec :: Int -> Context -> ShowS show :: Context -> String showList :: [Context] -> ShowS
Binary Context # |
Instance details Defined in Skylighting.Types Methods put :: Context -> Put get :: Get Context putList :: [Context] -> Put
Eq Context # |
Instance details Defined in Skylighting.Types Methods (==) :: Context -> Context -> Bool (/=) :: Context -> Context -> Bool
Ord Context # |
Instance details Defined in Skylighting.Types Methods compare :: Context -> Context -> Ordering (<) :: Context -> Context -> Bool (<=) :: Context -> Context -> Bool (>) :: Context -> Context -> Bool (>=) :: Context -> Context -> Bool max :: Context -> Context -> Context min :: Context -> Context -> Context
type Rep Context # |

Instance details

Defined in Skylighting.Types

type Rep Context = D1 ('MetaData "Context" "Skylighting.Types" "skylighting-core-0.14-2VFtdFvK2VbBi7Hr1W0TBh" 'False) (C1 ('MetaCons "Context" 'PrefixI 'True) (((S1 ('MetaSel ('Just "cName") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "cSyntax") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "cRules") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 [Rule]) :*: (S1 ('MetaSel ('Just "cAttribute") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 TokenType) :*: S1 ('MetaSel ('Just "cLineEmptyContext") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 [ContextSwitch])))) :*: ((S1 ('MetaSel ('Just "cLineEndContext") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 [ContextSwitch]) :*: S1 ('MetaSel ('Just "cLineBeginContext") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 [ContextSwitch])) :*: (S1 ('MetaSel ('Just "cFallthrough") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool) :*: (S1 ('MetaSel ('Just "cFallthroughContext") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 [ContextSwitch]) :*: S1 ('MetaSel ('Just "cDynamic") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool))))))

data ContextSwitch #

A context switch, either pops or pushes a context.

Constructors

Pop |
Push !ContextName |

#### Instances

Instances details

Data ContextSwitch # |

Instance details

Defined in Skylighting.Types

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ContextSwitch -> c ContextSwitch

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ContextSwitch

toConstr :: ContextSwitch -> Constr

dataTypeOf :: ContextSwitch -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ContextSwitch)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ContextSwitch)

gmapT :: (forall b. Data b => b -> b) -> ContextSwitch -> ContextSwitch

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ContextSwitch -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ContextSwitch -> r

gmapQ :: (forall d. Data d => d -> u) -> ContextSwitch -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ContextSwitch -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ContextSwitch -> m ContextSwitch

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ContextSwitch -> m ContextSwitch

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ContextSwitch -> m ContextSwitch

Generic ContextSwitch # |
Instance details Defined in Skylighting.Types Associated Types type Rep ContextSwitch :: Type -> Type Methods from :: ContextSwitch -> Rep ContextSwitch x to :: Rep ContextSwitch x -> ContextSwitch
Read ContextSwitch # |
Instance details Defined in Skylighting.Types Methods readsPrec :: Int -> ReadS ContextSwitch readList :: ReadS [ContextSwitch] readPrec :: ReadPrec ContextSwitch readListPrec :: ReadPrec [ContextSwitch]
Show ContextSwitch # |
Instance details Defined in Skylighting.Types Methods showsPrec :: Int -> ContextSwitch -> ShowS show :: ContextSwitch -> String showList :: [ContextSwitch] -> ShowS
Binary ContextSwitch # |
Instance details Defined in Skylighting.Types Methods put :: ContextSwitch -> Put get :: Get ContextSwitch putList :: [ContextSwitch] -> Put
Eq ContextSwitch # |
Instance details Defined in Skylighting.Types Methods (==) :: ContextSwitch -> ContextSwitch -> Bool (/=) :: ContextSwitch -> ContextSwitch -> Bool
Ord ContextSwitch # |

Instance details

Defined in Skylighting.Types

Methods

compare :: ContextSwitch -> ContextSwitch -> Ordering

(<) :: ContextSwitch -> ContextSwitch -> Bool

(<=) :: ContextSwitch -> ContextSwitch -> Bool

(>) :: ContextSwitch -> ContextSwitch -> Bool

(>=) :: ContextSwitch -> ContextSwitch -> Bool

max :: ContextSwitch -> ContextSwitch -> ContextSwitch

min :: ContextSwitch -> ContextSwitch -> ContextSwitch

type Rep ContextSwitch # |
Instance details Defined in Skylighting.Types type Rep ContextSwitch = D1 ('MetaData "ContextSwitch" "Skylighting.Types" "skylighting-core-0.14-2VFtdFvK2VbBi7Hr1W0TBh" 'False) (C1 ('MetaCons "Pop" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Push" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ContextName)))

data Syntax #

A syntax corresponds to a complete Kate syntax description. The `sShortname` field is derived from the filename.

Constructors

Syntax |

Fields

- sName :: !Text
- sFilename :: !String
- sShortname :: !Text
- sLists :: !(Map Text [ListItem])
- sContexts :: !(Map Text Context)
- sAuthor :: !Text
- sVersion :: !Text
- sLicense :: !Text
- sExtensions :: ![String]
- sStartingContext :: !Text

#### Instances

Instances details

Data Syntax # |

Instance details

Defined in Skylighting.Types

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Syntax -> c Syntax

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Syntax

toConstr :: Syntax -> Constr

dataTypeOf :: Syntax -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Syntax)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Syntax)

gmapT :: (forall b. Data b => b -> b) -> Syntax -> Syntax

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Syntax -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Syntax -> r

gmapQ :: (forall d. Data d => d -> u) -> Syntax -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Syntax -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Syntax -> m Syntax

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Syntax -> m Syntax

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Syntax -> m Syntax

Generic Syntax # |
Instance details Defined in Skylighting.Types Associated Types type Rep Syntax :: Type -> Type Methods from :: Syntax -> Rep Syntax x to :: Rep Syntax x -> Syntax
Read Syntax # |
Instance details Defined in Skylighting.Types Methods readsPrec :: Int -> ReadS Syntax readList :: ReadS [Syntax] readPrec :: ReadPrec Syntax readListPrec :: ReadPrec [Syntax]
Show Syntax # |
Instance details Defined in Skylighting.Types Methods showsPrec :: Int -> Syntax -> ShowS show :: Syntax -> String showList :: [Syntax] -> ShowS
Binary Syntax # |
Instance details Defined in Skylighting.Types Methods put :: Syntax -> Put get :: Get Syntax putList :: [Syntax] -> Put
Eq Syntax # |
Instance details Defined in Skylighting.Types Methods (==) :: Syntax -> Syntax -> Bool (/=) :: Syntax -> Syntax -> Bool
Ord Syntax # |
Instance details Defined in Skylighting.Types Methods compare :: Syntax -> Syntax -> Ordering (<) :: Syntax -> Syntax -> Bool (<=) :: Syntax -> Syntax -> Bool (>) :: Syntax -> Syntax -> Bool (>=) :: Syntax -> Syntax -> Bool max :: Syntax -> Syntax -> Syntax min :: Syntax -> Syntax -> Syntax
type Rep Syntax # |

Instance details

Defined in Skylighting.Types

type Rep Syntax = D1 ('MetaData "Syntax" "Skylighting.Types" "skylighting-core-0.14-2VFtdFvK2VbBi7Hr1W0TBh" 'False) (C1 ('MetaCons "Syntax" 'PrefixI 'True) (((S1 ('MetaSel ('Just "sName") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "sFilename") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 String)) :*: (S1 ('MetaSel ('Just "sShortname") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "sLists") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Map Text [ListItem])) :*: S1 ('MetaSel ('Just "sContexts") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Map Text Context))))) :*: ((S1 ('MetaSel ('Just "sAuthor") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "sVersion") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "sLicense") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "sExtensions") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 [String]) :*: S1 ('MetaSel ('Just "sStartingContext") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text))))))

type SyntaxMap = Map Text Syntax #

A map of syntaxes, keyed by full name.

# Tokens

type Token = (TokenType, Text) #

A pair consisting of a list of attributes and some text.

data TokenType #

`KeywordTok` corresponds to `dsKeyword` in Kate syntax descriptions, and so on.

Constructors

KeywordTok |
DataTypeTok |
DecValTok |
BaseNTok |
FloatTok |
ConstantTok |
CharTok |
SpecialCharTok |
StringTok |
VerbatimStringTok |
SpecialStringTok |
ImportTok |
CommentTok |
DocumentationTok |
AnnotationTok |
CommentVarTok |
OtherTok |
FunctionTok |
VariableTok |
ControlFlowTok |
OperatorTok |
BuiltInTok |
ExtensionTok |
PreprocessorTok |
AttributeTok |
RegionMarkerTok |
InformationTok |
WarningTok |
AlertTok |
ErrorTok |
NormalTok |

#### Instances

Instances details

FromJSON TokenType # |
Instance details Defined in Skylighting.Types Methods parseJSON :: Value -> Parser TokenType # parseJSONList :: Value -> Parser [TokenType] # omittedField :: Maybe TokenType #
FromJSONKey TokenType # | JSON `Keyword` corresponds to `KeywordTok`, and so on.
Instance details Defined in Skylighting.Types Methods fromJSONKey :: FromJSONKeyFunction TokenType # fromJSONKeyList :: FromJSONKeyFunction [TokenType] #
ToJSON TokenType # |
Instance details Defined in Skylighting.Types Methods toJSON :: TokenType -> Value # toEncoding :: TokenType -> Encoding # toJSONList :: [TokenType] -> Value # toEncodingList :: [TokenType] -> Encoding # omitField :: TokenType -> Bool #
ToJSONKey TokenType # |
Instance details Defined in Skylighting.Types Methods toJSONKey :: ToJSONKeyFunction TokenType # toJSONKeyList :: ToJSONKeyFunction [TokenType] #
Data TokenType # |

Instance details

Defined in Skylighting.Types

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> TokenType -> c TokenType

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c TokenType

toConstr :: TokenType -> Constr

dataTypeOf :: TokenType -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c TokenType)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c TokenType)

gmapT :: (forall b. Data b => b -> b) -> TokenType -> TokenType

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> TokenType -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> TokenType -> r

gmapQ :: (forall d. Data d => d -> u) -> TokenType -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> TokenType -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> TokenType -> m TokenType

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> TokenType -> m TokenType

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> TokenType -> m TokenType

Bounded TokenType # |
Instance details Defined in Skylighting.Types Methods minBound :: TokenType maxBound :: TokenType
Enum TokenType # |
Instance details Defined in Skylighting.Types Methods succ :: TokenType -> TokenType pred :: TokenType -> TokenType toEnum :: Int -> TokenType fromEnum :: TokenType -> Int enumFrom :: TokenType -> [TokenType] enumFromThen :: TokenType -> TokenType -> [TokenType] enumFromTo :: TokenType -> TokenType -> [TokenType] enumFromThenTo :: TokenType -> TokenType -> TokenType -> [TokenType]
Generic TokenType # |
Instance details Defined in Skylighting.Types Associated Types type Rep TokenType :: Type -> Type Methods from :: TokenType -> Rep TokenType x to :: Rep TokenType x -> TokenType
Read TokenType # |
Instance details Defined in Skylighting.Types Methods readsPrec :: Int -> ReadS TokenType readList :: ReadS [TokenType] readPrec :: ReadPrec TokenType readListPrec :: ReadPrec [TokenType]
Show TokenType # |
Instance details Defined in Skylighting.Types Methods showsPrec :: Int -> TokenType -> ShowS show :: TokenType -> String showList :: [TokenType] -> ShowS
Binary TokenType # |
Instance details Defined in Skylighting.Types Methods put :: TokenType -> Put get :: Get TokenType putList :: [TokenType] -> Put
Eq TokenType # |
Instance details Defined in Skylighting.Types Methods (==) :: TokenType -> TokenType -> Bool (/=) :: TokenType -> TokenType -> Bool
Ord TokenType # |
Instance details Defined in Skylighting.Types Methods compare :: TokenType -> TokenType -> Ordering (<) :: TokenType -> TokenType -> Bool (<=) :: TokenType -> TokenType -> Bool (>) :: TokenType -> TokenType -> Bool (>=) :: TokenType -> TokenType -> Bool max :: TokenType -> TokenType -> TokenType min :: TokenType -> TokenType -> TokenType
type Rep TokenType # |

Instance details

Defined in Skylighting.Types

type Rep TokenType = D1 ('MetaData "TokenType" "Skylighting.Types" "skylighting-core-0.14-2VFtdFvK2VbBi7Hr1W0TBh" 'False) ((((C1 ('MetaCons "KeywordTok" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "DataTypeTok" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "DecValTok" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "BaseNTok" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "FloatTok" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "ConstantTok" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "CharTok" 'PrefixI 'False) (U1 :: Type -> Type)))) :+: (((C1 ('MetaCons "SpecialCharTok" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "StringTok" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "VerbatimStringTok" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "SpecialStringTok" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "ImportTok" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "CommentTok" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "DocumentationTok" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "AnnotationTok" 'PrefixI 'False) (U1 :: Type -> Type))))) :+: ((((C1 ('MetaCons "CommentVarTok" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "OtherTok" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "FunctionTok" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "VariableTok" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "ControlFlowTok" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "OperatorTok" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "BuiltInTok" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ExtensionTok" 'PrefixI 'False) (U1 :: Type -> Type)))) :+: (((C1 ('MetaCons "PreprocessorTok" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "AttributeTok" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "RegionMarkerTok" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "InformationTok" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "WarningTok" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "AlertTok" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "ErrorTok" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "NormalTok" 'PrefixI 'False) (U1 :: Type -> Type))))))

type SourceLine = [Token] #

A line of source: a list of labeled tokens.

newtype LineNo #

Line numbers

Constructors

LineNo |

Fields

- lineNo :: Int

#### Instances

Instances details

Enum LineNo # |
Instance details Defined in Skylighting.Types Methods succ :: LineNo -> LineNo pred :: LineNo -> LineNo toEnum :: Int -> LineNo fromEnum :: LineNo -> Int enumFrom :: LineNo -> [LineNo] enumFromThen :: LineNo -> LineNo -> [LineNo] enumFromTo :: LineNo -> LineNo -> [LineNo] enumFromThenTo :: LineNo -> LineNo -> LineNo -> [LineNo]
Show LineNo # |
Instance details Defined in Skylighting.Types Methods showsPrec :: Int -> LineNo -> ShowS show :: LineNo -> String showList :: [LineNo] -> ShowS

# Styles

data TokenStyle #

A `TokenStyle` determines how a token is to be rendered.

Constructors

TokenStyle |

Fields

- tokenColor :: !(Maybe Color)
- tokenBackground :: !(Maybe Color)
- tokenBold :: !Bool
- tokenItalic :: !Bool
- tokenUnderline :: !Bool

#### Instances

Instances details

FromJSON TokenStyle # | The keywords used in KDE syntax themes are used, e.g. `text-color` for default token color.
Instance details Defined in Skylighting.Types Methods parseJSON :: Value -> Parser TokenStyle # parseJSONList :: Value -> Parser [TokenStyle] # omittedField :: Maybe TokenStyle #
ToJSON TokenStyle # |
Instance details Defined in Skylighting.Types Methods toJSON :: TokenStyle -> Value # toEncoding :: TokenStyle -> Encoding # toJSONList :: [TokenStyle] -> Value # toEncodingList :: [TokenStyle] -> Encoding # omitField :: TokenStyle -> Bool #
Data TokenStyle # |

Instance details

Defined in Skylighting.Types

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> TokenStyle -> c TokenStyle

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c TokenStyle

toConstr :: TokenStyle -> Constr

dataTypeOf :: TokenStyle -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c TokenStyle)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c TokenStyle)

gmapT :: (forall b. Data b => b -> b) -> TokenStyle -> TokenStyle

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> TokenStyle -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> TokenStyle -> r

gmapQ :: (forall d. Data d => d -> u) -> TokenStyle -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> TokenStyle -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> TokenStyle -> m TokenStyle

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> TokenStyle -> m TokenStyle

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> TokenStyle -> m TokenStyle

Generic TokenStyle # |
Instance details Defined in Skylighting.Types Associated Types type Rep TokenStyle :: Type -> Type Methods from :: TokenStyle -> Rep TokenStyle x to :: Rep TokenStyle x -> TokenStyle
Read TokenStyle # |
Instance details Defined in Skylighting.Types Methods readsPrec :: Int -> ReadS TokenStyle readList :: ReadS [TokenStyle] readPrec :: ReadPrec TokenStyle readListPrec :: ReadPrec [TokenStyle]
Show TokenStyle # |
Instance details Defined in Skylighting.Types Methods showsPrec :: Int -> TokenStyle -> ShowS show :: TokenStyle -> String showList :: [TokenStyle] -> ShowS
Binary TokenStyle # |
Instance details Defined in Skylighting.Types Methods put :: TokenStyle -> Put get :: Get TokenStyle putList :: [TokenStyle] -> Put
Eq TokenStyle # |
Instance details Defined in Skylighting.Types Methods (==) :: TokenStyle -> TokenStyle -> Bool (/=) :: TokenStyle -> TokenStyle -> Bool
Ord TokenStyle # |
Instance details Defined in Skylighting.Types Methods compare :: TokenStyle -> TokenStyle -> Ordering (<) :: TokenStyle -> TokenStyle -> Bool (<=) :: TokenStyle -> TokenStyle -> Bool (>) :: TokenStyle -> TokenStyle -> Bool (>=) :: TokenStyle -> TokenStyle -> Bool max :: TokenStyle -> TokenStyle -> TokenStyle min :: TokenStyle -> TokenStyle -> TokenStyle
type Rep TokenStyle # |

Instance details

Defined in Skylighting.Types

type Rep TokenStyle = D1 ('MetaData "TokenStyle" "Skylighting.Types" "skylighting-core-0.14-2VFtdFvK2VbBi7Hr1W0TBh" 'False) (C1 ('MetaCons "TokenStyle" 'PrefixI 'True) ((S1 ('MetaSel ('Just "tokenColor") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Color)) :*: S1 ('MetaSel ('Just "tokenBackground") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Color))) :*: (S1 ('MetaSel ('Just "tokenBold") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool) :*: (S1 ('MetaSel ('Just "tokenItalic") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "tokenUnderline") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool)))))

defStyle :: TokenStyle #

Default style.

data Color #

A color (red, green, blue).

Constructors

RGB Word8 Word8 Word8 |

#### Instances

Instances details

FromJSON Color # | JSON `"#1aff2b"` corresponds to the color `RGB 0x1a 0xff 0x2b`.
Instance details Defined in Skylighting.Types Methods parseJSON :: Value -> Parser Color # parseJSONList :: Value -> Parser [Color] # omittedField :: Maybe Color #
ToJSON Color # |
Instance details Defined in Skylighting.Types Methods toJSON :: Color -> Value # toEncoding :: Color -> Encoding # toJSONList :: [Color] -> Value # toEncodingList :: [Color] -> Encoding # omitField :: Color -> Bool #
Data Color # |

Instance details

Defined in Skylighting.Types

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Color -> c Color

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Color

toConstr :: Color -> Constr

dataTypeOf :: Color -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Color)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Color)

gmapT :: (forall b. Data b => b -> b) -> Color -> Color

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Color -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Color -> r

gmapQ :: (forall d. Data d => d -> u) -> Color -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Color -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Color -> m Color

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Color -> m Color

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Color -> m Color

Generic Color # |
Instance details Defined in Skylighting.Types Associated Types type Rep Color :: Type -> Type Methods from :: Color -> Rep Color x to :: Rep Color x -> Color
Read Color # |
Instance details Defined in Skylighting.Types Methods readsPrec :: Int -> ReadS Color readList :: ReadS [Color] readPrec :: ReadPrec Color readListPrec :: ReadPrec [Color]
Show Color # |
Instance details Defined in Skylighting.Types Methods showsPrec :: Int -> Color -> ShowS show :: Color -> String showList :: [Color] -> ShowS
Binary Color # |
Instance details Defined in Skylighting.Types Methods put :: Color -> Put get :: Get Color putList :: [Color] -> Put
Eq Color # |
Instance details Defined in Skylighting.Types Methods (==) :: Color -> Color -> Bool (/=) :: Color -> Color -> Bool
Ord Color # |
Instance details Defined in Skylighting.Types Methods compare :: Color -> Color -> Ordering (<) :: Color -> Color -> Bool (<=) :: Color -> Color -> Bool (>) :: Color -> Color -> Bool (>=) :: Color -> Color -> Bool max :: Color -> Color -> Color min :: Color -> Color -> Color
type Rep Color # |

Instance details

Defined in Skylighting.Types

type Rep Color = D1 ('MetaData "Color" "Skylighting.Types" "skylighting-core-0.14-2VFtdFvK2VbBi7Hr1W0TBh" 'False) (C1 ('MetaCons "RGB" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word8) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word8) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word8))))

class ToColor a where #

Things that can be converted to a color.

Methods

toColor :: a -> Maybe Color #

#### Instances

Instances details

ToColor String # |
Instance details Defined in Skylighting.Types Methods toColor :: String -> Maybe Color #
ToColor Int # |
Instance details Defined in Skylighting.Types Methods toColor :: Int -> Maybe Color #
(RealFrac a, Floating a) => ToColor (Colour a) # |
Instance details Defined in Skylighting.Types Methods toColor :: Colour a -> Maybe Color #
ToColor (Word8, Word8, Word8) # |
Instance details Defined in Skylighting.Types Methods toColor :: (Word8, Word8, Word8) -> Maybe Color #
ToColor (Double, Double, Double) # |
Instance details Defined in Skylighting.Types Methods toColor :: (Double, Double, Double) -> Maybe Color #

class FromColor a where #

Different representations of a `Color`.

Methods

fromColor :: Color -> a #

#### Instances

Instances details

FromColor String # |
Instance details Defined in Skylighting.Types Methods fromColor :: Color -> String #
(Ord a, Floating a) => FromColor (Colour a) # |
Instance details Defined in Skylighting.Types Methods fromColor :: Color -> Colour a #
FromColor (Word8, Word8, Word8) # |
Instance details Defined in Skylighting.Types Methods fromColor :: Color -> (Word8, Word8, Word8) #
FromColor (Double, Double, Double) # |
Instance details Defined in Skylighting.Types Methods fromColor :: Color -> (Double, Double, Double) #

data Style #

A rendering style. This determines how each kind of token is to be rendered, and sets a default color and background color for normal tokens. Line numbers can have a different color and background color.

Constructors

Style |

Fields

- tokenStyles :: !(Map TokenType TokenStyle)
- defaultColor :: !(Maybe Color)
- backgroundColor :: !(Maybe Color)
- lineNumberColor :: !(Maybe Color)
- lineNumberBackgroundColor :: !(Maybe Color)

#### Instances

Instances details

FromJSON Style # | The FromJSON instance for `Style` is designed so that a KDE syntax theme (JSON) can be decoded directly as a `Style`.
Instance details Defined in Skylighting.Types Methods parseJSON :: Value -> Parser Style # parseJSONList :: Value -> Parser [Style] # omittedField :: Maybe Style #
ToJSON Style # |
Instance details Defined in Skylighting.Types Methods toJSON :: Style -> Value # toEncoding :: Style -> Encoding # toJSONList :: [Style] -> Value # toEncodingList :: [Style] -> Encoding # omitField :: Style -> Bool #
Data Style # |

Instance details

Defined in Skylighting.Types

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Style -> c Style

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Style

toConstr :: Style -> Constr

dataTypeOf :: Style -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Style)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Style)

gmapT :: (forall b. Data b => b -> b) -> Style -> Style

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Style -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Style -> r

gmapQ :: (forall d. Data d => d -> u) -> Style -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Style -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Style -> m Style

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Style -> m Style

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Style -> m Style

Generic Style # |
Instance details Defined in Skylighting.Types Associated Types type Rep Style :: Type -> Type Methods from :: Style -> Rep Style x to :: Rep Style x -> Style
Read Style # |
Instance details Defined in Skylighting.Types Methods readsPrec :: Int -> ReadS Style readList :: ReadS [Style] readPrec :: ReadPrec Style readListPrec :: ReadPrec [Style]
Show Style # |
Instance details Defined in Skylighting.Types Methods showsPrec :: Int -> Style -> ShowS show :: Style -> String showList :: [Style] -> ShowS
Binary Style # |
Instance details Defined in Skylighting.Types Methods put :: Style -> Put get :: Get Style putList :: [Style] -> Put
Eq Style # |
Instance details Defined in Skylighting.Types Methods (==) :: Style -> Style -> Bool (/=) :: Style -> Style -> Bool
Ord Style # |
Instance details Defined in Skylighting.Types Methods compare :: Style -> Style -> Ordering (<) :: Style -> Style -> Bool (<=) :: Style -> Style -> Bool (>) :: Style -> Style -> Bool (>=) :: Style -> Style -> Bool max :: Style -> Style -> Style min :: Style -> Style -> Style
type Rep Style # |

Instance details

Defined in Skylighting.Types

type Rep Style = D1 ('MetaData "Style" "Skylighting.Types" "skylighting-core-0.14-2VFtdFvK2VbBi7Hr1W0TBh" 'False) (C1 ('MetaCons "Style" 'PrefixI 'True) ((S1 ('MetaSel ('Just "tokenStyles") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Map TokenType TokenStyle)) :*: S1 ('MetaSel ('Just "defaultColor") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Color))) :*: (S1 ('MetaSel ('Just "backgroundColor") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Color)) :*: (S1 ('MetaSel ('Just "lineNumberColor") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Color)) :*: S1 ('MetaSel ('Just "lineNumberBackgroundColor") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Color))))))

data ANSIColorLevel #

The available levels of color complexity in ANSI terminal output.

Constructors

ANSI16Color | 16-color mode
ANSI256Color | 256-color mode
ANSITrueColor | True-color mode

#### Instances

Instances details

Data ANSIColorLevel # |

Instance details

Defined in Skylighting.Types

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ANSIColorLevel -> c ANSIColorLevel

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ANSIColorLevel

toConstr :: ANSIColorLevel -> Constr

dataTypeOf :: ANSIColorLevel -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ANSIColorLevel)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ANSIColorLevel)

gmapT :: (forall b. Data b => b -> b) -> ANSIColorLevel -> ANSIColorLevel

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ANSIColorLevel -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ANSIColorLevel -> r

gmapQ :: (forall d. Data d => d -> u) -> ANSIColorLevel -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ANSIColorLevel -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ANSIColorLevel -> m ANSIColorLevel

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ANSIColorLevel -> m ANSIColorLevel

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ANSIColorLevel -> m ANSIColorLevel

Bounded ANSIColorLevel # |
Instance details Defined in Skylighting.Types Methods minBound :: ANSIColorLevel maxBound :: ANSIColorLevel
Enum ANSIColorLevel # |

Instance details

Defined in Skylighting.Types

Methods

succ :: ANSIColorLevel -> ANSIColorLevel

pred :: ANSIColorLevel -> ANSIColorLevel

toEnum :: Int -> ANSIColorLevel

fromEnum :: ANSIColorLevel -> Int

enumFrom :: ANSIColorLevel -> [ANSIColorLevel]

enumFromThen :: ANSIColorLevel -> ANSIColorLevel -> [ANSIColorLevel]

enumFromTo :: ANSIColorLevel -> ANSIColorLevel -> [ANSIColorLevel]

enumFromThenTo :: ANSIColorLevel -> ANSIColorLevel -> ANSIColorLevel -> [ANSIColorLevel]

Generic ANSIColorLevel # |
Instance details Defined in Skylighting.Types Associated Types type Rep ANSIColorLevel :: Type -> Type Methods from :: ANSIColorLevel -> Rep ANSIColorLevel x to :: Rep ANSIColorLevel x -> ANSIColorLevel
Read ANSIColorLevel # |
Instance details Defined in Skylighting.Types Methods readsPrec :: Int -> ReadS ANSIColorLevel readList :: ReadS [ANSIColorLevel] readPrec :: ReadPrec ANSIColorLevel readListPrec :: ReadPrec [ANSIColorLevel]
Show ANSIColorLevel # |
Instance details Defined in Skylighting.Types Methods showsPrec :: Int -> ANSIColorLevel -> ShowS show :: ANSIColorLevel -> String showList :: [ANSIColorLevel] -> ShowS
Binary ANSIColorLevel # |
Instance details Defined in Skylighting.Types Methods put :: ANSIColorLevel -> Put get :: Get ANSIColorLevel putList :: [ANSIColorLevel] -> Put
Eq ANSIColorLevel # |
Instance details Defined in Skylighting.Types Methods (==) :: ANSIColorLevel -> ANSIColorLevel -> Bool (/=) :: ANSIColorLevel -> ANSIColorLevel -> Bool
Ord ANSIColorLevel # |

Instance details

Defined in Skylighting.Types

Methods

compare :: ANSIColorLevel -> ANSIColorLevel -> Ordering

(<) :: ANSIColorLevel -> ANSIColorLevel -> Bool

(<=) :: ANSIColorLevel -> ANSIColorLevel -> Bool

(>) :: ANSIColorLevel -> ANSIColorLevel -> Bool

(>=) :: ANSIColorLevel -> ANSIColorLevel -> Bool

max :: ANSIColorLevel -> ANSIColorLevel -> ANSIColorLevel

min :: ANSIColorLevel -> ANSIColorLevel -> ANSIColorLevel

type Rep ANSIColorLevel # |
Instance details Defined in Skylighting.Types type Rep ANSIColorLevel = D1 ('MetaData "ANSIColorLevel" "Skylighting.Types" "skylighting-core-0.14-2VFtdFvK2VbBi7Hr1W0TBh" 'False) (C1 ('MetaCons "ANSI16Color" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "ANSI256Color" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ANSITrueColor" 'PrefixI 'False) (U1 :: Type -> Type)))

# Format options

data FormatOptions #

Options for formatting source code.

Constructors

FormatOptions |

Fields

- numberLines :: !Bool

  Number lines

- startNumber :: !Int

  Number of first line

- lineAnchors :: !Bool

  Anchors on each line number

- titleAttributes :: !Bool

  Html titles with token types

- codeClasses :: ![Text]

  Additional classes for Html code tag

- containerClasses :: ![Text]

  Additional classes for Html container tag

- lineIdPrefix :: !Text

  Prefix for id attributes on lines

- ansiColorLevel :: !ANSIColorLevel

  Level of ANSI color support to use

#### Instances

Instances details

Data FormatOptions # |

Instance details

Defined in Skylighting.Types

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> FormatOptions -> c FormatOptions

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c FormatOptions

toConstr :: FormatOptions -> Constr

dataTypeOf :: FormatOptions -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c FormatOptions)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c FormatOptions)

gmapT :: (forall b. Data b => b -> b) -> FormatOptions -> FormatOptions

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> FormatOptions -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> FormatOptions -> r

gmapQ :: (forall d. Data d => d -> u) -> FormatOptions -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> FormatOptions -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> FormatOptions -> m FormatOptions

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> FormatOptions -> m FormatOptions

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> FormatOptions -> m FormatOptions

Generic FormatOptions # |
Instance details Defined in Skylighting.Types Associated Types type Rep FormatOptions :: Type -> Type Methods from :: FormatOptions -> Rep FormatOptions x to :: Rep FormatOptions x -> FormatOptions
Read FormatOptions # |
Instance details Defined in Skylighting.Types Methods readsPrec :: Int -> ReadS FormatOptions readList :: ReadS [FormatOptions] readPrec :: ReadPrec FormatOptions readListPrec :: ReadPrec [FormatOptions]
Show FormatOptions # |
Instance details Defined in Skylighting.Types Methods showsPrec :: Int -> FormatOptions -> ShowS show :: FormatOptions -> String showList :: [FormatOptions] -> ShowS
Binary FormatOptions # |
Instance details Defined in Skylighting.Types Methods put :: FormatOptions -> Put get :: Get FormatOptions putList :: [FormatOptions] -> Put
Eq FormatOptions # |
Instance details Defined in Skylighting.Types Methods (==) :: FormatOptions -> FormatOptions -> Bool (/=) :: FormatOptions -> FormatOptions -> Bool
Ord FormatOptions # |

Instance details

Defined in Skylighting.Types

Methods

compare :: FormatOptions -> FormatOptions -> Ordering

(<) :: FormatOptions -> FormatOptions -> Bool

(<=) :: FormatOptions -> FormatOptions -> Bool

(>) :: FormatOptions -> FormatOptions -> Bool

(>=) :: FormatOptions -> FormatOptions -> Bool

max :: FormatOptions -> FormatOptions -> FormatOptions

min :: FormatOptions -> FormatOptions -> FormatOptions

type Rep FormatOptions # |

Instance details

Defined in Skylighting.Types

type Rep FormatOptions = D1 ('MetaData "FormatOptions" "Skylighting.Types" "skylighting-core-0.14-2VFtdFvK2VbBi7Hr1W0TBh" 'False) (C1 ('MetaCons "FormatOptions" 'PrefixI 'True) (((S1 ('MetaSel ('Just "numberLines") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "startNumber") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Int)) :*: (S1 ('MetaSel ('Just "lineAnchors") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "titleAttributes") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool))) :*: ((S1 ('MetaSel ('Just "codeClasses") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 [Text]) :*: S1 ('MetaSel ('Just "containerClasses") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 [Text])) :*: (S1 ('MetaSel ('Just "lineIdPrefix") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "ansiColorLevel") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ANSIColorLevel)))))

defaultFormatOpts :: FormatOptions #

Default formatting options.