tools.h

/*
 * 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_TOOLS_H
#define SYNDICATION_TOOLS_H

#include <syndication/person.h>
#include "ksyndication_export.h"


#include <QtCore/QString>

#include <ctime>

class QByteArray;
class QString;

namespace Syndication {

enum DateFormat
{
    ISODate, 
    RFCDate 
};

//KDE5: uint, not time_t
SYNDICATION_EXPORT
time_t parseISODate(const QString& str);

//KDE5: uint, not time_t
SYNDICATION_EXPORT
time_t parseRFCDate(const QString& str);

//KDE5: uint, not time_t
SYNDICATION_EXPORT
time_t parseDate(const QString& str, DateFormat hint=RFCDate);


//KDE5: uint, not time_t
SYNDICATION_EXPORT
QString dateTimeToString(time_t date);

SYNDICATION_EXPORT
QString resolveEntities(const QString& str);

SYNDICATION_EXPORT
QString escapeSpecialCharacters(const QString& str);

SYNDICATION_EXPORT
QString convertNewlines(const QString& str);

SYNDICATION_EXPORT
QString plainTextToHtml(const QString& plainText);

SYNDICATION_EXPORT
QString htmlToPlainText(const QString& html);

SYNDICATION_EXPORT
bool isHtml(const QString& str);

SYNDICATION_EXPORT
bool stringContainsMarkup(const QString& str);

SYNDICATION_EXPORT
QString normalize(const QString& str);

SYNDICATION_EXPORT
QString normalize(const QString& str, bool isCDATA, bool containsMarkup);

SYNDICATION_EXPORT
PersonPtr personFromString(const QString& str);

unsigned int calcHash(const QString& str);

unsigned int calcHash(const QByteArray& array);

QString calcMD5Sum(const QString& str);

//@cond PRIVATE
struct ElementType
{
    ElementType(const QString& localnamep,
                const QString& nsp=QString()); // implicit

    bool operator==(const ElementType& other) const;

    QString ns;
    QString localname;
};
//@endcond

} // namespace Syndication

#endif // SYNDICATION_TOOLS_H