IO.ANSI

Функциональность для рендеринга ANSI управляющих последовательностей.

ANSI управляющие последовательности — это символы, встроенные в текст, используемые для управления форматированием, цветом и другими параметрами вывода на видеотерминалах.

Краткое описание

Типы

ansicode()

ansidata()

ansilist()

Функции

black()

Устанавливает цвет переднего плана на чёрный

black_background()

Устанавливает цвет фона на чёрный

blink_off()

Мерцание: выкл

blink_rapid()

Мерцание: быстро. MS-DOS ANSI.SYS; 150 или более вспышек в минуту; не широко поддерживается

blink_slow()

Мерцание: медленно. Меньше 150 вспышек в минуту

blue()

Устанавливает цвет переднего плана на синий

blue_background()

Устанавливает цвет фона на синий

bright()

Ярко (увеличенная интенсивность) или полужирным шрифтом

clear()

Очищает экран

clear_line()

Очищает строку

color(code)

Устанавливает цвет переднего плана

color(r, g, b)

Устанавливает цвет переднего плана по значениям RGB

color_background(code)

Устанавливает цвет фона

color_background(r, g, b)

Устанавливает цвет фона по значениям RGB

conceal()

Скрывать. Не широко поддерживается

crossed_out()

Перечеркнутый. Символы читаемы, но помечены для удаления. Не широко поддерживается

cyan()

Устанавливает цвет переднего плана на циан

cyan_background()

Устанавливает цвет фона на циан

default_background()

Цвет фона по умолчанию

default_color()

Цвет текста по умолчанию

enabled?()

Проверяет, поддерживается ли и включено ли ANSI-окрашивание на этом компьютере

encircled()

Обведённый

faint()

Блеклый (уменьшенная интенсивность). Не широко поддерживается

font_1()

Устанавливает альтернативный шрифт 1

font_2()

Устанавливает альтернативный шрифт 2

font_3()

Устанавливает альтернативный шрифт 3

font_4()

Устанавливает альтернативный шрифт 4

font_5()

Устанавливает альтернативный шрифт 5

font_6()

Устанавливает альтернативный шрифт 6

font_7()

Устанавливает альтернативный шрифт 7

font_8()

Устанавливает альтернативный шрифт 8

font_9()

Устанавливает альтернативный шрифт 9

format(chardata, emit? \\ enabled?())

Форматирует аргумент chardata, преобразуя именованные ANSI-последовательности в фактические ANSI-коды

format_fragment(chardata, emit? \\ enabled?())

Форматирует аргумент chardata, преобразуя именованные ANSI-последовательности в фактические ANSI-коды

framed()

В рамке

green()

Устанавливает цвет переднего плана на зелёный

green_background()

Устанавливает цвет фона на зелёный

home()

Перемещает курсор в начало

inverse()

Изображение: негатив. Меняет местами передний и задний планы

inverse_off()

Изображение: позитив. Нормальные передний и задний планы

italic()

Курсив: включено. Не широко поддерживается. Иногда обрабатывается как инверсия

light_black()

Устанавливает цвет переднего плана на светло-чёрный

light_black_background()

Устанавливает цвет фона на светло-чёрный

light_blue()

Устанавливает цвет переднего плана на светло-синий

light_blue_background()

Устанавливает цвет фона на светло-синий

light_cyan()

Устанавливает цвет переднего плана на светло-циан

light_cyan_background()

Устанавливает цвет фона на светло-циан

light_green()

Устанавливает цвет переднего плана на светло-зелёный

light_green_background()

Устанавливает цвет фона на светло-зелёный

light_magenta()

Устанавливает цвет переднего плана на светло-пурпурный

light_magenta_background()

Устанавливает цвет фона на светло-пурпурный

light_red()

Устанавливает цвет переднего плана на светло-красный

light_red_background()

Устанавливает цвет фона на светло-красный

light_white()

Устанавливает цвет переднего плана на светло-белый

light_white_background()

Устанавливает цвет фона на светло-белый

light_yellow()

