|
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/htmlinfo |
|
44 \title XML HTML Info Example |
|
45 |
|
46 The XML HTML Info example provides a simple command line utility that |
|
47 scans the current directory for HTML files and prints statistics about |
|
48 them to standard out. |
|
49 |
|
50 \note Standard out is redirected on some platforms. On Symbian using Open |
|
51 C \c stdout is by default directed to the console window, but this window |
|
52 may not always be visible. To redirect to a file instead, locate the \c |
|
53 c:\\system\\data\\config.ini file (on either the emulator or the device) |
|
54 and change \c STDOUT to point to \c MEDIA4. This will redirect the console |
|
55 to \c c:\\system\\data\\out.txt. |
|
56 |
|
57 The files are parsed using a QXmlStreamReader object. If the file does |
|
58 not contain a well-formed XML document, a description of the error is |
|
59 printed to the standard error console. |
|
60 |
|
61 \section1 Basic Operation |
|
62 |
|
63 The main function of the example uses QDir to access files in the current |
|
64 directory that match either "*.htm" or "*.html". For each file found, |
|
65 the \c parseHtmlFile() function is called. |
|
66 |
|
67 Reading XML is handled by an instance of the QXmlStreamReader class, which |
|
68 operates on the input file object: |
|
69 |
|
70 \snippet examples/xml/htmlinfo/main.cpp 0 |
|
71 |
|
72 The work of parsing and the XML and extracting statistics is done in a |
|
73 while loop, and is driven by input from the reader: |
|
74 |
|
75 \snippet examples/xml/htmlinfo/main.cpp 1 |
|
76 |
|
77 If more input is available, the next token from the input file is read |
|
78 and parsed. The program then looks for the specific element types, |
|
79 "title", "a", and "p", and stores information about them. |
|
80 |
|
81 When there is no more input, the loop terminates. If an error occurred, |
|
82 information is written to the standard out file via a stream, and the |
|
83 example exits: |
|
84 |
|
85 \snippet examples/xml/htmlinfo/main.cpp 2 |
|
86 |
|
87 If no error occurred, the example prints some statistics from the data |
|
88 gathered in the loop, and then exits. |
|
89 */ |