iframe-proxy | Sunbelt Computer Software

231 lines (191 loc) · 6.26 KB
#include <QDebug>
#include <QVariant>
#include "qbencodedocument.h"
#include "qbencodeparser_p.h"
#include "qbencodewriter_p.h"
/*! \class QBencodeDocument
    \brief The QBencodeDocument class provides a way to read and write Bencode data.
    QBencodeDocument is a class that wraps a complete Bencode document and can read and
    write this document both from a UTF-8 encoded text based representation as well
    as binary data in case of the existance of non-string string entries.
    A Bencode document can be converted from its text-based representation to a QBencodeDocument
    using QBencodeDocument::fromBencodeString(). toBencodeString() converts it back to text. The
    parser is very fast and efficient and converts the Bencode to internal binary representation.
    Validity of the parsed document can be queried with !isNull().
    A document can be queried as to whether it contains data using isEmpty(). The value contained
    in the document can be retrieved using value() and then read or manipulated.
 * Constructs an empty and invalid document.
QBencodeDocument::QBencodeDocument()
 * Creates a QBencodeDocument from \a val
QBencodeDocument::QBencodeDocument(const QBencodeValue &val)
    setValue(val);
 * Deletes the document.
QBencodeDocument::~QBencodeDocument()
 * Creates a copy of the \a other document.
QBencodeDocument::QBencodeDocument(const QBencodeDocument &other)
    root = other.root;
 * Assigns the \a other document to this QBencodeDocument.
 * Returns a reference to this object.
QBencodeDocument &QBencodeDocument::operator =(const QBencodeDocument &other)
    root = other.root;
    return *this;
 Creates a QBencodeDocument that uses the first \a size bytes from \a data.
 It assumes \a data contains a Bencoded document. The created document does
 not take ownership of \a data and the caller has to guarantee that \a data
 will not be deleted or modified as long as any QBencodeDocument still references
 Returns a QBencodeDocument representing the data.
 \sa fromBencode()
/*static*/ QBencodeDocument QBencodeDocument::fromRawData(const char *data, int size,
                                                          QBencodeParseError *error, bool strictMode)
    QBencodePrivate::Parser parser(data, size);
    return parser.parse(error, strictMode);
  Creates a QBencodeDocument from the QVariant \a variant.
  If the \a variant contains any other type than a QBencodedValue
  accepted type, the returned document is invalid.
  \sa toVariant()
/*static*/ QBencodeDocument QBencodeDocument::fromVariant(const QVariant &variant)
    QBencodeDocument doc;
    QBencodeValue val = QBencodeValue::fromVariant(variant);
    if (!val.isUndefined()) {
        doc.setValue(val);
    return doc;
  Returns a QVariant representing the Bencode document.
  The returned variant will be empty if the document isEmpty()
  or isNull(). Otherwise this method is equivolant to call
  toVariant() on value().
  \sa fromVariant(), QBencodeValue::toVariant()
QVariant QBencodeDocument::toVariant() const
    if (isEmpty()) {
        return QVariant();
    } else {
        return root.toVariant();
  Parse Bencode format \a data and creates a QBencodeDocument from it.
  If the \a data is not valid, the method returns a null document.
  The optional \a error variable can be used to pass in a QBencodeParseError
  data structure that will contain information about possible errors encountered
  during parsing.
  \sa toBencode(), QBencodeParseError, isNull()
/*static*/ QBencodeDocument QBencodeDocument::fromBencode(const QByteArray &ben,
                                                          QBencodeParseError *error, bool strictMode)
    QBencodePrivate::Parser parser(ben.constData(), ben.length());
    return parser.parse(error, strictMode);
  Coverts the QBencodeDocument to Bencoded data, all string-type entries is
  encoded in UTF-8 if the entry was created from QString. The content of QBencodeValue
  created from QByteArray is untouched.
  \note There is no standard encoding for string-type entries in Bencode.
  While in most implementation is default to UTF-8, other encodings are still
  valid. e.g. GBK encoding found in Chinese systems. There are even implementations
  allowing arbitary binary in string-type entries. The caller should use a consistent
  encoding among all systems reading/writing the data and encode/decode the string
  explictly.
  \sa fromBencode()
QByteArray QBencodeDocument::toBencode() const
    QByteArray ben;
    QBencodePrivate::Writer::toBencode(root, ben);
    return ben;
 * Returns \c true if the document doesn't contain any data.
bool QBencodeDocument::isEmpty() const
    return isNull() || root.isUndefined();
  Returns \c true if this document is null.
  Null documents are documents created through the default constructor.
  Documents created from UTF-8 encoded text or the binary format are
  validated during parsing. If validation fails, the returned document
  will also be null.
bool QBencodeDocument::isNull() const
    return root.isNull();
  Returns the QBencodeValue contained in the document.
  Returns a value of type \c Undefined if the document is empty.
  \sa isEmpty(), setValue(), QBencodeValue::Type
QBencodeValue QBencodeDocument::value() const
    if (isEmpty()) {
        return QBencodeValue(QBencodeValue::Undefined);
    return root;
  Sets \a value as the root object of this document.
  \sa value()
void QBencodeDocument::setValue(const QBencodeValue &value)
    root = value;
  Returns \c true if the \a other document is equal to this document.
bool QBencodeDocument::operator==(const QBencodeDocument &other) const
    if (root.isNull()) {
        return other.root.isNull();
    } else {
        return other.root.isNull() ? false : root == other.root;
  \fn bool QBencodeDocument::operator!=(const QBencodeDocument &other) const
  Returns \c true if \a other is not equal to this document.
QDebug operator<<(QDebug out, const QBencodeDocument &doc)
    if (doc.isEmpty()) {
        out << "{QBencodeDocument, <Empty>}";
    } else {
        out << "{QBencodeDocument, " << doc.root << "}";
    return out;
Sunbelt Computer Software

PL/B Language Development and Support

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Sunbelt Computer Software

PL/B Language Development and Support

FilesExpand file tree

qbencodedocument.cpp

Latest commit

History

qbencodedocument.cpp

File metadata and controls
