Bump version to v1.2.1

This is useful for some arguments.

.gitignore

@@ -1 +1,2 @@
 /target
+/dbus-prettifier.1.gz

Cargo.lock

@@ -4,4 +4,4 @@ version = 4
 
 [[package]]
 name = "dbus-prettifier"
-version = "0.1.0"
+version = "1.2.1"

Cargo.toml

@@ -1,6 +1,14 @@
 [package]
 name = "dbus-prettifier"
-version = "0.1.0"
+version = "1.2.1"
 edition = "2024"
+authors = [ "Nicolás A. Ortega Froysa <nicolas@ortegas.org>" ]
+description = "A tool to prettify the output of qdbus."
+readme = "./README.md"
+homepage = "https://code.ortegas.org/nortega/dbus-prettifier"
+repository = "https://code.ortegas.org/nortega/dbus-prettifier"
+license = "Zlib"
+keywords = [ "dbus", "qdbus", "prettifier" ]
+categories = [ "command-line-utilities" ]
 
 [dependencies]

README.md

@@ -1,29 +1,40 @@
 # DBus Prettifier
 
-I noticed that when working with `qdbus` that I would get long and unformatted
+I noticed when working with `qdbus` that I would get long and unformatted
-outputs that are extremely difficult to read. This small program will prettify a
+outputs that are extremely difficult to read. This small program will prettify
-file with the output so that it is much  more readable.
+a file with the output so that it is much more readable.
 
 ## Usage
 
 To run the program, simply run it as follows:
 
 ```console
-qdbus-prettifier <in-file> <out-file>
+qdbus-prettifier <in-file> [out-file]
 ```
 
-## Building
+If `<in-file>` is defined as `-` this tells the program to read from `stdin`
+allowing input to be piped. If the `[out-file]` option is omitted then output is
+sent to `stdout`.
+
+For more information, check out the `-h` option.
+
+## Building & Installation
 
 To compile the program, install the Rust suite, namely the compiler and Cargo.
 Once installed you can run `cargo build --release` to generate a release build
 of the project which will be found at `target/release/dbus-prettifier`.
 
-To install you can use the `install` command as follows:
+To install the program you can use the `install` script. By default this will
+install to `/usr/local`, but this can be changed by setting the `PREFIX`
+variable prior to the command. For example:
 
 ```console
-install -Dm755 target/release/dbus-prettifier /usr/local/bin
+PREFIX=/usr ./install
 ```
 
