svgview.h

/*!
    SvgView - class representing a sheet of paper with handwritten text.

    It reads settings from a file, loads current font, changes it, places
    letters on a sheet, connects letters within words and displays the result.
    It also generates a QImage for MainWindow::save* functions.

    An algorithm that places characters on a sheet is described in the function
    renderText(). It takes the QStringRef with text, places as many characters
    as possible on a single sheet and returns the number of the first character
    that function has not processed.

    preventGoingBeyondRightMargin() prevents going beyond right margin
    by wrapping or hypphenating words, or just simply starts a new line.
*/
#ifndef SVGVIEW_H
#define SVGVIEW_H

#include <QtCore/QRegularExpression>
#include <QtCore/QTextCodec>
#include <QtCore/QSettings>
#include <QtCore/QtMath>
#include <QtWidgets/QGraphicsView>
#include <QtWidgets/QGraphicsColorizeEffect>
#include <QtWidgets/QApplication>
#include <QtGui/QWheelEvent>
#include <QtSvg/QGraphicsSvgItem>
#include <QtSvg/QSvgRenderer>
#include <QtXml/QDomDocument>

#include "symboldata.h"

class SvgView : public QGraphicsView
{
    Q_OBJECT

public:
    explicit SvgView(QWidget *parent = 0);
    ~SvgView();

    static void scaleViewBox(QDomElement &svgElement);

public slots:
    int renderText(const QStringRef &text = QStringRef());
    QImage saveRenderToImage();
    void loadFont(QString fontpath = QString());
    void loadSettingsFromFile();
    void hideBorders(bool hide);
    void changeLeftRightMargins(bool change);
    QList<QChar> getFontKeys() {return font.uniqueKeys();}

protected:
    void wheelEvent(QWheelEvent *event);

private:
    struct SvgData
    {
        SymbolData symbolData;
        qreal scale;
        QSvgRenderer *renderer;
    };

    QGraphicsScene *scene;
    QMultiMap<QChar, SvgData> font;
    QVector<QVector<QGraphicsSvgItem *>> storedWordItems; //!< there stored items that forming words
    QVector<QVector<SymbolData>> storedSymbolData; //!< data for items in storedWordItems
    int dpi;  //!< dots per inch
    int dpmm; //!< dots per millimeter
    int spacesInTab;
    int seed;
    uint itemsToRemove;
    bool useCustomFontColor, changeMargins, hideMarginsRect, connectingLetters,
         useSeed, roundLines, wordWrap, hyphenateWords, areBordersHidden,
         leftMarginRandomEnabled, symbolJumpRandomEnabled, letterSpacingRandomEnabled,
         markingEnabled, isMarkingLines, drawLeftMargins, drawRightMargins;
    qreal maxScaleFactor = 1.5; //NOTE: If this is exceeded, graphic artifacts will occure
    qreal minScaleFactor = 0.05, currentScaleFactor = 1.0;
    qreal fontSize, penWidth, letterSpacing, lineSpacing, wordSpacing,
          leftMarginRandomValue, symbolJumpRandomValue, letterSpacingRandomValue,
          markingCheckSize, markingLineSize, markingPenWidth, leftMarginsIndent, rightMarginsIndent;
    QRectF sheetRect, marginsRect;
    QColor fontColor, markingColor, marginsColor;
    QVector<QRegularExpression> hyphenRules;

    SymbolData symbolData, previousSymbolData;
    QRectF currentMarginsRect;
    qreal currentLetterSpacing;
    QSizeF symbolBoundingSize;
    QPointF cursor; /*!< cursor is pointing to where will be placed
                         the top left corner of the next character limits */
    QPointF previousSymbolCursor;
    qreal previousSymbolWidth;

    void limitScale(qreal factor);  //!< limited view zoom
    void prepareSceneToRender();
    bool preventGoingBeyondRightMargin(qreal letterWidth, QStringRef text, int currentSymbolIndex);
    void connectLetters();
    void processUnknownSymbol(const QChar &symbol);
    void insertSymbol(QChar key, SymbolData &symbolData);
    void changeAttribute(QString &attribute, QString parameter, QString newValue); //!< changes value of parameter in XML attribute
    bool wrapWords(QStringRef text, int currentSymbolIndex);
    bool wrapLastSymbols(int symbolsToWrap);
    void removeLastSymbols();
    bool hyphenate(QStringRef text, int currentSymbolIndex);
    void loadHyphenRules();
    QRectF changedVerticalMargins();
    QGraphicsSvgItem * generateHyphen(int symbolsToWrap);
    void randomizeMargins();
    void randomizeLetterSpacing();
    QPointF symbolPositionRandomValue();
    void cursorToNewLine();
    void drawMarking();
    void drawMargins();
};

#endif // SVGVIEW_H