Merge branch 'getopt-bindings'

Makefile, swab(1): fixes swab build
swab(1): fix some silly mistakes
2024-06-29 07:51:01 -06:00 · 2024-06-29 07:49:47 -06:00 · 2024-06-29 06:02:39 -06:00 · 2024-06-28 10:22:20 -06:00 · 2024-06-28 08:33:31 -06:00 · 2024-06-27 14:04:31 -06:00
26 changed files with 289 additions and 1056 deletions
--- a/49
+++ b/49
@@ -8,11 +8,10 @@
 # permitted in any medium without royalty provided the copyright notice and this
 # notice are preserved.  This file is offered as-is, without any warranty.

-.POSIX:
+# The octal escape \043 is utilized twice in this file as make(1p) will
+# interpret a hash in a rule as an inline comment.

-# 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?
+.POSIX:

 DESTDIR ?= dist
 PREFIX ?= /usr/local
@@ -30,12 +29,12 @@ RUSTLIBS = --extern getopt=build/o/libgetopt.rlib \
 CFLAGS += -I$(SYSEXITS)

 .PHONY: all
-all: dj false fop hru intcmp mm npc rpn scrut str strcmp swab true
+all: docs dj false fop hru intcmp mm npc rpn scrut str strcmp swab true

+# keep build/include until bindgen(1) has stdin support
+# https://github.com/rust-lang/rust-bindgen/issues/2703
 build:
-	# keep build/include until bindgen(1) has stdin support
-	# https://github.com/rust-lang/rust-bindgen/issues/2703
-	mkdir -p build/bin build/include build/lib build/o build/test
+	mkdir -p build/bin build/docs build/include build/lib build/o build/test

 .PHONY: clean
 clean:
