core-text-0.2.0.0: A text type based on a finger tree over UTF-8 fragments

Core.Text.Utilities

Contents

Description

Useful tools for working with Ropes. Support for pretty printing, multi-line strings, and...

Synopsis

# Pretty printing

class Render α where Source #

Types which can be rendered "prettily", that is, formatted by a pretty printer and embossed with beautiful ANSI colours when printed to the terminal.

Use render to build text object for later use or Core.Program.Execute's writeR if you're writing directly to console now.

Associated Types

type Token α :: * Source #

Which type are the annotations of your Doc going to be expressed in?

Methods

Convert semantic tokens to specific ANSI escape tokens

intoDocA :: α -> Doc (Token α) Source #

Arrange your type as a Doc ann, annotated with your semantic tokens.

Instances
 Source # Instance detailsDefined in Core.Text.Utilities Associated Typestype Token Char :: Type Source # Methods Source # Instance detailsDefined in Core.Text.Utilities Associated Typestype Token Text :: Type Source # Methods Source # Instance detailsDefined in Core.Text.Utilities Associated Typestype Token Bytes :: Type Source # Methods Source # Instance detailsDefined in Core.Text.Utilities Associated Typestype Token Rope :: Type Source # Methods Render a => Render [a] Source # Instance detailsDefined in Core.Text.Utilities Associated Typestype Token [a] :: Type Source # Methodscolourize :: Token [a] -> AnsiStyle Source #intoDocA :: [a] -> Doc (Token [a]) Source #

render :: Render α => Int -> α -> Rope Source #

Given an object of a type with a Render instance, transform it into a Rope saturated with ANSI escape codes representing syntax highlighting or similar colouring, wrapping at the specified width.

The obvious expectation is that the next thing you're going to do is send the Rope to console with:

    write (render 80 thing)


However, the better thing to do is to instead use:

    writeR thing


which is able to pretty print the document text respecting the available width of the terminal.

# Helpers

Render "a" or "an" in front of a word depending on English's idea of whether it's a vowel or not.

breakWords :: Rope -> [Rope] Source #

Split a passage of text into a list of words. A line is broken wherever there is one or more whitespace characters, as defined by Data.Char's isSpace.

Examples:

λ> breakWords "This is a test"
["This","is","a","test"]
λ> breakWords ("St" <> "op and " <> "go left")
["Stop","and","go","left"]
λ> breakWords emptyRope
[]


breakLines :: Rope -> [Rope] Source #

Split a paragraph of text into a list of its individual lines. The paragraph will be broken wherever there is a '\n' character.

Blank lines will be preserved. Note that as a special case you do not get a blank entry at the end of the a list of newline terminated strings.

λ> breakLines "Hello\n\nWorld\n"
["Hello","","World"]


breakPieces :: (Char -> Bool) -> Rope -> [Rope] Source #

Break a Rope into pieces whereever the given predicate function returns True. If found, that character will not be included on either side. Empty runs, however, *will* be preserved.

wrap :: Int -> Rope -> Rope Source #

Often the input text represents a paragraph, but does not have any internal newlines (representing word wrapping). This function takes a line of text and inserts newlines to simulate such folding, keeping the line under the supplied maximum width.

A single word that is excessively long will be included as-is on its own line (that line will exceed the desired maxium width).

Any trailing newlines will be removed.

Pad a pieve of text on the left with a specified character to the desired width. This function is named in homage to the famous result from Computer Science known as leftPad which has a glorious place in the history of the world-wide web.

Right pad a text with the specified character.

# Multi-line strings

Multi-line string literals.

To use these you need to enable the QuasiQuotes language extension in your source file:

{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE QuasiQuotes #-}


you are then able to easily write a string stretching over several lines.

How best to formatting multi-line string literal within your source code is an aesthetic judgement. Sometimes you don't care about the whitespace leading a passage (8 spaces in this example):

    let message = [quote|
This is a test of the Emergency Broadcast System. Do not be
alarmed. If this were a real emergency, someone would have tweeted
|]


because you are feeding it into a Doc for pretty printing and know the renderer will convert the whole text into a single line and then re-flow it. Other times you will want to have the string as is, literally:

    let poem = [quote|
If the sun
rises
in the
west
you     drank
too much
last week.
|]


Leading whitespace from the first line and trailing whitespace from the last line will be trimmed, so this:

    let value = [quote|
Hello
|]


is translated to:

    let value = fromString "Hello\n"


without the leading newline or trailing four spaces. Note that as string literals they are presented to your code with fromString :: String -> α so any type with an IsString instance (as Rope has) can be constructed from a multi-line [quote| ... |] literal.