Устанавливает цвет переднего плана на светло-жёлтый

light_yellow_background()

Устанавливает цвет фона на светло-жёлтый

magenta()

Устанавливает цвет переднего плана на пурпурный

magenta_background()

Устанавливает цвет фона на пурпурный

no_underline()

Подчёркивание: нет

normal()

Нормальный цвет или интенсивность

not_framed_encircled()

Без рамки и обводки

not_italic()

Не курсив

not_overlined()

Не перечёркнуто

overlined()

Перечёркнуто

primary_font()

Устанавливает основной (по умолчанию) шрифт

red()

Устанавливает цвет переднего плана на красный

red_background()

Устанавливает цвет фона на красный

reset()

Сбрасывает все атрибуты

reverse()

Изображение: негатив. Меняет местами передний и задний планы

reverse_off()

Изображение: позитив. Нормальные передний и задний планы

underline()

Подчёркивание: одиночное

white()

Устанавливает цвет переднего плана на белый

white_background()

Устанавливает цвет фона на белый

yellow()

Устанавливает цвет переднего плана на жёлтый

yellow_background()

Устанавливает цвет фона на жёлтый

Типы

ansicode()

ansicode() :: atom()

ansidata()

ansidata() :: ansilist() | ansicode() | binary()

ansilist()

ansilist() :: maybe_improper_list(char() | ansicode() | binary() | ansilist(), binary() | ansicode() | [])

Функции

black()

Устанавливает цвет фона в черный.

black_background()

Устанавливает цвет фона в черный.

blink_off()

Мигание: выключено.

blink_rapid()

Мигание: быстро. MS-DOS ANSI.SYS; 150 или более вспышек в минуту; не широко поддерживается.

blink_slow()

Мигание: медленно. Менее 150 вспышек в минуту.

blue()

Устанавливает цвет текста в синий.

blue_background()

Устанавливает цвет фона в синий.

bright()

Яркий (увеличенная интенсивность) или жирный.

clear()

Очищает экран.

clear_line()

Очищает строку.

color(code)

color(0..255) :: String.t()

Устанавливает цвет текста.

color(r, g, b)

color(0..5, 0..5, 0..5) :: String.t()

Устанавливает цвет текста из отдельных значений RGB.

Допустимые значения для каждого цвета находятся в диапазоне от 0 до 5.

color_background(code)

color_background(0..255) :: String.t()

Устанавливает цвет фона.

color_background(r, g, b)

color_background(0..5, 0..5, 0..5) :: String.t()

Устанавливает цвет фона из отдельных значений RGB.

Допустимые значения для каждого цвета находятся в диапазоне от 0 до 5.

conceal()

Скрыть. Не широко поддерживается.

crossed_out()

Зачеркнуто. Символы читаемы, но помечены для удаления. Не широко поддерживается.

cyan()

Устанавливает цвет текста в циан.

cyan_background()

Устанавливает цвет фона в циан.

default_background()

Цвет фона по умолчанию.

default_color()

Цвет текста по умолчанию.

enabled?()

enabled?() :: boolean()

Проверяет, поддерживается ли и включена ли ANSI-окраска на этом компьютере.

Эта функция просто считывает значение конфигурации для :ansi_enabled в приложении :elixir. Значение по умолчанию false, если Elixir не может определить во время запуска, что и stdout, и stderr являются терминалами.

encircled()

Окружено.

faint()

Блеклый (уменьшенная интенсивность). Не широко поддерживается.

font_1()

Устанавливает альтернативный шрифт 1.

font_2()

Устанавливает альтернативный шрифт 2.

font_3()

Устанавливает альтернативный шрифт 3.

font_4()

Устанавливает альтернативный шрифт 4.

font_5()

Устанавливает альтернативный шрифт 5.

font_6()

Устанавливает альтернативный шрифт 6.

font_7()

Устанавливает альтернативный шрифт 7.

font_8()

Устанавливает альтернативный шрифт 8.

font_9()

Устанавливает альтернативный шрифт 9.