+Similarly, to uninstall simply run the `uninstall` script. It uses the same
+`PREFIX` variable.
+
 ## License
 
 This program is licensed under the terms & conditions of the [Zlib

dbus-prettifier.1

@@ -0,0 +1,37 @@
+.TH dbus-prettifier "1" "October 2025" "dbus-prettifier 1.2.1" "User Commands"
+.SH "NAME"
+dbus-prettifier - A tool to prettify the output of qdbus.
+.SH "SYNOPSIS"
+.B dbus-prettifier
+<\fIin-file\fR> [\fIout-file\fR]
+
+.B dbus-prettifier
+\fI-h\fR | \fI-v\fR
+
+.SH "DESCRIPTION"
+Takes input from qdbus (either stored in a file or from \fIstdin\fR) and stores
+it in the provided \fIout-file\fR.
+
+.SH "ARGUMENTS"
+.TP
+\fBin-file\fR
+File containing qdbus output (if \fI-\fR then input is from \fIstdin\fR)
+.TP
+\fBout-file\fR
+File to write formatted output to (if omitted then \fIstdout\fR is used)
+.TP
+\fB\-h\fR
+Show help information
+.TP
+\fB\-v\fR
+Show version information
+
+.SH "AUTHOR"
+Written by Nicolás A. Ortega Froysa.
+
+.SH "COPYRIGHT"
+Copyright \(co 2024 Ortega Froysa, Nicolás A. <nicolas@ortegas.org>.
+License: ZLib License.
+
+This is free software: you are free to change and redistribute it.
+There is NO WARRANTY, to the extent permitted by law.

install

@@ -0,0 +1,17 @@
+#!/bin/bash
+set -euo pipefail
+
+PREFIX=${PREFIX:="/usr/local"}
+
+if ! [ -f "./target/release/dbus-prettifier" ]
+then
+	>&2 echo "Failed to find release target. Please compile the project with 'cargo build --release'."
+	exit 1
+fi
+
+gzip -k ./dbus-prettifier.1
+
+install -Dm644 ./dbus-prettifier.1.gz "$PREFIX/share/man/man1/"
+install -Dm755 ./target/release/dbus-prettifier "$PREFIX/bin/"
+
+rm -f ./dbus-prettifier.1.gz

src/main.rs

@@ -23,83 +23,68 @@
  */
 
 use std::env;
-use std::fs;
-use std::io;
-use std::io::Read;
-use std::boxed::Box;
 use std::process;
 
-// Read 1KiB of the file at a time.
+use crate::worker::work;
-static BLOCK_SIZE:usize = 1024;
 
-fn main() -> io::Result<()> {
+mod worker;
+
+fn print_version() {
+	println!("{} v{}", env!("CARGO_PKG_NAME"), env!("CARGO_PKG_VERSION"));
+}
+
+fn print_usage() {
+	println!("Usage: {} <in-file> [out-file]", env!("CARGO_PKG_NAME"));
+}
+
+fn print_help() {
+	print_version();
+	println!("Usage: \n\
+		\t{} <in-file> [out-file]\n\
+		\t{} -h | -v\n\
+		\n\
+		OPTIONS:\n\
+		\tin-file   Input file ('-' for stdin)\n\
+		\tout-file  Output file\n\
+		\t-h        Show this help information\n\
+		\t-v        Show version information",
+		env!("CARGO_PKG_NAME"), env!("CARGO_PKG_NAME"));
+}
+
+fn main() {
 	let args:Vec<String> = env::args().collect();
+	let mut in_path:Option<&str> = None;
+	let mut out_path:Option<&str> = None;
 
 	if args.len() < 2 || args.len() > 3 {
-		eprintln!("Usage: {} <in-file> [out-file]", args[0]);
+		eprintln!("Invalid number of arguments. Use -h for more information.");
+		print_usage();
 		process::exit(1);
 	}
 
-	let mut in_reader:Box<dyn io::Read>;
+	for i in &args[1..args.len()] {
-	if args[1] == "-" {
+		if i == "-h" {
-		in_reader = Box::new(io::stdin());
+			print_help();
-	} else {
+			return;
-		let in_file = fs::File::open(&args[1])?;
+		} else if i == "-v" {
-		in_reader = Box::new(io::BufReader::new(in_file));
+			print_version();
+			return;
+		} else if i.starts_with("-") && i != "-" {
+			eprintln!("Invalid argument '{}'. Use -h for help information.", i);
+			process::exit(1);
+		}
 	}
 
-	let mut out_writer:Box<dyn io::Write>;
+	if args[1] != "-" {
+		in_path = Some(args[1].as_str());
+	}
 	if args.len() == 3 {
-		let out_file = fs::File::create(&args[2])?;
+		out_path = Some(args[2].as_str());
-		out_writer = Box::new(io::BufWriter::new(out_file));
-	} else {
-		out_writer = Box::new(io::stdout());
 	}
 
-	let mut read_buf:[u8; BLOCK_SIZE] = [0; BLOCK_SIZE];
+	let res = work(in_path, out_path);
-	let mut last_ch:char = '\0';
+	if let Err(err) = res {
-	let mut tab_num = 0;
+		eprintln!("{}", err);
-
+		process::exit(1);
-	while in_reader.read(&mut read_buf)? > 0 {
-		for i in read_buf {
-			let ch = i as char;
-			match ch {
-				'[' | '{' => {
-					tab_num += 1;
-					out_writer.write(format!("{}\n", ch).as_bytes())?;
-					for _ in 0..tab_num {
-						out_writer.write(b"  ")?;
-					}
-					last_ch = ' ';
-				},
-				']' | '}' => {
-					tab_num -= 1;
-					out_writer.write(b"\n")?;
-					for _ in 0..tab_num {
-						out_writer.write(b"  ")?;
-					}
-					out_writer.write(format!("{}", ch).as_bytes())?;
-					last_ch = ch;
-				},
-				',' => {
-					out_writer.write(format!("{}\n", ch).as_bytes())?;
-					for _ in 0..tab_num {
-						out_writer.write(b"  ")?;
-					}
-					last_ch = ' ';
-				},
-				_ => {
-					let ch = ch;
-					if ch != ' ' || last_ch != ' ' {
-						out_writer.write(format!("{}", ch).as_bytes())?;
-						last_ch = ch;
-					}
-				},
 	}
 }
-	}
-
-	out_writer.flush()?;
-
-	Ok(())
-}

src/worker.rs

@@ -0,0 +1,128 @@
+/*
+ * Copyright (C) 2025 Nicolás Ortega Froysa <nicolas@ortegas.org> All rights reserved.
+ * Author: Nicolás Ortega Froysa <nicolas@ortegas.org>
+ *
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ *
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ *
+ * 1. The origin of this software must not be misrepresented; you must not
+ *    claim that you wrote the original software. If you use this software
+ *    in a product, an acknowledgment in the product documentation would be
+ *    appreciated but is not required.
+ *
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ *    misrepresented as being the original software.
+ *
+ * 3. This notice may not be removed or altered from any source
+ *    distribution.
+ */
+
+use std::io;
+use std::fs;
+use std::io::Read;
+use std::boxed::Box;
+
+static MAX_WRITE_BUF_SIZE:usize = 1024;
+
+pub fn work(in_path:Option<&str>, out_path:Option<&str>) -> Result<(), String>  {
+	let in_reader:Box<dyn io::Read> = match in_path {
+		Some(path) => {
+			let in_file = fs::File::open(path);
+			if let Err(e) = in_file {
+				return Err(format!("{path}: {e}"));
+			}
+			Box::new(io::BufReader::new(in_file.unwrap()))
+		},
+		None => {
+			Box::new(io::stdin())
+		},
+	};
+
+	let mut out_writer:Box<dyn io::Write> = match out_path {
+		Some(path) => {
+			let out_file = fs::File::create(path);
+			if let Err(e) = out_file {
+				return Err(format!("{path}: {e}"));
+			}
+			Box::new(io::BufWriter::new(out_file.unwrap()))
+		},
+		None => {
+			Box::new(io::stdout())
+		},
+	};
+
+	let mut last_ch = '\0';
+	let mut tab_num = 0;
+	let mut in_paren = false;
+	let mut write_buf = String::new();
+
+	for i in in_reader.bytes() {
+		let ch = i.unwrap() as char;
+		match ch {
+			'[' | '{' => {
+				tab_num += 1;
+				//write_buf += format!("{ch}\n").as_str();
+				write_buf.push(ch);
+				if !in_paren {
+					write_buf.push('\n');
+					for _ in 0..tab_num {
+						write_buf += "  ";
+					}
+					last_ch = ' ';
+				} else {
+					last_ch = ch;
+				}
+			},
+			']' | '}' => {
+				tab_num -= 1;
+				if !in_paren {
+					write_buf += "\n";
+					for _ in 0..tab_num {
+						write_buf += "  ";
+					}
+				}
+				write_buf.push(ch);
+				last_ch = ch;
+			},
+			',' => {
+				write_buf.push(ch);
+				if last_ch == '}' || last_ch == ']' {
+					write_buf.push('\n');
+					for _ in 0..tab_num {
+						write_buf += "  ";
+					}
+					last_ch = ' ';
+				} else {
+					last_ch = ch;
+				}
+			},
+			_ => {
+				if ch != ' ' || last_ch != ' ' {
+					if ch == '(' {
+						in_paren = true;
+					} else if ch == ')' {
+						in_paren = false;
+					}
+					write_buf.push(ch);
+					last_ch = ch;
+				}
+			},
+		}
+
+		if write_buf.len() >= MAX_WRITE_BUF_SIZE {
+			out_writer.write_all(write_buf.as_bytes()).unwrap();
+			write_buf.clear();
+		}
+	}
+
+	if write_buf.len() > 0 {
+		out_writer.write_all(write_buf.as_bytes()).unwrap();
+	}
+
+	Ok(())
+}

uninstall

@@ -0,0 +1,13 @@
+#!/bin/bash
+set -euo pipefail
+
+PREFIX=${PREFIX:="/usr/local"}
+
+if ! [ -f "$PREFIX/bin/dbus-prettifier" ]
+then
+	>&2 echo "Installation not found in prefix '$PREFIX'."
+	exit 1
+fi
+
+rm -f "$PREFIX/bin/dbus-prettifier"
+rm -f "$PREFIX/share/man/man1/dbus-prettifier.1.gz"