Merge branch 'swab' (closes #22)

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
+Make sure lines never exceed 80 columns in width when using four-character
-using four-character-wide indentation steps.
+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
+For usage text and help messages, do not implement a -h option. Instead, print
-print usage information when any erroneous option is specified. Follow the
+usage information when any erroneous option is specified. Follow the NetBSD
-NetBSD style guide for usage text output format [1].
+style guide for the usage text’s output format [1].
 
-If committing a new source file for a utility, format the commit message like
+[1] <http://cvsweb.netbsd.org/bsdweb.cgi/~checkout~/src/share/misc/style>
-this:
 
-$ 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 'README: clarify'
-$ git commit -m 'tests: posix: fixed bug #47'
+$ git commit -m 'tests/posix: fix bug #47'
-$ git commit -m 'docs: tool(1): added author information'
 
-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

@@ -17,7 +17,7 @@ CC=cc
 RUSTC=rustc
 
 .PHONY: all
-all: dj false fop intcmp rpn scrut str strcmp true
+all: dj false fop hru intcmp rpn scrut str strcmp swab true
 
 build:
 	# keep build/include until bindgen(1) has stdin support
@@ -74,6 +74,13 @@ build/bin/fop: src/fop.rs build build/o/libgetopt.rlib build/o/libsysexits.rlib
 		--extern sysexits=build/o/libsysexits.rlib \
 		-o $@ src/fop.rs
 
+.PHONY: hru
+hru: build/bin/hru
+build/bin/hru: src/hru.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/hru.rs
+
 .PHONY: intcmp
 intcmp: build/bin/intcmp
 build/bin/intcmp: src/intcmp.c build
@@ -101,6 +108,13 @@ 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/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

docs/swab.1

@@ -0,0 +1,71 @@
+.\" 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 swab 1
+
+.SH NAME
+
+swab \(en swap bytes
+
+.SH SYNOPSIS
+
+swab
+.RB ( -f )
+.RB ( -w
+.R [
+.B word size
+.R ])
+
+.SH USAGE
+
+Swab swaps the latter and former halves of a block of bytes.
+
+.SH EXAMPLES
+
+The following sh(1p) line:
+
+.R printf 'hello world!\n' | swab
+
+Produces the following output:
+
+.R ehll oowlr!d
+
+.SH OPTIONS
+
+The
+.B -f
+option ignores system call interruptions.
+.PP
+The
+.B -w
+option 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.
+
+.SH DIAGNOSTICS
+
+If an error is encountered in input, output, or invocation, a diagnostic
+message will be written to standard error and swab will exit with the
+appropriate status from sysexits.h(3).
+
+.SH RATIONALE
+
+Swab was modeled after the
+.R conv=swab
+functionality specified in the POSIX dd utility but additionally allows the
+word size to be configured.
+.PP
+Swab 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)

src/hru.rs

@@ -0,0 +1,107 @@
+/*
+ * 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 sysexits;
+
+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);
+				exit(EX_IOERR);
+			});
+	}
+
+	ExitCode::SUCCESS
+}

src/swab.rs

@@ -0,0 +1,90 @@
+/*
+ * 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)
+		}
+	}
+}