KisSeExprScript Class Reference

#include <KisSeExprScript.h>

Inheritance diagram for KisSeExprScript:

Classes
struct	Private

Public Member Functions
KoResourceSP	clone () const override
QString	defaultFileExtension () const override
	KisSeExprScript (const KisSeExprScript &rhs)
	KisSeExprScript (const QImage &image, const QString &script, const QString &name, const QString &folderName)
	KisSeExprScript (const QString &filename)
	KisSeExprScript (KisSeExprScript *rhs)
bool	loadFromDevice (QIODevice *dev, KisResourcesInterfaceSP resourcesInterface) override
QString	name () const override
QPair< QString, QString >	resourceType () const override
bool	saveToDevice (QIODevice *dev) const override
QString	script () const
	script the actual script
void	setScript (const QString &script)
	set SeExpr expression script
	~KisSeExprScript ()
Public Member Functions inherited from KoResource
bool	active () const
void	addMetaData (QString key, QVariant value)
	store the given key, value pair in the resource
virtual void	clearSideLoadedResources ()
virtual QList< KoResourceLoadResult >	embeddedResources (KisResourcesInterfaceSP globalResourcesInterface) const
QString	filename () const
QImage	image () const
bool	isDirty () const
virtual bool	isEphemeral () const
virtual bool	isSerializable () const
	KoResource ()
	KoResource (const KoResource &rhs)
	KoResource (const QString &filename)
virtual QList< KoResourceLoadResult >	linkedResources (KisResourcesInterfaceSP globalResourcesInterface) const
bool	load (KisResourcesInterfaceSP resourcesInterface)
QString	md5Sum (bool generateIfEmpty=true) const
QMap< QString, QVariant >	metadata () const
	get a map with all the metadata
KoResource &	operator= (const KoResource &rhs)=delete
bool	permanent () const
virtual QList< int >	requiredCanvasResources () const
QList< KoResourceLoadResult >	requiredResources (KisResourcesInterfaceSP globalResourcesInterface) const
int	resourceId () const
bool	save ()
void	setActive (bool active)
void	setDirty (bool value)
	Mark the preset as modified but not saved.
void	setFilename (const QString &filename)
void	setImage (const QImage &image)
void	setMD5Sum (const QString &md5sum)
	Set the md5sum of this resource. It must be in hex-encoded string format.
void	setName (const QString &name)
void	setPermanent (bool permanent)
void	setResourceId (int id)
void	setStorageLocation (const QString &location)
void	setValid (bool valid)
void	setVersion (int version)
virtual QList< KoResourceLoadResult >	sideLoadedResources (KisResourcesInterfaceSP globalResourcesInterface) const
KoResourceSignature	signature () const
QString	storageLocation () const
QList< KoResourceLoadResult >	takeSideLoadedResources (KisResourcesInterfaceSP globalResourcesInterface)
virtual QImage	thumbnail () const
	thumbnail the thumbnail image to use in resource selectors
virtual QString	thumbnailPath () const
	thumbnailPath returns the path to a separate thumbnail image, outside the actual resource file itself. If the path is relative, it is supposed start in the same location as the resource itself. If it's absolute, that is, it starts with "/", it is from the root of the storage.
virtual void	updateThumbnail ()
	updateThumbnail updates the thumbnail for this resource. Reimplement if your thumbnail is something else than the image set with setImage.
bool	valid () const
int	version () const
	Get the version of the resource.
virtual	~KoResource ()
Public Member Functions inherited from Private
	Private (KisCanvas2 *c)

Private Attributes
Private *const	d

Additional Inherited Members
Public Attributes inherited from KoResource
bool	active {true}
QString	filename
QImage	image
QString	md5sum
QMap< QString, QVariant >	metadata
bool	modified {false}
QString	name
bool	permanent {false}
int	resourceId {-1}
QString	storageLocation
bool	valid {false}
int	version {-1}
Public Attributes inherited from Private
KisCanvas2 *	canvas
int	displayedFrame
int	intendedFrame

Detailed Description

KoResource container for SeExpr scripts.

Definition at line 22 of file KisSeExprScript.h.

