CbmRoot
Loading...
Searching...
No Matches
CbmQaReportHtmlEngine.cxx
Go to the documentation of this file.
1/* Copyright (C) 2024 GSI Helmholtzzentrum fuer Schwerionenforschung, Darmstadt
2 SPDX-License-Identifier: GPL-3.0-only
3 Authors: Sergei Zharko [committer] */
4
9
10#include "CbmQaReportHtmlEngine.h"
11
12#include "CbmQaReportFigure.h"
13#include "CbmQaReportHeader.h"
14#include "CbmQaReportSection.h"
15#include "CbmQaReportTable.h"
16#include "CbmQaReportTail.h"
17
18using cbm::qa::report::Figure;
19using cbm::qa::report::Header;
20using cbm::qa::report::HtmlEngine;
21using cbm::qa::report::Section;
22using cbm::qa::report::Table;
23using cbm::qa::report::Tail;
24
25#include <algorithm>
26#include <chrono>
27#include <ctime>
28#include <iomanip>
29#include <sstream>
30//#include <regex>
31
32#include <fmt/format.h>
33
34// ---------------------------------------------------------------------------------------------------------------------
35//
36std::string HtmlEngine::FigureBody(const Figure& figure) const
37{
38 std::stringstream out;
39 out << "<figure>\n";
40 for (const auto& plot : figure.GetPlots()) {
41 out << " <embed src=\"" << plot.fsPath << "\" style=\"width:" << kFigureWidth << "\">\n";
42 }
43 if (!figure.GetCaption().empty()) {
44 out << " <figcaption>Fig.[" << figure.GetLabel() << "]: " << figure.GetCaption() << "</figcaption>\n";
45 }
46 out << "</figure>\n";
47
48 return out.str();
49}
50
51// ---------------------------------------------------------------------------------------------------------------------
52//
53std::string HtmlEngine::HeaderBody(const Header& header) const
54{
55 std::stringstream out;
56
57 // TODO: Move these definitions to text-file (?)
58 // Settings
59 out << "<!DOCTYPE html>\n";
60 out << "<html>\n";
61 out << "<style>\n";
62 out << "table {\n boarder-collapse: collapse;\n width: 100%;\n"
63 << "}\n";
64 out << "th, td {\n text-align: " << kTableTextAlign << ";\n padding: " << kTablePadding << "px;\n"
65 << "}\n";
66 out << "tr:nth-child(even) {\n background-color: #EEEEEE;\n}\n";
67 out << "</style>\n";
68 out << "<head>\n";
69 out << " <title>" << header.GetTitle() << "</title>\n";
70 out << "</head>\n\n";
71 out << "<body>\n";
72 out << "<h1>" << header.GetTitle() << "</h1>\n\n";
73 if (!header.GetSubtitle().empty()) {
74 out << "<h2>" << header.GetSubtitle() << "</h2>\n\n";
75 }
76 auto timeNow = std::chrono::system_clock::to_time_t(std::chrono::system_clock::now());
77 out << "<table style=\"width:1\">\n";
78 out << " <tr>\n";
79 out << " <td>Generated on:</td>\n";
80 out << " <td>" << std::put_time(std::localtime(&timeNow), "%a %d.%m.%Y, %X") << "</td>\n";
81 out << " </tr>\n";
82 out << " <tr>\n";
83 out << " <td>Author:</td>\n";
84 out << " <td>" << header.GetAuthor() << "</td>\n";
85 out << " </tr>\n";
86 if (!header.GetSetup().empty()) {
87 out << " <tr>\n";
88 out << " <td>Setup:</td>\n";
89 out << " <td>" << header.GetSetup() << "</td>\n";
90 out << " </tr>\n";
91 }
92 out << "</table>\n\n";
93
94 return out.str();
95}
96
97// ---------------------------------------------------------------------------------------------------------------------
98//
99std::string HtmlEngine::SectionBody(const Section& section) const
100{
101 std::stringstream out;
102 std::string sSectionTag = fmt::format("h{}", std::min((section.GetLevel() + 2), 6));
103
104 out << '<' << sSectionTag << '>' << section.GetTitle() << "</" << sSectionTag << ">\n\n";
105 for (const auto& pElement : section.GetDaughterElements()) {
106 out << pElement->GetBody(*this) << '\n';
107 }
108 out << '\n';
109 return out.str();
110}
111
112
113// ---------------------------------------------------------------------------------------------------------------------
114//
115std::string HtmlEngine::TableBody(const Table& table) const
116{
117 std::stringstream out;
118 int nRows = table.GetNofRows();
119 int nCols = table.GetNofCols();
120
121 out << "<table>\n";
122 // tabular header
123 if (!table.GetCaption().empty()) {
124 out << " <tablecaption>Table: " << table.GetCaption() << "</tablecaption>\n";
125 }
126 // table header
127 out << " <tr>\n";
128 for (int iCol = 0; iCol < nCols; ++iCol) {
129 out << " <th>" << table.GetColumnTitle(iCol) << "</th>\n";
130 }
131 out << " </tr>\n";
132 // table body
133 for (int iRow = 0; iRow < nRows; ++iRow) {
134 out << " <tr>\n";
135 for (int iCol = 0; iCol < nCols; ++iCol) {
136 out << " <td>" << table(iRow, iCol) << "</td>\n";
137 }
138 out << " </tr>\n";
139 }
140 out << "</table>\n";
141 return out.str();
142}
143
144
145// ---------------------------------------------------------------------------------------------------------------------
146//
147std::string HtmlEngine::TailBody(const Tail&) const
148{
149 std::stringstream out;
150 out << '\n';
151 out << "</body>\n";
152 out << "</html>\n";
153 return out.str();
154}
CbmQaReportFigure.h
Base class for the report figure (header)
CbmQaReportHeader.h
Base class for the report header (header)
CbmQaReportHtmlEngine.h
HTML document engine for the cbm::qa::report (source)
CbmQaReportSection.h
Base class for the report section (header)
CbmQaReportTable.h
Base class for the report table (header)
cbm::qa::report::CollapsibleElement::GetDaughterElements
const std::vector< std::shared_ptr< Element > > GetDaughterElements() const
Get daughter elements.
Definition CbmQaReportElement.h:87
cbm::qa::report::Element::GetTitle
const std::string & GetTitle() const
Gets name.
Definition CbmQaReportElement.h:48
cbm::qa::report::Element::GetLabel
const std::string & GetLabel() const
Gets label.
Definition CbmQaReportElement.h:45
cbm::qa::report::Figure
Figure in the report.
Definition CbmQaReportFigure.h:19
cbm::qa::report::Figure::GetCaption
const std::string & GetCaption() const
Gets caption.
Definition CbmQaReportFigure.h:64
cbm::qa::report::Figure::GetPlots
const std::vector< Plot > & GetPlots() const
Gets plot vector.
Definition CbmQaReportFigure.h:70
cbm::qa::report::Header
Header of the report.
Definition CbmQaReportHeader.h:21
cbm::qa::report::Header::GetTitle
const std::string & GetTitle() const
Gets title.
Definition CbmQaReportHeader.h:49
cbm::qa::report::Header::GetSubtitle
const std::string & GetSubtitle() const
Gets subtitle.
Definition CbmQaReportHeader.h:43
cbm::qa::report::Header::GetSetup
const std::string & GetSetup() const
Gets setup.
Definition CbmQaReportHeader.h:40
cbm::qa::report::Header::GetAuthor
const std::string & GetAuthor() const
Gets author.
Definition CbmQaReportHeader.h:34
cbm::qa::report::HtmlEngine::kTableTextAlign
static constexpr std::string_view kTableTextAlign
Table: align.
Definition CbmQaReportHtmlEngine.h:57
cbm::qa::report::HtmlEngine::kFigureWidth
static constexpr double kFigureWidth
Figure width [in page width].
Definition CbmQaReportHtmlEngine.h:56
cbm::qa::report::HtmlEngine::TableBody
std::string TableBody(const Table &table) const override
Creates a body for table.
Definition CbmQaReportHtmlEngine.cxx:115
cbm::qa::report::HtmlEngine::TailBody
std::string TailBody(const Tail &tail) const override
Creates a body for tail.
Definition CbmQaReportHtmlEngine.cxx:147
cbm::qa::report::HtmlEngine::FigureBody
std::string FigureBody(const Figure &figure) const override
Creates a body for figure.
Definition CbmQaReportHtmlEngine.cxx:36
cbm::qa::report::HtmlEngine::HeaderBody
std::string HeaderBody(const Header &header) const override
Creates a body for header.
Definition CbmQaReportHtmlEngine.cxx:53
cbm::qa::report::HtmlEngine::kTablePadding
static constexpr int kTablePadding
Table: rows padding [px].
Definition CbmQaReportHtmlEngine.h:58
cbm::qa::report::HtmlEngine::SectionBody
std::string SectionBody(const Section &section) const override
Creates a body for section.
Definition CbmQaReportHtmlEngine.cxx:99
cbm::qa::report::Section
Section of the report.
Definition CbmQaReportSection.h:22
cbm::qa::report::Section::GetLevel
int GetLevel() const
Gets level of the section.
Definition CbmQaReportSection.h:43
cbm::qa::report::Table
Table element in the report.
Definition CbmQaReportTable.h:21
cbm::qa::report::Table::GetColumnTitle
const std::string & GetColumnTitle(int iCol) const
Gets column title.
Definition CbmQaReportTable.h:65
cbm::qa::report::Table::GetNofRows
int GetNofRows() const
Gets number of rows.
Definition CbmQaReportTable.h:68
cbm::qa::report::Table::GetNofCols
int GetNofCols() const
Gets number of columns.
Definition CbmQaReportTable.h:71
cbm::qa::report::Table::GetCaption
const std::string & GetCaption() const
Gets caption.
Definition CbmQaReportTable.h:56
cbm::qa::report::Tail
Tail of the report.
Definition CbmQaReportTail.h:21