KisKraSaver Class Reference

#include <kis_kra_saver.h>

Classes
struct	Private

Public Member Functions
QStringList	errorMessages () const
	KisKraSaver (KisDocument *document, const QString &filename, bool addMergedImage=true)
bool	saveAnimationMetadata (KoStore *store, KisImageSP image, const QString &uri)
bool	saveAudio (KoStore *store)
bool	saveBinaryData (KoStore *store, KisImageSP image, const QString &uri, bool external, bool addMergedImage)
bool	saveKeyframes (KoStore *store, const QString &uri, bool external)
bool	saveResources (KoStore *store, KisImageSP image, const QString &uri)
bool	saveStoryboard (KoStore *store, KisImageSP image, const QString &uri)
QDomElement	saveXML (QDomDocument &doc, KisImageSP image)
QStringList	warningMessages () const
	~KisKraSaver ()

Private Member Functions
void	saveAnimationMetadataToXML (QDomDocument &doc, QDomElement &element, KisImageSP image)
bool	saveAssistants (KoStore *store, QString uri, bool external)
void	saveAssistantsGlobalColor (QDomDocument &doc, QDomElement &element)
bool	saveAssistantsList (QDomDocument &doc, QDomElement &element)
bool	saveAudioXML (QDomDocument &doc, QDomElement &element)
void	saveBackgroundColor (QDomDocument &doc, QDomElement &element, KisImageSP image)
void	saveColorHistory (QDomDocument &doc, QDomElement &element)
void	saveCompositions (QDomDocument &doc, QDomElement &element, KisImageSP image)
bool	saveGrid (QDomDocument &doc, QDomElement &element)
bool	saveGuides (QDomDocument &doc, QDomElement &element)
void	saveHDRMetadata (QDomDocument &doc, QDomElement &element, KisImageSP image)
bool	saveKoColors (QDomDocument &doc, QDomElement &element, const QList< KoColor > &colors) const
bool	saveMirrorAxis (QDomDocument &doc, QDomElement &element)
bool	saveNodeKeyframes (KoStore *store, QString location, const KisNode *node)
void	saveResourcesToXML (QDomDocument &doc, QDomElement &element)
void	saveStoryboardToXML (QDomDocument &doc, QDomElement &element)
void	saveWarningColor (QDomDocument &doc, QDomElement &element, KisImageSP image)

Private Attributes
Private *const	m_d

Detailed Description

Definition at line 23 of file kis_kra_saver.h.

Constructor & Destructor Documentation

KisKraSaver()

KisKraSaver::KisKraSaver	(	KisDocument *	document,
		const QString &	filename,
		bool	addMergedImage = true )

Definition at line 80 of file kis_kra_saver.cpp.

    : m_d(new Private)
{
    m_d->doc = document;
    m_d->filename = filename;
    m_d->addMergedImage = addMergedImage;
    m_d->linkedDocumentResources = document->linkedDocumentResources();
 
    m_d->imageName = m_d->doc->documentInfo()->aboutInfo("title");
    if (m_d->imageName.isEmpty()) {
        m_d->imageName = i18n("Unnamed");
    }
}

References KoDocumentInfo::aboutInfo(), KisKraSaver::Private::addMergedImage, KisKraSaver::Private::doc, KisDocument::documentInfo(), KisKraSaver::Private::filename, KisKraSaver::Private::imageName, KisKraSaver::Private::linkedDocumentResources, and m_d.

~KisKraSaver()

KisKraSaver::~KisKraSaver

(

)

Definition at line 94 of file kis_kra_saver.cpp.

{
    delete m_d;
}

References m_d.

Member Function Documentation

errorMessages()

QStringList KisKraSaver::errorMessages

(

)

const

Returns

a list with everything that went wrong while saving

Definition at line 679 of file kis_kra_saver.cpp.

{
    return m_d->errorMessages;
}

References KisKraSaver::Private::errorMessages, and m_d.

saveAnimationMetadata()

bool KisKraSaver::saveAnimationMetadata	(	KoStore *	store,
		KisImageSP	image,
		const QString &	uri )

Definition at line 297 of file kis_kra_saver.cpp.

{
    Q_UNUSED(uri);
 
    if (!store->open(m_d->imageName + ANIMATION_METADATA_PATH + "index.xml")) {
        m_d->errorMessages << i18nc("Error message when saving a .kra file", "Could not save animation meta data.");
        return false;
    }
 
    QDomDocument animationDocument = m_d->doc->createDomDocument("animation-metadata", "1.1");
    QDomElement root = animationDocument.documentElement();
    saveAnimationMetadataToXML(animationDocument, root, image);
 
    bool success = true;
 
    QByteArray ba = animationDocument.toByteArray();
    qint64 nwritten = 0;
    if (!ba.isEmpty()) {
        nwritten = store->write(ba);
    } else {
        qWarning() << "Could not save animation meta data to a byte array!";
        success = false;
    }
 
    bool r = store->close();
 
    success = success && r && (nwritten == ba.size());
 
    if (!success) {
        m_d->errorMessages << i18nc("Error message when saving a .kra file", "Could not save animation meta data.");
        return false;
    }
 
    return true;
}

References KRA::ANIMATION_METADATA_PATH, KoStore::close(), KisDocument::createDomDocument(), KisKraSaver::Private::doc, KisKraSaver::Private::errorMessages, KisKraSaver::Private::imageName, m_d, KoStore::open(), saveAnimationMetadataToXML(), and KoStore::write().

saveAnimationMetadataToXML()

void KisKraSaver::saveAnimationMetadataToXML ( QDomDocument & doc, QDomElement & element, KisImageSP image )

private

Definition at line 419 of file kis_kra_saver.cpp.

{
    KisDomUtils::saveValue(&element, "framerate", image->animationInterface()->framerate());
    KisDomUtils::saveValue(&element, "range", image->animationInterface()->documentPlaybackRange());
    KisDomUtils::saveValue(&element, "currentTime", image->animationInterface()->currentUITime());
 
    {
        QDomElement exportItemElem = doc.createElement("export-settings");
        KisDomUtils::saveValue(&exportItemElem, "sequenceFilePath", image->animationInterface()->exportSequenceFilePath());
        KisDomUtils::saveValue(&exportItemElem, "sequenceBaseName", image->animationInterface()->exportSequenceBaseName());
        KisDomUtils::saveValue(&exportItemElem, "sequenceInitialFrameNumber", image->animationInterface()->exportInitialFrameNumber());
        element.appendChild(exportItemElem);
    }
}

