1 /****************************************************************************

     2 **

     3 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).

     4 ** All rights reserved.

     5 ** Contact: Nokia Corporation (qt-info@nokia.com)

     6 **

     7 ** This file is part of the QtXml module of the Qt Toolkit.

     8 **

     9 ** $QT_BEGIN_LICENSE:LGPL$

    10 ** No Commercial Usage

    11 ** This file contains pre-release code and may not be distributed.

    12 ** You may use this file in accordance with the terms and conditions

    13 ** contained in the Technology Preview License Agreement accompanying

    14 ** this package.

    15 **

    16 ** GNU Lesser General Public License Usage

    17 ** Alternatively, this file may be used under the terms of the GNU Lesser

    18 ** General Public License version 2.1 as published by the Free Software

    19 ** Foundation and appearing in the file LICENSE.LGPL included in the

    20 ** packaging of this file.  Please review the following information to

    21 ** ensure the GNU Lesser General Public License version 2.1 requirements

    22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

    23 **

    24 ** In addition, as a special exception, Nokia gives you certain additional

    25 ** rights.  These rights are described in the Nokia Qt LGPL Exception

    26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.

    27 **

    28 ** If you have questions regarding the use of this file, please contact

    29 ** Nokia at qt-info@nokia.com.

    30 **

    31 **

    32 **

    33 **

    34 **

    35 **

    36 **

    37 **

    38 ** $QT_END_LICENSE$

    39 **

    40 ****************************************************************************/

    41 

    42 #include "qxml.h"

    43 #include "qtextcodec.h"

    44 #include "qbuffer.h"

    45 #include "qregexp.h"

    46 #include "qmap.h"

    47 #include "qstack.h"

    48 #include <qdebug.h>

    49 

    50 

    51 #ifdef Q_CC_BOR // borland 6 finds bogus warnings when building this file in uic3

    52 #    pragma warn -8080

    53 #endif

    54 

    55 //#define QT_QXML_DEBUG

    56 

    57 // Error strings for the XML reader

    58 #define XMLERR_OK                         QT_TRANSLATE_NOOP("QXml", "no error occurred")

    59 #define XMLERR_ERRORBYCONSUMER            QT_TRANSLATE_NOOP("QXml", "error triggered by consumer")

    60 #define XMLERR_UNEXPECTEDEOF              QT_TRANSLATE_NOOP("QXml", "unexpected end of file")

    61 #define XMLERR_MORETHANONEDOCTYPE         QT_TRANSLATE_NOOP("QXml", "more than one document type definition")

    62 #define XMLERR_ERRORPARSINGELEMENT        QT_TRANSLATE_NOOP("QXml", "error occurred while parsing element")

    63 #define XMLERR_TAGMISMATCH                QT_TRANSLATE_NOOP("QXml", "tag mismatch")

    64 #define XMLERR_ERRORPARSINGCONTENT        QT_TRANSLATE_NOOP("QXml", "error occurred while parsing content")

    65 #define XMLERR_UNEXPECTEDCHARACTER        QT_TRANSLATE_NOOP("QXml", "unexpected character")

    66 #define XMLERR_INVALIDNAMEFORPI           QT_TRANSLATE_NOOP("QXml", "invalid name for processing instruction")

    67 #define XMLERR_VERSIONEXPECTED            QT_TRANSLATE_NOOP("QXml", "version expected while reading the XML declaration")

    68 #define XMLERR_WRONGVALUEFORSDECL         QT_TRANSLATE_NOOP("QXml", "wrong value for standalone declaration")

    69 #define XMLERR_EDECLORSDDECLEXPECTED      QT_TRANSLATE_NOOP("QXml", "encoding declaration or standalone declaration expected while reading the XML declaration")

    70 #define XMLERR_SDDECLEXPECTED             QT_TRANSLATE_NOOP("QXml", "standalone declaration expected while reading the XML declaration")

    71 #define XMLERR_ERRORPARSINGDOCTYPE        QT_TRANSLATE_NOOP("QXml", "error occurred while parsing document type definition")

    72 #define XMLERR_LETTEREXPECTED             QT_TRANSLATE_NOOP("QXml", "letter is expected")

    73 #define XMLERR_ERRORPARSINGCOMMENT        QT_TRANSLATE_NOOP("QXml", "error occurred while parsing comment")

    74 #define XMLERR_ERRORPARSINGREFERENCE      QT_TRANSLATE_NOOP("QXml", "error occurred while parsing reference")

    75 #define XMLERR_INTERNALGENERALENTITYINDTD QT_TRANSLATE_NOOP("QXml", "internal general entity reference not allowed in DTD")

    76 #define XMLERR_EXTERNALGENERALENTITYINAV  QT_TRANSLATE_NOOP("QXml", "external parsed general entity reference not allowed in attribute value")

    77 #define XMLERR_EXTERNALGENERALENTITYINDTD QT_TRANSLATE_NOOP("QXml", "external parsed general entity reference not allowed in DTD")

    78 #define XMLERR_UNPARSEDENTITYREFERENCE    QT_TRANSLATE_NOOP("QXml", "unparsed entity reference in wrong context")

    79 #define XMLERR_RECURSIVEENTITIES          QT_TRANSLATE_NOOP("QXml", "recursive entities")

    80 #define XMLERR_ERRORINTEXTDECL            QT_TRANSLATE_NOOP("QXml", "error in the text declaration of an external entity")

    81 

    82 QT_BEGIN_NAMESPACE

    83 

    84 // the constants for the lookup table

    85 static const signed char cltWS      =  0; // white space

    86 static const signed char cltPer     =  1; // %

    87 static const signed char cltAmp     =  2; // &

    88 static const signed char cltGt      =  3; // >

    89 static const signed char cltLt      =  4; // <

    90 static const signed char cltSlash   =  5; // /

    91 static const signed char cltQm      =  6; // ?

    92 static const signed char cltEm      =  7; // !

    93 static const signed char cltDash    =  8; // -

    94 static const signed char cltCB      =  9; // ]

    95 static const signed char cltOB      = 10; // [

    96 static const signed char cltEq      = 11; // =

    97 static const signed char cltDq      = 12; // "

    98 static const signed char cltSq      = 13; // '

    99 static const signed char cltUnknown = 14;

   100 

   101 // Hack for letting QDom know where the skipped entity occurred

   102 // ### Qt5: the use of this variable means the code isn't reentrant.

   103 bool qt_xml_skipped_entity_in_content;

   104 

   105 // character lookup table

   106 static const signed char charLookupTable[256]={

   107     cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, // 0x00 - 0x07

   108     cltUnknown, // 0x08

   109     cltWS,      // 0x09 \t

   110     cltWS,      // 0x0A \n

   111     cltUnknown, // 0x0B

   112     cltUnknown, // 0x0C

   113     cltWS,      // 0x0D \r

   114     cltUnknown, // 0x0E

   115     cltUnknown, // 0x0F

   116     cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, // 0x17 - 0x16

   117     cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, // 0x18 - 0x1F

   118     cltWS,      // 0x20 Space

   119     cltEm,      // 0x21 !

   120     cltDq,      // 0x22 "

   121     cltUnknown, // 0x23

   122     cltUnknown, // 0x24

   123     cltPer,     // 0x25 %

   124     cltAmp,     // 0x26 &

   125     cltSq,      // 0x27 '

   126     cltUnknown, // 0x28

   127     cltUnknown, // 0x29

   128     cltUnknown, // 0x2A

   129     cltUnknown, // 0x2B

   130     cltUnknown, // 0x2C

   131     cltDash,    // 0x2D -

   132     cltUnknown, // 0x2E

   133     cltSlash,   // 0x2F /

   134     cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, // 0x30 - 0x37

   135     cltUnknown, // 0x38

   136     cltUnknown, // 0x39

   137     cltUnknown, // 0x3A

   138     cltUnknown, // 0x3B

   139     cltLt,      // 0x3C <

   140     cltEq,      // 0x3D =

   141     cltGt,      // 0x3E >

   142     cltQm,      // 0x3F ?

   143     cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, // 0x40 - 0x47

   144     cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, // 0x48 - 0x4F

   145     cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, // 0x50 - 0x57

   146     cltUnknown, // 0x58

   147     cltUnknown, // 0x59

   148     cltUnknown, // 0x5A

   149     cltOB,      // 0x5B [

   150     cltUnknown, // 0x5C

   151     cltCB,      // 0x5D]

   152     cltUnknown, // 0x5E

   153     cltUnknown, // 0x5F

   154     cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, // 0x60 - 0x67

   155     cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, // 0x68 - 0x6F

   156     cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, // 0x70 - 0x77

   157     cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, // 0x78 - 0x7F

   158     cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, // 0x80 - 0x87

   159     cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, // 0x88 - 0x8F

   160     cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, // 0x90 - 0x97

   161     cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, // 0x98 - 0x9F

   162     cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, // 0xA0 - 0xA7

   163     cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, // 0xA8 - 0xAF

   164     cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, // 0xB0 - 0xB7

   165     cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, // 0xB8 - 0xBF

   166     cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, // 0xC0 - 0xC7

   167     cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, // 0xC8 - 0xCF

   168     cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, // 0xD0 - 0xD7

   169     cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, // 0xD8 - 0xDF

   170     cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, // 0xE0 - 0xE7

   171     cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, // 0xE8 - 0xEF

   172     cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, // 0xF0 - 0xF7

   173     cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown, cltUnknown  // 0xF8 - 0xFF

   174 };

   175 

   176 //

   177 // local helper functions

   178 //

   179 

   180 /*

   181   This function strips the TextDecl [77] ("<?xml ...?>") from the string \a

   182   str. The stripped version is stored in \a str. If this function finds an

   183   invalid TextDecl, it returns false, otherwise true.

   184 

   185   This function is used for external entities since those can include an

   186   TextDecl that must be stripped before inserting the entity.

   187 */

   188 static bool stripTextDecl(QString& str)

   189 {

   190     QString textDeclStart(QLatin1String("<?xml"));

   191     if (str.startsWith(textDeclStart)) {

   192         QRegExp textDecl(QString::fromLatin1(

   193             "^<\\?xml\\s+"

   194             "(version\\s*=\\s*((['\"])[-a-zA-Z0-9_.:]+\\3))?"

   195             "\\s*"

   196             "(encoding\\s*=\\s*((['\"])[A-Za-z][-a-zA-Z0-9_.]*\\6))?"

   197             "\\s*\\?>"

   198        ));

   199         QString strTmp = str.replace(textDecl, QLatin1String(""));

   200         if (strTmp.length() != str.length())

   201             return false; // external entity has wrong TextDecl

   202         str = strTmp;

   203     }

   204     return true;

   205 }

   206 

   207 

   208 class QXmlAttributesPrivate

   209 {

   210 };

   211 

   212 /* \class QXmlInputSourcePrivate

   213     \internal

   214 

   215   There's a slight misdesign in this class that can

   216   be worth to keep in mind: the `str' member is

   217   a buffer which QXmlInputSource::next() returns from,

   218   and which is populated from the input device or input

   219   stream. However, when the input is a QString(the user called

   220   QXmlInputSource::setData()), `str' has two roles: it's the

   221   buffer, but also the source. This /seems/ to be no problem

   222   because in the case of having no device or stream, the QString

   223   is read in one go.

   224  */

   225 class QXmlInputSourcePrivate

   226 {

   227 public:

   228     QIODevice *inputDevice;

   229     QTextStream *inputStream;

   230 

   231     QString str;

   232     const QChar *unicode;

   233     int pos;

   234     int length;

   235     bool nextReturnedEndOfData;

   236 #ifndef QT_NO_TEXTCODEC

   237     QTextDecoder *encMapper;

   238 #endif

   239 

   240     QByteArray encodingDeclBytes;

   241     QString encodingDeclChars;

   242     bool lookingForEncodingDecl;

   243 };

   244 class QXmlParseExceptionPrivate

   245 {

   246 public:

   247     QXmlParseExceptionPrivate()

   248         : column(-1), line(-1)

   249     {

   250     }

   251     QXmlParseExceptionPrivate(const QXmlParseExceptionPrivate &other)

   252         : msg(other.msg), column(other.column), line(other.line),

   253           pub(other.pub), sys(other.sys)

   254     {

   255     }

   256 

   257     QString msg;

   258     int column;

   259     int line;

   260     QString pub;

   261     QString sys;

   262 

   263 };

   264 

   265 class QXmlLocatorPrivate

   266 {

   267 };

   268 

   269 class QXmlDefaultHandlerPrivate

   270 {

   271 };

   272 

   273 class QXmlSimpleReaderPrivate

   274 {

   275 public:

   276     ~QXmlSimpleReaderPrivate();

   277 private:

   278     // functions

   279     QXmlSimpleReaderPrivate(QXmlSimpleReader *reader);

   280     void initIncrementalParsing();

   281 

   282     // used to determine if elements are correctly nested

   283     QStack<QString> tags;

   284 

   285     // used by parseReference() and parsePEReference()

   286     enum EntityRecognitionContext { InContent, InAttributeValue, InEntityValue, InDTD };

   287 

   288     // used for entity declarations

   289     struct ExternParameterEntity

   290     {

   291         ExternParameterEntity() {}

   292         ExternParameterEntity(const QString &p, const QString &s)

   293             : publicId(p), systemId(s) {}

   294         QString publicId;

   295         QString systemId;

   296 

   297         Q_DUMMY_COMPARISON_OPERATOR(ExternParameterEntity)

   298     };

   299     struct ExternEntity

   300     {

   301         ExternEntity() {}

   302         ExternEntity(const QString &p, const QString &s, const QString &n)

   303             : publicId(p), systemId(s), notation(n) {}

   304         QString publicId;

   305         QString systemId;

   306         QString notation;

   307         Q_DUMMY_COMPARISON_OPERATOR(ExternEntity)

   308     };

   309     QMap<QString,ExternParameterEntity> externParameterEntities;

   310     QMap<QString,QString> parameterEntities;

   311     QMap<QString,ExternEntity> externEntities;

   312     QMap<QString,QString> entities;

   313 

   314     // used for parsing of entity references

   315     struct XmlRef {

   316         XmlRef()

   317             : index(0) {}

   318         XmlRef(const QString &_name, const QString &_value)

   319             : name(_name), value(_value), index(0) {}

   320         bool isEmpty() const { return index == value.length(); }

   321         QChar next() { return value.at(index++); }

   322         QString name;

   323         QString value;

   324         int index;

   325     };

   326     QStack<XmlRef> xmlRefStack;

   327 

   328     // used for standalone declaration

   329     enum Standalone { Yes, No, Unknown };

   330 

   331     QString doctype; // only used for the doctype

   332     QString xmlVersion; // only used to store the version information

   333     QString encoding; // only used to store the encoding

   334     Standalone standalone; // used to store the value of the standalone declaration

   335 

   336     QString publicId; // used by parseExternalID() to store the public ID

   337     QString systemId; // used by parseExternalID() to store the system ID

   338 

   339     // Since publicId/systemId is used as temporary variables by parseExternalID(), it

   340     // might overwrite the PUBLIC/SYSTEM for the document we're parsing. In effect, we would

   341     // possibly send off an QXmlParseException that has the PUBLIC/SYSTEM of a entity declaration

   342     // instead of those of the current document.

   343     // Hence we have these two variables for storing the document's data.

   344     QString thisPublicId;

   345     QString thisSystemId;

   346 

   347     QString attDeclEName; // use by parseAttlistDecl()

   348     QString attDeclAName; // use by parseAttlistDecl()

   349 

   350     // flags for some features support

   351     bool useNamespaces;

   352     bool useNamespacePrefixes;

   353     bool reportWhitespaceCharData;

   354     bool reportEntities;

   355 

   356     // used to build the attribute list

   357     QXmlAttributes attList;

   358 

   359     // used in QXmlSimpleReader::parseContent() to decide whether character

   360     // data was read

   361     bool contentCharDataRead;

   362 

   363     // helper classes

   364     QScopedPointer<QXmlLocator> locator;

   365     QXmlNamespaceSupport namespaceSupport;

   366 

   367     // error string

   368     QString error;

   369 

   370     // arguments for parse functions (this is needed to allow incremental

   371     // parsing)

   372     bool parsePI_xmldecl;

   373     bool parseName_useRef;

   374     bool parseReference_charDataRead;

   375     EntityRecognitionContext parseReference_context;

   376     bool parseExternalID_allowPublicID;

   377     EntityRecognitionContext parsePEReference_context;

   378     QString parseString_s;

   379 

   380     // for incremental parsing

   381     struct ParseState {

   382         typedef bool (QXmlSimpleReaderPrivate::*ParseFunction)();

   383         ParseFunction function;

   384         int state;

   385     };

   386     QStack<ParseState> *parseStack;

   387 

   388     // used in parseProlog()

   389     bool xmldecl_possible;

   390     bool doctype_read;

   391 

   392     // used in parseDoctype()

   393     bool startDTDwasReported;

   394 

   395     // used in parseString()

   396     signed char Done;

   397 

   398 

   399     // variables

   400     QXmlContentHandler *contentHnd;

   401     QXmlErrorHandler   *errorHnd;

   402     QXmlDTDHandler     *dtdHnd;

   403     QXmlEntityResolver *entityRes;

   404     QXmlLexicalHandler *lexicalHnd;

   405     QXmlDeclHandler    *declHnd;

   406 

   407     QXmlInputSource *inputSource;

   408 

   409     QChar c; // the character at reading position

   410     int   lineNr; // number of line

   411     int   columnNr; // position in line

   412 

   413     QChar   nameArray[256]; // only used for names

   414     QString nameValue; // only used for names

   415     int     nameArrayPos;

   416     int     nameValueLen;

   417     QChar   refArray[256]; // only used for references

   418     QString refValue; // only used for references

   419     int     refArrayPos;

   420     int     refValueLen;

   421     QChar   stringArray[256]; // used for any other strings that are parsed

   422     QString stringValue; // used for any other strings that are parsed

   423     int     stringArrayPos;

   424     int     stringValueLen;

   425     QString emptyStr;

   426 

   427     const QString &string();

   428     void stringClear();

   429     void stringAddC(QChar);

   430     inline void stringAddC() { stringAddC(c); }

   431     const QString &name();

   432     void nameClear();

   433     void nameAddC(QChar);

   434     inline void nameAddC() { nameAddC(c); }

   435     const QString &ref();

   436     void refClear();

   437     void refAddC(QChar);

   438     inline void refAddC() { refAddC(c); }

   439 

   440     // private functions

   441     bool eat_ws();

   442     bool next_eat_ws();

   443 

   444     void QT_FASTCALL next();

   445     bool atEnd();

   446 

   447     void init(const QXmlInputSource* i);

   448     void initData();

   449 

   450     bool entityExist(const QString&) const;

   451 

   452     bool parseBeginOrContinue(int state, bool incremental);

   453 

   454     bool parseProlog();

   455     bool parseElement();

   456     bool processElementEmptyTag();

   457     bool processElementETagBegin2();

   458     bool processElementAttribute();

   459     bool parseMisc();

   460     bool parseContent();

   461 

   462     bool parsePI();

   463     bool parseDoctype();

   464     bool parseComment();

   465 

   466     bool parseName();

   467     bool parseNmtoken();

   468     bool parseAttribute();

   469     bool parseReference();

   470     bool processReference();

   471 

   472     bool parseExternalID();

   473     bool parsePEReference();

   474     bool parseMarkupdecl();

   475     bool parseAttlistDecl();

   476     bool parseAttType();

   477     bool parseAttValue();

   478     bool parseElementDecl();

   479     bool parseNotationDecl();

   480     bool parseChoiceSeq();

   481     bool parseEntityDecl();

   482     bool parseEntityValue();

   483 

   484     bool parseString();

   485 

   486     bool insertXmlRef(const QString&, const QString&, bool);

   487 

   488     bool reportEndEntities();

   489     void reportParseError(const QString& error);

   490 

   491     typedef bool (QXmlSimpleReaderPrivate::*ParseFunction) ();

   492     void unexpectedEof(ParseFunction where, int state);

   493     void parseFailed(ParseFunction where, int state);

   494     void pushParseState(ParseFunction function, int state);

   495 

   496     Q_DECLARE_PUBLIC(QXmlSimpleReader)

   497     QXmlSimpleReader *q_ptr;

   498 

   499     friend class QXmlSimpleReaderLocator;

   500 };

   501 

   502 /*!

   503     \class QXmlParseException

   504     \reentrant

   505     \brief The QXmlParseException class is used to report errors with

   506     the QXmlErrorHandler interface.

   507 

   508     \inmodule QtXml

   509     \ingroup xml-tools

   510 

   511     The XML subsystem constructs an instance of this class when it

   512     detects an error. You can retrieve the place where the error

   513     occurred using systemId(), publicId(), lineNumber() and

   514     columnNumber(), along with the error message(). The possible error

   515     messages are:

   516 

   517 

   518     \list

   519         \o "no error occurred"

   520         \o "error triggered by consumer"

   521         \o "unexpected end of file"

   522         \o "more than one document type definition"

   523         \o "error occurred while parsing element"

   524         \o "tag mismatch"

   525         \o "error occurred while parsing content"

   526         \o "unexpected character"

   527         \o "invalid name for processing instruction"

   528         \o "version expected while reading the XML declaration"

   529         \o "wrong value for standalone declaration"

   530         \o "encoding declaration or standalone declaration expected while reading the XML declaration"

   531         \o "standalone declaration expected while reading the XML declaration"

   532         \o "error occurred while parsing document type definition"

   533         \o "letter is expected"

   534         \o "error occurred while parsing comment"

   535         \o "error occurred while parsing reference"

   536         \o "internal general entity reference not allowed in DTD"

   537         \o "external parsed general entity reference not allowed in attribute value"

   538         \o "external parsed general entity reference not allowed in DTD"

   539         \o "unparsed entity reference n wrong context"

   540         \o "recursive entities"

   541         \o "error in the text declaration of an external entity"

   542     \endlist

   543 

   544     Note that, if you want to display these error messages to your

   545     application's users, they will be displayed in English unless

   546     they are explicitly translated.

   547 

   548     \sa QXmlErrorHandler, QXmlReader

   549 */

   550 

   551 /*!

   552     Constructs a parse exception with the error string \a name for

   553     column \a c and line \a l for the public identifier \a p and the

   554     system identifier \a s.

   555 */

   556 

   557 QXmlParseException::QXmlParseException(const QString& name, int c, int l,

   558                                        const QString& p, const QString& s)

   559     : d(new QXmlParseExceptionPrivate)

   560 {

   561     d->msg = name;

   562     d->column = c;

   563     d->line = l;

   564     d->pub = p;

   565     d->sys = s;

   566 }

   567 

   568 /*!

   569     Creates a copy of \a other.

   570 */

   571 QXmlParseException::QXmlParseException(const QXmlParseException& other) :

   572      d(new QXmlParseExceptionPrivate(*other.d))

   573 {

   574 

   575 }

   576 

   577 /*!

   578     Destroys the QXmlParseException.

   579 */

   580 QXmlParseException::~QXmlParseException()

   581 {

   582 }

   583 

   584 /*!

   585     Returns the error message.

   586 */

   587 QString QXmlParseException::message() const

   588 {

   589     return d->msg;

   590 }

   591 /*!

   592     Returns the column number where the error occurred.

   593 */

   594 int QXmlParseException::columnNumber() const

   595 {

   596     return d->column;

   597 }

   598 /*!

   599     Returns the line number where the error occurred.

   600 */

   601 int QXmlParseException::lineNumber() const

   602 {

   603     return d->line;

   604 }

   605 /*!

   606     Returns the public identifier where the error occurred.

   607 */

   608 QString QXmlParseException::publicId() const

   609 {

   610     return d->pub;

   611 }

   612 /*!

   613     Returns the system identifier where the error occurred.

   614 */

   615 QString QXmlParseException::systemId() const

   616 {

   617     return d->sys;

   618 }

   619 

   620 

   621 /*!

   622     \class QXmlLocator

   623     \reentrant

   624     \brief The QXmlLocator class provides the XML handler classes with

   625     information about the parsing position within a file.

   626 

   627     \inmodule QtXml

   628     \ingroup xml-tools

   629 

   630     The reader reports a QXmlLocator to the content handler before it

   631     starts to parse the document. This is done with the

   632     QXmlContentHandler::setDocumentLocator() function. The handler

   633     classes can now use this locator to get the position (lineNumber()

   634     and columnNumber()) that the reader has reached.

   635 */

   636 

   637 /*!

   638     Constructor.

   639 */

   640 QXmlLocator::QXmlLocator()

   641 {

   642 }

   643 

   644 /*!

   645     Destructor.

   646 */

   647 QXmlLocator::~QXmlLocator()

   648 {

   649 }

   650 

   651 /*!

   652     \fn int QXmlLocator::columnNumber() const

   653 

   654     Returns the column number (starting at 1) or -1 if there is no

   655     column number available.

   656 */

   657 

   658 /*!

   659     \fn int QXmlLocator::lineNumber() const

   660 

   661     Returns the line number (starting at 1) or -1 if there is no line

   662     number available.

   663 */

   664 

   665 class QXmlSimpleReaderLocator : public QXmlLocator

   666 {

   667 public:

   668     QXmlSimpleReaderLocator(QXmlSimpleReader* parent)

   669     {

   670         reader = parent;

   671     }

   672     ~QXmlSimpleReaderLocator()

   673     {

   674     }

   675 

   676     int columnNumber() const

   677     {

   678         return (reader->d_ptr->columnNr == -1 ? -1 : reader->d_ptr->columnNr + 1);

   679     }

   680     int lineNumber() const

   681     {

   682         return (reader->d_ptr->lineNr == -1 ? -1 : reader->d_ptr->lineNr + 1);

   683     }

   684 //    QString getPublicId()

   685 //    QString getSystemId()

   686 

   687 private:

   688     QXmlSimpleReader *reader;

   689 };

   690 

   691 /*********************************************

   692  *

   693  * QXmlNamespaceSupport

   694  *

   695  *********************************************/

   696 

   697 typedef QMap<QString, QString> NamespaceMap;

   698 

   699 class QXmlNamespaceSupportPrivate

   700 {

   701 public:

   702     QXmlNamespaceSupportPrivate()

   703     {

   704         ns.insert(QLatin1String("xml"), QLatin1String("http://www.w3.org/XML/1998/namespace")); // the XML namespace

   705     }

   706 

   707     ~QXmlNamespaceSupportPrivate()

   708     {

   709     }

   710 

   711     QStack<NamespaceMap> nsStack;

   712     NamespaceMap ns;

   713 };

   714 

   715 /*!

   716     \class QXmlNamespaceSupport

   717     \since 4.4

   718     \reentrant

   719     \brief The QXmlNamespaceSupport class is a helper class for XML

   720     readers which want to include namespace support.

   721 

   722     \inmodule QtXml

   723     \ingroup xml-tools

   724 

   725     You can set the prefix for the current namespace with setPrefix(),

   726     and get the list of current prefixes (or those for a given URI)

   727     with prefixes(). The namespace URI is available from uri(). Use

   728     pushContext() to start a new namespace context, and popContext()

   729     to return to the previous namespace context. Use splitName() or

   730     processName() to split a name into its prefix and local name.

   731 

   732     \sa {Namespace Support via Features}

   733 */

   734 

   735 /*!

   736     Constructs a QXmlNamespaceSupport.

   737 */

   738 QXmlNamespaceSupport::QXmlNamespaceSupport()

   739 {

   740     d = new QXmlNamespaceSupportPrivate;

   741 }

   742 

   743 /*!

   744     Destroys a QXmlNamespaceSupport.

   745 */

   746 QXmlNamespaceSupport::~QXmlNamespaceSupport()

   747 {

   748     delete d;

   749 }

   750 

   751 /*!

   752     This function declares a prefix \a pre in the current namespace

   753     context to be the namespace URI \a uri. The prefix remains in

   754     force until this context is popped, unless it is shadowed in a

   755     descendant context.

   756 

   757     Note that there is an asymmetry in this library. prefix() does not

   758     return the default "" prefix, even if you have declared one; to

   759     check for a default prefix, you must look it up explicitly using

   760     uri(). This asymmetry exists to make it easier to look up prefixes

   761     for attribute names, where the default prefix is not allowed.

   762 */

   763 void QXmlNamespaceSupport::setPrefix(const QString& pre, const QString& uri)

   764 {

   765     if(pre.isNull()) {

   766         d->ns.insert(QLatin1String(""), uri);

   767     } else {

   768         d->ns.insert(pre, uri);

   769     }

   770 }

   771 

   772 /*!

   773     Returns one of the prefixes mapped to the namespace URI \a uri.

   774 

   775     If more than one prefix is currently mapped to the same URI, this

   776     function makes an arbitrary selection; if you want all of the

   777     prefixes, use prefixes() instead.

   778 

   779     Note: to check for a default prefix, use the uri() function with

   780     an argument of "".

   781 */

   782 QString QXmlNamespaceSupport::prefix(const QString& uri) const

   783 {

   784     NamespaceMap::const_iterator itc, it = d->ns.constBegin();

   785     while ((itc=it) != d->ns.constEnd()) {

   786         ++it;

   787         if (*itc == uri && !itc.key().isEmpty())

   788             return itc.key();

   789     }

   790     return QLatin1String("");

   791 }

   792 

   793 /*!

   794     Looks up the prefix \a prefix in the current context and returns

   795     the currently-mapped namespace URI. Use the empty string ("") for

   796     the default namespace.

   797 */

   798 QString QXmlNamespaceSupport::uri(const QString& prefix) const

   799 {

   800     return d->ns[prefix];

   801 }

   802 

   803 /*!

   804     Splits the name \a qname at the ':' and returns the prefix in \a

   805     prefix and the local name in \a localname.

   806 

   807     \sa processName()

   808 */

   809 void QXmlNamespaceSupport::splitName(const QString& qname, QString& prefix,

   810                                      QString& localname) const

   811 {

   812     int pos = qname.indexOf(QLatin1Char(':'));

   813     if (pos == -1)

   814         pos = qname.size();

   815 

   816     prefix = qname.left(pos);

   817     localname = qname.mid(pos+1);

   818 }

   819 

   820 /*!

   821     Processes a raw XML 1.0 name in the current context by removing

   822     the prefix and looking it up among the prefixes currently

   823     declared.

   824 

   825     \a qname is the raw XML 1.0 name to be processed. \a isAttribute

   826     is true if the name is an attribute name.

   827 

   828     This function stores the namespace URI in \a nsuri (which will be

   829     set to an empty string if the raw name has an undeclared prefix),

   830     and stores the local name (without prefix) in \a localname (which

   831     will be set to an empty string if no namespace is in use).

   832 

   833     Note that attribute names are processed differently than element

   834     names: an unprefixed element name gets the default namespace (if

   835     any), while an unprefixed attribute name does not.

   836 */

   837 void QXmlNamespaceSupport::processName(const QString& qname,

   838         bool isAttribute,

   839         QString& nsuri, QString& localname) const

   840 {

   841     int len = qname.size();

   842     const QChar *data = qname.constData();

   843     for (int pos = 0; pos < len; ++pos) {

   844         if (data[pos] == QLatin1Char(':')) {

   845             nsuri = uri(qname.left(pos));

   846             localname = qname.mid(pos + 1);

   847             return;

   848         }

   849     }

   850 

   851     // there was no ':'

   852     nsuri.clear();

   853     // attributes don't take default namespace

   854     if (!isAttribute && !d->ns.isEmpty()) {

   855 	/*

   856 	    We want to access d->ns.value(""), but as an optimization

   857 	    we use the fact that "" compares less than any other

   858 	    string, so it's either first in the map or not there.

   859 	*/

   860         NamespaceMap::const_iterator first = d->ns.constBegin();

   861         if (first.key().isEmpty())

   862             nsuri = first.value(); // get default namespace

   863     }

   864     localname = qname;

   865 }

   866 

   867 /*!

   868     Returns a list of all the prefixes currently declared.

   869 

   870     If there is a default prefix, this function does not return it in

   871     the list; check for the default prefix using uri() with an

   872     argument of "".

   873 */

   874 QStringList QXmlNamespaceSupport::prefixes() const

   875 {

   876     QStringList list;

   877 

   878     NamespaceMap::const_iterator itc, it = d->ns.constBegin();

   879     while ((itc=it) != d->ns.constEnd()) {

   880         ++it;

   881         if (!itc.key().isEmpty())

   882             list.append(itc.key());

   883     }

   884     return list;

   885 }

   886 

   887 /*!

   888     \overload

   889 

   890     Returns a list of all prefixes currently declared for the

   891     namespace URI \a uri.

   892 

   893     The "xml:" prefix is included. If you only want one prefix that is

   894     mapped to the namespace URI, and you don't care which one you get,

   895     use the prefix() function instead.

   896 

   897     Note: The empty (default) prefix is never included in this list;

   898     to check for the presence of a default namespace, call uri() with

   899     "" as the argument.

   900 */

   901 QStringList QXmlNamespaceSupport::prefixes(const QString& uri) const

   902 {

   903     QStringList list;

   904 

   905     NamespaceMap::const_iterator itc, it = d->ns.constBegin();

   906     while ((itc=it) != d->ns.constEnd()) {

   907         ++it;

   908         if (*itc == uri && !itc.key().isEmpty())

   909             list.append(itc.key());

   910     }

   911     return list;

   912 }

   913 

   914 /*!

   915     Starts a new namespace context.

   916 

   917     Normally, you should push a new context at the beginning of each

   918     XML element: the new context automatically inherits the

   919     declarations of its parent context, and it also keeps track of

   920     which declarations were made within this context.

   921 

   922     \sa popContext()

   923 */

   924 void QXmlNamespaceSupport::pushContext()

   925 {

   926     d->nsStack.push(d->ns);

   927 }

   928 

   929 /*!

   930     Reverts to the previous namespace context.

   931 

   932     Normally, you should pop the context at the end of each XML

   933     element. After popping the context, all namespace prefix mappings

   934     that were previously in force are restored.

   935 

   936     \sa pushContext()

   937 */

   938 void QXmlNamespaceSupport::popContext()

   939 {

   940     d->ns.clear();

   941     if(!d->nsStack.isEmpty())

   942         d->ns = d->nsStack.pop();

   943 }

   944 

   945 /*!

   946     Resets this namespace support object ready for reuse.

   947 */

   948 void QXmlNamespaceSupport::reset()

   949 {

   950     QXmlNamespaceSupportPrivate *newD = new QXmlNamespaceSupportPrivate;

   951     delete d;

   952     d = newD;

   953 }

   954 

   955 

   956 

   957 /*********************************************

   958  *

   959  * QXmlAttributes

   960  *

   961  *********************************************/

   962 

   963 /*!

   964     \class QXmlAttributes

   965     \reentrant

   966     \brief The QXmlAttributes class provides XML attributes.

   967 

   968     \inmodule QtXml

   969     \ingroup xml-tools

   970 

   971     If attributes are reported by QXmlContentHandler::startElement()

   972     this class is used to pass the attribute values.

   973 

   974     Use index() to locate the position of an attribute in the list,

   975     count() to retrieve the number of attributes, and clear() to

   976     remove the attributes. New attributes can be added with append().

   977     Use type() to get an attribute's type and value() to get its

   978     value. The attribute's name is available from localName() or

   979     qName(), and its namespace URI from uri().

   980 

   981 */

   982 

   983 /*!

   984     \fn QXmlAttributes::QXmlAttributes()

   985 

   986     Constructs an empty attribute list.

   987 */

   988 

   989 /*!

   990     \fn QXmlAttributes::~QXmlAttributes()

   991 

   992     Destroys the attributes object.

   993 */

   994 

   995 /*!

   996     Looks up the index of an attribute by the qualified name \a qName.

   997 

   998     Returns the index of the attribute or -1 if it wasn't found.

   999 

  1000     \sa {Namespace Support via Features}

  1001 */

  1002 int QXmlAttributes::index(const QString& qName) const

  1003 {

  1004     for (int i = 0; i < attList.size(); ++i) {

  1005         if (attList.at(i).qname == qName)

  1006             return i;

  1007     }

  1008     return -1;

  1009 }

  1010 

  1011 /*! \overload

  1012   */

  1013 int QXmlAttributes::index(const QLatin1String& qName) const

  1014 {

  1015     for (int i = 0; i < attList.size(); ++i) {

  1016         if (attList.at(i).qname == qName)

  1017             return i;

  1018     }

  1019     return -1;

  1020 }

  1021 

  1022 /*!

  1023     \overload

  1024 

  1025     Looks up the index of an attribute by a namespace name.

  1026 

  1027     \a uri specifies the namespace URI, or an empty string if the name

  1028     has no namespace URI. \a localPart specifies the attribute's local

  1029     name.

  1030 

  1031     Returns the index of the attribute, or -1 if it wasn't found.

  1032 

  1033     \sa {Namespace Support via Features}

  1034 */

  1035 int QXmlAttributes::index(const QString& uri, const QString& localPart) const

  1036 {

  1037     for (int i = 0; i < attList.size(); ++i) {

  1038         const Attribute &att = attList.at(i);

  1039         if (att.uri == uri && att.localname == localPart)

  1040             return i;

  1041     }

  1042     return -1;

  1043 }

  1044 

  1045 /*!

  1046     Returns the number of attributes in the list.

  1047 

  1048     \sa count()

  1049 */

  1050 int QXmlAttributes::length() const

  1051 {

  1052     return attList.count();

  1053 }

  1054 

  1055 /*!

  1056     \fn int QXmlAttributes::count() const

  1057 

  1058     Returns the number of attributes in the list. This function is

  1059     equivalent to length().

  1060 */

  1061 

  1062 /*!

  1063     Looks up an attribute's local name for the attribute at position

  1064     \a index. If no namespace processing is done, the local name is

  1065     an empty string.

  1066 

  1067     \sa {Namespace Support via Features}

  1068 */

  1069 QString QXmlAttributes::localName(int index) const

  1070 {

  1071     return attList.at(index).localname;

  1072 }

  1073 

  1074 /*!

  1075     Looks up an attribute's XML 1.0 qualified name for the attribute

  1076     at position \a index.

  1077 

  1078     \sa {Namespace Support via Features}

  1079 */

  1080 QString QXmlAttributes::qName(int index) const

  1081 {

  1082     return attList.at(index).qname;

  1083 }

  1084 

  1085 /*!

  1086     Looks up an attribute's namespace URI for the attribute at

  1087     position \a index. If no namespace processing is done or if the

  1088     attribute has no namespace, the namespace URI is an empty string.

  1089 

  1090     \sa {Namespace Support via Features}

  1091 */

  1092 QString QXmlAttributes::uri(int index) const

  1093 {

  1094     return attList.at(index).uri;

  1095 }

  1096 

  1097 /*!

  1098     Looks up an attribute's type for the attribute at position \a

  1099     index.

  1100 

  1101     Currently only "CDATA" is returned.

  1102 */

  1103 QString QXmlAttributes::type(int) const

  1104 {

  1105     return QLatin1String("CDATA");

  1106 }

  1107 

  1108 /*!

  1109     \overload

  1110 

  1111     Looks up an attribute's type for the qualified name \a qName.

  1112 

  1113     Currently only "CDATA" is returned.

  1114 */

  1115 QString QXmlAttributes::type(const QString&) const

  1116 {

  1117     return QLatin1String("CDATA");

  1118 }

  1119 

  1120 /*!

  1121     \overload

  1122 

  1123     Looks up an attribute's type by namespace name.

  1124 

  1125     \a uri specifies the namespace URI and \a localName specifies the

  1126     local name. If the name has no namespace URI, use an empty string

  1127     for \a uri.

  1128 

  1129     Currently only "CDATA" is returned.

  1130 */

  1131 QString QXmlAttributes::type(const QString&, const QString&) const

  1132 {

  1133     return QLatin1String("CDATA");

  1134 }