KoSvgTextShapeMarkupConverter.cpp File Reference

#include "KoSvgTextShapeMarkupConverter.h"
#include "klocalizedstring.h"
#include "kis_assert.h"
#include "kis_debug.h"
#include <ft2build.h>
#include <QXmlStreamReader>
#include <QXmlStreamWriter>
#include <QBuffer>
#include <QTextCodec>
#include <QtMath>
#include <QTextBlock>
#include <QTextLayout>
#include <QTextLine>
#include <QFont>
#include <QStack>
#include <QStringView>
#include <KoSvgTextShape.h>
#include <KoXmlWriter.h>
#include <KoDocumentResourceManager.h>
#include <KoColor.h>
#include <SvgParser.h>
#include <SvgWriter.h>
#include <SvgUtil.h>
#include <SvgSavingContext.h>
#include <SvgGraphicContext.h>
#include <html/HtmlSavingContext.h>
#include <html/HtmlWriter.h>
#include "kis_dom_utils.h"
#include <boost/optional.hpp>
#include <FlakeDebug.h>

Go to the source code of this file.

Classes
struct	KoSvgTextShapeMarkupConverter::ExtraStyles
struct	KoSvgTextShapeMarkupConverter::Private

Functions
qreal	calcLineWidth (const QTextBlock &block)
bool	compareFormatUnderlineWithMostCommon (QTextCharFormat format, QTextCharFormat mostCommon)
QString	convertFormatUnderlineToSvg (QTextCharFormat format)
QTextFormat	findMostCommonFormat (const QList< QTextFormat > &allFormats)
qreal	fixFromQtDpi (qreal value)
qreal	fixToQtDpi (qreal value)
static bool	guessIsRightToLeft (QStringView text)
void	parseTextAttributes (const QXmlStreamAttributes &elementAttributes, QTextCharFormat &charFormat, QTextBlockFormat &blockFormat, KoSvgTextShapeMarkupConverter::ExtraStyles &extraStyles)
void	postCorrectBlockHeight (QTextDocument *doc, qreal currLineAscent, qreal prevLineAscent, qreal prevLineDescent, int prevBlockCursorPosition, qreal currentBlockAbsoluteLineOffset)
Q_GUI_EXPORT int	qt_defaultDpi ()

Function Documentation

calcLineWidth()

qreal calcLineWidth

(

const QTextBlock &

block

)

Definition at line 535 of file KoSvgTextShapeMarkupConverter.cpp.

{
    const QString blockText = block.text();
 
    QTextLayout lineLayout;
    lineLayout.setText(blockText);
    lineLayout.setFont(block.charFormat().font());
    lineLayout.setFormats(block.textFormats());
    lineLayout.setTextOption(block.layout()->textOption());
 
    lineLayout.beginLayout();
    QTextLine fullLine = lineLayout.createLine();
    if (!fullLine.isValid()) {
        fullLine.setNumColumns(blockText.size());
    }
    lineLayout.endLayout();
 
    return fixFromQtDpi(lineLayout.boundingRect().width());
}

References fixFromQtDpi().

compareFormatUnderlineWithMostCommon()

bool compareFormatUnderlineWithMostCommon	(	QTextCharFormat	format,
		QTextCharFormat	mostCommon )

Definition at line 1131 of file KoSvgTextShapeMarkupConverter.cpp.

{
    // color and style is not supported in rich text editor yet
    // TODO: support color and style
    return format.fontUnderline() == mostCommon.fontUnderline()
            && format.fontOverline() == mostCommon.fontOverline()
            && format.fontStrikeOut() == mostCommon.fontStrikeOut();
}

convertFormatUnderlineToSvg()

QString convertFormatUnderlineToSvg

(

QTextCharFormat

format

)

Definition at line 1140 of file KoSvgTextShapeMarkupConverter.cpp.

