Add some pretty printers for Googletest. This really helps to find the errors if a check fails.

Author: Christian Feldmann

YUViewLib/src/statistics/StatisticsDataPainting.cpp

@@ -147,12 +147,11 @@ void paintVector(QPainter                    *painter,
         const int headSize =
             (zoomFactor >= STATISTICS_DRAW_VALUES_ZOOM && !vector.scaleToZoom) ? 8 : zoomFactor / 2;
 
-        if (vector.arrowHead != stats::StatisticsType::ArrowHead::none)
+        if (vector.arrowHead != stats::ArrowHead::none)
         {
           // We draw an arrow head. This means that we will have to draw a shortened line
-          const int shorten = (vector.arrowHead == stats::StatisticsType::ArrowHead::arrow)
-                                  ? headSize * 2
-                                  : headSize * 0.5;
+          const int shorten =
+              (vector.arrowHead == stats::ArrowHead::arrow) ? headSize * 2 : headSize * 0.5;
 
           if (std::sqrt(vx * vx * zoomFactor * zoomFactor + vy * vy * zoomFactor * zoomFactor) >
               shorten)
@@ -169,7 +168,7 @@ void paintVector(QPainter                    *painter,
           // Draw the not shortened line
           painter->drawLine(x1, y1, x2, y2);
 
-        if (vector.arrowHead == stats::StatisticsType::ArrowHead::arrow)
+        if (vector.arrowHead == stats::ArrowHead::arrow)
         {
           // Save the painter state, translate to the arrow tip, rotate the painter and draw the
           // normal triangle.
@@ -185,7 +184,7 @@ void paintVector(QPainter                    *painter,
           // Restore. Revert translation/rotation of the painter.
           painter->restore();
         }
-        else if (vector.arrowHead == stats::StatisticsType::ArrowHead::circle)
+        else if (vector.arrowHead == stats::ArrowHead::circle)
           painter->drawEllipse(x2 - headSize / 2, y2 - headSize / 2, headSize, headSize);
       }
 
@@ -591,11 +590,11 @@ void stats::paintStatisticsData(QPainter              *painter,
                       : zoomFactor / 2;
 
               const auto &arrowHead = it->vectorDataOptions->arrowHead;
-              if (arrowHead != StatisticsType::ArrowHead::none)
+              if (arrowHead != ArrowHead::none)
               {
                 // We draw an arrow head. This means that we will have to draw a shortened line
                 const int shorten =
-                    (arrowHead == StatisticsType::ArrowHead::arrow) ? headSize * 2 : headSize * 0.5;
+                    (arrowHead == ArrowHead::arrow) ? headSize * 2 : headSize * 0.5;
                 if (std::sqrt(vx * vx * zoomFactor * zoomFactor +
                               vy * vy * zoomFactor * zoomFactor) > shorten)
                 {
@@ -611,7 +610,7 @@ void stats::paintStatisticsData(QPainter              *painter,
                 // Draw the not shortened line
                 painter->drawLine(x1, y1, x2, y2);
 
-              if (arrowHead == StatisticsType::ArrowHead::arrow)
+              if (arrowHead == ArrowHead::arrow)
               {
                 // Save the painter state, translate to the arrow tip, rotate the painter and draw
                 // the normal triangle.
@@ -628,7 +627,7 @@ void stats::paintStatisticsData(QPainter              *painter,
                 // Restore. Revert translation/rotation of the painter.
                 painter->restore();
               }
-              else if (arrowHead == StatisticsType::ArrowHead::circle)
+              else if (arrowHead == ArrowHead::circle)
                 painter->drawEllipse(x2 - headSize / 2, y2 - headSize / 2, headSize, headSize);
             }
 
@@ -915,11 +914,11 @@ void stats::paintStatisticsData(QPainter              *painter,
                       : zoomFactor / 2;
 
               const auto &arrowHead = it->vectorDataOptions->arrowHead;
-              if (arrowHead != StatisticsType::ArrowHead::none)
+              if (arrowHead != ArrowHead::none)
               {
                 // We draw an arrow head. This means that we will have to draw a shortened line
                 const int shorten =
-                    (arrowHead == StatisticsType::ArrowHead::arrow) ? headSize * 2 : headSize * 0.5;
+                    (arrowHead == ArrowHead::arrow) ? headSize * 2 : headSize * 0.5;
                 if (std::sqrt(vx * vx * zoomFactor * zoomFactor +
                               vy * vy * zoomFactor * zoomFactor) > shorten)
                 {
@@ -935,7 +934,7 @@ void stats::paintStatisticsData(QPainter              *painter,
                 // Draw the not shortened line
                 painter->drawLine(center_x, center_y, head_x, head_y);
 
-              if (arrowHead == StatisticsType::ArrowHead::arrow)
+              if (arrowHead == ArrowHead::arrow)
               {
                 // Save the painter state, translate to the arrow tip, rotate the painter and draw
                 // the normal triangle.
@@ -952,7 +951,7 @@ void stats::paintStatisticsData(QPainter              *painter,
                 // Restore. Revert translation/rotation of the painter.
                 painter->restore();
               }
-              else if (arrowHead == StatisticsType::ArrowHead::circle)
+              else if (arrowHead == ArrowHead::circle)
                 painter->drawEllipse(
                     head_x - headSize / 2, head_y - headSize / 2, headSize, headSize);
             }

YUViewLib/src/statistics/StatisticsFileCSV.cpp

@@ -405,7 +405,7 @@ void StatisticsFileCSV::readHeaderFromFile(StatisticsData &statisticsData)
           {
             type->vectorDataOptions = StatisticsType::VectorDataOptions();
             if (rowItemList[4] == "line")
-              type->vectorDataOptions->arrowHead = StatisticsType::ArrowHead::none;
+              type->vectorDataOptions->arrowHead = ArrowHead::none;
           }
         }
       }

YUViewLib/src/statistics/StatisticsType.h

@@ -49,9 +49,27 @@ enum class Pattern
   DashDotDot
 };
 
+constexpr EnumMapper<Pattern, 5> PatternMapper = {
+    std::make_pair(Pattern::Solid, "Solid"),
+    std::make_pair(Pattern::Dash, "Dash"),
+    std::make_pair(Pattern::Dot, "Dot"),
+    std::make_pair(Pattern::DashDot, "DashDot"),
+    std::make_pair(Pattern::DashDotDot, "DashDotDot")};
+
 const std::vector<Pattern> AllPatterns = {
     Pattern::Solid, Pattern::Dash, Pattern::Dot, Pattern::DashDot, Pattern::DashDotDot};
 
+enum class ArrowHead
+{
+  arrow,
+  circle,
+  none
+};
+
+constexpr EnumMapper<ArrowHead, 5> ArrowHeadMapper = {std::make_pair(ArrowHead::arrow, "arrow"),
+                                                      std::make_pair(ArrowHead::circle, "circle"),
+                                                      std::make_pair(ArrowHead::none, "none")};
+
 struct LineDrawStyle
 {
   Color   color{};
@@ -92,13 +110,6 @@ class StatisticsType
 
   std::optional<ValueDataOptions> valueDataOptions;
 
-  enum class ArrowHead
-  {
-    arrow,
-    circle,
-    none
-  };
-
   struct VectorDataOptions
   {
     modified<bool>          render{true};

YUViewLib/src/statistics/StatisticsTypePlaylistHandler.cpp

@@ -79,9 +79,9 @@ void addModifiedValuesToElement(YUViewDomElement
     options->colorMapper->savePlaylist(element);
 }
 
-std::vector<StatisticsType::ArrowHead> AllArrowHeads = {StatisticsType::ArrowHead::arrow,
-                                                        StatisticsType::ArrowHead::circle,
-                                                        StatisticsType::ArrowHead::none};
+std::vector<ArrowHead> AllArrowHeads = {ArrowHead::arrow,
+                                                        ArrowHead::circle,
+                                                        ArrowHead::none};
 
 void addModifiedValuesToElement(YUViewDomElement                                       &element,
                                 const std::optional<StatisticsType::VectorDataOptions> &options)

YUViewLib/src/ui/Statisticsstylecontrol.cpp

@@ -436,7 +436,7 @@ void StatisticsStyleControl::on_checkBoxVectorScaleToZoom_stateChanged(int arg1)
 
 void StatisticsStyleControl::on_comboBoxVectorHeadStyle_currentIndexChanged(int index)
 {
-  this->currentItem->vectorDataOptions->arrowHead = (stats::StatisticsType::ArrowHead)(index);
+  this->currentItem->vectorDataOptions->arrowHead = (stats::ArrowHead)(index);
   emit StyleChanged();
 }
 

YUViewUnitTest/common/PrettyPrinting/Common.h

@@ -0,0 +1,59 @@
+/*  This file is part of YUView - The YUV player with advanced analytics toolset
+ *   <https://github.com/IENT/YUView>
+ *   Copyright (C) 2015  Institut für Nachrichtentechnik, RWTH Aachen University, GERMANY
+ *
+ *   This program is free software; you can redistribute it and/or modify
+ *   it under the terms of the GNU General Public License as published by
+ *   the Free Software Foundation; either version 3 of the License, or
+ *   (at your option) any later version.
+ *
+ *   In addition, as a special exception, the copyright holders give
+ *   permission to link the code of portions of this program with the
+ *   OpenSSL library under certain conditions as described in each
+ *   individual source file, and distribute linked combinations including
+ *   the two.
+ *
+ *   You must obey the GNU General Public License in all respects for all
+ *   of the code used other than OpenSSL. If you modify file(s) with this
+ *   exception, you may extend this exception to your version of the
+ *   file(s), but you are not obligated to do so. If you do not wish to do
+ *   so, delete this exception statement from your version. If you delete
+ *   this exception statement from all source files in the program, then
+ *   also delete it here.
+ *
+ *   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 General Public License for more details.
+ *
+ *   You should have received a copy of the GNU General Public License
+ *   along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#pragma once
+
+#include <common/Color.h>
+#include <common/Modified.h>
+#include <common/Typedef.h>
+
+void PrintTo(const bool &flag, std::ostream *os)
+{
+  *os << (flag ? "True" : "False");
+}
+
+template <typename T> void PrintTo(const Range<T> &range, std::ostream *os)
+{
+  *os << "(" << range.min << "," << range.max << ")";
+}
+
+template <typename T> void PrintTo(const modified<T> &value, std::ostream *os)
+{
+  if (value.wasModified())
+    *os << "*";
+  PrintTo(*value, os);
+}
+
+void PrintTo(const Color &color, std::ostream *os)
+{
+  *os << "RGBA(" << color.R() << "," << color.G() << "," << color.B() << "," << color.A() << ")";
+}

YUViewUnitTest/common/PrettyPrinting/Statistics.h

@@ -0,0 +1,162 @@
+/*  This file is part of YUView - The YUV player with advanced analytics toolset
+ *   <https://github.com/IENT/YUView>
+ *   Copyright (C) 2015  Institut für Nachrichtentechnik, RWTH Aachen University, GERMANY
+ *
+ *   This program is free software; you can redistribute it and/or modify
+ *   it under the terms of the GNU General Public License as published by
+ *   the Free Software Foundation; either version 3 of the License, or
+ *   (at your option) any later version.
+ *
+ *   In addition, as a special exception, the copyright holders give
+ *   permission to link the code of portions of this program with the
+ *   OpenSSL library under certain conditions as described in each
+ *   individual source file, and distribute linked combinations including
+ *   the two.
+ *
+ *   You must obey the GNU General Public License in all respects for all
+ *   of the code used other than OpenSSL. If you modify file(s) with this
+ *   exception, you may extend this exception to your version of the
+ *   file(s), but you are not obligated to do so. If you do not wish to do
+ *   so, delete this exception statement from your version. If you delete
+ *   this exception statement from all source files in the program, then
+ *   also delete it here.
+ *
+ *   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 General Public License for more details.
+ *
+ *   You should have received a copy of the GNU General Public License
+ *   along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#pragma once
+
+#include "Common.h"
+
+#include <statistics/ColorMapper.h>
+#include <statistics/StatisticsType.h>
+
+namespace stats
+{
+
+namespace color
+{
+
+void PrintTo(const ColorMap &colorMap, std::ostream *os)
+{
+  *os << "ColorMapper: {";
+  for (const auto &[value, color] : colorMap)
+  {
+    *os << "Value " << value << " ";
+    PrintTo(color, os);
+    *os << " ";
+  }
+  *os << "}";
+}
+
+void PrintTo(const ColorMapper &colorMapper, std::ostream *os)
+{
+  *os << "ColorMapper: {";
+
+  *os << "MappingType " << MappingTypeMapper.getName(colorMapper.mappingType);
+  *os << " valueRange ";
+  PrintTo(colorMapper.valueRange, os);
+  *os << " gradientColorStart ";
+  PrintTo(colorMapper.gradientColorStart, os);
+  *os << " gradientColorEnd ";
+  PrintTo(colorMapper.gradientColorEnd, os);
+  *os << " colorMap ";
+  PrintTo(colorMapper.colorMap, os);
+  *os << " colorMapOther ";
+  PrintTo(colorMapper.colorMapOther, os);
+  *os << " predefinedType " << PredefinedTypeMapper.getName(colorMapper.predefinedType);
+
+  *os << "}";
+}
+
+} // namespace color
+
+void PrintTo(const LineDrawStyle &style, std::ostream *os)
+{
+  *os << "LineDrawStyle: {";
+
+  *os << "color ";
+  PrintTo(style.color, os);
+  *os << " width " << style.width;
+  *os << " pattern " << PatternMapper.getName(style.pattern);
+
+  *os << "}";
+}
+
+void PrintTo(const StatisticsType::ValueDataOptions &options, std::ostream *os)
+{
+  *os << "ValueDataOptions: {";
+
+  *os << "Render ";
+  PrintTo(options.render, os);
+  *os << " ScaleToBlockSize ";
+  PrintTo(options.scaleToBlockSize, os);
+  *os << " ColorMapper ";
+  PrintTo(options.colorMapper, os);
+
+  *os << "}";
+}
+
+void PrintTo(const StatisticsType::VectorDataOptions &options, std::ostream *os)
+{
+  *os << "VectorDataOptions: {";
+
+  *os << "render ";
+  PrintTo(options.render, os);
+  *os << " renderDataValues ";
+  PrintTo(options.renderDataValues, os);
+  *os << " scaleToZoom ";
+  PrintTo(options.scaleToZoom, os);
+  *os << " style ";
+  PrintTo(options.style, os);
+  *os << " scale ";
+  PrintTo(options.scale, os);
+  *os << " mapToColor ";
+  PrintTo(options.mapToColor, os);
+  *os << " arrowHead " << ArrowHeadMapper.getName(options.arrowHead);
+
+  *os << "}";
+}
+
+void PrintTo(const StatisticsType::GridOptions &options, std::ostream *os)
+{
+  *os << "GridOptions: {";
+
+  *os << "render ";
+  PrintTo(options.render, os);
+  *os << " style ";
+  PrintTo(options.style, os);
+  *os << " scaleToZoom ";
+  PrintTo(options.scaleToZoom, os);
+
+  *os << "}";
+}
+
+void PrintTo(const StatisticsType &type, std::ostream *os)
+{
+  *os << "StatisticsType: {";
+  *os << "TypeID " << type.getTypeID();
+  *os << " Name " << type.getTypeName();
+  *os << " Description " << type.getDescription();
+
+  *os << " Render ";
+  PrintTo(type.render, os);
+  *os << " AlphaFactor ";
+  PrintTo(type.alphaFactor, os);
+
+  if (type.valueDataOptions)
+    PrintTo(type.valueDataOptions.value(), os);
+  if (type.vectorDataOptions)
+    PrintTo(type.vectorDataOptions.value(), os);
+  PrintTo(type.gridOptions, os);
+
+  *os << "}";
+}
+
+} // namespace stats