Получить ширину отображения строки символов

Что было бы наиболее близко к переносимому способу получения ширины дисплея (по крайней мере, на терминале (тот, который отображает символы в текущей локали с правильной шириной)) строки символов из сценария оболочки.

В первую очередь меня интересует ширина неконтролирующих символов, но приветствуются также решения, учитывающие управляющие символы, такие как возврат, возврат каретки, горизонтальная табуляция.

Другими словами, я ищу для оболочки API вокруг wcswidth()функции POSIX.

Эта команда должна вернуть:

$ that-command 'ｕｎｉｘ'   # 4 fullwidth characters
8
$ that-command 'Stéphane' # 9 characters, one of which zero-width
8
$ that-command 'もで 諤奯ゞ' # 5 double-width Japanese characters and a space
11

Можно использовать ksh93s, printf '%<n>Ls'который учитывает ширину символов для заполнения <n>столбцов, или colкоманду (например, с printf '++%s\b\b--\n' <character> | col -b), чтобы попытаться получить это, perlпо крайней мере, есть модуль Text :: CharWidth , но есть более прямые или переносимые подходы.

Это более или менее продолжение этого другого вопроса, касающегося отображения текста в правой части экрана, для которого вам потребуется эта информация перед отображением текста.

В эмуляторе терминала можно использовать отчет о положении курсора, чтобы получить позиции до / после, например, из

...record position
printf '%s' $string
...record position

и узнайте, насколько широко символы напечатаны на терминале. Поскольку это управляющая последовательность ECMA-48 (а также VT100), поддерживаемая практически любым терминалом, который вы, вероятно, будете использовать, она довольно переносима.

Для справки

• Управляющие последовательности XTerm

    CSI Ps n Отчет о состоянии устройства (DSR).
              ...
                Ps = 6 -> Положение курсора отчета (CPR) [строка; столбец].
              Результат - CSI r; с R

• console_codes (4)
• Стандарт ECMA-48: функции управления для наборов кодированных символов

В конечном счете, эмулятор терминала определяет ширину печати из-за следующих факторов:

• Настройки локали влияют на способ форматирования строки, но последовательность байтов, отправляемых на терминал, интерпретируется на основе конфигурации терминала (отмечая, что некоторые люди утверждают, что это должен быть UTF-8, в то время как с другой стороны мобильность была особенность, запрошенная в вопросе).
• wcswidthодин не говорит о том, как обрабатываются комбинированные символы; POSIX не упоминает этот аспект в описании этой функции.
• некоторые символы (например, рисование линий), которые можно считать само собой разумеющимися как одинарную ширину, являются (в Юникоде) «неоднозначной шириной», что подрывает мобильность приложения, использующего wcswidthодин (см., например, главу 2. Настройка Cygwin ). xtermнапример, есть положение для выбора символов двойной ширины для конфигураций, необходимых для этого.
• для обработки чего-либо, кроме печатаемых символов, вы должны полагаться на эмулятор терминала (если вы не хотите имитировать это).

Вызов API оболочки wcswidthподдерживается в различной степени:

• Text :: CharWidth - получает количество занятых столбцов строки на терминале.

  Этот модуль предоставляет функции, аналогичные wcwidth (3) и wcswidth (3) на языке Си.

• обсуждение для Ruby
• API для Python

Они более или менее прямые: симуляция wcswidthв случае Perl, вызов C времени выполнения из Ruby и Python. Вы даже можете использовать проклятия, например, из Python (которые будут обрабатывать комбинированные символы):

• инициализировать терминал с помощью setupterm (текст не выводится на экран)
• использовать filterфункцию (для отдельных строк)
• нарисуйте текст в начале строки addstr, проверяя на наличие ошибок (если она слишком длинная), а затем на конечную позицию
• если есть место, отрегулируйте исходное положение.
• вызов endwin(который не должен делать refresh)
• записать полученную информацию о начальной позиции в стандартный вывод

Использование проклятий для вывода (вместо подачи информации обратно в скрипт или прямого вызова tput) очистит всю строку ( filterограничивает ее строкой).

Для однострочных строк в реализации GNU wcесть опция -L(aka --max-line-length), которая делает именно то, что вы ищете (кроме символов управления).

По моему .profile, я вызываю скрипт для определения ширины строки в терминале. Я использую это при входе в систему на консоли компьютера, на котором я не доверяю системному набору LC_CTYPE, или когда я вхожу удаленно и не могу доверять, LC_CTYPEчтобы соответствовать удаленной стороне. Мой сценарий запрашивает терминал, а не вызывает какую-либо библиотеку, потому что в этом был смысл всего моего использования: определить кодировку терминала.

