Makefile: directory specification changes

This reverts commit 7e45af1bca, reversing
changes made to d87b5d0958.

CONTRIBUTING

@@ -90,26 +90,44 @@ notice:
  *     USE OR OTHER DEALINGS IN THE SOFTWARE.
  */
 
-When writing code, make sure lines never exceed 80 characters in width when
-using four-character-wide indentation steps.
+Make sure lines never exceed 80 columns in width when using four-character
+indentation steps. This helps contributors with smaller screens, those using
+side-by-side editor windows or panes, and those who have no text wrapping in
+their editor or terminal.
 
-For usage text and help messages, please do not implement a -h option. Just
-print usage information when any erroneous option is specified. Follow the
-NetBSD style guide for usage text output format [1].
+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].
 
-If committing a new source file for a utility, format the commit message like
-this:
+[1] <http://cvsweb.netbsd.org/bsdweb.cgi/~checkout~/src/share/misc/style>
 
-$ git commit -m 'tool(1): <information>'
+If committing a new source file, format the commit message following these
+guidelines:
+
+$ git commit -m 'tool(1): add feature x'
 
 If committing a new library or header file:
 
-$ git commit -m 'library(1): <information>'
+$ git commit -m 'library(3): fix overflow'
+$ git commit -m 'header.h(3): add header.h(3)'
+
+If committing a new manual page:
+
+$ git commit -m 'tool.1: add author details'
 
 If modifying some other file or directory:
 
-$ git commit -m 'README: clarification'
-$ git commit -m 'tests: posix: fixed bug #47'
-$ git commit -m 'docs: tool(1): added author information'
+$ git commit -m 'README: clarify'
+$ git commit -m 'tests/posix: fix bug #47'
 
-etc.
+For multiple of these:
+
+$ git commit -m 'Makefile, tool(1): add tool(1)'
+$ git commit -m 'tool(1): add tool(1); library(3), library.3: add library(3)'
+$ git commit -m 'tool(1): fix #42 & add feature x'
+
+Commit messages should be written in the present tense.
+
+--
+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

@@ -8,16 +8,26 @@
 # notice are preserved.  This file is offered as-is, without any warranty.
 
 .POSIX:
+
+# if using BSD make(1), remove these pragmas because they break it
 .PRAGMA: posix_202x # future POSIX standard support à la pdpmake(1)
 .PRAGMA: command_comment # breaks without this?
 
-PREFIX=/usr/local
+DESTDIR ?= dist
+PREFIX ?= /usr/local
 
-CC=cc
-RUSTC=rustc
+SYSEXITS != printf '\043include <sysexits.h>\n' | cpp -M - | sed 's/ /\n/g' \
+	| sed -n 's/sysexits\.h//p' || printf 'include\n'
+
+CC ?= cc
+RUSTC ?= rustc
+RUSTLIBS = --extern getopt=build/o/libgetopt.rlib \
+	--extern sysexits=build/o/libsysexits.rlib \
+	--extern strerror=build/o/libstrerror.rlib
+CFLAGS += -I$(SYSEXITS)
 
 .PHONY: all
-all: dj false fop intcmp rpn scrut str strcmp true
+all: dj false fop hru intcmp rpn scrut str strcmp true
 
 build:
 	# keep build/include until bindgen(1) has stdin support
@@ -26,36 +36,40 @@ build:
 
 .PHONY: clean
 clean:
-	rm -rf build/ dist/
+	rm -rf build dist
 
 dist: all