References KisImage::animationInterface(), KisImageAnimationInterface::currentUITime(), KisImageAnimationInterface::documentPlaybackRange(), KisImageAnimationInterface::exportInitialFrameNumber(), KisImageAnimationInterface::exportSequenceBaseName(), KisImageAnimationInterface::exportSequenceFilePath(), KisImageAnimationInterface::framerate(), and KisDomUtils::saveValue().

saveAssistants()

bool KisKraSaver::saveAssistants ( KoStore * store, QString uri, bool external )

private

Definition at line 774 of file kis_kra_saver.cpp.

{
    QString location;
    QMap<QString, int> assistantcounters;
    QByteArray data;
 
    QList<KisPaintingAssistantSP> assistants =  m_d->doc->assistants();
    QMap<KisPaintingAssistantHandleSP, int> handlemap;
 
    bool success = true;
    if (!assistants.isEmpty()) {
 
        Q_FOREACH (KisPaintingAssistantSP assist, assistants){
            if (!assistantcounters.contains(assist->id())){
                assistantcounters.insert(assist->id(),0);
            }
            location = external ? QString() : uri;
            location += m_d->imageName + ASSISTANTS_PATH;
            location += QString(assist->id()+"%1.assistant").arg(assistantcounters[assist->id()]);
 
            data = assist->saveXml(handlemap);
            if (store->open(location)) {
                qint64 nwritten = store->write(data);
                bool r = store->close();
                success = success && r && (nwritten == data.size());
            } else {
                success = false;
            }
            assistantcounters[assist->id()]++;
        }
    }
    if (!success) {
        m_d->errorMessages.append(i18nc("Saving .kra file error message", "Could not save assistants."));
    }
    return true;
}

References KisDocument::assistants, KRA::ASSISTANTS_PATH, KoStore::close(), KisKraSaver::Private::doc, KisKraSaver::Private::errorMessages, KisKraSaver::Private::imageName, m_d, KoStore::open(), and KoStore::write().

saveAssistantsGlobalColor()

void KisKraSaver::saveAssistantsGlobalColor ( QDomDocument & doc, QDomElement & element )

private

Definition at line 745 of file kis_kra_saver.cpp.

{
    QDomElement e = doc.createElement(GLOBALASSISTANTSCOLOR);
    QString colorString = KisDomUtils::qColorToQString(m_d->doc->assistantsGlobalColor());
    e.setAttribute(SIMPLECOLORDATA, QString(colorString));
    element.appendChild(e);
}

References KisDocument::assistantsGlobalColor(), KisKraSaver::Private::doc, KRA::GLOBALASSISTANTSCOLOR, m_d, KisDomUtils::qColorToQString(), and KRA::SIMPLECOLORDATA.

saveAssistantsList()

bool KisKraSaver::saveAssistantsList ( QDomDocument & doc, QDomElement & element )

private

Definition at line 811 of file kis_kra_saver.cpp.

{
    int count_ellipse = 0,
        count_twopoint = 0,
        count_perspective = 0,
        count_ruler = 0,
        count_vanishingpoint = 0,
        count_infiniteruler = 0,
        count_parallelruler = 0,
        count_concentricellipse = 0,
        count_fisheyepoint = 0,
        count_spline = 0,
        count_perspectiveellipse = 0,
        count_curvilinearperspective = 0;
    QList<KisPaintingAssistantSP> assistants =  m_d->doc->assistants();
    if (!assistants.isEmpty()) {
        QDomElement assistantsElement = doc.createElement("assistants");
        Q_FOREACH (KisPaintingAssistantSP assist, assistants){
            if (assist->id() == "ellipse"){
                assist->saveXmlList(doc, assistantsElement, count_ellipse);
                count_ellipse++;
            }
            else if (assist->id() == "spline"){
                assist->saveXmlList(doc, assistantsElement, count_spline);
                count_spline++;
            }
            else if (assist->id() == "perspective"){
                assist->saveXmlList(doc, assistantsElement, count_perspective);
                count_perspective++;
            }
            else if (assist->id() == "vanishing point"){
                assist->saveXmlList(doc, assistantsElement, count_vanishingpoint);
                count_vanishingpoint++;
            }
            else if (assist->id() == "infinite ruler"){
                assist->saveXmlList(doc, assistantsElement, count_infiniteruler);
                count_infiniteruler++;
            }
            else if (assist->id() == "parallel ruler"){
                assist->saveXmlList(doc, assistantsElement, count_parallelruler);
                count_parallelruler++;
            }
            else if (assist->id() == "concentric ellipse"){
                assist->saveXmlList(doc, assistantsElement, count_concentricellipse);
                count_concentricellipse++;
            }
            else if (assist->id() == "fisheye-point"){
                assist->saveXmlList(doc, assistantsElement, count_fisheyepoint);
                count_fisheyepoint++;
            }
            else if (assist->id() == "two point"){
                assist->saveXmlList(doc, assistantsElement, count_twopoint);
                count_twopoint++;
            }
            else if (assist->id() == "ruler"){
                assist->saveXmlList(doc, assistantsElement, count_ruler);
                count_ruler++;
            }
            else if (assist->id() == "perspective ellipse"){
                assist->saveXmlList(doc, assistantsElement, count_perspectiveellipse);
                count_perspectiveellipse++;
            }
            else if (assist->id() == "curvilinear-perspective"){
                assist->saveXmlList(doc, assistantsElement, count_curvilinearperspective);
                count_curvilinearperspective++;
            }
        }
        element.appendChild(assistantsElement);
    }
    return true;
}

References KisDocument::assistants, KisKraSaver::Private::doc, and m_d.

saveAudio()

bool KisKraSaver::saveAudio

(

KoStore *

store

)

Definition at line 333 of file kis_kra_saver.cpp.

