KisNodeQueryPath Class Reference

#include <kis_node_query_path.h>

Inheritance diagram for KisNodeQueryPath:

Public Member Functions
bool	isRelative () const
	KisNodeQueryPath (const KisNodeQueryPath &)
KisNodeQueryPath &	operator= (const KisNodeQueryPath &)
void	queryLevel (int _level, KisNodeSP _node, QList< KisNodeSP > &_result)
QList< KisNodeSP >	queryNodes (KisImageWSP image, KisNodeSP currentNode) const
KisNodeSP	queryUniqueNode (KisImageWSP image, KisNodeSP currentNode=0) const
void	simplifyPath ()
	This function will remove unneeded call to parent, for instance, "1/../3/../5" => "5".
QString	toString () const
	~KisNodeQueryPath ()
Public Member Functions inherited from Private
	Private (KisCanvas2 *c)

Static Public Member Functions
static KisNodeQueryPath	absolutePath (KisNodeSP node)
static KisNodeQueryPath	fromString (const QString &path)

Public Attributes
QList< PathElement >	elements
bool	relative
Public Attributes inherited from Private
KisCanvas2 *	canvas
int	displayedFrame
int	intendedFrame

Private Member Functions
	KisNodeQueryPath ()

Private Attributes
Private *const	d

Detailed Description

This class represent a path to access a node starting from another node.

Definition at line 28 of file kis_node_query_path.cc.

Constructor & Destructor Documentation

KisNodeQueryPath() [1/2]

KisNodeQueryPath::KisNodeQueryPath ( )

private

Definition at line 92 of file kis_node_query_path.cc.

                                   : d(new Private)
{
}

~KisNodeQueryPath()

KisNodeQueryPath::~KisNodeQueryPath

(

)

Definition at line 96 of file kis_node_query_path.cc.

{
    delete d;
}

References d.

KisNodeQueryPath() [2/2]

KisNodeQueryPath::KisNodeQueryPath

(

const KisNodeQueryPath &

nqp

)

Definition at line 101 of file kis_node_query_path.cc.

                                                              : d(new Private(*nqp.d))
{
}

Member Function Documentation

absolutePath()

KisNodeQueryPath KisNodeQueryPath::absolutePath ( KisNodeSP node )

static

Definition at line 198 of file kis_node_query_path.cc.

{
    KisNodeQueryPath path;
    path.d->relative = false;
    KisNodeSP parent = 0;
    while ((parent = node->parent())) {
        int index = parent->index(node);
        if (index >= 0) {
            path.d->elements.push_front(index);
        }
        node = parent;
    }
    return path;
}

References d, and KisNode::parent.

fromString()

KisNodeQueryPath KisNodeQueryPath::fromString ( const QString & path )

static

Parameters

path
err	if non null, it will be filled with an error message

See also

toString for an explanation of the string format

Definition at line 169 of file kis_node_query_path.cc.

{
    KisNodeQueryPath path;
    if (_path.size() == 0 || _path == ".") {
        path.d->relative = true;
        return path;
    }
    if (_path == "/") {
        path.d->relative = false;
        return path;
    }
    path.d->relative = !(_path.at(0) == '/');
    QStringList indexes = _path.split('/');
    if (!path.d->relative) {
        indexes.pop_front(); // In case of an absolute path "/1/2", the list is "", "1", "2" which is not good
    }
    Q_FOREACH (const QString& index, indexes) {
        if (index == "*") {
            path.d->elements.push_back(PathElement::Wildcard);
        } else if (index == "..") {
            path.d->elements.push_back(PathElement::Parent);
        } else {
            path.d->elements.push_back(index.toInt());
        }
    }
    path.d->simplifyPath();
    return path;
}

References d, PathElement::Parent, and PathElement::Wildcard.

isRelative()

bool KisNodeQueryPath::isRelative

(

)

const

Definition at line 111 of file kis_node_query_path.cc.

{
    return d->relative;
}

References d.

operator=()

KisNodeQueryPath & KisNodeQueryPath::operator=

(

const KisNodeQueryPath &

nqp

)

Definition at line 105 of file kis_node_query_path.cc.

{
    *d = *nqp.d;
    return *this;
}

References d.

queryLevel()

void KisNodeQueryPath::queryLevel ( int _level, KisNodeSP _node, QList< KisNodeSP > & _result )

inline