Constructor & Destructor Documentation

KisSeExprScript() [1/4]

KisSeExprScript::KisSeExprScript

(

const QString &

filename

)

Creates a new KisSeExprScript object using filename. No file is opened in the constructor, you have to call load.

Parameters

filename

the file name to save and load from.

Definition at line 25 of file KisSeExprScript.cpp.

    : KoResource(filename)
    , d(new Private)
{
    setName(name().replace("_", " "));
    if (name().endsWith(defaultFileExtension())) {
        const QFileInfo f(name());
        setName(f.completeBaseName());
    }
}

References defaultFileExtension(), name(), and KoResource::setName().

KisSeExprScript() [2/4]

KisSeExprScript::KisSeExprScript	(	const QImage &	image,
		const QString &	script,
		const QString &	name,
		const QString &	folderName )

Creates a new SeExpr script resource with the given image thumbnail, script, name, and folder name.

Parameters

image	the thumbnail of the texture this script will render
script	the actual script's contents
name	the name of the script
folderName	the folder name

Definition at line 36 of file KisSeExprScript.cpp.

    : KoResource(QString())
    , d(new Private)
{
    setScript(script);
    setImage(image);
    setName(name);
 
    QFileInfo fileInfo(folderName + QDir::separator() + name + defaultFileExtension());
 
    int i = 1;
    while (fileInfo.exists()) {
        fileInfo.setFile(folderName + QDir::separator() + name + QString::number(i) + defaultFileExtension());
        i++;
    }
 
    setFilename(fileInfo.filePath());
}

References defaultFileExtension(), KoResource::image, name(), script(), KoResource::setFilename(), KoResource::setImage(), KoResource::setName(), and setScript().

KisSeExprScript() [3/4]

KisSeExprScript::KisSeExprScript

(

KisSeExprScript *

rhs

)

Clones the given SeExpr script into a new instance.

Parameters

rhs	the original SeExpr script to be copied onto this object

Definition at line 55 of file KisSeExprScript.cpp.

    : KisSeExprScript(*rhs)
{
}

KisSeExprScript() [4/4]

KisSeExprScript::KisSeExprScript

(

const KisSeExprScript &

rhs

)

Definition at line 60 of file KisSeExprScript.cpp.

    : KoResource(rhs)
    , d(new Private)
{
    KIS_SAFE_ASSERT_RECOVER_NOOP(isDirty() == rhs.isDirty());
    // only valid if we could clone the settings
    setScript(rhs.script());
    setValid(rhs.valid());
}

References KoResource::isDirty(), KIS_SAFE_ASSERT_RECOVER_NOOP, script(), setScript(), KoResource::setValid(), and KoResource::valid.

~KisSeExprScript()

KisSeExprScript::~KisSeExprScript

(

)

Definition at line 70 of file KisSeExprScript.cpp.

{
    delete d;
}

References d.

Member Function Documentation

clone()

KoResourceSP KisSeExprScript::clone ( ) const

overridevirtual

Implements KoResource.

Definition at line 192 of file KisSeExprScript.cpp.

{
    return KoResourceSP(new KisSeExprScript(*this));
}

References KisSeExprScript().

defaultFileExtension()

QString KisSeExprScript::defaultFileExtension ( ) const

overridevirtual

Returns

the default file extension which should be used when saving the resource

Reimplemented from KoResource.

Definition at line 177 of file KisSeExprScript.cpp.

{
    return QString(".kse");
}

loadFromDevice()

bool KisSeExprScript::loadFromDevice ( QIODevice * dev, KisResourcesInterfaceSP resourcesInterface )

overridevirtual

Load this resource.

Returns

true if loading the resource succeeded.

Implements KoResource.

Definition at line 75 of file KisSeExprScript.cpp.