{
    // color and style is not supported in rich text editor yet
    // and text-decoration-line and -style and -color are not supported in svg render either
    // hence we just use text-decoration
    // TODO: support color and style
    QStringList line;
 
    if (format.fontUnderline()) {
        line.append("underline");
        if (format.underlineStyle() != QTextCharFormat::SingleUnderline) {
            warnFile << "Krita only supports solid underline style";
        }
    }
 
    if (format.fontOverline()) {
        line.append("overline");
    }
 
    if (format.fontStrikeOut()) {
        line.append("line-through");
    }
 
    if (line.isEmpty())
    {
        line.append("none");
    }
 
    QString c = QString("text-decoration").append(":")
            .append(line.join(" "));
 
    return c;
}

References warnFile.

findMostCommonFormat()

QTextFormat findMostCommonFormat

(

const QList< QTextFormat > &

allFormats

)

Get all existing property ids

Filter out properties that do not exist in some formats. Otherwise, the global format may override the default value used in these formats (and yes, we do not have access to the default values to use them in difference calculation algorithm

Calculate the frequency of values used in all the formats

Add the most popular property value to the set of most common properties

Definition at line 434 of file KoSvgTextShapeMarkupConverter.cpp.

{
    QTextCharFormat mostCommonFormat;
 
    QSet<int> propertyIds;
 
    Q_FOREACH (const QTextFormat &format, allFormats) {
        const QMap<int, QVariant> formatProperties = format.properties();
        Q_FOREACH (int id, formatProperties.keys()) {
            propertyIds.insert(id);
        }
    }
 
    Q_FOREACH (const QTextFormat &format, allFormats) {
        for (auto it = propertyIds.begin(); it != propertyIds.end();) {
            if (!format.hasProperty(*it)) {
                it = propertyIds.erase(it);
            } else {
                ++it;
            }
        }
        if (propertyIds.isEmpty()) break;
    }
 
    if (!propertyIds.isEmpty()) {
        QMap<int, QList<std::pair<QVariant, int>>> propertyFrequency;
 
        Q_FOREACH (const QTextFormat &format, allFormats) {
            const QMap<int, QVariant> formatProperties = format.properties();
 
            Q_FOREACH (int id, propertyIds) {
                KIS_SAFE_ASSERT_RECOVER_BREAK(formatProperties.contains(id));
                QList<std::pair<QVariant, int>> &valueFrequencies = propertyFrequency[id];
                const QVariant formatPropValue = formatProperties.value(id);
 
                // Find the value in frequency table
                auto it = std::find_if(valueFrequencies.begin(), valueFrequencies.end(),
                [formatPropValue](const std::pair<QVariant, int> &element) { return element.first == formatPropValue; });
 
                if (it != valueFrequencies.end()) {
                    // Increase frequency by 1, if already met
                    it->second += 1;
                } else {
                    // Add with initial frequency of 1 if met for the first time
                    valueFrequencies.push_back({formatPropValue, 1});
                }
            }
        }
 
        for (auto it = propertyFrequency.constBegin(); it != propertyFrequency.constEnd(); ++it) {
            const int id = it.key();
            const QList<std::pair<QVariant, int>>& allValues = it.value();
 
            int maxCount = 0;
            QVariant maxValue;
 
            for (const auto& [propValue, valFrequency] : allValues) {
                if (valFrequency > maxCount) {
                    maxCount = valFrequency;
                    maxValue = propValue;
                }
            }
 
            KIS_SAFE_ASSERT_RECOVER_BREAK(maxCount > 0);
            mostCommonFormat.setProperty(id, maxValue);
        }
 
    }
 
    return mostCommonFormat;
}

References KIS_SAFE_ASSERT_RECOVER_BREAK.

fixFromQtDpi()

qreal fixFromQtDpi

(

qreal

value

)

Definition at line 523 of file KoSvgTextShapeMarkupConverter.cpp.

{
    // HACK ALERT: see a comment in convertDocumentToSvg!
    return value * 72.0 / qt_defaultDpi();
}

References qt_defaultDpi(), and value().

fixToQtDpi()

qreal fixToQtDpi

(

qreal

value

)

Definition at line 529 of file KoSvgTextShapeMarkupConverter.cpp.

{
    // HACK ALERT: see a comment in convertDocumentToSvg!
    return value * qt_defaultDpi() / 72.0;
}

References qt_defaultDpi(), and value().

guessIsRightToLeft()

static bool guessIsRightToLeft ( QStringView text )

static

Mind blowing part: QTextEdit uses a hi-end algorithm for auto-estimation for the text directionality, so the user expects his text being saved to SVG with the same directionality. Just emulate behavior of direction="auto", which is not supported by SVG 1.1

BUG: 392064

Definition at line 563 of file KoSvgTextShapeMarkupConverter.cpp.

                                                 {
    // Is this just a worse version of QString::isRightToLeft??
    for (int i = 0; i < text.size(); i++) {
        const QChar ch = text[i];
        if (ch.direction() == QChar::DirR || ch.direction() == QChar::DirAL) {
            return true;
        } else if (ch.direction() == QChar::DirL) {
            return false;
        }
    }
    return false;
}

parseTextAttributes()

void parseTextAttributes	(	const QXmlStreamAttributes &	elementAttributes,
		QTextCharFormat &	charFormat,
		QTextBlockFormat &	blockFormat,
		KoSvgTextShapeMarkupConverter::ExtraStyles &	extraStyles )

Definition at line 865 of file KoSvgTextShapeMarkupConverter.cpp.

{
    QString styleString;
 
    // we convert all the presentation attributes into styles
    QString presentationAttributes;
    for (int a = 0; a < elementAttributes.size(); a++) {
        if (elementAttributes.at(a).name() != "style") {
            presentationAttributes
                    .append(elementAttributes.at(a).name().toString())
                    .append(":")
                    .append(elementAttributes.at(a).value().toString())
                    .append(";");
        }
    }
 
    if (presentationAttributes.endsWith(";")) {
        presentationAttributes.chop(1);
    }
 
    if (elementAttributes.hasAttribute("style")) {
        styleString = elementAttributes.value("style").toString();
        if (styleString.endsWith(";")) {
            styleString.chop(1);
        }
    }
 
    if (!styleString.isEmpty() || !presentationAttributes.isEmpty()) {
        //add attributes to parse them as part of the style.
        styleString.append(";")
                .append(presentationAttributes);
        QStringList styles = styleString.split(";");
        QVector<QTextFormat> formats =
            KoSvgTextShapeMarkupConverter::stylesFromString(styles, charFormat, blockFormat, extraStyles);
 
        charFormat = formats.at(0).toCharFormat();
        blockFormat = formats.at(1).toBlockFormat();
    }
}

References KoSvgTextShapeMarkupConverter::stylesFromString().

postCorrectBlockHeight()

void postCorrectBlockHeight	(	QTextDocument *	doc,
		qreal	currLineAscent,
		qreal	prevLineAscent,
		qreal	prevLineDescent,
		int	prevBlockCursorPosition,
		qreal	currentBlockAbsoluteLineOffset )

Definition at line 411 of file KoSvgTextShapeMarkupConverter.cpp.

{
    KIS_SAFE_ASSERT_RECOVER_RETURN(prevBlockCursorPosition >= 0);
 
    QTextCursor postCorrectionCursor(doc);
    postCorrectionCursor.setPosition(prevBlockCursorPosition);
    if (!postCorrectionCursor.isNull()) {
        const qreal relativeLineHeight =
                ((currentBlockAbsoluteLineOffset - currLineAscent + prevLineAscent) /
                 (prevLineAscent + prevLineDescent)) * 100.0;
 
        QTextBlockFormat format = postCorrectionCursor.blockFormat();
        format.setLineHeight(relativeLineHeight, QTextBlockFormat::ProportionalHeight);
        postCorrectionCursor.setBlockFormat(format);
        postCorrectionCursor = QTextCursor();
    }
}

References KIS_SAFE_ASSERT_RECOVER_RETURN.

qt_defaultDpi()

Q_GUI_EXPORT int qt_defaultDpi

(

)