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(): Зачеркнутый. Символы читаемы, но помечены для удаления. Не поддерживается широко
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(): Устанавливает цвет переднего плана в светло-желтый
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()

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

cursor(line, column)

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

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

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

cursor_down(lines \\ 1)

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

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

cursor_left(columns \\ 1)

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

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

cursor_right(columns \\ 1)

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

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

cursor_up(lines \\ 1)

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

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

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.

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

Примеры

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

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