Это хрупко по нескольким причинам:

• он изменяет отображение, поэтому он не очень приятен для пользователя;
• есть состояние гонки, если другая программа отображает что-то не в то время;
• он блокируется, если терминал не отвечает. (Несколько лет назад я спросил , как улучшить это , но это не было большой проблемой , на практике , так что я не удосужился переключения к этому решению. Единственный случай возникновения терминала , который не был ответить Windows Emacs с помощью plinkметода получает доступ к удаленным файлам с компьютера Linux , и я решил эту проблему, используя plinkxметод .)

Это может или не может соответствовать вашему варианту использования.

#! /bin/sh

if [ z"$ZSH_VERSION" = z ]; then :; else
  emulate sh 2>/dev/null
fi
set -e

help_and_exit () {
  cat <<EOF
Usage: $0 {-NUMBER|TEXT}
Find out the width of TEXT on the terminal.

LIMITATION: this program has been designed to work in an xterm. Only
xterm and sufficiently compatible terminals will work. If you think
this program may be blocked waiting for input from the the terminal,
try entering the characters "0n0n" (digit 0, lowercase letter n,
repeat).

Display TEXT and erase it. Find out the position of the cursor before
and after displaying TEXT so as to compute the width of TEXT. The width
is returned as the exit code of the program. A value of 100 is returned if
the text is wider than 100 columns.

TEXT may contain backslash-escapes: \\0DDD represents the byte whose numeric
value is DDD in octal. Use '\\\\' to include a single backslash character.

You may use -NUMBER instead of TEXT (if TEXT begins with a dash, use
"-- TEXT"). This selects one of the built-in texts that are designed
to discriminate between common encodings. The following table lists
supported values of NUMBER (leftmost column) and the widths of the
sample text in several encodings.

  1  ASCII=0 UTF-8=2 latinN=3 8bits=4
EOF
  exit
}

builtin_text () {
  case $1 in
    -*[!0-9]*)
      echo 1>&2 "$0: bad number: $1"
      exit 119;;
    -1) # UTF8: {\'E\'e}; latin1: {\~A\~A\copyright}; ASCII: {}
      text='\0303\0211\0303\0251';;
    *)
      echo 1>&2 "$0: there is no text number $1. Stop."
      exit 118;;
  esac
}

text=
if [ $# -eq 0 ]; then
  help_and_exit 1>&2
fi
case "$1" in
  --) shift;;
  -h|--help) help_and_exit;;
  -[0-9]) builtin_text "$1";;
  -*)
    echo 1>&2 "$0: unknown option: $1"
    exit 119
esac
if [ z"$text" = z ]; then
  text="$1"
fi

printf "" # test that it is there (abort on very old systems)

csi='\033['
dsr_cpr="${csi}6n" # Device Status Report --- Report Cursor Position
dsr_ok="${csi}5n" # Device Status Report --- Status Report

stty_save=`stty -g`
if [ z"$stty_save" = z ]; then
  echo 1>&2 "$0: \`stty -g' failed ($?)."
  exit 3
fi
initial_x=
final_x=
delta_x=

cleanup () {
  set +e
  # Restore terminal settings
  stty "$stty_save"
  # Restore cursor position (unless something unexpected happened)
  if [ z"$2" = z ]; then
    if [ z"$initial_report" = z ]; then :; else
      x=`expr "${initial_report}" : "\\(.*\\)0"`
      printf "%b" "${csi}${x}H"
    fi
  fi
  if [ z"$1" = z ]; then
    # cleanup was called explicitly, so don't exit.
    # We use `trap : 0' rather than `trap - 0' because the latter doesn't
    # work in older Bourne shells.
    trap : 0
    return
  fi
  exit $1
}
trap 'cleanup 120 no' 0
trap 'cleanup 129' 1
trap 'cleanup 130' 2
trap 'cleanup 131' 3
trap 'cleanup 143' 15

stty eol 0 eof n -echo
printf "%b" "$dsr_cpr$dsr_ok"
initial_report=`tr -dc \;0123456789`
# Get the initial cursor position. Time out if the terminal does not reply
# within 1 second. The trick of calling tr and sleep in a pipeline to put
# them in a process group, and using "kill 0" to kill the whole process
# group, was suggested by Stephane Gimenez at
# /unix/10698/timing-out-in-a-shell-script
#trap : 14
#set +e
#initial_report=`sh -c 'ps -t $(tty) -o pid,ppid,pgid,command >/tmp/p;
#                       { tr -dc \;0123456789 >&3; kill -14 0; } |
#                       { sleep 1; kill -14 0; }' 3>&1`
#set -e
#initial_report=`{ sleep 1; kill 0; } |
#                { tr -dc \;0123456789 </dev/tty; kill 0; }`
if [ z"$initial_report" = z"" ]; then
  # We couldn't read the initial cursor position, so abort.
  cleanup 120
