Support POSIX.1-2024 read built-in behavior (except byte-wise field splitting) (#123)

Author: magicant

NEWS

@@ -3,6 +3,10 @@
 ## Yash 2.59 (Unreleased)
 
   - Improved POSIX.1-2024 support:
+    - The `read` built-in now returns a more specific exit status
+      depending on the cause of the error.
+    - The `read` built-in now supports the `-d` option, which can be
+      used to specify a delimiter character.
     - The `trap` built-in now supports the `-p` option in the POSIXly-
       correct mode. When the `-p` option is used, the built-in prints
       all traps without filtering out traps that are not set.

NEWS.ja

@@ -3,6 +3,9 @@
 ## Yash 2.59 (未リリース)
 
   - POSIX.1-2024 のサポートを強化:
+    - `read` 組込みは結果に応じてより細分化された終了ステータスを返す
+      ようになった
+    - `read` 組込みに行区切り文字を指定する `-d` オプションを追加
     - POSIX 準拠モードで `trap` 組込みに `-p` オプションを使えるように
       なった。 `-p` オプションを使用する場合、設定が変更されていないもの
       も含めて全てのトラップを表示する。

doc/_read.txt

@@ -8,7 +8,7 @@ The dfn:[read built-in] reads a line from the standard input.
 [[syntax]]
 == Syntax
 
-- +read [-Aer] [-P|-p] {{variable}}...+
+- +read [-Aer] [-d {{delimiter}}] [-P|-p {{prompt}}] {{variable}}...+
 
 [[description]]
 == Description
@@ -27,6 +27,11 @@ When the built-in reads the next line, the link:params.html#sv-ps2[+PS2+
 variable] is used as a prompt if the shell is link:interact.html[interactive]
 and the standard input is a terminal.
 
+By default, the input line is read up to a newline character.
+If the +-d+ (+--delimiter+) option is specified, the input line is read up to
+the specified {{delimiter}} character instead.
+The {{delimiter}} character must be a single character.
+
 The input line is subject to link:expand.html#split[field splitting].
 The resulting words are assigned to {{variable}}s in order.
 If there are more words than {{variable}}s, the last variable is assigned all
@@ -43,6 +48,10 @@ Make the last {{variable}} an link:params.html#arrays[array].
 Instead of assigning a concatenation of the remaining words to a normal
 variable, the words are assigned to an array.
 
++-d {{delimiter}}+::
++--delimiter={{delimiter}}+::
+Read up to the specified {{delimiter}} character instead of a newline.
+
 +-e+::
 +--line-editing+::
 Use link:lineedit.html[line-editing] to read the line.
@@ -53,6 +62,7 @@ To use line-editing, all of the following conditions must also be met:
 - The link:_set.html#so-vi[vi] or link:_set.html#so-emacs[emacs] option is
   enabled.
 - The standard input and standard error are connected to a terminal.
+- The {{delimiter}} is a newline.
 
 +-P+::
 +--ps1+::
@@ -78,18 +88,22 @@ Names of variables to which input words are assigned.
 [[exitstatus]]
 == Exit status
 
-The exit status of the read built-in is zero unless there is any error.
-
-Note that the exit status is non-zero if an end of input is encountered before
-reading the entire line.
+The exit status is 0 if the read built-in successfully reads a line.
+If the end of the input is reached, the exit status is 1.
+The variables are assigned the words read so far.
+If a variable is read-only, the exit status is 2.
+If the standard input is unreadable, the exit status is 3.
+In case of a syntax error in the command line arguments, the exit status is 4.
 
 [[notes]]
 == Notes
 
 The read built-in is a link:builtin.html#types[mandatory built-in].
 
-The POSIX standard defines the +-r+  option only:
-other options cannot be used in the link:posix.html[POSIXly-correct mode].
+The POSIX standard defines the +-d+ and +-r+ options only.
+Other options cannot be used in the link:posix.html[POSIXly-correct mode].
+Only the exit status 0 and 1 are portable; for other error conditions, the
+exit status may be different in other shells.
 
 The link:params.html#sv-ps1r[+PS1R+] and link:params.html#sv-ps1s[+PS1S+]
 variables affect the behavior of line-editing if the +PS1+ prompt is used. The