{
    if (m_d->doc->getAudioTracks().isEmpty())
        return true;
 
    if (!store->open(m_d->imageName + AUDIO_PATH + "index.xml")) {
        m_d->errorMessages << i18nc("Error message when saving a .kra file", "Could not save audio meta data.");
        return false;
    }
 
    QDomDocument audioDocument = m_d->doc->createDomDocument("audio-info", "1.1");
    QDomElement root = audioDocument.documentElement();
    saveAudioXML(audioDocument, root);
 
    bool success = true;
    QByteArray byteArray = audioDocument.toByteArray();
    qint64 bytesWriteCount = 0;
    if (!byteArray.isEmpty()) {
        bytesWriteCount = store->write(byteArray);
    } else {
        qWarning() << "Could not save audio data to a byte array!";
        success = false;
    }
 
    bool closeOK = store->close();
 
    success = success && closeOK && (bytesWriteCount == byteArray.size());
 
    if (!success) {
        m_d->errorMessages << i18nc("Error message when saving a .kra file", "Could not save audio meta data.");
        return false;
    }
 
    return true;
}

References KRA::AUDIO_PATH, KoStore::close(), KisDocument::createDomDocument(), KisKraSaver::Private::doc, KisKraSaver::Private::errorMessages, KisDocument::getAudioTracks(), KisKraSaver::Private::imageName, m_d, KoStore::open(), saveAudioXML(), and KoStore::write().

saveAudioXML()

bool KisKraSaver::saveAudioXML ( QDomDocument & doc, QDomElement & element )

private

Definition at line 919 of file kis_kra_saver.cpp.

{
    QVector<QFileInfo> clips = m_d->doc->getAudioTracks();
    const qreal volume = m_d->doc->getAudioLevel();
 
    if (!clips.isEmpty()) {
        QDomElement audioClips = doc.createElement("audioClips");
        Q_FOREACH(const QFileInfo& file, clips) {
            QDomElement clip = doc.createElement(QString("Clip"));
            clip.setAttribute("filePath", file.absoluteFilePath());
            clip.setAttribute("volume", volume);
            audioClips.appendChild(clip);
        }
        element.appendChild(audioClips);
    }
 
    return true;
}

References KisKraSaver::Private::doc, KisDocument::getAudioLevel(), KisDocument::getAudioTracks(), and m_d.

saveBackgroundColor()

void KisKraSaver::saveBackgroundColor ( QDomDocument & doc, QDomElement & element, KisImageSP image )

private

Definition at line 689 of file kis_kra_saver.cpp.

{
    QDomElement e = doc.createElement(CANVASPROJECTIONCOLOR);
    KoColor color = image->defaultProjectionColor();
    QByteArray colorData = QByteArray::fromRawData((const char*)color.data(), color.colorSpace()->pixelSize());
    e.setAttribute(COLORBYTEDATA, QString(colorData.toBase64()));
    element.appendChild(e);
}

References KRA::CANVASPROJECTIONCOLOR, KRA::COLORBYTEDATA, KoColor::colorSpace(), KoColor::data(), KisImage::defaultProjectionColor(), and KoColorSpace::pixelSize().

saveBinaryData()

bool KisKraSaver::saveBinaryData	(	KoStore *	store,
		KisImageSP	image,
		const QString &	uri,
		bool	external,
		bool	addMergedImage )

Definition at line 482 of file kis_kra_saver.cpp.