@@ -44,32 +43,42 @@ clean:
 dist: all
 	mkdir -p $(DESTDIR)/$(PREFIX)/bin $(DESTDIR)/$(PREFIX)/share/man/man1
 	cp build/bin/* $(DESTDIR)/$(PREFIX)/bin
-	cp docs/*.1 $(DESTDIR)/$(PREFIX)/$(MANDIR)/man1
+	cp build/docs/*.1 $(DESTDIR)/$(PREFIX)/$(MANDIR)/man1

 .PHONY: install
 install: dist
 	cp -r $(DESTDIR)/* /

 .PHONY: test
-test: build
+test: build /tmp/getopt
+	/tmp/getopt
 	tests/posix-compat.sh
-	$(RUSTC) --test src/getopt-rs/lib.rs -o build/test/getopt
+
+/tmp/getopt: src/libgetopt.rs
+	$(RUSTC) --test -o /tmp/getopt src/libgetopt.rs
+
+.PHONY: docs
+docs: docs/ build
+	for file in docs/*; do original="$$(sed -n '/^\.TH/p' <"$$file")"; \
+		title="$$(printf '%s\n' "$$original" | sed \
+		"s/X\.X\.X/$$(git describe --tags --long | cut -d'-' -f1)/g")"; \
+		sed "s/$$original/$$title/g" <"$$file" >"build/$$file"; done

 .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
+build/o/libgetopt.rlib: build src/libgetopt.rs
 	$(RUSTC) $(RUSTFLAGS) --crate-type=lib --crate-name=getopt \
-		-o $@ src/getopt-rs/lib.rs
+		-o $@ src/libgetopt.rs

-build/o/libstrerror.rlib: build src/strerror.rs
+build/o/libstrerror.rlib: build src/libstrerror.rs
 	$(RUSTC) $(RUSTFLAGS) --crate-type=lib -o $@ \
-		src/strerror.rs
+		src/libstrerror.rs

+# bandage solution until bindgen(1) gets stdin support
 build/o/libsysexits.rlib: build $(SYSEXITS)sysexits.h
-	# bandage solution until bindgen(1) gets stdin support
-	printf '#define EXIT_FAILURE 1\n' | cat - $(SYSEXITS)sysexits.h \
+	printf '\043define EXIT_FAILURE 1\n' | cat - $(SYSEXITS)sysexits.h \
 		> build/include/sysexits.h 
 	bindgen --default-macro-constant-type signed --use-core --formatter=none \
 		build/include/sysexits.h | $(RUSTC) $(RUSTFLAGS) --crate-type lib -o $@ -
@@ -131,10 +140,8 @@ build/bin/strcmp: src/strcmp.c build

 .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
+build/bin/swab: src/swab.rs build rustlibs
+	$(RUSTC) $(RUSTFLAGS) $(RUSTLIBS) -o $@ src/swab.rs

 .PHONY: true
 true: build/bin/true
--- a/23
+++ b/23
@@ -1,26 +1,27 @@
 “Seek not to walk the path of the masters; seek what they sought.”
 – Matsuo Basho

-The Bonsai core utilities are the result of the careful examination of the
-current state of POSIX and Unix utilies. The Unix Philosophy, “do one thing and
-do it well” is its core but these tools do not cling to the names of the past.
+The Bonsai harakit utilities are a replacement for standard POSIX utilities
+which aim to fill its niche while expanding on their capabilities. These new
+tools are the result of the careful examination of the current state of POSIX
+and Unix utilies. The Unix Philosophy of “do one thing and do it well” are their
+core but they avoid clinging to the past.

 The era of the original Unix tools has been long and fruitful, but they have
-their flaws. The new, non-POSIX era of this project started with frustration
-with the way certain tools work and how other projects that extend POSIX don’t
-make anything better.
+their flaws. This project originated from frustrations with the way certain
+tools work and how other projects that extend POSIX don’t make anything better.

 This project will not follow in the footsteps of GNU; extensions of POSIX will
 not be found here. GNU extensions are a gateway to the misuse of the shell. The
-Bonsai core utilities will intentionally discourage use of the shell for
-purposes beyond its scope.
+harakit utilities will intentionally discourage use of the shell for purposes
+beyond its scope.

 See docs/ for more on the specific utilities currently implemented.

 Building

-The coreutils require a POSIX-compliant environment to compile, including a C
-compiler and preprocessor (cc(1) and cpp(1) by default), an edition 2023 Rust
+Harakit utilities require a POSIX-compliant environment to compile, including a
+C compiler and preprocessor (cc(1) and cpp(1) by default), an edition 2023 Rust
 compiler (rustc(1) by default), bindgen(1), and a POSIX-compliant make(1)
 utility.

@@ -38,7 +39,7 @@ To test the utilities:

 $ make test

-To remove all untracked files:
+To remove all build and distributable files:

 $ make clean

--- a/docs/dj.1
+++ b/docs/dj.1
@@ -4,7 +4,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 DJ 1 2024-06-17 "Bonsai Core Utilites 0.13.9"
+.TH DJ 1 2024-06-17 "Harakit X.X.X"
 .SH NAME
 dj \(en disk jockey
 .\"
--- a/docs/false.1
+++ b/docs/false.1
@@ -4,7 +4,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 FALSE 1 2024-06-06 "Bonsai Core Utilites 0.13.9"
+.TH FALSE 1 2024-06-06 "Harakit X.X.X"
 .SH NAME
 false \(en do nothing, unsuccessfully
 .\"
--- a/docs/fop.1
+++ b/docs/fop.1
@@ -4,7 +4,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 FOP 1 2024-06-17 "Bonsai Core Utilites 0.13.9"
+.TH FOP 1 2024-06-17 "Harakit X.X.X"
 .SH NAME
 fop \(en field operator
 .\"
--- a/docs/hru.1
+++ b/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 2024-06-17 "Bonsai Core Utilites 0.13.9"
+.TH HRU 1 2024-06-17 "Harakit X.X.X"
 .SH NAME
 hru \(en human readable units
 .\"
--- a/docs/intcmp.1
+++ b/docs/intcmp.1
@@ -4,7 +4,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 INTCMP 1 2024-06-06 "Bonsai Core Utilites 0.13.9"
+.TH INTCMP 1 2024-06-06 "Harakit X.X.X"
 .SH NAME
 intcmp \(en compare integers
 .\"
--- a/docs/mm.1
+++ b/docs/mm.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 MM 1 2024-06-17 "Bonsai Core Utilites 0.13.9"
+.TH MM 1 2024-06-17 "Harakit X.X.X"
 .SH NAME
 mm \(en middleman
 .\"
--- a/docs/npc.1
+++ b/docs/npc.1
@@ -4,7 +4,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 NPC 1 2024-06-17 "Bonsai Core Utilites 0.13.9"
+.TH NPC 1 2024-06-17 "Harakit X.X.X"
 .SH NAME
 npc \(en show non-printing characters
 .\"
--- a/docs/rpn.1
+++ b/docs/rpn.1
@@ -4,7 +4,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 RPN 1 2024-06-17 "Bonsai Core Utilites 0.13.9"
+.TH RPN 1 2024-06-17 "Harakit X.X.X"
 .SH NAME
 rpn \(en reverse polish notation evaluation
 .\"
--- a/docs/scrut.1
+++ b/docs/scrut.1
@@ -4,7 +4,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 SCRUT 1 2024-06-06 "Bonsai Core Utilites 0.13.9"
+.TH SCRUT 1 2024-06-06 "Harakit X.X.X"
 .SH NAME
 scrut \(en scrutinize file properties
 .SH SYNOPSIS
--- a/docs/str.1
+++ b/docs/str.1
@@ -4,7 +4,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 STR 1 2024-06-17 "Bonsai Core Utilites 0.13.9"
+.TH STR 1 2024-06-17 "Harakit X.X.X"
 .SH NAME
 str \(en test string arguments
 .\"
--- a/docs/strcmp.1
+++ b/docs/strcmp.1
@@ -4,7 +4,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 STRCMP 1 2024-06-17 "Bonsai Core Utilites 0.13.9"
+.TH STRCMP 1 2024-06-17 "Harakit X.X.X"
 .SH NAME
 strcmp \(en compare strings
 .\"
--- a/docs/swab.1
+++ b/docs/swab.1
@@ -4,7 +4,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 SWAB 1 2024-06-17 "Bonsai Core Utilites 0.13.9"
+.TH SWAB 1 2024-06-17 "Harakit X.X.X"
 .SH NAME
 swab \(en swap bytes
 .\"
--- a/docs/true.1
+++ b/docs/true.1
@@ -4,7 +4,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 TRUE 1 2024-06-06 "Bonsai Core Utilites 0.13.9"
+.TH TRUE 1 2024-06-06 "Harakit X.X.X"
 .SH NAME
 true \(en do nothing, successfully
 .\"
--- a/src/fop.rs
+++ b/src/fop.rs
@@ -26,27 +26,39 @@ extern crate getopt;
 extern crate strerror;
 extern crate sysexits;

-use getopt::{ Opt, Parser };
+use getopt::GetOpt;
 use strerror::StrError;
 use sysexits::{ EX_DATAERR, EX_IOERR, EX_UNAVAILABLE, EX_USAGE };

 fn main() {
 	let argv = args().collect::<Vec<String>>();
-	let mut d = 0x1E.to_string();
-	let mut arg_parser = Parser::new(&argv, "d:");
+	let mut d = '\u{1E}'.to_string();
+	let mut index_arg = 0;

-	while let Some(opt) = arg_parser.next() {
-		match opt {
-			Ok(Opt('d', Some(arg))) => d = arg,
-			_ => {},
+	let usage = format!(
+		"Usage: {} [-d delimiter] index command [args...]",
+		argv[0],
+	);
+
+	while let Some(opt) = argv.getopt("d:") {
+		match opt.opt() {
+			Ok(_) => {
+				/* unwrap because Err(OptError::MissingArg) will be returned if
+				 * opt.arg() is None */
+				d = opt.arg().unwrap();
+				index_arg = opt.ind();
+			},
+			Err(_) => {
+				eprintln!("{}", usage);
+				exit(EX_USAGE);
+			}
 		};
 	}

-	let index_arg = arg_parser.index();
-	let command_arg = arg_parser.index() + 1;
+	let command_arg = index_arg as usize + 1;

 	argv.get(command_arg).unwrap_or_else(|| {
-		eprintln!("Usage: {} [-d delimiter] index command [args...]", argv[0]);
+		eprintln!("{}", usage);
 		exit(EX_USAGE);
 	});

