qhtmlparser.h

Go to the documentation of this file.

#ifndef QHTMLPARSER_H
#define QHTMLPARSER_H

#include <QList>
#include <QString>

#if defined(QHTMLPARSER_LIBRARY)
#define QHTMLPARSER_EXPORT Q_DECL_EXPORT
#elif defined(QHTMLPARSER_STATIC_LIBRARY)
#define QHTMLPARSER_EXPORT
#else
#define QHTMLPARSER_EXPORT Q_DECL_IMPORT
#endif

namespace QHtmlParser
{
    enum MatchFlag {
        MatchExactly = 0x0000,

        MatchContains = 0x0001,
        
        MatchStartsWith = 0x0002,
        
        MatchEndsWith = 0x0004,
        
        MatchRegExp = 0x0008,
        
        MatchWildcard = 0x0010,
        
        MatchCaseSensitive = 0x0020
    };

    typedef QFlags<MatchFlag> MatchFlags;

    enum MatchType {
        MatchAll = 0,

        MatchAny = 1
    };
}

Q_DECLARE_OPERATORS_FOR_FLAGS(QHtmlParser::MatchFlags)


class QHTMLPARSER_EXPORT QHtmlAttribute
{

public:
    QHtmlAttribute();
    
    explicit QHtmlAttribute(const QString &name, const QString &value);
    
    const QString& name() const;
    
    void setName(const QString &name);
    
    const QString& value() const;
    
    void setValue(const QString &value);

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

    bool operator!=(const QHtmlAttribute &other) const;

private:
    QString m_name;
    QString m_value;
};

class QHTMLPARSER_EXPORT QHtmlAttributeMatch : public QHtmlAttribute
{

public:
    QHtmlAttributeMatch();
    
    explicit QHtmlAttributeMatch(const QString &name, const QString &value,
                                 QHtmlParser::MatchFlags flags = QHtmlParser::MatchFlags(QHtmlParser::MatchExactly));
    
    QHtmlParser::MatchFlags flags() const;
    
    void setFlags(QHtmlParser::MatchFlags flags);
    
    void setFlag(QHtmlParser::MatchFlag flag, bool on = true);
    
    bool testFlag(QHtmlParser::MatchFlag flag) const;

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

    bool operator!=(const QHtmlAttributeMatch &other) const;

private:
    QHtmlParser::MatchFlags m_flags;
};

class QHtmlElement;
class QHtmlElementPrivate;

typedef QList<QHtmlAttribute> QHtmlAttributes;

typedef QList<QHtmlAttributeMatch> QHtmlAttributeMatches;

typedef QList<QHtmlElement> QHtmlElementList;

class QHTMLPARSER_EXPORT QHtmlElement
{

public:
    QHtmlElement();
    
    QHtmlElement(const QHtmlElement &other);
    
    ~QHtmlElement();
    
    QHtmlAttributes attributes() const;
    
    QString attribute(const QString &name) const;

    QHtmlElement parentElement() const;

    QHtmlElement nextSibling() const;

    QHtmlElement previousSibling() const;
    
    QHtmlElementList childElements() const;
    
    QHtmlElement firstChildElement() const;
    
    QHtmlElement lastChildElement() const;
    
    QHtmlElement nthChildElement(int n) const;
    
    QHtmlElement elementById(const QString &id) const;
    
    QHtmlElementList elementsByTagName(const QString &name) const;
    
    QHtmlElementList elementsByTagName(const QString &name, const QHtmlAttributeMatch &match) const;
    
    QHtmlElementList elementsByTagName(const QString &name, const QHtmlAttributeMatches &matches,
                                       QHtmlParser::MatchType matchType = QHtmlParser::MatchAll) const;
    
    QHtmlElement firstElementByTagName(const QString &name) const;
    
    QHtmlElement firstElementByTagName(const QString &name, const QHtmlAttributeMatch &match) const;
    
    QHtmlElement firstElementByTagName(const QString &name, const QHtmlAttributeMatches &matches,
                                       QHtmlParser::MatchType matchType = QHtmlParser::MatchAll) const;
    
    QHtmlElement lastElementByTagName(const QString &name) const;
    
    QHtmlElement lastElementByTagName(const QString &name, const QHtmlAttributeMatch &match) const;
    
    QHtmlElement lastElementByTagName(const QString &name, const QHtmlAttributeMatches &matches,
                                      QHtmlParser::MatchType matchType = QHtmlParser::MatchAll) const;
    
    QHtmlElement nthElementByTagName(int n, const QString &name) const;
    
    QHtmlElement nthElementByTagName(int n, const QString &name, const QHtmlAttributeMatch &match) const;
    
    QHtmlElement nthElementByTagName(int n, const QString &name, const QHtmlAttributeMatches &matches,
                                     QHtmlParser::MatchType matchType = QHtmlParser::MatchAll) const;    
    
    QString tagName() const;
    
    QString text(bool includeChildElements = false) const;
    
    QString toString() const;
    
    bool isNull() const;

    QHtmlElement& operator=(const QHtmlElement &other);
    
    bool operator==(const QHtmlElement &other) const;
    
    bool operator!=(const QHtmlElement &other) const;

private:
    QHtmlElementPrivate *d;
    
    friend class QHtmlDocument;
};

class QHtmlDocumentPrivate;
class QIODevice;

class QHTMLPARSER_EXPORT QHtmlDocument
{

public:
    QHtmlDocument();
    
    explicit QHtmlDocument(const QString &content);
    
    explicit QHtmlDocument(const QByteArray &content);
    
    explicit QHtmlDocument(QIODevice *device);
    
    ~QHtmlDocument();
    
    bool setContent(const QString &content);
    
    bool setContent(const QByteArray &content);
    
    bool setContent(QIODevice *device);
    
    QHtmlElement documentElement() const;
    
    QHtmlElement htmlElement() const;
    
    QHtmlElement headElement() const;
    
    QHtmlElement bodyElement() const;
    
    QString toString() const;
    
    bool hasError() const;
    
    QString errorString() const;
    
    bool isNull() const;

private:
    QHtmlDocumentPrivate *d;
    Q_DISABLE_COPY(QHtmlDocument)
};

#endif // QHTMLPARSER_H