{
    QString location;
 
    // Save the layers data
    KisKraSaveVisitor visitor(store, m_d->imageName, m_d->nodeFileNames);
 
    if (external)
        visitor.setExternalUri(uri);
 
    image->rootLayer()->accept(visitor);
 
    m_d->errorMessages.append(visitor.errorMessages());
    if (!m_d->errorMessages.isEmpty()) {
        return false;
    }
 
    bool success = true;
    bool r = true;
    qint64 nwritten = 0;
 
    // saving annotations
    bool savingAnnotationsSuccess = true;
    KisAnnotationSP annotation = image->annotation("exif");
    if (annotation) {
        location = external ? QString() : uri;
        location += m_d->imageName + EXIF_PATH;
        if (store->open(location)) {
            nwritten = store->write(annotation->annotation());
            r = store->close();
            savingAnnotationsSuccess = savingAnnotationsSuccess && (nwritten == annotation->annotation().size()) && r;
        } else {
            savingAnnotationsSuccess = false;
        }
    }
 
    if (!savingAnnotationsSuccess) {
        m_d->errorMessages.append(i18nc("Saving .kra file error message", "Could not save annotations."));
    }
 
    success = success && savingAnnotationsSuccess;
 
    bool savingImageProfileSuccess = true;
    if (image->profile()) {
        const KoColorProfile *profile = image->profile();
        KisAnnotationSP annotation;
        if (profile) {
            QByteArray profileRawData = profile->rawData();
            if (!profileRawData.isEmpty()) {
                if (profile->type() == "icc") {
                    annotation = new KisAnnotation(ICC, profile->name(), profile->rawData());
                } else {
                    annotation = new KisAnnotation(PROFILE, profile->name(), profile->rawData());
                }
            }
        }
 
        if (annotation) {
            location = external ? QString() : uri;
            location += m_d->imageName + ICC_PATH;
            if (store->open(location)) {
                nwritten = store->write(annotation->annotation());
                r = store->close();
                savingImageProfileSuccess = savingImageProfileSuccess && (nwritten == annotation->annotation().size()) && r;
            } else {
                savingImageProfileSuccess = false;
            }
        }
    }
 
    if (!savingImageProfileSuccess) {
        m_d->errorMessages.append(i18nc("Saving .kra file error message", "Could not save image profile."));
    }
    success = success && savingImageProfileSuccess;
 
    //This'll embed the profile used for proofing into the kra file.
    bool savingSoftproofingProfileSuccess = true;
    if (image->proofingConfiguration()) {
        const KoColorProfile *proofingProfile =
            KoColorSpaceRegistry::instance()->profileByName(image->proofingConfiguration()->proofingProfile);
        if (proofingProfile && proofingProfile->valid()) {
            QByteArray proofingProfileRaw = proofingProfile->rawData();
            if (!proofingProfileRaw.isEmpty()) {
                annotation = new KisAnnotation(ICCPROOFINGPROFILE, proofingProfile->name(), proofingProfile->rawData());
            }
        }
        if (annotation) {
            location = external ? QString() : uri;
            location += m_d->imageName + ICC_PROOFING_PATH;
            if (store->open(location)) {
                nwritten = store->write(annotation->annotation());
                r = store->close();
                savingSoftproofingProfileSuccess =
                    savingSoftproofingProfileSuccess && (nwritten == annotation->annotation().size()) && r;
            } else {
                savingSoftproofingProfileSuccess = false;
            }
        }
    }
 
    if (!savingSoftproofingProfileSuccess) {
        m_d->errorMessages.append(i18nc("Saving .kra file error message", "Could not save softproofing color profile."));
    }
 
    success = success && savingSoftproofingProfileSuccess;
 
    // Save the remaining annotations
    vKisAnnotationSP_it beginIt = image->beginAnnotations();
    vKisAnnotationSP_it endIt = image->endAnnotations();
 
    bool savingRemainingAnnotationsSuccess = true;
    if (beginIt != endIt) {
        vKisAnnotationSP_it it = beginIt;
        while (it != endIt) {
            if (!(*it) || (*it)->type().isEmpty()) {
                it++;
                continue;
            }
            QString type = (*it)->type();
 
            if (!m_d->specialAnnotations.contains(type)) {
                location = external ? QString() : uri;
                location += m_d->imageName + ANNOTATIONS_PATH + type;
                if (store->open(location)) {
                    nwritten = store->write((*it)->annotation());
                    r = store->close();
                    savingRemainingAnnotationsSuccess = savingRemainingAnnotationsSuccess && (nwritten == (*it)->annotation().size()) && r;
                } else {
                    savingRemainingAnnotationsSuccess = false;
                }
            }
            it++;
        }
    }
 
    if (!savingRemainingAnnotationsSuccess) {
        m_d->errorMessages.append(i18nc("Saving .kra file error message", "Could not save additional annotations."));
    }
 
    success = success && savingRemainingAnnotationsSuccess;
 
    bool savingLayerStylesSuccess = true;
    {
        KisAslLayerStyleSerializer serializer;
        QVector<KisPSDLayerStyleSP> stylesClones = serializer.collectAllLayerStyles(image->root());
        if (stylesClones.size() > 0) {
            location = external ? QString() : uri;
            location += m_d->imageName + LAYER_STYLES_PATH;
 
            if (store->open(location)) {
                QBuffer aslBuffer;
                if (aslBuffer.open(QIODevice::WriteOnly)) {
                    serializer.setStyles(stylesClones);
                    serializer.saveToDevice(aslBuffer);
                    aslBuffer.close();
                    nwritten = store->write(aslBuffer.buffer());
                    savingLayerStylesSuccess = savingLayerStylesSuccess && (nwritten == aslBuffer.buffer().size());
                } else {
                    savingLayerStylesSuccess = false;
                }
                r = store->close();
                savingLayerStylesSuccess = savingLayerStylesSuccess && r;
            } else {
                savingLayerStylesSuccess = false;
            }
        }
    }
 
    if (!savingLayerStylesSuccess) {
        m_d->errorMessages.append(i18nc("Saving .kra file error message", "Could not save layer styles."));
    }
 
    success = success && savingLayerStylesSuccess;
 
    bool savingMergedImageSuccess = true;
    if (addMergedImage) {
        KisPaintDeviceSP dev = image->projection();
        store->setCompressionEnabled(false);
        r = KisPNGConverter::saveDeviceToStore("mergedimage.png", image->bounds(), image->xRes(), image->yRes(), dev, store);
        savingMergedImageSuccess = savingMergedImageSuccess && r;
        store->setCompressionEnabled(KisConfig(true).compressKra());
    }
 
    if (!savingMergedImageSuccess) {
        m_d->errorMessages.append(i18nc("Saving .kra file error message", "Could not save merged image."));
    }
 
    success = success && savingMergedImageSuccess;
 
    r = saveAssistants(store, uri,external);
    success = success && r;
 
    return success;
}

References KisGroupLayer::accept(), KisImage::annotation(), KRA::ANNOTATIONS_PATH, KisImage::beginAnnotations(), KisImage::bounds(), KoStore::close(), KisAslLayerStyleSerializer::collectAllLayerStyles(), KisImage::endAnnotations(), KisKraSaveVisitor::errorMessages(), KisKraSaver::Private::errorMessages, KRA::EXIF_PATH, KRA::ICC, KRA::ICC_PATH, KRA::ICC_PROOFING_PATH, KRA::ICCPROOFINGPROFILE, KisKraSaver::Private::imageName, KoColorSpaceRegistry::instance(), KRA::LAYER_STYLES_PATH, m_d, KoColorProfile::name, KisKraSaver::Private::nodeFileNames, KoStore::open(), KisImage::profile(), KRA::PROFILE, KoColorSpaceRegistry::profileByName(), KisImage::projection(), KisImage::proofingConfiguration(), KoColorProfile::rawData(), KisNodeFacade::root, KisImage::rootLayer(), saveAssistants(), KisPNGConverter::saveDeviceToStore(), KisAslLayerStyleSerializer::saveToDevice(), KoStore::setCompressionEnabled(), KisKraSaveVisitor::setExternalUri(), KisAslLayerStyleSerializer::setStyles(), KisKraSaver::Private::specialAnnotations, KoColorProfile::type(), KoColorProfile::valid(), KoStore::write(), KisImage::xRes(), and KisImage::yRes().

saveColorHistory()

void KisKraSaver::saveColorHistory ( QDomDocument & doc, QDomElement & element )

private

Definition at line 698 of file kis_kra_saver.cpp.

{
    QDomElement colorsElement = doc.createElement(COLORHISTORY);
    saveKoColors(doc, colorsElement, m_d->doc->colorHistoryColors());
 
    element.appendChild(colorsElement);
}

References KRA::COLORHISTORY, KisDocument::colorHistoryColors(), KisKraSaver::Private::doc, m_d, and saveKoColors().

saveCompositions()

void KisKraSaver::saveCompositions ( QDomDocument & doc, QDomElement & element, KisImageSP image )

private

Definition at line 763 of file kis_kra_saver.cpp.

{
    if (!image->compositions().isEmpty()) {
        QDomElement e = doc.createElement("compositions");
        Q_FOREACH (KisLayerCompositionSP composition, image->compositions()) {
            composition->save(doc, e);
        }
        element.appendChild(e);
    }
}

References KisImage::compositions().

saveGrid()