format(chardata, emit? \\ enabled?())

Форматирует аргумент типа chardata, преобразуя именованные ANSI-последовательности в фактические ANSI-коды.

Именованные последовательности представлены атомами.

Также добавит IO.ANSI.reset/0 к chardata при выполнении преобразования. Если вы не хотите этого поведения, используйте format_fragment/2.

Можно передать необязательный boolean-параметр для включения или выключения вывода фактических ANSI-кодов. Когда false, ANSI-коды не будут выводиться. По умолчанию проверяет, включена ли ANSI-окраска, используя функцию enabled?/0.

Примеры

iex> IO.ANSI.format(["Hello, ", :red, :bright, "world!"], true)
[[[[[[], "Hello, "] | "\e[31m"] | "\e[1m"], "world!"] | "\e[0m"]

format_fragment(chardata, emit? \\ enabled?())

Форматирует аргумент типа chardata, преобразуя именованные ANSI-последовательности в фактические ANSI-коды.

Именованные последовательности представлены атомами.

Можно передать необязательный boolean-параметр для включения или выключения вывода фактических ANSI-кодов. Когда false, ANSI-коды не будут выводиться. По умолчанию проверяет, включена ли ANSI-окраска, используя функцию enabled?/0.

Примеры

iex> IO.ANSI.format_fragment([:bright, 'Word'], true)
[[[[[[] | "\e[1m"], 87], 111], 114], 100]

framed()

Оформлено рамкой.

green()

Устанавливает цвет текста в зелёный.

green_background()

Устанавливает цвет фона в зелёный.

home()

Перемещает курсор в начало строки.

inverse()

Инверсия изображения. Поменяйте местами цвет текста и фона.

inverse_off()

Нормальное отображение изображения. Нормальный цвет текста и фона.

italic()

Курсив: включено. Не широко поддерживается. Иногда обрабатывается как инверсия.

light_black()

Устанавливает цвет текста в светло-чёрный.

light_black_background()

Устанавливает цвет фона в светло-чёрный.

light_blue()

Устанавливает цвет текста в светло-синий.

light_blue_background()

Устанавливает цвет фона в светло-синий.

light_cyan()

Устанавливает цвет текста в светло-циановый.

light_cyan_background()

Устанавливает цвет фона в светло-циановый.

light_green()

Устанавливает цвет текста в светло-зелёный.

light_green_background()

Устанавливает цвет фона в светло-зелёный.

light_magenta()

Устанавливает цвет текста в светло-пурпурный.

light_magenta_background()

Устанавливает цвет фона в светло-пурпурный.

light_red()

Устанавливает цвет текста в светло-красный.

light_red_background()

Устанавливает цвет фона в светло-красный.

light_white()

Устанавливает цвет текста в светло-белый.

light_white_background()

Устанавливает цвет фона в светло-белый.

light_yellow()

Устанавливает цвет текста в светло-жёлтый.

light_yellow_background()

Устанавливает цвет фона в светло-жёлтый.

magenta()

Устанавливает цвет текста в пурпурный.

magenta_background()

Устанавливает цвет фона в пурпурный.

no_underline()

Подчёркивание: выключено.

normal()

Нормальный цвет или интенсивность.

not_framed_encircled()

Без рамки и окружения.

not_italic()

Не курсив.

not_overlined()

Без перечеркивания.

overlined()

Перечеркнуто.

primary_font()

Устанавливает основной (по умолчанию) шрифт.

red()

Устанавливает цвет текста в красный.

red_background()

Устанавливает цвет фона в красный.

reset()

Сбрасывает все атрибуты.

reverse()

Изображение: отрицательное. Меняет местами передний и задний планы.

reverse_off()

Изображение: положительное. Обычный передний и задний планы.

underline()

Подчеркивание: одиночное.

white()

Устанавливает цвет переднего плана на белый.

white_background()

Устанавливает цвет фона на белый.

yellow()

Устанавливает цвет переднего плана на желтый.

yellow_background()

Устанавливает цвет фона на желтый.