/usr/include/syndication/abstractparser.h is in kdepimlibs5-dev 4:4.14.10-7+b2.
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 | /*
* 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_ABSTRACTPARSER_H
#define SYNDICATION_ABSTRACTPARSER_H
#include <syndication/specificdocument.h>
#include "ksyndication_export.h"
class QString;
namespace Syndication {
class DocumentSource;
/**
* Interface for all parsers. The parsers for the various formats must
* implement this interface and register themselves at the ParserRegistry.
*
* @author Frank Osterfeld
*/
class SYNDICATION_EXPORT AbstractParser
{
public:
/**
* virtual destructor
*/
virtual ~AbstractParser();
/**
* Lets the parser check if it can parse the passed source.
* Parser implementations should do a _quick_ check for the file
* format (i.e. check for feed format and version number in the root
* element) to find out if the source is in a supported format. They
* should _not_ completely parse the document to test for full
* compliance to the format specification.
*
* @param source the document source to be checked
* @return whether @c source seems to be in a format supported by the
* parser
*/
virtual bool accept(const DocumentSource& source) const = 0;
/**
* Lets the parser parse a document source. The parser returns a
* valid document instance if successful, or an invalid one if
* not.
*
* @see SpecificDocument::isValid()
* @param source The document source to be parsed
* @return a newly created document parsed from @c source
*/
virtual SpecificDocumentPtr parse(const DocumentSource& source) const = 0;
/**
* Returns the name of the format supported by this
* parser.
*
* @return a string like "rss2", "atom" or "rdf"
*/
virtual QString format() const = 0;
};
} // namespace Syndication
#endif // SYNDICATION_ABSTRACTPARSER_H
|