#include <KoColorSet_p.h>

Public Member Functions
KisSwatchGroupSP	global ()

bool	init ()

bool	loadAcb ()

bool	loadAco ()

bool	loadAct ()

bool	loadAse ()

bool	loadCss ()

bool	loadGpl ()

bool	loadKpl ()

bool	loadPsp ()

bool	loadRiff ()

bool	loadSbz ()

bool	loadXml ()

	Private (KoColorSet *a_colorSet)

bool	saveGpl (QIODevice *dev) const

bool	saveKpl (QIODevice *dev) const

Public Attributes
KoColorSet *	colorSet {0}

int	columns

QString	comment

QByteArray	data

bool	isLocked {false}

KoColorSet::PaletteType	paletteType {UNKNOWN}

QList< KisSwatchGroupSP >	swatchGroups

KUndo2Stack	undoStack

Private Member Functions
KoColorSet::PaletteType	detectFormat (const QString &fileName, const QByteArray &ba)

const KoColorProfile *	loadColorProfile (QScopedPointer< KoStore > &store, const QString &path, const QString &modelId, const QString &colorDepthId)

bool	loadKplColorset (QScopedPointer< KoStore > &store)

void	loadKplGroup (const QDomDocument &doc, const QDomElement &parentElement, KisSwatchGroupSP group, QString version)

bool	loadKplProfiles (QScopedPointer< KoStore > &store)

bool	loadSbzSwatchbook (QScopedPointer< KoStore > &store)

bool	loadScribusXmlPalette (KoColorSet set, QXmlStreamReader xml)

quint8	readByte (QIODevice *io)

float	readFloat (QIODevice *io)

qint32	readInt (QIODevice *io)

quint16	readShort (QIODevice *io)

QString	readUnicodeString (QIODevice *io, bool sizeIsInt=false)

void	saveKplGroup (QDomDocument &doc, QDomElement &groupEle, const KisSwatchGroupSP group, QSet< const KoColorSpace * > &colorSetSet) const

void	scribusParseColor (KoColorSet set, QXmlStreamReader xml)

Friends
struct	AddGroupCommand

struct	AddSwatchCommand

struct	ChangeGroupNameCommand

struct	ClearCommand

struct	MoveGroupCommand

struct	RemoveGroupCommand

struct	RemoveSwatchCommand

struct	SetColumnCountCommand

struct	SetCommentCommand

struct	SetPaletteTypeCommand

Detailed Description

Definition at line 27 of file KoColorSet_p.h.

Constructor & Destructor Documentation

◆ Private()

KoColorSet::Private::Private ( KoColorSet * a_colorSet )

Definition at line 1041 of file KoColorSet.cpp.

    : colorSet(a_colorSet)
{
    undoStack.setUndoLimit(100);
    KisSwatchGroupSP group(new KisSwatchGroup);
    group->setName(KoColorSet::GLOBAL_GROUP_NAME);
    swatchGroups.clear();
    swatchGroups.append(group);
}

References KoColorSet::GLOBAL_GROUP_NAME, KUndo2QStack::setUndoLimit(), swatchGroups, and undoStack.

Member Function Documentation

◆ detectFormat()

KoColorSet::PaletteType KoColorSet::Private::detectFormat	(	const QString &	fileName,
		const QByteArray &	ba )

private

Definition at line 1051 of file KoColorSet.cpp.

{
    QFileInfo fi(fileName);
 
    // .pal
    if (ba.startsWith("RIFF") && ba.indexOf("PAL data", 8)) {
        return KoColorSet::RIFF_PAL;
    }
    // .gpl
    else if (ba.startsWith("GIMP Palette")) {
        return KoColorSet::GPL;
    }
    // .pal
    else if (ba.startsWith("JASC-PAL")) {
        return KoColorSet::PSP_PAL;
    }
    else if (ba.contains("krita/x-colorset") || ba.contains("application/x-krita-palette")) {
        return KoColorSet::KPL;
    }
    else if (fi.suffix().toLower() == "aco") {
        return KoColorSet::ACO;
    }
    else if (fi.suffix().toLower() == "act") {
        return KoColorSet::ACT;
    }
    else if (fi.suffix().toLower() == "xml") {
        return KoColorSet::XML;
    }
    else if (fi.suffix().toLower() == "sbz") {
        return KoColorSet::SBZ;
    }
    else if (fi.suffix().toLower() == "ase" || ba.startsWith("ASEF")) {
        return KoColorSet::ASE;
    }
    else if (fi.suffix().toLower() == "acb" || ba.startsWith("8BCB")) {
        return KoColorSet::ACB;
    }
    else if (fi.suffix().toLower() == "css") {
        return KoColorSet::CSS;
    }
    return KoColorSet::UNKNOWN;
}

References KoColorSet::ACB, KoColorSet::ACO, KoColorSet::ACT, KoColorSet::ASE, KoColorSet::CSS, KoColorSet::GPL, KoColorSet::KPL, KoColorSet::PSP_PAL, KoColorSet::RIFF_PAL, KoColorSet::SBZ, KoColorSet::UNKNOWN, and KoColorSet::XML.

◆ global()

KisSwatchGroupSP KoColorSet::Private::global ( )

inline

Definition at line 34 of file KoColorSet_p.h.

                              {
        Q_ASSERT(swatchGroups.size() > 0 && swatchGroups.first()->name() == GLOBAL_GROUP_NAME);
        return swatchGroups.first();
    }

References KoColorSet::GLOBAL_GROUP_NAME, and swatchGroups.

◆ init()

bool KoColorSet::Private::init ( )

Definition at line 1270 of file KoColorSet.cpp.

{
    // just in case this is a reload (eg by KoEditColorSetDialog),
    swatchGroups.clear();
    KisSwatchGroupSP globalGroup(new KisSwatchGroup);
    globalGroup->setName(KoColorSet::GLOBAL_GROUP_NAME);
    swatchGroups.append(globalGroup);
    undoStack.clear();
 
    if (colorSet->filename().isNull()) {
        warnPigment << "Cannot load palette" << colorSet->name() << "there is no filename set";
        return false;
    }
    if (data.isNull()) {
        QFile file(colorSet->filename());
        if (file.size() == 0) {
            warnPigment << "Cannot load palette" << colorSet->name() << "there is no data available";
            return false;
        }
        if (!file.open(QIODevice::ReadOnly)) {
            warnPigment << "Cannot load palette" << colorSet->name() << ":" << file.errorString();
            return false;
        }
        data = file.readAll();
        file.close();
    }
 
    bool res = false;
    paletteType = detectFormat(colorSet->filename(), data);
    switch(paletteType) {
    case GPL:
        res = loadGpl();
        break;
    case ACT:
        res = loadAct();
        break;
    case RIFF_PAL:
        res = loadRiff();
        break;
    case PSP_PAL:
        res = loadPsp();
        break;
    case ACO:
        res = loadAco();
        break;
    case XML:
        res = loadXml();
        break;
    case KPL:
        res = loadKpl();
        break;
    case SBZ:
        res = loadSbz();
        break;
    case ASE:
        res = loadAse();
        break;
    case ACB:
        res = loadAcb();
        break;
    case CSS:
        res = loadCss();
        break;
    default:
        res = false;
    }
    if (paletteType != KPL) {
        int rowCount = global()->colorCount() / global()->columnCount();
        if (global()->colorCount() % global()->columnCount() > 0) {
            rowCount ++;
        }
        global()->setRowCount(rowCount);
    }
    colorSet->setValid(res);
    colorSet->updateThumbnail();
 
    data.clear();
    undoStack.clear();
 
    return res;
}

References KoColorSet::ACB, KoColorSet::ACO, KoColorSet::ACT, KoColorSet::ASE, KUndo2QStack::clear(), KoColorSet::colorCount(), KoColorSet::columnCount(), KoColorSet::CSS, KoColorSet::GLOBAL_GROUP_NAME, KoColorSet::GPL, KoColorSet::KPL, KoColorSet::paletteType(), KoColorSet::PSP_PAL, KoColorSet::RIFF_PAL, KoColorSet::rowCount(), KoColorSet::SBZ, KoColorSet::undoStack(), warnPigment, and KoColorSet::XML.

◆ loadAcb()

bool KoColorSet::Private::loadAcb ( )

Definition at line 2321 of file KoColorSet.cpp.