doc/ja/_read.txt

@@ -8,7 +8,7 @@ dfn:[Read 組込みコマンド]は標準入力から行を読み込み変数に
 [[syntax]]
 == 構文
 
-- +read [-Aer] [-P|-p] {{変数名}}...+
+- +read [-Aer] [-d {{行区切り}}] [-P|-p {{プロンプト}}] {{変数名}}...+
 
 [[description]]
 == 説明
@@ -19,6 +19,8 @@ Read コマンドは標準入力から一行の文字列を読み込み、それ
 
 +-r+ (+--raw-mode+) オプションを付けない場合、読み込んだ文字列の中のバックスラッシュ (+\+) は{zwsp}link:syntax.html#quotes[引用符]として働きます。バックスラッシュが行末にあるときは行の連結を行います。{zwsp}link:interact.html[対話モード]のシェルが 2 行目以降を読み込むとき、標準入力が端末ならば link:params.html#sv-ps2[+PS2+ 変数]の値がプロンプトとして出力されます。
 
+通常、入力行は改行文字まで読み込まれます。+-d+ (+--delimiter+) オプションを指定すると、改行文字の代わりに指定された{{行区切り}}文字まで読み込みます。{{行区切り}}文字は 1 文字である必要があります。
+
 読み込んだ文字列は、{zwsp}link:expand.html#split[単語分割]によって分割します。分割後の各文字列が、それぞれオペランドで指定された変数の値に順に設定されます。指定された変数の数より分割結果のほうが多い場合は、最後の変数に残りの分割結果の全てが入ります。分割結果の数より指定された変数のほうが多い場合は、余った変数には空文字列が入ります。
 
 [[options]]
@@ -28,6 +30,10 @@ Read コマンドは標準入力から一行の文字列を読み込み、それ
 +--array+::
 最後に指定した変数を{zwsp}link:params.html#arrays[配列]にします。分割後の各文字列が配列の要素として設定されます。
 
++-d {{行区切り}}+::
++--delimiter={{行区切り}}+::
+改行文字の代わりに指定された{{行区切り}}文字まで読み込みます。
+
 +-e+::
 +--line-editing+::
 読み込みに{zwsp}link:lineedit.html[行編集]を使用します。
@@ -37,6 +43,7 @@ Read コマンドは標準入力から一行の文字列を読み込み、それ
 - シェルが{zwsp}link:interact.html[対話モード]である。
 - link:_set.html#so-vi[vi] または link:_set.html#so-emacs[emacs] オプションが有効になっている。
 - 標準入力と標準エラーが端末である。
+- {{行区切り}}が改行文字である。
 
 +-P+::
 +--ps1+::
@@ -59,16 +66,19 @@ Read コマンドは標準入力から一行の文字列を読み込み、それ
 [[exitstatus]]
 == 終了ステータス
 
-エラーがない限り read コマンドの終了ステータスは 0 です。
-
-なお、行を完全に読み込む前に入力が終端に達した時は終了ステータスは非 0 になります。
+行を正常に読み込んだ場合は終了ステータスは 0 です。
+入力の終わりに達した場合は 1 です。この場合はそれまでに読み込んだ文字列が変数に代入されます。
+変数が読み取り専用の場合は 2 です。
+標準入力が読み込めない場合は 3 です。
+コマンドライン引数に構文エラーがある場合は 4 です。
 
 [[notes]]
 == 補足
 
 Read コマンドは{zwsp}link:builtin.html#types[必須組込みコマンド]です。
 
-POSIX では +-r+ オプションのみが規定されています。他のオプションは link:posix.html[POSIX 準拠モード]では使えません。
+POSIX では +-d+ と +-r+ オプションのみが規定されています。他のオプションは link:posix.html[POSIX 準拠モード]では使えません。
+終了ステータスは 0 と 1 だけが POSIX で固定されています。他のエラーの場合はシェルによって終了ステータスが異なります。
 
 +PS1+ 変数をプロンプトとして表示する際、{zwsp}link:params.html#sv-ps1r[+PS1R+] および link:params.html#sv-ps1s[+PS1S+] 変数も使用されます。 +PS2+ についても同様です。
 