bool KisKraSaver::saveGrid ( QDomDocument & doc, QDomElement & element )

private

Definition at line 883 of file kis_kra_saver.cpp.

{
    KisGridConfig config = m_d->doc->gridConfig();
 
    if (!config.isDefault()) {
        QDomElement gridElement = config.saveDynamicDataToXml(doc, "grid");
        element.appendChild(gridElement);
    }
 
    return true;
}

References KisKraSaver::Private::doc, KisDocument::gridConfig, KisGridConfig::isDefault(), m_d, and KisGridConfig::saveDynamicDataToXml().

saveGuides()

bool KisKraSaver::saveGuides ( QDomDocument & doc, QDomElement & element )

private

Definition at line 895 of file kis_kra_saver.cpp.

{
    KisGuidesConfig guides = m_d->doc->guidesConfig();
 
    if (!guides.isDefault()) {
        QDomElement guidesElement = guides.saveToXml(doc, "guides");
        element.appendChild(guidesElement);
    }
 
    return true;
}

References KisKraSaver::Private::doc, KisDocument::guidesConfig, KisGuidesConfig::isDefault(), m_d, and KisGuidesConfig::saveToXml().

saveHDRMetadata()

void KisKraSaver::saveHDRMetadata ( QDomDocument & doc, QDomElement & element, KisImageSP image )

private

Definition at line 706 of file kis_kra_saver.cpp.

{
    if (!image->hdrReferenceWhiteLightLevel() && !image->colorVolumeInformation() && !image->relativeContentLightLevelInformation()) {
        return;
    }
    QDomElement hdr = doc.createElement(HDRMETADATA);
    if (image->hdrReferenceWhiteLightLevel()) {
        KisDomUtils::saveValue(&hdr, HDRREFERENCEWHITE, *image->hdrReferenceWhiteLightLevel());
    }
    if (image->relativeContentLightLevelInformation()) {
        KisRelativeContentLightLevelInformation c = *image->relativeContentLightLevelInformation();
        QDomElement clli = doc.createElement(CONTENTLIGHTLEVEL);
        clli.setAttribute(MAXCLL, KisDomUtils::toString(c.maxContentLightLevel));
        clli.setAttribute(MAXFALL, KisDomUtils::toString(c.maxFrameAverageLightLevel));
        if (c.type == KisRelativeContentLightLevelInformation::XYZLuminance) {
            clli.setAttribute(CLLI_CALCTYPE, CLLI_CALC_XYZY);
        } else if (c.type == KisRelativeContentLightLevelInformation::Rec2020Component) {
            clli.setAttribute(CLLI_CALCTYPE, CLLI_CALC_Rec2020);
        } else if (c.type == KisRelativeContentLightLevelInformation::RGBComponent) {
            clli.setAttribute(CLLI_CALCTYPE, CLLI_CALC_RGB_XYZ_FALLBACK);
        }
        hdr.appendChild(clli);
    }
    if (image->colorVolumeInformation()) {
        KisColorVolumeInformation cv = *image->colorVolumeInformation();
        QDomElement cvi = doc.createElement(COLORVOLUME);
        cvi.setAttribute(COLORVOLUMEMAXLUMINANCE, KisDomUtils::toString(cv.maxLuminance));
        cvi.setAttribute(COLORVOLUMEMINLUMINANCE, KisDomUtils::toString(cv.minLuminance));
 
        KisDomUtils::saveValue(&cvi, COLORVOLUMERED, cv.red.asVector().toPointF());
        KisDomUtils::saveValue(&cvi, COLORVOLUMEGREEN, cv.green.asVector().toPointF());
        KisDomUtils::saveValue(&cvi, COLORVOLUMEBLUE, cv.blue.asVector().toPointF());
        KisDomUtils::saveValue(&cvi, COLORVOLUMEWHITE, cv.white.asVector().toPointF());
 
        hdr.appendChild(cvi);
    }
    element.appendChild(hdr);
}

References KoColorimetryUtils::xy::asVector(), KisColorVolumeInformation::blue, KRA::CLLI_CALC_Rec2020, KRA::CLLI_CALC_RGB_XYZ_FALLBACK, KRA::CLLI_CALC_XYZY, KRA::CLLI_CALCTYPE, KRA::COLORVOLUME, KRA::COLORVOLUMEBLUE, KRA::COLORVOLUMEGREEN, KisImage::colorVolumeInformation(), KRA::COLORVOLUMEMAXLUMINANCE, KRA::COLORVOLUMEMINLUMINANCE, KRA::COLORVOLUMERED, KRA::COLORVOLUMEWHITE, KRA::CONTENTLIGHTLEVEL, KisColorVolumeInformation::green, KRA::HDRMETADATA, KRA::HDRREFERENCEWHITE, KisImage::hdrReferenceWhiteLightLevel(), KRA::MAXCLL, KisRelativeContentLightLevelInformation::maxContentLightLevel, KRA::MAXFALL, KisRelativeContentLightLevelInformation::maxFrameAverageLightLevel, KisColorVolumeInformation::maxLuminance, KisColorVolumeInformation::minLuminance, KisRelativeContentLightLevelInformation::Rec2020Component, KisColorVolumeInformation::red, KisImage::relativeContentLightLevelInformation(), KisRelativeContentLightLevelInformation::RGBComponent, KisDomUtils::saveValue(), KisDomUtils::toString(), KisRelativeContentLightLevelInformation::type, KisColorVolumeInformation::white, and KisRelativeContentLightLevelInformation::XYZLuminance.

saveKeyframes()

bool KisKraSaver::saveKeyframes	(	KoStore *	store,
		const QString &	uri,
		bool	external )

Definition at line 434 of file kis_kra_saver.cpp.

{
    QMap<const KisNode*, QString>::iterator it;
 
    for (it = m_d->keyframeFilenames.begin(); it != m_d->keyframeFilenames.end(); it++) {
        const KisNode *node = it.key();
        QString filename = it.value();
 
        QString location =
                (external ? QString() : uri)
                + m_d->imageName + LAYER_PATH + filename;
 
        if (!saveNodeKeyframes(store, location, node)) {
            return false;
        }
    }
 
    return true;
}

References KisKraSaver::Private::imageName, KisKraSaver::Private::keyframeFilenames, KRA::LAYER_PATH, m_d, and saveNodeKeyframes().

