1 /****************************************************************************
2 **
3 ** Copyright (C) 2016 The Qt Company Ltd.
4 ** Contact: https://www.qt.io/licensing/
5 **
6 ** This file is part of the documentation of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:BSD$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and The Qt Company. For licensing terms
14 ** and conditions see https://www.qt.io/terms-conditions. For further
15 ** information use the contact form at https://www.qt.io/contact-us.
16 **
17 ** BSD License Usage
18 ** Alternatively, you may use this file under the terms of the BSD license
19 ** as follows:
20 **
21 ** "Redistribution and use in source and binary forms, with or without
22 ** modification, are permitted provided that the following conditions are
23 ** met:
24 **   * Redistributions of source code must retain the above copyright
25 **     notice, this list of conditions and the following disclaimer.
26 **   * Redistributions in binary form must reproduce the above copyright
27 **     notice, this list of conditions and the following disclaimer in
28 **     the documentation and/or other materials provided with the
29 **     distribution.
30 **   * Neither the name of The Qt Company Ltd nor the names of its
31 **     contributors may be used to endorse or promote products derived
32 **     from this software without specific prior written permission.
33 **
34 **
35 ** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
36 ** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
37 ** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
38 ** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
39 ** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
40 ** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
41 ** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
42 ** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
43 ** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
44 ** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
45 ** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
46 **
47 ** $QT_END_LICENSE$
48 **
49 ****************************************************************************/
50 
51 #include <QtGui>
52 
53 #include "xmlwriter.h"
54 
toXml()55 QDomDocument *XmlWriter::toXml()
56 {
57     QDomImplementation implementation;
58     QDomDocumentType docType = implementation.createDocumentType(
59         "scribe-document", "scribe", "qt.nokia.com/scribe");
60 
61     document = new QDomDocument(docType);
62 
63     // ### This processing instruction is required to ensure that any kind
64     // of encoding is given when the document is written.
65     QDomProcessingInstruction process = document->createProcessingInstruction(
66         "xml", "version=\"1.0\" encoding=\"utf-8\"");
67     document->appendChild(process);
68 
69     QDomElement documentElement = document->createElement("document");
70     document->appendChild(documentElement);
71 
72 //! [0]
73     QTextBlock currentBlock = textDocument->begin();
74 
75     while (currentBlock.isValid()) {
76 //! [0]
77         QDomElement blockElement = document->createElement("block");
78         document->appendChild(blockElement);
79 
80         readFragment(currentBlock, blockElement, document);
81 
82 //! [1]
83         processBlock(currentBlock);
84 //! [1]
85 
86 //! [2]
87         currentBlock = currentBlock.next();
88     }
89 //! [2]
90 
91     return document;
92 }
93 
readFragment(const QTextBlock & currentBlock,QDomElement blockElement,QDomDocument * document)94 void XmlWriter::readFragment(const QTextBlock &currentBlock,
95                              QDomElement blockElement,
96                              QDomDocument *document)
97 {
98 //! [3] //! [4]
99     QTextBlock::iterator it;
100     for (it = currentBlock.begin(); !(it.atEnd()); ++it) {
101         QTextFragment currentFragment = it.fragment();
102         if (currentFragment.isValid())
103 //! [3] //! [5]
104             processFragment(currentFragment);
105 //! [4] //! [5]
106 
107         if (currentFragment.isValid()) {
108             QDomElement fragmentElement = document->createElement("fragment");
109             blockElement.appendChild(fragmentElement);
110 
111             fragmentElement.setAttribute("length", currentFragment.length());
112             QDomText fragmentText = document->createTextNode(currentFragment.text());
113 
114             fragmentElement.appendChild(fragmentText);
115         }
116 //! [6] //! [7]
117     }
118 //! [7] //! [6]
119 }
120 
processBlock(const QTextBlock & currentBlock)121 void XmlWriter::processBlock(const QTextBlock &currentBlock)
122 {
123 }
124 
processFragment(const QTextFragment & currentFragment)125 void XmlWriter::processFragment(const QTextFragment &currentFragment)
126 {
127 }
128