cdisplaytemplatemgr.h

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-2021 by the BibleTime developers.
* The BibleTime source code is licensed under the GNU General Public License
* version 2.0.
*
**********/
 
#pragma once
 
#include <QHash>
#include <QString>
#include <QStringList>
#include "../../util/btassert.h"
#include "../drivers/btmodulelist.h"
#include "../drivers/cswordmoduleinfo.h"
 
 
/**
  Manages the display templates used in the filters and display classes.
  \note This is a singleton.
*/
class CDisplayTemplateMgr {
 
    public: // types:
 
        /**
          Settings which are used to fill the content into the template.
        */
        struct Settings {
 
            char const * textDirectionAsHtmlDirAttr() const noexcept {
                return textDirection == CSwordModuleInfo::LeftToRight ? "ltr" : "rtl";
            }
 
            /** The list of modules */
            BtConstModuleList modules;
 
            /** The title which is used for the new processed HTML page */
            QString title;
 
            /** The language for the HTML page. */
            QString langAbbrev{"en"};
 
            /** The CSS ID which is used in the content part of the page */
            QString pageCSS_ID;
 
            /** The language direction for the HTML page. */
            CSwordModuleInfo::TextDirection textDirection =
                    CSwordModuleInfo::LeftToRight;
 
        };
 
    public: // methods:
 
        /**
          \param[out] errorMessage Set to error string on error, otherwise set
                                   to QString().
        */
        explicit CDisplayTemplateMgr(QString & errorMessage);
 
        /**
          \returns the list of available templates.
        */
        QStringList const & availableTemplates() const
        { return m_availableTemplateNamesCache; }
 
        /**
          \brief Fills the template.
 
          Fills rendered content into the template given by the name.
 
          \param name The name of the template to fill.
          \param content The content which should be filled into the template.
          \param settings The settings which are used to process the templating
                          process.
 
          \returns The full HTML template HTML code including the CSS data.
        */
        QString fillTemplate(const QString & name,
                             const QString & content,
                             const Settings & settings) const;
 
        /**
          \returns the name of the active template.
        */
        static QString activeTemplateName();
 
        /**
          \returns The singleton instance of the instance of this class.
        */
        static CDisplayTemplateMgr * instance() {
            BT_ASSERT(m_instance);
            return m_instance;
        }
        /**
          \brief Turn on or off displaying module names during parallel text rendering
 
          \param visible display module names
        */
        void setMultiModuleHeadersVisible(bool visible);
 
    private: // methods:
 
        /** Preloads a single template from disk: */
        void loadTemplate(const QString & filename);
        void loadCSSTemplate(const QString & filename);
 
    private: // fields:
 
        bool m_multiModuleHeaders;
        QHash<QString, QString> m_templateMap;
        QHash<QString, QString> m_cssMap;
        static CDisplayTemplateMgr * m_instance;
        QStringList m_availableTemplateNamesCache;
 
};