tests: test.sh: utilize $BIN

CONTRIBUTING

@@ -97,9 +97,10 @@ their editor or terminal.
 
 For usage text and help messages, do not implement a -h option. Instead, print
 usage information when any erroneous option is specified. Follow the NetBSD
-style guide for the usage text’s output format [1].
+style guide for the usage text’s output format [0].
 
-[1] <http://cvsweb.netbsd.org/bsdweb.cgi/~checkout~/src/share/misc/style>
+If committing a new utility, please include tests and documentation (see
+tests/ and docs/) for the new tool.
 
 If committing a new source file, format the commit message following these
 guidelines:
@@ -128,6 +129,7 @@ $ git commit -m 'tool(1): fix #42 & add feature x'
 
 Commit messages should be written in the present tense.
 
+[0] <http://cvsweb.netbsd.org/bsdweb.cgi/~checkout~/src/share/misc/style>
 --
 This work © 2023–2024 by Emma Tebibyte is licensed under CC BY-SA 4.0. To view a
 copy of this license, visit <http://creativecommons.org/licenses/by-sa/4.0/>

Makefile

@@ -14,10 +14,11 @@
 PREFIX=/usr/local
 
 CC=cc
+MAKE=make
 RUSTC=rustc
 
 .PHONY: all
-all: dj false fop hru intcmp mm rpn scrut str strcmp swab true
+all: dj false fop hru intcmp rpn scrut str strcmp true
 
 build:
 	# keep build/include until bindgen(1) has stdin support
