/usr/include/KF5/Syndication/syndication/global.h is in libkf5syndication-dev 15.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 | /*
* 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_GLOBAL_H
#define SYNDICATION_GLOBAL_H
#include <feed.h>
#include "syndication_export.h"
#include <QtCore/QString>
namespace Syndication
{
class DocumentSource;
template <class T> class ParserCollection;
/**
*
* The default ParserCollection instance parsing
* a DocumentSource into a Feed object.
*
* Use this to parse a local file or a otherwise
* manually created DocumentSource object.
* To retrieve a feed from the web, use Loader instead.
*
* 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
*/
SYNDICATION_EXPORT
ParserCollection<Feed> *parserCollection();
/**
* parses a document from a source and returns a new Feed object
* wrapping the feed content.
* Shortcut for parserCollection()->parse().
* See ParserCollection::parse() for more details.
*
* @param src the document source to parse
* @param formatHint an optional hint which format to test first
*/
SYNDICATION_EXPORT
FeedPtr parse(const DocumentSource &src, const QString &formatHint = QString());
/**
* error code indicating fetching or parsing errors
*/
enum ErrorCode {
Success = 0, /**< No error occurred, feed was fetched and parsed
* successfully
*/
Aborted = 1, /**< file downloading/parsing was aborted by the user */
Timeout = 2, /**< file download timed out */
UnknownHost = 3, /**< The hostname couldn't get resolved to an IP address */
FileNotFound = 4, /**< the host was contacted successfully, but reported a
* 404 error
*/
OtherRetrieverError = 5, /**< retriever error not covered by the error codes
* above. This is returned if a custom
* DataRetriever was used. See the
* retriever-specific status byte for more
* information on the occurred error. */
InvalidXml = 6, /**< The XML is invalid. This is returned if no parser
* accepts the source and the DOM document can't be parsed.
* It is not returned if the source is not valid XML but a
* (non-XML) parser accepts it.
*/
XmlNotAccepted = 7, /**< The source is valid XML, but no parser accepted
* it.
*/
InvalidFormat = 8 /**< the source was accepted by a parser, but the actual
* parsing failed. As our parser implementations
* currently do not validate the source ("parse what you
* can get"), this code will be rarely seen.
*/
};
} // namespace Syndication
#endif // SYNDICATION_GLOBAL_H
|