KXmlGuiVersionHandler Class Reference

#include <kxmlguiversionhandler_p.h>

Public Member Functions
QString	finalDocument () const
QString	finalFile () const
	KXmlGuiVersionHandler (const QStringList &files)

Static Public Member Functions
static QString	findVersionNumber (const QString &xml)

Private Attributes
QString	m_doc
QString	m_file

Detailed Description

Definition at line 25 of file kxmlguiversionhandler_p.h.

Constructor & Destructor Documentation

KXmlGuiVersionHandler()

KXmlGuiVersionHandler::KXmlGuiVersionHandler

(

const QStringList &

files

)

Definition at line 247 of file kxmlguiversionhandler.cpp.

{
    Q_ASSERT(!files.isEmpty());
 
    if (files.count() == 1) {
        // No need to parse version numbers if there's only one file anyway
        m_file = files.first();
        m_doc = KisKXMLGUIFactory::readConfigFile(m_file);
        return;
    }
 
    QList<DocStruct> allDocuments;
 
    Q_FOREACH (const QString &file, files) {
        DocStruct d;
        d.file = file;
        d.data = KisKXMLGUIFactory::readConfigFile(file);
        allDocuments.append(d);
    }
 
    QList<DocStruct>::iterator best = allDocuments.end();
    uint bestVersion = 0;
 
    QList<DocStruct>::iterator docIt = allDocuments.begin();
    const QList<DocStruct>::iterator docEnd = allDocuments.end();
    for (; docIt != docEnd; ++docIt) {
        const QString versionStr = findVersionNumber((*docIt).data);
        if (versionStr.isEmpty()) {
            //qDebug(260) << "found no version in" << (*docIt).file;
            continue;
        }
 
        bool ok = false;
        uint version = versionStr.toUInt(&ok);
        if (!ok) {
            continue;
        }
        //qDebug(260) << "found version" << version << "for" << (*docIt).file;
 
        if (version > bestVersion) {
            best = docIt;
            //qDebug(260) << "best version is now " << version;
            bestVersion = version;
        }
    }
 
    if (best != docEnd) {
        if (best != allDocuments.begin()) {
            QList<DocStruct>::iterator local = allDocuments.begin();
 
            if ((*local).file.startsWith(QStandardPaths::writableLocation(QStandardPaths::AppDataLocation))) {
                // load the local document and extract the action properties
                QDomDocument localDocument;
                localDocument.setContent((*local).data);
 
                const ActionPropertiesMap properties = extractActionProperties(localDocument);
                const QList<QDomElement> toolbars = extractToolBars(localDocument);
 
                // in case the document has a ActionProperties section
                // we must not delete it but copy over the global doc
                // to the local and insert the ActionProperties section
 
                // TODO: kedittoolbar should mark toolbars as modified so that
                // we don't keep old toolbars just because the user defined a shortcut
 
                if (!properties.isEmpty() || !toolbars.isEmpty()) {
                    // now load the global one with the higher version number
                    // into memory
                    QDomDocument document;
                    document.setContent((*best).data);
                    // and store the properties in there
                    storeActionProperties(document, properties);
                    if (!toolbars.isEmpty()) {
                        // remove application toolbars present in the user file
                        // (not others, that the app might have added since)
                        removeToolBars(document, toolBarNames(toolbars));
 
                        // add user toolbars
                        insertToolBars(document, toolbars);
                    }
 
                    (*local).data = document.toString();
                    // make sure we pick up the new local doc, when we return later
                    best = local;
 
                    // write out the new version of the local document
                    QFile f((*local).file);
                    if (f.open(QIODevice::WriteOnly)) {
                        const QByteArray utf8data = (*local).data.toUtf8();
                        f.write(utf8data.constData(), utf8data.length());
                        f.close();
                    }
                } else {
                    // Move away the outdated local file, to speed things up next time
                    const QString f = (*local).file;
                    const QString backup = f + QStringLiteral(".backup");
                    QFile::rename(f, backup);
                }
            }
        }
        m_doc = (*best).data;
        m_file = (*best).file;
    } else {
        //qDebug(260) << "returning first one...";
        m_doc = allDocuments.first().data;
        m_file = allDocuments.first().file;
    }
}