{
 
    QFileInfo info(colorSet->filename());
 
    QBuffer buf(&data);
    buf.open(QBuffer::ReadOnly);
 
    QByteArray signature; // should be "8BCB";
    signature = buf.read(4);
    quint16 version = readShort(&buf);
    quint16 bookID = readShort(&buf);
    Q_UNUSED(bookID);
 
    if (signature != "8BCB" && version!= 1) {
        return false;
    }
 
    QStringList metadata;
    for (int i = 0; i< 4; i++) {
 
        QString metadataString = readUnicodeString(&buf, true);
        if (metadataString.startsWith("\"")) {
            metadataString = metadataString.remove(0, 1);
        }
        if (metadataString.endsWith("\"")) {
            metadataString.chop(1);
        }
        if (metadataString.startsWith("$$$/")) {
            if (metadataString.contains("=")) {
                metadataString = metadataString.split("=").last();
            } else {
                metadataString = QString();
            }
        }
        metadata.append(metadataString);
    }
    QString title = metadata.at(0);
    colorSet->setName(title);
    QString prefix = metadata.at(1);
    QString postfix = metadata.at(2);
    QString description = metadata.at(3);
    colorSet->setComment(description);
 
    quint16 numColors = readShort(&buf);
    quint16 numColumns = readShort(&buf);
    numColumns = numColumns > 0 ? numColumns : 8; // overwrite with sane default in case of 0
    colorSet->setColumnCount(numColumns);
    quint16 numKeyColorPage = readShort(&buf);
    Q_UNUSED(numKeyColorPage);
    quint16 colorType = readShort(&buf);
 
    const KoColorSpace *cs = KoColorSpaceRegistry::instance()->rgb8();
    if (colorType == 2) {
        QString profileName = "U.S. Web Coated (SWOP) v2";
        cs = KoColorSpaceRegistry::instance()->colorSpace(CMYKAColorModelID.id(), Integer8BitsColorDepthID.id(), profileName);
    } else if (colorType == 7) {
        cs = KoColorSpaceRegistry::instance()->colorSpace(LABAColorModelID.id(), Integer8BitsColorDepthID.id(), QString());
    }
 
    for (quint16 i = 0; i < numColors; i++) {
        KisSwatch swatch;
        QStringList name;
        name << prefix;
        name << readUnicodeString(&buf, true);
        name << postfix;
        swatch.setName(name.join(" ").trimmed());
        QByteArray key; // should be "8BCB";
        key = buf.read(6);
        swatch.setId(QString::fromLatin1(key));
        swatch.setSpotColor(true);
        quint8 c1 = readByte(&buf);
        quint8 c2 = readByte(&buf);
        quint8 c3 = readByte(&buf);
        KoColor c(cs);
        if (colorType == 0) {
            c.data()[0] = c3;
            c.data()[1] = c2;
            c.data()[2] = c1;
        } else if (colorType == 2) {
            quint8 c4 = readByte(&buf);
            c.data()[0] = c1;
            c.data()[1] = c2;
            c.data()[2] = c3;
            c.data()[3] = c4;
        } else if (colorType == 7) {
            c.data()[0] = c1;
            c.data()[1] = c2;
            c.data()[2] = c3;
        }
        c.setOpacity(1.0);
        swatch.setColor(c);
        colorSet->addSwatch(swatch);
    }
 
    return true;
}

References CMYKAColorModelID, KoColorSpaceRegistry::colorSpace(), KoColor::data(), KoID::id(), KoColorSpaceRegistry::instance(), Integer8BitsColorDepthID, LABAColorModelID, KoResource::metadata, KoResource::name, KoColorSpaceRegistry::rgb8(), KisSwatch::setColor(), KisSwatch::setId(), KisSwatch::setName(), KoColor::setOpacity(), KisSwatch::setSpotColor(), KoResource::signature(), and KoResource::version.

◆ loadAco()

bool KoColorSet::Private::loadAco ( )

Definition at line 1817 of file KoColorSet.cpp.

{
    QFileInfo info(colorSet->filename());
    colorSet->setName(info.completeBaseName());
 
    QBuffer buf(&data);
    buf.open(QBuffer::ReadOnly);
 
    quint16 version = readShort(&buf);
    quint16 numColors = readShort(&buf);
    KisSwatch swatch;
 
    if (version == 1 && buf.size() > 4+numColors*10) {
        buf.seek(4+numColors*10);
        version = readShort(&buf);
        numColors = readShort(&buf);
    }
 
    const quint16 quint16_MAX = 65535;
 
    KisSwatchGroupSP group = colorSet->getGlobalGroup();
 
    for (int i = 0; i < numColors && !buf.atEnd(); ++i) {
 
        quint16 colorSpace = readShort(&buf);
        quint16 ch1 = readShort(&buf);
        quint16 ch2 = readShort(&buf);
        quint16 ch3 = readShort(&buf);
        quint16 ch4 = readShort(&buf);
 
        bool skip = false;
        if (colorSpace == 0) { // RGB
            const KoColorProfile *srgb = KoColorSpaceRegistry::instance()->rgb8()->profile();
            KoColor c(KoColorSpaceRegistry::instance()->rgb16(srgb));
            reinterpret_cast<quint16*>(c.data())[0] = ch3;
            reinterpret_cast<quint16*>(c.data())[1] = ch2;
            reinterpret_cast<quint16*>(c.data())[2] = ch1;
            c.setOpacity(OPACITY_OPAQUE_U8);
            swatch.setColor(c);
        }
        else if (colorSpace == 1) { // HSB
            QColor qc;
            qc.setHsvF(ch1 / 65536.0, ch2 / 65536.0, ch3 / 65536.0);
            KoColor c(qc, KoColorSpaceRegistry::instance()->rgb16());
            c.setOpacity(OPACITY_OPAQUE_U8);
            swatch.setColor(c);
        }
        else if (colorSpace == 2) { // CMYK
            KoColor c(KoColorSpaceRegistry::instance()->colorSpace(CMYKAColorModelID.id(), Integer16BitsColorDepthID.id(), QString()));
            reinterpret_cast<quint16*>(c.data())[0] = quint16_MAX - ch1;
            reinterpret_cast<quint16*>(c.data())[1] = quint16_MAX - ch2;
            reinterpret_cast<quint16*>(c.data())[2] = quint16_MAX - ch3;
            reinterpret_cast<quint16*>(c.data())[3] = quint16_MAX - ch4;
            c.setOpacity(OPACITY_OPAQUE_U8);
            swatch.setColor(c);
        }
        else if (colorSpace == 7) { // LAB
            KoColor c = KoColor(KoColorSpaceRegistry::instance()->lab16());
            reinterpret_cast<quint16*>(c.data())[0] = ch3;
            reinterpret_cast<quint16*>(c.data())[1] = ch2;
            reinterpret_cast<quint16*>(c.data())[2] = ch1;
            c.setOpacity(OPACITY_OPAQUE_U8);
            swatch.setColor(c);
        }
        else if (colorSpace == 8) { // GRAY
            KoColor c(KoColorSpaceRegistry::instance()->colorSpace(GrayAColorModelID.id(), Integer16BitsColorDepthID.id(), QString()));
            reinterpret_cast<quint16*>(c.data())[0] = ch1 * (quint16_MAX / 10000);
            c.setOpacity(OPACITY_OPAQUE_U8);
            swatch.setColor(c);
        }
        else {
            warnPigment << "Unsupported colorspace in palette" << colorSet->filename() << "(" << colorSpace << ")";
            skip = true;
        }
 
        if (version == 2) {
            QString name = readUnicodeString(&buf, true);
            swatch.setName(name);
        }
        if (!skip) {
            group->addSwatch(swatch);
        }
    }
    return true;
}

References CMYKAColorModelID, KoColor::data(), GrayAColorModelID, KoID::id(), KoColorSpaceRegistry::instance(), Integer16BitsColorDepthID, KoResource::name, OPACITY_OPAQUE_U8, KoColorSpace::profile(), quint16_MAX, KoColorSpaceRegistry::rgb8(), KisSwatch::setColor(), KisSwatch::setName(), KoColor::setOpacity(), KoResource::version, and warnPigment.

◆ loadAct()

bool KoColorSet::Private::loadAct ( )

Definition at line 1455 of file KoColorSet.cpp.

{
    QFileInfo info(colorSet->filename());
    colorSet->setName(info.completeBaseName());
    KisSwatch swatch;
    int numOfTriplets = int(data.size() / 3);
    for (int i = 0; i < numOfTriplets * 3; i += 3) {
        quint8 r = data[i];
        quint8 g = data[i+1];
        quint8 b = data[i+2];
        swatch.setColor(KoColor(QColor(r, g, b), KoColorSpaceRegistry::instance()->rgb8()));
        global()->addSwatch(swatch);
    }
    return true;
}

References KoColorSpaceRegistry::instance(), and KisSwatch::setColor().

◆ loadAse()

bool KoColorSet::Private::loadAse ( )

Definition at line 2216 of file KoColorSet.cpp.

