Contains data used for loading svg. More...

#include <SvgLoadingContext.h>

Inheritance diagram for SvgLoadingContext:

Public Types
typedef std::function< QByteArray(const QString &)	FileFetcherFunc)

Public Member Functions
QString	absoluteFilePath (const QString &href)
	Constructs an absolute file path from the given href and current xml base directory.

void	addDefinition (const QDomElement &element)
	Adds a definition for later use.

void	addStyleSheet (const QDomElement &styleSheet)
	Adds a css style sheet.

SvgGraphicsContext *	currentGC () const
	Returns the current graphics context.

QDomElement	definition (const QString &id) const
	Returns the definition with the specified id.

QByteArray	fetchExternalFile (const QString &url)

bool	hasDefinition (const QString &id) const
	Checks if a definition with the specified id exists.

bool	isRootContext () const

QStringList	matchingCssStyles (const QDomElement &element) const
	Returns list of css styles matching to the specified element.

int	nextZIndex ()
	Returns the next z-index.

void	parseProfile (const QDomElement &element)
	parses 'color-profile' tag and saves it in the context

void	popGraphicsContext ()
	Pops the current graphics context from the stack.

	Private ()

QHash< QString, const KoColorProfile * >	profiles ()
	Return the profiles in the context.

SvgGraphicsContext *	pushGraphicsContext (const QDomElement &element=QDomElement(), bool inherit=true)
	Pushes a new graphics context to the stack.

void	registerShape (const QString &id, KoShape *shape)
	Registers a shape so it can be referenced later.

QString	relativeFilePath (const QString &href)

KoSvgTextProperties	resolvedProperties () const
	These are the text properties, completely resolved, ensuring that everything is inherited and the sizes are converted to pt.

void	setFileFetcher (FileFetcherFunc func)

void	setInitialXmlBaseDir (const QString &baseDir)
	Sets the initial xml base dir, i.e. the directory the svg file is read from.

KoShape *	shapeById (const QString &id)
	Returns shape with specified id.

SvgStyleParser &	styleParser ()
	Returns a style parser to parse styles.

	SvgLoadingContext (KoDocumentResourceManager *documentResourceManager)

QString	xmlBaseDir () const
	Returns the current xml base dir.

	~Private ()

	~SvgLoadingContext ()

Public Attributes
SvgCssHelper	cssStyles

QHash< QString, QDomElement >	definitions

KoDocumentResourceManager *	documentResourceManager

FileFetcherFunc	fileFetcher

QStack< SvgGraphicsContext * >	gcStack

QString	initialXmlBaseDir

QHash< QString, KoShape * >	loadedShapes

QHash< QString, const KoColorProfile * >	profiles

SvgStyleParser *	styleParser

int	zIndex

Private Attributes
QScopedPointer< Private >	d

Private Attributes inherited from Private
KisCanvas2 *	canvas

int	displayedFrame

int	intendedFrame

Additional Inherited Members
Private Member Functions inherited from Private
	Private (KisCanvas2 *c)

Detailed Description

Contains data used for loading svg.

Definition at line 27 of file SvgLoadingContext.cpp.

Member Typedef Documentation

◆ FileFetcherFunc

typedef std::function<QByteArray(const QString&) SvgLoadingContext::FileFetcherFunc)

Definition at line 89 of file SvgLoadingContext.h.

Constructor & Destructor Documentation

◆ ~Private()

SvgLoadingContext::~Private ( )

inline

Definition at line 38 of file SvgLoadingContext.cpp.

    {
        if (! gcStack.isEmpty() && !gcStack.top()->isResolutionFrame) {
            // Resolution frame is usually the first and is not removed.
            warnFlake << "the context stack is not empty (current count" << gcStack.size() << ", expected 0)";
        }
        qDeleteAll(gcStack);
        gcStack.clear();
        delete styleParser;
    }

References warnFlake.