Definition at line 57 of file kis_node_query_path.cc.

                                                                            {
        if (_level >= elements.size()) {
            _result.push_back(_node);
        } else {
            PathElement pe = elements[_level];
 
            switch (pe.type) {
            case PathElement::Wildcard: {
                for (KisNodeSP child = _node->firstChild();
                        child != 0; child = child->nextSibling()) {
                    queryLevel(_level + 1, child, _result);
                }
            }
            break;
            case PathElement::Parent: {
                if (_node->parent()) {
                    queryLevel(_level + 1, _node->parent(), _result);
                } else {
                    dbgKrita << "No parent";
                }
                break;
            }
            case PathElement::Index: {
                if (pe.index < _node->childCount()) {
                    queryLevel(_level + 1, _node->at(pe.index), _result);
                } else {
                    dbgKrita << "No parent";
                }
                break;
            }
            }
        }
    }

References KisNode::at(), KisNode::childCount(), dbgKrita, KisNode::firstChild(), PathElement::Index, PathElement::index, KisNode::parent, PathElement::Parent, PathElement::type, and PathElement::Wildcard.

queryNodes()

QList< KisNodeSP > KisNodeQueryPath::queryNodes	(	KisImageWSP	image,
		KisNodeSP	currentNode ) const

Definition at line 117 of file kis_node_query_path.cc.

{
    KisNodeSP _node;
    if (d->relative) {
        _node = currentNode;
    } else {
        _node = image->root();
    }
 
    QList<KisNodeSP> result;
 
    d->queryLevel(0, _node, result);
 
    return result;
}

References d, and KisNodeFacade::root.

queryUniqueNode()

KisNodeSP KisNodeQueryPath::queryUniqueNode	(	KisImageWSP	image,
		KisNodeSP	currentNode = 0 ) const

Definition at line 133 of file kis_node_query_path.cc.

{
    QList<KisNodeSP> result = queryNodes(image, currentNode);
    KIS_ASSERT_RECOVER_NOOP(result.size() <= 1);
 
    return !result.isEmpty() ? result.first() : 0;
}

References KIS_ASSERT_RECOVER_NOOP, and queryNodes().

simplifyPath()

void KisNodeQueryPath::simplifyPath ( )

inline

This function will remove unneeded call to parent, for instance, "1/../3/../5" => "5".

Definition at line 32 of file kis_node_query_path.cc.

                        {
        // No elements then return
        if (elements.isEmpty()) return;
        QList<PathElement> newelements;
        int i = 0;
        for (; i < elements.count() && elements[i].type == PathElement::Parent; ++i) {
            newelements.push_back(PathElement::Parent);
        }
        // Loop over the element of the list
        for (; i < elements.count(); ++i) {
            PathElement pe = elements[i];
            // If it's the last element, or the next element isn't a parent
            if (pe.type != PathElement::Parent) {
                newelements.push_back(pe);
            } else {
                if (newelements.isEmpty() || newelements.last().type == PathElement::Parent) {
                    newelements.push_back(PathElement::Parent);
                } else {
                    newelements.removeLast();
                }
            }
        }
        // Set the new list
        elements = newelements;
    }

References PathElement::Parent, and PathElement::type.

toString()

QString KisNodeQueryPath::toString

(

)

const

This function return a string representing this path. Which is a list separated by '\' of:

• '*': represents all layers
• '..': represents the parent layer
• number: index of the layer
• '.': represents the current layer

For instance: "1/*" return all children of the first layer, "../3" return the third layer of the parent of the current layer If the string starts with "/" then it's an absolute path, otherwise it's a relative path.

Definition at line 141 of file kis_node_query_path.cc.

{
    QString str;
    if (!d->relative) {
        str = '/';
    } else if (d->elements.count() == 0) {
        return QString('.');
    }
    for (int i = 0; i < d->elements.count(); ++i) {
        PathElement pe = d->elements[i];
        switch (pe.type) {
        case PathElement::Wildcard:
            str += '*';
            break;
        case PathElement::Parent:
            str += "..";
            break;
        case PathElement::Index:
            str += QString::number(pe.index);
            break;
        }
        if (i != d->elements.count() - 1) {
            str += '/';
        }
    }
    return str;
}

References d, PathElement::Index, PathElement::index, PathElement::Parent, PathElement::type, and PathElement::Wildcard.

Member Data Documentation

d

Private* const KisNodeQueryPath::d

private

Definition at line 46 of file kis_node_query_path.h.

elements

QList<PathElement> KisNodeQueryPath::elements

Definition at line 29 of file kis_node_query_path.cc.

relative

bool KisNodeQueryPath::relative

Definition at line 30 of file kis_node_query_path.cc.

---

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

• libs/image/kis_node_query_path.cc
• libs/image/kis_node_query_path.h