IO.ANSI

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

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

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

Типы

ansidata()

Функции

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()

Обратное изображение. Меняет местами цвет переднего и заднего плана

italic()

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

magenta()

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

magenta_background()

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

no_underline()

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

normal()

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

not_framed_encircled()

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

not_italic()

Не курсив

not_overlined()

Без подчеркивания сверху

overlined()

Подчеркнуто сверху

primary_font()

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

red()

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

red_background()

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

reset()

Сброс всех атрибутов

reverse()

Обратное изображение. Меняет местами цвет переднего и заднего плана

underline()

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

white()

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

white_background()

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

yellow()

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

yellow_background()

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

Типы

ansidata()

ansidata() :: ansilist | ansicode | binary

Функции

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.

В качестве дополнительного параметра можно передать булево значение, чтобы включить или отключить вывод фактических 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-коды.

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

В качестве дополнительного параметра можно передать булево значение, чтобы включить или отключить вывод фактических 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()

Инвертировать: поменять местами цвет переднего и заднего плана

italic()

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

magenta()

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

magenta_background()

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

no_underline()

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

normal()

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

not_framed_encircled()

Без рамки или окружности

not_italic()

Не курсив

not_overlined()

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

overlined()

Перечёркнутый

primary_font()

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

red()

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

red_background()

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

reset()

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

reverse()

Инвертировать: поменять местами цвет переднего и заднего плана

underline()

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

white()

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

white_background()

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

yellow()

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

yellow_background()

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