fi
# Write some text and get the final cursor position.
printf "%b%b" "$text" "$dsr_cpr$dsr_ok"
final_report=`tr -dc \;0123456789`

initial_x=`expr "$initial_report" : "[0-9][0-9]*;\\([0-9][0-9]*\\)0" || test $? -eq 1`
final_x=`expr "$final_report" : "[0-9][0-9]*;\\([0-9][0-9]*\\)0" || test $? -eq 1`
delta_x=`expr "$final_x" - "$initial_x" || test $? -eq 1`

cleanup
# Zsh has function-local EXIT traps, even in sh emulation mode. This
# is a long-standing bug.
trap : 0

if [ $delta_x -gt 100 ]; then
  delta_x=100
fi
exit $delta_x

Сценарий возвращает ширину в своем состоянии возврата, обрезанную до 100. Пример использования:

widthof -1
case $? in
  0) export LC_CTYPE=C;; # 7-bit charset
  2) locale_search .utf8 .UTF-8;; # utf8
  3) locale_search .iso88591 .ISO8859-1 .latin1 '';; # 8-bit with nonprintable 128-159, we assume latin1
  4) locale_search .iso88591 .ISO8859-1 .latin1 '';; # some full 8-bit charset, we assume latin1
  *) export LC_CTYPE=C;; # weird charset
esac

Эрик Пруитт написал впечатляющую реализацию wcwidth()и wcswidth()на Awk, доступную на wcwidth.awk . В основном это обеспечивает 4 функции

wcscolumns(), wcstruncate(), wcwidth(), wcswidth()

где wcscolumns()также допускает непечатные символы.

$ cat wcscolumns.awk 
{ printf "%d\n", wcscolumns($0) }
$ awk -f wcwidth.awk -f wcscolumns.awk <<< 'ｕｎｉｘ'
8
$ awk -f wcwidth.awk -f wcscolumns.awk <<< 'Stéphane'
8
$ awk -f wcwidth.awk -f wcscolumns.awk <<< 'もで 諤奯ゞ'
11
$ awk -f wcwidth.awk -f wcscolumns.awk <<< $'My sign is\t鼠鼠'
14

Я открыл вопрос об обработке TAB, поскольку их wcscolumns($'My sign is\t鼠鼠')должно быть больше 14. Обновление: Эрик добавил функцию wcsexpand()для расширения TAB до пробелов:

$ cat >wcsexpand.awk 
{ printf "%d\n", wcscolumns( wcsexpand($0, 8) ) }
$ awk -f wcwidth.awk -f wcsexpand.awk <<< $'My sign is\t鼠鼠'
20
$ echo $'鼠\tone\n鼠鼠\ttwo'
鼠      one
鼠鼠    two
$ awk -f wcwidth.awk -f wcsexpand.awk <<< $'鼠\tone\n鼠鼠\ttwo'
11
11

Чтобы расширить намеки на возможные решения, используя colи ksh93в моем вопросе:

Использование colfrom bsdmainutilsв Debian (может не работать с другими colреализациями), чтобы получить ширину одного неуправляемого символа:

charwidth() {
  set "$(printf '...%s\b\b...\n' "$1" | col -b)"
  echo "$((${#1} - 4))"
}

Пример:

$ charwidth x
1
$ charwidth $'\u301'
0
$ charwidth $'\u94f6'
2

Расширен для строки:

stringwidth() {
   awk '
     BEGIN{
       s = ARGV[1]
       l = length(s)
       for (i=0; i<l; i++) {
         s1 = s1 ".."
         s2 = s2 "\b\b"
       }
       print s1 s s2 s1
       exit
     }' "$1" | col -b | awk '
        {print length - 2 * length(ARGV[2]); exit}' - "$1"
}

Используя ksh93's printf '%Ls':

charwidth() {
  set "$(printf '.%2Ls.' "$1")"
  echo "$((5 - ${#1}))"
}

stringwidth() {
  set "$(printf '.%*Ls.' "$((2*${#1}))" "$1")" "$1"
  echo "$((2 + 3 * ${#2} - ${#1}))"
}

Используя perl's Text::CharWidth:

stringwidth() {
  perl -MText::CharWidth=mbswidth -le 'print mbswidth shift' "$@"
}