|
1 /**************************************************************************** |
|
2 ** |
|
3 ** Copyright (C) 2010 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 documentation 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 /*! |
|
43 \example xml/xmlstreamlint |
|
44 \title XML Stream Lint Example |
|
45 |
|
46 The XML Stream Lint example provides a simple command line utility that |
|
47 accepts a file name as its single argument and writes it to the standard |
|
48 output file. |
|
49 |
|
50 The specified file is parsed using an QXmlStreamReader object and written |
|
51 to the standard output file using an QXmlStreamWriter object. If the file |
|
52 does not contain a well-formed XML document or the use of namespaces in |
|
53 the document is incorrect, a description of the error is printed to |
|
54 the standard error file and will appear in the console. |
|
55 |
|
56 \section1 Basic Operation |
|
57 |
|
58 The main function of the example opens the file specified by the user |
|
59 for input (\c inputFile), and it uses QFile to access the standard output |
|
60 file. |
|
61 |
|
62 Reading XML is handled by an instance of the QXmlStreamReader class, which |
|
63 operates on the input file object; writing is handled by an instance of |
|
64 QXmlStreamWriter operating on the output file object: |
|
65 |
|
66 \snippet examples/xml/xmlstreamlint/main.cpp 0 |
|
67 |
|
68 The work of parsing and rewriting the XML is done in a while loop, and is |
|
69 driven by input from the reader: |
|
70 |
|
71 \snippet examples/xml/xmlstreamlint/main.cpp 1 |
|
72 |
|
73 If more input is available, the next token from the input file is read |
|
74 and parsed. If an error occurred, information is written to the standard |
|
75 error file via a stream, and the example exits by returning a non-zero |
|
76 value from the main function. |
|
77 |
|
78 \snippet examples/xml/xmlstreamlint/main.cpp 2 |
|
79 |
|
80 For valid input, the writer is fed the current token from the reader, |
|
81 and this is written to the output file that was specified when it was |
|
82 constructed. |
|
83 |
|
84 When there is no more input, the loop terminates, and the example can |
|
85 exit successfully. |
|
86 */ |