WEditor.Base.Parser

Generic line-parsing functionality.

Documentation

class FixedFontParser a c | a -> c where

Line parser for fixed-width fonts.

Minimal complete definition

defaultBreak, setLineWidth, breakLines, renderLine

Associated Types

type BreakType a :: *

Type used to differentiate between line-break types.

Methods

defaultBreak :: a -> BreakType a

An acceptable fallback line-break type.

setLineWidth :: a -> Int -> a

Change the max line width used for parsing. A width of zero must result in breakLines skipping line breaks.

breakLines :: a -> [c] -> [VisibleLine c (BreakType a)]

Break the sequence into lines.

The following must hold for all possible inputs to a FixedFontParser p:

concat (map vlText (breakLines p line)) == line

Implement renderLine and tweakCursor to make visual adjustments (such as adding hyphens or indentation) if necessary.

renderLine :: a -> VisibleLine c (BreakType a) -> [c]

Render the line for viewing. Implement tweakCursor if renderLine changes the positions of any characters on the line.

tweakCursor :: a -> VisibleLine c (BreakType a) -> Int -> Int

Adjust the horizontal cursor position.

Instances

FixedFontParser (BreakWords c) c

Defined in WEditor.LineWrap

Associated Types

type BreakType (BreakWords c) :: Type

Methods

defaultBreak :: BreakWords c -> BreakType (BreakWords c)

setLineWidth :: BreakWords c -> Int -> BreakWords c

breakLines :: BreakWords c -> [c] -> [VisibleLine c (BreakType (BreakWords c))]

renderLine :: BreakWords c -> VisibleLine c (BreakType (BreakWords c)) -> [c]

tweakCursor :: BreakWords c -> VisibleLine c (BreakType (BreakWords c)) -> Int -> Int

emptyLine :: FixedFontParser a c => a -> VisibleLine c (BreakType a)

Create an empty line.