--- a/src/getopt-rs/error.rs
+++ b/src/getopt-rs/error.rs
@@ -1,95 +0,0 @@
-/*
- * Copyright (c) 2023 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/.
- *
- * This file incorporates work covered by the following copyright and permission
- * notice:
- *     The Clear BSD License
- *
- *     Copyright © 2017-2023 David Wildasin
- *     All rights reserved.
- *
- *     Redistribution and use in source and binary forms, with or without
- *     modification, are permitted (subject to the limitations in the disclaimer
- *     below) provided that the following conditions are met:
- *
- *          * Redistributions of source code must retain the above copyright
- *          notice, this list of conditions, and the following disclaimer.
- *
- *          * Redistributions in binary form must reproduce the above copyright
- *          notice, this list of conditions, and the following disclaimer in the
- *          documentation and/or other materials provided with the distribution.
- *
- *          * Neither the name of the copyright holder nor the names of its
- *          contributors may be used to endorse or promote products derived from
- *          this software without specific prior written permission.
- *
- *     NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED
- *     BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
- *     CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,
- *     BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
- *     FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
- *     HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- *     SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
- *     TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
- *     PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
- *     LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
- *     NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
- *     SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
-
-use std::{ error, fmt };
-
-use crate::ErrorKind::{ self, * };
-
-/// A basic error type for [`Parser`](struct.Parser.html)
-#[derive(Debug, Eq, PartialEq)]
-pub struct Error {
-    culprit: char,
-    kind: ErrorKind,
-}
-
-impl Error {
-    /// Creates a new error using a known kind and the character that caused the
-	/// issue.
-    pub fn new(kind: ErrorKind, culprit: char) -> Self {
-        Self { culprit, kind }
-    }
-
-    /// Returns the [`ErrorKind`](enum.ErrorKind.html) for this error.
-    pub fn kind(self) -> ErrorKind {
-        self.kind
-    }
-}
-
-impl fmt::Display for Error {
-    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
-        match self.kind {
-            MissingArgument => write!(
-				f, 
-				"option requires an argument -- {:?}",
-				self.culprit,
-			),
-            UnknownOption => write!(f, "unknown option -- {:?}", self.culprit),
-        }
-    }
-}
-
-impl error::Error for Error {
-    fn source(&self) -> Option<&(dyn error::Error + 'static)> {
-        None
-    }
-}
--- a/src/getopt-rs/errorkind.rs
+++ b/src/getopt-rs/errorkind.rs
@@ -1,61 +0,0 @@
-/*
- * Copyright (c) 2023 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/.
- *
- * This file incorporates work covered by the following copyright and permission
- * notice:
- *     The Clear BSD License
- *
- *     Copyright © 2017-2023 David Wildasin
- *     All rights reserved.
- *
- *     Redistribution and use in source and binary forms, with or without
- *     modification, are permitted (subject to the limitations in the disclaimer
- *     below) provided that the following conditions are met:
- *
- *          * Redistributions of source code must retain the above copyright
- *          notice, this list of conditions, and the following disclaimer.
- *
- *          * Redistributions in binary form must reproduce the above copyright
- *          notice, this list of conditions, and the following disclaimer in the
- *          documentation and/or other materials provided with the distribution.
- *
- *          * Neither the name of the copyright holder nor the names of its
- *          contributors may be used to endorse or promote products derived from
- *          this software without specific prior written permission.
- *
- *     NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED
- *     BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
- *     CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,
- *     BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
- *     FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
- *     HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- *     SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
- *     TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
- *     PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
- *     LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
- *     NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
- *     SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
-
-/// What kinds of errors [`Parser`](struct.Parser.html) can return.
-#[derive(Debug, Eq, PartialEq)]
-pub enum ErrorKind {
-    /// An argument was not found for an option that was expecting one.
-    MissingArgument,
-    /// An unknown option character was encountered.
-    UnknownOption,
-}
--- a/src/getopt-rs/lib.rs
+++ b/src/getopt-rs/lib.rs
@@ -1,72 +0,0 @@
-/*
- * Copyright (c) 2023 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/.
- *
- * This file incorporates work covered by the following copyright and permission
- * notice:
- *     The Clear BSD License
- *
- *     Copyright © 2017-2023 David Wildasin
- *     All rights reserved.
- *
- *     Redistribution and use in source and binary forms, with or without
- *     modification, are permitted (subject to the limitations in the disclaimer
- *     below) provided that the following conditions are met:
- *
- *          * Redistributions of source code must retain the above copyright
- *          notice, this list of conditions, and the following disclaimer.
- *
- *          * Redistributions in binary form must reproduce the above copyright
- *          notice, this list of conditions, and the following disclaimer in the
- *          documentation and/or other materials provided with the distribution.
- *
- *          * Neither the name of the copyright holder nor the names of its
- *          contributors may be used to endorse or promote products derived from
- *          this software without specific prior written permission.
- *
- *     NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED
- *     BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
- *     CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,
- *     BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
- *     FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
- *     HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- *     SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
- *     TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
- *     PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
- *     LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
- *     NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
- *     SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
-
-//! # getopt
-//!
-//! `getopt` provides a minimal, (essentially) POSIX-compliant option parser.
-
-pub use crate::{
-	error::Error,
-	errorkind::ErrorKind,
-	opt::Opt,
-	parser::Parser,
-	result::Result
-};
-
-mod error;
-mod errorkind;
-mod opt;
-mod parser;
-mod result;
-#[cfg(test)]
-mod tests;
--- a/src/getopt-rs/opt.rs
+++ b/src/getopt-rs/opt.rs
@@ -1,89 +0,0 @@
-/*
- * Copyright (c) 2023 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/.
- *
- * This file incorporates work covered by the following copyright and permission
- * notice:
- *     The Clear BSD License
- *
- *     Copyright © 2017-2023 David Wildasin
- *     All rights reserved.
- *
- *     Redistribution and use in source and binary forms, with or without
- *     modification, are permitted (subject to the limitations in the disclaimer
- *     below) provided that the following conditions are met:
- *
- *          * Redistributions of source code must retain the above copyright
- *          notice, this list of conditions, and the following disclaimer.
- *
- *          * Redistributions in binary form must reproduce the above copyright
- *          notice, this list of conditions, and the following disclaimer in the
- *          documentation and/or other materials provided with the distribution.
- *
- *          * Neither the name of the copyright holder nor the names of its
- *          contributors may be used to endorse or promote products derived from
- *          this software without specific prior written permission.
- *
- *     NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED
- *     BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
- *     CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,
- *     BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
- *     FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
- *     HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- *     SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
- *     TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
- *     PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
- *     LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
- *     NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
- *     SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
-
-use std::fmt;
-
-/// A single option.
-///
-/// For `Opt(x, y)`:
-///   - `x` is the character representing the option.
-///   - `y` is `Some` string, or `None` if no argument was expected.
-///
-/// # Example
-///
-/// ```
-/// # fn main() -> Result<(), Box<dyn std::error::Error>> {
-/// use getopt::Opt;
-///
-/// // args = ["program", "-abc", "foo"];
-/// # let args: Vec<String> = vec!["program", "-abc", "foo"]
-/// #     .into_iter()
-/// #     .map(String::from)
-/// #     .collect();
-/// let optstring = "ab:c";
-/// let mut opts = getopt::Parser::new(&args, optstring);
-///
-/// assert_eq!(Opt('a', None), opts.next().transpose()?.unwrap());
-/// assert_eq!(Opt('b', Some("c".to_string())), opts.next().transpose()?.unwrap());
-/// assert_eq!(None, opts.next().transpose()?);
-/// # Ok(())
-/// # }
-/// ```
-#[derive(Debug, Eq, Ord, PartialEq, PartialOrd)]
-pub struct Opt(pub char, pub Option<String>);
-
-impl fmt::Display for Opt {
-    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
-        write!(f, "Opt({:?}, {:?})", self.0, self.1)
-    }
-}
--- a/src/getopt-rs/parser.rs
+++ b/src/getopt-rs/parser.rs
@@ -1,382 +0,0 @@
-/*
- * Copyright (c) 2023 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/.
- *
- * This file incorporates work covered by the following copyright and permission
- * notice:
- *     The Clear BSD License
- *
- *     Copyright © 2017-2023 David Wildasin
- *     All rights reserved.
- *
- *     Redistribution and use in source and binary forms, with or without
- *     modification, are permitted (subject to the limitations in the disclaimer
- *     below) provided that the following conditions are met:
- *
- *          * Redistributions of source code must retain the above copyright
- *          notice, this list of conditions, and the following disclaimer.
- *
- *          * Redistributions in binary form must reproduce the above copyright
- *          notice, this list of conditions, and the following disclaimer in the
- *          documentation and/or other materials provided with the distribution.
- *
- *          * Neither the name of the copyright holder nor the names of its
- *          contributors may be used to endorse or promote products derived from
- *          this software without specific prior written permission.
- *
- *     NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED
- *     BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
- *     CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,
- *     BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
- *     FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
- *     HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- *     SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
- *     TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
- *     PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
- *     LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
- *     NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
- *     SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
-
-use std::collections::HashMap;
-
-use crate::{ error::Error, errorkind::ErrorKind, opt::Opt, result::Result };
-
-/// The core of the `getopt` crate.
-///
-/// `Parser` is implemented as an iterator over the options present in the given
-/// argument vector.
-///
-/// The method [`next`](#method.next) does the heavy lifting.
-///
-/// # Examples
-///
-/// ## Simplified usage:
-/// ```
-/// # fn main() -> Result<(), Box<dyn std::error::Error>> {
-/// use getopt::Opt;
-///
-/// // args = ["program", "-abc", "foo"];
-/// # let args: Vec<String> = vec!["program", "-abc", "foo"]
-/// #     .into_iter()
-/// #     .map(String::from)
-/// #     .collect();
-/// let mut opts = getopt::Parser::new(&args, "ab:c");
-///
-/// assert_eq!(Some(Opt('a', None)), opts.next().transpose()?);
-/// assert_eq!(1, opts.index());
-/// assert_eq!(Some(Opt('b', Some("c".to_string()))), opts.next().transpose()?);
-/// assert_eq!(2, opts.index());
-/// assert_eq!(None, opts.next());
-/// assert_eq!(2, opts.index());
-/// assert_eq!("foo", args[opts.index()]);
-/// # Ok(())
-/// # }
-/// ```
-///
-/// ## A more idiomatic example:
-/// ```
-/// # fn main() -> Result<(), Box<dyn std::error::Error>> {
-/// use getopt::Opt;
-///
-/// // args = ["program", "-abc", "-d", "foo", "-e", "bar"];
-/// # let mut args: Vec<String> = vec!["program", "-abc", "-d", "foo", "-e", "bar"]
-/// #     .into_iter()
-/// #     .map(String::from)
-/// #     .collect();
-/// let mut opts = getopt::Parser::new(&args, "ab:cd:e");
-///
-/// let mut a_flag = false;
-/// let mut b_flag = String::new();
-/// let mut c_flag = false;
-/// let mut d_flag = String::new();
-/// let mut e_flag = false;
-///
-/// loop {
-///     match opts.next().transpose()? {
-///         None => break,
-///         Some(opt) => match opt {
-///             Opt('a', None) => a_flag = true,
-///             Opt('b', Some(arg)) => b_flag = arg.clone(),
-///             Opt('c', None) => c_flag = true,
-///             Opt('d', Some(arg)) => d_flag = arg.clone(),
-///             Opt('e', None) => e_flag = true,
-///             _ => unreachable!(),
-///         },
-///     }
-/// }
-///
-/// let new_args = args.split_off(opts.index());
-///
-/// assert_eq!(true, a_flag);
-/// assert_eq!("c", b_flag);
-/// assert_eq!(false, c_flag);
-/// assert_eq!("foo", d_flag);
-/// assert_eq!(true, e_flag);
-///
-/// assert_eq!(1, new_args.len());
-/// assert_eq!("bar", new_args.first().unwrap());
-/// # Ok(())
-/// # }
-/// ```
-#[derive(Debug, Eq, PartialEq)]
-pub struct Parser {
-    opts: HashMap<char, bool>,
-    args: Vec<Vec<char>>,
-    index: usize,
-    point: usize,
-}
-
-impl Parser {
-    /// Create a new `Parser`, which will process the arguments in `args`
-	/// according to the options specified in `optstring`.
-    ///
-    /// For compatibility with
-	/// [`std::env::args`](https://doc.rust-lang.org/std/env/fn.args.html),
-    /// valid options are expected to begin at the second element of `args`, and
-	/// `index` is
-    /// initialised to `1`.
-    /// If `args` is structured differently, be sure to call
-	/// [`set_index`](#method.set_index) before the first invocation of
-	/// [`next`](#method.next).
-    ///
-    /// `optstring` is a string of recognised option characters; if a character
-	/// is followed by a colon (`:`), that option takes an argument.
-    ///
-    /// # Note:
-    /// Transforming the OS-specific argument strings into a vector of `String`s
-	/// is the sole responsibility of the calling program, as it involves some
-	/// level of potential information loss (which this crate does not presume
-	/// to handle unilaterally) and error handling (which would complicate the
-	/// interface).
-    pub fn new(args: &[String], optstring: &str) -> Self {
-        let optstring: Vec<char> = optstring.chars().collect();
-        let mut opts = HashMap::new();
-        let mut i = 0;
-        let len = optstring.len();
-
-        while i < len {
-            let j = i + 1;
-
-            if j < len && optstring[j] == ':' {
-                opts.insert(optstring[i], true);
-                i += 1;
-            } else {
-                opts.insert(optstring[i], false);
-            }
-            i += 1;
-        }
-
-        Self {
-            opts,
-            // "explode" the args into a vector of character vectors, to allow
-			// indexing
-            args: args.iter().map(|e| e.chars().collect()).collect(),
-            index: 1,
-            point: 0,
-        }
-    }
-
-    /// Return the current `index` of the parser.
-    ///
-    /// `args[index]` will always point to the the next element of `args`; when
-	/// the parser is
-    /// finished with an element, it will increment `index`.
-    ///
-    /// After the last option has been parsed (and [`next`](#method.next) is
-	/// returning `None`),
-    /// `index` will point to the first non-option argument.
-    pub fn index(&self) -> usize {
-        self.index
-    }
-
-    // `point` must be reset to 0 whenever `index` is changed
-
-    /// Modify the current `index` of the parser.
-    pub fn set_index(&mut self, value: usize) {
-        self.index = value;
-        self.point = 0;
-    }
-
-    /// Increment the current `index` of the parser.
-    ///
-    /// This use case is common enough to warrant its own optimised method.
-    pub fn incr_index(&mut self) {
-        self.index += 1;
-        self.point = 0;
-    }
-}
-
-impl Iterator for Parser {
-    type Item = Result<Opt>;
-
-    /// Returns the next option, if any.
-    ///
-    /// Returns an [`Error`](struct.Error.html) if an unexpected option is
-	/// encountered or if an
-    /// expected argument is not found.
-    ///
-    /// Parsing stops at the first non-hyphenated argument; or at the first
-	/// argument matching "-";
-    /// or after the first argument matching "--".
-    ///
-    /// When no more options are available, `next` returns `None`.
-    ///
-    /// # Examples
-    ///
-    /// ## "-"
-    /// ```
-    /// use getopt::Parser;
-    ///
-    /// // args = ["program", "-", "-a"];
-    /// # let args: Vec<String> = vec!["program", "-", "-a"]
-    /// #     .into_iter()
-    /// #     .map(String::from)
-    /// #     .collect();
-    /// let mut opts = Parser::new(&args, "a");
-    ///
-    /// assert_eq!(None, opts.next());
-    /// assert_eq!("-", args[opts.index()]);
-    /// ```
-    ///
-    /// ## "--"
-    /// ```
-    /// use getopt::Parser;
-    ///
-    /// // args = ["program", "--", "-a"];
-    /// # let args: Vec<String> = vec!["program", "--", "-a"]
-    /// #     .into_iter()
-    /// #     .map(String::from)
-    /// #     .collect();
-    /// let mut opts = Parser::new(&args, "a");
-    ///
-    /// assert_eq!(None, opts.next());
-    /// assert_eq!("-a", args[opts.index()]);
-    /// ```
-    ///
-    /// ## Unexpected option:
-    /// ```
-    /// use getopt::Parser;
-    ///
-    /// // args = ["program", "-b"];
-    /// # let args: Vec<String> = vec!["program", "-b"]
-    /// #     .into_iter()
-    /// #     .map(String::from)
-    /// #     .collect();
-    /// let mut opts = Parser::new(&args, "a");
-    ///
-    /// assert_eq!(
-    ///     "unknown option -- 'b'".to_string(),
-    ///     opts.next().unwrap().unwrap_err().to_string()
-    /// );
-    /// ```
-    ///
-    /// ## Missing argument:
-    /// ```
-    /// use getopt::Parser;
-    ///
-    /// // args = ["program", "-a"];
-    /// # let args: Vec<String> = vec!["program", "-a"]
-    /// #     .into_iter()
-    /// #     .map(String::from)
-    /// #     .collect();
-    /// let mut opts = Parser::new(&args, "a:");
-    ///
-    /// assert_eq!(
-    ///     "option requires an argument -- 'a'".to_string(),
-    ///     opts.next().unwrap().unwrap_err().to_string()
-    /// );
-    /// ```
-    fn next(&mut self) -> Option<Result<Opt>> {
-        if self.point == 0 {
-            /*
-             * Rationale excerpts below taken verbatim from "The Open Group Base
-			 * Specifications Issue 7, 2018 edition", IEEE Std 1003.1-2017
-			 * (Revision of IEEE Std 1003.1-2008).
-             * Copyright © 2001-2018 IEEE and The Open Group.
-             */
-
-            /*
-             * If, when getopt() is called:
-             *      argv[optind]    is a null pointer
-             *      *argv[optind]   is not the character '-'
-             *      argv[optind]    points to the string "-"
-             * getopt() shall return -1 without changing optind.
-             */
-            if self.index >= self.args.len()
-                || self.args[self.index].is_empty()
-                || self.args[self.index][0] != '-'
-                || self.args[self.index].len() == 1
-            {
-                return None;
-            }
-
-            /*
-             * If:
-             *      argv[optind]    points to the string "--"
-             * getopt() shall return -1 after incrementing index.
-             */
-            if self.args[self.index][1] == '-' && self.args[self.index].len() == 2 {
-                self.incr_index();
-                return None;
-            }
-
-            // move past the starting '-'
-            self.point += 1;
-        }
-
-        let opt = self.args[self.index][self.point];
-        self.point += 1;
-
-        match self.opts.get(&opt) {
-            None => {
-                if self.point >= self.args[self.index].len() {
-                    self.incr_index();
-                }
-                Some(Err(Error::new(ErrorKind::UnknownOption, opt)))
-            }
-            Some(false) => {
-                if self.point >= self.args[self.index].len() {
-                    self.incr_index();
-                }
-
-                Some(Ok(Opt(opt, None)))
-            }
-            Some(true) => {
-                let arg: String = if self.point >= self.args[self.index].len() {
-                    self.incr_index();
-                    if self.index >= self.args.len() {
-                        return Some(Err(Error::new(
-									ErrorKind::MissingArgument,
-									opt,
-								)));
-                    }
-                    self.args[self.index].iter().collect()
-                } else {
-                    self.args[self.index]
-                        .clone()
-                        .split_off(self.point)
-                        .iter()
-                        .collect()
-                };
-
-                self.incr_index();
-
-                Some(Ok(Opt(opt, Some(arg))))
-            }
-        }
-    }
-}
--- a/src/getopt-rs/result.rs
+++ b/src/getopt-rs/result.rs
@@ -1,59 +0,0 @@
-/*
- * Copyright (c) 2023 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/.
- *
- * This file incorporates work covered by the following copyright and permission
- * notice:
- *     The Clear BSD License
- *
- *     Copyright © 2017-2023 David Wildasin
- *     All rights reserved.
- *
- *     Redistribution and use in source and binary forms, with or without
- *     modification, are permitted (subject to the limitations in the disclaimer
- *     below) provided that the following conditions are met:
- *
- *          * Redistributions of source code must retain the above copyright
- *          notice, this list of conditions, and the following disclaimer.
- *
- *          * Redistributions in binary form must reproduce the above copyright
- *          notice, this list of conditions, and the following disclaimer in the
- *          documentation and/or other materials provided with the distribution.
- *
- *          * Neither the name of the copyright holder nor the names of its
- *          contributors may be used to endorse or promote products derived from
- *          this software without specific prior written permission.
- *
- *     NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED
- *     BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
- *     CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,
- *     BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
- *     FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
- *     HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- *     SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
- *     TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
- *     PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
- *     LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
- *     NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
- *     SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
-
-use std::result;
-
-use crate::error::Error;
-
-/// A specialized `Result` type for use with [`Parser`](struct.Parser.html)
-pub type Result<T> = result::Result<T, Error>;
--- a/src/getopt-rs/tests.rs
+++ b/src/getopt-rs/tests.rs
@@ -1,228 +0,0 @@
-/*
- * Copyright (c) 2023 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/.
- *
- * This file incorporates work covered by the following copyright and permission
- * notice:
- *     The Clear BSD License
- *
- *     Copyright © 2017-2023 David Wildasin
- *     All rights reserved.
- *
- *     Redistribution and use in source and binary forms, with or without
- *     modification, are permitted (subject to the limitations in the disclaimer
- *     below) provided that the following conditions are met:
- *
- *          * Redistributions of source code must retain the above copyright
- *          notice, this list of conditions, and the following disclaimer.
- *
- *          * Redistributions in binary form must reproduce the above copyright
- *          notice, this list of conditions, and the following disclaimer in the
- *          documentation and/or other materials provided with the distribution.
- *
- *          * Neither the name of the copyright holder nor the names of its
- *          contributors may be used to endorse or promote products derived from
- *          this software without specific prior written permission.
- *
- *     NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED
- *     BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
- *     CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,
- *     BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
- *     FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
- *     HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- *     SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
- *     TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
- *     PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
- *     LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
- *     NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
- *     SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
-
-use crate::{Opt, Parser};
-
-macro_rules! basic_test {
-    ($name:ident, $expect:expr, $next:expr, [$($arg:expr),+], $optstr:expr) => (
-        #[test]
-        fn $name() -> Result<(), String> {
-            let expect: Option<Opt> = $expect;
-            let args: Vec<String> = vec![$($arg),+]
-				.into_iter()
-				.map(String::from)
-				.collect();
-            let next: Option<String> = $next;
-            let mut opts = Parser::new(&args, $optstr);
-
-            match opts.next().transpose() {
-                Err(error) => {
-                    return Err(format!("next() returned {:?}", error))
-                },
-                Ok(actual) => if actual != expect {
-                    return Err(
-						format!("expected {:?}; got {:?}", expect, actual)
-					)
-                },
-            };
-
-            match next {
-                None => if opts.index() < args.len() {
-                    return Err(format!(
-							"expected end of args; got {:?}", args[opts.index()]
-					))
-                },
-                Some(n) => if args[opts.index()] != n {
-                    return Err(format!(
-							"next arg: expected {:?}; got {:?}",
-							n,
-							args[opts.index()]
-					))
-                },
-            };
-
-            Ok(())
-        }
-    )
-}
-
-#[rustfmt::skip] basic_test!(
-	blank_arg, None, Some(String::new()), ["x", ""], "a"
-);
-#[rustfmt::skip] basic_test!(
-	double_dash, None, Some("-a".to_string()), ["x", "--", "-a", "foo"], "a"
-);
-#[rustfmt::skip] basic_test!(no_opts_1, None, None, ["x"], "a");
-#[rustfmt::skip] basic_test!(
-	no_opts_2, None, Some("foo".to_string()), ["x", "foo"], "a"
-);
-#[rustfmt::skip] basic_test!(
-	no_opts_3, None, Some("foo".to_string()), ["x", "foo", "-a"], "a"
-);
-#[rustfmt::skip] basic_test!(
-	single_dash, None, Some("-".to_string()), ["x", "-", "-a", "foo"], "a"
-);
-#[rustfmt::skip] basic_test!(
-	single_opt,
-	Some(Opt('a', None)),
-	Some("foo".to_string()),
-	["x", "-a", "foo"],
-	"a"
-);
-#[rustfmt::skip] basic_test!(
-	single_optarg,
-	Some(Opt('a', Some("foo".to_string()))),
-	None,
-	["x", "-a", "foo"],
-	"a:"
-);
-
-macro_rules! error_test {
-    ($name:ident, $expect:expr, [$($arg:expr),+], $optstr:expr) => (
-        #[test]
-        fn $name() -> Result<(), String> {
-            let expect: String = $expect.to_string();
-            let args: Vec<String> = vec![$($arg),+]
-				.into_iter()
-				.map(String::from)
-				.collect();
-            let mut opts = Parser::new(&args, $optstr);
-
-            match opts.next() {
-                None => {
-                    return Err(format!(
-							"unexpected successful response: end of options"
-					))
-                },
-                Some(Err(actual)) => {
-                    let actual = actual.to_string();
-
-                    if actual != expect {
-                        return Err(
-							format!("expected {:?}; got {:?}", expect, actual)
-						);
-                    }
-                },
-                Some(Ok(opt)) => {
-                    return Err(
-						format!("unexpected successful response: {:?}", opt)
-					)
-                },
-            };
-
-            Ok(())
-        }
-    )
-}
-
-#[rustfmt::skip] error_test!(
-	bad_opt,
-	"unknown option -- 'b'",
-	["x", "-b"],
-	"a"
-);
-
-#[rustfmt::skip] error_test!(
-	missing_optarg,
-	"option requires an argument -- 'a'",
-	["x", "-a"],
-	"a:"
-);
-
-#[test]
-fn multiple() -> Result<(), String> {
-    let args: Vec<String> = vec!["x", "-abc", "-d", "foo", "-e", "bar"]
-        .into_iter()
-        .map(String::from)
-        .collect();
-    let optstring = "ab:d:e".to_string();
-    let mut opts = Parser::new(&args, &optstring);
-
-    macro_rules! check_result {
-        ($expect:expr) => {
-            let expect: Option<Opt> = $expect;
-            match opts.next().transpose() {
-                Err(error) => {
-					return Err(format!("next() returned {:?}", error));
-				},
-                Ok(actual) => {
-                    if actual != expect {
-                        return Err(
-							format!("expected {:?}; got {:?}", expect, actual)
-						);
-                    }
-                }
-            };
-        };
-    }
-
-    check_result!(Some(Opt('a', None)));
-    check_result!(Some(Opt('b', Some("c".to_string()))));
-    check_result!(Some(Opt('d', Some("foo".to_string()))));
-    check_result!(Some(Opt('e', None)));
-    check_result!(None);
-
-    Ok(())
-}
-
-#[test]
-fn continue_after_error() {
-    let args: Vec<String> = vec!["x", "-z", "-abc"]
-        .into_iter()
-        .map(String::from)
-        .collect();
-    let optstring = "ab:d:e".to_string();
-    for _opt in Parser::new(&args, &optstring) {
-        // do nothing, should not panic
-    }
-}
--- a/src/libgetopt.rs
+++ b/src/libgetopt.rs
@@ -0,0 +1,202 @@
+/*
+ * 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::ffi::{ c_int, c_char, CString, CStr };
+
+/* binding to getopt(3p) */
+extern "C" {
+	static mut optarg: *mut c_char;
+	static mut _opterr: c_int;
+	static mut optind: c_int;
+	static mut optopt: c_int;
+
+	fn getopt(
+		___argc: c_int,
+		___argv: *const *mut c_char,
+		__shortopts: *const c_char,
+	) -> c_int;
+}
+
+#[derive(Clone, Debug)]
+pub enum OptError {
+	MissingArg(String),
+	UnknownOpt(String),
+}
+
+#[derive(Clone, Debug)]
+pub struct Opt {
+	arg: Option<String>, /* option argument */
+	ind: *mut i32, /* option index */
+	opt: Result<String, OptError>, /* option option */
+}
+
+impl Opt {
+	pub fn arg(&self) -> Option<String> { self.arg.clone() }
+
+	/* sets optarg if default is desired */
+	pub fn arg_or(&self, default: impl std::fmt::Display) -> String {
+		default.to_string()
+	}
+
+	/* makes matching the output of this method more bearable */
+	pub fn opt(&self) -> Result<&str, OptError> {
+		self.opt.as_ref().map(|o| o.as_str()).map_err(OptError::clone)
+	}
+
+	/* From getopt(3p):
+	 *
+	 * The variable optind is the index of the next element of the argv[]
+	 * vector to be processed. It shall be initialized to 1 by the system, and
+	 * getopt() shall update it when it finishes with each element of argv[].
+	 * If the application sets optind to zero  before calling getopt(), the
+	 * behavior is unspecified. When an element of argv[] contains multiple
+	 * option characters, it is unspecified how getopt() determines which
+	 * options have already been processed. */
+	pub fn ind(&self) -> usize { unsafe { *self.ind as usize } }
+
+	/* this is patently terrible and is only happening because I’m stubborn */
+	pub fn set_ind(&self, ind: i32) { unsafe { *self.ind = ind; } }
+}
+
+/* function signature */
+pub trait GetOpt {
+	fn getopt(&self, optstring: &str) -> Option<Opt>;
+}
+
+impl GetOpt for Vec<String> {
+    fn getopt(&self, optstring: &str) -> Option<Opt> {
+        let c_strings: Vec<_> = self
+			.iter()
+			.cloned()
+			.map(|x| CString::new(x).unwrap().into_raw())
+			.collect();
+
+		/* god knows what this does */
+		let boxed = Box::into_raw(c_strings.into_boxed_slice());
+		let argv = boxed as *const *mut c_char;
+
+		/* operations are separated out so that everything lives long enough */
+        let opts = CString::new(optstring).unwrap().into_raw();
+        let len = self.len() as c_int;
+
+        unsafe {
+            let ret = match getopt(len, argv, opts) { 
+				/* From getopt(3p):
+				 *
+				 * The getopt() function shall return the next option character
+				 * specified on the command line.
+				 *
+				 * A <colon> (':') shall be returned if getopt() detects a
+				 * missing argument and the first character of optstring was a
+				 * <colon> (':').
+				 *
+				 * A <question-mark> ('?') shall be returned if getopt()
+				 * encounters an option character not in optstring or detects a
+				 * missing argument and the first character of optstring was not
+				 * a <colon> (':').
+				 *
+				 * Otherwise, getopt() shall return -1 when all command line
+				 * options are parsed. */
+				58 => { /* ASCII ':' */
+					Some(Opt {
+						arg: None,
+						ind: std::ptr::addr_of_mut!(optind),
+						/* error containing option */
+						opt: Err(OptError::MissingArg(optopt.to_string())),
+					})
+				},
+				63 => { /* ASCII '?' */
+					Some(Opt {
+						arg: None,
+						ind: std::ptr::addr_of_mut!(optind),
+						/* error containing option */
+						opt: Err(OptError::UnknownOpt(optopt.to_string())),
+					})
+				},
+				/* From getopt(3p):
+				 *
+				 * If, when getopt() is called:
+				 *
+				 * argv[optind]  is a null pointer
+				 * *argv[optind]  is not the character -
+				 * argv[optind]  points to the string "-"
+				 *
+				 * getopt() shall return -1 without changing optind.  If:
+				 *
+				 * argv[optind]   points to the string "--"
+				 *
+				 * getopt() shall return -1 after incrementing optind. */
+                -1 => return None,
+                opt => {
+					let arg: Option<String>;
+
+					if optarg.is_null() { arg = None; }
+					else {
+						arg = Some(CStr::from_ptr(optarg)
+							.to_string_lossy()
+							.into_owned());
+					}
+
+					Some(Opt {
+						arg,
+						ind: std::ptr::addr_of_mut!(optind),
+						/* I didn’t need to cast this before; I rewrote the
+						 * pointer logic and now I do
+						 *
+						 * I don’t know why this is */
+						opt: Ok((opt as u8 as char).to_string()),
+					})
+				},
+            };
+
+			/* delloc argv (something online said I should do this) */
+			let _ = Box::from_raw(boxed);
+			return ret;
+        }
+    }
+}
+
+/* tests (good) */
+#[cfg(test)]
+mod tests {
+	use GetOpt;
+
+	#[test]
+	fn testing() {
+		let argv: Vec<String> = ["test", "-b", "-f", "arg", "-o", "arg"]
+			.iter()
+			.map(|s| s.to_string())
+			.collect();
+
+		while let Some(opt) = argv.getopt(":abf:o:") {
+			match opt.opt() {
+				Ok("a") => assert_eq!(opt.ind(), 1),
+				Ok("b") => assert_eq!(opt.ind(), 2),
+				Ok("f") | Ok("o") => {
+					assert_eq!(opt.arg(), Some("arg".into()));
+				},
+				_ => assert!(false),
+			};
+		}
+
+		if let Some(opt) = argv.getopt("abc:") {
+			opt.clone().set_ind(1);
+			assert_eq!(opt.ind(), 1);
+		}
+	}
+}
--- a/src/libstrerror.rs
+++ b/src/libstrerror.rs
--- a/src/swab.rs
+++ b/src/swab.rs
@@ -24,7 +24,7 @@ use std::{
 };

 extern crate getopt;
