QXmlStreamReader Class

  QXmlStreamReader xml;
  ...
  while (!xml.atEnd()) {
        xml.readNext();
        ... // do processing
  }
  if (xml.hasError()) {
        ... // do error handling
  }

メンバ関数の説明

QXmlStreamReader::QXmlStreamReader()

ストリームリーダーを構築する。

setDevice() およびaddData()も参照 。

[explicit] QXmlStreamReader::QXmlStreamReader(QAnyStringView data)

data から読み込む新しいストリームリーダを作成します。

addData()、clear()、setDevice()も参照してください 。

[explicit] QXmlStreamReader::QXmlStreamReader(QIODevice *device)

device から読み込む新しいストリーム・リーダを作成します。

setDevice() およびclear() も参照して ください。

[explicit] QXmlStreamReader::QXmlStreamReader(const QByteArray &data)

これはオーバーロードされた関数です。

data から読み込む新しいストリーム・リーダを作成します。

addData()、clear() およびsetDevice()も参照して ください。

[noexcept] QXmlStreamReader::~QXmlStreamReader()

リーダを破棄します。

void QXmlStreamReader::addData(QAnyStringView data)

リーダーが読み取るためのdata を追加します。リーダがdevice() を持っている場合、この関数は何もしません。

readNext() およびclear()も参照してください 。

void QXmlStreamReader::addData(const QByteArray &data)

これはオーバーロードされた関数です。

読者が読むためのdata を追加します。読者がdevice() を持っている場合、この関数は何もしない。

readNext() およびclear()も参照 。

void QXmlStreamReader::addExtraNamespaceDeclaration(const QXmlStreamNamespaceDeclaration &extraNamespaceDeclaration)

extraNamespaceDeclaration を追加する。 この宣言は、現在の要素の子要素に対して有効であるか、または、要素が読み込まれる前に関数が呼び出された場合は、XML文書全体に対して有効である。

namespaceDeclarations(),addExtraNamespaceDeclarations(),setNamespaceProcessing()も参照 。

void QXmlStreamReader::addExtraNamespaceDeclarations(const QXmlStreamNamespaceDeclarations &extraNamespaceDeclarations)

extraNamespaceDeclarations で指定された宣言のベクトルを追加する。

namespaceDeclarations() およびaddExtraNamespaceDeclaration()も参照 。

bool QXmlStreamReader::atEnd() const

リーダがXMLドキュメントの最後まで読み込んだ場合、またはerror() が発生して読み込みが中止された場合はtrue を返す。それ以外の場合はfalse を返す。

atEnd()とhasError()が真を返し、error()がPrematureEndOfDocumentError を返す場合、XMLはこれまでに整形されているが、完全なXMLドキュメントが解析されていないことを意味する。XML がQByteArray から読み込まれている場合はaddData() で、XML がQIODevice から読み込まれている場合はさらなるデータの到着を待つことで、XML の次のチャンクを追加できる。

hasError()、error()、device()、QIODevice::atEnd()も参照 。

QXmlStreamAttributes QXmlStreamReader::attributes() const

StartElement の属性を返します。

qint64 QXmlStreamReader::characterOffset() const

現在の文字オフセットを返します。

lineNumber() およびcolumnNumber()も参照してください 。

void QXmlStreamReader::clear()

device() またはデータをリーダから削除し、その内部状態を初期状態にリセットする。

addData()も参照 。

qint64 QXmlStreamReader::columnNumber() const

0 から始まる現在の列番号を返します。

lineNumber() およびcharacterOffset() も参照 。

QIODevice *QXmlStreamReader::device() const

QXmlStreamReader に関連付けられた現在のデバイス、またはデバイスが割り当てられていない場合はnullptr を返す。

setDevice() も参照 。

QStringView QXmlStreamReader::documentEncoding() const

tokenType() がStartDocument の場合、この関数は XML 宣言で指定されたエンコード文字列を返す。それ以外の場合は空文字列が返される。

QStringView QXmlStreamReader::documentVersion() const

tokenType() がStartDocument の場合、この関数は XML 宣言で指定されたバージョン文字列を返す。それ以外の場合は空文字列が返される。

QStringView QXmlStreamReader::dtdName() const

tokenType() がDTD の場合、この関数は DTD の名前を返す。それ以外の場合は空文字列が返される。

QStringView QXmlStreamReader::dtdPublicId() const

tokenType() がDTD の場合、この関数は DTD の公開識別子を返す。それ以外の場合は空文字列が返されます。

QStringView QXmlStreamReader::dtdSystemId() const

tokenType() がDTD の場合、この関数は DTD のシステム識別子を返します。それ以外の場合は空文字列を返します。

QXmlStreamEntityDeclarations QXmlStreamReader::entityDeclarations() const

tokenType() がDTD の場合、この関数は DTD の解析されていない（外部）実体宣言を返します。そうでない場合は、空のベクトルが返されます。

QXmlStreamEntityDeclarations クラスはQXmlStreamEntityDeclaration のQList であると定義されています。

int QXmlStreamReader::entityExpansionLimit() const