input.c

@@ -1,6 +1,6 @@
 /* Yash: yet another shell */
 /* input.c: functions for input of command line */
-/* (C) 2007-2024 magicant */
+/* (C) 2007-2025 magicant */
 
 /* This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -54,7 +54,8 @@
 
 static bool is_seekable_file(int fd);
 static inputresult_T optimized_read_input(
-        struct xwcsbuf_T *buf, struct input_file_info_T *info, _Bool trap)
+        struct xwcsbuf_T *buf, struct input_file_info_T *info, bool trap,
+        wchar_t delimiter)
     __attribute__((nonnull));
 static wchar_t *expand_prompt_variable(wchar_t num, wchar_t suffix)
     __attribute__((malloc,warn_unused_result));
@@ -110,9 +111,17 @@ inputresult_T input_file(struct xwcsbuf_T *buf, void *inputinfo)
  *   INPUT_ERROR if an error occurred before reading any characters */
 inputresult_T read_input(
         xwcsbuf_T *buf, struct input_file_info_T *info, bool trap)
+{
+    return read_input_delimited(buf, info, trap, L'\n');
+}
+
+/* Like `read_input', but reads input until a delimiter character is found. */
+inputresult_T read_input_delimited(
+        xwcsbuf_T *buf, struct input_file_info_T *info, bool trap,
+        wchar_t delimiter)
 {
     if (info->bufsize == 1 && is_seekable_file(info->fd))
-        return optimized_read_input(buf, info, trap);
+        return optimized_read_input(buf, info, trap, delimiter);
 
     size_t initlen = buf->length;
     inputresult_T status = INPUT_EOF;
@@ -170,7 +179,7 @@ inputresult_T read_input(
             default:
                 info->bufpos += convcount;
                 buf->contents[++buf->length] = L'\0';
-                if (buf->contents[buf->length - 1] == L'\n')
+                if (buf->contents[buf->length - 1] == delimiter)
                     goto end;
                 break;
         }
@@ -200,7 +209,8 @@ bool is_seekable_file(int fd)
  * once even if `info->bufsize' is 1. The input file descriptor must be
  * seekable. */
 inputresult_T optimized_read_input(
-        struct xwcsbuf_T *buf, struct input_file_info_T *info, _Bool trap)
+        struct xwcsbuf_T *buf, struct input_file_info_T *info, bool trap,
+        wchar_t delimiter)
 {
     struct input_file_info_T *tmpinfo =
         xmallocs(sizeof *tmpinfo, BUFSIZ, sizeof *tmpinfo->buf);
@@ -212,7 +222,7 @@ inputresult_T optimized_read_input(
     while (info->bufpos < info->bufmax)
         tmpinfo->buf[tmpinfo->bufmax++] = info->buf[info->bufpos++];
 
-    inputresult_T result = read_input(buf, tmpinfo, trap);
+    inputresult_T result = read_input_delimited(buf, tmpinfo, trap, delimiter);
 
     if (tmpinfo->bufpos < tmpinfo->bufmax) {
         /* rewind the FD to pretend we're not buffering */

input.h

@@ -1,6 +1,6 @@
 /* Yash: yet another shell */
 /* input.h: functions for input of command line */
-/* (C) 2007-2018 magicant */
+/* (C) 2007-2025 magicant */
 
 /* This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -59,6 +59,10 @@ struct input_file_info_T;
 extern inputresult_T read_input(
         struct xwcsbuf_T *buf, struct input_file_info_T *info, _Bool trap)
     __attribute__((nonnull));
+extern inputresult_T read_input_delimited(
+        struct xwcsbuf_T *buf, struct input_file_info_T *info, _Bool trap,
+        wchar_t delimiter)
+    __attribute__((nonnull));
 
 /* The type of input functions.
  * An input function reads input and appends it to buffer `buf'.