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

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

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

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

Типы

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

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

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

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