{
    QFileInfo info(colorSet->filename());
    colorSet->setName(info.completeBaseName());
 
    QBuffer buf(&data);
    buf.open(QBuffer::ReadOnly);
 
    QByteArray signature; // should be "ASEF";
    signature = buf.read(4);
    quint16 version = readShort(&buf);
    quint16 version2 = readShort(&buf);
 
    if (signature != "ASEF" && version!= 1 && version2 != 0) {
        qWarning() << "incorrect header:" << signature << version << version2;
        return false;
    }
    qint32 numBlocks = readInt(&buf);
 
    QByteArray groupStart("\xC0\x01");
    QByteArray groupEnd("\xC0\x02");
    QByteArray swatchSig("\x00\x01");
 
    bool inGroup = false;
    QString groupName;
    for (qint32 i = 0; i < numBlocks; i++) {
        QByteArray blockType;
        blockType = buf.read(2);
        qint32 blockSize = readInt(&buf);
        qint64 pos = buf.pos();
 
        if (blockType == groupStart) {
            groupName = readUnicodeString(&buf);
            colorSet->addGroup(groupName);
            inGroup = true;
        }
        else if (blockType == groupEnd) {
            int colorCount = colorSet->getGroup(groupName)->colorCount();
            int columns = colorSet->columnCount();
            int rows = colorCount/columns;
            if (colorCount % columns > 0) {
                rows += 1;
            }
            colorSet->getGroup(groupName)->setRowCount(rows);
            inGroup = false;
        }
        else /* if (blockType == swatchSig)*/ {
            KisSwatch swatch;
            swatch.setName(readUnicodeString(&buf).trimmed());
            QByteArray colorModel;
            QDomDocument doc;
            colorModel = buf.read(4);
            if (colorModel == "RGB ") {
                QDomElement elt = doc.createElement("sRGB");
 
                elt.setAttribute("r", readFloat(&buf));
                elt.setAttribute("g", readFloat(&buf));
                elt.setAttribute("b", readFloat(&buf));
 
                KoColor color = KoColor::fromXML(elt, "U8");
                swatch.setColor(color);
            } else if (colorModel == "CMYK") {
                QDomElement elt = doc.createElement("CMYK");
 
                elt.setAttribute("c", readFloat(&buf));
                elt.setAttribute("m", readFloat(&buf));
                elt.setAttribute("y", readFloat(&buf));
                elt.setAttribute("k", readFloat(&buf));
                //try to select the default PS icc profile if possible.
                elt.setAttribute("space", "U.S. Web Coated (SWOP) v2");
 
                KoColor color = KoColor::fromXML(elt, "U8");
                swatch.setColor(color);
            } else if (colorModel == "LAB ") {
                QDomElement elt = doc.createElement("Lab");
 
                elt.setAttribute("L", readFloat(&buf)*100.0);
                elt.setAttribute("a", readFloat(&buf));
                elt.setAttribute("b", readFloat(&buf));
 
                KoColor color = KoColor::fromXML(elt, "U16");
                swatch.setColor(color);
            } else if (colorModel == "GRAY") {
                QDomElement elt = doc.createElement("Gray");
 
                elt.setAttribute("g", readFloat(&buf));
 
                KoColor color = KoColor::fromXML(elt, "U8");
                swatch.setColor(color);
            }
            qint16 type = readShort(&buf);
            if (type == 1) { //0 is global, 2 is regular;
                swatch.setSpotColor(true);
            }
            if (inGroup) {
                colorSet->addSwatch(swatch, groupName);
            } else {
                colorSet->addSwatch(swatch);
            }
        }
        buf.seek(pos + qint64(blockSize));
    }
    return true;
}

References KoColorSet::colorCount(), KoColor::fromXML(), KisSwatch::setColor(), KisSwatch::setName(), KisSwatch::setSpotColor(), KoResource::signature(), and KoResource::version.

◆ loadColorProfile()

const KoColorProfile * KoColorSet::Private::loadColorProfile	(	QScopedPointer< KoStore > &	store,
		const QString &	path,
		const QString &	modelId,
		const QString &	colorDepthId )

private

Definition at line 1694 of file KoColorSet.cpp.

{
    if (!store->open(path)) {
        return nullptr;
    }
 
    QByteArray bytes = store->read(store->size());
    store->close();
 
    const KoColorProfile *profile = KoColorSpaceRegistry::instance()
        ->createColorProfile(modelId, colorDepthId, bytes);
    if (!profile || !profile->valid()) {
        return nullptr;
    }
 
    KoColorSpaceRegistry::instance()->addProfile(profile);
    return profile;
}

References KoColorSpaceRegistry::addProfile(), KoColorSpaceRegistry::createColorProfile(), KoColorSpaceRegistry::instance(), and KoColorProfile::valid().

◆ loadCss()

bool KoColorSet::Private::loadCss ( )

Definition at line 1534 of file KoColorSet.cpp.

{
    QFileInfo info(colorSet->filename());
    colorSet->setName(info.completeBaseName());
    
    QString text = readAllLinesSafe(&data).join("").replace("\t", "").replace(" ", ""); 
    
    QRegularExpression re("/\\*.*?\\*/");
 
    text.remove(re); // Remove comments
 
    KisSwatch swatch;
    
    // Regex to detect a color in the palette
    QRegularExpression palette("(.*?){(?:[^:;]+:[^;]+;)*?color:(.*?)(?:;.*?)*?}");
 
    QRegularExpressionMatchIterator colors = palette.globalMatch(text);
 
    if (!colors.hasNext()) {
        warnPigment << "No color found in CSS palette : " << colorSet->filename();
        return false;
    }
    
    while (colors.hasNext()) {
        QRegularExpressionMatch match = colors.next();
        QString colorInfo = match.captured();
        QString colorName = match.captured(1);
        QString colorValue = match.captured(2);
        
        if (!colorInfo.startsWith(".") || colorValue.isEmpty()) {
            warnPigment << "Illegal CSS palette syntax : " << colorInfo;
            return false;
        }
 
        QColor qColor;
 
        colorName.remove(".");
        swatch.setName(colorName);
 
        if (colorValue.startsWith("rgb")) {
            QStringList color;
            
            if (colorValue.startsWith("rgba")) {
                colorValue.remove("rgba(").remove(")");
                color = colorValue.split(",");
 
                if (color.size() != 4) {
                    warnPigment << "Invalid RGBA color definition : " << colorInfo;
                    return false;
                }
                
                int alpha = color[3].toFloat() * 255;
                
                if (alpha < 0 || alpha > 255) {
                    warnPigment << "Invalid alpha parameter : " << colorInfo;
                    return false;
                }
            }
            else {
                colorValue.remove("rgb(").remove(")");
                
                color = colorValue.split(",");
 
                if (color.size() != 3) {
                    warnPigment << "Invalid RGB color definition : " << colorInfo;
                    return false;
                }
            }
 
            int rgb[3];
 
            for (int i = 0; i < 3; i++) {
                if (color[i].endsWith("%")) {
                    color[i].replace("%", "");
                    rgb[i] = color[i].toFloat() / 100 * 255 ;
                }
                else {
                    rgb[i] = color[i].toInt();
                };
            }
 
            qColor = QColor(rgb[0], rgb[1], rgb[2]);
        }
        else if (colorValue.startsWith("hsl")) {
            QStringList color;
 
            if (colorValue.startsWith("hsla")) {
                colorValue.remove("hsla(").remove(")").replace("%", "");
                color = colorValue.split(",");
                if (color.size() != 4) {
                    warnPigment << "Invalid HSLA color definition : " << colorInfo;
                    return false;
                }
 
                float alpha = color[3].toFloat();
 
                if (alpha < 0.0 || alpha > 1.0) {
                    warnPigment << "Invalid alpha parameter : " << colorInfo;
                    return false;
                }
 
            }
            else {
                colorValue.remove("hsl(").remove(")").replace("%", "");
                color = colorValue.split(",");
                if (color.size() != 3) {
                    warnPigment << "Invalid HSL color definition : " << colorInfo;
                    return false;
                }
            }
            
            float hue = color[0].toFloat() / 359;
            float saturation = color[1].toFloat() / 100;
            float lightness = color[2].toFloat() / 100;
 
            if (hue < 0.0 || hue > 1.0) {
                warnPigment << "Invalid hue parameter : " << colorInfo;
                return false;
            }
 
            if (saturation < 0.0 || saturation > 1.0) {
                warnPigment << "Invalid saturation parameter : " << colorInfo;
                return false;
            }
 
            if (lightness < 0.0 || lightness > 1.0) {
                warnPigment << "Invalid lightness parameter : " << colorInfo;
                return false;
            }
 
            qColor = QColor::fromHslF(hue, saturation, lightness);
 
        }
        else if (colorValue.startsWith("#")) {
            if (colorValue.size() == 9) {
                // Convert the CSS format #RRGGBBAA to #RRGGBB 
                // Due to QColor's 8 digits format being #AARRGGBB and that we do not load the alpha channel
                colorValue.truncate(7);
            }
            
            qColor = QColor(colorValue);
        }
        else {
            warnPigment << "Unknown color declaration : " << colorInfo;
            return false;
        }
 
        if (!qColor.isValid()) {
            warnPigment << "Invalid color definition : " << colorInfo;
            return false;
        }
 
        swatch.setColor(KoColor(qColor, KoColorSpaceRegistry::instance()->rgb8()));
 
        global()->addSwatch(swatch);
    }
 
    return true;
}

References KoColorSpaceRegistry::instance(), palette, KisSwatch::setColor(), KisSwatch::setName(), and warnPigment.

◆ loadGpl()

bool KoColorSet::Private::loadGpl ( )

Definition at line 1380 of file KoColorSet.cpp.

