mirror of
https://bitbucket.org/smil3y/kde-extraapps.git
synced 2025-02-24 19:02:53 +00:00
124 lines
3.8 KiB
C++
124 lines
3.8 KiB
C++
/*
|
|
* This file is part of the syndication library
|
|
*
|
|
* Copyright (C) 2006 Frank Osterfeld <osterfeld@kde.org>
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Library General Public
|
|
* License as published by the Free Software Foundation; either
|
|
* version 2 of the License, or (at your option) any later version.
|
|
*
|
|
* This library is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* Library General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Library General Public License
|
|
* along with this library; see the file COPYING.LIB. If not, write to
|
|
* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
|
|
* Boston, MA 02110-1301, USA.
|
|
*
|
|
*/
|
|
#ifndef SYNDICATION_RDF_NODEVISITOR_H
|
|
#define SYNDICATION_RDF_NODEVISITOR_H
|
|
|
|
#include <syndication/ksyndication_export.h>
|
|
|
|
namespace boost {
|
|
template <class T> class shared_ptr;
|
|
}
|
|
|
|
namespace Syndication {
|
|
|
|
namespace RDF {
|
|
|
|
//@cond PRIVATE
|
|
class Literal;
|
|
typedef boost::shared_ptr<Literal> LiteralPtr;
|
|
class Node;
|
|
typedef boost::shared_ptr<Node> NodePtr;
|
|
class Property;
|
|
typedef boost::shared_ptr<Property> PropertyPtr;
|
|
class Resource;
|
|
typedef boost::shared_ptr<Resource> ResourcePtr;
|
|
class Sequence;
|
|
typedef boost::shared_ptr<Sequence> SequencePtr;
|
|
//@endcond
|
|
|
|
/**
|
|
* Visitor interface, following the Visitor design pattern. Use this if you
|
|
* want to process nodes and the way how to handle the nodes depends
|
|
* on it's concrete type (e.g. Resource or Literal).
|
|
*
|
|
* TODO: insert code example
|
|
*
|
|
* @author Frank Osterfeld
|
|
*/
|
|
class SYNDICATION_EXPORT NodeVisitor //krazy:exclude=dpointer
|
|
{
|
|
public:
|
|
|
|
/**
|
|
* destructor
|
|
*/
|
|
virtual ~NodeVisitor();
|
|
|
|
/**
|
|
* call this method to handle a node. Depending on the concrete type
|
|
* of the node, a specialized visit method is called.
|
|
*
|
|
* @param node the node to process
|
|
*/
|
|
virtual void visit(NodePtr node);
|
|
|
|
/**
|
|
* reimplement this method to handle literals.
|
|
*
|
|
* @param item the literal to visit
|
|
* @return whether the visitor handled the literal.
|
|
* Reimplementations of this method must return @p true.
|
|
*/
|
|
virtual bool visitLiteral(LiteralPtr);
|
|
|
|
/**
|
|
* reimplement this method to handle nodes that weren't handled
|
|
* by the more specific method.
|
|
*
|
|
* @param node the node to visit
|
|
* @return whether the visitor handled the node.
|
|
* Reimplementations of this method must return @p true.
|
|
*/
|
|
virtual bool visitNode(NodePtr node);
|
|
|
|
/**
|
|
* reimplement this method to handle properties.
|
|
*
|
|
* @param property the property to visit
|
|
* @return whether the visitor handled the property.
|
|
* Reimplementations of this method must return @p true.
|
|
*/
|
|
virtual bool visitProperty(PropertyPtr property);
|
|
|
|
/**
|
|
* reimplement this method to handle resources.
|
|
*
|
|
* @param resource the resource to visit
|
|
* @return whether the visitor handled the resource.
|
|
* Reimplementations of this method must return @p true.
|
|
*/
|
|
virtual bool visitResource(ResourcePtr resource);
|
|
|
|
/**
|
|
* reimplement this method to handle sequences.
|
|
*
|
|
* @param seq the sequence to visit
|
|
* @return whether the visitor handled the sequence.
|
|
* Reimplementations of this method must return @p true.
|
|
*/
|
|
virtual bool visitSequence(SequencePtr seq);
|
|
};
|
|
|
|
} // namespace RDF
|
|
} // namespace Syndication
|
|
|
|
#endif // SYNDICATION_RDF_NODEVISITOR_H
|