IO.ANSI

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

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

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

Типы

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(): Зачеркнуто. Символы читаемы, но помечены для удаления. Не широко поддерживается.
cursor(line, column): Перемещает курсор в абсолютную позицию, заданную line и column.
cursor_down(lines \\ 1): Перемещает курсор lines вниз.
cursor_left(columns \\ 1): Перемещает курсор columns влево.
cursor_right(columns \\ 1): Перемещает курсор columns вправо.
cursor_up(lines \\ 1): Перемещает курсор lines вверх.
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(): Устанавливает цвет переднего плана на светло-жёлтый.

END_OF_DOCUMENT_MARKER

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)

Specs

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

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

color(r, g, b)

Specs

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

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

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

color_background(code)

Specs

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

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

color_background(r, g, b)

Specs

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

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

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

conceal()

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

crossed_out()

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

cursor(line, column)

Specs

cursor(non_neg_integer(), non_neg_integer()) :: String.t()

Перемещает курсор в абсолютную позицию, заданную значениями line и column.

Строка 0 и столбец 0 означают верхний левый угол.

cursor_down(lines \\ 1)

Specs

cursor_down(pos_integer()) :: String.t()

Перемещает курсор lines вниз.

cursor_left(columns \\ 1)

Specs

cursor_left(pos_integer()) :: String.t()

Перемещает курсор columns влево.

cursor_right(columns \\ 1)

Specs

cursor_right(pos_integer()) :: String.t()

Перемещает курсор columns вправо.

cursor_up(lines \\ 1)

Specs

cursor_up(pos_integer()) :: String.t()

Перемещает курсор lines вверх.

cyan()

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

cyan_background()

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

default_background()

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

default_color()

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

enabled?()

Specs

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-коды.

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

Примеры

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

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

END_OF_DOCUMENT_MARKER

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

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