{
    if (data.isEmpty() || data.isNull() || data.length() < 50) {
        warnPigment << "Illegal Gimp palette file: " << colorSet->filename();
        return false;
    }
 
    quint32 index = 0;
 
    QStringList lines = readAllLinesSafe(&data);
 
    if (lines.size() < 3) {
        warnPigment << "Not enough lines in palette file: " << colorSet->filename();
        return false;
    }
 
    QString columnsText;
    qint32 r, g, b;
    KisSwatch swatch;
 
    // Read name
    if (!lines[0].startsWith("GIMP") || !lines[1].toLower().contains("name")) {
        warnPigment << "Illegal Gimp palette file: " << colorSet->filename();
        return false;
    }
 
    // translated name will be in a tooltip, here don't translate
    colorSet->setName(lines[1].split(":")[1].trimmed());
 
    index = 2;
 
    // Read columns
    int columns = 0;
    if (lines[index].toLower().contains("columns")) {
        columnsText = lines[index].split(":")[1].trimmed();
        columns = columnsText.toInt();
        if (columns > MAXIMUM_ALLOWED_COLUMNS) {
            warnPigment << "Refusing to set unreasonable number of columns (" << columns << ") in GIMP Palette file " << colorSet->filename() << " - using maximum number of allowed columns instead";
            global()->setColumnCount(MAXIMUM_ALLOWED_COLUMNS);
        }
        else {
            global()->setColumnCount(columns);
        }
        index = 3;
    }
 
 
    for (qint32 i = index; i < lines.size(); i++) {
        if (lines[i].startsWith('#')) {
            comment += lines[i].mid(1).trimmed() + ' ';
        } else if (!lines[i].isEmpty()) {
            QStringList a = lines[i].replace('\t', ' ').split(' ', Qt::SkipEmptyParts);
 
            if (a.count() < 3) {
                continue;
            }
 
            r = qBound(0, a[0].toInt(), 255);
            g = qBound(0, a[1].toInt(), 255);
            b = qBound(0, a[2].toInt(), 255);
 
            swatch.setColor(KoColor(QColor(r, g, b), KoColorSpaceRegistry::instance()->rgb8()));
 
            for (int i = 0; i != 3; i++) {
                a.pop_front();
            }
            QString name = a.join(" ");
            swatch.setName(name.isEmpty() || name == "Untitled" ? i18n("Untitled") : name);
 
            global()->addSwatch(swatch);
        }
    }
    return true;
}

References KoColorSet::comment(), KoColorSpaceRegistry::instance(), MAXIMUM_ALLOWED_COLUMNS, KoResource::name, KisSwatch::setColor(), KisSwatch::setName(), and warnPigment.

◆ loadKpl()

bool KoColorSet::Private::loadKpl ( )

Definition at line 1792 of file KoColorSet.cpp.

{
    QBuffer buf(&data);
    buf.open(QBuffer::ReadOnly);
 
    QScopedPointer<KoStore> store(
        KoStore::createStore(&buf, KoStore::Read,
                             "application/x-krita-palette",
                             KoStore::Zip));
    if (!store || store->bad()) {
        return false;
    }
 
    if (store->hasFile("profiles.xml") && !loadKplProfiles(store)) {
        return false;
    }
 
    if (!loadKplColorset(store)) {
        return false;
    }
 
    buf.close();
    return true;
}

References KoStore::createStore(), KoStore::Read, and KoStore::Zip.

◆ loadKplColorset()

bool KoColorSet::Private::loadKplColorset ( QScopedPointer< KoStore > & store )

private

Definition at line 1750 of file KoColorSet.cpp.

{
    if (!store->open("colorset.xml")) {
        return false;
    }
 
    QByteArray bytes = store->read(store->size());
    store->close();
 
    QDomDocument doc;
    if (!doc.setContent(bytes)) {
        return false;
    }
 
    QDomElement root = doc.documentElement();
    colorSet->setName(root.attribute(KPL_PALETTE_NAME_ATTR));
    QString version = root.attribute(KPL_VERSION_ATTR);
    comment         = root.attribute(KPL_PALETTE_COMMENT_ATTR);
 
    int desiredColumnCount = root.attribute(KPL_PALETTE_COLUMN_COUNT_ATTR).toInt();
    if (desiredColumnCount > MAXIMUM_ALLOWED_COLUMNS) {
        warnPigment << "Refusing to set unreasonable number of columns (" << desiredColumnCount
                    << ") in KPL palette file " << colorSet->filename()
                    << " - setting maximum allowed column count instead.";
        colorSet->setColumnCount(MAXIMUM_ALLOWED_COLUMNS);
    } else {
        colorSet->setColumnCount(desiredColumnCount);
    }
 
    loadKplGroup(doc, root, colorSet->getGlobalGroup(), version);
 
    for (QDomElement g = root.firstChildElement(KPL_GROUP_TAG);
         !g.isNull();
         g = g.nextSiblingElement(KPL_GROUP_TAG)) {
        QString groupName = g.attribute(KPL_GROUP_NAME_ATTR);
        colorSet->addGroup(groupName);
        loadKplGroup(doc, g, colorSet->getGroup(groupName), version);
    }
 
    return true;
}

References KoColorSet::comment(), KoColorSet::KPL_GROUP_NAME_ATTR, KoColorSet::KPL_GROUP_TAG, KoColorSet::KPL_PALETTE_COLUMN_COUNT_ATTR, KoColorSet::KPL_PALETTE_COMMENT_ATTR, KoColorSet::KPL_PALETTE_NAME_ATTR, KoColorSet::KPL_VERSION_ATTR, MAXIMUM_ALLOWED_COLUMNS, KoResource::version, and warnPigment.

◆ loadKplGroup()

void KoColorSet::Private::loadKplGroup	(	const QDomDocument &	doc,
		const QDomElement &	parentElement,
		KisSwatchGroupSP	group,
		QString	version )

private

Definition at line 2554 of file KoColorSet.cpp.

{
    Q_UNUSED(doc);
    if (!parentEle.attribute(KPL_GROUP_ROW_COUNT_ATTR).isNull()) {
        group->setRowCount(parentEle.attribute(KPL_GROUP_ROW_COUNT_ATTR).toInt());
    }
    group->setColumnCount(colorSet->columnCount());
 
    for (QDomElement swatchEle = parentEle.firstChildElement(KPL_SWATCH_TAG);
         !swatchEle.isNull();
         swatchEle = swatchEle.nextSiblingElement(KPL_SWATCH_TAG)) {
        QString colorDepthId = swatchEle.attribute(KPL_SWATCH_BITDEPTH_ATTR, Integer8BitsColorDepthID.id());
        KisSwatch swatch;
 
        if (version == "1.0" && swatchEle.firstChildElement().tagName() == "Lab") {
            // previous version of krita had the values wrong, and scaled everything between 0 to 1,
            // but lab requires L = 0-100 and AB = -128-127.
            // TODO: write unittest for this.
            QDomElement el = swatchEle.firstChildElement();
            double L = KisDomUtils::toDouble(el.attribute("L"));
            el.setAttribute("L", L*100.0);
            double ab = KisDomUtils::toDouble(el.attribute("a"));
            if (ab <= .5) {
                ab = (0.5 - ab) * 2 * -128.0;
            } else {
                ab = (ab - 0.5) * 2 * 127.0;
            }
            el.setAttribute("a", ab);
 
            ab = KisDomUtils::toDouble(el.attribute("b"));
            if (ab <= .5) {
                ab = (0.5 - ab) * 2 * -128.0;
            } else {
                ab = (ab - 0.5) * 2 * 127.0;
            }
            el.setAttribute("b", ab);
            swatch.setColor(KoColor::fromXML(el, colorDepthId));
        } else {
            swatch.setColor(KoColor::fromXML(swatchEle.firstChildElement(), colorDepthId));
        }
        swatch.setName(swatchEle.attribute(KPL_SWATCH_NAME_ATTR));
        swatch.setId(swatchEle.attribute(KPL_SWATCH_ID_ATTR));
        swatch.setSpotColor(swatchEle.attribute(KPL_SWATCH_SPOT_ATTR, "false") == "true" ? true : false);
        QDomElement positionEle = swatchEle.firstChildElement(KPL_SWATCH_POS_TAG);
        if (!positionEle.isNull()) {
            int rowNumber = positionEle.attribute(KPL_SWATCH_ROW_ATTR).toInt();
            int columnNumber = positionEle.attribute(KPL_SWATCH_COL_ATTR).toInt();
            if (columnNumber < 0 ||
                    columnNumber >= colorSet->columnCount() ||
                    rowNumber < 0
                    ) {
                warnPigment << "Swatch" << swatch.name()
                            << "of palette" << colorSet->name()
                            << "has invalid position.";
                continue;
            }
            group->setSwatch(swatch, columnNumber, rowNumber);
        } else {
            group->addSwatch(swatch);
        }
    }
 
    if (parentEle.attribute(KPL_GROUP_ROW_COUNT_ATTR).isNull()
            && group->colorCount() > 0
            && group->columnCount() > 0
            && (group->colorCount() / (group->columnCount()) + 1) < 20) {
        group->setRowCount((group->colorCount() / group->columnCount()) + 1);
    }
 
}