単一の実体が展開できる最大文字数を返します。単一の実体が与えられた上限を超えて展開された場合、その文書はうまく形成されていないとみなされます。

setEntityExpansionLimitも参照してください 。

QXmlStreamEntityResolver *QXmlStreamReader::entityResolver() const

実体リゾルバを返し、実体リゾルバがない場合はnullptr を返します。

setEntityResolver()も参照 。

QXmlStreamReader::Error QXmlStreamReader::error() const

現在のエラーの型を返し、エラーが発生していない場合はNoError を返す。

errorString() およびraiseError() も参照 。

QString QXmlStreamReader::errorString() const

raiseError() で設定したエラー・メッセージを返します。

error()、lineNumber()、columnNumber()、characterOffset() も参照 。

bool QXmlStreamReader::hasError() const

エラーが発生した場合はtrue を返し、そうでない場合はfalse を返す。

errorString() およびerror() も参照 。

[since 6.6] bool QXmlStreamReader::hasStandaloneDeclaration() const

このドキュメントに明示的なスタンドアロン宣言がある場合はtrue を返し (「yes」または「no」を指定可能)、 それ以外の場合はfalse を返す；

XML 宣言が解析されていない場合、この関数はfalse を返します。

この関数は Qt 6.6 で導入されました。

isStandaloneDocument()も参照してください 。

bool QXmlStreamReader::isCDATA() const

リーダが CDATA セクションに由来する文字を報告した場合はtrue を返し、そうでない場合はfalse を返します。

isCharacters() およびtext()も参照 。

bool QXmlStreamReader::isCharacters() const

tokenType() がCharacters と等しい場合はtrue を返し、そうでない場合はfalse を返す。

isWhitespace() およびisCDATA()も参照 。

bool QXmlStreamReader::isComment() const

tokenType() がComment に等しい場合はtrue を返し、そうでない場合はfalse を返す。

bool QXmlStreamReader::isDTD() const

tokenType() がDTD に等しい場合はtrue を返し、そうでない場合はfalse を返す。

bool QXmlStreamReader::isEndDocument() const

tokenType() がEndDocument に等しい場合はtrue を返し、そうでない場合はfalse を返す。

bool QXmlStreamReader::isEndElement() const

tokenType() がEndElement に等しければtrue を返し、そうでなければfalse を返す。

bool QXmlStreamReader::isEntityReference() const

tokenType() がEntityReference に等しければtrue を返し、そうでなければfalse を返す。

bool QXmlStreamReader::isProcessingInstruction() const

tokenType() がProcessingInstruction に等しければtrue を返し、そうでなければfalse を返す。

bool QXmlStreamReader::isStandaloneDocument() const

このドキュメントがXML宣言でスタンドアロン宣言されている場合はtrue を返し、そうでない場合はfalse を返す。

XML宣言が解析されていない場合、この関数はfalse を返す。

hasStandaloneDeclaration()も参照 。

bool QXmlStreamReader::isStartDocument() const

tokenType() がStartDocument と等しい場合はtrue を返し、そうでない場合はfalse を返す。

bool QXmlStreamReader::isStartElement() const

tokenType() がStartElement に等しい場合はtrue を返し、そうでない場合はfalse を返す。

bool QXmlStreamReader::isWhitespace() const

リーダが空白のみで構成される文字を報告した場合はtrue を返し、そうでない場合はfalse を返す。

isCharacters() およびtext()も参照のこと 。

qint64 QXmlStreamReader::lineNumber() const

1 から始まる現在の行番号を返す。

columnNumber() およびcharacterOffset() も参照 。

QStringView QXmlStreamReader::name() const

StartElement 、EndElement 、またはEntityReference のローカル名を返す。

namespaceUri() およびqualifiedName() も参照 。

QXmlStreamNamespaceDeclarations QXmlStreamReader::namespaceDeclarations() const

tokenType() がStartElement の場合、この関数は要素の名前空間宣言を返す。そうでない場合は、空のベクトルが返されます。

QXmlStreamNamespaceDeclarations クラスは、QXmlStreamNamespaceDeclaration のQList として定義されます。

addExtraNamespaceDeclaration() およびaddExtraNamespaceDeclarations()も参照 。

QStringView QXmlStreamReader::namespaceUri() const

StartElement またはEndElement の namespaceUri を返します。

name() およびqualifiedName()も参照 。

QXmlStreamNotationDeclarations QXmlStreamReader::notationDeclarations() const

tokenType() がDTD の場合、この関数は DTD の表記宣言を返す。そうでない場合は、空のベクトルが返されます。

QXmlStreamNotationDeclarations クラスはQXmlStreamNotationDeclaration のQList と定義されています。

QStringView QXmlStreamReader::prefix() const

StartElement またはEndElement の接頭辞を返す。

name() およびqualifiedName()も参照のこと 。

QStringView QXmlStreamReader::processingInstructionData() const

ProcessingInstruction のデータを返します。

QStringView QXmlStreamReader::processingInstructionTarget() const

ProcessingInstruction のターゲットを返します。

QStringView QXmlStreamReader::qualifiedName() const

StartElement またはEndElement の修飾名を返します；