-	mkdir -p dist/bin dist/share/man/man1
-	cp build/bin/* dist/bin/
-	cp docs/*.1 dist/share/man/man1/
+	mkdir -p $(DESTDIR)/$(PREFIX)/bin $(DESTDIR)/$(PREFIX)/share/man/man1
+	cp build/bin/* $(DESTDIR)/$(PREFIX)/bin
+	cp docs/*.1 $(DESTDIR)/$(PREFIX)/share/man/man1
 
 .PHONY: install
 install: dist
-	mkdir -p $(PREFIX)
-	cp -r dist/* $(PREFIX)/
+	cp -r $(DESTDIR)/* /
 
 .PHONY: test
 test: build
 	tests/posix-compat.sh
 	$(RUSTC) --test src/getopt-rs/lib.rs -o build/test/getopt
 
-build/o/libsysexits.rlib: build
+.PHONY: rustlibs
+rustlibs: build/o/libsysexits.rlib build/o/libgetopt.rlib \
+	build/o/libstrerror.rlib
+
+build/o/libgetopt.rlib: build src/getopt-rs/lib.rs
+	$(RUSTC) $(RUSTFLAGS) --crate-type=lib --crate-name=getopt \
+		-o $@ src/getopt-rs/lib.rs
+
+build/o/libstrerror.rlib: build src/strerror.rs
+	$(RUSTC) $(RUSTFLAGS) --crate-type=lib -o $@ \
+		src/strerror.rs
+
+build/o/libsysexits.rlib: build $(SYSEXITS)sysexits.h
 	# bandage solution until bindgen(1) gets stdin support
-	printf '#define EXIT_FAILURE 1\n' | cat - include/sysexits.h \
+	printf '#define EXIT_FAILURE 1\n' | cat - $(SYSEXITS)sysexits.h \
 		> build/include/sysexits.h 
 	bindgen --default-macro-constant-type signed --use-core --formatter=none \
-		"$$(printf '#include <sysexits.h>\n' \
-			| cpp -M -idirafter "build/include" - \
-			| sed 's/ /\n/g' | grep sysexits.h)" \
-		| $(RUSTC) $(RUSTFLAGS) --crate-type lib -o build/o/libsysexits.rlib -
-
-build/o/libgetopt.rlib: src/getopt-rs/lib.rs
-	$(RUSTC) $(RUSTFLAGS) --crate-type=lib --crate-name=getopt \
-		-o build/o/libgetopt.rlib src/getopt-rs/lib.rs
+		build/include/sysexits.h | $(RUSTC) $(RUSTFLAGS) --crate-type lib -o $@ -
 
 .PHONY: dj
 dj: build/bin/dj
@@ -69,10 +83,13 @@ build/bin/false: src/false.c build
 
 .PHONY: fop
 fop: build/bin/fop
-build/bin/fop: src/fop.rs build build/o/libgetopt.rlib build/o/libsysexits.rlib
-	$(RUSTC) $(RUSTFLAGS) --extern getopt=build/o/libgetopt.rlib \
-		--extern sysexits=build/o/libsysexits.rlib \
-		-o $@ src/fop.rs
+build/bin/fop: src/fop.rs build rustlibs
+	$(RUSTC) $(RUSTFLAGS) $(RUSTLIBS) -o $@ src/fop.rs
+
+.PHONY: hru
+hru: build/bin/hru
+build/bin/hru: src/hru.rs build rustlibs 
+	$(RUSTC) $(RUSTFLAGS) $(RUSTLIBS) -o $@ src/hru.rs
 
 .PHONY: intcmp
 intcmp: build/bin/intcmp
@@ -81,10 +98,8 @@ build/bin/intcmp: src/intcmp.c build
 
 .PHONY: rpn
 rpn: build/bin/rpn
-build/bin/rpn: src/rpn.rs build build/o/libsysexits.rlib
-	$(RUSTC) $(RUSTFLAGS) \
-		--extern sysexits=build/o/libsysexits.rlib \
-		-o $@ src/rpn.rs
+build/bin/rpn: src/rpn.rs build rustlibs
+	$(RUSTC) $(RUSTFLAGS) $(RUSTLIBS) -o $@ src/rpn.rs
 
 .PHONY: scrut
 scrut: build/bin/scrut

docs/hru.1

@@ -0,0 +1,57 @@
+.\" 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 rpn 1
+
+.SH NAME
+
+hru \(en human readable units
+
+.SH SYNOPSIS
+
+hru
+
+.SH DESCRIPTION
+
+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, hru will exit with
+the appropriate error code as defined by sysexits.h(3) and print an error
+message.
+
+.SH RATIONALE
+
+The GNU project’s ls(1) implementation contains a human-readable option (-h)
+that, when specified, makes the tool print size information in a format more
+immediately readable. This functionality is useful not only in the context of
+ls(1) so the decision was made to split it into a new tool. The original
+functionality in GNU’s ls(1) can be emulated with fop(1) combined with this
+program.
+
+.SH STANDARDS
+
+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
+
+Written by Emma Tebibyte <emma@tebibyte.media>.
+
+.SH COPYRIGHT
+
+Copyright (c) 2024 Emma Tebibyte. License AGPLv3+: GNU AGPL version 3 or later
+<https://gnu.org/licenses/agpl.html>.
+
+.SH SEE ALSO
+
+GNU ls(1), The International System of Units (SI) 9th Edition

src/fop.rs

@@ -22,10 +22,12 @@ use std::{
 	process::{ Command, exit, Stdio },
 };
 
-extern crate sysexits;
 extern crate getopt;
+extern crate strerror;
+extern crate sysexits;
 
 use getopt::{ Opt, Parser };
+use strerror::StrError;
 use sysexits::{ EX_DATAERR, EX_IOERR, EX_UNAVAILABLE, EX_USAGE };
 
 fn main() {
@@ -55,7 +57,7 @@ fn main() {
 	});
 
 	let index = argv[index_arg].parse::<usize>().unwrap_or_else(|e| {
-		eprintln!("{}: {}: {}.", argv[0], argv[1], e);
+		eprintln!("{}: {}: {}", argv[0], argv[1], e);
 		exit(EX_DATAERR);
 	});
 
@@ -75,13 +77,13 @@ fn main() {
 		.stdout(Stdio::piped())
 		.spawn()
 		.unwrap_or_else( |e| {
-			eprintln!("{}: {}: {}.", argv[0], argv[command_arg], e);
+			eprintln!("{}: {}: {}", argv[0], argv[command_arg], e.strerror());
 			exit(EX_UNAVAILABLE);
 		});
 
 	let field = fields.get(index).unwrap_or_else(|| {
 		eprintln!(
-			"{}: {}: No such index in input.",
+			"{}: {}: No such index in input",
 			argv[0],
 			index.to_string(),
 		);
@@ -94,7 +96,7 @@ fn main() {
 	}
 
 	let output = spawned.wait_with_output().unwrap_or_else(|e| {
-		eprintln!("{}: {}: {}.", argv[0], argv[command_arg], e);
+		eprintln!("{}: {}: {}", argv[0], argv[command_arg], e.strerror());
 		exit(EX_IOERR);
 	});
 
@@ -103,7 +105,7 @@ fn main() {
 	if replace.pop() != Some(b'\n') { replace = output.stdout; }
 
 	let new_field = String::from_utf8(replace).unwrap_or_else(|e| {
-		eprintln!("{}: {}: {}.", argv[0], argv[command_arg], e);
+		eprintln!("{}: {}: {}", argv[0], argv[command_arg], e);
 		exit(EX_IOERR);
 	});
 
@@ -111,8 +113,8 @@ fn main() {
 
 	stdout().write_all(
 		fields.join(&d.to_string()).as_bytes()
-	).unwrap_or_else(|e|{
-		eprintln!("{}: {}.", argv[0], e);
+	).unwrap_or_else(|e| {
+		eprintln!("{}: {}", argv[0], e.strerror());
 		exit(EX_IOERR);
 	});
 }

src/hru.rs

@@ -0,0 +1,109 @@
+/*
+ * Copyright (c) 2023–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
+ * 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::{
+	cmp::Ordering,
+	env::args,
+	io::{ stdin, stdout, Write },
+	process::{ ExitCode, exit },
+};
+
+extern crate strerror;
+extern crate sysexits;
+
+use strerror::StrError;
+use sysexits::{ EX_DATAERR, EX_IOERR, EX_SOFTWARE };
+
+const LIST: [(u32, &str); 10] = [
+	(3, "k"),
+	(6, "M"),
+	(9, "G"),
+	(12, "T"),
+	(15, "P"),
+	(18, "E"),
+	(21, "Z"),
+	(24, "Y"),
+	(27, "R"),
+	(30, "Q")
+];
+
+fn convert(input: u128) -> Result<(f64, (u32, &'static str)), String> {
+
+	let mut out = (input as f64, (0_u32, ""));
+	if input < 1000 { return Ok(out); }
+
+	for (n, p) in LIST {
+		let c = match 10_u128.checked_pow(n) {
+			Some(c) => c,
+			None => {
+				return Err(format!("10^{}: Integer overflow", n.to_string()));
+			},
+		};
+
+		match c.cmp(&input) {
+			Ordering::Less => {
+				out = (input as f64 / c as f64, (n, p));
+			},
+			Ordering::Equal => {
+				return Ok((input as f64 / c as f64, (n, p)));
+			},
+			Ordering::Greater => {},
+		};
+	}
+
+	Ok(out)
+}
+
+fn main() -> ExitCode {
+	let argv = args().collect::<Vec<String>>();
+	let mut buf = String::new();
+	while let Ok(_) = stdin().read_line(&mut buf) {
+		if buf.is_empty() { return ExitCode::SUCCESS; }
+
+		let n: u128 = match buf.trim().parse() {
+			Ok(f) => {
+				buf.clear();
+				f
+			},
+			Err(err) => {
+				eprintln!("{}: {}", argv[0], err);
+				return ExitCode::from(EX_DATAERR as u8);
+			},
+		};
+
+		let (number, prefix) = match convert(n) {
+			Ok(x) => x,
+			Err(err) => {
+				eprintln!("{}: {}", argv[0], err);
+				return ExitCode::from(EX_SOFTWARE as u8);
+			},
+		};
+
+		let si_prefix = format!("{}B", prefix.1);
+
+		let out = ((number * 10.0).round() / 10.0).to_string();
+
+		stdout().write_all(format!("{} {}\n", out, si_prefix).as_bytes())
+			.unwrap_or_else(|e| {
+				eprintln!("{}: {}", argv[0], e.strerror());
+				exit(EX_IOERR);
+			});
+	}
+
+	ExitCode::SUCCESS
+}

src/rpn.rs

@@ -172,7 +172,7 @@ fn eval(
 					};
 				} else {
 					return Err(EvaluationError {
-						message: format!("{}: Unexpected operation.", op),
+						message: format!("{}: Unexpected operation", op),
 						code: EX_DATAERR,
 					})
 				}

src/strerror.rs

@@ -0,0 +1,31 @@
+/*
+ * 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.
+ */
+
+use std::ffi::{ c_int, c_char, CStr };
+
+pub trait StrError { fn strerror(&self) -> String; }
+
+impl StrError for std::io::Error {
+	/* wrapper function for use in Rust */
+	fn strerror(&self) -> String {
+		/* Get the raw OS error. If it’s None, what the hell is going on‽ */
+		let errno = self.raw_os_error().unwrap_or(0) as c_int;
+
+		/* Get a CStr from the error message so that it’s referenced and then
+		 * convert it to an owned value. If the string is not valid UTF-8,
+		 * return that error instead. */
+		match unsafe { CStr::from_ptr(strerror(errno)) }.to_str() {
+			Ok(s) => s.to_owned(), // yay!! :D
+			Err(e) => e.to_string(), // awww :(
+		}
+	}
+}
+
+/* binding to strerror(3p) */
+extern "C" { fn strerror(errnum: c_int) -> *mut c_char; }

src/test.rs

@@ -0,0 +1,10 @@
+extern crate strerror;
+
+use strerror::raw_message;
+
+fn main() {
+	stdout.write_all(b"meow\n").unwrap_or_else(|e| {
+		eprintln!("{}", raw_message(e));
+		std::process::exit(1);
+	});
+}