vis(3)

vis − キャラクタを視覚的にコード化

標準 C ライブラリ (libc, −lc)

#include <vis.h>

char *

vis(char *dst, int c, int flag, int nextc);

int

strvis(char *dst, const char *src, int flag);

int

strvisx(char *dst, const char *src, size_t len, int flag);

解説

vis() 関数は、キャラクタ c を表す文字列を dst にコピーします。 c がコード 化を必要としない場合は、何も変更せずにコピーします。文字列は null で終端 され、文字列の最後へのポインタが返されます。コード化の長さの最大値は 4 キャラクタです (最後の NUL は含まない)。従って、キャラクタのセットをバッ ファにコード化するときは、バッファのサイズはコード化されるキャラクタ数の 4 倍と、最後に付ける NUL の分の 1 が必要です。コード化するキャラクタのデ フォルト範囲を変更するため、また視覚的な表現を変更するためにはフラグパラ メータを使います。追加のキャラクタ、 nextc は、コード化形式 VIS_CSTYLE を 選択したときにのみ使います (以下に説明します)。

strvis() および strvisx() 関数は、文字列 src の視覚的表現を dst にコピー します。 strvis() 関数は、 src から最初の NUL までのキャラクタをコード化 します。 strvisx() 関数は、 src から正確に len 個のキャラクタをコード化し ます (これは、複数の NUL を含む可能性のあるデータのブロックをコード化する 場合に役に立ちます)。どちらの形式でも dst を NUL で終端します。 dst のサ イズは、 src からコード化されるキャラクタ数の 4 倍でなければなりません ( プラス NUL のための 1)。どちらの形式でも、キャラクタ数を dst に返します ( 最後の NUL は含まずに)。

コード化は、すべてグラフィックキャラクタで構成されたユニークで逆変換可能 な表現です。すなわち、 unvis(3) または strunvis(3) 関数を使えば元の形に戻 すことができます。

制御できるパラメータは 2 つあります:コード化するキャラクタの範囲、および 使用する表現のタイプです。デフォルトでは、スペース、タブ、改行を除くすべ ての非グラフィックキャラクタがコード化されます。( isgraph(3) 参照) これ は、以下のフラグによって変更されます:

スペースもコード化します。

VIS_TAB
タブもコード化します。

VIS_NL
改行もコード化します。

VIS_WHITE
VIS_SP | VIS_TAB | VIS_NL と同義。

VIS_SAFE
"unsafe" キャラクタのみをコード化します。"unsafe"キャラクタと は、普通の端末に予期しない機能を引き起こすような制御キャラク タのことです。現在のところ、この形式ではすべてのグラフィック キャラクタに加えて、スペース、タブ、改行、バックスペース、ベ ル、リターンをコード化しないでおきます。

コード化には 4 つの形式があります。すべての形式は、バックスラッシュキャラ クタ ‘\’ を使って特殊シーケンスを導入します。本当のバックスラッシュを表す には、 2 つのバックスラッシュを使います。次のような視覚的形式があります:

(default)
‘M’ を使ってメタキャラクタ (8 番目のビットがセットされた キャラクタ) を表し、カラット ‘^’ を使って制御キャラクタを 表します ( iscntrl(3) 参照)。次のような形式を使います：

\^C
制御キャラクタ ‘C’ を表します。 ‘\000’ から ‘\037’ まで、および ‘\177’ のキャラクタを含みます ( のよう に)。

\M-C
8 番目のビットがセットされたキャラクタ ‘C’ を表しま す。 ‘\241’ から ‘\377’ までのキャラクタを含みま す。

\M^C
8 番目のビットがセットされた制御キャラクタ ‘C’ を表 します。 ‘\200’ から ‘\237’ まで、およびのキャラク タを含みます ( ‘\M^?’ のように)。

\040
ASCII のスペースを表します。

\240
メタスペースを表します。

VIS_CSTYLE
C スタイルのバックスラッシュシーケンスを使って、標準非印刷 キャラクタを表します。次に示すシーケンスを使って、指定され ているキャラクタを表します：

\a - BEL (007)
\b - BS (010)
\f - NP (014)
\n - NL (012)
\r - CR (015)
\t - HT (011)
\v - VT (013)
\0 - NUL (000)

この形式を使う場合は、nextc パラメータを見て NUL キャラク タを ‘\000’ ではなく ‘\0’ とコード化するかどうかを判断しま す。 nextc が 8 進数字である場合は、あいまいさを避けるため に ‘\000’ の表現を使います。

RFC 1808 に記述された URI エンコードを使用します。形式は ‘%dd’ であり、 d は、16 進数の桁を表現します。

VIS_OCTAL
3 桁の 8 進法シーケンスを使います。 d が 8 進数字を表す場 合は、形式は ‘\ddd’ となります。

もう一つのフラグ、 VIS_NOSLASH は、バックスラッシュの重複およびデフォルト 形式 (すなわち、制御キャラクタを ‘^C’ で、メタキャラクタを ‘M-C’ で表す形 式) の前のバックスラッシュを抑制します。このフラグがセットしてあると、 コード化はあいまいとなり逆変換不能となります。

関連項目

unvis(1), unvis(3)

これらの関数は 4.4BSD ではじめて登場しました。

FreeBSD 10.0 July 25, 1996 FreeBSD 10.0