◆ loadKplProfiles()

bool KoColorSet::Private::loadKplProfiles ( QScopedPointer< KoStore > & store )

private

Definition at line 1716 of file KoColorSet.cpp.

{
    if (!store->open("profiles.xml")) {
        return false;
    }
 
    QByteArray bytes = store->read(store->size());
    store->close();
 
    QDomDocument doc;
    if(!doc.setContent(bytes)) {
        return false;
    }
 
    QDomElement root = doc.documentElement();
    for (QDomElement c = root.firstChildElement(KPL_PALETTE_PROFILE_TAG);
         !c.isNull();
         c = c.nextSiblingElement(KPL_PALETTE_PROFILE_TAG)) {
        QString name         = c.attribute(KPL_PALETTE_NAME_ATTR);
        QString filename     = c.attribute(KPL_PALETTE_FILENAME_ATTR);
        QString colorModelId = c.attribute(KPL_COLOR_MODEL_ID_ATTR);
        QString colorDepthId = c.attribute(KPL_COLOR_DEPTH_ID_ATTR);
 
        if (KoColorSpaceRegistry::instance()->profileByName(name)) {
            continue;
        }
 
        loadColorProfile(store, filename, colorModelId, colorDepthId);
        // TODO: What should happen if this fails?
    }
 
    return true;
}

References KoResource::filename, KoColorSpaceRegistry::instance(), KoColorSet::KPL_COLOR_DEPTH_ID_ATTR, KoColorSet::KPL_COLOR_MODEL_ID_ATTR, KoColorSet::KPL_PALETTE_FILENAME_ATTR, KoColorSet::KPL_PALETTE_NAME_ATTR, KoColorSet::KPL_PALETTE_PROFILE_TAG, KoResource::name, and KoColorSpaceRegistry::profileByName().

◆ loadPsp()

bool KoColorSet::Private::loadPsp ( )

Definition at line 1495 of file KoColorSet.cpp.

{
    QFileInfo info(colorSet->filename());
    colorSet->setName(info.completeBaseName());
    KisSwatch swatch;
    qint32 r, g, b;
 
    QStringList l = readAllLinesSafe(&data);
    if (l.size() < 4) return false;
    if (l[0] != "JASC-PAL") return false;
    if (l[1] != "0100") return false;
 
    int entries = l[2].toInt();
 
    KisSwatchGroupSP global = colorSet->getGlobalGroup();
 
    for (int i = 0; i < entries; ++i)  {
 
        QStringList a = l[i + 3].replace('\t', ' ').split(' ', Qt::SkipEmptyParts);
 
        if (a.count() != 3) {
            continue;
        }
 
        r = qBound(0, a[0].toInt(), 255);
        g = qBound(0, a[1].toInt(), 255);
        b = qBound(0, a[2].toInt(), 255);
 
        swatch.setColor(KoColor(QColor(r, g, b),
                                KoColorSpaceRegistry::instance()->rgb8()));
 
        QString name = a.join(" ");
        swatch.setName(name.isEmpty() ? i18n("Untitled") : name);
 
        global->addSwatch(swatch);
    }
    return true;
}

References KoColorSpaceRegistry::instance(), KoResource::name, KisSwatch::setColor(), and KisSwatch::setName().

◆ loadRiff()

bool KoColorSet::Private::loadRiff ( )

Definition at line 1471 of file KoColorSet.cpp.

{
    // https://worms2d.info/Palette_file
    QFileInfo info(colorSet->filename());
    colorSet->setName(info.completeBaseName());
    KisSwatch swatch;
 
    RiffHeader header;
    memcpy(&header, data.constData(), sizeof(RiffHeader));
    header.colorcount = qFromBigEndian(header.colorcount);
 
    for (int i = sizeof(RiffHeader);
         (i < (int)(sizeof(RiffHeader) + (header.colorcount * 4)) && i < data.size());
         i += 4) {
        quint8 r = data[i];
        quint8 g = data[i+1];
        quint8 b = data[i+2];
        swatch.setColor(KoColor(QColor(r, g, b), KoColorSpaceRegistry::instance()->rgb8()));
        colorSet->getGlobalGroup()->addSwatch(swatch);
    }
    return true;
}

References RiffHeader::colorcount, KoColorSpaceRegistry::instance(), KoColorSpaceRegistry::rgb8(), and KisSwatch::setColor().

◆ loadSbz()

bool KoColorSet::Private::loadSbz ( )

Definition at line 2195 of file KoColorSet.cpp.

                                {
    QBuffer buf(&data);
    buf.open(QBuffer::ReadOnly);
 
    // &buf is a subclass of QIODevice
    QScopedPointer<KoStore> store(
        KoStore::createStore(&buf, KoStore::Read,
                             "application/x-swatchbook",
                             KoStore::Zip));
    if (!store || store->bad()) {
        return false;
    }
 
    if (store->hasFile("swatchbook.xml") && !loadSbzSwatchbook(store)) {
        return false;
    }
 
    buf.close();
    return true;
}

References KoStore::createStore(), KoStore::Read, and KoStore::Zip.

◆ loadSbzSwatchbook()

bool KoColorSet::Private::loadSbzSwatchbook ( QScopedPointer< KoStore > & store )

private

Definition at line 1903 of file KoColorSet.cpp.