@@ -39,8 +40,8 @@ install: dist
 	cp -r dist/* $(PREFIX)/
 
 .PHONY: test
-test: build
-	tests/posix-compat.sh
+test: all
+	tests/test.sh
 	$(RUSTC) --test src/getopt-rs/lib.rs -o build/test/getopt
 
 build/o/libsysexits.rlib: build
@@ -86,11 +87,6 @@ intcmp: build/bin/intcmp
 build/bin/intcmp: src/intcmp.c build
 	$(CC) $(CFLAGS) -o $@ src/intcmp.c
 
-.PHONY: mm
-mm: build/bin/mm
-build/bin/mm: src/mm.c build
-	$(CC) $(CFLAGS) -o $@ src/mm.c
-
 .PHONY: rpn
 rpn: build/bin/rpn
 build/bin/rpn: src/rpn.rs build build/o/libsysexits.rlib
@@ -113,13 +109,6 @@ strcmp: build/bin/strcmp
 build/bin/strcmp: src/strcmp.c build
 	$(CC) $(CFLAGS) -o $@ src/strcmp.c
 
-.PHONY: swab
-swab: build/bin/swab
-build/bin/swab: src/swab.rs build build/o/libsysexits.rlib
-	$(RUSTC) $(RUSTFLAGS) --extern getopt=build/o/libgetopt.rlib \
-		--extern sysexits=build/o/libsysexits.rlib \
-		-o $@ src/swab.rs
-
 .PHONY: true
 true: build/bin/true
 build/bin/true: src/true.c build

docs/dj.1

@@ -1,5 +1,4 @@
 .\" Copyright (c) 2024 DTB <trinity@trinity.moe>
-.\" Copyright (c) 2024 Emma Tebibyte <emma@tebibyte.media>
 .\"
 .\" This work is licensed under CC BY-SA 4.0. To see a copy of this license,
 .\" visit <http://creativecommons.org/licenses/by-sa/4.0/>.
@@ -45,139 +44,87 @@ dj
 .B output offset
 .R ])
 
-.SH OPTIONS
+.SH USAGE
 
+The
 .B -i
-.RS
-Takes a file path as an argument to open and use as an input.
-.RE
-
-.B -b
-.RS
-Takes a numeric argument as the size in bytes of the input buffer, with the
-default being 1024 bytes or one kibibyte (KiB).
-.RE
-
-.B -s
-.RS
-Takes a numeric argument as the number of bytes to skip into the input
-before starting to read. If the standard input is used, bytes read to this point
-are discarded.
-.RE
-
+option takes a path as an argument to open and use in place of standard input.
+The
 .B -o
-.RS
-Takes a file path as an argument to open and use as an output.
-.RE
-
-.B -B
-.RS
-Does the same as
+option does the same in place of standard output. Dj does not truncate output
+files and instead writes over the bytes in the existing file.
+.PP
+The
 .B -b
-but for the output buffer.
-.RE
-
+option takes a numeric argument as the size in bytes of the input buffer and
+the
+.B -B
+option does the same for the output buffer, the default for both being 1024
+bytes, or one kibibyte (KiB).
+.PP
+The
+.B -s
+option takes a numeric argument as the number of bytes to skip into the input
+before starting to read, and the
 .B -S
-.RS
-Skips a number of bytes through the output before starting to write from
-the input. If the output is a stream, null characters are printed.
-.RE
-
+option skips a number of bytes through the output before starting to write from
+the input. If the input is a stream the bytes are read and discarded. If the
+output is a stream, nul characters are printed.
+.PP
+The
 .B -a
-.RS
-Accepts a single literal byte with which input buffer is padded in the event
-of an incomplete read from the input file.
-.RE
-
-.B -c
-.RS
-Specifies a number of reads to make. If set to zero (the default), reading will
-continue until a partial or empty read is encountered.
-.RE
-
+option takes one argument of one byte in length and pads the input buffer with
+that byte in the event that a read doesn't fill the input buffer, and the
 .B -A
-.RS
-If the output is a stream, null bytes are printed. This option is equivalent to
-specifying
-.B -a
-with a null byte instead of a character.
-.RE
-
-.B -d
-.RS
-Prints invocation information before program execution as described in the
-DIAGNOSTICS section below. Each invocation increments the debug level of the
-program.
-.RE
-
-.B -H
-.RS
-Prints diagnostics messages in a human-readable manner as described in the
-DIAGNOSTICS section below.
-.RE
-
-.B -n
-.RS
-Retries failed reads once more before exiting.
-.RE
-
+option takes no arguments and pads with nuls.
+The
+.B -c
+option specifies an amount of reads to make, and if 0 (the default) dj will
+continue reading until a partial or empty read.
+.PP
+On a partial or empty read, dj prints a diagnostic message (unless the
 .B -q
-.RS
-Suppresses error messages which print when a read or write is partial or
-empty. Each invocation decrements the debug level of the program.
-.RE
-
-.SH STANDARD INPUT
-
-The standard input shall be used as an input if no inputs are specified one or
-more of the input files is “-”.
+option is specified) and exits (unless the
+.B -n
+option is specified, in which case only two consecutive empty reads will cause
+dj to exit).
+At exit, usage statistics are printed unless the option
+.B -q
+is specified a second time. The
+.B -H
+option will make these diagnostics human-readable.
 
 .SH DIAGNOSTICS
 
-On a partial or empty read, a diagnostic message is printed (unless the
-.B -q
-option is specified) and the program exits (unless the
-.B -n
-option is specified.
-
-By default statistics are printed for input and output to the standard error in
-the following format:
-
-.RS
+The
+.B -d
+option prints all information, user-specified or otherwise, before program
+execution.
+.PP
+When dj exits, by default statistics are printed for input and output to
+standard error in the following format:
+.PP
 .R {records read} {ASCII unit separator} {partial records read}
 .R {ASCII record separator} {records written} {ASCII unit separator}
 .R {partial records written} {ASCII group separator} {bytes read}
 .R {ASCII record separator} {bytes written} {ASCII file separator}
-.RE
-
-This format for diagnostic output is designed to be machine-parseable for
-convenience. For a more human-readable format, the
+.PP
+If the
 .B -H
-option may be specified. In this event, the following format is used instead:
-
-.RS
+option is specified dj instead uses this following format:
+.PP
 .R {records read} '+' {partial records read} '>' {records written}
 .R '+' {partial records written} ';' {bytes read} '>' {bytes written}
 .R {ASCII line feed}
-.RE
-
-If the
-.B -d
-option is specified, debug output will be printed at the beginning of execution.
-This debug information contains information regarding how the program was
-invoked. The following example is the result of running the program with
-.B -d
-as the only argument:
-
-.RS
-.R argv0=dj
-.R in=<stdin>      ibs=1024        skip=0  align=ff       count=0
-.R out=<stdout>    obs=1024        seek=0  debug= 3       noerror=0
-.RE
-
-In non-recoverable errors that don’t pertain to the read-write cycle, a
-diagnostic message is printed and the program exits with the appropriate
-sysexits.h(3) status.
+.PP
+The
+.B -q
+option suppresses error messages which print when a read or write is partial or
+empty and when used twice suppresses diagnostic output entirely.
+.PP
+In non-recoverable errors that don't pertain to dj's read-write cycle, a
+diagnostic message is printed and dj exits with the appropriate sysexits(3)
+status.
 
 .SH BUGS
 
@@ -189,29 +136,25 @@ expected (the product of the count multiplied by the input block size). If the
 or
 .B -A
 options are used this could make data written nonsensical.
-
+.PP
 Many lowercase options have capitalized variants and vice-versa which can be
 confusing. Capitalized options tend to affect output or are more intense
 versions of lowercase options.
 
-.SH CAVEATS
-
-Existing files are not truncated on ouput and are instead overwritten.
-
 .SH RATIONALE
 
-This program was based on the dd(1p) utility as specified in POSIX. While
-character conversion may have been the original intent of dd(1p), it is
-irrelevant to its modern use. Because of this, it eschews character conversion
-and adds typical option formatting, allowing seeks to be specified in bytes
+Dj was modeled after the dd utility specified in POSIX but adds additional
+features: typical option formatting, allowing seeks to be specified in bytes
 rather than in blocks, allowing arbitrary bytes as padding, and printing in a
-format that’s easy to parse for machines.
+format that's easy to parse for machines. It also neglects character
+conversion, which may be dd's original intent but is irrelevant to its modern
+use.
 
 .SH COPYRIGHT
 
-Copyright © 2023 DTB. License AGPLv3+: GNU AGPL version 3 or later
+Copyright (C) 2023 DTB. License AGPLv3+: GNU AGPL version 3 or later
 <https://gnu.org/licenses/agpl.html>.
 
 .SH SEE ALSO
 
-dd(1p)
+dd(1)

docs/false.1

@@ -1,5 +1,5 @@
 .\" Copyright (c) 2022, 2024 DTB <trinity@trinity.moe>
-.\" Copyright (c) 2023–2024 Emma Tebibyte <emma@tebibyte.media>
+.\" Copyright (c) 2023 Emma Tebibyte <emma@tebibyte.media>
 .\"
 .\" This work is licensed under CC BY-SA 4.0. To see a copy of this license,
 .\" visit <http://creativecommons.org/licenses/by-sa/4.0/>.
@@ -12,13 +12,14 @@ false \(en do nothing, unsuccessfully
 
 .SH DESCRIPTION
 
-Do nothing regardless of operands or standard input.
-An exit code of 1 will always be returned.
+False does nothing regardless of operands or standard input.
+False will always return an exit code of 1.
 
 .SH RATIONALE
 
-In POSIX.1-2017, false(1p) exists for the construction of control flow and loops
-based on a failure. This implementation functions as described in that standard.
+False exists for the construction of control flow and loops based on a failure.
+
+False functions as described in POSIX.1-2017.
 
 .SH AUTHOR
 

docs/fop.1

@@ -1,60 +0,0 @@
-.\" Copyright (c) 2024 DTB <trinity@trinity.moe>
-.\" Copyright (c) 2024 Emma Tebibyte <emma@tebibyte.media>
-.\"
-.\" This work is licensed under CC BY-SA 4.0. To see a copy of this license,
-.\" visit <http://creativecommons.org/licenses/by-sa/4.0/>.
-
-.TH fop 1
-
-.SH NAME
-
-fop \(en field operator
-
-.SH SYNOPSIS
-
-fop
-.RB ( -d )
-.RB [ delimiter ]
-.RB index 
-.RB program...
-
-.SH DESCRIPTION
-
-Performs operations on specified fields in input data.
-
-.SH OPTIONS
-
-.B -d
-.RS
-Sets a delimiter by which the input data will be split into fields. The default
-is an ASCII record separator (␞).
-.RE
-
-.SH STANDARD INPUT
-
-Data will be read from the standard input.
-
-.SH CAVEATS
-
-Field indices are zero-indexed, which may be unexpected behavior for some users.
-
-.SH RATIONALE
-
-With the assumption that tools will output data separated with ASCII field
-separators, there is 
-
-The idea for this utility originated in the fact that GNU ls(1) utility contains
-a
-.B -h
-option which enables human-readable units in file size outputs. This
-functionality was broken out into hru(1), but there was no easy way to modify
-the field in the ouput of ls(1p) without a new tool.
-
-.SH COPYRIGHT
-
-Copyright © 2024 Emma Tebibyte. License AGPLv3+: GNU AGPL version 3 or later
-<https://gnu.org/licenses/agpl.html>.
-
-.SH SEE ALSO
-
-sed(1p)

docs/hru.1

@@ -3,7 +3,7 @@
 .\" This work is licensed under CC BY-SA 4.0. To see a copy of this license,
 .\" visit <http://creativecommons.org/licenses/by-sa/4.0/>.
 
-.TH hru 1
+.TH rpn 1
 
 .SH NAME
 
@@ -15,20 +15,18 @@ hru
 
 .SH DESCRIPTION
 
-Convert counts to higher units.
-
-The program will read byte counts in the form of whole numbers from the standard
-input and write to the standard output the same number converted to a higher 
-unit of data as defined by the International System of Units.
+Hru reads byte counts in the form of whole numbers from the standard input and
+writes to the standard output the same number converted one of the units of data
+defined by the International System of Units.
 
 The program will convert the byte count to the highest unit possible where the
 value is greater than one.
 
 .SH DIAGNOSTICS
 
-If encountering non-integer characters in the standard input, the program will
-exit with the appropriate error code as defined by sysexits.h(3) and print an
-error message.
+If encountering non-integer characters in the standard input, hru will exit with
+the appropriate error code as defined by sysexits.h(3) and print an error
+message.
 
 .SH RATIONALE
 
@@ -41,9 +39,9 @@ program.
 
 .SH STANDARDS
 
-The standard unit prefixes as specified by the Bureau International des Poids
-et Mesures (BIPM) in the ninth edition of The International System of Units
-(SI) are utilized for the ouput of conversions.
+Hru follows the standard unit prefixes as specified by the Bureau International
+des Poids et Mesures (BIPM) in the ninth edition of The International System of
+Units (SI).
 
 .SH AUTHOR
 

docs/intcmp.1

@@ -1,5 +1,5 @@
 .\" Copyright (c) 2023–2024 DTB <trinity@trinity.moe>
-.\" Copyright (c) 2023–2024 Emma Tebibyte <emma@tebibyte.media>
+.\" Copyright (c) 2023 Emma Tebibyte <emma@tebibyte.media>
 .\"
 .\" This work is licensed under CC BY-SA 4.0. To see a copy of this license,
 .\" visit <http://creativecommons.org/licenses/by-sa/4.0/>.
@@ -13,59 +13,45 @@ intcmp \(en compare integers
 .SH SYNOPSIS
 
 intcmp
-.RB ( -egl )
+.RB ( -eghl )
 .RB [ integer ]
 .RB [ integer... ]
 
 .SH DESCRIPTION
 
-Compare integers to each other.
+Intcmp compares integers.
 
 .SH USAGE
 
-.B -e
-.RS
-Permits given integers to be equal to each other.
-.RE
-
-.B -g
-.RS
-Permits a given integer to be greater than the following integer.
-.RE
-
-.B -l
-.RS
-Permits a given integer to be less than the following integer.
-.RE
-
-.SH EXAMPLES
-
+The -e option permits given integers to be equal to each other. If combined
+with -g or -l, only adjacent integers in the argument sequence can be equal.
+.PP
+The -g option permits a given integer to be greater than the following integer.
+.PP
+The -l option permits a given integer to be less than the following integer.
+.PP
 It may help to think of the -e, -g, and -l options as equivalent to the
 infix algebraic “=”, “>”, and “<” operators respectively, with each option
-putting its symbol between every given integer. The following example is
-equivalent to evaluating “1 < 2 < 3”:
-
-.RS
+putting its symbol between every given integer. For example,
 .R intcmp -l 1 2 3
-.RE
+is equivalent to evaluating "1 < 2 < 3".
 
 .SH DIAGNOSTICS
 
-The program will exit with a status code of 0 for a valid expression and with a
-code of 1 for an invalid expression.
-
-In the event of an error, a debug message will be printed and the program will
-exit with the appropriate sysexits.h(3) error code.
+Intcmp exits 0 for a valid expression and 1 for an invalid expression.
+.PP
+Intcmp prints a debug message and exits with the appropriate sysexits(3) error
+code in the event of an error.
 
 .SH BUGS
 
 There are multiple ways to express compound comparisons; “less than or equal
 to” can be -le or -el, for example.
-
+.PP
 The inequality comparison is -gl or -lg for “less than or greater than”; this
 is elegant but unintuitive.
-
--egl, “equal to or less than or greater than”, exits 0 no matter what for valid
+.PP
+-egl, "equal to or less than or greater than", exits 0 no matter what for valid
 program usage and may be abused to function as an integer validator.
 Use str(1) instead.
 
@@ -75,7 +61,7 @@ The traditional tool for integer comparisons in POSIX and other Unix shells has
 been test(1). This tool also handles string comparisons and file scrutiny.
 These parts of its functionality have been broken out into multiple utilities.
 
-This program’s functionality may be performed on a POSIX-compliant system with
+Strcmp’s functionality may be performed on a POSIX-compliant system with
 test(1p).
 
 .SH AUTHOR

docs/mm.1

@@ -1,88 +0,0 @@
-.\" Copyright (c) 2024 DTB <trinity@trinity.moe>
-.\"
-.\" This work is licensed under CC BY-SA 4.0. To see a copy of this license,
-.\" visit <http://creativecommons.org/licenses/by-sa/4.0/>.
-
-.TH mm 1
-
-.SH NAME
-
-mm \(en middleman
-
-.SH SYNOPSIS
-
-mm
-.RB ( -aenu )
-.RB ( -i
-.RB [ input ])
-.RB ( -o
-.RB [ output ])
-
-.SH DESCRIPTION
-
-Catenate input files and write them to the start of each output file or stream.
-
-.SH OPTIONS
-
-.B -a
-.RS
-Opens subsequent outputs for appending rather than updating.
-.RE
-
-.B -e
-.RS
-Use the standard error as an output.
-.RE
-
-.B -i
-.RS
-Opens a path as an input. Without any inputs specified mm will use the
-standard input. The standard input shall be used as an input if one or more of
-the input files is “-”.
-.RE
-
-.B -o
-.RS
-Opens a path as an output. Without any outputs specified mm will use the
-standard output. The standard output shall be used as an output if one or more
-of the output files is “-”.
-
-.RE
-
-.B -u
-.RS
-Ensures neither input or output will be buffered.
-.RE
-
-.B -n
-.RS
-Causes SIGINT signals to be ignored.
-.RE
-
-.SH DIAGNOSTICS
-
-If an output can no longer be written mm prints a diagnostic message, ceases
-writing to that particular output, and if there are more outputs specified,
-continues, eventually exiting unsuccessfully.
-
-When an error is encountered, diagnostic message is printed and the program
-exits with the appropriate sysexits.h(3) status.
-
-.SH CAVEATS
-
-Existing files are not truncated on ouput and are instead overwritten.
-
-.SH RATIONALE
-
-The cat(1p) and tee(1p) programs specified in POSIX together provide similar
-functionality. The separation of the two sets of functionality into separate
-APIs seemed unncessary.
-
-.SH COPYRIGHT
-
-Copyright (c) 2024 DTB. License AGPLv3+: GNU AGPL version 3 or later
-<https://gnu.org/licenses/agpl.html>.
-
-.SH SEE ALSO
-
-cat(1p), dd(1), dj(1), tee(1p)

docs/npc.1

@@ -1,5 +1,5 @@
 .\" Copyright (c) 2023–2024 DTB <trinity@trinity.moe>
-.\" Copyright (c) 2023–2024 Emma Tebibyte <emma@tebibyte.media>
+.\" Copyright (c) 2023 Emma Tebibyte <emma@tebibyte.media>
 .\"
 .\" This work is licensed under CC BY-SA 4.0. To see a copy of this license,
 .\" visit <http://creativecommons.org/licenses/by-sa/4.0/>.
@@ -13,50 +13,43 @@ npc \(en show non-printing characters
 .SH SYNOPSIS
 
 npc
-.RB ( -et )
+.RB ( -eht )
 
 .SH DESCRIPTION
 
-Print normally non-printing characters.
-
-The program reads from standard input and writes to standard output, replacing
-non-printing characters with printable equivalents. Control characters print as
-a carat ('^') followed by the character '@' through '_' corresponding to the
-character replaced (e.g. control-X becomes '^X'). The delete character (0x7F)
-becomes '^?'. Characters with the high bit set (>127) are printed as 'M-'
+Npc reads from standard input and writes to standard output, replacing non-
+printing characters with printable equivalents. Control characters print as a
+carat ('^') followed by the character '@' through '_' corresponding to the
+character replaced (e.g. control-X becomes "^X"). The delete character (0x7F)
+becomes "^?". Characters with the high bit set (>127) are printed as "M-"
 followed by the graphical representation for the same character without the
 high bit set.
-
-.SH USAGE
-
+.PP
+The
 .B -e
-.RS
-Prints a currency sign ('$') before each line ending.
-.RE
-
+option prints a currency sign ('$') before each line ending.
+.PP
+The
 .B -t
-.RS
-Prints tab characters as '^I' rather than a literal horizontal tab.
-.RE
+option prints tab characters as "^I" rather than a literal horizontal tab.
 
 .SH DIAGNOSTICS
 
-In the event of an error, a debug message will be printed and the program will
-exit with the appropriate sysexits.h(3) error code.
+Npc prints a debug message and exits with the appropriate sysexits(3) error
+code in the event of an error, otherwise it exits successfully.
 
 .SH BUGS
 
-The program operates in single-byte chunks regardless of intended encoding.
+Npc operates in single-byte chunks regardless of intended encoding.
 
 .SH RATIONALE
 
 POSIX currently lacks a way to display non-printing characters in the terminal
-using a standard tool. A popular extension to cat(1p), the
-.B -v
-option, is the bandage solution GNU and other software suites use.
+using a standard tool. A popular extension to cat(1p), the -v option, is the
+bandage solution GNU and other software suites use.
 
-This functionality is a separate tool because its usefulness extends beyond that
-of cat(1p).
+This functionality should be a separate tool because its usefulness extends
+beyond that of cat(1p).
 
 .SH AUTHOR
 

docs/rpn.1

@@ -17,13 +17,10 @@ rpn
 
 .SH DESCRIPTION
 
-Evaluate reverse polish notation.
+Rpn evaluates reverse polish notation expressions either read from the standard
+input or parsed from provided arguments. See the STANDARD INPUT section.
 
-The program evaluates reverse polish notation expressions either read from the
-standard input or parsed from provided arguments. See the STANDARD INPUT
-section.
-
-Upon evaluation, the program will print the resulting number on the stack to the
+Upon evaluation, rpn will print the resulting number on the stack to the
 standard output. Any further specified numbers will be placed at the end of the
 stack.
 
@@ -31,16 +28,14 @@ For information on for reverse polish notation syntax, see rpn(7).
 
 .SH STANDARD INPUT
 
-If arguments are passed , they are interpreted as an expression to be evaluated.
-Otherwise, it reads whitespace-delimited numbers and operations from the
-standard input.
+If arguments are passed to rpn, it interprets them as an expression to be
+evaluated. Otherwise, it reads whitespace-delimited numbers and operations from
+the standard input.
 
 .SH DIAGNOSTICS
 
-In the event of a syntax error, the program will print an
-
-In the event of an error, a debug message will be printed and the program will
-exit with the appropriate sysexits.h(3) error code.
+If encountering a syntax error, rpn will exit with the appropriate error code
+as defined by sysexits.h(3) and print an error message.
 
 .SH CAVEATS
 
@@ -49,7 +44,7 @@ with the IEEE Standard for Floating Point Arithmetic (IEEE 754), floating-point
 arithmetic has rounding errors. This is somewhat curbed by using the
 machine epsilon as provided by the Rust standard library to which to round
 numbers. Because of this, variation is expected in the number of decimal places 
-the program can handle based on the platform and hardware of any given machine.
+rpn can handle based on the platform and hardware of any given machine.
 
 .SH RATIONALE
 

docs/scrut.1

@@ -1,5 +1,4 @@
 .\" Copyright (c) 2024 DTB <trinity@trinity.moe>
-.\" Copyright (c) 2024 Emma Tebibyte <emma@tebibyte.media>
 .\"
 .\" This work is licensed under CC BY-SA 4.0. To see a copy of this license,
 .\" visit <http://creativecommons.org/licenses/by-sa/4.0/>.
@@ -18,92 +17,62 @@ scrut
 
 .SH DESCRIPTION
 
-Determine if files comply with requirements.
+Scrut determines if given files comply with the opted requirements.
 
 .SH OPTIONS
 
-.B -L
-.RS
-Requires the given files to exist and be symbolic links.
-.RE
-
-.B -S
-.RS
-Requires the given files to exist and be sockets.
-.RE
-
 .B -b
-.RS
-Requires the given files to exist and be block special files.
-.RE
-
+requires the given files to exist and be block special files.
+.PP
 .B -c
-.RS
-Requires the given files to exist and be character special files.
-.RE
-
+requires the given files to exist and be character special files.
+.PP
 .B -d
-.RS
-Requires the given files to exist and be directories.
-.RE
-
+requires the given files to exist and be directories.
+.PP
 .B -e
-.RS
-Requires the given files to exist, and is redundant to any other option.
-.RE
-
+requires the given files to exist, and is redundant to any other option.
+.PP
 .B -e
-.RS
-Requires the given files to exist and be regular files.
-.RE
-
+requires the given files to exist and be regular files.
+.PP
 .B -g
-.RS
-Requires the given files to exist and have their set group ID flags set.
-.RE
-
+requires the given files to exist and have their set group ID flags set.
+.PP
 .B -k
-.RS
-Requires the given files to exist and have their sticky bit set.
-.RE
-
+requires the given files to exist and have their sticky bit set.
+.PP
 .B -p
-.RS
-Requires the given files to exist and be named pipes.
-.RE
-
+requires the given files to exist and be named pipes.
+.PP
 .B -r
-.RS
-Requires the given files to exist and be readable.
-.RE
-
+requires the given files to exist and be readable.
+.PP
 .B -u
-.RS
-Requires the given files to exist and have their set user ID flags set.
-.RE
-
+requires the given files to exist and have their set user ID flags set.
+.PP
 .B -w
-.RS
-Requires the given files to exist and be writable.
-.RE
-
+requires the given files to exist and be writable.
+.PP
 .B -x
-.RS
-Requires the given files to exist and be executable.
-.RE
+requires the given files to exist and be executable.
+.PP
+.B -L
+requires the given files to exist and be symbolic links.
+.PP
+.B -S
+requires the given files to exist and be sockets.
 
 .SH EXIT STATUS
 
-If the given files comply with the specified requirements, the program will exit
-successfully. If not, it exits unsuccessfully.
-
-When invoked incorrectly, a debug message will be printed and the program will
-exit with the appropriate sysexits.h(3) error code.
+Scrut prints a debug message and exits unsuccessfully with the appropriate
+sysexits.h(3) error code if invoked incorrectly. Scrut exits successfully if
+the given files comply with their requirements and unsuccessfully otherwise.
 
 .SH STANDARDS
 
-The test(1p) utility contains functionality that was broken out into separate
-programs. Thus, the scope of this program is narrower than it. Notably, the
+Scrut is nearly compatible with POSIX's test utility though it is narrower in
+scope. Notably, the
 .B -h
 option is now invalid and therefore shows usage information instead of being an
 alias to the modern

docs/str.1

@@ -1,5 +1,5 @@
 .\" Copyright (c) 2023–2024 DTB <trinity@trinity.moe>
-.\" Copyright (c) 2023–2024 Emma Tebibyte <emma@tebibyte.media>
+.\" Copyright (c) 2023 Emma Tebibyte <emma@tebibyte.media>
 .\"
 .\" This work is licensed under CC BY-SA 4.0. To see a copy of this license,
 .\" visit <http://creativecommons.org/licenses/by-sa/4.0/>.
@@ -18,27 +18,30 @@ str
 
 .SH DESCRIPTION
 
-Test string arguments.
-
-The tests in this program are equivalent to the functions with the same names in
-ctype.h(0p) and are the methods by which string arguments are tested.
+Str tests each character in an arbitrary quantity of string arguments against
+the function of the same name within ctype(3).
 
 .SH DIAGNOSTICS
 
-If all tests pass, the program will exit with an exit code of 0. If any of the
-tests fail, the program will exit unsuccessfully with an error code of 1.
+Str exits successfully if all tests pass and unsuccessfully if a test failed.
+.PP
+Str will exit unsuccessfully if a string is empty, as none of its contents
+passed the test.
+.PP
+Str will print a message to standard error and exit unsuccessfully if used
+improperly.
 
-An empty string will cause an unsuccessful exit as none of its contents pass any
-tests.
+.SH DEPRECATED FEATURES
 
-When invoked incorrectly, a debug message will be printed and the program will
-exit with the appropriate sysexits.h(3) error code.
+Str used to have an "isvalue" type as an extension to ctype(3). This was
+removed in favor of using strcmp(1) to compare strings against the empty string
+('').
 
 .SH BUGS
 
-There’s no way of knowing which argument failed the test without re-testing
+There's no way of knowing which argument failed the test without re-testing
 arguments individually.
-
+.PP
 If a character in a string isn't valid ASCII str will exit unsuccessfully.
 
 .SH AUTHOR

docs/strcmp.1

@@ -1,5 +1,5 @@
 .\" Copyright (c) 2023–2024 DTB <trinity@trinity.moe>
-.\" Copyright (c) 2023–2024 Emma Tebibyte <emma@tebibyte.media>
+.\" Copyright (c) 2023 Emma Tebibyte <emma@tebibyte.media>
 .\"
 .\" This work is licensed under CC BY-SA 4.0. To see a copy of this license,
 .\" visit <http://creativecommons.org/licenses/by-sa/4.0/>.
@@ -18,27 +18,26 @@ strcmp
 
 .SH DESCRIPTION
 
-Check whether string arguments are the same.
-
-.SH DIAGNOSTICS
-
-The program will exit successfully if the strings are identical. Otherwise, it
-exits with the value 1 if an earlier string has a greater byte value than a
-later string (e.g.
+Strcmp checks whether the given strings are the same.
+Strcmp exits successfully if the strings are identical. Otherwise, strcmp exits
+with the value 1 if an earlier string has a greater byte value than a later
+string (e.g.
 .R strcmp b a
 )
 and 255 if an earlier string has a lesser byte value (e.g.
 .R strcmp a b
 ).
 
-When invoked incorrectly, a debug message will be printed and the program will
-exit with the appropriate sysexits.h(3) error code.
+.SH DIAGNOSTICS
+
+Strcmp will print an error message and exit unsuccessfully with a status
+described in sysexits(3) if used incorrectly (given less than two operands).
 
 .SH UNICODE
 
-The program will exit unsuccessfully if the given strings are not identical;
-therefore, Unicode strings may need to be normalized if the intent is to check
-visual similarity and not byte similarity.
+Strcmp will exit unsuccessfully if the given strings are not identical;
+Unicode strings may need to be normalized if the intent is to check visual
+similarity and not byte similarity.
 
 .SH RATIONALE
 
@@ -46,7 +45,7 @@ The traditional tool for string comparisons in POSIX and other Unix shells has
 been test(1). This tool also handles integer comparisons and file scrutiny.
 These parts of its functionality have been broken out into multiple utilities.
 
-This program’s functionality may be performed on a POSIX-compliant system with
+Strcmp’s functionality may be performed on a POSIX-compliant system with
 test(1p).
 
 .SH AUTHOR

docs/swab.1

@@ -1,77 +0,0 @@
-.\" Copyright (c) 2024 DTB <trinity@trinity.moe>
-.\" Copyright (c) 2024 Emma Tebibyte <emma@tebibyte.media>
-.\"
-.\" This work is licensed under CC BY-SA 4.0. To see a copy of this license,
-.\" visit <http://creativecommons.org/licenses/by-sa/4.0/>.
-
-.TH swab 1
-
-.SH NAME
-
-swab \(en swap bytes
-
-.SH SYNOPSIS
-
-swab
-.RB ( -f )
-.RB ( -w
-.R [
-.B word size
-.R ])
-
-.SH USAGE
-
-Swap the latter and former halves of a block of bytes.
-
-.SH OPTIONS
-
-.B -f
-.RS
-Ignore system call interruptions.
-.RE
-
-.B -w
-.RS
-Configures the word size; that is, the size in bytes of the block size
-on which to operate. By default the word size is 2. The word size must be
-cleanly divisible by 2, otherwise the block of bytes being processed can't be
-halved.
-.RE
-
-.SH EXAMPLES
-
-The following sh(1p) line:
-
-.RS
-.R printf 'hello world!\n' | swab
-.RE
-
-Produces the following output:
-
-.RS
-.R ehll oowlr!d
-.RE
-
-.SH DIAGNOSTICS
-
-In the event of an error, a debug message will be printed and the program will
-exit with the appropriate sysexits.h(3) error code.
-
-.SH RATIONALE
-
-This program was modeled and named after the
-.R conv=swab
-functionality specified in the dd(1p) utility. It additionally allows the word
-size to be configured.
-
-This functionality is useful for fixing the endianness of binary files produced
-on other machines.
-
-.SH COPYRIGHT
-
-Copyright (c) 2024 DTB. License AGPLv3+: GNU AGPL version 3 or later
-<https://gnu.org/licenses/agpl.html>.
-
-.SH SEE ALSO
-
-dd(1p)

docs/true.1

@@ -1,5 +1,5 @@
 .\" Copyright (c) 2022, 2024 DTB <trinity@trinity.moe>
-.\" Copyright (c) 2023–2024 Emma Tebibyte <emma@tebibyte.media>
+.\" Copyright (c) 2023 Emma Tebibyte <emma@tebibyte.media>
 .\"
 .\" This work is licensed under CC BY-SA 4.0. To see a copy of this license,
 .\" visit <http://creativecommons.org/licenses/by-sa/4.0/>.
@@ -12,13 +12,14 @@ true \(en do nothing, successfully
 
 .SH DESCRIPTION
 
-Do nothing regardless of operands or standard input.
-An exit code of 0 will always be returned.
+True does nothing regardless of operands or standard input.
+True will always return an exit code of 0.
 
 .SH RATIONALE
 
-In POSIX.1-2017, true(1p) exists for the construction of control flow and loops
-based on a success. This implementation functions as described in that standard.
+True exists for the construction of control flow and loops based on a success.
+
+True functions as described in POSIX.1-2017.
 
 .SH AUTHOR
 

src/dj.c

@@ -203,28 +203,28 @@ Io_fdseek(struct Io *io){
 	
 	if(!fdisstd(io->fd) && lseek(io->fd, io->seek, SEEK_SET) != -1)
 		return -1;
-
-	/* repeated code to get the condition out of the loop */
-	if(io->fl == write_flags){
+	else if(io->fl == write_flags){
 		memset(io->buf, '\0', io->bs);
-		/* We're going to cheat and use bufuse as the retval for write(2),
-		 * which is fine because it'll be zeroed as this function returns
-		 * anyway. */
-		do{
-			if((io->bufuse = write(io->fd, io->buf, MIN(io->bs, io->seek)))
-					== 0)
-				/* second chance */
-				io->bufuse = write(io->fd, io->buf, MIN(io->bs, io->seek));
-		}while((io->seek -= io->bufuse) > 0 && io->bufuse != 0);
-	}else if(io->fl == read_flags){
-		do{
-			if((io->bufuse = read(io->fd, io->buf, MIN(io->bs, io->seek)))
-					== 0)
-				/* second chance */
-				io->bufuse = read(io->fd, io->buf, MIN(io->bs, io->seek));
-		}while((io->seek -= io->bufuse) > 0 && io->bufuse != 0);
+		/* This is a dirty trick; rather than testing conditions and operating
+		 * likewise, because the parameters to read or write are going to be
+		 * the same either way, just use a function pointer to keep track of
+		 * the intended operation. */
+		op = (int (*)(int, void *, size_t))&write;
+		/* Function pointer casts are risky; this works because the difference
+		 * is in the second parameter and only that write(2) makes the buffer
+		 * const whereas read(2) does not. To avoid even the slightest
+		 * undefined behavior comment out the cast, just be ready for a
+		 * -Wincompatible-function-pointer-types if your compiler notices it.
+		 */
 	}else
-		return EX_SOFTWARE;
+		op = &read;
+
+	/* We're going to cheat and use bufuse as the retval for write(2), which is
+	 * fine because it'll be zeroed as this function returns anyway. */
+	do{	if(	(io->bufuse = (*op)(io->fd, io->buf, MIN(io->bs, io->seek))) == 0)
+			/* second chance */
+			io->bufuse = (*op)(io->fd, io->buf, MIN(io->bs, io->seek));
+	}while((io->seek -= io->bufuse) > 0 && io->bufuse != 0);
 
 	io->bufuse = 0;
 

src/mm.c

@@ -1,224 +0,0 @@
-/*
- * Copyright (c) 2024 DTB <trinity@trinity.moe>
- * SPDX-License-Identifier: AGPL-3.0-or-later
- *
- * This program is free software: you can redistribute it and/or modify it under
- * the terms of the GNU Affero General Public License as published by the Free
- * Software Foundation, either version 3 of the License, or (at your option) any
- * later version.
- *
- * This program is distributed in the hope that it will be useful, but WITHOUT
- * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
- * FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
- * details.
- *
- * You should have received a copy of the GNU Affero General Public License
- * along with this program. If not, see https://www.gnu.org/licenses/.
- */
-
-#include <errno.h> /* errno */
-#include <signal.h> /* signal(2), SIG_ERR, SIG_IGN, SIGINT */
-#include <stdio.h> /* fclose(3), fopen(3), fprintf(3), getc(3), putc(3),
-                    * setvbuf(3), size_t, _IONBF, NULL */
-#include <stdlib.h> /* free(3), realloc(3) */
-#include <string.h> /* strcmp(3), strerror(3) */
-#include <unistd.h> /* getopt(3) */
-#if !defined EX_IOERR || !defined EX_OK || !defined EX_OSERR \
-		|| !defined EX_USAGE
-#	include <sysexits.h>
-#endif
-extern int errno;
-
-/* This structure is how open files are tracked. */
-struct Files{
-	size_t a;	/* allocation */
-	size_t s;	/* used size */
-	char *mode;	/* file opening mode */
-	char **names;	/* file names */
-	FILE **files;	/* file pointers */
-};
-
-/* How much to grow the allocation when it's saturated. */
-#ifndef ALLOC_INCREMENT
-#	define ALLOC_INCREMENT 1
-#endif
-
-/* How much to grow the allocation at program start. */
-#ifndef ALLOC_INITIAL
-#	define ALLOC_INITIAL 10
-#endif
-
-/* pre-allocated strings */
-static char *program_name = "<no argv[0]>";
-static char *stdin_name = "<stdin>";
-static char *stdout_name = "<stdout>";
-static char *stderr_name = "<stderr>";
-static char *(fmode[]) = { (char []){"rb"}, (char []){"rb+"} };
-static char *wharsh = "wb";
-
-/* Adds the open FILE pointer for the file at the path s to the files struct,
- * returning the FILE if successful and NULL if not, allocating more memory in
- * the files buffers as needed. */
-static FILE *
-Files_append(struct Files *files, FILE *file, char *name){
-
-	if(file == NULL || (files->s == files->a
-			&& ((files->files = realloc(files->files,
-					(files->a += (files->a == 0)
-						? ALLOC_INITIAL
-						: ALLOC_INCREMENT)
-					* sizeof *(files->files))) == NULL
-				|| (files->names = realloc(files->names,
-					files->a * sizeof *(files->names))) == NULL)))
-		return NULL;
-
-	files->names[files->s] = name;
-	return files->files[files->s++] = file;
-}
-
-/* Opens the file at the path p and puts it in the files struct, returning NULL
- * if either the opening or the placement of the open FILE pointer fail. */
-#define Files_open(files, p) \
-	Files_append((files), fopen((p), (files)->mode), (p))
-
-/* Prints a diagnostic message based on errno and returns an exit status
- * appropriate for an OS error. */
-static int
-oserr(char *s, char *r){
-
-	fprintf(stderr, "%s: %s: %s\n", s, r, strerror(errno));
-
-	return EX_OSERR;
-}
-
-/* Hijacks i and j from main and destructs the files[2] struct used by main by
- * closing its files and freeing its files and names arrays, returning retval
- * from main. */
-#define terminate \
-	for(i = 0; i < 2; ++i){ \
-		for(j = 0; j < files[i].s; ++j) \
-			if(files[i].files[j] != stdin \
-					&& files[i].files[j] != stdout \
-					&& files[i].files[j] != stderr) \
-				fclose(files[i].files[j]); \
-		free(files[i].files); \
-		free(files[i].names); \
-	} \
-	return retval
-
-int main(int argc, char *argv[]){
-	int c;
-	struct Files files[2]; /* {read, write} */
-	size_t i;
-	size_t j;
-	size_t k; /* loop index but also unbuffer status */
-	int retval;
-
-	/* Initializes the files structs with their default values, standard
-	 * input and standard output. If an input or an output is specified
-	 * these initial values will be overwritten, so to, say, use mm(1)
-	 * equivalently to tee(1p), -o - will need to be specified before
-	 * additional files to ensure standard output is still written. */
-	for(i = 0; i < 2; ++i){
-		files[i].a = 0;
-		files[i].s = 0;
-		files[i].mode = fmode[i];
-		files[i].files = NULL;
-		files[i].names = NULL;
-		Files_append(&files[i], i == 0 ? stdin : stdout,
-			i == 0 ? stdin_name : stdout_name);
-		files[i].s = 0;
-	}
-
-	k = 0;
-
-	if(argc > 0)
-		program_name = argv[0];
-
-	if(argc > 1)
-		while((c = getopt(argc, argv, "aehi:no:u")) != -1)
-			switch(c){
-			case 'a': /* "rb+" -> "ab" */
-				files[1].mode[0] = 'a';
-				files[1].mode[2] = '\0';
-				break;
-			case 'e':
-				if(Files_append(&files[1], stderr, stderr_name) != NULL)
-					break;
-				retval = oserr(argv[0], "-e");
-				terminate;
-			case 'i':
-				if((strcmp(optarg, "-") == 0 && Files_append(&files[0],
-							stdin, stdin_name) != NULL)
-						|| Files_open(&files[0], optarg) != NULL)
-					break;
-				retval = oserr(argv[0], optarg);
-				terminate;
-			case 'o':
-				if((strcmp(optarg, "-") == 0 && Files_append(&files[1],
-							stdout, stdout_name) != NULL)
-						|| Files_open(&files[1], optarg) != NULL)
-					break;
-				/* does not exist, so try to create it */
-				if(errno == ENOENT){
-					files[1].mode = wharsh;
-					if(Files_open(&files[1], optarg) != NULL){
-						files[1].mode = fmode[1];
-						break;
-					}
-				}
-				retval = oserr(argv[0], optarg);
-				terminate;
-			case 'n':
-				if(signal(SIGINT, SIG_IGN) != SIG_ERR)
-					break;
-				retval = oserr(argv[0], "-n");
-				terminate;
-			case 'u':
-				k = 1;
-				break;
-			default:
-				fprintf(stderr, "Usage: %s (-aenu) (-i [input])..."
-					" (-o [output])...\n", argv[0]);
-				retval = EX_USAGE;
-				terminate;
-			}
-
-	files[0].s += files[0].s == 0;
-	files[1].s += files[1].s == 0;
-	
-	/* Unbuffer files. */
-	if(k){
-		for(i = 0;
-			i < files[0].s;
-			setvbuf(files[0].files[i++], NULL, _IONBF, 0));
-		for(i = 0;
-			i < files[1].s;
-			setvbuf(files[1].files[i++], NULL, _IONBF, 0));
-	}
-
-	retval = EX_OK;
-
-	/* Actual program loop. */
-	for(i = 0; i < files[0].s; ++i) /* iterate ins */
-		while((c = getc(files[0].files[i])) != EOF) /* iterate chars */
-			for(j = 0; j < files[1].s; ++j) /* iterate outs */
-				if(putc(c, files[1].files[j]) == EOF){
-					/* notebook's full */
-					retval = EX_IOERR;
-					fprintf(stderr, "%s: %s: %s\n",
-						program_name, files[1].names[j], strerror(errno));
-					if(fclose(files[1].files[j]) == EOF)
-						fprintf(stderr, "%s: %s: %s\n",
-							program_name, files[1].names[j], strerror(errno));
-					/* massage out the tense muscle */
-					for(k = j--; k < files[1].s - 1; ++k){
-						files[1].files[k] = files[1].files[k+1];
-						files[1].names[k] = files[1].names[k+1];
-					}
-					if(--files[1].s == 0)
-						terminate;
-				}
-
-	terminate;
-}

src/swab.rs

@@ -1,90 +0,0 @@
-/*
- * Copyright (c) 2024 DTB <trinity@trinity.moe>
- * SPDX-License-Identifier: AGPL-3.0-or-later
- *
- * This program is free software: you can redistribute it and/or modify it under
- * the terms of the GNU Affero General Public License as published by the Free
- * Software Foundation, either version 3 of the License, or (at your option) any
- * later version.
- * 
- * This program is distributed in the hope that it will be useful, but WITHOUT
- * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
- * FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
- * details.
- *
- * You should have received a copy of the GNU Affero General Public License
- * along with this program. If not, see https://www.gnu.org/licenses/.
- */
-
-use std::{
-	env::args,
-	io::{ stdin, stdout, Error, ErrorKind, Read, Write },
-	process::ExitCode,
-	vec::Vec
-};
-
-extern crate getopt;
-use getopt::{ Opt, Parser };
-
-extern crate sysexits;
-use sysexits::{ EX_OK, EX_OSERR, EX_USAGE };
-
-fn oserr(s: &str, e: Error) -> ExitCode {
-	eprintln!("{}: {}", s, e);
-	ExitCode::from(EX_OSERR as u8)
-}
-
-fn usage(s: &str) -> ExitCode {
-	eprintln!("Usage: {} (-f) (-w [wordsize])", s);
-	ExitCode::from(EX_USAGE as u8)
-}
-
-fn main() -> ExitCode {
-	let argv = args().collect::<Vec<String>>();
-	let mut buf: Vec<u8> = Vec::new();
-	let mut input = stdin();
-	let mut output = stdout().lock();
-
-	let mut opts = Parser::new(&argv, "fw:");
-	let mut force = false;
-	let mut wordsize: usize = 2;
-
-	loop {
-		match opts.next() {
-			None => break,
-			Some(opt) =>
-				match opt {
-					Ok(Opt('f', None)) => force = true,
-					Ok(Opt('w', Some(arg))) => {
-						match arg.parse::<usize>() {
-							Ok(w) if w % 2 == 0 => { wordsize = w; () },
-							_ => { return usage(&argv[0]); },
-						}
-					},
-					_ => { return usage(&argv[0]); }
-				}
-		}
-	}
-
-	buf.resize(wordsize, 0);
-
-	loop {
-		match input.read(&mut buf) {
-			Ok(0) => break ExitCode::from(EX_OK as u8),
-			Ok(v) if v == wordsize => {
-				let (left, right) = buf.split_at(v/2);
-				if let Err(e) = output.write(&right)
-						.and_then(|_| output.write(&left)) {
-					break oserr(&argv[0], e)
-				}
-			},
-			Ok(v) => {
-				if let Err(e) = output.write(&buf[..v]) {
-					break oserr(&argv[0], e)
-				}
-			},
-			Err(e) if e.kind() == ErrorKind::Interrupted && force => continue,
-			Err(e) => break oserr(&argv[0], e)
-		}
-	}
-}

tests/bonsai/dj.sh

@@ -0,0 +1,27 @@
+#!/bin/sh
+# Copyright (c) 2024 DTB <trinity@trinity.moe>
+# Copyright (c) 2024 Emma Tebibyte <emma@tebibyte.media>
+# SPDX-License-Identifier: FSFAP
+#
+# Copying and distribution of this file, with or without modification, are
+# permitted in any medium without royalty provided the copyright notice and this
+# notice are preserved.  This file is offered as-is, without any warranty.
+
+. tests/bonsai/test_env
+
+! dj -h
+
+# This test is theoretically Linux-dependent; write(2) should return -1 on
+# error.
+# Right now dj(1) interprets the return value of write(2) as the amount of
+# bytes written. This can decrement the stored quantity of bytes written,
+# which is an int, so doesn't underflow but goes negative. dj(1) tries to
+# again to write(2) if an error occurs in which no bytes are written, so in
+# total two write(2)s are attempted and so the written byte quantity is -2.
+# This is a bug and will change, but for now is at least documented.
+dj -Hi /dev/zero -o /dev/full \
+	| xargs -I out "$BIN/strcmp" '1+0 > 0+0; 1024 > -2' out
+
+# Read nothing from /dev/null, write nothing to /dev/null.
+dj -Hi /dev/null -o /dev/null \
+	| xargs -I out "$BIN/strcmp" '0+0 > 0+0; 0 > 0' out

tests/bonsai/false.sh

@@ -0,0 +1,13 @@
+#!/bin/sh
+# Copyright (c) 2024 DTB <trinity@trinity.moe>
+# Copyright (c) 2024 Emma Tebibyte <emma@tebibyte.media>
+# SPDX-License-Identifier: FSFAP
+#
+# Copying and distribution of this file, with or without modification, are
+# permitted in any medium without royalty provided the copyright notice and this
+# notice are preserved.  This file is offered as-is, without any warranty.
+
+. tests/bonsai/test_env
+
+! false
+! false -h

tests/bonsai/fop.sh

@@ -0,0 +1,21 @@
+#!/bin/sh
+# Copyright (c) 2024 Emma Tebibyte <emma@tebibyte.media>
+# SPDX-License-Identifier: FSFAP
+#
+# Copying and distribution of this file, with or without modification, are
+# permitted in any medium without royalty provided the copyright notice and this
+# notice are preserved.  This file is offered as-is, without any warranty.
+
+. tests/bonsai/test_env
+
+! fop -h
+
+"$BIN/strcmp" "$(printf 'test0␞test1␞test2\n' | fop 1 sed 's/1/4/g')" \
+	'test0␞test4␞test2'
+
+"$BIN/strcmp" "$(printf 'test0 test1 test2\n' | fop -d' ' 2 sed 's/2/4/g')" \
+	'test0 test1 test4'
+
+! printf 'test\n' | fop 1 cat
+! printf 'test\n' | fop 'test' cat
+! printf 'test\n' | fop -d'test' cat

tests/bonsai/hru.sh

@@ -0,0 +1,26 @@
+#!/bin/sh
+# Copyright (c) 2024 Emma Tebibyte <emma@tebibyte.media>
+# SPDX-License-Identifier: FSFAP
+#
+# Copying and distribution of this file, with or without modification, are
+# permitted in any medium without royalty provided the copyright notice and this
+# notice are preserved.  This file is offered as-is, without any warranty.
+
+. tests/bonsai/test_env
+
+alias strcmp="$BIN/strcmp"
+alias rpn="$BIN/rpn"
+
+strcmp "$(printf '1234\n' | hru)" '1.2 kB'
+strcmp "$(printf '0\n' | hru)" '0 B'
+
+# doesn’t currently work but would be useful for testing for regressions
+#n=1
+#while "$BIN/true"; do
+#	n="$(rpn "$n" 10 ×)"
+#
+#	printf '%s\n' "$n" | hru || break
+#done
+#printf 'integer limit: ~%s\n' "$(rpn "$n" 10 ÷)"
+
+! printf '%s\n' '-1' | hru

tests/bonsai/intcmp.sh

@@ -0,0 +1,25 @@
+#!/bin/sh
+# Copyright (c) 2024 DTB <trinity@trinity.moe>
+# Copyright (c) 2024 Emma Tebibyte <emma@tebibyte.media>
+# SPDX-License-Identifier: FSFAP
+#
+# Copying and distribution of this file, with or without modification, are
+# permitted in any medium without royalty provided the copyright notice and this
+# notice are preserved.  This file is offered as-is, without any warranty.
+
+. tests/bonsai/test_env
+
+intcmp -e     3 3 3
+intcmp -g     3 2 1
+intcmp -l     1 2 3
+intcmp -ge    3 3 1
+intcmp -le    1 3 3
+intcmp -gl    1 2 3
+intcmp -egl   3 1 1 2
+! intcmp -e   1 2 3
+! intcmp -g   1 3 3
+! intcmp -l   3 3 1
+! intcmp -ge  1 2 3
+! intcmp -le  3 2 1
+! intcmp -gl  3 3 3
+! intcmp -egl foo

tests/bonsai/mm.sh

@@ -0,0 +1,19 @@
+#!/bin/sh
+# Copyright (c) 2024 Emma Tebibyte <emma@tebibyte.media>
+# SPDX-License-Identifier: FSFAP
+#
+# Copying and distribution of this file, with or without modification, are
+# permitted in any medium without royalty provided the copyright notice and this
+# notice are preserved.  This file is offered as-is, without any warranty.
+
+. tests/bonsai/test_env
+
+exec 3>&1
+
+! mm -h
+
+# mm(1) will error if positional arguments are given without -i or -o
+! mm argument
+
+# check if stderr is empty upon specifying -e
+! "$BIN/strcmp" "$(printf 'test\n' | mm -i - -e 2>&1 1>&3)" ''

tests/bonsai/strcmp.sh

@@ -0,0 +1,16 @@
+#!/bin/sh
+# Copyright (c) 2024 DTB <trinity@trinity.moe>
+# Copyright (c) 2024 Emma Tebibyte <emma@tebibyte.media>
+# SPDX-License-Identifier: FSFAP
+#
+# Copying and distribution of this file, with or without modification, are
+# permitted in any medium without royalty provided the copyright notice and this
+# notice are preserved.  This file is offered as-is, without any warranty.
+
+. tests/bonsai/test_env
+
+strcmp equals equals
+! strcmp inequals equals
+strcmp - -
+strcmp -h
+! strcmp nocmp

tests/bonsai/test_env

@@ -0,0 +1,5 @@
+#!/bin/sh
+
+set -x
+
+alias "$UTIL=$BIN/$UTIL"

tests/bonsai/true.sh

@@ -0,0 +1,13 @@
+#!/bin/sh
+# Copyright (c) 2024 DTB <trinity@trinity.moe>
+# Copyright (c) 2024 Emma Tebibyte <emma@tebibyte.media>
+# SPDX-License-Identifier: FSFAP
+#
+# Copying and distribution of this file, with or without modification, are
+# permitted in any medium without royalty provided the copyright notice and this
+# notice are preserved.  This file is offered as-is, without any warranty.
+
+. tests/bonsai/test_env
+
+true
+true -h

tests/posix/bin/cat

@@ -0,0 +1,22 @@
+#!/bin/sh
+# Copyright (c) 2024 Emma Tebibyte <emma@tebibyte.media>
+# SPDX-License-Identifier: FSFAP
+#
+# Copying and distribution of this file, with or without modification, are
+# permitted in any medium without royalty provided the copyright notice and this
+# notice are preserved.  This file is offered as-is, without any warranty.
+
+# Strictly POSIX-compliant cat(1) implementation. See cat(1p)
+
+for arg in "$@"; do
+	case "$arg" in
+		-u) args="$(printf '%s	%s\n' "$args" "$arg")" ;;
+		*) args="$(printf -- '%s	-i	%s\n' "$args" "$arg")" ;;
+	esac
+done
+
+# See IEEE Std 1003.1-2017 3.282
+# https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap03.html#tag_03_282
+IFS='	'
+
+mm $args

