Manager+Doc: Make package tracking more flexible, allow custom filenames

doc/manafiles.1

@@ -1,4 +1,4 @@
-.TH MANAFILES 1 "2022-01-29" "manafiles 0.5" "User Commands"
+.TH MANAFILES 1 "2025-02-02" "manafiles 0.6" "User Commands"
 
 .SH NAME
 manafiles \- config file and package tracking utility
@@ -31,7 +31,7 @@ See File Options below.
 .TP
 .BR \-P ", " \-\-package
 Operate on packages. \
-This operation allows you to track installed packages and reinstall them. \
+This operation allows tracking installed packages and reinstalling them. \
 In the first case, if no package names are provided in the command line, all packages will be selected. \
 See Package Options below.
 
@@ -67,8 +67,10 @@ Install all AUR packages of the stored list.
 Install all official packages of the stored list.
 
 .TP
-.BR \-s ", " \-\-store
+.BR \-s ", " \-\-search
-Stores a list of all installed packages on the system.
+Search each locally-installed package for names via a partial match. \
+When including multiple search terms, all packages with names matching any of those terms are returned. \
+If the \fB-s\fR option is ommited, packages names are filtered via a full match.
 
 .SH EXAMPLES
 Usage examples:

src/dotfile.cpp

@@ -115,7 +115,12 @@ bool Dotfile::match(const std::string& path, const std::vector<std::string>& pat
 	std::string pathString = path.substr(cutFrom);
 
 	for (const auto& pattern : patterns) {
+		// A dot matches everything in the current working directory
+		if (pattern == ".") {
+			return true;
+		}
 
+		// Exact match is obviously true
 		if (pathString == pattern) {
 			return true;
 		}
@@ -391,25 +396,43 @@ void Dotfile::selectivelyCommentOrUncomment(const std::string& path)
 	size_t positionInFile = 0;
 
 	auto commentOrUncommentLine = [&](std::string& line, bool addComment) {
+		size_t indentation = line.find_first_not_of(" \t");
+
+		// Empty lines are skipped
+		if (line.empty() || indentation == std::string::npos) {
+			return;
+		}
+
 		size_t lineLength = line.size();
-		size_t whiteSpaceBeforeComment = line.find_first_not_of(" \t");
+		size_t commentStart = line.find(commentCharacter, indentation);
-		size_t contentAfterComment = line.find_first_not_of(" \t" + commentCharacter);
+		size_t commentEnd = line.rfind(commentTerminationCharacter);
-		// NOTE: The +1 is needed to take the newline into account
+		bool hasComment = commentStart != std::string::npos && (commentTerminationCharacter.empty() || commentEnd != std::string::npos);
-		size_t contentLength = lineLength + 1 - contentAfterComment - (lineLength - line.find_last_not_of(" \t" + commentTerminationCharacter));
 
-		// If there was no comment, grab whitespace correctly
+		// Lines that have a comment at the *end* of the line aren't considered commented lines
-		if (whiteSpaceBeforeComment == std::string::npos) {
+		if (hasComment && line.find_first_not_of(" \t") < commentStart) {
-			whiteSpaceBeforeComment = contentAfterComment;
+			hasComment = false;
 		}
 
-		if (!addComment) {
+		// Uncomment line
-			line = line.substr(0, whiteSpaceBeforeComment)
+		if (hasComment && !addComment) {
-			       + line.substr(contentAfterComment, contentLength);
+			size_t contentStart = line.find_first_not_of(" \t", commentStart + commentCharacter.size());
+			size_t contentLength = commentEnd - contentStart;
+
+			// Trim trailing whitespace
+			std::string content = line.substr(contentStart, contentLength);
+			content = content.substr(0, content.find_last_not_of(" \t") + 1);
+
+			line = line.substr(0, indentation)
+			       + content;
 		}
-		else {
+		// Comment line
-			line = line.substr(0, whiteSpaceBeforeComment)
+		else if (!hasComment && addComment) {
+			size_t contentStart = line.find_first_not_of(" \t");
+			size_t contentLength = line.size() - contentStart;
+
+			line = line.substr(0, indentation)
 			       + commentCharacter + ' '
-			       + line.substr(contentAfterComment, contentLength)
+			       + line.substr(contentStart, contentLength)
 			       + (!commentTerminationCharacter.empty() ? ' ' + commentTerminationCharacter : "");
 		}
 
@@ -437,6 +460,10 @@ void Dotfile::selectivelyCommentOrUncomment(const std::string& path)
 				if (i > 0 && commentCharacter.at(i - 1) == '/' && commentCharacter.at(i) == '*') {
 					commentTerminationCharacter = "*/";
 				}
+				// Support for <!-- XMl comments -->
+				if (i > 0 && commentCharacter.at(i - 1) == '<' && commentCharacter.at(i) == '!' && commentCharacter.at(i + 1) == '-' && commentCharacter.at(i + 2) == '-') {
+					commentTerminationCharacter = "-->";
+				}
 				// NOTE: Modification of the string should be at the end of the iteration to prevent 'out of range' errors
 				if (commentCharacter.at(i) == ' ' || commentCharacter.at(i) == '\t') {
 					commentCharacter.erase(i, 1);

src/machine.cpp

@@ -72,18 +72,24 @@ void Machine::fetchSession()
 	int8_t likelyWayland = 0;
 
 	// Detect via environment variable
-	std::string env;
+	const char* env;
-	env = std::string(std::getenv("XDG_SESSION_TYPE"));
+	env = std::getenv("XDG_SESSION_TYPE");
-	if (env == "wayland") {
+	if (env != nullptr) {
+		auto session = std::string(env);
+		if (session == "wayland") {
 			likelyWayland++;
 		}
-	else if (env == "x11") {
+		else if (session == "x11") {
 			likelyWayland--;
 		}
-	env = std::string(std::getenv("WAYLAND_DISPLAY"));
+	}
-	if (env.find("wayland-", 0) == 0) {
+	env = std::getenv("WAYLAND_DISPLAY");
+	if (env != nullptr) {
+		auto display = std::string(env);
+		if (display.find("wayland-", 0) == 0) {
 			likelyWayland++;
 		}
+	}
 
 	// Detect via Wayland socket
 	auto socket = std::filesystem::path("/run/user") / std::to_string(uid());
@@ -117,12 +123,12 @@ void Machine::fetchSession()
 				std::string command;
 				std::getline(stream, command);
 
-				if (command == "Xwayland" || command == "hyprland" || command == "sway") {
+				if (command == "Xwayland" || command == "sway" || command == "hyprland") {
 					likelyWayland++;
 					break;
 				}
 
-				if (command == "Xorg" || command == "xinit" || command == "bspwm") {
+				if (command == "Xorg" || command == "xinit" || command == "i3" || command == "bspwm") {
 					likelyWayland--;
 					break;
 				}

src/main.cpp

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2021-2022 Riyyi
+ * Copyright (C) 2021-2022,2025 Riyyi
  *
  * SPDX-License-Identifier: MIT
  */
@@ -8,11 +8,12 @@
 #include <string>
 #include <vector>
 
+#include "ruc/argparser.h"
+#include "ruc/timer.h"
+
 #include "config.h"
 #include "dotfile.h"
 #include "package.h"
-#include "ruc/argparser.h"
-#include "ruc/timer.h"
 
 int main(int argc, const char* argv[])
 {
@@ -23,7 +24,7 @@ int main(int argc, const char* argv[])
 	bool addOrAur = false;
 	bool install = false;
 	bool pull = false;
-	bool pushOrStore = false;
+	bool pushOrSearch = false;
 	bool verbose = false;
 
 	std::vector<std::string> targets {};
@@ -36,7 +37,7 @@ int main(int argc, const char* argv[])
 	argParser.addOption(addOrAur, 'a', "add", nullptr, nullptr);
 	argParser.addOption(install, 'i', "install", nullptr, nullptr);
 	argParser.addOption(pull, 'l', "pull", nullptr, nullptr);
-	argParser.addOption(pushOrStore, 's', "push", nullptr, nullptr);
+	argParser.addOption(pushOrSearch, 's', "push", nullptr, nullptr);
 	argParser.addOption(verbose, 'v', "verbose", nullptr, nullptr);
 
 	argParser.addArgument(targets, "targets", nullptr, nullptr, ruc::ArgParser::Required::No);
@@ -60,32 +61,29 @@ int main(int argc, const char* argv[])
 		if (pull) {
 			Dotfile::the().pull(targets);
 		}
-		if (pushOrStore) {
+		if (pushOrSearch) {
 			Dotfile::the().push(targets);
 		}
-		if (!addOrAur && !pull && !pushOrStore) {
+		if (!addOrAur && !pull && !pushOrSearch) {
 			Dotfile::the().list(targets);
 		}
 	}
 	else if (packageOperation) {
 		if (addOrAur) {
-			Package::the().aurInstall();
+			Package::the().aurInstall(targets);
 		}
 		if (install) {
-			Package::the().install();
+			Package::the().install(targets);
 		}
-		if (pushOrStore) {
+		if (!addOrAur && !install) {
-			Package::the().store();
+			Package::the().list(targets, pushOrSearch);
-		}
-		if (!addOrAur && !install && !pushOrStore) {
-			Package::the().list(targets);
 		}
 	}
 	else if (helpOperation) {
-		// TODO open manpage
+		// TODO: open manpage
 	}
 	else {
-		// TODO open manpage
+		// TODO: open manpage
 	}
 
 #ifndef NDEBUG

src/package.cpp

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2021-2022 Riyyi
+ * Copyright (C) 2021-2022,2025 Riyyi
  *
  * SPDX-License-Identifier: MIT
  */
@@ -14,12 +14,12 @@
 #include <string>  // getline
 #include <vector>
 
-#include "machine.h"
-#include "package.h"
-#include "ruc/file.h"
 #include "ruc/shell.h"
 #include "ruc/system.h"
 
+#include "machine.h"
+#include "package.h"
+
 Package::Package(s)
 {
 }
@@ -30,17 +30,27 @@ Package::~Package()
 
 // -----------------------------------------
 
-void Package::aurInstall()
+void Package::aurInstall(const std::vector<std::string>& targets)
 {
-	installOrAurInstall(InstallType::AurInstall);
+	if (targets.size() > 1) {
+		fprintf(stderr, "\033[31;1mPackage:\033[0m only 1 file can be read packages from at a time\n");
+		return;
+	}
+
+	installOrAurInstall(InstallType::AurInstall, targets.size() != 0 ? targets.front() : PACKAGE_FILE);
 }
 
-void Package::install()
+void Package::install(const std::vector<std::string>& targets)
 {
-	installOrAurInstall(InstallType::Install);
+	if (targets.size() > 1) {
+		fprintf(stderr, "\033[31;1mPackage:\033[0m only 1 file can be read packages from at a time\n");
+		return;
+	}
+
+	installOrAurInstall(InstallType::Install, targets.size() != 0 ? targets.front() : PACKAGE_FILE);
 }
 
-void Package::list(const std::vector<std::string>& targets)
+void Package::list(const std::vector<std::string>& targets, bool partialMatch)
 {
 	auto packagesOrEmpty = getPackageList();
 
@@ -62,7 +72,7 @@ void Package::list(const std::vector<std::string>& targets)
 	std::string line;
 	while (std::getline(stream, line)) {
 		for (const auto& target : targets) {
-			if (line.find(target) != std::string::npos) {
+			if (line == target || (partialMatch && line.find(target) != std::string::npos)) {
 				packages.append(line + '\n');
 				break;
 			}
@@ -72,20 +82,6 @@ void Package::list(const std::vector<std::string>& targets)
 	printf("%s", packages.c_str());
 }
 
-void Package::store()
-{
-	auto packagesOrEmpty = getPackageList();
-
-	if (!packagesOrEmpty.has_value()) {
-		return;
-	}
-
-	auto packageFile = ruc::File::create("./packages");
-	packageFile.clear();
-	packageFile.append(packagesOrEmpty.value());
-	packageFile.flush();
-}
-
 // -----------------------------------------
 
 std::optional<std::string> Package::fetchAurHelper()
@@ -105,7 +101,7 @@ std::optional<std::string> Package::fetchAurHelper()
 	return {};
 }
 
-void Package::installOrAurInstall(InstallType type)
+void Package::installOrAurInstall(InstallType type, const std::string& file)
 {
 	distroDetect();
 	distroDependencies();
@@ -129,12 +125,12 @@ void Package::installOrAurInstall(InstallType type)
 	ruc::System $;
 	if (m_distro == Distro::Arch) {
 		// Grab everything off enabled official repositories that is in the list
-		auto repoList = $("pacman -Ssq") | $("grep -xf ./packages");
+		auto repoList = $("pacman -Ssq") | $("grep -xf " + file);
 
 		if (type == InstallType::AurInstall) {
 			// Determine which packages in the list are from the AUR
 			// NOTE: ruc::System does not support commands with newlines
-			auto aurList = ruc::Shell()("grep -vx '" + repoList.output() + "' ./packages");
+			auto aurList = ruc::Shell()("grep -vx '" + repoList.output() + "' " + file);
 			command = aurHelper.value() + " -Sy --devel --needed --noconfirm " + aurList.output();
 		}
 		else {
@@ -143,7 +139,7 @@ void Package::installOrAurInstall(InstallType type)
 	}
 	else if (m_distro == Distro::Debian) {
 		// Grab everything off enabled official repositories that is in the list
-		auto repoList = $("apt-cache search .").cut(1, ' ') | $("grep -xf ./packages");
+		auto repoList = $("apt-cache search .").cut(1, ' ') | $("grep -xf " + file);
 		command = "apt install " + repoList.output();
 	}
 

src/package.h

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2021-2022 Riyyi
+ * Copyright (C) 2021-2022,2025 Riyyi
  *
  * SPDX-License-Identifier: MIT
  */
@@ -13,6 +13,8 @@
 
 #include "ruc/singleton.h"
 
+#define PACKAGE_FILE "./packages"
+
 class Package : public ruc::Singleton<Package> {
 public:
 	Package(s);
@@ -29,14 +31,13 @@ public:
 		AurInstall,
 	};
 
-	void aurInstall();
+	void aurInstall(const std::vector<std::string>& targets = {});
-	void install();
+	void install(const std::vector<std::string>& targets = {});
-	void list(const std::vector<std::string>& targets = {});
+	void list(const std::vector<std::string>& targets = {}, bool partialMatch = false);
-	void store();
 
 private:
 	std::optional<std::string> fetchAurHelper();
-	void installOrAurInstall(InstallType type);
+	void installOrAurInstall(InstallType type, const std::string& file);
 
 	bool findDependency(const std::string& search);
 	bool distroDetect();

test/unit/testdotfile.cpp

@@ -1,11 +1,10 @@
 /*
- * Copyright (C) 2022 Riyyi
+ * Copyright (C) 2022,2025 Riyyi
  *
  * SPDX-License-Identifier: MIT
  */
 
 #include <cstddef>    // size_t
-#include <cstdint>    // uint32_t
 #include <cstdio>     // stderr
 #include <filesystem> // path
 #include <string>
@@ -13,12 +12,12 @@
 #include <unordered_map>
 #include <vector>
 
+#include "ruc/file.h"
+
 #include "config.h"
 #include "dotfile.h"
 #include "machine.h"
 #include "macro.h"
-#include "ruc/file.h"
-#include "ruc/system.h"
 #include "testcase.h"
 #include "testsuite.h"
 
@@ -28,7 +27,7 @@ const size_t homeDirectorySize = homeDirectory.string().size();
 
 void createTestDotfiles(const std::vector<std::string>& fileNames, const std::vector<std::string>& fileContents, bool asRoot = false)
 {
-	EXPECT(fileNames.size() == fileContents.size(), return );
+	EXPECT(fileNames.size() == fileContents.size(), return);
 
 	if (root && !asRoot) {
 		setegid(Machine::the().gid());
@@ -503,7 +502,7 @@ TEST_CASE(PushDotfilesWithIgnorePattern)
 TEST_CASE(PushDotfilesSelectivelyComment)
 {
 	std::vector<std::string> fileNames;
-	for (size_t i = 0; i < 36; ++i) {
+	for (size_t i = 0; i < 44; ++i) {
 		fileNames.push_back("__test-file-" + std::to_string(i + 1));
 	}
 
@@ -678,6 +677,43 @@ test data /**/ comment
 	  /*	  test data /**/ uncomment	  */
 	  /* <<< */
 )",
+
+		// Comment <!---->
+		"<!-- >>> distro=" + placeholder + " hostname=" + hostname + " user=" + username + " -->" + R"(
+test data <!----> comment
+<!-- <<< -->
+)",
+		"  <!-- >>> distro=" + distro + " hostname=" + placeholder + " user=" + username + " -->" + R"(
+  test data <!----> comment
+  <!-- <<< -->
+)",
+		"	<!-- >>> distro=" + distro + " hostname=" + hostname + " user=" + placeholder + " -->" + R"(
+	test data <!----> comment
+	<!-- <<< -->
+)",
+		"	  <!-- >>> distro=" + placeholder + " hostname=" + hostname + " user=" + username + " -->" + R"(
+	  test data <!----> comment
+	  <!-- <<< -->
+)",
+
+		// Uncomment <!---->
+		"<!-- >>> distro=" + distro + " hostname=" + hostname + " user=" + username + " -->" + R"(
+<!-- test data <!----> uncomment -->
+<!-- <<< -->
+)",
+		"  <!-- >>> distro="
+			+ distro + " hostname=" + hostname + " user=" + username + " -->" + R"(
+  <!--  test data <!----> uncomment  -->
+  <!-- <<< -->
+)",
+		"	<!-- >>> distro=" + distro + " hostname=" + hostname + " user=" + username + " -->" + R"(
+	<!--	test data <!----> uncomment	-->
+	<!-- <<< -->
+)",
+		"	  <!-- >>> distro=" + distro + " hostname=" + hostname + " user=" + username + " -->" + R"(
+	  <!--	  test data <!----> uncomment	  -->
+	  <!-- <<< -->
+)",
 	};
 
 	std::vector<std::string> pushedFileContents = {
@@ -846,6 +882,42 @@ test data /**/ uncomment
 	  test data /**/ uncomment
 	  /* <<< */
 )",
+
+		// Comment <!---->
+		"<!-- >>> distro=" + placeholder + " hostname=" + hostname + " user=" + username + " -->" + R"(
+<!-- test data <!----> comment -->
+<!-- <<< -->
+)",
+		"  <!-- >>> distro=" + distro + " hostname=" + placeholder + " user=" + username + " -->" + R"(
+  <!-- test data <!----> comment -->
+  <!-- <<< -->
+)",
+		"	<!-- >>> distro=" + distro + " hostname=" + hostname + " user=" + placeholder + " -->" + R"(
+	<!-- test data <!----> comment -->
+	<!-- <<< -->
+)",
+		"	  <!-- >>> distro=" + placeholder + " hostname=" + hostname + " user=" + username + " -->" + R"(
+	  <!-- test data <!----> comment -->
+	  <!-- <<< -->
+)",
+
+		// Uncomment <!---->
+		"<!-- >>> distro=" + distro + " hostname=" + hostname + " user=" + username + " -->" + R"(
+test data <!----> uncomment
+<!-- <<< -->
+)",
+		"  <!-- >>> distro=" + distro + " hostname=" + hostname + " user=" + username + " -->" + R"(
+  test data <!----> uncomment
+  <!-- <<< -->
+)",
+		"	<!-- >>> distro=" + distro + " hostname=" + hostname + " user=" + username + " -->" + R"(
+	test data <!----> uncomment
+	<!-- <<< -->
+)",
+		"	  <!-- >>> distro=" + distro + " hostname=" + hostname + " user=" + username + " -->" + R"(
+	  test data <!----> uncomment
+	  <!-- <<< -->
+)",
 	};
 
 	createTestDotfiles(fileNames, fileContents);
@@ -866,7 +938,7 @@ test data /**/ uncomment
 
 TEST_CASE(AddSystemDotfiles)
 {
-	EXPECT(geteuid() == 0, return );
+	EXPECT(geteuid() == 0, return);
 
 	Config::the().setSystemPatterns({ "/etc/", "/usr/lib/" });
 	Dotfile::the().add({ "/etc/group", "/usr/lib/os-release" });
@@ -881,7 +953,7 @@ TEST_CASE(AddSystemDotfiles)
 
 TEST_CASE(PullSystemDotfiles)
 {
-	EXPECT(geteuid() == 0, return );
+	EXPECT(geteuid() == 0, return);
 
 	createTestDotfiles({ "etc/group" }, { "" }, true);