saveKoColors()

bool KisKraSaver::saveKoColors ( QDomDocument & doc, QDomElement & element, const QList< KoColor > & colors ) const

private

Definition at line 938 of file kis_kra_saver.cpp.

{
    // Writes like <colors><RGB ../><RGB .. /> ... </colors>
    Q_FOREACH(const KoColor & color, colors) {
        color.toXML(doc, colorsElement);
    }
    return true;
}

References KoColor::toXML().

saveMirrorAxis()

bool KisKraSaver::saveMirrorAxis ( QDomDocument & doc, QDomElement & element )

private

Definition at line 907 of file kis_kra_saver.cpp.

{
    KisMirrorAxisConfig mirrorAxisConfig = m_d->doc->mirrorAxisConfig();
 
    if (!mirrorAxisConfig.isDefault()) {
        QDomElement mirrorAxisElement = mirrorAxisConfig.saveToXml(doc, MIRROR_AXIS);
        element.appendChild(mirrorAxisElement);
    }
 
    return true;
}

References KisKraSaver::Private::doc, KisMirrorAxisConfig::isDefault(), m_d, KRA::MIRROR_AXIS, KisDocument::mirrorAxisConfig, and KisMirrorAxisConfig::saveToXml().

saveNodeKeyframes()

bool KisKraSaver::saveNodeKeyframes ( KoStore * store, QString location, const KisNode * node )

private

Definition at line 454 of file kis_kra_saver.cpp.

{
    QDomDocument doc = KisDocument::createDomDocument("krita-keyframes", "keyframes", "1.0");
    QDomElement root = doc.documentElement();
 
    KisKeyframeChannel *channel;
    Q_FOREACH (channel, node->keyframeChannels()) {
        QDomElement element = channel->toXML(doc, m_d->nodeFileNames[node]);
        root.appendChild(element);
    }
 
    bool success = true;
    if (store->open(location)) {
        QByteArray xml = doc.toByteArray();
        qint64 nwritten = store->write(xml);
        bool r = store->close();
        success = r && (nwritten == xml.size());
    } else {
        success = false;
    }
    if (!success) {
        m_d->errorMessages << i18nc("Error message on saving a .kra file", "Could not save keyframes.");
        return false;
    }
 
    return true;
}

References KoStore::close(), KisDocument::createDomDocument(), KisKraSaver::Private::errorMessages, KisBaseNode::keyframeChannels, m_d, KisKraSaver::Private::nodeFileNames, KoStore::open(), KisKeyframeChannel::toXML(), and KoStore::write().

saveResources()

bool KisKraSaver::saveResources	(	KoStore *	store,
		KisImageSP	image,
		const QString &	uri )

Definition at line 207 of file kis_kra_saver.cpp.

{
    Q_UNUSED(image);
    Q_UNUSED(uri);
 
    QList<KoResourceLoadResult> embeddedResources = m_d->linkedDocumentResources;
 
    Q_FOREACH (const KoResourceLoadResult &result, embeddedResources) {
        KIS_SAFE_ASSERT_RECOVER(result.type() != KoResourceLoadResult::ExistingResource) { continue; }
 
        if (result.type() == KoResourceLoadResult::FailedLink) {
            m_d->warningMessages << i18nc("Error message when saving a .kra file", "Could not export resource for embedding: %1", result.signature().filename);
            continue;
        }
 
        KoEmbeddedResource resource = result.embeddedResource();
 
        QString path = RESOURCE_PATH + "/" + resource.signature().type;
 
        if (resource.signature().type == ResourceType::Palettes) {
            path = m_d->imageName + PALETTE_PATH;
        }
 
        const QString fileName = resource.signature().filename;
 
        if (!store->open(path  + '/' + fileName)) {
            m_d->warningMessages << i18nc("Error message when saving a .kra file", "Could not write resource: %1", result.signature().filename);
            continue;
        }
 
        // we first read into a buffer to make sure the save operation is transactional,
        // that is, either resource is saves correctly, or the file is left empty.
        QByteArray ba = resource.data();
 
        qint64 nwritten = 0;
        if (!ba.isEmpty()) {
            nwritten = store->write(ba);
        } else {
            m_d->warningMessages << i18nc("Error message when saving a .kra file", "Written resource is empty: %1", result.signature().filename);
        }
 
        store->close();
 
        if (nwritten != ba.size()) {
            m_d->warningMessages << i18nc("Error message when saving a .kra file", "Written resource is incomplete: %1", result.signature().filename);
        }
    }
 
    return true;
}

References KoStore::close(), KoEmbeddedResource::data(), KoResourceLoadResult::embeddedResource(), KoResourceLoadResult::ExistingResource, KoResourceLoadResult::FailedLink, KoResourceSignature::filename, KisKraSaver::Private::imageName, KIS_SAFE_ASSERT_RECOVER, KisKraSaver::Private::linkedDocumentResources, m_d, KoStore::open(), KRA::PALETTE_PATH, ResourceType::Palettes, KRA::RESOURCE_PATH, KoEmbeddedResource::signature(), KoResourceLoadResult::signature(), KoResourceLoadResult::type(), KoResourceSignature::type, KisKraSaver::Private::warningMessages, and KoStore::write().

saveResourcesToXML()

void KisKraSaver::saveResourcesToXML ( QDomDocument & doc, QDomElement & element )

private

Definition at line 369 of file kis_kra_saver.cpp.

{
    QDomElement ePalette = doc.createElement(PALETTES);
    QDomElement eResources = doc.createElement(RESOURCES);
 
    Q_FOREACH (const KoResourceLoadResult resource, m_d->linkedDocumentResources) {
        // all warnings will be issued in KisKraSaver::saveResources()
        if (resource.type() != KoResourceLoadResult::EmbeddedResource) continue;
 
        KoResourceSignature sig = resource.signature();
 
        QDomElement eResource = doc.createElement("resource");
        eResource.setAttribute("type", sig.type);
        eResource.setAttribute("name", sig.name);
        eResource.setAttribute("filename", sig.filename);
        eResource.setAttribute("md5sum", sig.md5sum);
 
        if (sig.type == ResourceType::Palettes) {
            ePalette.appendChild(eResource);
        }
        else {
            eResources.appendChild(eResource);
 
        }
    }
    element.appendChild(ePalette);
    element.appendChild(eResources);
}