tests/posix/bin/false

@@ -0,0 +1,12 @@
+#!/bin/sh
+# Copyright (c) 2024 DTB <trinity@trinity.moe>
+# Copyright (c) 2024 Emma Tebibyte <emma@tebibyte.media>
+# SPDX-License-Identifier: FSFAP
+#
+# Copying and distribution of this file, with or without modification, are
+# permitted in any medium without royalty provided the copyright notice and this
+# notice are preserved.  This file is offered as-is, without any warranty.
+
+# Strictly POSIX-compliant false(1) implementation. See false(1p)
+
+false "$@"

tests/posix/bin/true

@@ -0,0 +1,11 @@
+#!/bin/sh
+# Copyright (c) 2024 DTB <trinity@trinity.moe>
+# Copyright (c) 2024 Emma Tebibyte <emma@tebibyte.media>
+# SPDX-License-Identifier: FSFAP
+#
+# Copying and distribution of this file, with or without modification, are
+# permitted in any medium without royalty provided the copyright notice and this
+# notice are preserved.  This file is offered as-is, without any warranty.
+
+# Strictly POSIX-compliant true(1) implementation. See true(1p)
+true "$@"

tests/test.sh

@@ -9,16 +9,30 @@
 
 set -e
 
+export BIN=build/bin
+
 if ! ls Makefile >/dev/null 2>&1
 then
 	printf '%s: Run this script in the root of the project.\n' "$0" 1>&2 
 	exit 1
 fi
 
-printf "Starting POSIX compatibility testing.\n"
+printf "Starting Bonsai testing.\n\n"
 
-for utility in tests/posix/*; do
-	printf '%s: %s: Testing utility.\n' "$0" "$utility"
+for script in tests/bonsai/*.sh; do
+	export UTIL="$(printf '%s\n' "$script" \
+		| sed -e 's/\.sh//g' -e 's;tests\/bonsai\/;;g')"
+
+	printf '%s: %s: Testing utility.\n' "$0" "$UTIL"
+	"$script"
+	printf '\n'
+done
+
+printf "Starting POSIX compatibility testing.\n\n"
+
+for test in tests/posix/*.sh; do
+	export PATH="$BIN:$PATH"
+	printf '%s: %s: Testing utility.\n' "$0" "$test"
 	"$utility"
 	printf '\n'
 done