top(1): support multibyte characters in command names (ARGV array) depending on locale

[daichi]

Summary

top(1): support multibyte characters in command names (ARGV array) depending on locale.

• add setlocale()
• remove printable() function
• add VIS_OCTAL and VIS_SAFE to the flag of strvisx() to display non-printable characters that do not use C-style backslash sequences in three digit octal sequence, or remove it

This change allows multibyte characters to be displayed according to locale. If it is recognized as a non-display character according to the locale, it is displayed in three digit octal sequence.

submitted by: hrs

Reference:
https://www.mail-archive.com/[e-mail]/msg165751.html
https://www.mail-archive.com/[e-mail]/msg165766.html
https://www.mail-archive.com/[e-mail]/msg165833.html
https://www.mail-archive.com/[e-mail]/msg165846.html
https://www.mail-archive.com/[e-mail]/msg165891.html

Test Plan

You need a terminal that supports multibyte characters (for example, use Terminal of MacOS and login FreeBSD-head via ssh).

on terminal A:

% export LANG=ja_JP.UTF-8
% sh
% touch 日本語のファイル
% cat - 日本語のファイル

on terminal B:

% export LANG=ja_JP.UTF-8
% /usr/bin/top -a -d 1 1000 | grep cat

result:

original top:
% /usr/bin/top -a -d 1 | grep cat
 9688 daichi        1  20    0   12M    2M piperd   0   0:00   0.00% grep cat
 7925 daichi        1  20    0   11M    2M ttyin    1   0:00   0.00% cat - \M-f\M^W\M-%\M-f\M^\\M-,\M-h\M-*\M^^\M-c\M^A\M-.\M-c\M^C\M^U\M-c\M^B\M-!\M-c\M^B\M-$\M-c\M^C\M-+
%

patched top:
% top -a -d 1 1000 | grep cat
 9692 daichi        1  20    0   12M    2M piperd   1   0:00   0.00% grep cat
 7925 daichi        1  20    0   11M    2M ttyin    1   0:00   0.00% cat - 日本語のファイル
%

Or check with other locales.

[hrs]

IMHO strvisx(3) in machine.c should have a VIS_OCTAL flag as in my original submission because meta char encoding of strvisx(3), which uses iscntrl(3), does not make sense for most of multibyte encodings. Displaying characters not for the current locale in octal (or hexadecimal) number looks more intuitive to me.

[daichi]

Updated patches according to hrs' advice. Thank you.

[hrs]

This is my submission, so I will leave someone else to do further review of this change. Please do not count my "accept revision" as an immediate approval.

I think VIS_OCTAL should be documented at least in the commit log because it is a user-visible change, and multibyte character handling should be documented in the manual page, too.

[gnn]

LGTM

[daichi]

Update patch to HEAD-2019-09-20

[daichi]

Added explanation about locale display in manual according to hrs advice.

[daichi]

Update from arc

[daichi]

Add VIS_SAFE to strvisx(), adviced by hrs

[0mp]

There's a minor manpage style issue.

Please remember to bump Dd when committing!

usr.bin/top/top.1

196 ↗

(On Diff #62344)

New sentences should start on a new line.

[daichi]

Changed man page style and bumped Dd according to 0mp advice.