File indexing completed on 2024-09-15 06:35:52

 /*
     This file is part of the syndication library
     SPDX-FileCopyrightText: 2005 Frank Osterfeld <osterfeld@kde.org>
 
     SPDX-License-Identifier: LGPL-2.0-or-later
 */
 
 #ifndef SYNDICATION_PARSERCOLLECTION_H
 #define SYNDICATION_PARSERCOLLECTION_H
 
 #include "abstractparser.h"
 #include "documentsource.h"
 #include "feed.h"
 #include "global.h"
 #include "mapper.h"
 #include "specificdocument.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&lt;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