◆ SvgLoadingContext()

SvgLoadingContext::SvgLoadingContext ( KoDocumentResourceManager * documentResourceManager )

explicit

Definition at line 60 of file SvgLoadingContext.cpp.

    : d(new Private())
{
    d->documentResourceManager = documentResourceManager;
    d->styleParser = new SvgStyleParser(*this);
    Q_ASSERT(d->documentResourceManager);
}

References d, and documentResourceManager.

◆ ~SvgLoadingContext()

SvgLoadingContext::~SvgLoadingContext ( )

Definition at line 68 of file SvgLoadingContext.cpp.

69{

70}

Member Function Documentation

◆ absoluteFilePath()

QString SvgLoadingContext::absoluteFilePath ( const QString & href )

Constructs an absolute file path from the given href and current xml base directory.

Definition at line 136 of file SvgLoadingContext.cpp.

{
    QFileInfo info(href);
    if (! info.isRelative())
        return href;
 
    SvgGraphicsContext *gc = currentGC();
    if (!gc)
        return d->initialXmlBaseDir;
 
    QString baseDir = d->initialXmlBaseDir;
    if (! gc->xmlBaseDir.isEmpty())
        baseDir = absoluteFilePath(gc->xmlBaseDir);
 
    QFileInfo pathInfo(QFileInfo(baseDir).filePath());
 
    QString relFile = href;
    while (relFile.startsWith(QLatin1String("../"))) {
        relFile.remove(0, 3);
        pathInfo.setFile(pathInfo.dir(), QString());
    }
 
    QString absFile = pathInfo.absolutePath() + '/' + relFile;
 
    return absFile;
}

References absoluteFilePath(), currentGC(), d, and SvgGraphicsContext::xmlBaseDir.

◆ addDefinition()

void SvgLoadingContext::addDefinition ( const QDomElement & element )

Adds a definition for later use.

Definition at line 200 of file SvgLoadingContext.cpp.

{
    const QString id = element.attribute("id");
    if (id.isEmpty() || d->definitions.contains(id))
        return;
    d->definitions.insert(id, element);
}

References d.

◆ addStyleSheet()

void SvgLoadingContext::addStyleSheet ( const QDomElement & styleSheet )

Adds a css style sheet.

Definition at line 218 of file SvgLoadingContext.cpp.

{
    d->cssStyles.parseStylesheet(styleSheet);
}

References d.

◆ currentGC()

SvgGraphicsContext * SvgLoadingContext::currentGC ( ) const

Returns the current graphics context.

Definition at line 72 of file SvgLoadingContext.cpp.

{
    if (d->gcStack.isEmpty())
        return 0;
 
    return d->gcStack.top();
}

References d.

◆ definition()

QDomElement SvgLoadingContext::definition ( const QString & id ) const

Returns the definition with the specified id.

Definition at line 208 of file SvgLoadingContext.cpp.

{
    return d->definitions.value(id);
}

References d.

◆ fetchExternalFile()

QByteArray SvgLoadingContext::fetchExternalFile ( const QString & url )

Definition at line 308 of file SvgLoadingContext.cpp.

{
    return d->fileFetcher ? d->fileFetcher(url) : QByteArray();
}

References d.

◆ hasDefinition()

bool SvgLoadingContext::hasDefinition ( const QString & id ) const

Checks if a definition with the specified id exists.

Definition at line 213 of file SvgLoadingContext.cpp.

{
    return d->definitions.contains(id);
}

References d.

◆ isRootContext()

bool SvgLoadingContext::isRootContext ( ) const

Definition at line 297 of file SvgLoadingContext.cpp.

{
    KIS_ASSERT(!d->gcStack.isEmpty());
    return d->gcStack.size() == 1;
}

References d, and KIS_ASSERT.

◆ matchingCssStyles()

QStringList SvgLoadingContext::matchingCssStyles ( const QDomElement & element ) const