References KoResourceLoadResult::EmbeddedResource, KoResourceSignature::filename, KisKraSaver::Private::linkedDocumentResources, m_d, KoResourceSignature::md5sum, KoResourceSignature::name, ResourceType::Palettes, KRA::PALETTES, KRA::RESOURCES, KoResourceLoadResult::signature(), KoResourceLoadResult::type(), and KoResourceSignature::type.

saveStoryboard()

bool KisKraSaver::saveStoryboard	(	KoStore *	store,
		KisImageSP	image,
		const QString &	uri )

Definition at line 258 of file kis_kra_saver.cpp.

{
    Q_UNUSED(image);
    Q_UNUSED(uri);
 
    bool success = true;
    if (m_d->doc->getStoryboardItemList().count() == 0) {
        return true;
    } else {
        if (!store->open(m_d->imageName + STORYBOARD_PATH + "index.xml")) {
            m_d->errorMessages << i18nc("Error message when saving a .kra file", "Could not save storyboards.");
            return false;
        }
 
        QDomDocument storyboardDocument = m_d->doc->createDomDocument("storyboard-info", "1.1");
        QDomElement root = storyboardDocument.documentElement();
        saveStoryboardToXML(storyboardDocument, root);
 
        QByteArray ba = storyboardDocument.toByteArray();
        qint64 nwritten = 0;
        if (!ba.isEmpty()) {
            nwritten = store->write(ba);
        } else {
            success = false;
            qWarning() << "Could not save storyboard data to a byte array!";
        }
 
        bool r = store->close();
        success = success && r && (nwritten == ba.size());
    }
 
    if (!success) {
        m_d->errorMessages << i18nc("Error message when saving a .kra file", "Could not save storyboards.");
        return false;
    }
 
    return success;
}

References KoStore::close(), KisDocument::createDomDocument(), KisKraSaver::Private::doc, KisKraSaver::Private::errorMessages, KisDocument::getStoryboardItemList(), KisKraSaver::Private::imageName, m_d, KoStore::open(), saveStoryboardToXML(), KRA::STORYBOARD_PATH, and KoStore::write().

saveStoryboardToXML()

void KisKraSaver::saveStoryboardToXML ( QDomDocument & doc, QDomElement & element )

private

Definition at line 398 of file kis_kra_saver.cpp.

{
    //saving storyboard comments
    QDomElement eCommentList = doc.createElement("StoryboardCommentList");
    for (StoryboardComment comment: m_d->doc->getStoryboardCommentsList()) {
        QDomElement commentElement = doc.createElement("storyboardcomment");
        commentElement.setAttribute("name", comment.name);
        commentElement.setAttribute("visibility", comment.visibility);
        eCommentList.appendChild(commentElement);
    }
    element.appendChild(eCommentList);
 
    //saving storyboard items
    QDomElement eItemList = doc.createElement("StoryboardItemList");
    for (StoryboardItemSP item : m_d->doc->getStoryboardItemList()) {
        QDomElement eItem =  item->toXML(doc);
        eItemList.appendChild(eItem);
    }
    element.appendChild(eItemList);
}

References KisKraSaver::Private::doc, KisDocument::getStoryboardCommentsList(), KisDocument::getStoryboardItemList(), and m_d.

saveWarningColor()

void KisKraSaver::saveWarningColor ( QDomDocument & doc, QDomElement & element, KisImageSP image )

private

Definition at line 753 of file kis_kra_saver.cpp.

{
    if (image->proofingConfiguration()) {
        QDomElement e = doc.createElement(PROOFINGWARNINGCOLOR);
        KoColor color = image->proofingConfiguration()->warningColor;
        color.toXML(doc, e);
        element.appendChild(e);
    }
}

References KisImage::proofingConfiguration(), KRA::PROOFINGWARNINGCOLOR, and KoColor::toXML().

saveXML()

QDomElement KisKraSaver::saveXML	(	QDomDocument &	doc,
		KisImageSP	image )

Definition at line 99 of file kis_kra_saver.cpp.