{
    if (!store->open("swatchbook.xml")) {
        return false;
    }
 
    QByteArray bytes = store->read(store->size());
    store->close();
 
    dbgPigment << "XML palette: " << colorSet->filename() << ", SwatchBooker format";
 
    QDomDocument doc;
#if QT_VERSION < QT_VERSION_CHECK(6, 5, 0)
    int errorLine, errorColumn;
    QString errorMessage;
    if (!doc.setContent(bytes, &errorMessage, &errorLine, &errorColumn)) {
        warnPigment << "Illegal XML palette:" << colorSet->filename();
        warnPigment << "Error (line" << errorLine
                    << ", column" << errorColumn
                    << "):" << errorMessage;
#else
    QDomDocument::ParseResult result = doc.setContent(bytes);
    if (!result) {
        warnPigment << "Illegal XML palette:" << colorSet->filename();
        warnPigment << "Error (line" << result.errorLine
                    << ", column" << result.errorColumn
                    << "):" << result.errorMessage;
#endif
        return false;
    }
 
    QDomElement root = doc.documentElement(); // SwatchBook
 
    // Start reading properties...
    QDomElement metadata = root.firstChildElement("metadata");
    if (metadata.isNull()) {
        warnPigment << "Palette metadata not found";
        return false;
    }
 
    QDomElement title = metadata.firstChildElement("dc:title");
    QString colorName = title.text();
    colorName = colorName.isEmpty() ? i18n("Untitled") : colorName;
    colorSet->setName(colorName);
    dbgPigment << "Processed name of palette:" << colorSet->name();
    // End reading properties
 
    // Also read the swatch book...
    QDomElement book = root.firstChildElement("book");
    if (book.isNull()) {
        warnPigment << "Palette book (swatch composition) not found (line" << root.lineNumber()
                    << ", column" << root.columnNumber()
                    << ")";
        return false;
    }
 
    // Which has lots of "swatch"es (todo: support groups)
    QDomElement swatch = book.firstChildElement();
    if (swatch.isNull()) {
        warnPigment << "Swatches/groups definition not found (line" << book.lineNumber()
                    << ", column" << book.columnNumber()
                    << ")";
        return false;
    }
 
    // Now read colors...
    QDomElement materials = root.firstChildElement("materials");
    if (materials.isNull()) {
        warnPigment << "Materials (color definitions) not found";
        return false;
    }
 
    // This one has lots of "color" elements
    if (materials.firstChildElement("color").isNull()) {
        warnPigment << "Color definitions not found (line" << materials.lineNumber()
                    << ", column" << materials.columnNumber()
                    << ")";
        return false;
    }
 
    // We'll store colors here, and as we process swatches
    // we'll add them to the palette
    QHash<QString, KisSwatch> materialsBook;
    QHash<QString, const KoColorSpace*> fileColorSpaces;
 
    // Color processing
    store->enterDirectory("profiles"); // Color profiles (icc files) live here
    for (QDomElement colorElement = materials.firstChildElement("color");
         !colorElement.isNull();
         colorElement = colorElement.nextSiblingElement("color")) {
        KisSwatch currentEntry;
        // Set if color is spot
        currentEntry.setSpotColor(colorElement.attribute("usage") == "spot");
 
        // <metadata> inside contains id and name
        // one or more <values> define the color
        QDomElement currentColorMetadata = colorElement.firstChildElement("metadata");
        // Get color name
        QDomElement colorTitle = currentColorMetadata.firstChildElement("dc:title");
        QDomElement colorId = currentColorMetadata.firstChildElement("dc:identifier");
        // Is there an id? (we need that at the very least for identifying a color)
        if (colorId.text().isEmpty()) {
            warnPigment << "Unidentified color (line" << colorId.lineNumber()
                        << ", column" << colorId.columnNumber()
                        << ")";
            return false;
        }
 
        if (materialsBook.contains(colorId.text())) {
            warnPigment << "Duplicated color definition (line" << colorId.lineNumber()
                        << ", column" << colorId.columnNumber()
                        << ")";
            return false;
        }
 
        // Get a valid color name
        currentEntry.setId(colorId.text());
        currentEntry.setName(colorTitle.text().isEmpty() ? colorId.text() : colorTitle.text());
 
        // Get a valid color definition
        if (colorElement.firstChildElement("values").isNull()) {
            warnPigment << "Color definitions not found (line" << colorElement.lineNumber()
                        << ", column" << colorElement.columnNumber()
                        << ")";
            return false;
        }
 
        bool status;
        bool firstDefinition = false;
        KoColorSpaceRegistry *colorSpaceRegistry = KoColorSpaceRegistry::instance();
        const QString colorDepthId = Float32BitsColorDepthID.id();
        // Priority: Lab, otherwise the first definition found
        for (QDomElement colorValueE = colorElement.firstChildElement("values");
             !colorValueE.isNull();
             colorValueE = colorValueE.nextSiblingElement("values")) {
            QString model = colorValueE.attribute("model");
 
            QString modelId;
            const KoColorProfile *profile = nullptr;
            if (model == "Lab") {
                modelId = LABAColorModelID.id();
            } else if (model == "sRGB") {
                modelId = RGBAColorModelID.id();
                profile = colorSpaceRegistry->rgb8()->profile();
            } else if (model == "XYZ") {
                modelId = XYZAColorModelID.id();
            } else if (model == "CMYK") {
                modelId = CMYKAColorModelID.id();
            } else if (model == "GRAY") {
                modelId = GrayAColorModelID.id();
            } else if (model == "RGB") {
                modelId = RGBAColorModelID.id();
            } else {
                warnPigment << "Color space not implemented:" << model
                            << "(line" << colorValueE.lineNumber()
                            << ", column "<< colorValueE.columnNumber()
                            << ")";
                continue;
            }
 
            const KoColorSpace *colorSpace = colorSpaceRegistry->colorSpace(modelId, colorDepthId, profile);
 
            // The 'space' attribute is the name of the icc file
            // sitting in the 'profiles' directory in the zip.
            QString space = colorValueE.attribute("space");
            if (!space.isEmpty()) {
                if (fileColorSpaces.contains(space)) {
                    colorSpace = fileColorSpaces.value(space);
                } else {
                    // Try loading the profile and add it to the registry
                    profile = loadColorProfile(store, space, modelId, colorDepthId);
                    if (profile) {
                        colorSpace = colorSpaceRegistry->colorSpace(modelId, colorDepthId, profile);
                        fileColorSpaces.insert(space, colorSpace);
                    }
                }
            }
 
            KoColor c(colorSpace);
 
            // sRGB,RGB,HSV,HSL,CMY,CMYK,nCLR: 0 -> 1
            // YIQ: Y 0 -> 1 : IQ -0.5 -> 0.5
            // Lab: L 0 -> 100 : ab -128 -> 127
            // XYZ: 0 -> ~100
            QVector<float> channels;
            for (const QString &str : colorValueE.text().split(" ")) {
                float channelValue = str.toFloat(&status);
                if (!status) {
                    warnPigment << "Invalid float definition (line" << colorValueE.lineNumber()
                                << ", column" << colorValueE.columnNumber()
                                << ")";
 
                    channelValue = 0;
                }
 
                channels.append(channelValue);
            }
            channels.append(OPACITY_OPAQUE_F); // Alpha channel
            colorSpace->fromNormalisedChannelsValue(c.data(), channels);
 
            currentEntry.setColor(c);
            firstDefinition = true;
 
            if (model == "Lab") {
                break; // Immediately add this one
            }
        }
 
        if (firstDefinition) {
            materialsBook.insert(currentEntry.id(), currentEntry);
        } else {
            warnPigment << "No supported color  spaces for the current color (line" << colorElement.lineNumber()
                        << ", column "<< colorElement.columnNumber()
                        << ")";
            return false;
        }
    }
 
    store->leaveDirectory(); // Return to root
    // End colors
    // Now decide which ones will go into the palette
 
    KisSwatchGroupSP global = colorSet->getGlobalGroup();
    for(; !swatch.isNull(); swatch = swatch.nextSiblingElement()) {
        QString type = swatch.tagName();
        if (type.isEmpty() || type.isNull()) {
            warnPigment << "Invalid swatch/group definition (no id) (line" << swatch.lineNumber()
                        << ", column" << swatch.columnNumber()
                        << ")";
            return false;
        } else if (type == "swatch") {
            QString id = swatch.attribute("material");
            if (id.isEmpty() || id.isNull()) {
                warnPigment << "Invalid swatch definition (no material id) (line" << swatch.lineNumber()
                            << ", column" << swatch.columnNumber()
                            << ")";
                return false;
            }
 
            if (materialsBook.contains(id)) {
                global->addSwatch(materialsBook.value(id));
            } else {
                warnPigment << "Invalid swatch definition (material not found) (line" << swatch.lineNumber()
                            << ", column" << swatch.columnNumber()
                            << ")";
                return false;
            }
        } else if (type == "group") {
            QDomElement groupMetadata = swatch.firstChildElement("metadata");
            if (groupMetadata.isNull()) {
                warnPigment << "Invalid group definition (missing metadata) (line" << groupMetadata.lineNumber()
                            << ", column" << groupMetadata.columnNumber()
                            << ")";
                return false;
            }
            QDomElement groupTitle = metadata.firstChildElement("dc:title");
            if (groupTitle.isNull()) {
                warnPigment << "Invalid group definition (missing title) (line" << groupTitle.lineNumber()
                            << ", column" << groupTitle.columnNumber()
                            << ")";
                return false;
            }
            QString currentGroupName = groupTitle.text();
            colorSet->addGroup(currentGroupName);
 
            for (QDomElement groupSwatch = swatch.firstChildElement("swatch");
                 !groupSwatch.isNull();
                 groupSwatch = groupSwatch.nextSiblingElement("swatch")) {
                QString id = groupSwatch.attribute("material");
                if (id.isEmpty() || id.isNull()) {
                    warnPigment << "Invalid swatch definition (no material id) (line" << groupSwatch.lineNumber()
                                << ", column" << groupSwatch.columnNumber()
                                << ")";
                    return false;
                }
 
                if (materialsBook.contains(id)) {
                    colorSet->getGroup(currentGroupName)->addSwatch(materialsBook.value(id));
                } else {
                    warnPigment << "Invalid swatch definition (material not found) (line" << groupSwatch.lineNumber()
                                << ", column" << groupSwatch.columnNumber()
                                << ")";
                    return false;
                }
            }
        }
    }
    // End palette
 
    return true;
}

References CMYKAColorModelID, KoColorSpaceRegistry::colorSpace(), KoColor::data(), dbgPigment, Float32BitsColorDepthID, KoColorSpace::fromNormalisedChannelsValue(), GrayAColorModelID, KoID::id(), KisSwatch::id(), KoColorSpaceRegistry::instance(), LABAColorModelID, KoResource::metadata, OPACITY_OPAQUE_F, KoColorSpace::profile(), KoColorSpaceRegistry::rgb8(), RGBAColorModelID, KisSwatch::setColor(), KisSwatch::setId(), KisSwatch::setName(), KisSwatch::setSpotColor(), warnPigment, and XYZAColorModelID.

◆ loadScribusXmlPalette()

bool KoColorSet::Private::loadScribusXmlPalette	(	KoColorSet *	set,
		QXmlStreamReader *	xml )

private

Definition at line 1187 of file KoColorSet.cpp.

{
 
    //1. Get name
    QXmlStreamAttributes paletteProperties = xml->attributes();
    auto paletteName = paletteProperties.value("Name");
    dbgPigment << "Processed name of palette:" << paletteName;
    set->setName(paletteName.toString());
 
    //2. Inside the SCRIBUSCOLORS, there are lots of colors. Retrieve them
 
    while(xml->readNextStartElement()) {
        auto currentElement = xml->name();
        if (currentElement.compare(QString("COLOR"), Qt::CaseInsensitive) == 0) {
            scribusParseColor(set, xml);
        }
        else {
            xml->skipCurrentElement();
        }
    }
 
    if(xml->hasError()) {
        return false;
    }
 
    return true;
}

References dbgPigment, and KoResource::setName().

◆ loadXml()

bool KoColorSet::Private::loadXml ( )

Definition at line 2419 of file KoColorSet.cpp.

                                {
    bool res = false;
 
    QXmlStreamReader *xml = new QXmlStreamReader(data);
 
    if (xml->readNextStartElement()) {
        auto paletteId = xml->name();
        if (paletteId.compare(QString("SCRIBUSCOLORS"), Qt::CaseInsensitive) == 0) { // Scribus
            dbgPigment << "XML palette: " << colorSet->filename() << ", Scribus format";
            res = loadScribusXmlPalette(colorSet, xml);
        }
        else {
            // Unknown XML format
            xml->raiseError("Unknown XML palette format. Expected SCRIBUSCOLORS, found " + paletteId);
        }
    }
 
    // If there is any error (it should be returned through the stream)
    if (xml->hasError() || !res) {
        warnPigment << "Illegal XML palette:" << colorSet->filename();
        warnPigment << "Error (line"<< xml->lineNumber() << ", column" << xml->columnNumber() << "):" << xml->errorString();
        return false;
    }
    else {
        dbgPigment << "XML palette parsed successfully:" << colorSet->filename();
        return true;
    }
}

References dbgPigment, and warnPigment.

◆ readByte()

quint8 KoColorSet::Private::readByte ( QIODevice * io )

private

Definition at line 1215 of file KoColorSet.cpp.

{
    quint8 val;
    quint64 read = io->read((char*)&val, 1);
    if (read != 1) return false;
    return val;
}

◆ readFloat()

float KoColorSet::Private::readFloat ( QIODevice * io )

private

Definition at line 1238 of file KoColorSet.cpp.

{
    float val;
    quint64 read = io->read((char*)&val, 4);
    if (read != 4) return false;
    return qFromBigEndian(val);
}

◆ readInt()

qint32 KoColorSet::Private::readInt ( QIODevice * io )

private

Definition at line 1230 of file KoColorSet.cpp.

{
    qint32 val;
    quint64 read = io->read((char*)&val, 4);
    if (read != 4) return false;
    return qFromBigEndian(val);
}

◆ readShort()

quint16 KoColorSet::Private::readShort ( QIODevice * io )

private

Definition at line 1223 of file KoColorSet.cpp.

                                                  {
    quint16 val;
    quint64 read = io->read((char*)&val, 2);
    if (read != 2) return false;
    return qFromBigEndian(val);
}

◆ readUnicodeString()

QString KoColorSet::Private::readUnicodeString	(	QIODevice *	io,
		bool	sizeIsInt = false )

private

Definition at line 1246 of file KoColorSet.cpp.

{
    QString unicode;
    qint32 size = 0;
    if (sizeIsInt) {
        size = readInt(io);
    } else {
        size = readShort(io)-1;
    }
    if (size>0) {
        QByteArray ba = io->read(size*2);
        if (ba.size() == int(size)*2) {
            QTextCodec *Utf16Codec = QTextCodec::codecForName("UTF-16BE");
            unicode = Utf16Codec->toUnicode(ba);
        } else {
            warnPigment << "Unicode name block is the wrong size" << colorSet->filename();
        }
    }
    if (!sizeIsInt) {
        readShort(io); // when the size is quint16, the string is 00 terminated;
    }
    return unicode.trimmed();
}

References warnPigment.

◆ saveGpl()

bool KoColorSet::Private::saveGpl ( QIODevice * dev ) const

Definition at line 1352 of file KoColorSet.cpp.

{
    Q_ASSERT(dev->isOpen());
    Q_ASSERT(dev->isWritable());
 
    QTextStream stream(dev);
    KisPortingUtils::setUtf8OnStream(stream);
    stream << "GIMP Palette\nName: " << colorSet->name() << "\nColumns: " << colorSet->columnCount() << "\n#\n";
 
    KisSwatchGroupSP global = colorSet->getGlobalGroup();
    for (int y = 0; y < global->rowCount(); y++) {
        for (int x = 0; x < colorSet->columnCount(); x++) {
            if (!global->checkSwatchExists(x, y)) {
                continue;
            }
            const KisSwatch& entry = global->getSwatch(x, y);
            QColor c = entry.color().toQColor();
            stream << c.red() << " " << c.green() << " " << c.blue() << "\t";
            if (entry.name().isEmpty())
                stream << "Untitled\n";
            else
                stream << entry.name() << "\n";
        }
    }
 
    return true;
}

References KisSwatch::color(), KisSwatch::name(), KisPortingUtils::setUtf8OnStream(), and KoColor::toQColor().

◆ saveKpl()

bool KoColorSet::Private::saveKpl ( QIODevice * dev ) const

Definition at line 2448 of file KoColorSet.cpp.

{
    QScopedPointer<KoStore> store(KoStore::createStore(dev, KoStore::Write, "application/x-krita-palette", KoStore::Zip));
    if (!store || store->bad()) {
        qWarning() << "saveKpl could not create store";
        return false;
    }
 
    QSet<const KoColorSpace *> colorSpaces;
 
    {
        QDomDocument doc;
        QDomElement root = doc.createElement(KPL_PALETTE_TAG);
        root.setAttribute(KPL_VERSION_ATTR, "2.0");
        root.setAttribute(KPL_PALETTE_NAME_ATTR, colorSet->name());
        root.setAttribute(KPL_PALETTE_COMMENT_ATTR, comment);
        root.setAttribute(KPL_PALETTE_COLUMN_COUNT_ATTR, colorSet->columnCount());
        root.setAttribute(KPL_GROUP_ROW_COUNT_ATTR, colorSet->getGlobalGroup()->rowCount());
 
        saveKplGroup(doc, root, colorSet->getGroup(KoColorSet::GLOBAL_GROUP_NAME), colorSpaces);
 
        for (const KisSwatchGroupSP &group : swatchGroups) {
            if (group->name() == KoColorSet::GLOBAL_GROUP_NAME) { continue; }
            QDomElement gl = doc.createElement(KPL_GROUP_TAG);
            gl.setAttribute(KPL_GROUP_NAME_ATTR, group->name());
            root.appendChild(gl);
            saveKplGroup(doc, gl, group, colorSpaces);
        }
 
        doc.appendChild(root);
        if (!store->open("colorset.xml")) { return false; }
        QByteArray ba = doc.toByteArray();
        if (store->write(ba) != ba.size()) { return false; }
        if (!store->close()) { return false; }
    }
 
    QDomDocument doc;
    QDomElement profileElement = doc.createElement("Profiles");
 
    for (const KoColorSpace *colorSpace : colorSpaces) {
        QString fn = QFileInfo(colorSpace->profile()->fileName()).fileName();
        if (!store->open(fn)) { qWarning() << "Could not open the store for profiles directory"; return false; }
        QByteArray profileRawData = colorSpace->profile()->rawData();
        if (!store->write(profileRawData)) { qWarning() << "Could not write the profiles data into the store"; return false; }
        if (!store->close()) { qWarning() << "Could not close the store for profiles directory"; return false; }
        QDomElement el = doc.createElement(KPL_PALETTE_PROFILE_TAG);
        el.setAttribute(KPL_PALETTE_FILENAME_ATTR, fn);
        el.setAttribute(KPL_PALETTE_NAME_ATTR, colorSpace->profile()->name());
        el.setAttribute(KPL_COLOR_MODEL_ID_ATTR, colorSpace->colorModelId().id());
        el.setAttribute(KPL_COLOR_DEPTH_ID_ATTR, colorSpace->colorDepthId().id());
        profileElement.appendChild(el);
 
    }
    doc.appendChild(profileElement);
 
    if (!store->open("profiles.xml")) { qWarning() << "Could not open profiles.xml"; return false; }
    QByteArray ba = doc.toByteArray();
 
    int bytesWritten = store->write(ba);
    if (bytesWritten != ba.size()) { qWarning() << "Bytes written is wrong" << ba.size(); return false; }
 
    if (!store->close()) { qWarning() << "Could not close the store"; return false; }
 
    bool r = store->finalize();
    if (!r) { qWarning() << "Could not finalize the store"; }
    return r;
}

◆ saveKplGroup()

void KoColorSet::Private::saveKplGroup	(	QDomDocument &	doc,
		QDomElement &	groupEle,
		const KisSwatchGroupSP	group,
		QSet< const KoColorSpace * > &	colorSetSet ) const

private

Definition at line 2516 of file KoColorSet.cpp.

{
    groupEle.setAttribute(KPL_GROUP_ROW_COUNT_ATTR, QString::number(group->rowCount()));
 
    for (const KisSwatchGroup::SwatchInfo &info : group->infoList()) {
        const KoColorProfile *profile = info.swatch.color().colorSpace()->profile();
        // Only save non-builtin profiles.=
        if (!profile->fileName().isEmpty()) {
            bool alreadyIncluded = false;
            Q_FOREACH(const KoColorSpace* colorSpace, colorSetSet) {
                if (colorSpace->profile()->fileName() == profile->fileName()) {
                    alreadyIncluded = true;
                    break;
                }
            }
            if(!alreadyIncluded) {
                colorSetSet.insert(info.swatch.color().colorSpace());
            }
        }
        QDomElement swatchEle = doc.createElement(KPL_SWATCH_TAG);
        swatchEle.setAttribute(KPL_SWATCH_NAME_ATTR, info.swatch.name());
        swatchEle.setAttribute(KPL_SWATCH_ID_ATTR, info.swatch.id());
        swatchEle.setAttribute(KPL_SWATCH_SPOT_ATTR, info.swatch.spotColor() ? "true" : "false");
        swatchEle.setAttribute(KPL_SWATCH_BITDEPTH_ATTR, info.swatch.color().colorSpace()->colorDepthId().id());
        info.swatch.color().toXML(doc, swatchEle);
 
        QDomElement positionEle = doc.createElement(KPL_SWATCH_POS_TAG);
        positionEle.setAttribute(KPL_SWATCH_ROW_ATTR, info.row);
        positionEle.setAttribute(KPL_SWATCH_COL_ATTR, info.column);
        swatchEle.appendChild(positionEle);
 
        groupEle.appendChild(swatchEle);
    }
}

References KoColorProfile::fileName, KoColorSet::KPL_GROUP_ROW_COUNT_ATTR, KoColorSet::KPL_SWATCH_BITDEPTH_ATTR, KoColorSet::KPL_SWATCH_COL_ATTR, KoColorSet::KPL_SWATCH_ID_ATTR, KoColorSet::KPL_SWATCH_NAME_ATTR, KoColorSet::KPL_SWATCH_POS_TAG, KoColorSet::KPL_SWATCH_ROW_ATTR, KoColorSet::KPL_SWATCH_SPOT_ATTR, KoColorSet::KPL_SWATCH_TAG, and KoColorSpace::profile().

◆ scribusParseColor()

void KoColorSet::Private::scribusParseColor	(	KoColorSet *	set,
		QXmlStreamReader *	xml )

private

Definition at line 1094 of file KoColorSet.cpp.

{
    KisSwatch colorEntry;
    // It's a color, retrieve it
    QXmlStreamAttributes colorProperties = xml->attributes();
    auto colorName = colorProperties.value("NAME");
    colorEntry.setName(colorName.isEmpty() || colorName.isNull() ? i18n("Untitled") : colorName.toString());
 
    // RGB or CMYK?
    if (colorProperties.hasAttribute("RGB")) {
        dbgPigment << "Color " << colorProperties.value("NAME") << ", RGB " << colorProperties.value("RGB");
 
        KoColor currentColor(KoColorSpaceRegistry::instance()->rgb8());
        auto colorValue = colorProperties.value("RGB");
 
        if (colorValue.length() != 7 && colorValue.at(0) != '#') { // Color is a hexadecimal number
            xml->raiseError("Invalid rgb8 color (malformed): " + colorValue);
            return;
        } else {
            bool rgbOk;
            quint32 rgb = colorValue.mid(1).toUInt(&rgbOk, 16);
            if  (!rgbOk) {
                xml->raiseError("Invalid rgb8 color (unable to convert): " + colorValue);
                return;
            }
 
            quint8 r = rgb >> 16 & 0xff;
            quint8 g = rgb >> 8 & 0xff;
            quint8 b = rgb & 0xff;
 
            dbgPigment << "Color parsed: "<< r << g << b;
 
            currentColor.data()[0] = r;
            currentColor.data()[1] = g;
            currentColor.data()[2] = b;
            currentColor.setOpacity(OPACITY_OPAQUE_U8);
            colorEntry.setColor(currentColor);
 
            set->addSwatch(colorEntry);
 
            while(xml->readNextStartElement()) {
                //ignore - these are all unknown or the /> element tag
                xml->skipCurrentElement();
            }
            return;
        }
    }
    else if (colorProperties.hasAttribute("CMYK")) {
        dbgPigment << "Color " << colorProperties.value("NAME") << ", CMYK " << colorProperties.value("CMYK");
 
        KoColor currentColor(KoColorSpaceRegistry::instance()->colorSpace(CMYKAColorModelID.id(), Integer8BitsColorDepthID.id(), QString()));
        auto colorValue = colorProperties.value("CMYK");
 
        if (colorValue.length() != 9 && colorValue.at(0) != '#') { // Color is a hexadecimal number
            xml->raiseError("Invalid cmyk color (malformed): " % colorValue);
            return;
        }
        else {
            bool cmykOk;
            quint32 cmyk = colorValue.mid(1).toUInt(&cmykOk, 16); // cmyk uses the full 32 bits
            if  (!cmykOk) {
                xml->raiseError("Invalid cmyk color (unable to convert): " % colorValue);
                return;
            }
 
            quint8 c = cmyk >> 24 & 0xff;
            quint8 m = cmyk >> 16 & 0xff;
            quint8 y = cmyk >> 8 & 0xff;
            quint8 k = cmyk & 0xff;
 
            dbgPigment << "Color parsed: "<< c << m << y << k;
 
            currentColor.data()[0] = c;
            currentColor.data()[1] = m;
            currentColor.data()[2] = y;
            currentColor.data()[3] = k;
            currentColor.setOpacity(OPACITY_OPAQUE_U8);
            colorEntry.setColor(currentColor);
 
            set->addSwatch(colorEntry);
 
            while(xml->readNextStartElement()) {
                //ignore - these are all unknown or the /> element tag
                xml->skipCurrentElement();
            }
            return;
        }
    }
    else {
        xml->raiseError("Unknown color space for color " + colorEntry.name());
    }
}

References KoColorSet::addSwatch(), CMYKAColorModelID, KoColor::data(), dbgPigment, KoID::id(), KoColorSpaceRegistry::instance(), Integer8BitsColorDepthID, KisSwatch::name(), OPACITY_OPAQUE_U8, KisSwatch::setColor(), KisSwatch::setName(), and KoColor::setOpacity().

Friends And Related Symbol Documentation

◆ AddGroupCommand

friend struct AddGroupCommand

friend

Definition at line 73 of file KoColorSet_p.h.

◆ AddSwatchCommand

friend struct AddSwatchCommand

friend

Definition at line 70 of file KoColorSet_p.h.

◆ ChangeGroupNameCommand

friend struct ChangeGroupNameCommand

friend

Definition at line 72 of file KoColorSet_p.h.

◆ ClearCommand

friend struct ClearCommand

friend

Definition at line 75 of file KoColorSet_p.h.

◆ MoveGroupCommand

friend struct MoveGroupCommand

friend

Definition at line 79 of file KoColorSet_p.h.

◆ RemoveGroupCommand

friend struct RemoveGroupCommand

friend

Definition at line 74 of file KoColorSet_p.h.

◆ RemoveSwatchCommand

friend struct RemoveSwatchCommand

friend

Definition at line 71 of file KoColorSet_p.h.

◆ SetColumnCountCommand

friend struct SetColumnCountCommand

friend

Definition at line 76 of file KoColorSet_p.h.

◆ SetCommentCommand

friend struct SetCommentCommand

friend

Definition at line 77 of file KoColorSet_p.h.

◆ SetPaletteTypeCommand

friend struct SetPaletteTypeCommand

friend

Definition at line 78 of file KoColorSet_p.h.

Member Data Documentation

◆ colorSet

KoColorSet* KoColorSet::Private::colorSet {0}

Definition at line 59 of file KoColorSet_p.h.

59{0};

◆ columns

int KoColorSet::Private::columns

Definition at line 66 of file KoColorSet_p.h.

◆ comment

QString KoColorSet::Private::comment

Definition at line 62 of file KoColorSet_p.h.

◆ data

QByteArray KoColorSet::Private::data

Definition at line 61 of file KoColorSet_p.h.

◆ isLocked

bool KoColorSet::Private::isLocked {false}

Definition at line 65 of file KoColorSet_p.h.

65{false};

◆ paletteType

KoColorSet::PaletteType KoColorSet::Private::paletteType {UNKNOWN}

Definition at line 60 of file KoColorSet_p.h.

60{UNKNOWN};

◆ swatchGroups

QList<KisSwatchGroupSP> KoColorSet::Private::swatchGroups

Definition at line 63 of file KoColorSet_p.h.

◆ undoStack

KUndo2Stack KoColorSet::Private::undoStack

Definition at line 64 of file KoColorSet_p.h.

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

libs/pigment/resources/KoColorSet_p.h
libs/pigment/resources/KoColorSet.cpp

Public Member Functions

Public Attributes

Private Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ Private()

Member Function Documentation

◆ detectFormat()

◆ global()

◆ init()

◆ loadAcb()

◆ loadAco()

◆ loadAct()

◆ loadAse()

◆ loadColorProfile()

◆ loadCss()

◆ loadGpl()

◆ loadKpl()

◆ loadKplColorset()

◆ loadKplGroup()

◆ loadKplProfiles()

◆ loadPsp()

◆ loadRiff()

◆ loadSbz()

◆ loadSbzSwatchbook()

◆ loadScribusXmlPalette()

◆ loadXml()

◆ readByte()

◆ readFloat()

◆ readInt()

◆ readShort()

◆ readUnicodeString()

◆ saveGpl()

◆ saveKpl()

◆ saveKplGroup()

◆ scribusParseColor()

Friends And Related Symbol Documentation

◆ AddGroupCommand

◆ AddSwatchCommand

◆ ChangeGroupNameCommand

◆ ClearCommand

◆ MoveGroupCommand

◆ RemoveGroupCommand

◆ RemoveSwatchCommand

◆ SetColumnCountCommand

◆ SetCommentCommand

◆ SetPaletteTypeCommand

Member Data Documentation

◆ colorSet

◆ columns

◆ comment

◆ data

◆ isLocked

◆ paletteType

◆ swatchGroups

◆ undoStack