Returns list of css styles matching to the specified element.

Definition at line 223 of file SvgLoadingContext.cpp.

{
    return d->cssStyles.matchStyles(element);
}

References d.

◆ nextZIndex()

int SvgLoadingContext::nextZIndex ( )

Returns the next z-index.

Definition at line 184 of file SvgLoadingContext.cpp.

{
    return d->zIndex++;
}

References d.

◆ parseProfile()

void SvgLoadingContext::parseProfile ( const QDomElement & element )

parses 'color-profile' tag and saves it in the context

Definition at line 233 of file SvgLoadingContext.cpp.

{
    const QString href = element.attribute("xlink:href");
    const QByteArray uniqueId = QByteArray::fromHex(element.attribute("local").toLatin1());
    const QString name = element.attribute("name");
 
    if (element.attribute("rendering-intent", "auto") != "auto") {
        // WARNING: Krita does *not* treat rendering intents attributes of the profile!
        warnFlake << "WARNING: we do *not* treat rendering intents attributes of the profile!";
    }
 
    if (d->profiles.contains(name)) {
        debugFlake << "Profile already in the map!" << ppVar(name);
        return;
    }
 
    const KoColorProfile *profile =
            KoColorSpaceRegistry::instance()->profileByUniqueId(uniqueId);
 
    if (!profile && d->fileFetcher) {
        KoColorSpaceEngine *engine = KoColorSpaceEngineRegistry::instance()->get("icc");
        KIS_ASSERT(engine);
        if (engine) {
            const QString fileName = relativeFilePath(href);
            const QByteArray profileData = d->fileFetcher(fileName);
            if (!profileData.isEmpty()) {
                profile = engine->addProfile(profileData);
 
                if (profile->uniqueId() != uniqueId) {
                    warnFlake << "WARNING: ProfileID of the attached profile doesn't match the one mentioned in SVG element";
                    warnFlake << "       " << ppVar(profile->uniqueId().toHex());
                    warnFlake << "       " << ppVar(uniqueId.toHex());
                }
            } else {
                warnFlake << "WARNING: couldn't fetch the ICCprofile file!" << fileName;
            }
        }
    }
 
    if (profile) {
        d->profiles.insert(name, profile);
    } else {
        warnFlake << "WARNING: couldn't load SVG profile" << ppVar(name) << ppVar(href) << ppVar(uniqueId);
    }
}

References KoColorSpaceEngine::addProfile(), d, debugFlake, KoGenericRegistry< T >::get(), KoColorSpaceEngineRegistry::instance(), KoColorSpaceRegistry::instance(), KIS_ASSERT, ppVar, KoColorSpaceRegistry::profileByUniqueId(), relativeFilePath(), KoColorProfile::uniqueId(), and warnFlake.

◆ popGraphicsContext()

void SvgLoadingContext::popGraphicsContext ( )

Pops the current graphics context from the stack.

Definition at line 120 of file SvgLoadingContext.cpp.

{
    delete(d->gcStack.pop());
}

References d.

◆ Private()

SvgLoadingContext::Private ( )

inline

Definition at line 30 of file SvgLoadingContext.cpp.

        : zIndex(0)
        , documentResourceManager(0)
        , styleParser(0)
    {
 
    }

◆ profiles()

QHash< QString, const KoColorProfile * > SvgLoadingContext::profiles ( )

Return the profiles in the context.

◆ pushGraphicsContext()

SvgGraphicsContext * SvgLoadingContext::pushGraphicsContext	(	const QDomElement &	element = QDomElement(),
		bool	inherit = true )

Pushes a new graphics context to the stack.

Definition at line 82 of file SvgLoadingContext.cpp.

