Dynamically sized "Group Name" column.

DigitalInBlue · Oct 6, 2023 · b670b52 · b670b52
1 parent 518ce41
commit b670b52
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 8 deletions.
diff --git a/include/celero/Print.h b/include/celero/Print.h
@@ -46,7 +46,7 @@ namespace celero
 		void initialize(std::vector<std::string> userDefinedColumns);
 
 		void Console(const std::string& x);
-		void TableBanner();
+		void TableBanner(const size_t groupNameLength = 15);
 		void TableRowExperimentHeader(Experiment* x);
 		void TableRowFailure(const std::string& msg);
 		void TableRowProblemSpaceHeader(std::shared_ptr<celero::ExperimentResult> x);

diff --git a/src/Celero.cpp b/src/Celero.cpp
@@ -231,8 +231,13 @@ void celero::Run(int argc, char** argv)
 				userDefinedFields.insert(fieldName);
 			}
 		}
+
+		return bmark->getName().length();
 	};
 
+	// PrintConstants::ColumnWidth
+	auto maxGroupNameLength = size_t(15);
+
 	if(argument.empty() == false)
 	{
 		if(celero::TestVector::Instance().containsGroup(argument))
@@ -241,7 +246,8 @@ void celero::Run(int argc, char** argv)
 
 			if(bmark != nullptr)
 			{
-				collectFromBenchmark(bmark);
+				const auto groupNameLength = collectFromBenchmark(bmark);
+				maxGroupNameLength = std::max(maxGroupNameLength, groupNameLength);
 			}
 		}
 		else
@@ -258,15 +264,16 @@ void celero::Run(int argc, char** argv)
 
 			if(bmark != nullptr)
 			{
-				collectFromBenchmark(bmark);
+				const auto groupNameLength = collectFromBenchmark(bmark);
+				maxGroupNameLength = std::max(maxGroupNameLength, groupNameLength);
 			}
 		}
 	}
 
 	std::vector<std::string> userDefinedFieldsOrder(userDefinedFields.begin(), userDefinedFields.end());
 
 	Printer::get().initialize(userDefinedFieldsOrder);
-	Printer::get().TableBanner();
+	Printer::get().TableBanner(maxGroupNameLength);
 
 	const auto startTime = celero::timer::GetSystemTime();
 

diff --git a/src/Print.cpp b/src/Print.cpp
@@ -41,6 +41,11 @@ enum PrintConstants : size_t
 	ColumnWidth = 15
 };
 
+// Here, we demonstrate "worst-practices" my implementing a global variable.
+// This is technical debt to shoe-horn in a way to dynamically adjust the column width for the group name.
+// Public shaming is acceptable.
+size_t GlobalGroupNameColumnWidth(15);
+
 ///
 /// http://stackoverflow.com/questions/14765155/how-can-i-easily-format-my-data-table-in-c
 /// Center-aligns string within a field of width w. Pads with blank spaces to enforce alignment.
@@ -186,17 +191,24 @@ std::string PrintHRule(const size_t additionalColumns = 0)
 
 	std::stringstream ss;
 	std::string column{":"};
+	std::string groupColumn{":"};
 
 	while(column.length() < PrintConstants::ColumnWidth)
 	{
 		column += "-";
 	}
 
+	while(groupColumn.length() < GlobalGroupNameColumnWidth)
+	{
+		groupColumn += "-";
+	}
+
 	std::string firstColumn = column + ":|";
+	groupColumn = groupColumn + ":|";
 
 	column += "-:|";
 
-	ss << "|" << firstColumn;
+	ss << "|" << groupColumn;
 
 	for(size_t i = 0; i < PrintConstants::NumberOfColumns + additionalColumns - 1; ++i)
 	{
@@ -215,11 +227,14 @@ namespace celero
 		std::cout << "Celero: " << x << std::endl;
 	}
 
-	void Printer::TableBanner()
+	void Printer::TableBanner(const size_t groupNameLength)
 	{
+		GlobalGroupNameColumnWidth = groupNameLength;
+
 		celero::console::SetConsoleColor(celero::console::ConsoleColor::Default);
 
-		std::cout << "|" << PrintCenter("Group") << PrintCenter("Experiment") << PrintCenter("Prob. Space") << PrintCenter("Samples")
+		std::cout << "|" << PrintCenter("Group", GlobalGroupNameColumnWidth) << PrintCenter("Experiment") << PrintCenter("Prob. Space")
+				  << PrintCenter("Samples")
 				  << PrintCenter("Iterations") << PrintCenter("Baseline") << PrintCenter("us/Iteration") << PrintCenter("Iterations/sec")
 				  << PrintCenter("RAM (bytes)");
 
@@ -235,7 +250,7 @@ namespace celero
 	void Printer::TableRowExperimentHeader(Experiment* x)
 	{
 		celero::console::SetConsoleColor(celero::console::ConsoleColor::Default);
-		std::cout << "|" << PrintColumn(x->getBenchmark()->getName()) << PrintColumn(x->getName());
+		std::cout << "|" << PrintColumn(x->getBenchmark()->getName(), GlobalGroupNameColumnWidth) << PrintColumn(x->getName());
 	}
 
 	void Printer::TableRowFailure(const std::string& msg)