-use getopt::{ Opt, Parser };
+use getopt::GetOpt;

 extern crate sysexits;
 use sysexits::{ EX_OK, EX_OSERR, EX_USAGE };
@@ -45,24 +45,21 @@ fn main() -> ExitCode {
 	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]); }
+	while let Some(opt) = argv.getopt("fw:") {
+		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; () },
+						_ => { return usage(&argv[0]); },
+					}
 				}
+			},
+			_ => { return usage(&argv[0]); }
 		}
 	}
Author	SHA1	Message	Date
emma	cb88ed9809	Merge branch 'getopt-bindings'	2024-06-29 07:51:01 -06:00
emma	cf5136d247	Makefile, swab(1): fixes swab build	2024-06-29 07:49:47 -06:00
DTB	6bd19c072d	swab(1): fix some silly mistakes	2024-06-29 06:02:39 -06:00
emma	50bbee10a9	libgetopt.rs(3): fixes typecasting for ARM devices	2024-06-28 10:22:20 -06:00
DTB	d07bb7da41	swab(1): untested move to new getopt bindings	2024-06-28 08:33:31 -06:00
emma	2f87ad948f	strerror.rs(3), getopt.rs(3): renames	2024-06-27 14:04:31 -06:00
emma	0fc9a6b533	Makefile, docs: programmatically generate version for docs (i got tired of doing it myself)	2024-06-23 23:47:29 -06:00
emma	8b400d8a62	Makefile, docs: rename	2024-06-23 23:34:23 -06:00
emma	6e4aeb7be7	fop(1): bring getopt(3) usage up-to-date	2024-06-23 01:00:48 -06:00
emma	965d1bb76e	Merge branch 'main' into getopt-bindings	2024-06-23 00:57:20 -06:00
emma	e1bf49c75a	getopt.rs(3): adds comments & documentation	2024-06-22 22:30:30 -06:00
emma	8f990ba515	getopt.rs(3): adds testing	2024-06-22 22:18:13 -06:00
emma	4b3333d8d3	fop(1): record separator worky now?	2024-06-21 03:26:42 -06:00
emma	578d947561	Merge branch 'README-clarity'	2024-06-19 23:30:03 -06:00
emma	2e91338101	Merge branch 'makefile-posix-2024'	2024-06-19 23:29:42 -06:00
emma	72f57ba08b	Makefile: adds octal disclaimer	2024-06-19 23:29:22 -06:00
emma	35f49a699f	fop(1): fixes record separator, again	2024-06-19 15:26:46 -06:00
emma	125b4c8930	README: updated for clarity	2024-06-19 02:52:58 -06:00
emma	f553cff096	Makefile: removes unneeded comment	2024-06-18 16:33:22 -06:00
emma	d201f9228c	Makefile: updates to use new POSIX 2024 standard features!	2024-06-18 16:32:20 -06:00
emma	40da8135f1	getopt.rs(3): relicense to AGPLv3	2024-06-06 01:03:01 -06:00
emma	02daca87dc	fop(1): updated to latest optind api	2024-06-05 11:55:16 -06:00
emma	e862b7fec6	getopt.rs(3): safe api around optind reading and setting	2024-06-05 11:54:55 -06:00
emma	05cde15105	fop(1): updated to use new optind api	2024-06-04 19:15:55 -06:00
emma	35ddc729fd	getopt.rs(3): makes optind part of the Opt struct	2024-06-04 19:15:22 -06:00
emma	b7283d54fe	getopt.rs(3): formatting & organization	2024-06-04 15:07:11 -06:00
emma	a5a9c91cb6	getopt.rs(3): optind support	2024-06-04 15:04:01 -06:00
emma	78eacd660a	getopt.rs(3): better Opt return	2024-04-13 23:42:11 -06:00
emma	d1b77d652b	getopt.rs(3): returns last parsed option	2024-04-13 17:11:04 -06:00
emma	8c255e61fc	COPYING.GPL: initial commit	2024-04-12 00:12:37 -06:00
emma	95927ba8c5	getopt.rs(3): formatting	2024-04-11 23:51:52 -06:00
emma	ad92fe27d4	fop(1): switch to getopt.rs(3)	2024-04-11 23:37:04 -06:00
emma	bb2c63bfaf	getopt.rs(3): fixed pointer shenanigans	2024-04-11 20:33:42 -06:00
emma	88b0d55440	getopt.rs(3): refactor to remove as much as possible from unsafe	2024-04-11 20:21:01 -06:00
emma	0164b681c0	Makefile: remove unneeded test	2024-04-01 20:41:07 -06:00
emma	320a70bc56	getopt.rs(3): initial commit	2024-04-01 20:39:10 -06:00