Text.PrettyPrint.HughesPJ

Тип документа

data Doc Исходный код

Абстрактный тип документов. Doc представляет *множество* макетов. Doc без вхождений Union или NoDoc представляет только один макет.

data Детали текста Исходный код

Тип данных TextDetails

TextDetails представляет фрагмент текста, который будет выведен в какой-то момент.

Создание документов

Преобразование значений в документы

char :: Char -> Doc Source

Документ высоты и ширины 1, содержащий литерный символ.

text :: String -> Doc Source

Документ высоты 1, содержащий литерную строку. text удовлетворяет следующим законам:

• text s <> text t = text (s++t)

• text "" <> x = x, если x не пустая

Побочное условие последнего закона необходимо, потому что text "" имеет высоту 1, а empty не имеет высоты.

ptext :: String -> Doc Source

То же, что и text. Раньше использовался для байтовых строк.

sizedText :: Int -> String -> Doc Source

Некоторая строка с любой шириной. (text s = sizedText (length s) s)

zeroWidthText :: String -> Doc Source

Некоторая строка, но без ширины. Используется для непечатаемого текста, такого как теги HTML или LaTeX.

int Source

int n = text (show n)

integer Source

integer n = text (show n)

float Source

float n = text (show n)

double Source

double n = text (show n)

rational Source

rational n = text (show n)

Простые производные документы

semi Source

comma Source

colon Source

space Source

equals Source

lparen Source

rparen Source

lbrack Source

rbrack Source

lbrace Source

rbrace Source

Оборачивание документов в разделители

parens Source

brackets Source

braces Source

quotes Source

doubleQuotes Source

maybeParens :: Bool -> Doc -> Doc Source

Применяет parens к Doc, если булево значение истинно.

maybeBrackets :: Bool -> Doc -> Doc Source

Применяет brackets к Doc, если булево значение истинно.

maybeBraces :: Bool -> Doc -> Doc Source

Применяет braces к Doc, если булево значение истинно.

maybeQuotes :: Bool -> Doc -> Doc Source

Применяет quotes к Doc, если булево значение истинно.

maybeDoubleQuotes :: Bool -> Doc -> Doc Source

Применяет doubleQuotes к Doc, если булево значение истинно.

Комбинирование документов

empty :: Doc Source

Пустой документ, без высоты и ширины. empty является тождественным элементом для <>, <+>, $$ и $+$, и где угодно в списке аргументов для sep, hcat, hsep, vcat, fcat и т.д.

(<>) :: Doc -> Doc -> Doc infixl 6 Source

Рядом. <> является ассоциативным, с тождественным элементом empty

(<+>) :: Doc -> Doc -> Doc infixl 6 Source

Рядом, разделенные пробелом, если один из аргументов не empty. <+> является ассоциативным, с тождественным элементом empty

hcat :: [Doc] -> Doc Source

Список версия <>

hsep :: [Doc] -> Doc Source

Список версия <+>.

($$) :: Doc -> Doc -> Doc infixl 5 Source

Вышесказанное, за исключением того, что если последняя строка первого аргумента заканчивается хотя бы на одну позицию раньше, чем начинается первая строка второго, эти две строки перекрываются. Например:

   text "hi" $$ nest 5 (text "there")

выводится как

   hi   there

а не как

   hi
        there

$$ ассоциативна, с тождественным элементом empty, и также удовлетворяет

• (x $$ y) <> z = x $$ (y <> z), если y не пусто.

($+$) :: Doc -> Doc -> Doc infixl 5 Source

Вышесказанное, без перекрытия. $+$ ассоциативна, с тождественным элементом empty.

vcat :: [Doc] -> Doc Source

Список версия $$.

sep :: [Doc] -> Doc Source

Либо hsep либо vcat.

cat :: [Doc] -> Doc Source

Либо hcat либо vcat.

fsep :: [Doc] -> Doc Source

"Абзац заполнения" версия sep.

fcat :: [Doc] -> Doc Source

"Абзац заполнения" версия cat.

nest :: Int -> Doc -> Doc Source

Вложить (или отступать) документ на заданное количество позиций (которые также могут быть отрицательными). nest удовлетворяет законам:

• nest 0 x = x

• nest k (nest k' x) = nest (k+k') x

• nest k (x <> y) = nest k z <> nest k y

• nest k (x $$ y) = nest k x $$ nest k y

• nest k empty = empty

• x <> nest k y = x <> y, если x не пусто

Дополнительное условие для последнего закона необходимо, потому что empty является левым тождественным элементом для <>.

hang :: Doc -> Int -> Doc -> Doc Source

hang d1 n d2 = sep [d1, nest n d2]

punctuate :: Doc -> [Doc] -> [Doc] Source

punctuate p [d1, ... dn] = [d1 <> p, d2 <> p, ... dn-1 <> p, dn]

Предикаты для документов

isEmpty :: Doc -> Bool Source

Возвращает True, если документ пуст

Функции для работы с документами

first :: Doc -> Doc -> Doc Источник

first возвращает свой первый аргумент, если он не пуст, в противном случае — второй.

reduceDoc :: Doc -> RDoc Источник

Выполняет некоторое упрощение созданного GDoc.

Вывод документов

Вывод по умолчанию

render :: Doc -> String Источник

Выводит Doc в строку, используя параметры по умолчанию Style.

Вывод с определенным стилем

data Style Источник

Стиль вывода.

style :: Style Источник

Стиль по умолчанию (mode=PageMode, lineLength=100, ribbonsPerLine=1.5).

renderStyle :: Style -> Doc -> String Источник

Выводит Doc в строку, используя заданный Style.

data Mode Источник

Режим вывода.

Общие параметры рендеринга

fullRender Исходный код

Интерфейс общего рендеринга.