{
    QDomElement imageElement = doc.createElement("IMAGE");
 
    Q_ASSERT(image);
    imageElement.setAttribute(NAME, m_d->imageName);
    imageElement.setAttribute(MIME, NATIVE_MIMETYPE);
    imageElement.setAttribute(WIDTH, KisDomUtils::toString(image->width()));
    imageElement.setAttribute(HEIGHT, KisDomUtils::toString(image->height()));
    imageElement.setAttribute(COLORSPACE_NAME, image->colorSpace()->id());
    imageElement.setAttribute(DESCRIPTION, m_d->doc->documentInfo()->aboutInfo("comment"));
    // XXX: Save profile as blob inside the image, instead of the product name.
    if (image->profile() && image->profile()-> valid()) {
        imageElement.setAttribute(PROFILE, image->profile()->name());
    }
    imageElement.setAttribute(X_RESOLUTION, KisDomUtils::toString(image->xRes()*72.0));
    imageElement.setAttribute(Y_RESOLUTION, KisDomUtils::toString(image->yRes()*72.0));
 
    //now the proofing options:
    if (image->proofingConfiguration()) {
        imageElement.setAttribute(PROOFINGPROFILENAME,
                                  KisDomUtils::toString(image->proofingConfiguration()->proofingProfile));
        imageElement.setAttribute(PROOFINGMODEL, KisDomUtils::toString(image->proofingConfiguration()->proofingModel));
        imageElement.setAttribute(PROOFINGDEPTH, KisDomUtils::toString(image->proofingConfiguration()->proofingDepth));
        imageElement.setAttribute(PROOFINGINTENT,
                                  KisDomUtils::toString(image->proofingConfiguration()->conversionIntent));
        imageElement.setAttribute(PROOFINGDISPLAYINTENT,
                                  KisDomUtils::toString(image->proofingConfiguration()->displayIntent));
        bool bcp = image->proofingConfiguration()->useBlackPointCompensationFirstTransform;
        imageElement.setAttribute(PROOFINGBLACKPOINTCOMPENSATION, bcp ? "true" : "false");
        bcp = image->proofingConfiguration()->displayFlags.testFlag(
            KoColorConversionTransformation::BlackpointCompensation);
        imageElement.setAttribute(PROOFINGDISPLAYBLACKPOINTCOMPENSATION, bcp ? "true" : "false");
        const QString mode = [&]() {
            switch (image->proofingConfiguration()->displayMode) {
            case KisProofingConfiguration::Monitor:
                return "monitor";
            case KisProofingConfiguration::Paper:
                return "paper";
            case KisProofingConfiguration::Custom:
                return "custom";
            }
            Q_UNREACHABLE_RETURN("custom");
        }();
        imageElement.setAttribute(PROOFINGDISPLAYMODE, mode);
        imageElement.setAttribute(PROOFINGADAPTATIONSTATE,
                                  KisDomUtils::toString(image->proofingConfiguration()->legacyAdaptationState()));
    }
 
    quint32 count = 1; // We don't save the root layer, but it does count
    KisSaveXmlVisitor visitor(doc, imageElement, count, m_d->filename, true);
    visitor.setSelectedNodes({m_d->doc->preActivatedNode()});
 
    image->rootLayer()->accept(visitor);
    m_d->errorMessages.append(visitor.errorMessages());
 
    m_d->nodeFileNames = visitor.nodeFileNames();
    m_d->keyframeFilenames = visitor.keyframeFileNames();
 
    saveHDRMetadata(doc, imageElement, image);
    saveBackgroundColor(doc, imageElement, image);
    saveAssistantsGlobalColor(doc, imageElement);
    saveWarningColor(doc, imageElement, image);
    saveCompositions(doc, imageElement, image);
    saveAssistantsList(doc, imageElement);
    saveGrid(doc, imageElement);
    saveGuides(doc, imageElement);
    saveMirrorAxis(doc, imageElement);
    saveColorHistory(doc, imageElement);
    saveResourcesToXML(doc, imageElement);
 
    // Redundancy -- Save animation metadata in XML to prevent data loss for the time being...
    QDomElement animationElement = doc.createElement("animation");
    KisDomUtils::saveValue(&animationElement, "framerate", image->animationInterface()->framerate());
    KisDomUtils::saveValue(&animationElement, "range", image->animationInterface()->documentPlaybackRange());
    KisDomUtils::saveValue(&animationElement, "currentTime", image->animationInterface()->currentUITime());
    imageElement.appendChild(animationElement);
 
    vKisAnnotationSP_it beginIt = image->beginAnnotations();
    vKisAnnotationSP_it endIt = image->endAnnotations();
 
    if (beginIt != endIt) {
        QDomElement annotationsElement = doc.createElement(ANNOTATIONS);
        vKisAnnotationSP_it it = beginIt;
        while (it != endIt) {
            if (!(*it) || (*it)->type().isEmpty()) {
                it++;
                continue;
            }
            QString type = (*it)->type();
 
            if (!m_d->specialAnnotations.contains(type)) {
 
                QString description = (*it)->description();
                QDomElement annotationElement = doc.createElement(ANNOTATION);
                annotationsElement.appendChild(annotationElement);
                annotationElement.setAttribute("type", type);
                annotationElement.setAttribute("description", description);
            }
            it++;
        }
        imageElement.appendChild(annotationsElement);
    }
 
 
    return imageElement;
}

References KoDocumentInfo::aboutInfo(), KisGroupLayer::accept(), KisImage::animationInterface(), KRA::ANNOTATION, KRA::ANNOTATIONS, KisImage::beginAnnotations(), KoColorConversionTransformation::BlackpointCompensation, KisImage::colorSpace(), KRA::COLORSPACE_NAME, KisImageAnimationInterface::currentUITime(), KisProofingConfiguration::Custom, DESCRIPTION, KisKraSaver::Private::doc, KisDocument::documentInfo(), KisImageAnimationInterface::documentPlaybackRange(), KisImage::endAnnotations(), KisKraSaver::Private::errorMessages, KisSaveXmlVisitor::errorMessages(), KisKraSaver::Private::filename, KisImageAnimationInterface::framerate(), KisImage::height(), KRA::HEIGHT, KoColorSpace::id, KisKraSaver::Private::imageName, KisKraSaver::Private::keyframeFilenames, KisSaveXmlVisitor::keyframeFileNames(), m_d, KRA::MIME, KisProofingConfiguration::Monitor, KoColorProfile::name, KRA::NAME, KRA::NATIVE_MIMETYPE, KisKraSaver::Private::nodeFileNames, KisSaveXmlVisitor::nodeFileNames(), KisProofingConfiguration::Paper, KisDocument::preActivatedNode, KisImage::profile(), KRA::PROFILE, KRA::PROOFINGADAPTATIONSTATE, KRA::PROOFINGBLACKPOINTCOMPENSATION, KisImage::proofingConfiguration(), KRA::PROOFINGDEPTH, KRA::PROOFINGDISPLAYBLACKPOINTCOMPENSATION, KRA::PROOFINGDISPLAYINTENT, KRA::PROOFINGDISPLAYMODE, KRA::PROOFINGINTENT, KRA::PROOFINGMODEL, KRA::PROOFINGPROFILENAME, KisImage::rootLayer(), saveAssistantsGlobalColor(), saveAssistantsList(), saveBackgroundColor(), saveColorHistory(), saveCompositions(), saveGrid(), saveGuides(), saveHDRMetadata(), saveMirrorAxis(), saveResourcesToXML(), KisDomUtils::saveValue(), saveWarningColor(), KisSaveXmlVisitor::setSelectedNodes(), KisKraSaver::Private::specialAnnotations, KisDomUtils::toString(), KisImage::width(), KRA::WIDTH, KRA::X_RESOLUTION, KisImage::xRes(), KRA::Y_RESOLUTION, and KisImage::yRes().

warningMessages()

QStringList KisKraSaver::warningMessages

(

)

const

Returns

a list with non-critical issues that happened while saving

Definition at line 684 of file kis_kra_saver.cpp.

{
    return m_d->warningMessages;
}

References m_d, and KisKraSaver::Private::warningMessages.

Member Data Documentation

m_d

Private* const KisKraSaver::m_d

private

Definition at line 72 of file kis_kra_saver.h.

---

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

• plugins/impex/libkra/kis_kra_saver.h
• plugins/impex/libkra/kis_kra_saver.cpp