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     QTextFrame *root = textDocument->rootFrame();
73 
74     if (root)
75         processFrame(documentElement, root);
76 
77     return document;
78 }
79 
processBlock(QDomElement & parent,const QTextBlock & block)80 void XmlWriter::processBlock(QDomElement &parent, const QTextBlock &block)
81 {
82     QDomElement blockElement = document->createElement("block");
83     blockElement.setAttribute("position", block.position());
84     blockElement.setAttribute("length", block.length());
85     parent.appendChild(blockElement);
86 
87     QTextBlock::iterator it;
88     for (it = block.begin(); !(it.atEnd()); ++it) {
89         QTextFragment fragment = it.fragment();
90 
91         if (fragment.isValid()) {
92             QDomElement fragmentElement = document->createElement("fragment");
93             blockElement.appendChild(fragmentElement);
94 
95             fragmentElement.setAttribute("length", fragment.length());
96             QDomText fragmentText = document->createTextNode(fragment.text());
97 
98             fragmentElement.appendChild(fragmentText);
99         }
100     }
101 }
102 
processFrame(QDomElement & parent,QTextFrame * frame)103 void XmlWriter::processFrame(QDomElement &parent, QTextFrame *frame)
104 {
105     QDomElement frameElement = document->createElement("frame");
106     frameElement.setAttribute("begin", frame->firstPosition());
107     frameElement.setAttribute("end", frame->lastPosition());
108     parent.appendChild(frameElement);
109 
110 //! [0]
111     QDomElement frameElement = ...
112 
113     QTextFrame::iterator it;
114     for (it = frame->begin(); !(it.atEnd()); ++it) {
115 
116         QTextFrame *childFrame = it.currentFrame();
117         QTextBlock childBlock = it.currentBlock();
118 
119         if (childFrame) {
120             QTextTable *childTable = qobject_cast<QTextTable*>(childFrame);
121 
122             if (childTable)
123                 processTable(frameElement, childTable);
124             else
125                 processFrame(frameElement, childFrame);
126 
127         } else if (childBlock.isValid())
128 //! [0] //! [1]
129             processBlock(frameElement, childBlock);
130     }
131 //! [1]
132 }
133 
processTable(QDomElement & parent,QTextTable * table)134 void XmlWriter::processTable(QDomElement &parent, QTextTable *table)
135 {
136     QDomElement element = document->createElement("table");
137 
138     for (int row = 0; row < table->rows(); ++row) {
139         for (int column = 0; column < table->columns(); ++column) {
140             QTextTableCell cell = table->cellAt(row, column);
141             processTableCell(element, cell);
142         }
143     }
144     parent.appendChild(element);
145 }
146 
processTableCell(QDomElement & parent,const QTextTableCell & cell)147 void XmlWriter::processTableCell(QDomElement &parent, const QTextTableCell &cell)
148 {
149     QDomElement element = document->createElement("cell");
150     element.setAttribute("row", cell.row());
151     element.setAttribute("column", cell.column());
152 
153     QTextFrame::iterator it;
154     for (it = cell.begin(); !(it.atEnd()); ++it) {
155 
156         QTextFrame *childFrame = it.currentFrame();
157         QTextBlock childBlock = it.currentBlock();
158 
159         if (childFrame)
160             processFrame(element, childFrame);
161         else if (childBlock.isValid())
162             processBlock(element, childBlock);
163     }
164     parent.appendChild(element);
165 }
166