Copyright	(C) 2011-2019 Edward Kmett
License	BSD-style (see the file LICENSE)
Maintainer	Edward Kmett <ekmett@gmail.com>
Stability	experimental
Portability	non-portable
Safe Haskell	Safe-Inferred
Language	Haskell2010

Text.Trifecta.Highlight

Description

Synopsis

data Highlight
data HighlightedRope = HighlightedRope !(IntervalMap Delta Highlight) !Rope
class HasHighlightedRope c where
- highlightedRope :: Lens' c HighlightedRope
- ropeContent :: Lens' c Rope
- ropeHighlights :: Lens' c (IntervalMap Delta Highlight)
withHighlight :: Highlight -> Doc AnsiStyle -> Doc AnsiStyle
data HighlightDoc = HighlightDoc String String HighlightedRope
class HasHighlightDoc c where
- highlightDoc :: Lens' c HighlightDoc
- docContent :: Lens' c HighlightedRope
- docCss :: Lens' c String
- docTitle :: Lens' c String
doc :: String -> HighlightedRope -> HighlightDoc

Documentation

data Highlight #

Tags used by the TokenParsing highlight combinator.

Instances

Instances details

Bounded Highlight
Instance details Defined in Text.Parser.Token.Highlight Methods minBound :: Highlight # maxBound :: Highlight #
Enum Highlight
Instance details Defined in Text.Parser.Token.Highlight Methods succ :: Highlight -> Highlight # pred :: Highlight -> Highlight # toEnum :: Int -> Highlight # fromEnum :: Highlight -> Int # enumFrom :: Highlight -> [Highlight] # enumFromThen :: Highlight -> Highlight -> [Highlight] # enumFromTo :: Highlight -> Highlight -> [Highlight] # enumFromThenTo :: Highlight -> Highlight -> Highlight -> [Highlight] #
Read Highlight
Instance details Defined in Text.Parser.Token.Highlight Methods readsPrec :: Int -> ReadS Highlight # readList :: ReadS [Highlight] # readPrec :: ReadPrec Highlight # readListPrec :: ReadPrec [Highlight] #
Show Highlight
Instance details Defined in Text.Parser.Token.Highlight Methods showsPrec :: Int -> Highlight -> ShowS # show :: Highlight -> String # showList :: [Highlight] -> ShowS #
Eq Highlight
Instance details Defined in Text.Parser.Token.Highlight Methods (==) :: Highlight -> Highlight -> Bool # (/=) :: Highlight -> Highlight -> Bool #
Ord Highlight
Instance details Defined in Text.Parser.Token.Highlight Methods compare :: Highlight -> Highlight -> Ordering # (<) :: Highlight -> Highlight -> Bool # (<=) :: Highlight -> Highlight -> Bool # (>) :: Highlight -> Highlight -> Bool # (>=) :: Highlight -> Highlight -> Bool # max :: Highlight -> Highlight -> Highlight # min :: Highlight -> Highlight -> Highlight #

data HighlightedRope Source #

A HighlightedRope is a Rope with an associated IntervalMap full of highlighted regions.

Constructors

HighlightedRope !(IntervalMap Delta Highlight) !Rope

Instances

Instances details

Monoid HighlightedRope Source #
Instance details Defined in Text.Trifecta.Highlight Methods mempty :: HighlightedRope # mappend :: HighlightedRope -> HighlightedRope -> HighlightedRope # mconcat :: [HighlightedRope] -> HighlightedRope #
Semigroup HighlightedRope Source #
Instance details Defined in Text.Trifecta.Highlight Methods (<>) :: HighlightedRope -> HighlightedRope -> HighlightedRope # sconcat :: NonEmpty HighlightedRope -> HighlightedRope # stimes :: Integral b => b -> HighlightedRope -> HighlightedRope #
ToMarkup HighlightedRope Source #
Instance details Defined in Text.Trifecta.Highlight Methods toMarkup :: HighlightedRope -> Markup # preEscapedToMarkup :: HighlightedRope -> Markup #
HasBytes HighlightedRope Source #
Instance details Defined in Text.Trifecta.Highlight Methods bytes :: HighlightedRope -> Int64 Source #
HasDelta HighlightedRope Source #
Instance details Defined in Text.Trifecta.Highlight Methods delta :: HighlightedRope -> Delta Source #
HasHighlightedRope HighlightedRope Source #
Instance details Defined in Text.Trifecta.Highlight Methods highlightedRope :: Lens' HighlightedRope HighlightedRope Source # ropeContent :: Lens' HighlightedRope Rope Source # ropeHighlights :: Lens' HighlightedRope (IntervalMap Delta Highlight) Source #

class HasHighlightedRope c where Source #

Minimal complete definition

highlightedRope

Methods

highlightedRope :: Lens' c HighlightedRope Source #

ropeContent :: Lens' c Rope Source #

ropeHighlights :: Lens' c (IntervalMap Delta Highlight) Source #

Instances

Instances details

HasHighlightedRope HighlightedRope Source #
Instance details Defined in Text.Trifecta.Highlight Methods highlightedRope :: Lens' HighlightedRope HighlightedRope Source # ropeContent :: Lens' HighlightedRope Rope Source # ropeHighlights :: Lens' HighlightedRope (IntervalMap Delta Highlight) Source #

withHighlight :: Highlight -> Doc AnsiStyle -> Doc AnsiStyle Source #

Convert a Highlight into a coloration on a Doc.

data HighlightDoc Source #

Represents a source file like an HsColour rendered document

Constructors

HighlightDoc String String HighlightedRope

Instances

Instances details

ToMarkup HighlightDoc Source #
Instance details Defined in Text.Trifecta.Highlight Methods toMarkup :: HighlightDoc -> Markup # preEscapedToMarkup :: HighlightDoc -> Markup #
HasHighlightDoc HighlightDoc Source #
Instance details Defined in Text.Trifecta.Highlight Methods highlightDoc :: Lens' HighlightDoc HighlightDoc Source # docContent :: Lens' HighlightDoc HighlightedRope Source # docCss :: Lens' HighlightDoc String Source # docTitle :: Lens' HighlightDoc String Source #

class HasHighlightDoc c where Source #

Minimal complete definition

highlightDoc

Methods

highlightDoc :: Lens' c HighlightDoc Source #

docContent :: Lens' c HighlightedRope Source #

docCss :: Lens' c String Source #

docTitle :: Lens' c String Source #

Instances

Instances details

HasHighlightDoc HighlightDoc Source #
Instance details Defined in Text.Trifecta.Highlight Methods highlightDoc :: Lens' HighlightDoc HighlightDoc Source # docContent :: Lens' HighlightDoc HighlightedRope Source # docCss :: Lens' HighlightDoc String Source # docTitle :: Lens' HighlightDoc String Source #

doc :: String -> HighlightedRope -> HighlightDoc Source #

Generate an HTML document from a title and a HighlightedRope.