{
    Q_UNUSED(resourcesInterface);
 
    if (!dev->isOpen())
        dev->open(QIODevice::ReadOnly);
 
    d->data = dev->readAll();
 
    // TODO: test
    KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE(d->data.size() != 0, false);
 
    if (filename().isNull()) {
        warnFlake << "Cannot load SeExpr script" << name() << ", there is no filename set";
        return false;
    }
 
    if (d->data.isNull()) {
        QFile file(filename());
        if (file.size() == 0) {
            warnFlake << "Cannot load SeExpr script" << name() << "there is no data available";
            return false;
        }
 
        file.open(QIODevice::ReadOnly);
        d->data = file.readAll();
        file.close();
    }
 
    QBuffer buf(&d->data);
    buf.open(QBuffer::ReadOnly);
 
    QScopedPointer<KoStore> store(KoStore::createStore(&buf, KoStore::Read, "application/x-krita-seexpr-script", KoStore::Zip));
    if (!store || store->bad())
        return false;
 
    bool storeOpened = store->open("script.se");
    if (!storeOpened) {
        return false;
    }
 
    d->script = QString(store->read(store->size()));
    store->close();
 
    if (store->open("preview.png")) {
        KoStoreDevice previewDev(store.data());
        previewDev.open(QIODevice::ReadOnly);
 
        QImage preview = QImage();
        preview.load(&previewDev, "PNG");
        setImage(preview);
 
        (void)store->close();
    }
 
    buf.close();
 
    setValid(true);
    setDirty(false);
 
    return true;
}

References KoStore::createStore(), d, KisSeExprScript::Private::data, KoResource::filename, KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE, name(), KoStoreDevice::open(), KoStore::Read, KisSeExprScript::Private::script, KoResource::setDirty(), KoResource::setImage(), KoResource::setValid(), void(), warnFlake, and KoStore::Zip.

name()

QString KisSeExprScript::name ( ) const

overridevirtual

Returns

the user-visible name of the resource

Reimplemented from KoResource.

Definition at line 197 of file KisSeExprScript.cpp.

{
    return KoResource::name().replace("_", " ");
}

References KoResource::name.

resourceType()

QPair< QString, QString > KisSeExprScript::resourceType ( ) const

overridevirtual

Returns

the resource type

Implements KoResource.

Definition at line 172 of file KisSeExprScript.cpp.

{
    return QPair<QString, QString>(ResourceType::SeExprScripts, "");
}

References ResourceType::SeExprScripts.

saveToDevice()

bool KisSeExprScript::saveToDevice ( QIODevice * dev ) const

overridevirtual

Save this resource.

Returns

true if saving the resource succeeded.

Reimplemented from KoResource.

Definition at line 138 of file KisSeExprScript.cpp.

{
    KoStore *store(KoStore::createStore(dev, KoStore::Write, "application/x-krita-seexpr-script", KoStore::Zip));
    if (!store || store->bad())
        return false;
 
    if (!store->open("script.se")) {
        return false;
    }
 
    KoStoreDevice storeDev(store);
    storeDev.open(QIODevice::WriteOnly);
 
    storeDev.write(d->script.toUtf8());
 
    if (!store->close()) {
        return false;
    }
 
    if (!store->open("preview.png")) {
        return false;
    }
 
    KoStoreDevice previewDev(store);
    previewDev.open(QIODevice::WriteOnly);
 
    image().save(&previewDev, "PNG");
    if (!store->close()) {
        return false;
    }
 
    return store->finalize();
}

References KoStore::bad(), KoStore::close(), KoStore::createStore(), d, KoStore::finalize(), KoResource::image, KoStore::open(), KoStoreDevice::open(), KisSeExprScript::Private::script, KoStore::Write, and KoStore::Zip.

script()

QString KisSeExprScript::script

(

)

const

script the actual script

Returns

a valid SeExpr script. It is guaranteed to be in UTF-8.

Definition at line 182 of file KisSeExprScript.cpp.

{
    return d->script;
}

References d, and KisSeExprScript::Private::script.

setScript()

void KisSeExprScript::setScript

(

const QString &

script

)

set SeExpr expression script

Definition at line 187 of file KisSeExprScript.cpp.

{
    d->script = script;
}

References d, KisSeExprScript::Private::script, and script().

Member Data Documentation

d

Private* const KisSeExprScript::d

private

Definition at line 88 of file KisSeExprScript.h.

---

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

• libs/flake/resources/KisSeExprScript.h
• libs/flake/resources/KisSeExprScript.cpp