修飾名は、XML データ内の要素の生の名前です。名前空間接頭辞の後にコロンが続き、その後に要素のローカル名が続きます。名前空間接頭辞は一意ではありません（同じ接頭辞が異なる名前空間を指すことも、異なる接頭辞が同じ名前空間を指すこともあります）ので、qualifiedName()は使用せず、解決されたnamespaceUri （）と属性のローカルname （）を使用する必要があります。

name()、prefix()、namespaceUri()も参照 ください。

void QXmlStreamReader::raiseError(const QString &message = QString())

オプションのエラーmessage でカスタム・エラーを発生させます。

error() およびerrorString() も参照 。

QString QXmlStreamReader::readElementText(QXmlStreamReader::ReadElementTextBehaviour behaviour = ErrorOnUnexpectedElement)

StartElement が読み込まれた場合に呼び出される便利な関数。対応するEndElement まで読み込み、その間のすべてのテキストを返します。エラーがない場合、この関数を呼び出した後の現在のトークン（tokenType() を参照）はEndElement となります。

この関数は、Characters またはEntityReference のトークンを読み込むと、text() を連結しますが、ProcessingInstruction とComment はスキップします。現在のトークンがStartElement でない場合、空の文字列が返されます。

behaviour は、EndElement に到達する前に他のものが読み込まれた場合の動作を定義しています。この関数は、子要素のテキストを含めたり（HTMLの場合などに便利）、子要素を無視したり、UnexpectedElementError を発生させてそれまでに読み込まれたものを返したりすることができます（デフォルト）。

QXmlStreamReader::TokenType QXmlStreamReader::readNext()

次のトークンを読み取り、その型を返します。

1つの例外を除いて、readNext()によってerror() が報告されると、XMLストリームをそれ以上読み込むことはできない。その場合、atEnd() はtrue を返し、hasError() はtrue を返し、この関数はQXmlStreamReader::Invalid を返す。

例外は、error() がPrematureEndOfDocumentError を返す場合である。このエラーは、整形式でないXMLの塊の終端に達したが、その塊が完全なXML文書を表していない場合に報告される。この場合、QByteArray からストリームを読み込んでいるときにaddData() を呼び出して XML の次のチャンクを追加するか、device() からストリームを読み込んでいるときにさらなるデータの到着を待つことで、構文解析を再開できる。

tokenType() およびtokenString()も参照 。

bool QXmlStreamReader::readNextStartElement()

現在の要素内の次の開始要素まで読み込む。開始要素に達した場合はtrue を返す。終了要素に達した場合、またはエラーが発生した場合は false を返します。

現在の要素は、最も最近解析された開始要素に一致する要素で、一致する終了要素にまだ到達していないものです。パーサーが終了要素に到達すると、現在の要素が親要素になります。

これは、XML 要素の解析にのみ関心がある場合に便利な関数です。QXmlStream Bookmarks Exampleでは、この関数を多用しています。

readNext()も参照してください 。

void QXmlStreamReader::setDevice(QIODevice *device)

現在のデバイスをdevice に設定します。 デバイスを設定すると、ストリームが初期状態にリセットされます。

device() およびclear() も参照して ください。

void QXmlStreamReader::setEntityExpansionLimit(int limit)

1つのエンティティが展開できる最大文字数をlimit に設定します。 1つのエンティティが指定された制限を超えて展開された場合、ドキュメントは正しく形成されていないとみなされます。

この制限は、再帰的なエンティティの展開によって利用可能なメモリをすべて使い果たしてしまうような、未知のXMLドキュメントを読み込む際のDoS攻撃を防ぐためにあります。

このプロパティのデフォルト値は4096文字である。

entityExpansionLimitも参照のこと 。

void QXmlStreamReader::setEntityResolver(QXmlStreamEntityResolver *resolver)

resolver を新しいentityResolver() にする。

ストリームリーダはリゾルバの所有権を持たない。リゾルバがストリームリーダオブジェクトの全ライフタイム中、 あるいは別のリゾルバやnullptr が設定されるまで有効であることを 保証するのは、呼び出し側の責任である。

entityResolver()も参照のこと 。

void QXmlStreamReader::skipCurrentElement()

子ノードをスキップして、現在の要素の終わりまで読み込みます。この関数は、未知の要素をスキップするのに便利です。

現在の要素とは、最近パースされた開始要素にマッチする要素のうち、まだ終了要素に達していない要素です。パーサーが終了要素に達すると、現在の要素が親要素になります。

QStringView QXmlStreamReader::text() const

Characters,Comment,DTD, またはEntityReference のテキストを返します。

QString QXmlStreamReader::tokenString() const

リーダの現在のトークンを文字列で返します。

tokenType()も参照してください 。

QXmlStreamReader::TokenType QXmlStreamReader::tokenType() const

現在のトークンの型を返します。

現在のトークンは、便利関数isStartDocument()、isEndDocument()、isStartElement()、isEndElement()、isCharacters()、isComment()、isDTD()、isEntityReference()、およびisProcessingInstruction() でも照会できます。

tokenString()も参照してください 。