mm(1): improves comments

CONTRIBUTING

@@ -99,10 +99,9 @@ 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 [0].
+style guide for the usage text’s output format [1].
 
-If committing a new utility, please include tests and documentation (see
-tests/ and docs/) for the new tool.
+[1] <http://cvsweb.netbsd.org/bsdweb.cgi/~checkout~/src/share/misc/style>
 
 If committing a new source file, format the commit message following these
 guidelines:
@@ -131,7 +130,6 @@ $ 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

@@ -31,13 +31,6 @@ RUSTLIBS = --extern getopt=build/o/libgetopt.rlib \
 	--extern strerror=build/o/libstrerror.rlib
 CFLAGS += -I$(SYSEXITS)
 
-# testing requires the absolute path to the bin directory set
-BIN = build/bin
-include tests/tests.mk
-
-.PHONY: default
-default: all test
-
 .PHONY: all
 all: dj false fop hru intcmp mm npc rpn scrut str strcmp swab true
 
@@ -60,9 +53,9 @@ install: dist
 	cp -r $(DESTDIR)/* /
 
 .PHONY: test
-test: all $(TESTS) /tmp/getopt
-	@echo $(TESTS)
+test: build /tmp/getopt
 	/tmp/getopt
+	tests/posix-compat.sh
 
 /tmp/getopt: src/libgetopt.rs
 	$(RUSTC) --test -o /tmp/getopt src/libgetopt.rs
@@ -121,8 +114,8 @@ build/bin/intcmp: src/intcmp.c build
 
 .PHONY: mm
 mm: build/bin/mm
-build/bin/mm: src/mm.c build
-	$(CC) $(CFLAGS) -o $@ src/mm.c
+build/bin/mm: src/mm.rs build rustlibs 
+	$(RUSTC) $(RUSTFLAGS) $(RUSTLIBS) -o $@ src/mm.rs
 
 .PHONY: npc
 npc: build/bin/npc

docs/mm.1

@@ -3,14 +3,14 @@
 .\" 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 2024-06-17 "Harakit X.X.X"
+.TH MM 1 2024-07-14 "Harakit X.X.X"
 .SH NAME
 mm \(en middleman
 .\"
 .SH SYNOPSIS
 
 mm
-.RB [ -aenu ]
+.RB [ -aetu ]
 .RB [ -i\ input ]
 .RB [ -o\ output ]
 .\"
@@ -21,19 +21,25 @@ Catenate input files and write them to the start of each output file or stream.
 .SH OPTIONS
 
 .IP \fB-a\fP
-Opens subsequent outputs for appending rather than updating.
+Opens outputs for appending rather than updating.
 .IP \fB-e\fP
 Use the standard error as an output.
-.IP \fB-i\fP\ \fIinput\fP
-Opens a path as an input. If one or more of the input files is \(lq-\(rq or if
-no inputs are specified, the standard input shall be used.
-.IP \fB-o\fP\ \fIoutput\fP
-Opens a path as an output. If one or more of the output files is \(lq-\(rq or if
-no outputs are specified, the standard output shall be used.
+.IP \fB-t\fP
+Causes outputs to be overwritten instead of being truncated.
 .IP \fB-u\fP
 Ensures neither input or output will be buffered.
-.IP \fB-n\fP
-Causes SIGINT signals to be ignored.
+.IP \fB-i\fP\ \fIinput\fP
+Opens a path as an input. If one or more of the input files is \(lq-\(rq or if
+no inputs are specified, the standard input shall be used. If specified as the
+last option and if there are trailing arguments to the program, they shall be
+appended to the list of files to use as inputs.
+.IP \fB-o\fP\ \fIoutput\fP
+Opens a path as an output. If one or more of the output files is \(lq-\(rq or if
+no outputs are specified and the
+.B -e
+option is not specified, the standard output shall be used. If specified as the
+last option and if there are trailing arguments to the program, they shall be
+appended to the list of files to use as outputs.
 .\"
 .SH DIAGNOSTICS
 
@@ -45,10 +51,6 @@ exits with the appropriate
 .BR sysexits.h (3)
 status.
 .\"
-.SH CAVEATS
-
-Existing files are not truncated on ouput and are instead overwritten.
-.\"
 .SH RATIONALE
 
 The

docs/swab.1

@@ -11,7 +11,6 @@ swab \(en swap bytes
 .SH SYNOPSIS
 
 swab
-.RB [ -f ]
 .RB [ -w\ word_size ]
 .\"
 .SH DESCRIPTION
@@ -20,8 +19,6 @@ Swap the latter and former halves of a block of bytes.
 .\"
 .SH OPTIONS
 
-.IP \fB-f\fP
-Ignore SIGINT signal.
 .IP \fB-w\fP\ \fIword_size\fP
 Configures the word size; that is, the size in bytes of the block size on which
 to operate. The default word size is 2. The word size must be cleanly divisible

src/dj.c

@@ -263,12 +263,12 @@ int main(int argc, char *argv[]){
 		assert(io[0].bufuse == 0);
 
 		{ /* read */