{
    SvgGraphicsContext *gc;
    // copy data from current context
    if (! d->gcStack.isEmpty() && inherit) {
        gc = new SvgGraphicsContext(*d->gcStack.top());
    } else {
        gc = new SvgGraphicsContext();
    }
 
    gc->textProperties = KoSvgTextProperties();
 
    gc->filterId.clear(); // filters are not inherited
    gc->clipPathId.clear(); // clip paths are not inherited
    gc->clipMaskId.clear(); // clip masks are not inherited
    gc->display = true; // display is not inherited
    gc->opacity = 1.0; // opacity is not inherited
    gc->paintOrder = QString(); //paint order is inherited by default
 
    if (!element.isNull()) {
        if (element.hasAttribute("transform")) {
            SvgTransformParser p(element.attribute("transform"));
            if (p.isValid()) {
                QTransform mat = p.transform();
                gc->matrix = mat * gc->matrix;
            }
        }
        if (element.hasAttribute("xml:base"))
            gc->xmlBaseDir = element.attribute("xml:base");
        if (element.hasAttribute("xml:space"))
            gc->preserveWhitespace = element.attribute("xml:space") == "preserve";
    }
 
    d->gcStack.push(gc);
 
    return gc;
}

References SvgGraphicsContext::clipMaskId, SvgGraphicsContext::clipPathId, d, SvgGraphicsContext::display, SvgGraphicsContext::filterId, SvgGraphicsContext::matrix, SvgGraphicsContext::opacity, p, SvgGraphicsContext::paintOrder, SvgGraphicsContext::preserveWhitespace, SvgGraphicsContext::textProperties, and SvgGraphicsContext::xmlBaseDir.

◆ registerShape()

void SvgLoadingContext::registerShape	(	const QString &	id,
		KoShape *	shape )

Registers a shape so it can be referenced later.

Definition at line 189 of file SvgLoadingContext.cpp.

{
    if (!id.isEmpty())
        d->loadedShapes.insert(id, shape);
}

References d.

◆ relativeFilePath()

QString SvgLoadingContext::relativeFilePath ( const QString & href )

Definition at line 163 of file SvgLoadingContext.cpp.

{
    const SvgGraphicsContext *gc = currentGC();
    if (!gc) return href;
 
    QString result = href;
 
    QFileInfo info(href);
    if (info.isRelative())
        return href;
 
 
    if (!gc->xmlBaseDir.isEmpty()) {
        result = QDir(gc->xmlBaseDir).relativeFilePath(href);
    } else if (!d->initialXmlBaseDir.isEmpty()) {
        result = QDir(d->initialXmlBaseDir).relativeFilePath(href);
    }
 
    return QDir::cleanPath(result);
}

References currentGC(), d, and SvgGraphicsContext::xmlBaseDir.

◆ resolvedProperties()

KoSvgTextProperties SvgLoadingContext::resolvedProperties ( ) const

These are the text properties, completely resolved, ensuring that everything is inherited and the sizes are converted to pt.

Definition at line 284 of file SvgLoadingContext.cpp.

{
    KoSvgTextProperties props;
    for (auto it = d->gcStack.begin(); it != d->gcStack.end(); it++) {
        SvgGraphicsContext *gc = *it;
        KoSvgTextProperties props2 = gc->textProperties;
        props.resetNonInheritableToDefault();
        props2.inheritFrom(props, true);
        props = props2;
    }
    return props;
}

References d, KoSvgTextProperties::inheritFrom(), KoSvgTextProperties::resetNonInheritableToDefault(), and SvgGraphicsContext::textProperties.

◆ setFileFetcher()

void SvgLoadingContext::setFileFetcher ( SvgLoadingContext::FileFetcherFunc func )

Definition at line 303 of file SvgLoadingContext.cpp.

{
    d->fileFetcher = func;
}

References d.

◆ setInitialXmlBaseDir()

void SvgLoadingContext::setInitialXmlBaseDir ( const QString & baseDir )

Sets the initial xml base dir, i.e. the directory the svg file is read from.

Definition at line 125 of file SvgLoadingContext.cpp.