References extractActionProperties(), extractToolBars(), findVersionNumber(), insertToolBars(), m_doc, m_file, KisKXMLGUIFactory::readConfigFile(), removeToolBars(), storeActionProperties(), and toolBarNames().

Member Function Documentation

finalDocument()

QString KXmlGuiVersionHandler::finalDocument ( ) const

inline

Definition at line 34 of file kxmlguiversionhandler_p.h.

    {
        return m_doc;
    }

References m_doc.

finalFile()

QString KXmlGuiVersionHandler::finalFile ( ) const

inline

Definition at line 30 of file kxmlguiversionhandler_p.h.

    {
        return m_file;
    }

References m_file.

findVersionNumber()

QString KXmlGuiVersionHandler::findVersionNumber ( const QString & xml )

static

Definition at line 173 of file kxmlguiversionhandler.cpp.

{
    enum { ST_START, ST_AFTER_OPEN, ST_AFTER_GUI,
           ST_EXPECT_VERSION, ST_VERSION_NUM
         } state = ST_START;
    const int length = xml.length();
    for (int pos = 0; pos < length; pos++) {
        switch (state) {
        case ST_START:
            if (xml[pos] == QLatin1Char('<')) {
                state = ST_AFTER_OPEN;
            }
            break;
        case ST_AFTER_OPEN: {
            //Jump to gui..
            const int guipos = xml.indexOf(QStringLiteral("gui"), pos, Qt::CaseInsensitive);
            if (guipos == -1) {
                return QString();    //Reject
            }
 
            pos = guipos + 2; //Position at i, so we're moved ahead to the next character by the ++;
            state = ST_AFTER_GUI;
            break;
        }
        case ST_AFTER_GUI:
            state = ST_EXPECT_VERSION;
            break;
        case ST_EXPECT_VERSION: {
            const int verpos = xml.indexOf(QStringLiteral("version"), pos, Qt::CaseInsensitive);
            if (verpos == -1) {
                return QString();    //Reject
            }
            pos = verpos + 7; // strlen("version") is 7
            while (xml.at(pos).isSpace()) {
                ++pos;
            }
            if (xml.at(pos++) != QLatin1Char('=')) {
                return QString();    //Reject
            }
            while (xml.at(pos).isSpace()) {
                ++pos;
            }
 
            state = ST_VERSION_NUM;
            break;
        }
        case ST_VERSION_NUM: {
            int endpos;
            for (endpos = pos; endpos < length; endpos++) {
                const ushort ch = xml[endpos].unicode();
                if (ch >= QLatin1Char('0') && ch <= QLatin1Char('9')) {
                    continue;    //Number..
                }
                if (ch == QLatin1Char('"')) { //End of parameter
                    break;
                } else { //This shouldn't be here..
                    endpos = length;
                }
            }
 
            if (endpos != pos && endpos < length) {
                const QString matchCandidate = xml.mid(pos, endpos - pos); //Don't include " ".
                return matchCandidate;
            }
 
            state = ST_EXPECT_VERSION; //Try to match a well-formed version..
            break;
        } //case..
        } //switch
    } //for
 
    return QString();
}

References length().

Member Data Documentation

m_doc

QString KXmlGuiVersionHandler::m_doc

private

Definition at line 43 of file kxmlguiversionhandler_p.h.

m_file

QString KXmlGuiVersionHandler::m_file

private

Definition at line 42 of file kxmlguiversionhandler_p.h.

---

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

• libs/widgetutils/xmlgui/kxmlguiversionhandler_p.h
• libs/widgetutils/xmlgui/kxmlguiversionhandler.cpp