New report command-line option

Author: joseasoler

src/arguments/arguments.cpp

@@ -97,6 +97,15 @@ constexpr auto verbose_arg = optional_argument("--verbose", "Display all input f
 
 constexpr auto help_arg = optional_argument("--help", "Show usage information.");
 
+// Advanced options.
+constexpr auto alpha_black_arg = optional_arg{"--bc1-alpha-black", "-bc1-ab",
+	"The BC1 encoder will use 3 color blocks for blocks containing black or very dark pixels. Increases texture quality "
+	"substantially, but programs using these textures must ignore the alpha channel."};
+
+constexpr auto report_arg =
+	optional_arg{"--report", "-rp", "Prints information about the encoding process of each file."};
+
+// Positional arguments.
 constexpr std::string_view input_name = "input";
 constexpr std::string_view input_help =
 	"Encode all PNG files inside of this folder as DDS. It can also point to a single PNG file. "
@@ -108,10 +117,6 @@ constexpr std::string_view output_help =
 	"Write DDS files to this folder instead of creating them next to input PNGs. This argument is ignored if input "
 	"points to a TXT file.";
 
-constexpr auto alpha_black_arg = optional_arg{"--bc1-alpha-black", "-bc1-ab",
-	"The BC1 encoder will use 3 color blocks for blocks containing black or very dark pixels. Increases texture quality "
-	"substantially, but programs using these textures must ignore the alpha channel."};
-
 consteval std::size_t argument_name_total_space() {
 	std::size_t max_space{};
 	max_space = std::max(max_space, clean_arg.name.size() + clean_arg.shorter.size() + 2UL);
@@ -135,9 +140,10 @@ consteval std::size_t argument_name_total_space() {
 	max_space = std::max(max_space, verbose_arg.name.size() + verbose_arg.shorter.size() + 2UL);
 	max_space = std::max(max_space, regex_arg.name.size() + regex_arg.shorter.size() + 2UL);
 	max_space = std::max(max_space, help_arg.name.size() + help_arg.shorter.size() + 2UL);
+	max_space = std::max(max_space, alpha_black_arg.name.size() + alpha_black_arg.shorter.size() + 2UL);
+	max_space = std::max(max_space, report_arg.name.size() + report_arg.shorter.size() + 2UL);
 	max_space = std::max(max_space, input_name.size());
 	max_space = std::max(max_space, output_name.size());
-	max_space = std::max(max_space, alpha_black_arg.name.size() + alpha_black_arg.shorter.size() + 2UL);
 
 	return max_space + 2UL;
 }
@@ -244,6 +250,7 @@ std::string get_help(std::size_t max_threads) {
 	ostream << "\nADVANCED OPTIONS:\n";
 
 	print_optional_argument(ostream, alpha_black_arg);
+	print_optional_argument(ostream, report_arg);
 
 	return std::move(ostream).str();
 }
@@ -307,7 +314,6 @@ void argument_from_str<double>(
 } // anonymous namespace
 
 namespace todds::args {
-
 data get(int argc, char** argv) {
 	const boost::nowide::args nowide_args(argc, argv);
 	todds::vector<std::string_view> arguments;
@@ -426,6 +432,8 @@ data get(const todds::vector<std::string_view>& arguments) {
 			parsed_arguments.verbose = true;
 		} else if (matches(argument, alpha_black_arg)) {
 			parsed_arguments.alpha_black = true;
+		} else if (matches(argument, report_arg)) {
+			parsed_arguments.report = true;
 		} else {
 			parsed_arguments.error = true;
 			parsed_arguments.text = fmt::format("Invalid positional argument {:s}", argument);

src/arguments/include/todds/arguments.hpp

@@ -39,6 +39,7 @@ struct data {
 	bool vflip;
 	bool time;
 	bool verbose;
+	bool report;
 	todds::regex regex;
 	bool dry_run;
 	bool progress;

src/pipeline/include/todds/input.hpp

@@ -62,6 +62,9 @@ struct input {
 	 * substantially, but programs using these textures must ignore the alpha channel.
 	 */
 	bool alpha_black{};
+
+	/** Prints information about the encoding process of each file. */
+	bool report{};
 };
 
 } // namespace todds::pipeline

src/pipeline/pipeline.cpp

@@ -164,6 +164,16 @@ void encode_as_dds(const input& input_data) {
 
 	cancel_encoding_log = nullptr;
 	force_finish_flag = nullptr;
+
+	if (input_data.report) {
+		boost::nowide::cout << "File;Width;Height;Mipmaps;Format\n";
+		for (std::size_t index = 0U; index < input_data.paths.size(); ++index) {
+			const std::string& dds_path = input_data.paths[index].second.string();
+			const auto& data = files_data[index];
+			boost::nowide::cout << fmt::format(
+				"{:s};{:d};{:d};{:d};{:s}\n", dds_path, data.width, data.height, data.mipmaps, format::name(data.format));
+		}
+	}
 }
 
 } // namespace todds::pipeline

src/task/task.cpp

@@ -172,6 +172,7 @@ void run(const args::data& arguments) {
 	input_data.scale_filter = arguments.scale_filter;
 	input_data.progress = arguments.progress;
 	input_data.alpha_black = arguments.alpha_black;
+	input_data.report = arguments.report;
 
 	// Launch the parallel pipeline.
 	pipeline::encode_as_dds(input_data);

test/test_arguments.cpp

@@ -610,3 +610,19 @@ TEST_CASE("todds::arguments alpha_black", "[arguments]") {
 		REQUIRE(shorter.alpha_black);
 	}
 }
+
+TEST_CASE("todds::arguments report", "[arguments]") {
+	SECTION("The default value of report is false") {
+		const auto arguments = get({binary, "."});
+		REQUIRE(!arguments.report);
+	}
+
+	SECTION("Providing the report parameter sets its value to true") {
+		const auto arguments = get({binary, "--report", "."});
+		REQUIRE(is_valid(arguments));
+		REQUIRE(arguments.report);
+		const auto shorter = get({binary, "-rp", "."});
+		REQUIRE(is_valid(shorter));
+		REQUIRE(shorter.report);
+	}
+}