/usr/include/KF5/Syndication/syndication/parsercollection.h is in libkf5syndication-dev 17.12.3-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 | /*
* This file is part of the syndication library
*
* Copyright (C) 2005 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_PARSERCOLLECTION_H
#define SYNDICATION_PARSERCOLLECTION_H
#include <syndication/specificdocument.h>
#include <syndication/abstractparser.h>
#include <syndication/documentsource.h>
#include <syndication/feed.h>
#include <syndication/global.h>
#include <syndication/mapper.h>
#include <QString>
namespace Syndication
{
/**
* A collection of format-specific parser implementations.
* To parse a feed source, pass it to the parse() method of this class.
* In most cases, you should use the global singleton instance
* Syndication::parserCollection().
* When loading the source from the web, use Loader instead of using
* this class directly.
*
* Example code:
*
* @code
* ...
* QFile someFile(somePath);
* ...
* DocumentSource src(someFile.readAll());
* someFile.close();
*
* FeedPtr feed = parserCollection()->parse(src);
*
* if (feed)
* {
* QString title = feed->title();
* QList<ItemPtr> items = feed->items();
* ...
* }
* @endcode
*
* The template parameter T is the abstraction class parsed documents
* should be mapped to. If you want to use your own abstraction MyFeed,
* implement ParserCollection<MyFeed> (Note that you have to provide
* mapper implementations for every feed format then).
*
* @author Frank Osterfeld
*/
template <class T>
class SYNDICATION_EXPORT ParserCollection
{
public:
/** destructor */
virtual ~ParserCollection() {}
/**
* tries to parse a given source with the parsers registered.
* The source is passed to the first parser that accepts it.
*
* @param source The source to be parsed
* @param formatHint An optional hint which parser to test first. If
* there is a parser with the given hint as format string (e.g.,
* "rss2", "atom", "rdf"...), it is asked first to accept the source.
* This can avoid unnecessary AbstractParser::accept() checks and speed
* up parsing. See also AbstractParser::format().
* @return The feed document parsed from the source, or NULL if no
* parser accepted the source.
*/
virtual QSharedPointer<T> parse(const DocumentSource &source,
const QString &formatHint = QString()) = 0;
/**
* returns the error code of the last parse() call.
*
* @return the last error, or Success if parse() was successful
* or not yet called at all.
*/
virtual ErrorCode lastError() const = 0;
/**
* Adds a parser and corresponding mapper to the collection.
* AbstractParser::format() must be unique
* in the collection. If there is already a parser with the same format
* string, the parser isn't added.
*
* @note ownership for both @c parser and @c mapper is taken by the
* implementation, so don't delete them in your code!
*
* @param parser The parser to be registered
* @param mapper the mapper that should be used for building the
* abstraction
* @return whether the parser was successfully registered or not.
*/
virtual bool registerParser(AbstractParser *parser, Mapper<T> *mapper) = 0;
/**
* Changes the specific format to abstraction mapping for a parser.
*
* @param format the format string of the parser whose
* mapping should be changed. See AbstractParser::format.
* @param mapper Mapper implementation doing the mapping from the
* format specific representation to abstraction of type T.
*/
virtual void changeMapper(const QString &format, Mapper<T> *mapper) = 0;
};
} // namespace Syndication
#endif // SYNDICATION_PARSERCOLLECTION_H
|