<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- filetree.qdoc -->
<title>File System Example | Qt XML Patterns 5.12.6</title>
<link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
<script type="text/javascript">
document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");
// loading style sheet breaks anchors that were jumped to before
// so force jumping to anchor again
setTimeout(function() {
var anchor = location.hash;
// need to jump to different anchor first (e.g. none)
location.hash = "#";
setTimeout(function() {
location.hash = anchor;
}, 0);
}, 0);
</script>
</head>
<body>
<div class="header" id="qtdocheader">
<div class="main">
<div class="main-rounded">
<div class="navigationbar">
<table><tr>
<td >Qt 5.12</td><td ><a href="qtxmlpatterns-index.html">Qt XML Patterns</a></td><td ><a href="xmlpattern-examples.html">Qt XML Patterns Examples</a></td><td >File System Example</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right"><a href="qtxmlpatterns-index.html">Qt 5.12.6 Reference Documentation</a></td>
</tr></table>
</div>
</div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#introduction">Introduction</a></li>
<li class="level2"><a href="#the-user-interface">The User Interface</a></li>
<li class="level2"><a href="#running-your-own-xqueries">Running your own XQueries</a></li>
<li class="level1"><a href="#code-walk-through">Code Walk-Through</a></li>
<li class="level2"><a href="#the-custom-node-model-class-filetree">The Custom Node Model Class: FileTree</a></li>
<li class="level2"><a href="#the-ui-class-mainwindow">The UI Class: MainWindow</a></li>
<li class="level2"><a href="#node-model-building-strategy">Node Model Building Strategy</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">File System Example</h1>
<span class="subtitle"></span>
<!-- $$$filetree-brief -->
<p>Using Qt XML Patterns for querying non-XML data that is modeled to look like XML.</p>
<!-- @@@filetree -->
<!-- $$$filetree-description -->
<div class="descr"> <a name="details"></a>
<p>This example shows how to use Qt XML Patterns for querying non-XML data that is modeled to look like XML.</p>
<a name="introduction"></a>
<h2 id="introduction">Introduction</h2>
<p>The example models your computer's file system to look like XML and allows you to query the file system with <a href="xmlprocessing.html">XQuery</a>. Suppose we want to find all the <code>cpp</code> files in the subtree beginning at <code>/filetree</code>:</p>
<p class="centerAlign"><img src="images/filetree_1-example.png" alt="" /></p><a name="the-user-interface"></a>
<h3 id="the-user-interface">The User Interface</h3>
<p>The example is shown below. First, we use <code>File->Open Directory</code> (not shown) to select the <code>/filetree</code> directory. Then we use the combobox on the right to select the <a href="xmlprocessing.html">XQuery</a> that searches for <code>cpp</code> files (<code>listCPPFiles.xq</code>). Selecting an <a href="xmlprocessing.html">XQuery</a> runs the query, which in this case traverses the model looking for all the <code>cpp</code> files. The <a href="xmlprocessing.html">XQuery</a> text and the query results are shown on the right:</p>
<p class="centerAlign"><img src="images/filetree_2-example.png" alt="" /></p><p>Don't be mislead by the XML representation of the <code>/filetree</code> directory shown on the left. This is not the node model itself but the XML obtained by traversing the node model and outputting it as XML. Constructing and using the custom node model is explained in the code walk-through.</p>
<a name="running-your-own-xqueries"></a>
<h3 id="running-your-own-xqueries">Running your own XQueries</h3>
<p>You can write your own <a href="xmlprocessing.html">XQuery</a> files and run them in the example program. The file <code>xmlpatterns/filetree/queries.qrc</code> is the resource file for this example. It is used in <code>main.cpp</code> (<code>Q_INIT_RESOURCE(queries);</code>). It lists the <a href="xmlprocessing.html">XQuery</a> files (<code>.xq</code>) that can be selected in the combobox.</p>
<pre class="cpp">
<!DOCTYPE RCC>
<RCC version="1.0">
<qresource>
<file>queries/listCPPFiles.xq</file>
<file>queries/wholeTree.xq</file>
</qresource>
</RCC>
</pre>
<p>To add your own queries to the example's combobox, store your <code>.xq</code> files in the <code>examples/xmlpatterns/filetree/queries</code> directory and add them to <code>queries.qrc</code> as shown above.</p>
<a name="code-walk-through"></a>
<h2 id="code-walk-through">Code Walk-Through</h2>
<p>The strategy is to create a custom node model that represents the directory tree of the computer's file system. That tree structure is non-XML data. The custom node model must have the same callback interface as the XML node models that the Qt XML Patterns query engine uses to execute queries. The query engine can then traverse the custom node model as if it were traversing the node model built from an XML document.</p>
<p>The required callback interface is in <a href="qabstractxmlnodemodel.html">QAbstractXmlNodeModel</a>, so we create a custom node model by subclassing <a href="qabstractxmlnodemodel.html">QAbstractXmlNodeModel</a> and providing implementations for its pure virtual functions. For many cases, the implementations of several of the virtual functions are always the same, so Qt XML Patterns also provides <a href="qsimplexmlnodemodel.html">QSimpleXmlNodeModel</a>, which subclasses <a href="qabstractxmlnodemodel.html">QAbstractXmlNodeModel</a> and provides implementations for the callback functions that you can ignore. By subclassing <a href="qsimplexmlnodemodel.html">QSimpleXmlNodeModel</a> instead of <a href="qabstractxmlnodemodel.html">QAbstractXmlNodeModel</a>, you can reduce development time.</p>
<a name="the-custom-node-model-class-filetree"></a>
<h3 id="the-custom-node-model-class-filetree">The Custom Node Model Class: FileTree</h3>
<p>The custom node model for this example is class <code>FileTree</code>, which is derived from <a href="qsimplexmlnodemodel.html">QSimpleXmlNodeModel</a>. <code>FileTree</code> implements all the callback functions that don't have standard implementations in <a href="qsimplexmlnodemodel.html">QSimpleXmlNodeModel</a>. When you implement your own custom node model, you must provide implementations for these callback functions:</p>
<pre class="cpp">
<span class="keyword">virtual</span> <span class="type"><a href="qxmlnodemodelindex.html">QXmlNodeModelIndex</a></span><span class="operator">::</span>DocumentOrder compareOrder(<span class="keyword">const</span> <span class="type"><a href="qxmlnodemodelindex.html">QXmlNodeModelIndex</a></span><span class="operator">&</span><span class="operator">,</span> <span class="keyword">const</span> <span class="type"><a href="qxmlnodemodelindex.html">QXmlNodeModelIndex</a></span><span class="operator">&</span>) <span class="keyword">const</span>;
<span class="keyword">virtual</span> <span class="type"><a href="qxmlname.html">QXmlName</a></span> name(<span class="keyword">const</span> <span class="type"><a href="qxmlnodemodelindex.html">QXmlNodeModelIndex</a></span> <span class="operator">&</span>node) <span class="keyword">const</span>;
<span class="keyword">virtual</span> <span class="type">QUrl</span> documentUri(<span class="keyword">const</span> <span class="type"><a href="qxmlnodemodelindex.html">QXmlNodeModelIndex</a></span> <span class="operator">&</span>node) <span class="keyword">const</span>;
<span class="keyword">virtual</span> <span class="type"><a href="qxmlnodemodelindex.html">QXmlNodeModelIndex</a></span><span class="operator">::</span>NodeKind kind(<span class="keyword">const</span> <span class="type"><a href="qxmlnodemodelindex.html">QXmlNodeModelIndex</a></span> <span class="operator">&</span>node) <span class="keyword">const</span>;
<span class="keyword">virtual</span> <span class="type"><a href="qxmlnodemodelindex.html">QXmlNodeModelIndex</a></span> root(<span class="keyword">const</span> <span class="type"><a href="qxmlnodemodelindex.html">QXmlNodeModelIndex</a></span> <span class="operator">&</span>node) <span class="keyword">const</span>;
<span class="keyword">virtual</span> <span class="type">QVariant</span> typedValue(<span class="keyword">const</span> <span class="type"><a href="qxmlnodemodelindex.html">QXmlNodeModelIndex</a></span> <span class="operator">&</span>node) <span class="keyword">const</span>;
<span class="keyword">virtual</span> <span class="type">QVector</span><span class="operator"><</span><span class="type"><a href="qxmlnodemodelindex.html">QXmlNodeModelIndex</a></span><span class="operator">></span> attributes(<span class="keyword">const</span> <span class="type"><a href="qxmlnodemodelindex.html">QXmlNodeModelIndex</a></span> <span class="operator">&</span>element) <span class="keyword">const</span>;
<span class="keyword">virtual</span> <span class="type"><a href="qxmlnodemodelindex.html">QXmlNodeModelIndex</a></span> nextFromSimpleAxis(SimpleAxis<span class="operator">,</span> <span class="keyword">const</span> <span class="type"><a href="qxmlnodemodelindex.html">QXmlNodeModelIndex</a></span><span class="operator">&</span>) <span class="keyword">const</span>;
</pre>
<p>The <code>FileTree</code> class declares four data members:</p>
<pre class="cpp">
<span class="keyword">mutable</span> <span class="type">QVector</span><span class="operator"><</span><span class="type">QFileInfo</span><span class="operator">></span> m_fileInfos;
<span class="keyword">const</span> <span class="type">QDir</span><span class="operator">::</span>Filters m_filterAllowAll;
<span class="keyword">const</span> <span class="type">QDir</span><span class="operator">::</span>SortFlags m_sortFlags;
<span class="type">QVector</span><span class="operator"><</span><span class="type"><a href="qxmlname.html">QXmlName</a></span><span class="operator">></span> m_names;
</pre>
<p>The QVector <code>m_fileInfos</code> will contain the node model. Each QFileInfo in the vector will represent a file or a directory in the file system. At this point it is instructive to note that although the node model class for this example (<code>FileTree</code>) actually builds and contains the custom node model, building the custom node model isn't always required. For example, it is possible to use an already existing QObject tree as a node model and just implement the callback interface for that already existing data structure. In this file system example, however, although we have an already existing data structure, i.e. the file system, that data structure is not in memory and is not in a form we can use. So we must build an analog of the file system in memory from instances of QFileInfo, and we use that analog as the custom node model.</p>
<p>The two sets of flags, <code>m_filterAllowAll</code> and <code>m_sortFlags</code>, contain OR'ed flags from QDir::Filters and QDir::SortFlags respectively. They are set by the <code>FileTree</code> constructor and used in calls to QDir::entryInfoList() for getting the child list for a directory node, i.e. a QFileInfoList containing the file and directory nodes for all the immediate children of a directory.</p>
<p>The QVector <code>m_names</code> is an auxiliary component of the node model. It holds the XML element and attribute names (<a href="qxmlname.html">QXmlName</a>) for all the node types that will be found in the node model. <code>m_names</code> is indexed by the enum <code>FileTree::Type</code>, which specifies the node types:</p>
<a name="node-type"></a><pre class="cpp">
<span class="keyword">enum</span> Type {
File<span class="operator">,</span>
Directory<span class="operator">,</span>
AttributeFileName<span class="operator">,</span>
AttributeFilePath<span class="operator">,</span>
AttributeSize<span class="operator">,</span>
AttributeMIMEType<span class="operator">,</span>
AttributeSuffix
};
</pre>
<p><code>Directory</code> and <code>File</code> will represent the XML element nodes for directories and files respectively, and the other enum values will represent the XML attribute nodes for a file's path, name, suffix, its size in bytes, and its mime type. The <code>FileTree</code> constructor initializes <code>m_names</code> with an appropriate <a href="qxmlname.html">QXmlName</a> for each element and attribute type:</p>
<pre class="cpp">
FileTree<span class="operator">::</span>FileTree(<span class="keyword">const</span> <span class="type"><a href="qxmlnamepool.html">QXmlNamePool</a></span><span class="operator">&</span> pool)
: <span class="type"><a href="qsimplexmlnodemodel.html">QSimpleXmlNodeModel</a></span>(pool)<span class="operator">,</span>
m_filterAllowAll(<span class="type">QDir</span><span class="operator">::</span>AllEntries <span class="operator">|</span>
<span class="type">QDir</span><span class="operator">::</span>AllDirs <span class="operator">|</span>
<span class="type">QDir</span><span class="operator">::</span>NoDotAndDotDot <span class="operator">|</span>
<span class="type">QDir</span><span class="operator">::</span>Hidden)<span class="operator">,</span>
m_sortFlags(<span class="type">QDir</span><span class="operator">::</span>Name)
{
<span class="type"><a href="qxmlnamepool.html">QXmlNamePool</a></span> np <span class="operator">=</span> namePool();
m_names<span class="operator">.</span>resize(<span class="number">7</span>);
m_names<span class="operator">[</span>File<span class="operator">]</span> <span class="operator">=</span> <span class="type"><a href="qxmlname.html">QXmlName</a></span>(np<span class="operator">,</span> QLatin1String(<span class="string">"file"</span>));
m_names<span class="operator">[</span>Directory<span class="operator">]</span> <span class="operator">=</span> <span class="type"><a href="qxmlname.html">QXmlName</a></span>(np<span class="operator">,</span> QLatin1String(<span class="string">"directory"</span>));
m_names<span class="operator">[</span>AttributeFileName<span class="operator">]</span> <span class="operator">=</span> <span class="type"><a href="qxmlname.html">QXmlName</a></span>(np<span class="operator">,</span> QLatin1String(<span class="string">"fileName"</span>));
m_names<span class="operator">[</span>AttributeFilePath<span class="operator">]</span> <span class="operator">=</span> <span class="type"><a href="qxmlname.html">QXmlName</a></span>(np<span class="operator">,</span> QLatin1String(<span class="string">"filePath"</span>));
m_names<span class="operator">[</span>AttributeSize<span class="operator">]</span> <span class="operator">=</span> <span class="type"><a href="qxmlname.html">QXmlName</a></span>(np<span class="operator">,</span> QLatin1String(<span class="string">"size"</span>));
m_names<span class="operator">[</span>AttributeMIMEType<span class="operator">]</span> <span class="operator">=</span> <span class="type"><a href="qxmlname.html">QXmlName</a></span>(np<span class="operator">,</span> QLatin1String(<span class="string">"mimeType"</span>));
m_names<span class="operator">[</span>AttributeSuffix<span class="operator">]</span> <span class="operator">=</span> <span class="type"><a href="qxmlname.html">QXmlName</a></span>(np<span class="operator">,</span> QLatin1String(<span class="string">"suffix"</span>));
}
</pre>
<p>Note that the constructor does <i>not</i> pre-build the entire node model. Instead, the node model is built <i>incrementally</i> as the query engine evaluates a query. To see how the query engine causes the node model to be built incrementally, see <a href="qtxmlpatterns-filetree-example.html#building-and-traversing-the-node-model">Building And Traversing The Node Model</a>. To see how the query engine accesses the node model, see <a href="qtxmlpatterns-filetree-example.html#accessing-the-node-model">Accessing the node model</a>. See also: <a href="qtxmlpatterns-filetree-example.html#node-model-building-strategy">Node Model Building Strategy</a>.</p>
<a name="accessing-the-node-model"></a>
<h4 id="accessing-the-node-model">Accessing The Node Model</h4>
<p>Since the node model is stored outside the query engine in the <code>FileTree</code> class, the query engine knows nothing about it and can only access it by calling functions in the callback interface. When the query engine calls any callback function to access data in the node model, it passes a <a href="qxmlnodemodelindex.html">QXmlNodeModelIndex</a> to identify the node in the node model that it wants to access. Hence all the virtual functions in the callback interface use a <a href="qxmlnodemodelindex.html">QXmlNodeModelIndex</a> to uniquely identify a node in the model.</p>
<p>We use the index of a QFileInfo in <code>m_fileInfos</code> to uniquely identify a node in the node model. To get the <a href="qxmlnodemodelindex.html">QXmlNodeModelIndex</a> for a QFileInfo, the class uses the private function <code>toNodeIndex()</code>:</p>
<a name="main-tonodeindex"></a><pre class="cpp">
<span class="type"><a href="qxmlnodemodelindex.html">QXmlNodeModelIndex</a></span>
FileTree<span class="operator">::</span>toNodeIndex(<span class="keyword">const</span> <span class="type">QFileInfo</span> <span class="operator">&</span>fileInfo<span class="operator">,</span> Type attributeName) <span class="keyword">const</span>
{
<span class="keyword">const</span> <span class="type">int</span> indexOf <span class="operator">=</span> m_fileInfos<span class="operator">.</span>indexOf(fileInfo);
<span class="keyword">if</span> (indexOf <span class="operator">=</span><span class="operator">=</span> <span class="operator">-</span><span class="number">1</span>) {
m_fileInfos<span class="operator">.</span>append(fileInfo);
<span class="keyword">return</span> createIndex(m_fileInfos<span class="operator">.</span>count()<span class="operator">-</span><span class="number">1</span><span class="operator">,</span> attributeName);
}
<span class="keyword">else</span>
<span class="keyword">return</span> createIndex(indexOf<span class="operator">,</span> attributeName);
}
</pre>
<p>It searches the <code>m_fileInfos</code> vector for a QFileInfo that matches <code>fileInfo</code>. If a match is found, its array index is passed to <a href="qabstractxmlnodemodel.html#createIndex">QAbstractXmlNodeModel::createIndex</a>() as the <code>data</code> value for the QXmlNodeIndex. If no match is found, the unmatched QFileInfo is appended to the vector, so this function is also doing the actual incremental model building (see <a href="qtxmlpatterns-filetree-example.html#building-and-traversing-the-node-model">Building And Traversing The Node Model</a>).</p>
<p>Note that <code>toNodeIndex()</code> gets a <a href="qtxmlpatterns-filetree-example.html#node-type">node type</a> as the second parameter, which it just passes on to <a href="qabstractxmlnodemodel.html#createIndex">createIndex()</a> as the <code>additionalData</code> value. Logically, this second parameter represents a second dimension in the node model, where the first dimension represents the <i>element</i> nodes, and the second dimension represents each element's attribute nodes. The meaning is that each QFileInfo in the <code>m_fileInfos</code> vector can represent an <i>element</i> node <i>and</i> one or more <i>attribute</i> nodes. In particular, the QFileInfo for a file will contain the values for the attribute nodes path, name, suffix, size, and mime type (see <code>FileTree::attributes()</code>). Since the attributes are contained in the QFileInfo of the file element, there aren't actually any attribute nodes in the node model. Hence, we can use a QVector for <code>m_fileInfos</code>.</p>
<p>A convenience overloading of <a href="qtxmlpatterns-filetree-example.html#tonodeindex-of-convenience">toNodeIndex()</a> is also called in several places, wherever it is known that the <a href="qxmlnodemodelindex.html">QXmlNodeModelIndex</a> being requested is for a directory or a file and not for an attribute. The convenience function takes only the QFileInfo parameter and calls the other <a href="qtxmlpatterns-filetree-example.html#main-tonodeindex">toNodeIndex()</a>, after obtaining either the Directory or File node type directly from the QFileInfo:</p>
<a name="tonodeindex-of-convenience"></a><pre class="cpp">
<span class="type"><a href="qxmlnodemodelindex.html">QXmlNodeModelIndex</a></span> FileTree<span class="operator">::</span>toNodeIndex(<span class="keyword">const</span> <span class="type">QFileInfo</span> <span class="operator">&</span>fileInfo) <span class="keyword">const</span>
{
<span class="keyword">return</span> toNodeIndex(fileInfo<span class="operator">,</span> fileInfo<span class="operator">.</span>isDir() <span class="operator">?</span> Directory : File);
}
</pre>
<p>Note that the auxiliary vector <code>m_names</code> is accessed using the <a href="qtxmlpatterns-filetree-example.html#node-type">node type</a>, for example:</p>
<pre class="cpp">
<span class="type"><a href="qxmlname.html">QXmlName</a></span> FileTree<span class="operator">::</span>name(<span class="keyword">const</span> <span class="type"><a href="qxmlnodemodelindex.html">QXmlNodeModelIndex</a></span> <span class="operator">&</span>node) <span class="keyword">const</span>
{
<span class="keyword">return</span> m_names<span class="operator">.</span>at(node<span class="operator">.</span>additionalData());
}
</pre>
<p>Most of the virtual functions in the callback interface are as simple as the ones described so far, but the callback function used for traversing (and building) the node model is more complex.</p>
<a name="building-and-traversing-the-node-model"></a>
<h4 id="building-and-traversing-the-node-model">Building And Traversing The Node Model</h4>
<p>The node model in <code>FileTree</code> is not fully built before the query engine begins evaluating the query. In fact, when the query engine begins evaluating its first query, the only node in the node model is the one representing the root directory for the selected part of the file system. See <a href="qtxmlpatterns-schema-example.html#the-ui-class-mainwindow">The UI Class: MainWindow</a> below for details about how the UI triggers creation of the model.</p>
<p>The query engine builds the node model incrementally each time it calls the <a href="qtxmlpatterns-filetree-example.html#next-node-on-axis">nextFromSimpleAxis()</a> callback function, as it traverses the node model to evaluate a query. Thus the query engine only builds the region of the node model that it needs for evaluating the query.</p>
<p><a href="qtxmlpatterns-filetree-example.html#next-node-on-axis">nextFromSimpleAxis()</a> takes an <a href="qabstractxmlnodemodel.html#SimpleAxis-enum">axis identifier</a> and a <a href="qxmlnodemodelindex.html">node identifier</a> as parameters. The <a href="qxmlnodemodelindex.html">node identifier</a> represents the <i>context node</i> (i.e. the query engine's current location in the model), and the <a href="qabstractxmlnodemodel.html#SimpleAxis-enum">axis identifier</a> represents the direction we want to move from the context node. The function finds the appropriate next node and returns its <a href="qxmlnodemodelindex.html">QXmlNodeModelIndex</a>.</p>
<p><a href="qtxmlpatterns-filetree-example.html#next-node-on-axis">nextFromSimpleAxis()</a> is where most of the work of implementing a custom node model will be required. The obvious way to do it is to use a switch statement with a case for each <a href="qabstractxmlnodemodel.html#SimpleAxis-enum">axis</a>.</p>
<a name="next-node-on-axis"></a><pre class="cpp">
<span class="type"><a href="qxmlnodemodelindex.html">QXmlNodeModelIndex</a></span>
FileTree<span class="operator">::</span>nextFromSimpleAxis(SimpleAxis axis<span class="operator">,</span> <span class="keyword">const</span> <span class="type"><a href="qxmlnodemodelindex.html">QXmlNodeModelIndex</a></span> <span class="operator">&</span>nodeIndex) <span class="keyword">const</span>
{
<span class="keyword">const</span> <span class="type">QFileInfo</span> fi(toFileInfo(nodeIndex));
<span class="keyword">const</span> Type type <span class="operator">=</span> Type(nodeIndex<span class="operator">.</span>additionalData());
<span class="keyword">if</span> (type <span class="operator">!</span><span class="operator">=</span> File <span class="operator">&</span><span class="operator">&</span> type <span class="operator">!</span><span class="operator">=</span> Directory) {
Q_ASSERT_X(axis <span class="operator">=</span><span class="operator">=</span> Parent<span class="operator">,</span> Q_FUNC_INFO<span class="operator">,</span> <span class="string">"An attribute only has a parent!"</span>);
<span class="keyword">return</span> toNodeIndex(fi<span class="operator">,</span> Directory);
}
<span class="keyword">switch</span> (axis) {
<span class="keyword">case</span> Parent:
<span class="keyword">return</span> toNodeIndex(<span class="type">QFileInfo</span>(fi<span class="operator">.</span>path())<span class="operator">,</span> Directory);
<span class="keyword">case</span> FirstChild:
{
<span class="keyword">if</span> (type <span class="operator">=</span><span class="operator">=</span> File) <span class="comment">// A file has no children.</span>
<span class="keyword">return</span> <span class="type"><a href="qxmlnodemodelindex.html">QXmlNodeModelIndex</a></span>();
<span class="keyword">else</span> {
Q_ASSERT(type <span class="operator">=</span><span class="operator">=</span> Directory);
Q_ASSERT_X(fi<span class="operator">.</span>isDir()<span class="operator">,</span> Q_FUNC_INFO<span class="operator">,</span> <span class="string">"It isn't really a directory!"</span>);
<span class="keyword">const</span> <span class="type">QDir</span> dir(fi<span class="operator">.</span>absoluteFilePath());
Q_ASSERT(dir<span class="operator">.</span>exists());
<span class="keyword">const</span> <span class="type">QFileInfoList</span> children(dir<span class="operator">.</span>entryInfoList(<span class="type">QStringList</span>()<span class="operator">,</span>
m_filterAllowAll<span class="operator">,</span>
m_sortFlags));
<span class="keyword">if</span> (children<span class="operator">.</span>isEmpty())
<span class="keyword">return</span> <span class="type"><a href="qxmlnodemodelindex.html">QXmlNodeModelIndex</a></span>();
<span class="keyword">const</span> <span class="type">QFileInfo</span> firstChild(children<span class="operator">.</span>first());
<span class="keyword">return</span> toNodeIndex(firstChild);
}
}
<span class="keyword">case</span> PreviousSibling:
<span class="keyword">return</span> nextSibling(nodeIndex<span class="operator">,</span> fi<span class="operator">,</span> <span class="operator">-</span><span class="number">1</span>);
<span class="keyword">case</span> NextSibling:
<span class="keyword">return</span> nextSibling(nodeIndex<span class="operator">,</span> fi<span class="operator">,</span> <span class="number">1</span>);
}
Q_ASSERT_X(<span class="keyword">false</span><span class="operator">,</span> Q_FUNC_INFO<span class="operator">,</span> <span class="string">"Don't ever get here!"</span>);
<span class="keyword">return</span> <span class="type"><a href="qxmlnodemodelindex.html">QXmlNodeModelIndex</a></span>();
}
</pre>
<p>The first thing this function does is call <a href="qtxmlpatterns-filetree-example.html#to-file-info">toFileInfo()</a> to get the QFileInfo of the context node. The use of QVector::at() here is guaranteed to succeed because the context node must already be in the node model, and hence must have a QFileInfo in <code>m_fileInfos</code>.</p>
<a name="to-file-info"></a><pre class="cpp">
<span class="keyword">const</span> <span class="type">QFileInfo</span><span class="operator">&</span>
FileTree<span class="operator">::</span>toFileInfo(<span class="keyword">const</span> <span class="type"><a href="qxmlnodemodelindex.html">QXmlNodeModelIndex</a></span> <span class="operator">&</span>nodeIndex) <span class="keyword">const</span>
{
<span class="keyword">return</span> m_fileInfos<span class="operator">.</span>at(nodeIndex<span class="operator">.</span>data());
}
</pre>
<p>The <a href="qabstractxmlnodemodel.html#SimpleAxis-enum">Parent</a> case looks up the context node's parent by constructing a QFileInfo from the context node's path and passing it to <a href="qtxmlpatterns-filetree-example.html#main-tonodeindex">toNodeIndex()</a> to find the QFileInfo in <code>m_fileInfos</code>.</p>
<p>The <a href="qabstractxmlnodemodel.html#SimpleAxis-enum">FirstChild</a> case requires that the context node must be a directory, because a file doesn't have children. If the context node is not a directory, a default constructed <a href="qxmlnodemodelindex.html">QXmlNodeModelIndex</a> is returned. Otherwise, QDir::entryInfoList() constructs a QFileInfoList of the context node's children. The first QFileInfo in the list is passed to <a href="qtxmlpatterns-filetree-example.html#tonodeindex-of-convenience">toNodeIndex()</a> to get its <a href="qxmlnodemodelindex.html">QXmlNodeModelIndex</a>. Note that this will add the child to the node model, if it isn't in the model yet.</p>
<p>The <a href="qabstractxmlnodemodel.html#SimpleAxis-enum">PreviousSibling</a> and <a href="qabstractxmlnodemodel.html#SimpleAxis-enum">NextSibling</a> cases call the <a href="qtxmlpatterns-filetree-example.html#nextsibling-helper">nextSibling() helper function</a>. It takes the <a href="qxmlnodemodelindex.html">QXmlNodeModelIndex</a> of the context node, the QFileInfo of the context node, and an offest of +1 or -1. The context node is a child of some parent, so the function gets the parent and then gets the child list for the parent. The child list is searched to find the QFileInfo of the context node. It must be there. Then the offset is applied, -1 for the previous sibling and +1 for the next sibling. The resulting index is passed to <a href="qtxmlpatterns-filetree-example.html#tonodeindex-of-convenience">toNodeIndex()</a> to get its <a href="qxmlnodemodelindex.html">QXmlNodeModelIndex</a>. Note again that this will add the sibling to the node model, if it isn't in the model yet.</p>
<a name="nextsibling-helper"></a><pre class="cpp">
<span class="type"><a href="qxmlnodemodelindex.html">QXmlNodeModelIndex</a></span> FileTree<span class="operator">::</span>nextSibling(<span class="keyword">const</span> <span class="type"><a href="qxmlnodemodelindex.html">QXmlNodeModelIndex</a></span> <span class="operator">&</span>nodeIndex<span class="operator">,</span>
<span class="keyword">const</span> <span class="type">QFileInfo</span> <span class="operator">&</span>fileInfo<span class="operator">,</span>
<span class="type">qint8</span> offset) <span class="keyword">const</span>
{
Q_ASSERT(offset <span class="operator">=</span><span class="operator">=</span> <span class="operator">-</span><span class="number">1</span> <span class="operator">|</span><span class="operator">|</span> offset <span class="operator">=</span><span class="operator">=</span> <span class="number">1</span>);
<span class="comment">// Get the context node's parent.</span>
<span class="keyword">const</span> <span class="type"><a href="qxmlnodemodelindex.html">QXmlNodeModelIndex</a></span> parent(nextFromSimpleAxis(Parent<span class="operator">,</span> nodeIndex));
<span class="keyword">if</span> (parent<span class="operator">.</span>isNull())
<span class="keyword">return</span> <span class="type"><a href="qxmlnodemodelindex.html">QXmlNodeModelIndex</a></span>();
<span class="comment">// Get the parent's child list.</span>
<span class="keyword">const</span> <span class="type">QFileInfo</span> parentFI(toFileInfo(parent));
Q_ASSERT(Type(parent<span class="operator">.</span>additionalData()) <span class="operator">=</span><span class="operator">=</span> Directory);
<span class="keyword">const</span> <span class="type">QFileInfoList</span> siblings(<span class="type">QDir</span>(parentFI<span class="operator">.</span>absoluteFilePath())<span class="operator">.</span>entryInfoList(<span class="type">QStringList</span>()<span class="operator">,</span>
m_filterAllowAll<span class="operator">,</span>
m_sortFlags));
Q_ASSERT_X(<span class="operator">!</span>siblings<span class="operator">.</span>isEmpty()<span class="operator">,</span> Q_FUNC_INFO<span class="operator">,</span> <span class="string">"Can't happen! We started at a child."</span>);
<span class="comment">// Find the index of the child where we started.</span>
<span class="keyword">const</span> <span class="type">int</span> indexOfMe <span class="operator">=</span> siblings<span class="operator">.</span>indexOf(fileInfo);
<span class="comment">// Apply the offset.</span>
<span class="keyword">const</span> <span class="type">int</span> siblingIndex <span class="operator">=</span> indexOfMe <span class="operator">+</span> offset;
<span class="keyword">if</span> (siblingIndex <span class="operator"><</span> <span class="number">0</span> <span class="operator">|</span><span class="operator">|</span> siblingIndex <span class="operator">></span> siblings<span class="operator">.</span>count() <span class="operator">-</span> <span class="number">1</span>)
<span class="keyword">return</span> <span class="type"><a href="qxmlnodemodelindex.html">QXmlNodeModelIndex</a></span>();
<span class="keyword">else</span>
<span class="keyword">return</span> toNodeIndex(siblings<span class="operator">.</span>at(siblingIndex));
}
</pre>
<a name="the-ui-class-mainwindow"></a>
<h3 id="the-ui-class-mainwindow">The UI Class: MainWindow</h3>
<p>The example's UI is a conventional Qt GUI application inheriting QMainWindow and the Ui_MainWindow base class generated by Qt Designer.</p>
<pre class="cpp">
<span class="preprocessor">#include "filetree.h"</span>
<span class="preprocessor">#include "ui_mainwindow.h"</span>
<span class="keyword">class</span> MainWindow : <span class="keyword">public</span> <span class="type">QMainWindow</span><span class="operator">,</span> <span class="keyword">private</span> Ui_MainWindow
{
Q_OBJECT
<span class="keyword">public</span>:
MainWindow();
<span class="keyword">private</span> <span class="keyword">slots</span>:
<span class="type">void</span> on_actionOpenDirectory_triggered();
<span class="type">void</span> on_actionAbout_triggered();
<span class="type">void</span> on_queryBox_currentIndexChanged(<span class="keyword">const</span> <span class="type">QString</span> <span class="operator">&</span>);
<span class="keyword">private</span>:
<span class="type">void</span> loadDirectory(<span class="keyword">const</span> <span class="type">QString</span> <span class="operator">&</span>directory);
<span class="type">void</span> evaluateResult();
<span class="keyword">const</span> <span class="type"><a href="qxmlnamepool.html">QXmlNamePool</a></span> m_namePool;
<span class="keyword">const</span> FileTree m_fileTree;
<span class="type"><a href="qxmlnodemodelindex.html">QXmlNodeModelIndex</a></span> m_fileNode;
};
</pre>
<p>It contains the custom node model (<code>m_fileTree</code>) and an instance of <a href="qxmlnodemodelindex.html">QXmlNodeModelIndex</a> (<code>m_fileNode</code>) used for holding the node index for the root of the file system subtree. <code>m_fileNode</code> will be bound to a $variable in the <a href="xmlprocessing.html">XQuery</a> to be evaluated.</p>
<p>Two actions of interest are handled by slot functions: <a href="qtxmlpatterns-filetree-example.html#selecting-a-directory-to-model">Selecting A Directory To Model</a> and <a href="qtxmlpatterns-filetree-example.html#selecting-and-running-an-xquery">Selecting And Running An XQuery</a>.</p>
<a name="selecting-a-directory-to-model"></a>
<h4 id="selecting-a-directory-to-model">Selecting A Directory To Model</h4>
<p>The user selects <code>File->Open Directory</code> to choose a directory to be loaded into the custom node model. Choosing a directory signals the <code>on_actionOpenDirectory_triggered()</code> slot:</p>
<pre class="cpp">
<span class="type">void</span> MainWindow<span class="operator">::</span>on_actionOpenDirectory_triggered()
{
<span class="keyword">const</span> <span class="type">QString</span> directoryName <span class="operator">=</span> <span class="type">QFileDialog</span><span class="operator">::</span>getExistingDirectory(<span class="keyword">this</span>);
<span class="keyword">if</span> (<span class="operator">!</span>directoryName<span class="operator">.</span>isEmpty())
loadDirectory(directoryName);
}
</pre>
<p>The slot function simply calls the private function <code>loadDirectory()</code> with the path of the chosen directory:</p>
<a name="the-standard-code-pattern"></a><pre class="cpp">
<span class="type">void</span> MainWindow<span class="operator">::</span>loadDirectory(<span class="keyword">const</span> <span class="type">QString</span> <span class="operator">&</span>directory)
{
Q_ASSERT(<span class="type">QDir</span>(directory)<span class="operator">.</span>exists());
m_fileNode <span class="operator">=</span> m_fileTree<span class="operator">.</span>nodeFor(directory);
<span class="type"><a href="qxmlquery.html">QXmlQuery</a></span> query(m_namePool);
query<span class="operator">.</span>bindVariable(<span class="string">"fileTree"</span><span class="operator">,</span> m_fileNode);
query<span class="operator">.</span>setQuery(<span class="type">QUrl</span>(<span class="string">"qrc:/queries/wholeTree.xq"</span>));
<span class="type">QByteArray</span> output;
<span class="type">QBuffer</span> buffer(<span class="operator">&</span>output);
buffer<span class="operator">.</span>open(<span class="type">QIODevice</span><span class="operator">::</span>WriteOnly);
<span class="type"><a href="qxmlformatter.html">QXmlFormatter</a></span> formatter(query<span class="operator">,</span> <span class="operator">&</span>buffer);
query<span class="operator">.</span>evaluateTo(<span class="operator">&</span>formatter);
treeInfo<span class="operator">-</span><span class="operator">></span>setText(tr(<span class="string">"Model of %1 output as XML."</span>)<span class="operator">.</span>arg(directory));
fileTree<span class="operator">-</span><span class="operator">></span>setText(<span class="type">QString</span><span class="operator">::</span>fromLatin1(output<span class="operator">.</span>constData()));
evaluateResult();
}
</pre>
<p><code>loadDirectory()</code> demonstrates a standard code pattern for using Qt XML Patterns programatically. First it gets the node model index for the root of the selected directory. Then it creates an instance of <a href="qxmlquery.html">QXmlQuery</a> and calls <a href="qxmlquery.html#bindVariable">QXmlQuery::bindVariable</a>() to bind the node index to the <a href="xmlprocessing.html">XQuery</a> variable <code>$fileTree</code>. It then calls <a href="qxmlquery.html#setQuery">QXmlQuery::setQuery</a>() to load the <a href="xmlprocessing.html">XQuery</a> text.</p>
<p><b>Note: </b><a href="qxmlquery.html#bindVariable">QXmlQuery::bindVariable</a>() must be called <i>before</i> calling <a href="qxmlquery.html#setQuery">QXmlQuery::setQuery</a>(), which loads and parses the <a href="xmlprocessing.html">XQuery</a> text and must have access to the variable binding as the text is parsed.</p><p>The next lines create an output device for outputting the query result, which is then used to create a <a href="qxmlformatter.html">QXmlFormatter</a> to format the query result as XML. <a href="qxmlquery.html#evaluateTo">QXmlQuery::evaluateTo</a>() is called to run the query, and the formatted XML output is displayed in the left panel of the UI window.</p>
<p>Finally, the private function <a href="qtxmlpatterns-filetree-example.html#selecting-and-running-an-xquery">evaluateResult()</a> is called to run the currently selected <a href="xmlprocessing.html">XQuery</a> over the custom node model.</p>
<p><b>Note: </b>As described in <a href="qtxmlpatterns-filetree-example.html#building-and-traversing-the-node-model">Building And Traversing The Node Model</a>, the <code>FileTree</code> class wants to build the custom node model incrementally as it evaluates the <a href="xmlprocessing.html">XQuery</a>. But, because the <code>loadDirectory()</code> function runs the <code>wholeTree.xq</code> <a href="xmlprocessing.html">XQuery</a>, it actually builds the entire node model anyway. See <a href="qtxmlpatterns-filetree-example.html#node-model-building-strategy">Node Model Building Strategy</a> for a discussion about building your custom node model.</p><a name="selecting-and-running-an-xquery"></a>
<h4 id="selecting-and-running-an-xquery">Selecting And Running An XQuery</h4>
<p>The user chooses an <a href="xmlprocessing.html">XQuery</a> from the menu in the combobox on the right. Choosing an <a href="xmlprocessing.html">XQuery</a> signals the <code>on_queryBox_currentIndexChanged()</code> slot:</p>
<pre class="cpp">
<span class="type">void</span> MainWindow<span class="operator">::</span>on_queryBox_currentIndexChanged(<span class="keyword">const</span> <span class="type">QString</span> <span class="operator">&</span>currentText)
{
<span class="type">QFile</span> queryFile(<span class="string">":/queries/"</span> <span class="operator">+</span> currentText);
queryFile<span class="operator">.</span>open(<span class="type">QIODevice</span><span class="operator">::</span>ReadOnly);
queryEdit<span class="operator">-</span><span class="operator">></span>setPlainText(<span class="type">QString</span><span class="operator">::</span>fromLatin1(queryFile<span class="operator">.</span>readAll()));
evaluateResult();
}
</pre>
<p>The slot function opens and loads the query file and then calls the private function <code>evaluateResult()</code> to run the query:</p>
<pre class="cpp">
<span class="type">void</span> MainWindow<span class="operator">::</span>evaluateResult()
{
<span class="keyword">if</span> (queryBox<span class="operator">-</span><span class="operator">></span>currentText()<span class="operator">.</span>isEmpty() <span class="operator">|</span><span class="operator">|</span> m_fileNode<span class="operator">.</span>isNull())
<span class="keyword">return</span>;
<span class="type"><a href="qxmlquery.html">QXmlQuery</a></span> query(m_namePool);
query<span class="operator">.</span>bindVariable(<span class="string">"fileTree"</span><span class="operator">,</span> m_fileNode);
query<span class="operator">.</span>setQuery(<span class="type">QUrl</span>(<span class="string">"qrc:/queries/"</span> <span class="operator">+</span> queryBox<span class="operator">-</span><span class="operator">></span>currentText()));
<span class="type">QByteArray</span> formatterOutput;
<span class="type">QBuffer</span> buffer(<span class="operator">&</span>formatterOutput);
buffer<span class="operator">.</span>open(<span class="type">QIODevice</span><span class="operator">::</span>WriteOnly);
<span class="type"><a href="qxmlformatter.html">QXmlFormatter</a></span> formatter(query<span class="operator">,</span> <span class="operator">&</span>buffer);
query<span class="operator">.</span>evaluateTo(<span class="operator">&</span>formatter);
output<span class="operator">-</span><span class="operator">></span>setText(<span class="type">QString</span><span class="operator">::</span>fromLatin1(formatterOutput<span class="operator">.</span>constData()));
}
</pre>
<p><code>evaluateResult()</code> is a second example of the same code pattern shown in <a href="qtxmlpatterns-filetree-example.html#the-standard-code-pattern">loadDirectory()</a>. In this case, it runs the <a href="xmlprocessing.html">XQuery</a> currently selected in the combobox instead of <code>qrc:/queries/wholeTree.xq</code>, and it outputs the query result to the panel on the lower right of the UI window.</p>
<a name="node-model-building-strategy"></a>
<h3 id="node-model-building-strategy">Node Model Building Strategy</h3>
<p>We saw that the <a href="qtxmlpatterns-filetree-example.html#the-custom-node-model-class-filetree">FileTree</a> tries to build its custom node model incrementally, but we also saw that the <a href="qtxmlpatterns-filetree-example.html#the-standard-code-pattern">MainWindow::loadDirectory()</a> function in the UI class immediately subverts the incremental build by running the <code>wholeTree.xq</code> <a href="xmlprocessing.html">XQuery</a>, which traverses the entire selected directory, thereby causing the entire node model to be built.</p>
<p>If we want to preserve the incremental build capability of the <code>FileTree</code> class, we can strip the running of <code>wholeTree.xq</code> out of <a href="qtxmlpatterns-filetree-example.html#the-standard-code-pattern">MainWindow::loadDirectory()</a>:</p>
<pre class="cpp">
<span class="type">void</span> MainWindow<span class="operator">::</span>loadDirectory(<span class="keyword">const</span> <span class="type">QString</span> <span class="operator">&</span>directory)
{
Q_ASSERT(<span class="type">QDir</span>(directory)<span class="operator">.</span>exists());
m_fileNode <span class="operator">=</span> m_fileTree<span class="operator">.</span>nodeFor(directory);
}
</pre>
<p>Note, however, that <code>FileTree</code> doesn't have the capability of deleting all or part of the node model. The node model, once built, is only deleted when the <code>FileTree</code> instance goes out of scope.</p>
<p>In this example, each element node in the node model represents a directory or a file in the computer's file system, and each node is represented by an instance of QFileInfo. An instance of QFileInfo is not costly to produce, but you might imagine a node model where building new nodes is very costly. In such cases, the capability to build the node model incrementally is important, because it allows us to only build the region of the model we need for evaluating the query. In other cases, it will be simpler to just build the entire node model.</p>
<p>Files:</p>
<ul>
<li><a href="qtxmlpatterns-filetree-filetree-cpp.html">filetree/filetree.cpp</a></li>
<li><a href="qtxmlpatterns-filetree-filetree-h.html">filetree/filetree.h</a></li>
<li><a href="qtxmlpatterns-filetree-filetree-pro.html">filetree/filetree.pro</a></li>
<li><a href="qtxmlpatterns-filetree-forms-mainwindow-ui.html">filetree/forms/mainwindow.ui</a></li>
<li><a href="qtxmlpatterns-filetree-main-cpp.html">filetree/main.cpp</a></li>
<li><a href="qtxmlpatterns-filetree-mainwindow-cpp.html">filetree/mainwindow.cpp</a></li>
<li><a href="qtxmlpatterns-filetree-mainwindow-h.html">filetree/mainwindow.h</a></li>
<li><a href="qtxmlpatterns-filetree-queries-qrc.html">filetree/queries.qrc</a></li>
<li><a href="qtxmlpatterns-filetree-queries-listcppfiles-xq.html">filetree/queries/listCPPFiles.xq</a></li>
<li><a href="qtxmlpatterns-filetree-queries-wholetree-xq.html">filetree/queries/wholeTree.xq</a></li>
</ul>
</div>
<!-- @@@filetree -->
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2019 The Qt Company Ltd.
Documentation contributions included herein are the copyrights of
their respective owners.<br/> The documentation provided herein is licensed under the terms of the <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation License version 1.3</a> as published by the Free Software Foundation.<br/> Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. </p>
</div>
</body>
</html>