{
    d->initialXmlBaseDir = baseDir;
}

References d.

◆ shapeById()

KoShape * SvgLoadingContext::shapeById ( const QString & id )

Returns shape with specified id.

Definition at line 195 of file SvgLoadingContext.cpp.

{
    return d->loadedShapes.value(id);
}

References d.

◆ styleParser()

SvgStyleParser & SvgLoadingContext::styleParser ( )

Returns a style parser to parse styles.

◆ xmlBaseDir()

QString SvgLoadingContext::xmlBaseDir ( ) const

Returns the current xml base dir.

Definition at line 130 of file SvgLoadingContext.cpp.

{
    SvgGraphicsContext *gc = currentGC();
    return (gc && !gc->xmlBaseDir.isEmpty()) ? gc->xmlBaseDir : d->initialXmlBaseDir;
}

References currentGC(), d, and SvgGraphicsContext::xmlBaseDir.

Member Data Documentation

◆ cssStyles

SvgCssHelper SvgLoadingContext::cssStyles

Definition at line 55 of file SvgLoadingContext.cpp.

◆ d

QScopedPointer<Private> SvgLoadingContext::d

private

Definition at line 96 of file SvgLoadingContext.h.

◆ definitions

QHash<QString, QDomElement> SvgLoadingContext::definitions

Definition at line 53 of file SvgLoadingContext.cpp.

◆ documentResourceManager

KoDocumentResourceManager* SvgLoadingContext::documentResourceManager

Definition at line 51 of file SvgLoadingContext.cpp.

◆ fileFetcher

FileFetcherFunc SvgLoadingContext::fileFetcher

Definition at line 57 of file SvgLoadingContext.cpp.

◆ gcStack

QStack<SvgGraphicsContext*> SvgLoadingContext::gcStack

Definition at line 48 of file SvgLoadingContext.cpp.

◆ initialXmlBaseDir

QString SvgLoadingContext::initialXmlBaseDir

Definition at line 49 of file SvgLoadingContext.cpp.

◆ loadedShapes

QHash<QString, KoShape*> SvgLoadingContext::loadedShapes

Definition at line 52 of file SvgLoadingContext.cpp.

◆ profiles

QHash< QString, const KoColorProfile * > SvgLoadingContext::profiles

Definition at line 54 of file SvgLoadingContext.cpp.

◆ styleParser

SvgStyleParser & SvgLoadingContext::styleParser

Definition at line 56 of file SvgLoadingContext.cpp.

◆ zIndex

int SvgLoadingContext::zIndex

Definition at line 50 of file SvgLoadingContext.cpp.

The documentation for this class was generated from the following files:

libs/flake/svg/SvgLoadingContext.cpp
libs/flake/svg/SvgLoadingContext.h

Public Types

Public Member Functions

Public Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ FileFetcherFunc

Constructor & Destructor Documentation

◆ ~Private()

◆ SvgLoadingContext()

◆ ~SvgLoadingContext()

Member Function Documentation

◆ absoluteFilePath()

◆ addDefinition()

◆ addStyleSheet()

◆ currentGC()

◆ definition()

◆ fetchExternalFile()

◆ hasDefinition()

◆ isRootContext()

◆ matchingCssStyles()

◆ nextZIndex()

◆ parseProfile()

◆ popGraphicsContext()

◆ Private()

◆ profiles()

◆ pushGraphicsContext()

◆ registerShape()

◆ relativeFilePath()

◆ resolvedProperties()

◆ setFileFetcher()

◆ setInitialXmlBaseDir()

◆ shapeById()

◆ styleParser()

◆ xmlBaseDir()

Member Data Documentation

◆ cssStyles

◆ d

◆ definitions

◆ documentResourceManager

◆ fileFetcher

◆ gcStack

◆ initialXmlBaseDir

◆ loadedShapes

◆ profiles

◆ styleParser

◆ zIndex