-			char skipping;
+			long skipping;
 			size_t t;
 
 			/* hack to intentionally get a partial read from Io_read */
-			if((skipping = (io[0].seek > 0)) && io[0].seek < io[0].bs)
-				io[0].bufuse = io[0].bs - io[0].seek;
+			if((skipping = MIN(io[0].seek, io[0].bs)) > 0)
+				io[0].bufuse = io[0].bs - (size_t)skipping;
 
 			t = io[0].bufuse;
 			if(Io_read(&io[0])->bufuse == t && !noerror && io[0].error == 0)
@@ -290,7 +290,8 @@ int main(int argc, char *argv[]){
 				}
 			}
 
-			if(skipping){
+			if(skipping > 0){
+				io[0].seek -= skipping;
 				io[0].bufuse = 0;
 				count += (count != 0);
 				continue;

src/mm.c

@@ -1,236 +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
-
-/* Prints a usage text, in which s is the program being run (i.e. argv[0]), and
- * returns an exit status appropriate for a usage error. */
-int usage(char *s){
-
-	fprintf(stderr, "Usage: %s [-aenu] [-i input]... [-o output]...\n", s);
-
-	return EX_USAGE;
-}
-
-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:
-				retval = usage(argv[0]);
-				terminate;
-			}
-
-	if(optind != argc){
-		retval = usage(argv[0]);
-		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/mm.rs

@@ -0,0 +1,185 @@
+/*
+ * Copyright (c) 2024 Emma Tebibyte <emma@tebibyte.media>
+ * 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,
+	fs::File,
+	io::{ stdin, stdout, stderr, BufWriter, Read, Write },
+	os::fd::{ AsRawFd, FromRawFd },
+	process::{ exit, ExitCode },
+};
+
+extern crate getopt;
+extern crate strerror;
+extern crate sysexits;
+
+use getopt::GetOpt;
+use strerror::StrError;
+use sysexits::{ EX_IOERR, EX_USAGE };
+
+use ArgMode::*;
+
+enum ArgMode { In, Out }
+
+fn main() -> ExitCode {
+	let argv = args().collect::<Vec<_>>();
+	let usage = format!("Usage: {} [-aetu] [-i input] [-o output]", argv[0]);
+
+	let mut a = false; /* append to the file */
+	let mut e = false; /* use stderr as an output */
+	let mut t = true; /* do not truncate the file before writing */
+	let mut u = false; /* unbuffer i/o */
+	let mut ins = Vec::new(); /* initial input file path vector */
+	let mut outs = Vec::new(); /* initial output file path vector */
+	let mut mode: Option<ArgMode> = None; /* mode set by last-used option */
+	let mut optind = 0;
+
+	while let Some(opt) = argv.getopt("aei:o:tu") {
+		match opt.opt() {
+			Ok("a") => a = true,
+			Ok("e") => e = true, 
+			Ok("u") => u = true,
+			Ok("t") => t = false,
+			Ok("i") => { /* add inputs */
+				let input = opt.arg().unwrap();
+				ins.push(input);
+				mode = Some(In); /* latest argument == -i */
+			},
+			Ok("o") => { /* add output */
+				let output = opt.arg().unwrap(); 
+				outs.push(output);
+				mode = Some(Out); /* latest argument == -o */
+			},
+			Err(_) | Ok(_) => {
+				eprintln!("{}", usage);
+				return ExitCode::from(EX_USAGE as u8);
+			},
+		};
+
+		optind = opt.ind();
+	}
+
+	let remaining = argv.iter().skip(optind);
+
+	/* check the last flag specified */
+	if let Some(m) = mode {
+		for arg in remaining {
+			/* move the subsequent arguments to the list of inputs or outputs */
+			match m {
+				In => ins.push(arg.to_string()),
+				Out => outs.push(arg.to_string()),
+			};
+		}
+	} else {
+		eprintln!("{}", usage);
+		return ExitCode::from(EX_USAGE as u8);
+	}
+
+	/* use stdin if no inputs are specified */
+	if ins.is_empty() { ins.push("-".to_string()); }
+
+	/* use stdout if no outputs are specified */
+	if outs.is_empty() && !e { outs.push("-".to_string()); }
+	
+	/* map all path strings to files */
+	let inputs = ins.iter().map(|file| {
+		/* if a file is “-”, it is stdin */
+		if *file == "-" {
+			/* portable way to access stdin as a file */
+			return unsafe { File::from_raw_fd(stdin().as_raw_fd()) };
+		}
+
+		match File::open(file) {
+			Ok(f) => f,
+			Err(e) => {
+				eprintln!("{}: {}: {}", argv[0], file, e.strerror());
+				exit(EX_IOERR);
+			},
+		}
+	}).collect::<Vec<_>>();
+
+	/* map all path strings to files */
+	let mut outputs = outs.iter().map(|file| {
+		/* of a file is “-”, it is stdout */
+		if *file == "-" {
+			/* portable way to access stdout as a file */
+			return unsafe { File::from_raw_fd(stdout().as_raw_fd()) }; 
+		}
+
+		let options = File::options()
+			/* don’t truncate if -t is specified, append if -a is specified */
+			.truncate(t)
+			.append(a)
+			/* enable the ability to create and write to files */
+			.create(true)
+			.write(true)
+			/* finally, open the file! */
+			.open(file);
+
+		match options {
+			Ok(f) => return f,
+			Err(e) => {
+				eprintln!("{}: {}: {}", argv[0], file, e.strerror());
+				exit(EX_IOERR);
+			},
+		};
+	}).collect::<Vec<_>>();
+
+	/* if -e is specified, use stderr */
+	if e {
+		/* portable way to access stderr as a file */
+		outputs.push(unsafe { File::from_raw_fd(stderr().as_raw_fd()) });
+	}
+
+	let mut outputs = outputs.iter().map(|o| {
+		if u {
+			/* unbuffered writing through a buffer of capacity 0 */
+			BufWriter::with_capacity(0, o)
+		} else {
+			/* theoretically buffered writing */
+			BufWriter::new(o)
+		}
+	}).collect::<Vec<_>>();
+
+	for file in inputs {
+		for byte in file.bytes().map(|b| {
+			b.unwrap_or_else(|e| {
+				eprintln!("{}: {}", argv[0], e.strerror());
+				exit(EX_IOERR);
+			})
+		}) {
+			for out in &mut outputs {
+				if let Err(e) = out.write(&[byte]) {
+					eprintln!("{}: {}", argv[0], e.strerror());
+					return ExitCode::from(EX_IOERR as u8);
+				}
+
+				if u {
+					/* immediately flush the output for -u */
+					if let Err(e) = out.flush() { 
+						eprintln!("{}: {}", argv[0], e.strerror());
+						return ExitCode::from(EX_IOERR as u8);
+					}
+				}
+			}
+		}
+	}
+
+	ExitCode::SUCCESS
+}

src/swab.rs

@@ -1,5 +1,6 @@
 /*
  * Copyright (c) 2024 DTB <trinity@trinity.moe>
+ * Copyright (c) 2024 Emma Tebibyte <emma@tebibyte.media>
  * SPDX-License-Identifier: AGPL-3.0-or-later
  *
  * This program is free software: you can redistribute it and/or modify it under
@@ -18,7 +19,7 @@
 
 use std::{
 	env::args,
-	io::{ stdin, stdout, Error, ErrorKind, Read, Write },
+	io::{ stdin, stdout, Error, Read, Write },
 	process::ExitCode,
 	vec::Vec
 };
@@ -38,7 +39,7 @@ fn oserr(s: &str, e: Error) -> ExitCode {
 }
 
 fn usage(s: &str) -> ExitCode {
-	eprintln!("Usage: {} [-f] [-w word_size]", s);
+	eprintln!("Usage: {} [-w word_size]", s);
 	ExitCode::from(EX_USAGE as u8)
 }
 
@@ -48,24 +49,26 @@ fn main() -> ExitCode {
 	let mut input = stdin();
 	let mut output = stdout().lock();
 
-	let mut force = false;
-	let mut wordsize: usize = 2;
+	let mut optind: usize = 1;   // argv[0]
+	let mut wordsize: usize = 2; // Equivalent to dd(1p).
 
-	while let Some(opt) = argv.getopt("fw:") {
+	while let Some(opt) = argv.getopt("w:") {
 		match opt.opt() {
-			Ok("f") => force = true,
 			Ok("w") => {
-				if let Some(arg) = opt.arg() {
-					match arg.parse::<usize>() {
-						Ok(w) if w % 2 == 0 => { wordsize = w; () },
+					match opt.arg().unwrap().parse::<usize>() {
+						Ok(w) if w % 2 == 0 => { wordsize = w; },
 						_ => { return usage(&argv[0]); },
 					}
-				}
+				optind = opt.ind();
 			},
 			_ => { return usage(&argv[0]); }
 		}
 	}
 
+	if optind < argv.len() {
+		return usage(&argv[0]);
+	}
+
 	buf.resize(wordsize, 0);
 
 	loop {
@@ -83,7 +86,6 @@ fn main() -> ExitCode {
 					break oserr(&argv[0], e)
 				}
 			},
-			Err(e) if e.kind() == ErrorKind::Interrupted && force => continue,
 			Err(e) => break oserr(&argv[0], e)
 		}
 	}

tests/README

@@ -1,60 +0,0 @@
-The testing suite contains two main trees (plus translations for strings used in
-the shell scripts): the Bonsai tree and the POSIX tree:
-
-.
-├── bonsai
-│   ├── test_env
-│   ├── dj.sh
-│   ├── false.sh
-│   ├── fop.sh
-│   ├── hru.sh
-│   ├── intcmp.sh
-│   ├── mm.sh
-│   ├── strcmp.sh
-│   └── true.sh
-├── locales
-│   ├── en_US.UTF-8
-│   └── tok
-├── posix
-│   ├── bin
-│   │   ├── cat
-│   │   ├── false
-│   │   └── true
-│   └── posix_env
-├── README
-└── test.sh
-
-The Bonsai tree tests the functionality of Harakit utilities for regressions and
-other issues relating to compliance to our standards of practice.
-
-The POSIX tree tests the use of Harakit utilities in place of the standard usage
-of POSIX utilities. These scripts test the ability of Harakit to comply to POSIX
-standards using its native utilities in shell scripts as a compatibility shim.
-Each shell script in the top directory should contain a set of tests for each
-POSIX utility and be named for that utility. The bin directory should contain
-a set of shim scripts which will be imported into the path as POSIX utilities.
-Each test will compare the behavior of the shim script to the real utility on
-the system.
-
-Currently, due to the limitations of POSIX shell quoting, a subset of argument
-parsing is supported: arguments containing characters from POSIX’s Portable
-Filename Character Set [0].
-
-The bonsai/test_env and posix/posix_env files contain prerequisite shared
-environments for each of the tests. These scripts both contain lines which set
-the shell to write all commands run in them (-x) and to fail if any command
-fails (-e). See set(1p) for more information.
-
-Both sets of tests also inherit the environment set by the test.sh script, which
-sets the $BIN environment variable to the bin directory at the root of the
-project for easy and idiomatic access to the built Harakit binaries. When
-calling the POSIX test scripts, test.sh also sets the variable $realutil to be
-the absolute path to the currently tested utility’s counterpart on the system.
-
-[0] <https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap03.html#tag_03_282>
-
---
-Copyright © 2024 Emma Tebibyte <emma@tebibyte.media>
-
-This work is licensed under CC BY-SA 4.0. To view a copy of this license, visit
-<http://creativecommons.org/licenses/by-sa/4.0/>.

tests/bonsai/dj.mk

@@ -1,48 +0,0 @@
-# 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.
-
-.PRAGMA: command_comment
-
-/dev/full:
-/dev/null:
-
-.PHONY: dj_tests
-dj_tests: dj_help dj_full dj_null # dj_skip_stdin
-
-.PHONY: dj_full
-# Linux has a /dev/full pseudodevice useful for testing errors.
-dj_full: $(BIN)/dj /dev/full
-	case "$$(uname)" in \
-	Linux) \
-		$(BIN)/dj -Hi /dev/zero -o /dev/full 2>&1 \
-			| tee /dev/stderr \
-			| xargs -I out test '1+0 > 0+0; 1024 > 0' = out \
-		;; \
-	esac
-
-.PHONY: dj_help
-dj_help: $(BIN)/dj
-	! $(BIN)/dj -h
-
-.PHONY: dj_null
-# Read nothing from /dev/null, write nothing to /dev/null.
-dj_null: $(BIN)/dj /dev/null
-	$(BIN)/dj -Hi /dev/null -o /dev/null 2>&1 \
-		| tee /dev/stderr \
-		| xargs -I out test '0+0 > 0+0; 0 > 0' = out
-
-# This test currently fails. This is probably due to dj(1) being stale relative
-# to the main harakit branch. TODO: Reassess once the testing branch is merged.
-# .PHONY: dj_skip_stdin
-# # Test skipping stdin.
-# dj_skip_stdin: $(BIN)/dj
-# 	# Pipe 1024B of '\0' into dj(1); skip the first 24B; expect 1000B written.
-# 	dd count=1 bs=1024 </dev/zero 2>/dev/null \
-# 		| $(BIN)/dj -H -s 24 -o /dev/null 2>&1 \
-# 		| tee /dev/stderr \
-# 		| xargs -I out test '1+0 > 1+0; 1024 > 1000' = out

tests/bonsai/false.mk

@@ -1,18 +0,0 @@
-# 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.
-
-.PHONY: false_tests
-false_tests: false_test false_help
-
-.PHONY: false
-false_test: $(BIN)/false
-	! $(BIN)/false
-
-.PHONY: false_help
-false_help: $(BIN)/false
-	! $(BIN)/false -h

tests/bonsai/fop.mk

@@ -1,31 +0,0 @@
-# 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.
-
-.PHONY: fop_tests
-fop_tests: fop_functionality fop_delimiter fop_help fop_fail
-
-.PHONY: fop_help
-fop_help: $(BIN)/fop
-	! $(BIN)/fop -h
-
-.PHONY: fop_delimiter
-fop_delimiter: $(BIN)/fop
-	test "$$(printf 'test1 test1 test1\n' | $(BIN)/fop -d' ' 2 sed 's/2/4/g')" \
-		= 'test1 test1 test4'
-	test "$$(printf 'meowsetwoofsetribbit\n' \
-		| $(BIN)/fop -d 'set' 1 sed 's/woof/meow/g')" = 'meowsetmeowsetribbit'
-
-.PHONY: fop_fail
-fop_fail: $(BIN)/fop
-	! printf 'test\n' | $(BIN)/fop 1 cat
-	! printf 'test\n' | $(BIN)/fop 'test' cat
-	! printf 'test\n' | $(BIN)/fop -d'test' cat
-
-.PHONY: fop_functionality
-fop_functionality: $(BIN)/fop
-	test "$$(printf 'test1\036test1\036test1\n' | $(BIN)/fop 1 sed 's/1/4/g')" \
-		= "$$(printf 'test1\036test4\036test1\n')"

tests/bonsai/hru.mk

@@ -1,35 +0,0 @@
-# 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.
-
-NAME = hru
-TARGET = $(NAME)_tests
-BINARY = $(BIN)/$(NAME)
-
-.PHONY: hru_tests
-hru_tests: $(BIN)/hru
-
-.PHONY: hru_functionality
-hru_functionality: $(BIN)/hru
-	test "$(printf '1234\n' | $(BIN)/hru)" = '1.2 kB'
-	test "$(printf '0\n' | $(BIN)/hru)" = '0 B'
-
-.PHONY: $(NAME_help)
-hru_help: $(BIN)/hru
-	! $(BIN)/hru -h
-
-.PHONY: hru_negative
-hru_negative: $(BIN)/hru
-	! printf '%s\n' '-1' | $(BIN)/hru
-
-.PHONY: hru_regressions
-hru_regressions: $(BIN)/hru
-	n=1; \
-	while true; \
-		do n="$$(($$n * 10))"; \
-		printf '%s\n' "$$n" | $(BIN)/hru || break; \
-	done; \
-	printf 'Max float: %s\n' "$$n"

tests/bonsai/intcmp.mk

@@ -1,45 +0,0 @@
-# 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.
-
-.PHONY: intcmp_tests
-intcmp_tests: intcmp_help intcmp_e intcmp_g intcmp_l intcmp_combined
-
-.PHONY: intcmp_help
-intcmp_help: $(BIN)/intcmp
-	! $(BIN)/intcmp -h
-
-.PHONY: intcmp_e
-intcmp_e: $(BIN)/intcmp
-	$(BIN)/intcmp   -e   3 3 3    # ==
-	! $(BIN)/intcmp -e   1 2 3    # <
-	! $(BIN)/intcmp -e   3 2 1    # >
-
-.PHONY: intcmp_g
-intcmp_g: $(BIN)/intcmp
-	$(BIN)/intcmp   -g   3 2 1    # >
-	! $(BIN)/intcmp -g   3 3 3    # ==
-	! $(BIN)/intcmp -g   1 2 3    # <
-	$(BIN)/intcmp   -ge  3 3 1    # >=
-	! $(BIN)/intcmp -ge  1 2 3    # <
-
-.PHONY: intcmp_l
-intcmp_l: $(BIN)/intcmp
-	$(BIN)/intcmp   -l   1 2 3    # <
-	! $(BIN)/intcmp -l   3 3 3    # ==
-	! $(BIN)/intcmp -l   3 2 1    # >
-	$(BIN)/intcmp   -le  1 3 3    # <=
-	! $(BIN)/intcmp -le  3 2 1    # >
-
-.PHONY: intcmp_combined
-intcmp_combined: $(BIN)/intcmp
-	$(BIN)/intcmp   -gl  1 2 3    # <
-	$(BIN)/intcmp   -gl  3 2 1    # >
-	$(BIN)/intcmp   -gl  1 3 1    # !=
-	! $(BIN)/intcmp -gl  3 3 3    # ==
-	$(BIN)/intcmp   -egl 3 1 1 3  # >, ==, <
-	! $(BIN)/intcmp -egl foo      # huh?

tests/bonsai/mm.mk

@@ -1,27 +0,0 @@
-# Copyright (c) 2024 E$(NAME)a Tebibyte <e$(NAME)a@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.
-
-NAME = mm
-TARGET = $(NAME)_tests
-BINARY = $(BIN)/$(NAME)
-
-.PHONY: mm_tests
-mm_tests: mm_args mm_help mm_stderr
-
-.PHONY: mm_args
-# mm(1) will error if positional arguments are given without -i or -o
-mm_args: $(BIN)/mm
-	! $(BIN)/mm argument
-
-.PHONY: mm_help
-mm_help: $(BIN)/mm
-	! $(BIN)/mm -h
-
-.PHONY: mm_stderr
-# check if stderr is empty upon specifying -e
-mm_stderr: $(BIN)/mm
-	! test "$$(printf 'test\n' | $(BIN)/mm -i - -e 2>&1 >/dev/null)" = "test"

tests/bonsai/npc.mk

@@ -1,72 +0,0 @@
-#!/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.
-
-.PRAGMA: command_comment
-
-.PHONY: npc_tests
-npc_tests: npc_help npc_args npc_ascii
-
-.PHONY: npc_help
-npc_help: $(BIN)/npc
-	! $(BIN)/npc -h
-
-.PHONY: npc_args
-# arg parsing
-npc_args:
-	$(BIN)/npc -e </dev/null
-	$(BIN)/npc -t </dev/null
-	$(BIN)/npc -et </dev/null
-	! $(BIN)/npc -et 5 </dev/null
-
-.PHONY: npc_ascii
-# Test 0x00 to 0x7f in input; in other words, the full 7b ASCII range.
-npc_ascii: npc_ascii_controls npc_ascii_symbols npc_ascii_uppers # \
-#	npc_ascii_lowers
-
-.PHONY: npc_ascii_controls
-# (control characters)
-npc_ascii_controls:
-	# ASCII 0x00 to 0x0a (before the newline, due to xargs(1p) issues)
-	awk 'BEGIN{ for (i = 0; i < 32; ++i) printf("%c", i); }' \
-		| $(BIN)/npc \
-		| head -n 1 \
-		| xargs -I out test "^@^A^B^C^D^E^F^G^H" = out
-
-	# ASCII 0x0a (otherwise the head|tail sequence won't work) to 0x1f
-	awk 'BEGIN{ for (i = 0; i < 32; ++i) printf("%c", i); print }' \
-		| $(BIN)/npc \
-		| head -n 2 \
-		| tail -n 1 \
-		| xargs -I out test "^K^L^M^N^O^P^Q^R^S^T^U^V^W^X^Y^Z^[^\^]^^^_"
-
-.PHONY: npc_ascii_symbols
-# ASCII 0x1f to 0x3f (^_ and symbols)
-npc_ascii_symbols:
-	# shell quoting olympics
-	awk 'BEGIN{ for (i = 31; i < 64; ++i) printf("%c", i); print }' \
-		| $(BIN)/npc \
-		| sed -e s"/\'/\\\'/g" -e 's/"/\\"/g' \
-		| xargs -I out test "^_ !\"#$$%&'()*+,-./0123456789:;<=>?" = out
-
-.PHONY: npc_ascii_uppers
-# ASCII 0x40 to 0x5f (uppercases)
-npc_ascii_uppers:
-	awk 'BEGIN{ for (i = 64; i < 96; ++i) printf("%c", i); print }' \
-		| $(BIN)/npc \
-		| sed 's/\\/\\\\/' \
-		| xargs -I out test @ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_ = out
-
-# This test is broken and will need closer inspection along with the npc(1)
-# source.
-# .PHONY: npc_ascii_lowers
-# # ASCII 0x60 to 0x7f (lowercases)
-# npc_ascii_lowers:
-# 	awk 'BEGIN{ for (i = 96; i < 128; ++i) printf("%c", i); print }' \
-# 		| $(BIN)/npc \
-# 		| xargs -I out test "\`abcdefghijklmnopqrstuvwxyz{|}~^?" = out

tests/bonsai/scrut.mk

@@ -1,46 +0,0 @@
-#!/bin/sh
-# Copyright (c) 2024 DTB <trinity@trinity.moe>
-# 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.
-
-.PRAGMA: command_comment
-
-.PHONY: scrut_tests
-scrut_tests: scrut_help scrut_options
-
-.PHONY: scrut_help
-scrut_help: $(BIN)/scrut
-	! $(BIN)/scrut -h
-
-.PHONY: scrut_options
-# scrut tests file attributes, but files of a certain attribute aren't
-# guaranteed to be present on a system. This test checks all of the files in
-# harakit and, if test(1p) says a file matches a certain attribute, then checks
-# scrut.
-# opts are space-delimited (for command splitting), sel is not
-scrut_options: $(BIN)/scrut
-	set -e; \
-	opts="b c d e f g k p r s u w x L S"; \
-	sel=; \
-	find . -name .git -prune -o -print \
-		| while read -r f; do \
-			for opt in $$opts; \
-				do if ! printf "%s\n" $$sel | grep $$opt >/dev/null; then \
-					if test -$$opt "$$f"; then \
-						if ! $(BIN)/scrut -$$opt "$$f"; \
-							then printf "[!!] scrut -%s failed on %s.\n" \
-								$$opt "$$f"; \
-						fi; \
-						sel="$$sel$$opt"; \
-						printf "[OK] Tested scrut -%s using %s\n" \
-							$$opt "$$f"; \
-					fi; \
-				fi; \
-			done; \
-			if printf "%s\n" "$$opts" | sed 's/ //g' | xargs test "$$sel" =; \
-				then break; \
-			fi; \
-		done

tests/bonsai/strcmp.mk

@@ -1,31 +0,0 @@
-# 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.
-
-NAME = strcmp
-TARGET = $(NAME)_tests
-BINARY = $(BIN)/$(NAME)
-
-.PHONY: strcmp_tests
-strcmp_tests: strcmp_equals strcmp_help strcmp_nocmp strcmp_unequals
-
-.PHONY: strcmp_equals
-strcmp_equals: $(BIN)/strcmp
-	$(BIN)/strcmp equals equals
-	$(BIN)/strcmp - -
-
-.PHONY: strcmp_help
-strcmp_help: $(BIN)/strcmp
-	! $(BIN)/strcmp -h
-
-.PHONY: strcmp_nocmp
-strcmp_nocmp: $(BIN)/strcmp
-	! $(BIN)/strcmp nocmp
-
-.PHONY: strcmp_unequals
-strcmp_unequals: $(BIN)/strcmp
-	! $(BIN)/strcmp unequals equals

tests/bonsai/true.mk

@@ -1,19 +0,0 @@
-#!/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.
-
-.PHONY: true_tests
-true_tests: true_test
-
-.PHONY: true_help
-true_help: $(BIN)/true
-	$(BIN)/true -h
-
-.PHONY: true_test
-true_test: $(BIN)/true
-	$(BIN)/true

tests/posix-compat.sh

@@ -0,0 +1,24 @@
+#!/bin/sh
+
+# Copyright (c) 2023–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.
+
+set -e
+
+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"
+
+for utility in tests/posix/*; do
+	printf '%s: %s: Testing utility.\n' "$0" "$utility"
+	"$utility"
+	printf '\n'
+done

tests/posix/bin/cat

@@ -1,22 +0,0 @@
-#!/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

@@ -1,12 +0,0 @@
-#!/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

@@ -1,11 +0,0 @@
-#!/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/posix/posix_env

@@ -1,5 +0,0 @@
-#!/bin/sh
-
-set -ex
-
-PATH="$PWD/bin:$PATH"

tests/tests.mk

@@ -1,15 +0,0 @@
-# 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.
-
-
-#TESTFILES != for file in tests/bonsai/*.mk tests/posix/*.mk; do printf '%s ' "$$file"; done;
-TESTFILES != for file in tests/bonsai/*.mk; do printf '%s ' "$$file"; done;
-
-TESTS != printf '%s\n' "$(TESTFILES)" | xargs -n1 basename \
-	| sed 's/\.mk/_tests/g'
-
-include $(TESTFILES)