csearchanalysisscene.cpp

Go to the documentation of this file.

/*********
*
* In the name of the Father, and of the Son, and of the Holy Spirit.
*
* This file is part of BibleTime's source code, https://bibletime.info/
*
* Copyright 1999-2025 by the BibleTime developers.
* The BibleTime source code is licensed under the GNU General Public License
* version 2.0.
*
**********/
 
#include "csearchanalysisscene.h"
 
#include <algorithm>
#include <QApplication>
#include <QFileDialog>
#include <QMap>
#include <QTextStream>
#include <QTextDocument>
#include <type_traits>
#include <utility>
#include "../../../backend/drivers/cswordmoduleinfo.h"
#include "../../../backend/keys/cswordversekey.h"
#include "../../../util/btassert.h"
#include "../../../util/tool.h"
 
 
namespace Search {
 
const int SPACE_BETWEEN_PARTS = 5;
const int RIGHT_BORDER = 15;
const int LEFT_BORDER = 15;
const int LOWER_BORDER = 10;
const int UPPER_BORDER = 10;
 
const int ITEM_TEXT_SIZE = 8;
 
//used for the shift between the bars
const int BAR_DELTAX = 4;
const int BAR_DELTAY = 2;
const int BAR_WIDTH  = 2 + (2*BAR_DELTAX);  //should be equal or bigger than the label font size
// Used for the text below the bars
const int BAR_LOWER_BORDER = 90;
 
const int LEGEND_INNER_BORDER = 5;
const int LEGEND_DELTAY = 4;
const int LEGEND_WIDTH = 85;
 
CSearchAnalysisScene::CSearchAnalysisScene(
        QString searchedText,
        CSwordModuleSearch::Results const & results,
        QObject * parent)
    : QGraphicsScene(parent)
    , m_searchedText(std::move(searchedText))
{
    setBackgroundBrush(QBrush(Qt::white));
    setSceneRect(0, 0, 1, 1);
 
    for (auto const & result : results)
        if ((result.module->type() == CSwordModuleInfo::Bible)
            || (result.module->type() == CSwordModuleInfo::Commentary))
            m_results.emplace_back(result);
 
    auto const numberOfModules = m_results.size();
    if (!numberOfModules)
        return;
    m_legend = std::make_unique<CSearchAnalysisLegendItem>(&m_results);
    addItem(m_legend.get());
    m_legend->setRect(LEFT_BORDER, UPPER_BORDER,
                      LEGEND_WIDTH, LEGEND_INNER_BORDER*2 + ITEM_TEXT_SIZE*numberOfModules + LEGEND_DELTAY*(numberOfModules - 1) );
    m_legend->show();
 
    int moduleIndex = 0;
    for (auto const & result : m_results) {
        qApp->processEvents(QEventLoop::AllEvents);
        for (auto const & moduleresultPtr : result.results) {
            /* m_results only contains results from Bibles and
               Commentaries, as filtered above. */
            BT_ASSERT(dynamic_cast<sword::VerseKey const *>(
                          moduleresultPtr.get()));
            auto const * const vk =
                    static_cast<sword::VerseKey const *>(
                        moduleresultPtr.get());
            auto key = std::tuple(vk->getTestament(), vk->getBook());
            CSearchAnalysisItem * analysisItem;
            static_assert(std::is_same_v<decltype(key),
                                         decltype(m_itemList)::key_type>, "");
            if (auto const it = m_itemList.find(key); it != m_itemList.end()) {
                analysisItem = it->second;
            } else {
                analysisItem =
                        new CSearchAnalysisItem(
                            QString::fromUtf8(vk->getBookName()),
                            m_results.size());
                m_itemList.emplace(std::move(key), analysisItem);
            }
            auto const count = ++analysisItem->counts()[moduleIndex];
            m_maxCount = std::max(m_maxCount, count);
        }
 
        ++moduleIndex;
    }
 
    int xPos = static_cast<int>(LEFT_BORDER
                                + m_legend->rect().width()
                                + SPACE_BETWEEN_PARTS);
    for (auto const & vp : m_itemList) {
        auto & analysisItem = *vp.second;
        addItem(&analysisItem);
        analysisItem.setRect(xPos,
                             UPPER_BORDER,
                             analysisItem.rect().width(),
                             analysisItem.rect().height());
        xPos += static_cast<int>(analysisItem.width() + SPACE_BETWEEN_PARTS);
 
        QStringList toolTipItems;
        int i = 0;
        for (auto const & result : m_results) {
            auto const * const info = result.module;
 
            auto const count = result.results.size();
            double const percent =
                    (info && count)
                    ? ((static_cast<double>(analysisItem.counts()[i])
                        * static_cast<double>(100.0))
                       / static_cast<double>(count))
                    : 0.0;
            toolTipItems.append(
                        QStringLiteral("%1\">%2</span></b></td><td>%3 (%4")
                        .arg(getColor(i).name(),
                             info ? info->name() : QString(),
                             QString::number(analysisItem.counts()[i]),
                             QString::number(percent, 'g', 2)));
            ++i;
        }
        #define ROW_START "<tr bgcolor=\"white\"><td><b><span style=\"color:"
        #define ROW_END "%)</td></tr>"
        analysisItem.setToolTip(
                    QStringLiteral(
                        "<center><b>%1</b></center><hr/>"
                        "<table cellspacing=\"0\" cellpadding=\"3\" "
                            "width=\"100%\" height=\"100%\" align=\"center\">"
                        ROW_START "%2" ROW_END "</table>")
                    .arg(analysisItem.bookName().toHtmlEscaped(),
                         toolTipItems.join(QStringLiteral(ROW_END ROW_START))));
        #undef ROW_START
        #undef ROW_END
    }
    setSceneRect(0, 0, xPos + BAR_WIDTH + (m_results.size() - 1)*BAR_DELTAX + RIGHT_BORDER, height() );
    slotResized();
}
 
/** No descriptions */
void CSearchAnalysisScene::slotResized() {
    double scaleFactor;
    if (m_maxCount <= 0) {
        scaleFactor = 0.0;
    } else {
        scaleFactor = static_cast<double>(height() - UPPER_BORDER - LOWER_BORDER - BAR_LOWER_BORDER - 100 - (m_results.size() - 1) * BAR_DELTAY)
                      / static_cast<double>(m_maxCount);
    }
    for (auto const & vp : m_itemList) {
        auto & analysisItem = *vp.second;
        analysisItem.setScaleFactor(scaleFactor);
        analysisItem.setRect(analysisItem.rect().x(),
                             UPPER_BORDER,
                             BAR_WIDTH + (m_results.size() - 1) * BAR_DELTAX,
                             height() - LOWER_BORDER - BAR_LOWER_BORDER);
    }
    update();
}
 
/** This function returns a color for each module */
QColor CSearchAnalysisScene::getColor(int index) {
    switch (index) {
        case  0:
            return Qt::red;
        case  1:
            return Qt::darkGreen;
        case  2:
            return Qt::blue;
        case  3:
            return Qt::cyan;
        case  4:
            return Qt::magenta;
        case  5:
            return Qt::darkRed;
        case  6:
            return Qt::darkGray;
        case  7:
            return Qt::black;
        case  8:
            return Qt::darkCyan;
        case  9:
            return Qt::darkMagenta;
        default:
            return Qt::red;
    }
}
 
void CSearchAnalysisScene::saveAsHTML() const {
    auto const fileName =
            QFileDialog::getSaveFileName(
                nullptr,
                tr("Save Search Analysis"),
                QString(),
                QObject::tr("HTML files") + QStringLiteral(" (*.html *.htm);;")
                + QObject::tr("All files") + QStringLiteral(" (*)"));
    if (fileName.isEmpty())
        return;
 
    struct UserData { CSearchAnalysisScene const & obj; } userData{*this};
    static auto const writer =
            +[](QTextStream & out, void * userPtr)
            { static_cast<UserData const * >(userPtr)->obj.saveAsHTML(out); };
    util::tool::savePlainFile(fileName, *writer, &userData);
}
 
void CSearchAnalysisScene::saveAsHTML(QTextStream & out) const {
    auto const title(tr("BibleTime Search Analysis"));
    out << QStringLiteral(
               "<?xml version=\"1.0\" encoding=\"UTF-8\"?>"
               "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\" "
               "\"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">"
               "<html xmlns=\"http://www.w3.org/1999/xhtml\"><head><title>")
        << title
        << QStringLiteral(
               "</title>"
               "<style type=\"text/css\">"
                   "body{background-color:#fff;color:#000}"
                   "table{border-collapse:collapse}"
                   "td{border:1px solid #333}"
                   "th{font-size:130%;text-align:left;vertical-align:top}"
                   "td,th{text-align:left;padding:0.2em 0.5em}"
                   ".r{text-align:right}"
               "</style>"
               "<meta http-equiv=\"Content-Type\" "
                   "content=\"text/html; charset=utf-8\"/>"
           "</head><body><h1>")
        << title
        << QStringLiteral("</h1><p><span style=\"font-weight:bold\">")
        << tr("Search text:")
        << QStringLiteral("</span>&nbsp;")
        << m_searchedText.toHtmlEscaped()
        << QStringLiteral("</p><table><caption>")
        << tr("Results by work and book")
        << QStringLiteral("</caption><tr><th>")
        << tr("Book")
        << QStringLiteral("</th>");
 
    for (auto const & result : m_results)
        out << QStringLiteral("<th>")
            << result.module->name().toHtmlEscaped()
            << QStringLiteral("</th>");
    out << QStringLiteral("</tr>");
 
    for (auto const & vp : m_itemList) {
        auto const & analysisItem = *vp.second;
        out << QStringLiteral("<tr><td>")
            << analysisItem.bookName().toHtmlEscaped()
            << QStringLiteral("</td>");
        for (auto const count : analysisItem.counts())
            out << QStringLiteral("<td class=\"r\">")
                << QString::number(count)
                << QStringLiteral("</td>");
        out << QStringLiteral("</tr>");
    }
    out << QStringLiteral("<tr><th class=\"r\">")
        << tr("Total hits")
        << QStringLiteral("</th>");
 
    for (auto const & result : m_results) {
        out << QStringLiteral("<td class=\"r\">")
            << QString::number(result.results.size())
            << QStringLiteral("</td>");
    }
 
    out << QStringLiteral("</tr></table><p style=\"text-align:center;"
                          "font-size:x-small\">")
        << tr("Created by <a href=\"%1\">BibleTime</a>").arg(BT_HOMEPAGE)
        << QStringLiteral("</p></body></html>");
}
 
void CSearchAnalysisScene::resizeHeight(int height) {
    setSceneRect(0, 0, sceneRect().width(), height);
    slotResized();
}
 
} // namespace Search {